hpm_opamp_drv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef HPM_OPAMP_DRV_H
#define HPM_OPAMP_DRV_H
 
#include "hpm_common.h"
#include "hpm_opamp_regs.h"
#include "hpm_soc_feature.h"
 
#define OPAMP_MODE_FOLLOW_KEY   (0x06)
#define OPAMP_MODE_INVERT_INDEX0_KEY   (0x08)
#define OPAMP_MODE_INVERT_INDEX1_KEY   (0x18)
#define OPAMP_MODE_NON_INVERT_INDEX0_KEY   (0x01)
#define OPAMP_MODE_NON_INVERT_INDEX1_KEY   (0x09)
#define OPAMP_MODE_NON_INVERT_INDEX2_KEY   (0x11)
#define OPAMP_MODE_NON_INVERT_INDEX3_KEY   (0x19)
#define OPAMP_MODE_NON_INVERT_INDEX4_KEY   (0x09)
#define OPAMP_MODE_USER_DEFINE_KEY  (0x04)
 
typedef enum {
    inm_pad_vim0 = 0,    
    inm_pad_vim1 = 1,    
    inm_pad_vim2 = 2,    
    inm_pad_vim3 = 3,    
    inm_pad_floating = 4    
} opamp_inm_pad_t;
 
typedef enum {
    gain_x_2 = 0,     
    gain_x_4 = 1,
    gain_x_8 = 2,
    gain_x_16 = 3,
    gain_x_32 = 4,
    gain_x_64 = 5,
    gain_x_128 = 6,   
} opamp_gain_t;
 
typedef enum {
    miller_cap_x_7 = 0, 
    miller_cap_x_8 = 1,
    miller_cap_x_10 = 2,
    miller_cap_x_13 = 3,
    miller_cap_x_15 = 4,    
    miller_cap_x_18 = 5,
    miller_cap_x_5 = 6,
    miller_cap_x_6 = 7, 
} opamp_miller_cap_t;
 
typedef enum {
    inp_pad_vip0 = 0,    
    inp_pad_vip1 = 1,    
    inp_pad_vip2 = 2,    
    inp_pad_vip3 = 3,    
    inp_pad_vsupply_x_0_25 = 4,    
    inp_pad_vsupply_x_0_5 = 5,    
    inp_pad_vsupply_x_0_75 = 6,    
    inp_pad_floating = 7    
} opamp_inp_pad_t;
 
typedef enum {
    cfg_preset_0 = OPAMP_CFG_PRESET0,
    cfg_preset_1 = OPAMP_CFG_PRESET1,
    cfg_preset_2 = OPAMP_CFG_PRESET2,
    cfg_preset_3 = OPAMP_CFG_PRESET3,
    cfg_preset_4 = OPAMP_CFG_PRESET4,
    cfg_preset_5 = OPAMP_CFG_PRESET5,
    cfg_preset_6 = OPAMP_CFG_PRESET6,
    cfg_preset_7 = OPAMP_CFG_PRESET7,
} opamp_cfg_preset_chn_t;
 
typedef enum {
    mode_follow = 0,  
    mode_invert_intern_vol = 1,   
    mode_invert_extern_vol = 2,   
    mode_invert_dac_vol = 3,      
    mode_non_invert_gnd_vol = 4,   
    mode_non_invert_extern_vol = 5,   
    mode_non_invert_dac_vol = 6,  
    mode_user = 7,    
} opamp_mode_t;
 
typedef union opamp_cfg_preset0 {
    struct {
        uint32_t vip_select: 3;
        uint32_t vim_select: 3;
        uint32_t vswitch_select: 3;
        uint32_t cap_select: 4;
        uint32_t reserve: 19;
    };
    uint32_t val;
} opamp_ctrl_cfg_preset0_t;
 
typedef union opamp_cfg_preset1 {
    struct {
        uint32_t res_select: 3;
        uint32_t function_mode: 5;
        uint32_t iref_select: 2;
        uint32_t opaout_select: 2;
        uint32_t is_vssa_disconnect: 1;
        uint32_t en_lv: 1;
        uint32_t hw_trig_en: 1;
        uint32_t reserve: 17;
    };
    uint32_t val;
} opamp_ctrl_cfg_preset1_t;
 
typedef struct opamp_cfg {
    opamp_mode_t mode;
    opamp_inm_pad_t negative_input_pin;
    opamp_inp_pad_t positive_input_pin;
    opamp_gain_t gain;
    opamp_miller_cap_t miller_cap;
    bool enable_extern_filter_cap;
    bool enable_phase_margin_cap;
} opamp_cfg_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
hpm_stat_t opamp_init(OPAMP_Type *opamp, opamp_cfg_t *cfg);
static inline void opamp_enable(OPAMP_Type *opamp)
{
    opamp->CTRL0 |= OPAMP_CTRL0_EN_LV_MASK;
}
 
static inline void opamp_preset_opamp_enable(OPAMP_Type *opamp, uint8_t preset_chn)
{
    opamp->CFG[preset_chn].CFG1 |= OPAMP_CFG_CFG1_EN_LV_MASK;
}
 
static inline void opamp_disable(OPAMP_Type *opamp)
{
    opamp->CTRL0 &= ~OPAMP_CTRL0_EN_LV_MASK;
}
 
static inline void opamp_preset_opamp_disable(OPAMP_Type *opamp, uint8_t preset_chn)
{
    opamp->CFG[preset_chn].CFG1 &= ~OPAMP_CFG_CFG1_EN_LV_MASK;
}
 
static inline void opamp_miller_cap_select(OPAMP_Type *opamp, opamp_miller_cap_t select)
{
    opamp->CTRL0 = (opamp->CTRL0 & (~OPAMP_CTRL0_MILLER_SEL_MASK)) | OPAMP_CTRL0_MILLER_SEL_SET(select);
}
 
static inline void opamp_preset_miller_cap_select(OPAMP_Type *opamp, uint8_t preset_chn, opamp_miller_cap_t select)
{
    opamp->CFG[preset_chn].CFG0 = (opamp->CFG[preset_chn].CFG0 & (~OPAMP_CFG_CFG0_MILLER_SEL_MASK)) | OPAMP_CFG_CFG0_MILLER_SEL_SET(select);
}
 
static inline void opamp_phase_margin_cap_enable(OPAMP_Type *opamp)
{
    opamp->CTRL0 &= ~OPAMP_CTRL0_DISABLE_PM_CAP_MASK;
}
 
static inline void opamp_preset_phase_margin_cap_enable(OPAMP_Type *opamp, uint8_t preset_chn)
{
    opamp->CFG[preset_chn].CFG0 &= ~OPAMP_CFG_CFG0_DISABLE_PM_CAP_MASK;
}
 
static inline void opamp_phase_margin_cap_disable(OPAMP_Type *opamp)
{
    opamp->CTRL0 |= OPAMP_CTRL0_DISABLE_PM_CAP_MASK;
}
 
static inline void opamp_preset_phase_margin_cap_disable(OPAMP_Type *opamp, uint8_t preset_chn)
{
    opamp->CFG[preset_chn].CFG0 |= OPAMP_CFG_CFG0_DISABLE_PM_CAP_MASK;
}
 
static inline void opamp_inn_pad_select(OPAMP_Type *opamp, opamp_inm_pad_t select)
{
    opamp->CTRL0 = (opamp->CTRL0 & (~OPAMP_CTRL0_VIM_SEL_MASK)) | OPAMP_CTRL0_VIM_SEL_SET(select);
}
 
static inline void opamp_preset_inn_pad_select(OPAMP_Type *opamp, uint8_t preset_chn, opamp_inm_pad_t select)
{
    opamp->CFG[preset_chn].CFG0 = (opamp->CFG[preset_chn].CFG0 & (~OPAMP_CFG_CFG0_VIM_SEL_MASK)) | OPAMP_CFG_CFG0_VIM_SEL_SET(select);
}
 
static inline void opamp_gain_select(OPAMP_Type *opamp, opamp_gain_t select)
{
    opamp->CTRL0 = (opamp->CTRL0 & (~OPAMP_CTRL0_GAIN_SEL_MASK)) | OPAMP_CTRL0_GAIN_SEL_SET(select);
}
 
static inline void opamp_preset_gain_select(OPAMP_Type *opamp, uint8_t preset_chn, opamp_gain_t select)
{
    opamp->CFG[preset_chn].CFG1 = (opamp->CFG[preset_chn].CFG1 & (~OPAMP_CFG_CFG1_GAIN_SEL_MASK)) | OPAMP_CFG_CFG1_GAIN_SEL_SET(select);
}
 
static inline void opamp_disconnect_vssa(OPAMP_Type *opamp)
{
    opamp->CTRL0 |= OPAMP_CTRL0_VBYPASS_MASK;
}
 
static inline void opamp_preset_disconnect_vssa(OPAMP_Type *opamp, uint8_t preset_chn)
{
    opamp->CFG[preset_chn].CFG1 |= OPAMP_CFG_CFG1_VBYPASS_LV_MASK;
}
 
static inline void opamp_connect_vssa(OPAMP_Type *opamp)
{
    opamp->CTRL0 &= ~OPAMP_CTRL0_VBYPASS_MASK;
}
 
static inline void opamp_preset_connect_vssa(OPAMP_Type *opamp, uint8_t preset_chn)
{
    opamp->CFG[preset_chn].CFG1 &= ~OPAMP_CFG_CFG1_VBYPASS_LV_MASK;
}
 
static inline void opamp_inp_pad_select(OPAMP_Type *opamp, opamp_inp_pad_t select)
{
    opamp->CTRL0 = (opamp->CTRL0 & (~OPAMP_CTRL0_VIP_SEL_MASK)) | OPAMP_CTRL0_VIP_SEL_SET(select);
}
 
static inline void opamp_preset_inp_pad_select(OPAMP_Type *opamp, uint8_t preset_chn, opamp_inp_pad_t select)
{
    opamp->CFG[preset_chn].CFG0 = (opamp->CFG[preset_chn].CFG0 & (~OPAMP_CFG_CFG0_VIP_SEL_MASK)) | OPAMP_CFG_CFG0_VIP_SEL_SET(select);
}
 
 
static inline uint8_t opamp_get_cur_preset(OPAMP_Type *opamp)
{
    return OPAMP_STATUS_CUR_PRESET_GET(opamp->STATUS);
}
 
static inline bool opamp_get_is_preset(OPAMP_Type *opamp)
{
    return OPAMP_STATUS_PRESET_ACT_GET(opamp->STATUS);
}
 
static inline uint8_t opamp_get_trig_conflict_status(OPAMP_Type *opamp)
{
    return OPAMP_STATUS_TRIG_CONFLICT_GET(opamp->STATUS);
}
 
static inline void opamp_clear_conflict_status(OPAMP_Type *opamp)
{
    opamp->STATUS = OPAMP_STATUS_TRIG_CONFLICT_MASK;
}
 
static inline void opamp_set_sw_preset_val(OPAMP_Type *opamp, opamp_cfg_preset_chn_t val)
{
    opamp->CTRL1 = (opamp->CTRL1 & (~OPAMP_CTRL1_SW_SEL_MASK)) | OPAMP_CTRL1_SW_SEL_SET(val);
}
 
static inline void opamp_enable_sw_preset(OPAMP_Type *opamp)
{
    opamp->CTRL1 |= OPAMP_CTRL1_SW_PRESET_MASK;
}
 
static inline void opamp_disable_sw_preset(OPAMP_Type *opamp)
{
    opamp->CTRL1 &= ~OPAMP_CTRL1_SW_PRESET_MASK;
}
 
 
static inline void opamp_set_preset_x_chn(OPAMP_Type *opamp, uint8_t preset_chn, uint8_t chn)
{
    opamp->CFG[preset_chn].CFG2 = OPAMP_CFG_CFG2_CHANNEL_SET(chn);
}
 
hpm_stat_t opamp_set_preset_cfg(OPAMP_Type *opamp, uint8_t preset_chn, opamp_cfg_t *cfg);
 
static inline void opamp_preset_enable_hw_trig(OPAMP_Type *opamp, uint8_t preset_chn)
{
    opamp->CFG[preset_chn].CFG1 |= OPAMP_CFG_CFG1_HW_TRIG_EN_MASK;
}
 
static inline void opamp_preset_disable_hw_trig(OPAMP_Type *opamp, uint8_t preset_chn)
{
    opamp->CFG[preset_chn].CFG1 &= ~OPAMP_CFG_CFG1_HW_TRIG_EN_MASK;
}
 
static inline void opamp_mode_set(OPAMP_Type *opamp, uint8_t mode)
{
    opamp->CTRL0 = (opamp->CTRL0 & (~OPAMP_CTRL0_MODE_MASK)) | OPAMP_CTRL0_MODE_SET(mode);
}
 
static inline void opamp_preset_mode_set(OPAMP_Type *opamp, uint8_t preset_chn, uint8_t mode)
{
    opamp->CFG[preset_chn].CFG1 = (opamp->CFG[preset_chn].CFG1 & (~OPAMP_CFG_CFG1_MODE_MASK)) | OPAMP_CFG_CFG1_MODE_SET(mode);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* HPM_ACMP_DRV_H */