ltc4286.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Analog Devices Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_SENSOR_LTC4286_H_
#define ZEPHYR_INCLUDE_DRIVERS_SENSOR_LTC4286_H_

 
#include <zephyr/types.h>
#include <zephyr/drivers/sensor.h>

enum ltc4286_sensor_chan {
        SENSOR_CHAN_LTC4286_VIN = SENSOR_CHAN_PRIV_START, 
        SENSOR_CHAN_LTC4286_ADC,                          
        SENSOR_CHAN_LTC4286_CONFIG,                       
        SENSOR_CHAN_LTC4286_END,                          
};

enum ltc4286_trig_chan {
        SENSOR_CHAN_LTC4286_TRIG_POWER_GOOD =
                SENSOR_CHAN_LTC4286_END,     
        SENSOR_CHAN_LTC4286_TRIG_COMPARATOR, 
        SENSOR_CHAN_LTC4286_TRIG_ALERT,      
        SENSOR_CHAN_LTC4286_TRIG_END,        
};

enum ltc4286_status_chan {
        SENSOR_CHAN_LTC4286_STATUS =
                SENSOR_CHAN_LTC4286_TRIG_END,       
        SENSOR_CHAN_LTC4286_STATUS_VOUT,            
        SENSOR_CHAN_LTC4286_STATUS_IOUT,            
        SENSOR_CHAN_LTC4286_STATUS_INPUT,           
        SENSOR_CHAN_LTC4286_STATUS_TEMP,            
        SENSOR_CHAN_LTC4286_STATUS_CML,             
        SENSOR_CHAN_LTC4286_STATUS_OTHER,           
        SENSOR_CHAN_LTC4286_STATUS_MFR_SPEC,        
        SENSOR_CHAN_LTC4286_STATUS_MFR_SYS_STATUS1, 
        SENSOR_CHAN_LTC4286_STATUS_MFR_SYS_STATUS2, 
        SENSOR_CHAN_LTC4286_STATUS_END,             
};

enum ltc4286_mfr_chan {
        SENSOR_CHAN_LTC4286_MFR_CONFIG = SENSOR_CHAN_LTC4286_STATUS_END,
        SENSOR_CHAN_LTC4286_MFR_FLT_CONFIG,       
        SENSOR_CHAN_LTC4286_MFR_PMB_STATUS,       
        SENSOR_CHAN_LTC4286_MFR_PADS_LIVE_STATUS, 
        SENSOR_CHAN_LTC4286_MFR_COMMON,           
        SENSOR_CHAN_LTC4286_MFR_REBOOT_CONTROL,   
        SENSOR_CHAN_LTC4286_MFR_SHUTDOWN_CAUSE,   
        SENSOR_CHAN_LTC4286_MFR_END,              
};

enum ltc4286_fault_response_chan {
        SENSOR_CHAN_LTC4286_FAULT_RESP_FET = SENSOR_CHAN_LTC4286_MFR_END, 
        SENSOR_CHAN_LTC4286_FAULT_RESP_END,                               
};

enum ltc4286_config_attr {
        SENSOR_ATTR_LTC4286_CONFIG_OPERATION = SENSOR_ATTR_PRIV_START,
        SENSOR_ATTR_LTC4286_CONFIG_CLEAR_FAULTS,  
        SENSOR_ATTR_LTC4286_CONFIG_WRITE_PROTECT, 
        SENSOR_ATTR_LTC4286_CONFIG_END,           
};

enum ltc4286_status_attr {
        SENSOR_ATTR_LTC4286_STATUS_VOUT = SENSOR_ATTR_LTC4286_CONFIG_END,
        SENSOR_ATTR_LTC4286_STATUS_IOUT,      
        SENSOR_ATTR_LTC4286_STATUS_INPUT,     
        SENSOR_ATTR_LTC4286_STATUS_MFRSPEC,   
        SENSOR_ATTR_LTC4286_STATUS_PG,        
        SENSOR_ATTR_LTC4286_STATUS_OTHER,     
        SENSOR_ATTR_LTC4286_STATUS_UNKNOWN,   
        SENSOR_ATTR_LTC4286_STATUS_BUSY,      
        SENSOR_ATTR_LTC4286_STATUS_OFF,       
        SENSOR_ATTR_LTC4286_STATUS_IOUT_OC,   
        SENSOR_ATTR_LTC4286_STATUS_VIN_UV,    
        SENSOR_ATTR_LTC4286_STATUS_TEMP,      
        SENSOR_ATTR_LTC4286_STATUS_CML,       
        SENSOR_ATTR_LTC4286_STATUS_NOT_CLEAR, 
        SENSOR_ATTR_LTC4286_STATUS_END,       
};

enum ltc4286_status_vout_attr {
        SENSOR_ATTR_LTC4286_STATUS_VOUT_OV = SENSOR_ATTR_LTC4286_STATUS_END,
        SENSOR_ATTR_LTC4286_STATUS_VOUT_UV,  
        SENSOR_ATTR_LTC4286_STATUS_VOUT_END, 
};

enum ltc4286_status_iout_attr {
        SENSOR_ATTR_LTC4286_STATUS_IOUT_OC_FAULT = SENSOR_ATTR_LTC4286_STATUS_VOUT_END,
        SENSOR_ATTR_LTC4286_STATUS_IOUT_OC_WARN, 
        SENSOR_ATTR_LTC4286_STATUS_IOUT_END,     
};

enum ltc4286_status_input_attr {
        SENSOR_ATTR_LTC4286_STATUS_VIN_OV_FAULT = SENSOR_ATTR_LTC4286_STATUS_IOUT_END,
        SENSOR_ATTR_LTC4286_STATUS_VIN_OV_WARN,  
        SENSOR_ATTR_LTC4286_STATUS_VIN_UV_FAULT, 
        SENSOR_ATTR_LTC4286_STATUS_VIN_UV_WARN,  
        SENSOR_ATTR_LTC4286_STATUS_PIN_OP_WARN,  
        SENSOR_ATTR_LTC4286_STATUS_INPUT_END,    
};

enum ltc4286_status_temp_attr {
        SENSOR_ATTR_LTC4286_STATUS_TEMP_OT_FAULT = SENSOR_ATTR_LTC4286_STATUS_INPUT_END,
        SENSOR_ATTR_LTC4286_STATUS_TEMP_OT_WARN, 
        SENSOR_ATTR_LTC4286_STATUS_TEMP_UT_WARN, 
        SENSOR_ATTR_LTC4286_STATUS_TEMP_END,     
};

enum ltc4286_status_cml_attr {
        SENSOR_ATTR_LTC4286_STATUS_CML_BAD_CMD = SENSOR_ATTR_LTC4286_STATUS_TEMP_END,
        SENSOR_ATTR_LTC4286_STATUS_CML_BAD_DATA,     
        SENSOR_ATTR_LTC4286_STATUS_CML_BAD_PEC_FAIL, 
        SENSOR_ATTR_LTC4286_STATUS_CML_MISC_FAULT,   
        SENSOR_ATTR_LTC4286_STATUS_CML_END,          
};

enum ltc4286_status_mfr_spec_attr {
        SENSOR_ATTR_LTC4286_STATUS_MFR_SPEC_EN_CHANGED = SENSOR_ATTR_LTC4286_STATUS_CML_END,
        SENSOR_ATTR_LTC4286_STATUS_MFR_SPEC_TSD_FAULT,     
        SENSOR_ATTR_LTC4286_STATUS_MFR_SPEC_VDD_UVLO,      
        SENSOR_ATTR_LTC4286_STATUS_MFR_SPEC_PIN_OP2_FAULT, 
        SENSOR_ATTR_LTC4286_STATUS_MFR_SPEC_PIN_OP1_FAULT, 
        SENSOR_ATTR_LTC4286_STATUS_MFR_SPEC_FET_BAD_FAULT, 
        SENSOR_ATTR_LTC4286_STATUS_MFR_SPEC_END,           
};

enum ltc4286_status_other_attr {
        SENSOR_ATTR_LTC4286_STATUS_OTHER_FIRST_ALERT = SENSOR_ATTR_LTC4286_STATUS_MFR_SPEC_END,
        SENSOR_ATTR_LTC4286_STATUS_OTHER_END, 
};

enum ltc4286_status_mfr_sys_status_attr {
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_STAT1_ALERT = SENSOR_ATTR_LTC4286_STATUS_OTHER_END,
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_STAT1_L_ALERT, 
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_POWER_LOSS,    
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_RESET_DONE,    
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_AVG_DONE,      
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_ADC_CONV,      
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_STAT2_SET,
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_POWER_FAILED_WARN, 
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_FET_SHORT_WARN,    
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_VDS_UV_WARN,       
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_VDS_OV_WARN,       
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_IOUT_UC_WARN, 
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_PIN_UP_WARN,  
        SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_END,          
};

enum ltc4286_adc_attr {
        SENSOR_ATTR_LTC4286_ADC_VDS_SELECT = SENSOR_ATTR_LTC4286_STATUS_MFR_SYS_END,
        SENSOR_ATTR_LTC4286_ADC_VIN_VOUT_SELECT, 
        SENSOR_ATTR_LTC4286_ADC_DISP_AVG,        
        SENSOR_ATTR_LTC4286_ADC_AVG_SELECT,      
        SENSOR_ATTR_LTC4286_ADC_END,             
};

enum ltc4286_fault_response_attr {
        SENSOR_ATTR_LTC4286_FAULT_RESPONSE =
                SENSOR_ATTR_LTC4286_ADC_END,   
        SENSOR_ATTR_LTC4286_FAULT_RETRY,       
        SENSOR_ATTR_LTC4286_FAULT_OP_TIMER,    
        SENSOR_ATTR_LTC4286_FAULT_OV_RESPONSE, 
        SENSOR_ATTR_LTC4286_FAULT_OV_RETRY,    
        SENSOR_ATTR_LTC4286_FAULT_UV_RESPONSE, 
        SENSOR_ATTR_LTC4286_FAULT_UV_RETRY,    
        SENSOR_ATTR_LTC4286_FAULT_END,         
};

enum ltc4286_mfr_flt_attr {
        SENSOR_ATTR_LTC4286_MFR_FLT_OP_TO_FAULT = SENSOR_ATTR_LTC4286_FAULT_END,
        SENSOR_ATTR_LTC4286_MFR_FLT_OT_TO_FAULT, 
        SENSOR_ATTR_LTC4286_MFR_FLT_END,         
};

enum ltc4286_reboot_control_attr {
        SENSOR_ATTR_LTC4286_REBOOT_CONTROL_INIT = SENSOR_ATTR_LTC4286_MFR_FLT_END,
        SENSOR_ATTR_LTC4286_REBOOT_CONTROL_DELAY, 
        SENSOR_ATTR_LTC4286_REBOOT_CONTROL_END,   
};

enum ltc4286_mfr_config_attr {
        SENSOR_ATTR_LTC4286_MFR_CONFIG_ILIM = SENSOR_ATTR_LTC4286_REBOOT_CONTROL_END,
        SENSOR_ATTR_LTC4286_MFR_CONFIG_VRANGE_SEL,          
        SENSOR_ATTR_LTC4286_MFR_CONFIG_VPWR_SEL,            
        SENSOR_ATTR_LTC4286_MFR_CONFIG_PMBUS_1MBIT,         
        SENSOR_ATTR_LTC4286_MFR_CONFIG_RESET_FAULT,         
        SENSOR_ATTR_LTC4286_MFR_CONFIG_PWR_GOOD_RESET_CTRL, 
        SENSOR_ATTR_LTC4286_MFR_CONFIG_MASS_WRITE,          
        SENSOR_ATTR_LTC4286_MFR_CONFIG_EXT_TEMP,            
        SENSOR_ATTR_LTC4286_MFR_CONFIG_DEBOUNCE_TIMER,      
        SENSOR_ATTR_LTC4286_MFR_CONFIG_END,                 
};

enum ltc4286_status_word_field {
        LTC4286_STATUS_WORD_VOUT_BIT = BIT(15),    
        LTC4286_STATUS_WORD_IOUT_BIT = BIT(14),    
        LTC4286_STATUS_WORD_INPUT_BIT = BIT(13),   
        LTC4286_STATUS_WORD_MFRSPEC_BIT = BIT(12), 
        LTC4286_STATUS_WORD_FET_UV_THRES_BIT = BIT(11), 
        LTC4286_STATUS_WORD_OTHER_BIT = BIT(9),         
        LTC4286_STATUS_WORD_UNKNOWN_BIT = BIT(8),       
        LTC4286_STATUS_WORD_BUSY_BIT = BIT(7),          
        LTC4286_STATUS_WORD_OFF_BIT = BIT(6),           
        LTC4286_STATUS_WORD_IOUT_OTHRES_BIT =
                BIT(4), 
        LTC4286_STATUS_WORD_VIN_UTHRES_BIT =
                BIT(3),                           
        LTC4286_STATUS_WORD_TEMP_BIT = BIT(2),    
        LTC4286_STATUS_WORD_COMLINE_BIT = BIT(1), 
        LTC4286_STATUS_WORD_NOT_CLEAR_BIT = BIT(0), 
};

enum ltc4286_status_vout_field {
        LTC4286_VOUT_UV_WARNING_BIT = BIT(5), 
        LTC4286_VOUT_OV_WARNING_BIT = BIT(6), 
};

enum ltc4286_status_iout_field {
        LTC4286_IOUT_OC_WARNING_BIT = BIT(5), 
        LTC4286_IOUT_OC_FAULT_BIT = BIT(7),   
};

enum ltc4286_status_input_field {
        LTC4286_PIN_OP_WARNING_BIT = BIT(0), 
        LTC4286_VIN_UV_FAULT_BIT = BIT(4),   
        LTC4286_VIN_UV_WARNING_BIT = BIT(5), 
        LTC4286_VIN_OV_WARNING_BIT = BIT(6), 
        LTC4286_VIN_OV_FAULT_BIT = BIT(7),   
};

enum ltc4286_status_temp_field {
        LTC4286_TEMP_UT_WARNING_BIT = BIT(5), 
        LTC4286_TEMP_OT_WARNING_BIT = BIT(6), 
        LTC4286_TEMP_OT_FAULT_BIT = BIT(7),   
};

enum ltc4286_status_cml_field {
        LTC4286_MISC_FAULT_BIT = BIT(1), 
        LTC4286_PEC_FAILED_BIT = BIT(5), 
        LTC4286_BAD_DATA_BIT = BIT(6),   
        LTC4286_BAD_CMD_BIT = BIT(7),    
};

enum ltc4286_status_other_field {
        LTC4286_OTHER_FIRST_ALERT_BIT = BIT(0), 
};

enum ltc4286_status_mfr_spec_field {
        LTC4286_MFR_SPEC_FET_BAD_FAULT_BIT = BIT(2), 
        LTC4286_MFR_SPEC_PIN_OP1_FAULT_BIT = BIT(3), 
        LTC4286_MFR_SPEC_PIN_OP2_FAULT_BIT = BIT(4), 
        LTC4286_MFR_SPEC_VDD_UVLO_BIT = BIT(5),      
        LTC4286_MFR_SPEC_TSD_FAULT_BIT = BIT(6),     
        LTC4286_MFR_SPEC_EN_CHANGED_BIT = BIT(7),    
};

enum ltc4286_mfr_sys_status1_field {
        LTC4286_MFR_SYS_STATUS1_ADC_CONV_BIT = BIT(6),     
        LTC4286_MFR_SYS_STATUS1_AVERAGE_DONE_BIT = BIT(7), 
        LTC4286_MFR_SYS_STATUS1_RESET_DONE_BIT = BIT(10),  
        LTC4286_MFR_SYS_STATUS1_POWER_LOSS_BIT = BIT(11),  
        LTC4286_MFR_SYS_STATUS1_L_ALERT_BIT = BIT(14),     
        LTC4286_MFR_SYS_STATUS1_ALERT_BIT = BIT(15),       
};

enum ltc4286_mfr_sys_status2_field {
        LTC4286_MFR_SYS_STATUS2_PIN_UP_WARNING_BIT = BIT(0), 
        LTC4286_MFR_SYS_STATUS2_IOUT_UC_WARNING_BIT = BIT(1),
        LTC4286_MFR_SYS_STATUS2_VDS_UV_WARNING_BIT = BIT(2),     
        LTC4286_MFR_SYS_STATUS2_VDS_OV_WARNING_BIT = BIT(3),     
        LTC4286_MFR_SYS_STATUS2_FET_SHORT_WARNING_BIT = BIT(14), 
        LTC4286_MFR_SYS_STATUS2_POWER_FAILED_WARNING_BIT = BIT(15), 
};

enum ltc4286_trig_alert_mask {
        LTC4286_ALERT_STATUS_WORD_MASK = 0xD0, 
        LTC4286_ALERT_STATUS_VOUT_MASK = 0xD2, 
        LTC4286_ALERT_STATUS_IOUT_MASK,        
        LTC4286_ALERT_STATUS_INPUT_MASK,       
        LTC4286_ALERT_STATUS_TEMP_MASK,        
        LTC4286_ALERT_STATUS_COMMS_MASK,       
        LTC4286_ALERT_STATUS_SPEC_MASK = 0xD8, 
        LTC4286_ALERT_STATUS_SYS1_MASK = 0xDA, 
        LTC4286_ALERT_STATUS_SYS2_MASK = 0xDC, 
};

enum ltc4286_status_alert {
        LTC4286_ALERT_STATUS_BUSY_ALERT_BIT = BIT(7), 
};

enum ltc4286_vout_alert {
        LTC4286_ALERT_VOUT_UV_WARNING_ALERT_BIT = BIT(5),
        LTC4286_ALERT_VOUT_OV_WARNING_ALERT_BIT = BIT(6),
};

enum ltc4286_iout_alert {
        LTC4286_ALERT_IOUT_OC_WARNING_ALERT_BIT = BIT(5),
        LTC4286_ALERT_IOUT_OC_FAULT_ALERT_BIT = BIT(7),
};

enum ltc4286_input_alert {
        LTC4286_ALERT_PIN_OP_WARNING_ALERT_BIT = BIT(0),
        LTC4286_ALERT_VIN_UV_FAULT_ALERT_BIT = BIT(4),
        LTC4286_ALERT_VIN_UV_WARNING_ALERT_BIT = BIT(5),
        LTC4286_ALERT_VIN_OV_WARNING_ALERT_BIT = BIT(6),
        LTC4286_ALERT_VIN_OV_FAULT_ALERT_BIT = BIT(7),
};

enum ltc4286_temp_alert {
        LTC4286_ALERT_TEMP_UT_WARNING_ALERT_BIT = BIT(5),
        LTC4286_ALERT_TEMP_OT_WARNING_ALERT_BIT = BIT(6),
        LTC4286_ALERT_TEMP_OT_FAULT_ALERT_BIT = BIT(7),
};

enum ltc4286_cml_alert {
        LTC4286_ALERT_MISC_FAULT_ALERT_BIT = BIT(1),
        LTC4286_ALERT_PEC_FAILED_ALERT_BIT = BIT(5),
        LTC4286_ALERT_BAD_DATA_ALERT_BIT = BIT(6),
        LTC4286_ALERT_BAD_CMD_ALERT_BIT = BIT(7),
};

enum ltc4286_mfr_spec_alert {
        LTC4286_ALERT_MFR_SPEC_FET_BAD_FAULT_ALERT_BIT = BIT(2),
        LTC4286_ALERT_MFR_SPEC_PIN_OP1_FAULT_ALERT_BIT = BIT(3),
        LTC4286_ALERT_MFR_SPEC_PIN_OP2_FAULT_ALERT_BIT = BIT(4),
        LTC4286_ALERT_MFR_SPEC_VDD_UVLO_ALERT_BIT = BIT(5),
        LTC4286_ALERT_MFR_SPEC_TSD_FAULT_ALERT_BIT = BIT(6),
        LTC4286_ALERT_MFR_SPEC_EN_CHANGED_ALERT_BIT = BIT(7),
};

enum ltc4286_mfr_sys_status1_alert {
        LTC4286_ALERT_MFR_SYS_STATUS1_ADC_CONV_ALERT_BIT = BIT(6),
        LTC4286_ALERT_MFR_SYS_STATUS1_AVERAGE_DONE_ALERT_BIT = BIT(7),
        LTC4286_ALERT_MFR_SYS_STATUS1_RESET_DONE_ALERT_BIT = BIT(10),
        LTC4286_ALERT_MFR_SYS_STATUS1_POWER_LOSS_ALERT_BIT = BIT(11),
};

enum ltc4286_mfr_sys_status2_alert {
        LTC4286_ALERT_MFR_SYS_STATUS2_PIN_UP_WARNING_ALERT_BIT = BIT(0),
        LTC4286_ALERT_MFR_SYS_STATUS2_IOUT_UC_WARNING_ALERT_BIT = BIT(1),
        LTC4286_ALERT_MFR_SYS_STATUS2_VDS_UV_WARNING_ALERT_BIT = BIT(2),
        LTC4286_ALERT_MFR_SYS_STATUS2_VDS_OV_WARNING_ALERT_BIT = BIT(3),
        LTC4286_ALERT_MFR_SYS_STATUS2_FET_SHORT_WARNING_ALERT_BIT = BIT(14),
        LTC4286_ALERT_MFR_SYS_STATUS2_POWER_FAILED_WARNING_ALERT_BIT = BIT(15),
};

int ltc4286_enable_alert_mask(const struct device *dev, enum ltc4286_trig_alert_mask alert_reg,
                              uint16_t alert_bit);

int ltc4286_disable_alert_mask(const struct device *dev, enum ltc4286_trig_alert_mask alert_reg,
                               uint16_t alert_bit);

 
#endif /* ZEPHYR_DRIVERS_SENSOR_LTC4286_LTC4286_H_ */