max2221x.h

Go to the documentation of this file.

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

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_MISC_MAX2221X_MAX2221X_H_
#define ZEPHYR_INCLUDE_DRIVERS_MISC_MAX2221X_MAX2221X_H_
 
#ifdef __cplusplus
extern "C" {
#endif


enum max2221x_master_chop_freq {
        MAX2221X_FREQ_100KHZ = 0, 
        MAX2221X_FREQ_80KHZ,      
        MAX2221X_FREQ_60KHZ,      
        MAX2221X_FREQ_50KHZ,      
        MAX2221X_FREQ_40KHZ,      
        MAX2221X_FREQ_30KHZ,      
        MAX2221X_FREQ_25KHZ,      
        MAX2221X_FREQ_20KHZ,      
        MAX2221X_FREQ_15KHZ,      
        MAX2221X_FREQ_10KHZ,      
        MAX2221X_FREQ_7500HZ,     
        MAX2221X_FREQ_5000HZ,     
        MAX2221X_FREQ_2500HZ,     
 
        MAX2221X_FREQ_INVALID, 
};

enum max2221x_individual_chop_freq {
        MAX2221X_FREQ_M = 0, 
        MAX2221X_FREQ_M_2,   
        MAX2221X_FREQ_M_4,   
        MAX2221X_FREQ_M_8,   
 
        MAX2221X_FREQ_M_INVALID, 
};

enum max2221x_fault_pin_masks {
        MAX2221X_FAULT_PIN_UVM = 0, 
        MAX2221X_FAULT_PIN_COMF,    
        MAX2221X_FAULT_PIN_DPM,     
        MAX2221X_FAULT_PIN_HHF,     
        MAX2221X_FAULT_PIN_OLF,     
        MAX2221X_FAULT_PIN_OCP,     
        MAX2221X_FAULT_PIN_OVT,     
 
        MAX2221X_FAULT_PIN_INVALID, 
};

enum max2221x_vdr_mode {
        MAX2221X_VDR_MODE_NORMAL = 0, 
        MAX2221X_VDR_MODE_DUTY,       
 
        MAX2221X_VDR_MODE_INVALID, 
};

enum max2221x_vm_threshold {
        MAX2221X_VM_THRESHOLD_DISABLED = 0, 
        MAX2221X_VM_THRESHOLD_4500MV,       
        MAX2221X_VM_THRESHOLD_6500MV,       
        MAX2221X_VM_THRESHOLD_8500MV,       
        MAX2221X_VM_THRESHOLD_10500MV,      
        MAX2221X_VM_THRESHOLD_12500MV,      
        MAX2221X_VM_THRESHOLD_14500MV,      
        MAX2221X_VM_THRESHOLD_16500MV,      
        MAX2221X_VM_THRESHOLD_18500MV,      
        MAX2221X_VM_THRESHOLD_20500MV,      
        MAX2221X_VM_THRESHOLD_22500MV,      
        MAX2221X_VM_THRESHOLD_24500MV,      
        MAX2221X_VM_THRESHOLD_26500MV,      
        MAX2221X_VM_THRESHOLD_28500MV,      
        MAX2221X_VM_THRESHOLD_30500MV,      
        MAX2221X_VM_THRESHOLD_32500MV,      
 
        MAX2221X_VM_THRESHOLD_INVALID, 
};

enum max2221x_ctrl_mode {
        MAX2221X_CTRL_MODE_VOLT = 0,     
        MAX2221X_CTRL_MODE_CDR,          
        MAX2221X_CTRL_MODE_LIMITER_VOLT, 
        MAX2221X_CTRL_MODE_VOLT_CDR,     
 
        MAX2221X_CTRL_MODE_INVALID, 
};

enum max2221x_ch_freq_div {
        MAX2221X_CH_FREQ_DIV_1 = 0, 
        MAX2221X_CH_FREQ_DIV_2,     
        MAX2221X_CH_FREQ_DIV_4,     
        MAX2221X_CH_FREQ_DIV_8,     
 
        MAX2221X_CH_FREQ_DIV_INVALID, 
};

enum max2221x_slew_rate {
        MAX2221X_SLEW_RATE_FAST = 0,    
        MAX2221X_SLEW_RATE_400V_PER_US, 
        MAX2221X_SLEW_RATE_200V_PER_US, 
        MAX2221X_SLEW_RATE_100V_PER_US, 
 
        MAX2221X_SLEW_RATE_INVALID, 
};

enum max2221x_gain {
        MAX2221X_SCALE_1 = 0, 
        MAX2221X_SCALE_2,     
        MAX2221X_SCALE_3,     
        MAX2221X_SCALE_4,     
 
        MAX2221X_GAIN_INVALID, 
};

enum max2221x_snsf {
        MAX2221X_SNSF_FULL_SCALE = 0, 
        MAX2221X_SNSF_2_3,            
        MAX2221X_SNSF_1_3,            
 
        MAX2221X_SNSF_INVALID, 
};

#define MAX2221X_RAMP_DOWN_MASK BIT(2)
#define MAX2221X_RAMP_MID_MASK  BIT(1)
#define MAX2221X_RAMP_UP_MASK   BIT(0)

int max2221x_set_master_chop_freq(const struct device *dev, enum max2221x_master_chop_freq freq);

int max2221x_get_master_chop_freq(const struct device *dev);

int max2221x_get_channel_freq(const struct device *dev, uint8_t channel);

int max2221x_set_part_state(const struct device *dev, bool enable);

int max2221x_set_channel_state(const struct device *dev, uint8_t channel, bool enable);

int max2221x_mask_fault_pin(const struct device *dev, enum max2221x_fault_pin_masks mask);

int max2221x_unmask_fault_pin(const struct device *dev, enum max2221x_fault_pin_masks mask);

int max2221x_set_vdr_mode(const struct device *dev, enum max2221x_vdr_mode mode);

int max2221x_get_vdr_mode(const struct device *dev);

int max2221x_read_status(const struct device *dev, uint16_t *status);

int max2221x_read_vm_monitor(const struct device *dev, uint16_t *vm_monitor);

int max2221x_set_dc_h2l(const struct device *dev, uint16_t dc_hdl);

int max2221x_get_dc_h2l(const struct device *dev, uint16_t *dc_hdl);

int max2221x_set_vm_upper_threshold(const struct device *dev, enum max2221x_vm_threshold threshold);

int max2221x_get_vm_upper_threshold(const struct device *dev);

int max2221x_set_vm_lower_threshold(const struct device *dev, enum max2221x_vm_threshold threshold);

int max2221x_get_vm_lower_threshold(const struct device *dev);

int max2221x_read_dc_l2h(const struct device *dev, uint16_t *dc_l2h, uint8_t channel);

int max2221x_write_dc_l2h(const struct device *dev, uint16_t dc_l2h, uint8_t channel);

int max2221x_read_dc_h(const struct device *dev, uint16_t *dc_h, uint8_t channel);

int max2221x_write_dc_h(const struct device *dev, uint16_t dc_h, uint8_t channel);

int max2221x_read_dc_l(const struct device *dev, uint16_t *dc_l, uint8_t channel);

int max2221x_write_dc_l(const struct device *dev, uint16_t dc_l, uint8_t channel);

int max2221x_read_time_l2h(const struct device *dev, uint16_t *time_l2h, uint8_t channel);

int max2221x_write_time_l2h(const struct device *dev, uint16_t time_l2h, uint8_t channel);

int max2221x_set_ctrl_mode(const struct device *dev, enum max2221x_ctrl_mode mode, uint8_t channel);

int max2221x_get_ctrl_mode(const struct device *dev, uint8_t channel);

int max2221x_set_ramps(const struct device *dev, uint8_t channel, uint8_t ramp_mask, bool enable);

int max2221x_set_ramp_slew_rate(const struct device *dev, uint8_t channel, uint8_t ramp_slew_rate);

int max2221x_get_ramp_slew_rate(const struct device *dev, uint8_t channel);

int max2221x_set_channel_chop_freq_div(const struct device *dev, uint8_t channel,
                                       enum max2221x_ch_freq_div freq_div);

int max2221x_get_channel_chop_freq_div(const struct device *dev, uint8_t channel);

int max2221x_set_slew_rate(const struct device *dev, uint8_t channel,
                           enum max2221x_slew_rate slew_rate);

int max2221x_get_slew_rate(const struct device *dev, uint8_t channel);

int max2221x_set_gain(const struct device *dev, uint8_t channel, enum max2221x_gain gain);

int max2221x_get_gain(const struct device *dev, uint8_t channel);

int max2221x_set_snsf(const struct device *dev, uint8_t channel, enum max2221x_snsf snsf);

int max2221x_get_snsf(const struct device *dev, uint8_t channel);

int max2221x_read_pwm_dutycycle(const struct device *dev, uint8_t channel, uint16_t *duty_cycle);

int max2221x_read_fault0(const struct device *dev);

int max2221x_read_fault1(const struct device *dev);

int max2221x_set_on_time(const struct device *dev, uint8_t channel, uint16_t on_time_us);

int max2221x_get_on_time(const struct device *dev, uint8_t channel);

int max2221x_set_off_time(const struct device *dev, uint8_t channel, uint16_t off_time_us);

int max2221x_get_off_time(const struct device *dev, uint8_t channel);

int max2221x_set_stop_state(const struct device *dev, uint8_t channel, bool stop_state);

int max2221x_get_stop_state(const struct device *dev, uint8_t channel);

int max2221x_set_repetitions(const struct device *dev, uint8_t channel, uint16_t repetitions);

int max2221x_get_repetitions(const struct device *dev, uint8_t channel);

int max2221x_start_rapid_fire(const struct device *dev, uint8_t channel);

int max2221x_stop_rapid_fire(const struct device *dev, uint8_t channel);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_MISC_MAX2221X_MAX2221X_H_ */