max22200.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _MAX22200_H
#define _MAX22200_H
 
#include <stdint.h>
#include <stdbool.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "no_os_util.h"
 
#define MAX22200_FRAME_SIZE     4
 
#define MAX22200_CHANNELS       8
#define MAX22200_CHANNELS_CONFIG    4
#define MAX22200_MAX_CHN_IDX        7
#define MAX22200_HIT_MAX_VAL        0x7F
#define MAX22200_HIT_NO_TIME        0x00
 
#define MAX22200_R1B            NO_OS_BIT(0)
 
#define MAX22200_STATUS_REG     0x00
#define MAX22200_CFG_CH(x)      (0x02 + (0x02 * (x)))
#define MAX22200_FAULT_REG      0x0C
#define MAX22200_CFG_DPM_REG        0x0E
 
/* Write/Read Masks */
#define MAX22200_RW_MASK        NO_OS_BIT(7)
#define MAX22200_ADDR_MASK      NO_OS_GENMASK(6, 0)
 
/* Status Register Masks */
#define MAX22200_ONCH_MASK(x)       NO_OS_BIT((x) + 24)
#define MAX22200_STATUS_ONCH_MASK   NO_OS_GENMASK(31, 24)
#define MAX22200_STATUS_FREQ_MASK   NO_OS_BIT(16)
#define MAX22200_STATUS_FAULT_MASK(x)   NO_OS_BIT(x)
#define MAX22200_STATUS_MODE_MASK   NO_OS_GENMASK(15, 8)
#define MAX22200_CH_MODE_MASK(x)    NO_OS_GENMASK(8 + (2 * (x)), 9 + (2 * (x)))
#define MAX22200_STATUS_FLAG_MASK   NO_OS_GENMASK(7, 0)
#define MAX22200_ACTIVE_MASK        NO_OS_BIT(0)
 
/* CFG CH Register Masks */
#define MAX22200_HFS_MASK       NO_OS_BIT(31)
#define MAX22200_HOLD_MASK      NO_OS_GENMASK(30, 24)
#define MAX22200_TRGNSP_IO_MASK     NO_OS_BIT(23)
#define MAX22200_HIT_MASK       NO_OS_GENMASK(22, 16)
#define MAX22200_HIT_T_MASK     NO_OS_GENMASK(15, 8)
#define MAX22200_VDRNCDR_MASK       NO_OS_BIT(7)
#define MAX22200_HSNLS_MASK     NO_OS_BIT(6)
#define MAX22200_FREQ_CFG_MASK      NO_OS_GENMASK(5, 4)
#define MAX22200_CH_ENABLE_MASK(x)  NO_OS_BIT(x)
 
/* CFG DPM Register Masks */
#define MAX22200_DPM_ISTART_MASK    NO_OS_GENMASK(14, 8)
#define MAX22200_DPM_TDEB_MASK      NO_OS_GENMASK(7, 4)
#define MAX22200_DPM_IPTH_MASK      NO_OS_GENMASK(3, 0)
 
enum max22200_fault_mask {
    MAX22200_M_UVM = 17,
    MAX22200_M_COMF,
    MAX22200_M_DPM,
    MAX22200_M_HHF,
    MAX22200_M_OLF,
    MAX22200_M_OCP,
    MAX22200_M_OVT
};
 
enum max22200_chopping_freq {
    MAX22200_FREQ_100KHZ,
    MAX22200_FREQ_80KHZ
};
 
enum max22200_ch_op_mode {
    MAX22200_INDEPENDENT_MODE,
    MAX22200_PARALLEL_MODE,
    MAX22200_HALF_BRIDGE_MODE,
};
 
enum max22200_scale {
    MAX22200_FULLSCALE,
    MAX22200_HALF_FULL_SCALE
};
 
enum max22200_trig {
    MAX22200_ONCH_SPI,
    MAX22200_TRIG
};
 
enum max22200_ch_drive {
    MAX22200_CURRENT_DRIVE,
    MAX22200_VOLTAGE_DRIVE
};
 
enum max22200_ch_side {
    MAX22200_LOW_SIDE,
    MAX22200_HIGH_SIDE
};
 
enum max22200_ch_freq {
    MAX22200_FREQMAIN_DIV_4,
    MAX22200_FREQMAIN_DIV_3,
    MAX22200_FREQMAIN_DIV_2,
    MAX22200_FREQMAIN
};
 
enum max22200_ch_enable {
    MAX22200_HHF_ENABLE,
    MAX22200_DPM_ENABLE,
    MAX22200_OL_ENABLE,
    MAX22200_SRC
};
 
struct max22200_init_param {
    struct no_os_spi_init_param *comm_param;
    struct no_os_gpio_init_param *fault_param;
    struct no_os_gpio_init_param *enable_param;
    struct no_os_gpio_init_param *cmd_param;
    struct no_os_gpio_init_param *trig_param;
    enum max22200_ch_op_mode ch_config[MAX22200_CHANNELS_CONFIG];
};
 
struct max22200_desc {
    struct no_os_spi_desc *comm_desc;
    struct no_os_gpio_desc *fault_desc;
    struct no_os_gpio_desc *enable_desc;
    struct no_os_gpio_desc *cmd_desc;
    struct no_os_gpio_desc *trig_desc;
    uint8_t buff[MAX22200_FRAME_SIZE];
    enum max22200_ch_op_mode ch_config[MAX22200_CHANNELS_CONFIG];
    enum max22200_ch_side chan_side;
    enum max22200_ch_drive chan_drive;
};
 
int max22200_reg_read(struct max22200_desc *, uint32_t, uint32_t *);
 
int max22200_reg_write(struct max22200_desc *, uint32_t, uint32_t);
 
int max22200_reg_update(struct max22200_desc *, uint32_t, uint32_t, uint32_t);
 
int max22200_set_trig_state(struct max22200_desc *, bool);
 
int max22200_set_ch_state(struct max22200_desc *, uint32_t, bool);
 
int max22200_fault_mask_set(struct max22200_desc *, enum max22200_fault_mask,
                bool);
 
int max22200_set_chop_freq(struct max22200_desc *, enum max22200_chopping_freq);
 
int max22200_set_ch_hit(struct max22200_desc *, uint32_t, uint8_t, uint8_t);
 
int max22200_set_ch_hold(struct max22200_desc *, uint32_t, uint8_t);
 
int max22200_set_ch_scale(struct max22200_desc *, uint32_t,
              enum max22200_scale);
 
int max22200_set_ch_trig(struct max22200_desc *, uint32_t, enum max22200_trig);
 
int max22200_set_ch_mode(struct max22200_desc *, uint32_t,
             enum max22200_ch_drive, enum max22200_ch_side,
             enum max22200_ch_op_mode);
 
int max22200_set_ch_freq(struct max22200_desc *, uint32_t,
             enum max22200_ch_freq);
 
int max22200_set_ch_enable(struct max22200_desc *, uint32_t,
               enum max22200_ch_enable, bool);
 
int max22200_set_cfg_dpm(struct max22200_desc *, uint8_t, uint8_t);
 
int max22200_fault_mask_get(struct max22200_desc *, enum max22200_fault_mask,
                bool *);
 
int max22200_get_ch_state(struct max22200_desc *, uint32_t, bool *);
 
int max22200_get_chop_freq(struct max22200_desc *,
               enum max22200_chopping_freq *);
 
int max22200_get_ch_hit(struct max22200_desc *, uint32_t, uint8_t *, uint8_t *);
 
int max22200_get_ch_hold(struct max22200_desc *, uint32_t, uint8_t *);
 
int max22200_get_ch_scale(struct max22200_desc *, uint32_t,
              enum max22200_scale *);
 
int max22200_get_ch_trig(struct max22200_desc *, uint32_t,
             enum max22200_trig *);
 
int max22200_get_ch_mode(struct max22200_desc *, uint32_t,
             enum max22200_ch_drive *, enum max22200_ch_side *,
             enum max22200_ch_op_mode *);
 
int max22200_get_ch_freq(struct max22200_desc *, uint32_t,
             enum max22200_ch_freq *);
 
int max22200_get_ch_enable(struct max22200_desc *, uint32_t,
               enum max22200_ch_enable, bool *);
 
int max22200_get_cfg_dpm(struct max22200_desc *, uint8_t *, uint8_t *);
 
int max22200_init(struct max22200_desc **, struct max22200_init_param *);
 
int max22200_remove(struct max22200_desc *);
 
#endif /* _MAX22200_H */