AD917x.h

Go to the documentation of this file.

 
#ifndef __AD917XAPI_H__
#define __AD917XAPI_H__
 
#include "api_def.h"
#include "no_os_util.h"
 
typedef enum {
    AD917X_DDSM = 0,
    AD917X_DDSC = 1
} ad917x_dds_select_t;
 
typedef enum {
    AD917X_DAC_NONE = 0,
    AD917X_DAC0 = 1,
    AD917X_DAC1 = 2
} ad917x_dac_select_t;
 
typedef enum {
    AD917X_CH_NONE = 0,
    AD917X_CH_0 = NO_OS_BIT(0),
    AD917X_CH_1 = NO_OS_BIT(1),
    AD917X_CH_2 = NO_OS_BIT(2),
    AD917X_CH_3 = NO_OS_BIT(3),
    AD917X_CH_4 = NO_OS_BIT(4),
    AD917X_CH_5 = NO_OS_BIT(5)
} ad917x_channel_select_t;
 
typedef struct {
    uint8_t code_grp_sync_stat;
    uint8_t frame_sync_stat;
    uint8_t good_checksum_stat;
    uint8_t init_lane_sync_stat;
} ad917x_jesd_link_stat_t;
 
typedef enum {
    AD917X_PLL_LOCK_STAT = 0x1, 
    AD917X_PLL_REG_RDY = 0x2,   
    AD917X_PLL_CAL_STAT = 0x4,  
    AD917X_PLL_LOSSLOCK = 0x8  
} ad917x_jesd_serdes_pll_flg_t;
 
typedef struct {
    void *user_data;        
    spi_sdo_config_t sdo;      
    signal_type_t syncoutb;    
    signal_coupling_t sysref;  
    uint64_t dac_freq_hz;   
    spi_xfer_t dev_xfer;    
    delay_us_t delay_us;    
    tx_en_pin_ctrl_t
    tx_en_pin_ctrl; 
    reset_pin_ctrl_t
    reset_pin_ctrl; 
    hw_open_t hw_open;      
    hw_close_t
    hw_close;    
} ad917x_handle_t;
 
int32_t ad917x_init(ad917x_handle_t *h);
 
int32_t ad917x_deinit(ad917x_handle_t *h);
 
int32_t ad917x_reset(ad917x_handle_t *h, uint8_t hw_reset);
 
int32_t ad917x_get_chip_id(ad917x_handle_t *h, adi_chip_id_t *chip_id);
 
 
int32_t ad917x_register_write(ad917x_handle_t *h,
                  const uint16_t address, const uint8_t data);
int32_t ad917x_register_read(ad917x_handle_t *h,
                 const uint16_t address, uint8_t *data);
int32_t ad917x_get_revision(ad917x_handle_t *h, uint8_t *rev_major,
                uint8_t *rev_minor, uint8_t *rev_rc);
 
 
int32_t ad917x_set_dac_pll_config(ad917x_handle_t *h, uint8_t dac_pll_en,
                  uint8_t m_div, uint8_t n_div, uint8_t vco_div);
int32_t ad917x_set_dac_clk_freq(ad917x_handle_t *h,
                uint64_t dac_clk_freq_hz);
 
int32_t ad917x_get_dac_clk_freq(ad917x_handle_t *h,
                uint64_t *dac_clk_freq_hz);
int32_t ad917x_get_dac_clk_status(ad917x_handle_t *h,
                  uint8_t *pll_lock_stat, uint8_t *dll_lock_stat);
 
int32_t ad917x_set_clkout_config(ad917x_handle_t *h, uint8_t l_div);
 
int32_t ad917x_set_dac_clk(ad917x_handle_t *h,
               uint64_t dac_clk_freq_hz, uint8_t dac_pll_en, uint64_t ref_clk_freq_hz);
 
int32_t ad917x_jesd_config_datapath(ad917x_handle_t *h, uint8_t dual_en,
                    uint8_t jesd_mode, uint8_t ch_intpl, uint8_t dp_intpl);
 
int32_t ad917x_jesd_get_cfg_status(ad917x_handle_t *h, uint8_t *cfg_valid);
 
int32_t ad917x_jesd_get_cfg_param(ad917x_handle_t *h,
                  jesd_param_t *jesd_param);
 
int32_t ad917x_jesd_set_sysref_enable(ad917x_handle_t *h, uint8_t en);
int32_t ad917x_jesd_get_sysref_enable(ad917x_handle_t *h, uint8_t *en);
 
 
int32_t ad917x_jesd_set_lmfc_delay(ad917x_handle_t *h, jesd_link_t link,
                   uint8_t delay, uint8_t var);
int32_t ad917x_jesd_set_syncoutb_enable(ad917x_handle_t *h,
                    jesd_syncoutb_t syncoutb, uint8_t en);
 
int32_t ad917x_jesd_set_scrambler_enable(ad917x_handle_t *h, uint8_t en);
 
int32_t ad917x_jesd_set_lane_xbar(ad917x_handle_t *h,
                  uint8_t logical_lane, uint8_t physical_lane);
 
int32_t ad917x_jesd_get_lane_xbar(ad917x_handle_t *h, uint8_t *phy_log_map);
 
int32_t ad917x_jesd_invert_lane(ad917x_handle_t *h,
                uint8_t logical_lane, uint8_t invert);
int32_t ad917x_jesd_enable_datapath(ad917x_handle_t *h,
                    uint8_t lanes_msk, uint8_t run_cal, uint8_t en);
int32_t ad917x_jesd_get_pll_status(ad917x_handle_t *h, uint8_t *pll_status);
 
int32_t ad917x_jesd_enable_link(ad917x_handle_t *h,
                jesd_link_t link, uint8_t en);
 
int32_t ad917x_jesd_get_link_status(ad917x_handle_t *h,
                    jesd_link_t link, ad917x_jesd_link_stat_t *link_status);
 
int32_t ad917x_set_page_idx(ad917x_handle_t *h, const uint32_t dac,
                const uint32_t channel);
 
int32_t ad917x_get_page_idx(ad917x_handle_t *h, int32_t *dac, int32_t *channel);
 
int32_t ad917x_set_channel_gain(ad917x_handle_t *h, const uint16_t gain);
 
int32_t ad917x_get_channel_gain(ad917x_handle_t *h, uint16_t *gain);
 
 
int32_t ad917x_set_dc_cal_tone_amp(ad917x_handle_t *h, const uint16_t amp);
 
int32_t ad917x_nco_get_phase_offset(ad917x_handle_t *h,
                    const ad917x_dac_select_t dacs, uint16_t *dacs_po,
                    const ad917x_channel_select_t channels, uint16_t *ch_po);
 
int32_t ad917x_nco_set_phase_offset(ad917x_handle_t *h,
                    const ad917x_dac_select_t dacs, const uint16_t dacs_po,
                    const ad917x_channel_select_t channels, const uint16_t ch_po);
 
int32_t ad917x_nco_set_ftw(ad917x_handle_t *h,
               const ad917x_dds_select_t nco,
               const uint64_t ftw,
               const uint64_t acc_modulus,
               const uint64_t acc_delta);
 
int32_t ad917x_nco_get_ftw(ad917x_handle_t *h,
               const ad917x_dds_select_t nco,
               uint64_t *ftw,
               uint64_t *acc_modulus,
               uint64_t *acc_delta);
 
int32_t ad917x_nco_set(ad917x_handle_t *h,
               const ad917x_dac_select_t dacs,
               const ad917x_channel_select_t channels,
               const int64_t carrier_freq_hz,
               const uint16_t amplitude,
               int32_t dc_test_tone_en,
               int32_t ddsm_cal_dc_input_en);
 
int32_t ad917x_nco_enable(ad917x_handle_t *h,
              const ad917x_dac_select_t dacs,
              const ad917x_channel_select_t channels);
 
int32_t ad917x_ddsm_cal_dc_input_set(ad917x_handle_t *h,
                     int32_t ddsm_cal_dc_input_en);
 
int32_t ad917x_ddsm_cal_dc_input_get(ad917x_handle_t *h,
                     int32_t *ddsm_cal_dc_input_en);
 
int32_t ad917x_dc_test_tone_set(ad917x_handle_t *h, int32_t dc_test_tone_en);
 
int32_t ad917x_dc_test_tone_get(ad917x_handle_t *h, int32_t *dc_test_tone_en);
 
int32_t ad917x_nco_channel_freq_get(ad917x_handle_t *h,
                    ad917x_channel_select_t channel,
                    int64_t *carrier_freq_hz);
 
int32_t ad917x_nco_main_freq_get(ad917x_handle_t *h,
                 ad917x_dac_select_t dac,
                 int64_t *carrier_freq_hz);
 
#endif /* !__AD917XAPI_H__ */