ltc3220.h

Go to the documentation of this file.

/***************************************************************************/
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef __LTC3220_H__
#define __LTC3220_H__
 
#include "no_os_i2c.h"
#include "no_os_gpio.h"
#include "no_os_util.h"
 
/*ltc3220 register addresses*/
#define LTC3220_REG_COMMAND                 0x00
#define LTC3220_REG_START_ULED              0x01 /*ULED1 */
#define LTC3220_REG_END_ULED                0x12 /*ULED18*/
#define LTC3220_REG_BLINK_GRAD              0x13
 
/*command register (0x00) */
#define LTC3220_COMMAND_QUICK_WRITE_MASK    NO_OS_BIT(0)
#define LTC3220_COMMAND_1P5X_MASK           NO_OS_BIT(1)
#define LTC3220_COMMAND_2X_MASK             NO_OS_BIT(2)
#define LTC3220_COMMAND_SHUTDOWN            NO_OS_BIT(3)
 
/* ULEDxx registers (0x01-0x12) */
#define LTC3220_ULED_MODE_MASK              NO_OS_GENMASK(7,6)
#define LTC3220_ULED_CURRENT_MASK           NO_OS_GENMASK(5,0)
#define LTC3220_ULED_CURRENT_MAX_STEP       64
 
/* Blink/Gradation (0x13) */
#define LTC3220_BLINK_LONG_MASK             NO_OS_BIT(4)
#define LTC3220_BLINK_FAST_MASK             NO_OS_BIT(3)
#define LTC3220_GRAD_SPD_MASK               NO_OS_GENMASK(2,1)
#define LTC3220_GRAD_DIRECTION_MASK         NO_OS_BIT(0)
#define LTC3220_GRAD_MAX_SPD                3
 
/* Reset timing */
#define LTC3220_RESET_DELAY_USEC            1 /*20ns min */
 
enum ltc3220_variant {
    LTC3220 = 0x1C,
    LTC3220_1 = 0x1D
};
 
enum ltc3220_uled_mode {
    LTC3220_MODE_NORMAL = 0,
    LTC3220_MODE_BLINK,
    LTC3220_MODE_GRADATION,
    LTC3220_MODE_GPO
};
 
struct ltc3220_command_cfg {
    bool is_quick_write;
    bool is_force_cpo_1p5x;
    bool is_force_cpo_2x;
    bool is_shutdown;
};
 
static const struct ltc3220_command_cfg command_reset;
 
struct ltc3220_uled_cfg {
    enum ltc3220_uled_mode mode;
    uint8_t current_level;
};
 
static const struct ltc3220_uled_cfg uled_reset;
 
struct ltc3220_blink_cfg {
    bool is_fast_on;
    bool is_long_period;
};
 
static const struct ltc3220_blink_cfg blink_reset;
 
struct ltc3220_grad_cfg {
    uint8_t speed;
    bool is_increasing;
};
 
static const struct ltc3220_grad_cfg grad_reset;
 
struct ltc3220_dev {
    struct no_os_i2c_desc *i2c_desc;
 
    struct no_os_gpio_desc *gpio_rst_desc;
 
    /* Contains configuration of each ULED */
    struct ltc3220_uled_cfg uleds[LTC3220_REG_END_ULED];
 
    /* Contains configuration of device */
    struct ltc3220_command_cfg command_config;
 
    /* Blink mode configuration */
    struct ltc3220_blink_cfg blink_config;
 
    /* Gradation mode configuration */
    struct ltc3220_grad_cfg gradation_config;
};
 
struct ltc3220_init_param {
    struct no_os_i2c_init_param i2c_init_param;
    struct no_os_gpio_init_param gpio_init_param;   /* for device reset */
};

int ltc3220_init(struct ltc3220_dev **device,
         struct ltc3220_init_param init_param);

int ltc3220_remove(struct ltc3220_dev *device);

int ltc3220_reset(struct ltc3220_dev *device);

int ltc3220_reg_write(struct ltc3220_dev *device, uint8_t reg_addr,
              uint8_t reg_data);

int ltc3220_set_uled_mode(struct ltc3220_dev *device, uint8_t uled_number,
              enum ltc3220_uled_mode mode);

int ltc3220_set_uled_current(struct ltc3220_dev *device, uint8_t uled_number,
                 uint8_t current_level);

int ltc3220_update_reg_uled(struct ltc3220_dev *device, uint8_t uled_number,
                enum ltc3220_uled_mode mode, uint8_t current_level);

int ltc3220_set_blink_fast(struct ltc3220_dev *device, bool is_fast_on);

int ltc3220_set_blink_long(struct ltc3220_dev *device, bool is_long_period);

int ltc3220_set_grad_speed(struct ltc3220_dev *device, uint8_t speed);

int ltc3220_set_grad_increasing(struct ltc3220_dev *device, bool is_increasing);

int ltc3220_update_reg_blink_grad(struct ltc3220_dev *device,
                  bool is_blink_fast, bool is_blink_long, bool is_grad_inc,
                  uint8_t grad_speed);

int ltc3220_set_quick_write(struct ltc3220_dev *device, bool is_quick_write);

int ltc3220_set_cpo_1x(struct ltc3220_dev *device, bool is_force_cpo_1x);

int ltc3220_set_cpo_1p5x(struct ltc3220_dev *device, bool is_force_cpo_1p5x);

int ltc3220_set_cpo_2x(struct ltc3220_dev *device, bool is_force_cpo_2x);

int ltc3220_set_shutdown(struct ltc3220_dev *device, bool is_shutdown);
 

int ltc3220_update_reg_command(struct ltc3220_dev *device, bool is_shutdown,
                   bool is_force_cpo_2x, bool is_force_cpo_1p5x,
                   bool is_quick_write);
 
#endif  /*__LTC3220_H__*/
 
#ifdef __cplusplus
}
#endif