max14916.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _MAX14916_H
#define _MAX14916_H
 
#include <stdint.h>
#include <stdbool.h>
#include "max149x6-base.h"
#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "no_os_util.h"
 
#define MAX14916_CHANNELS       8
 
#define MAX14916_SETOUT_REG     0x0
#define MAX14916_SET_FLED_REG       0x1
#define MAX14916_SET_SLED_REG       0x2
#define MAX14916_INT_REG        0x3
#define MAX14916_OVR_LD_REG     0x4
#define MAX14916_CURR_LIM_REG       0x5
#define MAX14916_OW_OFF_FAULT_REG   0x6
#define MAX14916_OW_ON_FAULT_REG    0x7
#define MAX14916_SHD_VDD_FAULT_REG  0x8
#define MAX14916_GLOB_ERR_REG       0x9
#define MAX14916_OW_OFF_EN_REG      0xA
#define MAX14916_OW_ON_EN_REG       0xB
#define MAX14916_SHD_VDD_EN_REG     0xC
#define MAX14916_CONFIG1_REG        0xD
#define MAX14916_CONFIG2_REG        0xE
#define MAX14916_MASK_REG       0xF
 
#define MAX14916_SETOUT_MASK(x)     NO_OS_BIT(x)
#define MAX14916_SLED_CH_MASK(x)    NO_OS_BIT(x)
#define MAX14916_SLED_MASK      NO_OS_BIT(1)
#define MAX14916_FLED_MASK      NO_OS_BIT(0)
#define MAX14916_FLED_STRETCH_MASK  NO_OS_GENMASK(2, 1)
#define MAX14916_WD_MASK        NO_OS_GENMASK(7, 6)
#define MAX14916_OW_OFF_CS_MASK     NO_OS_GENMASK(5, 4)
#define MAX14916_SHT_VDD_THR_MASK   NO_OS_GENMASK(3, 2)
 
enum max14916_fled_time {
    MAX14916_FLED_TIME_DISABLED,
    MAX14916_FLED_TIME_1S,
    MAX14916_FLED_TIME_2S,
    MAX14916_FLED_TIME_3S
};
 
enum max14916_sled_state {
    MAX14916_SLED_OFF,
    MAX14916_SLED_ON
};
 
enum max14916_wd {
    MAX14916_WD_DISABLED,
    MAX14916_WD_200MS,
    MAX14916_WD_600MS,
    MAX14916_WD_1200MS
};
 
enum max14916_ow_off_cs {
    MAX14916_OW_OFF_CS_20UA,
    MAX14916_OW_OFF_CS_100UA,
    MAX14916_OW_OFF_CS_300UA,
    MAX14916_OW_OFF_CS_600UA
};
 
enum max14916_sht_vdd_thr {
    MAX14916_SHT_VDD_THR_9V,
    MAX14916_SHT_VDD_THR_10V,
    MAX14916_SHT_VDD_THR_12V,
    MAX14916_SHT_VDD_THR_14V
};
 
int max14916_ch_get(struct max149x6_desc *, uint32_t, uint32_t *);
 
int max14916_ch_set(struct max149x6_desc *, uint32_t, uint32_t);
 
int max14916_sled_set(struct max149x6_desc *, uint32_t,
              enum max14916_sled_state);
 
int max14916_fled_time_set(struct max149x6_desc *, enum max14916_fled_time);
 
int max14916_set_wd(struct max149x6_desc *, enum max14916_wd);
 
int max14916_set_ow_off(struct max149x6_desc *, enum max14916_ow_off_cs);
 
int max14916_set_sht_vdd_thr(struct max149x6_desc *, enum max14916_sht_vdd_thr);
 
int max14916_init(struct max149x6_desc **, struct max149x6_init_param *);
 
int max14916_remove(struct max149x6_desc *);
 
#endif