admv8818.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef ADMV8818_H_
#define ADMV8818_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
/******************************************************************************/
#include <stdint.h>
#include "no_os_spi.h"
#include "no_os_util.h"
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
/* ADMV8818 Register Map */
#define ADMV8818_REG_SPI_CONFIG_A       0x0
#define ADMV8818_REG_SPI_CONFIG_B       0x1
#define ADMV8818_REG_CHIPTYPE           0x3
#define ADMV8818_REG_PRODUCT_ID_L       0x4
#define ADMV8818_REG_PRODUCT_ID_H       0x5
#define ADMV8818_REG_FAST_LATCH_POINTER     0x10
#define ADMV8818_REG_FAST_LATCH_STOP        0x11
#define ADMV8818_REG_FAST_LATCH_START       0x12
#define ADMV8818_REG_FAST_LATCH_DIRECTION   0x13
#define ADMV8818_REG_FAST_LATCH_STATE       0x14
#define ADMV8818_REG_WR0_SW         0x20
#define ADMV8818_REG_WR0_FILTER         0x21
#define ADMV8818_REG_WR1_SW         0x22
#define ADMV8818_REG_WR1_FILTER         0x23
#define ADMV8818_REG_WR2_SW         0x24
#define ADMV8818_REG_WR2_FILTER         0x25
#define ADMV8818_REG_WR3_SW         0x26
#define ADMV8818_REG_WR3_FILTER         0x27
#define ADMV8818_REG_WR4_SW         0x28
#define ADMV8818_REG_WR4_FILTER         0x29
#define ADMV8818_REG_LUT0_SW            0x100
#define ADMV8818_REG_LUT0_FILTER        0x101
#define ADMV8818_REG_LUT127_SW          0x1FE
#define ADMV8818_REG_LUT127_FILTER      0x1FF
 
/* ADMV8818_REG_SPI_CONFIG_A Map */
#define ADMV8818_SOFTRESET_N_MSK        NO_OS_BIT(7)
#define ADMV8818_LSB_FIRST_N_MSK        NO_OS_BIT(6)
#define ADMV8818_ENDIAN_N_MSK           NO_OS_BIT(5)
#define ADMV8818_SDOACTIVE_N_MSK        NO_OS_BIT(4)
#define ADMV8818_SDOACTIVE_MSK          NO_OS_BIT(3)
#define ADMV8818_ENDIAN_MSK         NO_OS_BIT(2)
#define ADMV8818_LSBFIRST_MSK           NO_OS_BIT(1)
#define ADMV8818_SOFTRESET_MSK          NO_OS_BIT(0)
 
/* ADMV8818_REG_SPI_CONFIG_B Map */
#define ADMV8818_SINGLE_INSTRUCTION_MSK     NO_OS_BIT(7)
#define ADMV8818_CSB_STALL_MSK          NO_OS_BIT(6)
#define ADMV8818_MASTER_SLAVE_RB_MSK        NO_OS_BIT(5)
#define ADMV8818_MASTER_SLAVE_TRANSFER_MSK  NO_OS_BIT(0)
 
/* ADMV8818_REG_WR0_SW Map */
#define ADMV8818_SW_IN_SET_WR0_MSK      NO_OS_BIT(7)
#define ADMV8818_SW_OUT_SET_WR0_MSK     NO_OS_BIT(6)
#define ADMV8818_SW_IN_WR0_MSK          NO_OS_GENMASK(5, 3)
#define ADMV8818_SW_OUT_WR0_MSK         NO_OS_GENMASK(2, 0)
 
/* ADMV8818_REG_WR0_FILTER Map */
#define ADMV8818_HPF_WR0_MSK            NO_OS_GENMASK(7, 4)
#define ADMV8818_LPF_WR0_MSK            NO_OS_GENMASK(3, 0)
 
/* Specifications */
#define ADMV8818_BUFF_SIZE_BYTES        3
#define ADMV8818_CHIP_ID            NO_OS_BIT(0)
#define ADMV8818_SPI_READ_CMD           NO_OS_BIT(7)
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
enum admv8818_filter_mode {
    ADMV8818_AUTO,
    ADMV8818_MANUAL,
};
 
struct admv8818_init_param {
    struct no_os_spi_init_param *spi_init;
    unsigned long long      rf_in;
    /* Filter Mode */
    enum admv8818_filter_mode   mode;
};
 
struct admv8818_dev {
    struct no_os_spi_desc       *spi_desc;
    unsigned long long      rf_in;
    /* Filter Mode */
    enum admv8818_filter_mode   mode;
};
 
int admv8818_spi_write(struct admv8818_dev *dev, uint16_t reg_addr,
               uint8_t data);
 
/* ADMV8818 Register Update */
int admv8818_spi_update_bits(struct admv8818_dev *dev, uint16_t reg_addr,
                 uint8_t mask, uint8_t data);
 
int admv8818_spi_read(struct admv8818_dev *dev, uint16_t reg_addr,
              uint8_t *data);
 
int admv8818_hpf_select(struct admv8818_dev *dev, unsigned long long freq);
 
int admv8818_read_hpf_freq(struct admv8818_dev *dev, unsigned long long *freq);
 
int admv8818_lpf_select(struct admv8818_dev *dev, unsigned long long freq);
 
int admv8818_read_lpf_freq(struct admv8818_dev *dev, unsigned long long *freq);
 
int admv8818_rfin_select(struct admv8818_dev *dev);
 
int admv8818_init(struct admv8818_dev **device,
          struct admv8818_init_param *init_param);
 
int admv8818_remove(struct admv8818_dev *dev);
 
#endif /* ADMV8818_H_ */