ltc2983.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef __LTC2983_H__
#define __LTC2983_H__
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdbool.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "no_os_util.h"
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
#define LTC2983_STATUS_REG              0x0000
#define LTC2983_TEMP_RES_START_REG      0x0010
#define LTC2983_EEPROM_KEY_REG          0x00B0
#define LTC2983_EEPROM_READ_STATUS_REG      0x00D0
#define LTC2983_GLOBAL_CONFIG_REG       0x00F0
#define LTC2986_EEPROM_STATUS_REG       0x00F9
#define LTC2983_MUX_CONFIG_REG          0x00FF
#define LTC2983_CHAN_ASSIGN_START_REG   0x0200
#define LTC2983_CUST_SENS_TBL_START_REG 0x0250
#define LTC2983_CUST_SENS_TBL_END_REG   0x03CF
 
#define LTC2983_CUST_SENS_TBL_SIZE LTC2983_CUST_SENS_TBL_END_REG - \
                    LTC2983_CUST_SENS_TBL_START_REG + 1
#define LTC2983_SPI_READ_BYTE           0x3
#define LTC2983_SPI_WRITE_BYTE          0x2
 
#define LTC2983_EEPROM_KEY                  0xA53C0F5A
#define LTC2983_EEPROM_WRITE_CMD            0x15
#define LTC2983_EEPROM_READ_CMD             0x16
#define LTC2983_EEPROM_STATUS_FAILURE_MASK  NO_OS_GENMASK(3, 1)
#define LTC2983_EEPROM_READ_FAILURE_MASK    NO_OS_GENMASK(7, 0)
 
#define LTC2983_EEPROM_WRITE_TIME_MS    2600
#define LTC2983_EEPROM_READ_TIME_MS     20
 
#define LTC2983_CHAN_START_ADDR(chan) \
            (((chan - 1) * 4) + LTC2983_CHAN_ASSIGN_START_REG)
#define LTC2983_CHAN_RES_ADDR(chan) \
            (((chan - 1) * 4) + LTC2983_TEMP_RES_START_REG)
 
#define LTC2983_COMMON_HARD_FAULT_MASK  NO_OS_GENMASK(31, 30)
#define LTC2983_COMMON_SOFT_FAULT_MASK  NO_OS_GENMASK(27, 25)
 
#define LTC2983_STATUS_START_MASK   NO_OS_BIT(7)
#define LTC2983_STATUS_START(x) no_os_field_prep(LTC2983_STATUS_START_MASK, x)
#define LTC2983_STATUS_UP_MASK  NO_OS_GENMASK(7, 6)
#define LTC2983_STATUS_UP(reg)  no_os_field_get(LTC2983_STATUS_UP_MASK, reg)
 
#define LTC2983_STATUS_CHAN_SEL_MASK    NO_OS_GENMASK(4, 0)
#define LTC2983_STATUS_CHAN_SEL(x) \
            no_os_field_prep(LTC2983_STATUS_CHAN_SEL_MASK, x)
 
#define LTC2983_NOTCH_FREQ_MASK NO_OS_GENMASK(1, 0)
 
#define LTC2983_RES_VALID_MASK      NO_OS_BIT(24)
#define LTC2983_DATA_SIGN_BIT       23
#define LTC2983_DATA_MASK       NO_OS_GENMASK(LTC2983_DATA_SIGN_BIT, 0)
 
#define LTC2983_CHAN_TYPE_MASK  NO_OS_GENMASK(31, 27)
#define LTC2983_CHAN_TYPE(x)    no_os_field_prep(LTC2983_CHAN_TYPE_MASK, x)
 
#define LTC2983_CHAN_ASSIGN_MASK    NO_OS_GENMASK(26, 22)
#define LTC2983_CHAN_ASSIGN(x)  no_os_field_prep(LTC2983_CHAN_ASSIGN_MASK, x)
 
#define LTC2983_CUSTOM_LEN_MASK NO_OS_GENMASK(5, 0)
#define LTC2983_CUSTOM_LEN(x)   no_os_field_prep(LTC2983_CUSTOM_LEN_MASK, x)
 
#define LTC2983_CUSTOM_ADDR_MASK    NO_OS_GENMASK(11, 6)
#define LTC2983_CUSTOM_ADDR(x)  no_os_field_prep(LTC2983_CUSTOM_ADDR_MASK, x)
 
#define LTC2983_THERMOCOUPLE_CFG_MASK   NO_OS_GENMASK(21, 18)
#define LTC2983_THERMOCOUPLE_CFG(x) \
            no_os_field_prep(LTC2983_THERMOCOUPLE_CFG_MASK, x)
#define LTC2983_THERMOCOUPLE_HARD_FAULT_MASK    NO_OS_GENMASK(31, 29)
#define LTC2983_THERMOCOUPLE_SOFT_FAULT_MASK    NO_OS_GENMASK(28, 25)
 
#define LTC2983_RTD_CFG_MASK    NO_OS_GENMASK(21, 18)
#define LTC2983_RTD_CFG(x)  no_os_field_prep(LTC2983_RTD_CFG_MASK, x)
#define LTC2983_RTD_EXC_CURRENT_MASK    NO_OS_GENMASK(17, 14)
#define LTC2983_RTD_EXC_CURRENT(x) \
            no_os_field_prep(LTC2983_RTD_EXC_CURRENT_MASK, x)
#define LTC2983_RTD_CURVE_MASK      NO_OS_GENMASK(13, 12)
#define LTC2983_RTD_CURVE(x)    no_os_field_prep(LTC2983_RTD_CURVE_MASK, x)
 
#define LTC2983_THERMISTOR_CFG_MASK NO_OS_GENMASK(21, 19)
#define LTC2983_THERMISTOR_CFG(x) \
                no_os_field_prep(LTC2983_THERMISTOR_CFG_MASK, x)
#define LTC2983_THERMISTOR_EXC_CURRENT_MASK NO_OS_GENMASK(18, 15)
#define LTC2983_THERMISTOR_EXC_CURRENT(x) \
            no_os_field_prep(LTC2983_THERMISTOR_EXC_CURRENT_MASK, x)
 
#define LTC2983_DIODE_CFG_MASK      NO_OS_GENMASK(26, 24)
#define LTC2983_DIODE_CFG(x)    no_os_field_prep(LTC2983_DIODE_CFG_MASK, x)
#define LTC2983_DIODE_EXC_CURRENT_MASK  NO_OS_GENMASK(23, 22)
#define LTC2983_DIODE_EXC_CURRENT(x) \
            no_os_field_prep(LTC2983_DIODE_EXC_CURRENT_MASK, x)
#define LTC2983_DIODE_IDEAL_FACTOR_MASK NO_OS_GENMASK(21, 0)
#define LTC2983_DIODE_IDEAL_FACTOR(x) \
            no_os_field_prep(LTC2983_DIODE_IDEAL_FACTOR_MASK, x)
 
#define LTC2983_R_SENSE_VAL_MASK    NO_OS_GENMASK(26, 0)
#define LTC2983_R_SENSE_VAL(x)  no_os_field_prep(LTC2983_R_SENSE_VAL_MASK, x)
 
#define LTC2983_ADC_SINGLE_ENDED_MASK   NO_OS_BIT(26)
#define LTC2983_ADC_SINGLE_ENDED(x) \
            no_os_field_prep(LTC2983_ADC_SINGLE_ENDED_MASK, x)
 
enum ltc298x_id {
    ID_LTC2983,
    ID_LTC2984,
    ID_LTC2986,
};
 
enum ltc2983_filter_notch_freq {
    LTC2983_50_60HZ_REJECTION,
    LTC2983_60HZ_REJECTION,
    LTC2983_50HZ_REJECTION,
};
 
enum ltc2983_sensor_type {
    LTC2983_UNASSIGNED,
    LTC2983_THERMOCOUPLE_J,
    LTC2983_THERMOCOUPLE_K,
    LTC2983_THERMOCOUPLE_E,
    LTC2983_THERMOCOUPLE_N,
    LTC2983_THERMOCOUPLE_R,
    LTC2983_THERMOCOUPLE_S,
    LTC2983_THERMOCOUPLE_T,
    LTC2983_THERMOCOUPLE_B,
    LTC2983_THERMOCOUPLE_CUSTOM,
    LTC2983_RTD_PT_10,
    LTC2983_RTD_PT_50,
    LTC2983_RTD_PT_100,
    LTC2983_RTD_PT_200,
    LTC2983_RTD_PT_500,
    LTC2983_RTD_PT_1000,
    LTC2983_RTD_1000,
    LTC2983_RTD_NI_120,
    LTC2983_RTD_CUSTOM,
    LTC2983_THERMISTOR_44004_44033,
    LTC2983_THERMISTOR_44005_44030,
    LTC2983_THERMISTOR_44007_44034,
    LTC2983_THERMISTOR_44006_44031,
    LTC2983_THERMISTOR_44008_44032,
    LTC2983_THERMISTOR_YSI_400,
    LTC2983_THERMISTOR_SPECTRUM_1003K,
    LTC2983_THERMISTOR_CUSTOM_STEINHART_HART,
    LTC2983_THERMISTOR_CUSTOM,
    LTC2983_DIODE,
    LTC2983_RSENSE,
    LTC2983_DIRECT_ADC,
    LTC2983_ACTIVE_TEMP,
};
 
#define to_thermocouple(_sensor) \
        NO_OS_CONTAINER_OF(_sensor, struct ltc2983_thermocouple, sensor)
 
#define to_rtd(_sensor) \
        NO_OS_CONTAINER_OF(_sensor, struct ltc2983_rtd, sensor)
 
#define to_thermistor(_sensor) \
        NO_OS_CONTAINER_OF(_sensor, struct ltc2983_thermistor, sensor)
 
#define to_diode(_sensor) \
        NO_OS_CONTAINER_OF(_sensor, struct ltc2983_diode, sensor)
 
#define to_rsense(_sensor) \
        NO_OS_CONTAINER_OF(_sensor, struct ltc2983_rsense, sensor)
 
#define to_adc(_sensor) \
        NO_OS_CONTAINER_OF(_sensor, struct ltc2983_adc, sensor)
 
#define to_temp(_sensor) \
        NO_OS_CONTAINER_OF(_sensor, struct ltc2983_temp, sensor)
 
struct ltc2983_init_param {
    struct no_os_spi_init_param spi_init;
    struct no_os_gpio_init_param gpio_rstn;
    uint32_t mux_delay_config_us;
    enum ltc2983_filter_notch_freq filter_notch_freq;
    struct ltc2983_sensor *sensors[20];
    uint16_t custom_addr_ptr;
    enum ltc298x_id dev_type;
};
 
struct ltc2983_desc {
    struct no_os_spi_desc *comm_desc;
    struct no_os_gpio_desc *gpio_rstn;
    uint32_t mux_delay_config_us;
    enum ltc2983_filter_notch_freq filter_notch_freq;
    uint8_t num_channels;
    struct ltc2983_sensor *sensors[20];
    uint16_t custom_addr_ptr;
    uint8_t max_channels_nr;
};
 
struct ltc2983_sensor {
    uint8_t chan;
    uint8_t type : 5;
};
 
struct ltc2983_custom_sensor {
    uint32_t *table;
    size_t len;
    bool is_steinhart;
};
 
struct ltc2983_thermocouple {
    struct ltc2983_sensor sensor;
    struct ltc2983_custom_sensor *custom;
    uint32_t sensor_config;
    uint32_t cold_junction_chan;
};
 
struct ltc2983_rtd {
    struct ltc2983_sensor sensor;
    struct ltc2983_custom_sensor *custom;
    uint32_t sensor_config;
    uint32_t r_sense_chan;
    uint32_t excitation_current;
    uint32_t rtd_curve;
};
 
struct ltc2983_thermistor {
    struct ltc2983_sensor sensor;
    struct ltc2983_custom_sensor *custom;
    uint32_t sensor_config;
    uint32_t r_sense_chan;
    uint32_t excitation_current;
};
 
struct ideal_factor_value {
    uint32_t ideal_factor_val_int;
    uint32_t ideal_factor_val_dec_1048576;
};
 
struct ltc2983_diode {
    struct ltc2983_sensor sensor;
    uint32_t sensor_config;
    uint32_t excitation_current;
    struct ideal_factor_value ideal_factor_val;
};
 
struct r_sense_value {
    uint32_t r_sense_val_int;
    uint32_t r_sense_val_dec_1024;
};
 
struct ltc2983_rsense {
    struct ltc2983_sensor sensor;
    struct r_sense_value r_sense_val;
};
 
struct ltc2983_adc {
    struct ltc2983_sensor sensor;
    bool single_ended;
};
 
struct ltc2983_temp {
    struct ltc2983_sensor sensor;
    struct ltc2983_custom_sensor *custom;
    bool single_ended;
};
 
int ltc2983_init(struct ltc2983_desc **, struct ltc2983_init_param *);
 
int ltc2983_remove(struct ltc2983_desc *);
 
int ltc2983_reg_read(struct ltc2983_desc *, uint16_t, uint8_t *);
 
int ltc2983_reg_write(struct ltc2983_desc *, uint16_t, uint8_t);
 
int ltc2983_reg_update_bits(struct ltc2983_desc *, uint16_t, uint8_t, uint8_t);
 
int ltc2983_setup(struct ltc2983_desc *);
 
int ltc2983_chan_read(struct ltc2983_desc *, const int, int *);
 
int ltc2983_chan_read_raw(struct ltc2983_desc *, const int, uint32_t *);
 
int ltc2983_chan_read_scale(struct ltc2983_desc *, const int, uint32_t *,
                uint32_t *);
 
int ltc2983_thermocouple_assign_chan(struct ltc2983_desc *,
                     const struct ltc2983_sensor *);
 
int ltc2983_rtd_assign_chan(struct ltc2983_desc *,
                const struct ltc2983_sensor *);
 
int ltc2983_thermistor_assign_chan(struct ltc2983_desc *,
                   const struct ltc2983_sensor *);
 
int ltc2983_diode_assign_chan(struct ltc2983_desc *,
                  const struct ltc2983_sensor *);
 
int ltc2983_r_sense_assign_chan(struct ltc2983_desc *,
                const struct ltc2983_sensor *);
 
int ltc2983_adc_assign_chan(struct ltc2983_desc *,
                const struct ltc2983_sensor *);
 
int ltc2983_temp_assign_chan(struct ltc2983_desc *,
                 const struct ltc2983_sensor *);
 
int ltc2983_thermocouple_fault_handler(const uint32_t);
 
int ltc2983_common_fault_handler(const uint32_t);
 
#endif