lt8722.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef __LT8722_H__
#define __LT8722_H__
 
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "no_os_units.h"
#include "no_os_util.h"
 
#define LT8722_CRC_POLYNOMIAL          0x07
 
#define LT8722_MAX_REGISTER_SIZE       4
#define LT8722_NUM_REGISTERS           8
 
// LT8722 SPI Command
#define LT8722_STATUS_ACQUISITION_COMMAND    0xF0
#define LT8722_DATA_WRITE_COMMAND            0xF2
#define LT8722_DATA_READ_COMMAND             0xF4
 
// LT8722 SPI Command Size in Bytes
#define LT8722_STATUS_ACQUISITION_COMMAND_SIZE   4
#define LT8722_DATA_WRITE_COMMAND_SIZE           8
#define LT8722_DATA_READ_COMMAND_SIZE            8
 
// LT8722 SPI Acknowledge
#define LT8722_ACK_ACKNOWLEDGE              0xA5
#define LT8722_ACK_NON_ACKNOWLEDGE          0xC3
#define LT8722_ACK_UNSUPPORTED_ADDRESS      0x0F
#define LT8722_ACK_STUCK_AT_0               0x00
#define LT8722_ACK_STUCK_AT_1               0xFF
 
// LT8722 SPI Register Address
#define LT8722_SPIS_COMMAND                0x00
#define LT8722_SPIS_STATUS                 0x01
#define LT8722_SPIS_DAC_ILIMN              0x02
#define LT8722_SPIS_DAC_ILIMP              0x03
#define LT8722_SPIS_DAC                    0x04
#define LT8722_SPIS_OV_CLAMP               0x05
#define LT8722_SPIS_UV_CLAMP               0x06
#define LT8722_SPIS_AMUX                   0x07
 
// LT8722 SPI Register Size in Bits
#define LT8722_SPIS_COMMAND_SIZE           22
#define LT8722_SPIS_STATUS_SIZE            11
#define LT8722_SPIS_DAC_ILIMN_SIZE         9
#define LT8722_SPIS_DAC_ILIMP_SIZE         9
#define LT8722_SPIS_DAC_SIZE               32
#define LT8722_SPIS_OV_CLAMP_SIZE          4
#define LT8722_SPIS_UV_CLAMP_SIZE          4
#define LT8722_SPIS_AMUX_SIZE              7
 
// LT8722 SPI Register Mask
#define LT8722_SPIS_COMMAND_MASK           NO_OS_GENMASK(21, 0)
#define LT8722_SPIS_STATUS_MASK            NO_OS_GENMASK(10, 0)
#define LT8722_SPIS_DAC_ILIMN_MASK         NO_OS_GENMASK(8, 0)
#define LT8722_SPIS_DAC_ILIMP_MASK         NO_OS_GENMASK(8, 0)
#define LT8722_SPIS_DAC_MASK               NO_OS_GENMASK(31, 0)
#define LT8722_SPIS_OV_CLAMP_MASK          NO_OS_GENMASK(3, 0)
#define LT8722_SPIS_UV_CLAMP_MASK          NO_OS_GENMASK(3, 0)
#define LT8722_SPIS_AMUX_MASK              NO_OS_GENMASK(6, 0)
 
// LT8722 SPI Register Default Value
#define LT8722_SPIS_COMMAND_DEFAULT_VALUE   0x08A214
#define LT8722_SPIS_STATUS_DEFAULT_VALUE    0x0
#define LT8722_SPIS_DAC_ILIMN_DEFAULT_VALUE 0x1FF
#define LT8722_SPIS_DAC_ILIMP_DEFAULT_VALUE 0x000
#define LT8722_SPIS_DAC_DEFAULT_VALUE       0xFF000000
#define LT8722_SPIS_OV_CLAMP_DEFAULT_VALUE  0xF
#define LT8722_SPIS_UV_CLAMP_DEFAULT_VALUE  0x0
#define LT8722_SPIS_AMUX_DEFAULT_VALUE      0x00
 
// LT8722 SPIS_COMMAND Register
#define LT8722_ENABLE_REQ_MASK             NO_OS_BIT(0)
#define LT8722_SWEN_REQ_MASK               NO_OS_BIT(1)
#define LT8722_SW_FRQ_SET_MASK             NO_OS_GENMASK(4, 2)
#define LT8722_SW_FRQ_ADJ_MASK             NO_OS_GENMASK(6, 5)
#define LT8722_SYS_DC_MASK                 NO_OS_GENMASK(8, 7)
#define LT8722_VCC_VREG_MASK               NO_OS_BIT(9)
#define LT8722_SW_VC_INT_MASK              NO_OS_GENMASK(13, 11)
#define LT8722_SPI_RST_MASK                NO_OS_BIT(14)
#define LT8722_PWR_LIM_POS                 15
#define LT8722_PWR_LIM_MASK                NO_OS_GENMASK(18, 15)
 
// LT8722 SPIS_COMMAND Register SPI_RST
#define LT8722_SPI_RST_RESET               0b1
 
// LT8722 SPIS_STATUS Register
#define LT8722_SWEN_MASK                   NO_OS_BIT(0)
#define LT8722_SRVO_ILIM_MASK              NO_OS_BIT(1)
#define LT8722_SRVO_PLIM_MASK              NO_OS_BIT(2)
#define LT8722_MIN_OT_MASK                 NO_OS_BIT(3)
#define LT8722_POR_OCC_MASK                NO_OS_BIT(4)
#define LT8722_OVER_CURRENT_MASK           NO_OS_BIT(5)
#define LT8722_TSD_MASK                    NO_OS_BIT(6)
#define LT8722_VCC_UVLO_MASK               NO_OS_BIT(7)
#define LT8722_VDDIO_UVLO_MASK             NO_OS_BIT(8)
#define LT8722_CP_UVLO_MASK                NO_OS_BIT(9)
#define LT8722_V2P5_UVLO_MASK              NO_OS_BIT(10)
 
// LT8722 faults mask
#define LT8722_FAULTS_MASK                 NO_OS_GENMASK(10, 5)
 
// LT8722 SPIS_DAC_ILIMN Register
#define LT8722_SPIS_DAC_ILIMN_MASK         NO_OS_GENMASK(8, 0)
 
// LT8722 SPIS_DAC_ILIMN Register SPIS_DAC_ILIMN
#define LT8722_SPIS_DAC_ILIMN_MIN          0x030
#define LT8722_SPIS_DAC_ILIMN_MAX          0x1FF
 
// LT8722 SPIS_DAC_ILIMP Register
#define LT8722_SPIS_DAC_ILIMP_MASK         NO_OS_GENMASK(8, 0)
 
// LT8722 SPIS_DAC_ILIMP Register SPIS_DAC_ILIMP
#define LT8722_SPIS_DAC_ILIMP_MIN          0x000
#define LT8722_SPIS_DAC_ILIMP_MAX          0x1CE
 
// LT8722 SPIS_DAC Register
#define LT8722_SPIS_DAC_MASK               NO_OS_GENMASK(31, 0)
 
// LT8722 SPIS_OV_CLAMP Register
#define LT8722_SPIS_OV_CLAMP_MASK          NO_OS_GENMASK(3, 0)
 
// LT8722 SPIS_UV_CLAMP Register
#define LT8722_SPIS_UV_CLAMP_MASK          NO_OS_GENMASK(3, 0)
 
// LT8722 SPIS_AMUX Register
#define LT8722_AMUX_MASK                   NO_OS_GENMASK(3, 0)
#define LT8722_AMUX_TEST_MASK              NO_OS_GENMASK(5, 4)
#define LT8722_AOUT_EN_MASK                NO_OS_BIT(6)
 
#define LT8722_DAC_RESOLUTION              25
#define LT8722_DAC_OFFSET                  1250000000LL  // nanovolts
#define LT8722_DAC_VREF                    2500000000LL // nanovolts
#define LT8722_VOLTAGE_SCALE               NANO

enum lt8722_enable_req {
    LT8722_ENABLE_REQ_DISABLED,
    LT8722_ENABLE_REQ_ENABLED,
};
enum lt8722_enable_req {…};

enum lt8722_swen_req {
    LT8722_SWEN_REQ_DISABLED,
    LT8722_SWEN_REQ_ENABLED,
};
enum lt8722_swen_req {…};

enum lt8722_sw_frq_set {
    LT8722_SW_FRQ_SET_0_5MHZ,
    LT8722_SW_FRQ_SET_1MHZ,
    LT8722_SW_FRQ_SET_1_5MHZ,
    LT8722_SW_FRQ_SET_2MHZ,
    LT8722_SW_FRQ_SET_2_5MHZ,
    LT8722_SW_FRQ_SET_3MHZ,
    LT8722_SW_FRQ_SET_3MHZ_2,
    LT8722_SW_FRQ_SET_3MHZ_3,
};
enum lt8722_sw_frq_set {…};

enum lt8722_sw_frq_adj {
    LT8722_SW_FRQ_ADJ_0_PERCENT,
    LT8722_SW_FRQ_ADJ_POSITIVE_15_PERCENT,
    LT8722_SW_FRQ_ADJ_NEGATIVE_15_PERCENT,
    LT8722_SW_FRQ_ADJ_0_PERCENT_2,
};
enum lt8722_sw_frq_adj {…};

enum lt8722_vcc_vreg {
    LT8722_VCC_VREG_3_1V,
    LT8722_VCC_VREG_3_4V,
};
enum lt8722_vcc_vreg {…};

enum lt8722_sw_vc_int {
    LT8722_SW_VC_INT_0_252A,
    LT8722_SW_VC_INT_0_594A,
    LT8722_SW_VC_INT_0_936A,
    LT8722_SW_VC_INT_1_278A,
    LT8722_SW_VC_INT_1_620A,
    LT8722_SW_VC_INT_1_962A,
    LT8722_SW_VC_INT_2_304A,
    LT8722_SW_VC_INT_2_646A,
};
enum lt8722_sw_vc_int {…};

enum lt8722_pwr_lim {
    LT8722_PWR_LIM_2W,
    LT8722_PWR_LIM_NO_LIMIT,
    LT8722_PWR_LIM_3W,
    LT8722_PWR_LIM_3_5W,
};
enum lt8722_pwr_lim {…};

enum lt8722_sys_dc {
    LT8722_SYS_DC_20_80_DUTY_CYCLE,
    LT8722_SYS_DC_15_85_DUTY_CYCLE,
    LT8722_SYS_DC_10_90_DUTY_CYCLE,
};
enum lt8722_sys_dc {…};

enum lt8722_amux {
    LT8722_AMUX_VILIMP,
    LT8722_AMUX_VILIMN,
    LT8722_AMUX_VDAC,
    LT8722_AMUX_VOUT,
    LT8722_AMUX_IOUT,
    LT8722_AMUX_V2P5,
    LT8722_AMUX_V1P25,
    LT8722_AMUX_V1P65,
    LT8722_AMUX_VTEMP,
    LT8722_AMUX_VIN,
    LT8722_AMUX_VCC,
    LT8722_AMUX_VDDIO,
    LT8722_AMUX_VSFB,
    LT8722_AMUX_VSFB_2,
    LT8722_AMUX_VSFB_3,
    LT8722_AMUX_VSFB_4
};
enum lt8722_amux {…};

enum lt8722_aout_en {
    LT8722_AOUT_EN_DISABLED,
    LT8722_AOUT_EN_ENABLED,
};
enum lt8722_aout_en {…};

struct lt8722_reg {
    uint8_t address;
    uint32_t default_val;
    uint8_t size;
};
struct lt8722_reg {…};

struct lt8722_command {
    uint8_t byte;
    uint8_t size;
};
struct lt8722_command {…};

struct lt8722_packet {
    struct lt8722_command command;
    struct lt8722_reg reg;
    uint32_t data;
    uint8_t crc;
    uint8_t ack;
    uint16_t status;
};
struct lt8722_packet {…};

struct lt8722_init_param {
    struct no_os_spi_init_param *spi;
    struct no_os_gpio_init_param *gpio_swen;
    struct no_os_gpio_init_param *gpio_en;
    bool start_up_sequence;
};
struct lt8722_init_param {…};

struct lt8722_dev {
    struct no_os_spi_desc *spi;
    struct no_os_gpio_desc *gpio_swen;
    struct no_os_gpio_desc *gpio_en;
    bool start_up_sequence;
    uint16_t status;
};
struct lt8722_dev {…};
 
extern struct lt8722_reg lt8722_regs[LT8722_NUM_REGISTERS];

int32_t lt8722_voltage_to_dac(int64_t voltage);

int64_t lt8722_dac_to_voltage(int32_t dac);

int lt8722_transaction(struct lt8722_dev *dev, struct lt8722_packet *packet);

int lt8722_reg_read(struct lt8722_dev *dev, uint8_t address, uint32_t *data);

int lt8722_reg_write(struct lt8722_dev *dev, uint8_t address, uint32_t data);

int lt8722_reg_write_mask(struct lt8722_dev *dev, uint8_t address,
              uint32_t mask, uint32_t data);

int lt8722_get_status(struct lt8722_dev *dev, uint16_t *status);

int lt8722_clear_faults(struct lt8722_dev *dev);

int lt8722_set_enable_req(struct lt8722_dev *dev, bool value);

int lt8722_get_enable_req(struct lt8722_dev *dev, bool *value);

int lt8722_set_swen_req(struct lt8722_dev *dev, bool value);

int lt8722_get_swen_req(struct lt8722_dev *dev, bool *value);

int lt8722_set_sw_frq_set(struct lt8722_dev *dev, enum lt8722_sw_frq_set value);

int lt8722_get_sw_frq_set(struct lt8722_dev *dev,
              enum lt8722_sw_frq_set *value);

int lt8722_set_sw_frq_adj(struct lt8722_dev *dev, enum lt8722_sw_frq_adj value);

int lt8722_get_sw_frq_adj(struct lt8722_dev *dev,
              enum lt8722_sw_frq_adj *value);

int lt8722_set_vcc_vreg(struct lt8722_dev *dev, enum lt8722_vcc_vreg value);

int lt8722_get_vcc_vreg(struct lt8722_dev *dev, enum lt8722_vcc_vreg *value);

int lt8722_set_sw_vc_int(struct lt8722_dev *dev, enum lt8722_sw_vc_int value);

int lt8722_get_sw_vc_int(struct lt8722_dev *dev, enum lt8722_sw_vc_int *value);

int lt8722_set_pwr_lim(struct lt8722_dev *dev, enum lt8722_pwr_lim value);

int lt8722_get_pwr_lim(struct lt8722_dev *dev, enum lt8722_pwr_lim *value);

int lt8722_set_sys_dc(struct lt8722_dev *dev, enum lt8722_sys_dc value);

int lt8722_get_sys_dc(struct lt8722_dev *dev, enum lt8722_sys_dc *value);

int lt8722_set_spis_dac_ilimn(struct lt8722_dev *dev, uint16_t value);

int lt8722_get_spis_dac_ilimn(struct lt8722_dev *dev, uint16_t *value);

int lt8722_set_spis_dac_ilimp(struct lt8722_dev *dev, uint16_t value);

int lt8722_get_spis_dac_ilimp(struct lt8722_dev *dev, uint16_t *value);

int lt8722_set_dac(struct lt8722_dev *dev, uint32_t value);

int lt8722_get_dac(struct lt8722_dev *dev, uint32_t *value);

int lt8722_set_spis_ov_clamp(struct lt8722_dev *dev, uint8_t value);

int lt8722_get_spis_ov_clamp(struct lt8722_dev *dev, uint8_t *value);

int lt8722_set_spis_uv_clamp(struct lt8722_dev *dev, uint8_t value);

int lt8722_get_spis_uv_clamp(struct lt8722_dev *dev, uint8_t *value);

int lt8722_set_aout_en(struct lt8722_dev *dev, bool value);

int lt8722_get_aout_en(struct lt8722_dev *dev, bool *value);

int lt8722_set_amux(struct lt8722_dev *dev, enum lt8722_amux value,
            uint8_t test);

int lt8722_get_amux(struct lt8722_dev *dev, enum lt8722_amux *value,
            uint8_t *test);

int lt8722_set_output_voltage(struct lt8722_dev *dev, int64_t value);

int lt8722_get_output_voltage(struct lt8722_dev *dev, int64_t *value);

int lt8722_shutdown(struct lt8722_dev *dev);

int lt8722_reset(struct lt8722_dev *dev);

int lt8722_set_swen_pin(struct lt8722_dev *dev, uint8_t value);

int lt8722_get_swen_pin(struct lt8722_dev *dev, uint8_t *value);

int lt8722_set_en_pin(struct lt8722_dev *dev, uint8_t value);

int lt8722_get_en_pin(struct lt8722_dev *dev, uint8_t *value);

int lt8722_init(struct lt8722_dev **device,
        struct lt8722_init_param *init_param);

int lt8722_remove(struct lt8722_dev *dev);
 
#endif