ad9208_api.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0
#ifndef __AD9208API_H__
#define __AD9208API_H__
 
#include "api_def.h"
#include "no_os_util.h"
 
typedef enum {
    AD9208_DATA_FRMT_REAL = 0x0,  
    AD9208_DATA_FRMT_COMPLEX      
} ad9208_adc_data_frmt_t;
 
typedef enum {
    AD9208_ADC_CH_NONE = 0x0,   
    AD9208_ADC_CH_A,        
    AD9208_ADC_CH_B,        
    AD9208_ADC_CH_ALL       
} ad9208_adc_ch_t;
 
typedef enum {
    AD9208_ADC_SCALE_2P04_VPP = 0,  
    AD9208_ADC_SCALE_1P13_VPP,  
    AD9208_ADC_SCALE_1P25_VPP,  
    AD9208_ADC_SCALE_1P7_VPP,   
    AD9208_ADC_SCALE_1P81_VPP,  
    AD9208_ADC_SCALE_1P93_VPP   
} ad9208_adc_scale_range_t;
 
typedef enum {
    AD9208_ADC_BUFF_CURR_400_UA = 0x4,   
    AD9208_ADC_BUFF_CURR_500_UA = 0x9,   
    AD9208_ADC_BUFF_CURR_600_UA = 0x1E,  
    AD9208_ADC_BUFF_CURR_700_UA = 0x23,  
    AD9208_ADC_BUFF_CURR_800_UA = 0x28,  
    AD9208_ADC_BUFF_CURR_1000_UA = 0x32, 
} ad9208_adc_buff_curr_t;
 
typedef enum {
    AD9208_ADC_NCO_VIF = 0,   
    AD9208_ADC_NCO_ZIF = 1,   
    AD9208_ADC_NCO_TEST = 3,  
    AD9208_ADC_NCO_INVLD = 4  
} ad9208_adc_nco_mode_t;
 
typedef enum {
    AD9208_POWERUP = 0x0,   
    AD9208_STANDBY = 0x2,   
    AD9208_POWERDOWN = 0x3  
} ad9208_pdn_mode_t;
 
typedef enum {
    AD9208_PLL_LOCK_STAT = 0x8, 
    AD9208_PLL_LOSSLOCK = 0x4   
} ad9208_jesd_serdes_pll_flg_t;
 
typedef struct {
    void *user_data;    
    spi_xfer_t dev_xfer;    
    reset_pin_ctrl_t reset_pin_ctrl;
    delay_us_t delay_us;    
    hw_open_t hw_open;  
    hw_close_t hw_close;    
    uint64_t adc_clk_freq_hz;   
} ad9208_handle_t;
 
int ad9208_init(ad9208_handle_t *h);
 
int ad9208_deinit(ad9208_handle_t *h);
 
int ad9208_reset(ad9208_handle_t *h, uint8_t hw_reset);
 
int ad9208_set_pdn_pin_mode(ad9208_handle_t *h,
                uint8_t pin_enable, ad9208_pdn_mode_t pin_mode);
 
int ad9208_set_input_clk_cfg(ad9208_handle_t *h,
                 uint64_t clk_freq_hz, uint8_t div);
 
int ad9208_set_input_clk_duty_cycle_stabilizer(ad9208_handle_t *h, uint8_t en);
 
int ad9208_get_adc_clk_freq(ad9208_handle_t *h, uint64_t *adc_clk_freq_hz);
 
int ad9208_adc_set_channel_select(ad9208_handle_t *h, uint8_t ch);
 
int ad9208_adc_get_channel_select(ad9208_handle_t *h, uint8_t *ch);
 
int ad9208_adc_set_ch_pdn_mode(ad9208_handle_t *h, ad9208_pdn_mode_t mode);
 
int ad9208_adc_set_clk_phase(ad9208_handle_t *h, uint8_t phase_adj);
 
int ad9208_adc_set_input_cfg(ad9208_handle_t *h,
                 signal_coupling_t analog_input_mode,
                 uint8_t ext_vref,
                 ad9208_adc_scale_range_t full_scale_range);
 
int ad9208_adc_set_input_buffer_cfg(ad9208_handle_t *h,
                    ad9208_adc_buff_curr_t buff_curr_n,
                    ad9208_adc_buff_curr_t buff_curr_p,
                    ad9208_adc_buff_curr_t vcm_buff);
 
int ad9208_adc_set_dc_offset_filt_en(ad9208_handle_t *h, uint8_t en);
 
int ad9208_adc_set_fc_ch_mode(ad9208_handle_t *h, uint8_t fc_ch);
 
int ad9208_adc_set_dcm_mode(ad9208_handle_t *h, uint8_t dcm);
 
int ad9208_adc_set_data_format(ad9208_handle_t *h,
                   ad9208_adc_data_frmt_t ip_data_frmt,
                   ad9208_adc_data_frmt_t op_data_frmt);
 
int ad9208_adc_set_sync_update_mode_enable(ad9208_handle_t *h, uint8_t en);
 
int ad9208_adc_set_ddc_ip_mux(ad9208_handle_t *h,
                  uint8_t ddc_ch, ad9208_adc_ch_t i_data_src,
                  ad9208_adc_ch_t q_data_src);
 
int ad9208_adc_set_ddc_dcm(ad9208_handle_t *h, uint8_t ddc_ch, uint8_t dcm);
 
int ad9208_adc_set_ddc_nco_mode(ad9208_handle_t *h,
                uint8_t ddc_ch, ad9208_adc_nco_mode_t mode);
 
int ad9208_adc_set_ddc_nco_ftw(ad9208_handle_t *h, uint8_t ddc_ch,
                   uint64_t ftw, uint64_t mod_a, uint64_t mod_b);
 
int ad9208_adc_set_ddc_nco(ad9208_handle_t *h, uint8_t ddc_ch,
               const int64_t carrier_freq_hz);
 
int ad9208_adc_set_ddc_nco_phase(ad9208_handle_t *h, uint8_t ddc_ch,
                 uint64_t po);
 
int ad9208_adc_set_ddc_gain(ad9208_handle_t *h,
                uint8_t ddc_ch, uint8_t gain_db);
int ad9208_adc_set_ddc_nco_reset(ad9208_handle_t *h);
int ad9208_jesd_set_if_config(ad9208_handle_t *h,
                  jesd_param_t jesd_param,
                  uint64_t *lane_rate_kbps);
 
int ad9208_jesd_get_cfg_param(ad9208_handle_t *h, jesd_param_t *jesd_param);
 
int ad9208_jesd_set_lane_xbar(ad9208_handle_t *h,
                  uint8_t logical_lane, uint8_t physical_lane);
 
int ad9208_jesd_get_lane_xbar(ad9208_handle_t *h, uint8_t *phy_log_map);
 
int ad9208_jesd_enable_scrambler(ad9208_handle_t *h, uint8_t en);
 
int ad9208_jesd_enable_link(ad9208_handle_t *h, uint8_t en);
 
int ad9208_jesd_get_pll_status(ad9208_handle_t *h, uint8_t *pll_status);
 
int ad9208_jesd_subclass_set(ad9208_handle_t *h, uint8_t subclass);
 
int ad9208_jesd_syref_mode_set(ad9208_handle_t *h,
                   jesd_sysref_mode_t mode, uint8_t sysref_count);
 
int ad9208_jesd_syref_config_set(ad9208_handle_t *h,
                 uint8_t sysref_edge_sel, uint8_t clk_edge_sel,
                 uint8_t neg_window_skew,
                 uint8_t pos_window_skew);
 
int ad9208_jesd_syref_status_get(ad9208_handle_t *h,
                 uint8_t *hold_status, uint8_t *setup_status,
                 uint8_t *phase_status);
 
int ad9208_jesd_sysref_timestamp_set(ad9208_handle_t *h,
                     uint8_t timestamp_en, uint8_t control_bit,
                     uint8_t delay);
int ad9208_jesd_syref_lmfc_offset_set(ad9208_handle_t *h, uint8_t offset);
 
int ad9208_adc_get_overange_status(ad9208_handle_t *h, uint8_t *status);
 
int ad9208_adc_set_fd_thresholds(ad9208_handle_t *h,
                 uint16_t upper_dbfs, uint16_t lower_dbfs,
                 uint16_t dwell_time);
int ad9208_adc_temp_sensor_set_enable(ad9208_handle_t *h, uint8_t en);
int ad9208_get_chip_id(ad9208_handle_t *h, adi_chip_id_t *chip_id);
 
int ad9208_register_write(ad9208_handle_t *h,
              const uint16_t address, const uint8_t data);
 
int ad9208_register_read(ad9208_handle_t *h,
             const uint16_t address, uint8_t *data);
int ad9208_get_revision(ad9208_handle_t *h, uint8_t *rev_major,
            uint8_t *rev_minor, uint8_t *rev_rc);
 
int ad9208_adc_set_input_scale(ad9208_handle_t *h,
                   ad9208_adc_scale_range_t full_scale_range);
 
int ad9208_get_decimation(ad9208_handle_t *h, uint8_t *dcm);
 
#endif /* !__AD9208API_H__ */