adgs6414d.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef ADGS6414D_H_
#define ADGS6414D_H_
 
#include <stdint.h>
#include <stdbool.h>
#include "no_os_spi.h"
 
#define ADGS6414D_NUM_SWITCHES  8
 
/* ADGS6414D Register Map */
#define ADGS6414D_REG_SW_DATA       0x01
#define ADGS6414D_REG_ERR_CONFIG    0x02
#define ADGS6414D_REG_ERR_FLAGS     0x03
#define ADGS6414D_REG_BURST_EN      0x05
#define ADGS6414D_REG_SOFT_RESETB   0x0B
 
/* SPI Command Format */
#define ADGS6414D_CMD_WRITE     0x00
#define ADGS6414D_CMD_READ      0x80
 
/* Soft Reset Values */
#define ADGS6414D_SOFT_RESET_VAL1   0xA3
#define ADGS6414D_SOFT_RESET_VAL2   0x05
 
/* Error Flags Clear Command */
#define ADGS6414D_ERR_CLR_CMD_MSB   0x6C
#define ADGS6414D_ERR_CLR_CMD_LSB   0xA9
 
/* ERR_CONFIG Register Bits */
#define ADGS6414D_ERR_CFG_CRC_EN    0x01
#define ADGS6414D_ERR_CFG_SCLK_EN   0x02
#define ADGS6414D_ERR_CFG_RW_EN     0x04
#define ADGS6414D_ERR_CFG_DEFAULT   0x06
 
/* CRC Polynomial: x^8 + x^2 + x + 1 */
#define ADGS6414D_CRC8_POLYNOMIAL   0x07
 
/* ADGS6414D Switch Channels */
#define ADGS6414D_SW1       0
#define ADGS6414D_SW2       1
#define ADGS6414D_SW3       2
#define ADGS6414D_SW4       3
#define ADGS6414D_SW5       4
#define ADGS6414D_SW6       5
#define ADGS6414D_SW7       6
#define ADGS6414D_SW8       7

struct adgs6414d_dev {
    struct no_os_spi_desc *spi_desc;
    uint8_t         switch_state;
    bool            crc_en;
    uint8_t         err_config;
};

struct adgs6414d_init_param {
    struct no_os_spi_init_param *spi_init;
    uint8_t             initial_state;
    bool                crc_en;
    bool                sclk_err_en;
    bool                rw_err_en;
};
 
/* SPI write operation. */
int adgs6414d_spi_write(struct adgs6414d_dev *dev, uint8_t reg_addr,
            uint8_t data);
 
/* SPI read operation. */
int adgs6414d_spi_read(struct adgs6414d_dev *dev, uint8_t reg_addr,
               uint8_t *data);
 
/* Read the error flags register. */
int adgs6414d_get_err_flags(struct adgs6414d_dev *dev, uint8_t *flags);
 
/* Clear the error flags register. */
int adgs6414d_clear_err_flags(struct adgs6414d_dev *dev);
 
/* Enable or disable CRC error detection. */
int adgs6414d_crc_enable(struct adgs6414d_dev *dev, bool enable);
 
/* Perform software reset. */
int adgs6414d_soft_reset(struct adgs6414d_dev *dev);
 
/* Set switch state for a specific channel. */
int adgs6414d_set_switch(struct adgs6414d_dev *dev, uint8_t channel,
             bool state);
 
/* Get switch state for a specific channel. */
int adgs6414d_get_switch(struct adgs6414d_dev *dev, uint8_t channel,
             bool *state);
 
/* Set multiple switches at once using bitmask. */
int adgs6414d_set_switches(struct adgs6414d_dev *dev, uint8_t mask);
 
/* Get all switch states as bitmask. */
int adgs6414d_get_switches(struct adgs6414d_dev *dev, uint8_t *mask);
 
/* Initialize the device. */
int adgs6414d_init(struct adgs6414d_dev **device,
           struct adgs6414d_init_param *init_param);
 
/* Free the resources allocated by adgs6414d_init(). */
int adgs6414d_remove(struct adgs6414d_dev *dev);
 
#endif /* ADGS6414D_H_ */