max22190.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _MAX22190_H
#define _MAX22190_H
 
#include <stdint.h>
#include <stdbool.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "no_os_util.h"
 
#define MAX22190_FRAME_SIZE     2
#define MAX22190_CHANNELS       8
#define MAX22190_FAULT2_ENABLES     5
 
#define MAX22190_WIRE_BREAK_REG     0x0
#define MAX22190_DIGITAL_INPUT_REG  0x2
#define MAX22190_FAULT1_REG     0x4
#define MAX22190_FILTER_IN_REG(x)   (0x6 + (2 * (x)))
#define MAX22190_CONFIG_REG     0x18
#define MAX22190_INPUT_EN_REG       0x1A
#define MAX22190_FAULT2_REG     0x1C
#define MAX22190_FAULT2_EN_REG      0x1E
#define MAX22190_GPO_REG        0x22
#define MAX22190_FAULT1_EN_REG      0x24
 
#define MAX22190_NO_OP_REG      0x26
 
#define MAX22190_CH_STATE_MASK(x)   NO_OS_BIT(x)
#define MAX22190_DELAY_MASK     NO_OS_GENMASK(2, 0)
#define MAX22190_FBP_MASK       NO_OS_BIT(3)
#define MAX22190_WBE_MASK       NO_OS_BIT(4)
#define MAX22190_RW_MASK        NO_OS_BIT(7)
#define MAX22190_ADDR_MASK      NO_OS_GENMASK(6, 0)
#define MAX22190_ALARM_MASK     NO_OS_GENMASK(4, 3)
#define MAX22190_POR_MASK       NO_OS_BIT(6)
 
#define MAX22190_FAULT_MASK(x)      NO_OS_BIT(x)
#define MAX22190_FAULT2_WBE_MASK    NO_OS_BIT(4)
 
#define MAX22190_FAULT2_EN_MASK     NO_OS_GENMASK(5, 0)
 
#define MAX22190_CFG_REFDI_MASK     NO_OS_BIT(0)
#define MAX22190_CFG_CLRF_MASK      NO_OS_BIT(3)
#define MAX22190_CFG_24VF_MASK      NO_OS_BIT(4)
 
enum max22190_ch_state {
    MAX22190_CH_OFF,
    MAX22190_CH_ON
};
 
struct max22190_init_param {
    struct no_os_spi_init_param *comm_param;
    struct no_os_gpio_init_param *en_gpio_param;
    bool crc_en;
};
 
struct max22190_desc {
    struct no_os_spi_desc *comm_desc;
    struct no_os_gpio_desc *en_gpio;
    uint8_t buff[MAX22190_FRAME_SIZE + 1];
    enum max22190_ch_state channels[MAX22190_CHANNELS];
    uint8_t fault2en;
    bool crc_en;
};
 
enum max22190_delay {
    MAX22190_DELAY_50US,
    MAX22190_DELAY_100US,
    MAX22190_DELAY_400US,
    MAX22190_DELAY_800US,
    MAX22190_DELAY_1800US,
    MAX22190_DELAY_3200US,
    MAX22190_DELAY_12800US,
    MAX22190_DELAY_20MS
};
 
enum max22190_fault_enable {
    MAX22190_FAULT1_WBGE,
    MAX22190_FAULT1_24VME,
    MAX22190_FAULT1_24VLE,
    MAX22190_FAULT1_ALRMT1E,
    MAX22190_FAULT1_ALRMT2E,
    MAX22190_FAULT1_FAULT2E,
    MAX22190_FAULT2_RFWBSE,
    MAX22190_FAULT2_RFWBOE,
    MAX22190_FAULT2_RFDISE,
    MAX22190_FAULT2_RFDIOE,
    MAX22190_FAULT2_OTSHDNE,
    MAX22190_FAULT2_FAULT8CKE,
    MAX22190_CFG_24VF,
    MAX22190_CFG_REFDI_SH_ENA,
};
 
int max22190_filter_set(struct max22190_desc *, uint32_t, uint32_t,
            uint32_t, enum max22190_delay);
 
int max22190_filter_get(struct max22190_desc *, uint32_t, uint32_t *,
            uint32_t *, enum max22190_delay *);
 
int max22190_chan_state(struct max22190_desc *, uint32_t,
            enum max22190_ch_state);
 
int max22190_wbe_get(struct max22190_desc *, uint32_t, bool *);
 
int max22190_wbe_set(struct max22190_desc *, uint32_t, bool);
 
int max22190_fault_enable_set(struct max22190_desc *,
                  enum max22190_fault_enable, bool);
 
int max22190_fault_enable_get(struct max22190_desc *,
                  enum max22190_fault_enable, bool *);
 
int max22190_reg_read(struct max22190_desc *, uint32_t, uint32_t *);
 
int max22190_reg_write(struct max22190_desc *, uint32_t, uint32_t);
 
int max22190_reg_update(struct max22190_desc *, uint32_t, uint32_t, uint32_t);
 
int max22190_init(struct max22190_desc **, struct max22190_init_param *);
 
int max22190_remove(struct max22190_desc *);
 
#endif