adis_internals.h

Go to the documentation of this file.

/***************************************************************************/
 
#ifndef __ADIS_INTERNALS_H__
#define __ADIS_INTERNALS_H__
 
#define ADIS_HAS_BURST32        NO_OS_BIT(0)
#define ADIS_HAS_BURST_DELTA_DATA   NO_OS_BIT(1)
#define ADIS_HAS_FIFO           NO_OS_BIT(2)
 
#define ADIS_READ_BURST_DATA_CMD_MSB   0x68
#define ADIS_READ_BURST_DATA_CMD_LSB   0x00
#define ADIS_READ_BURST_DATA_CMD_SIZE  2  /* in bytes */
 
#define ADIS_PAGE_SIZE          0x80
#define ADIS_REG_PAGE_ID        0x00
 
#define ADIS_WRITE_REG(reg)     ((NO_OS_BIT(7) | (reg)))
#define ADIS_READ_REG(reg)      ((reg) & NO_OS_GENMASK(6,0))

struct adis_timeout {
    uint16_t reset_ms;
    uint16_t fact_calib_restore_ms;
    uint16_t self_test_ms;
    uint16_t fls_mem_update_ms;
    uint16_t fls_mem_test_ms;
    uint16_t sw_reset_ms;
    uint16_t dec_rate_update_us;
    uint16_t filt_size_var_b_update_us;
    uint16_t msc_reg_update_us;
    uint16_t sens_bw_update_ms;
};
struct adis_timeout {…};

struct adis_clk_freq_limit {
    uint32_t min_freq;
    uint32_t max_freq;
};
struct adis_clk_freq_limit {…};

struct adis_scale_members {
    uint32_t scale_m1;
    uint32_t scale_m2;
};
struct adis_scale_members {…};

struct adis_field {
    uint16_t    reg_addr;
    uint8_t     reg_size;
    uint32_t    field_mask;
};
struct adis_field {…};

struct adis_data_field_map_def {
    struct adis_field diag_stat;
    uint32_t diag_snsr_init_failure_mask;
    uint32_t diag_data_path_overrun_mask;
    uint32_t diag_fls_mem_update_failure_mask;
    uint32_t diag_spi_comm_err_mask;
    uint32_t diag_standby_mode_mask;
    uint32_t diag_snsr_failure_mask;
    uint32_t diag_mem_failure_mask;
    uint32_t diag_clk_err_mask;
    uint32_t diag_gyro1_failure_mask;
    uint32_t diag_gyro2_failure_mask;
    uint32_t diag_accl_failure_mask;
    uint32_t diag_x_axis_gyro_failure_mask;
    uint32_t diag_y_axis_gyro_failure_mask;
    uint32_t diag_z_axis_gyro_failure_mask;
    uint32_t diag_x_axis_accl_failure_mask;
    uint32_t diag_y_axis_accl_failure_mask;
    uint32_t diag_z_axis_accl_failure_mask;
    uint32_t diag_aduc_mcu_fault_mask;
    uint32_t diag_config_calib_crc_error_mask;
    uint32_t diag_overrange_mask;
    uint32_t diag_temp_err_mask;
    uint32_t diag_power_supply_failure_mask;
    uint32_t diag_boot_memory_failure_mask;
    uint32_t diag_reg_nvm_err_mask;
    uint32_t diag_wdg_timer_flag_mask;
    uint32_t diag_int_proc_supply_err_mask;
    uint32_t diag_ext_5v_supply_err_mask;
    uint32_t diag_int_snsr_supply_err_mask;
    uint32_t diag_int_reg_err_mask;

    struct adis_field temp_flags;

    struct adis_field x_gyro;
    struct adis_field y_gyro;
    struct adis_field z_gyro;
    struct adis_field x_accl;
    struct adis_field y_accl;
    struct adis_field z_accl;
    struct adis_field temp_out;

    struct adis_field time_stamp;
    struct adis_field data_cntr;

    struct adis_field x_deltang;
    struct adis_field y_deltang;
    struct adis_field z_deltang;
    struct adis_field x_deltvel;
    struct adis_field y_deltvel;
    struct adis_field z_deltvel;

    struct adis_field fifo_cnt;
    struct adis_field spi_chksum;

    struct adis_field xg_bias;
    struct adis_field yg_bias;
    struct adis_field zg_bias;
    struct adis_field xa_bias;
    struct adis_field ya_bias;
    struct adis_field za_bias;

    struct adis_field xg_scale;
    struct adis_field yg_scale;
    struct adis_field zg_scale;
    struct adis_field xa_scale;
    struct adis_field ya_scale;
    struct adis_field za_scale;

    struct adis_field fifo_en;
    struct adis_field fifo_overflow;
    struct adis_field fifo_wm_int_en;
    struct adis_field fifo_wm_int_pol;
    struct adis_field fifo_wm_lvl;

    struct adis_field filt_size_var_b;

    struct adis_field gyro_meas_range;

    struct adis_field dr_selection;
    struct adis_field dr_polarity;
    struct adis_field dr_enable;
    struct adis_field sync_selection;
    struct adis_field sync_polarity;
    struct adis_field sync_mode;
    struct adis_field alarm_selection;
    struct adis_field alarm_polarity;
    struct adis_field alarm_enable;
    struct adis_field gpio_ctrl;
    struct adis_field sens_bw;
    struct adis_field pt_of_perc_algnmt;
    struct adis_field linear_accl_comp;
    struct adis_field burst_sel;
    struct adis_field burst32;
    struct adis_field timestamp32;
    struct adis_field sync_4khz;
    struct adis_field accl_fir_enable;
    struct adis_field gyro_fir_enable;

    struct adis_field up_scale;
    struct adis_field dec_rate;

    struct adis_field bias_corr_tbc;
    struct adis_field bias_corr_en_xg;
    struct adis_field bias_corr_en_yg;
    struct adis_field bias_corr_en_zg;
    struct adis_field bias_corr_en_xa;
    struct adis_field bias_corr_en_ya;
    struct adis_field bias_corr_en_za;

    struct adis_field write_lock;
    struct adis_field bias_corr_update;
    struct adis_field fact_calib_restore;
    struct adis_field snsr_self_test;
    struct adis_field fls_mem_update;
    struct adis_field fls_mem_test;
    struct adis_field fifo_flush;
    struct adis_field sw_res;

    struct adis_field proc_rev;
    struct adis_field firm_rev;
    struct adis_field firm_d;
    struct adis_field firm_m;
    struct adis_field firm_y;
    struct adis_field boot_rev;
    struct adis_field prod_id;
    struct adis_field serial_num;
    struct adis_field lot_num;

    struct adis_field usr_scr_1;
    struct adis_field usr_scr_2;
    struct adis_field usr_scr_3;
    struct adis_field usr_scr_4;

    struct adis_field fls_mem_wr_cntr;
 
    /* FIR Filter Coefficient C0 */
    struct adis_field coeff_c0;
    struct adis_field fir_en_xg;
    struct adis_field fir_en_yg;
    struct adis_field fir_en_zg;
    struct adis_field fir_en_xa;
    struct adis_field fir_en_ya;
    struct adis_field fir_en_za;
    struct adis_field fir_bank_sel_xg;
    struct adis_field fir_bank_sel_yg;
    struct adis_field fir_bank_sel_zg;
    struct adis_field fir_bank_sel_xa;
    struct adis_field fir_bank_sel_ya;
    struct adis_field fir_bank_sel_za;
    /* FIR Filter Coefficient Bank A */
    struct adis_field coeff_bank_a;
    /* FIR Filter Coefficient Bank B */
    struct adis_field coeff_bank_b;
    /* FIR Filter Coefficient Bank C */
    struct adis_field coeff_bank_c;
    /* FIR Filter Coefficient Bank D */
    struct adis_field coeff_bank_d;
};
struct adis_data_field_map_def {…};

struct adis_chip_info {
    const struct adis_init_param         *ip;
    const struct adis_data_field_map_def     *field_map;
    const struct adis_clk_freq_limit *sync_clk_freq_limits;
    const struct adis_clk_freq_limit sampling_clk_limits;
    const struct adis_timeout       *timeouts;
    const uint32_t flags;
    uint32_t                read_delay;
    uint32_t                write_delay;
    uint32_t                cs_change_delay;
    bool                    has_paging;
    bool                    has_lock;
    uint16_t                filt_size_var_b_max;
    uint16_t                dec_rate_max;
    uint8_t                 sync_mode_max;
    uint32_t                fls_mem_wr_cntr_max;
    uint8_t                 bias_corr_tbc_max;
    uint8_t                 fir_coef_idx_max;
    uint32_t                int_clk;
    int (*get_scale)(struct adis_dev *adis,
             uint32_t *scale_m1, uint32_t *scale_m2,
             enum adis_chan_type chan_type);
    int (*read_reg)(struct adis_dev *adis,  uint32_t reg, uint32_t *val,
            uint32_t size);
    int (*write_reg)(struct adis_dev *adis,  uint32_t reg, uint32_t val,
             uint32_t size);
    int (*read_burst_data)(struct adis_dev *adis, struct adis_burst_data *data,
                   bool burst32, uint8_t burst_sel, bool fifo_pop, bool crc_check);
    int (*get_offset)(struct adis_dev *adis,
              int *offset,
              enum adis_chan_type chan_type);
    int (*read_sync_mode)(struct adis_dev *adis, uint32_t *sync_mode);
    int (*write_sync_mode)(struct adis_dev *adis, uint32_t sync_mode,
                   uint32_t ext_clk);
    int (*write_lpf)(struct adis_dev *adis, enum adis_chan_type chan,
             enum adis_axis_type axis, uint32_t freq);
    int (*read_lpf)(struct adis_dev *adis, enum adis_chan_type chan,
            enum adis_axis_type axis, uint32_t *freq);
};
struct adis_chip_info {…};

bool adis_validate_checksum(uint8_t *buffer, uint8_t size, uint8_t idx);
void adis_update_diag_flags(struct adis_dev *adis, uint32_t diag_stat);
void adis_update_temp_flags(struct adis_dev *adis, uint16_t temp_reg);
int adis_write_field_u32(struct adis_dev *adis, struct adis_field field,
             uint32_t field_val);
int adis_read_field_s32(struct adis_dev *adis, struct adis_field field,
            int32_t *field_val);
int adis_read_field_u32(struct adis_dev *adis, struct adis_field field,
            uint32_t *field_val);
 
#endif