adf4371.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef ADF4371_H_
#define ADF4371_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include "no_os_spi.h"
 
/******************************************************************************/
/********************** Macros and Types Declarations *************************/
/******************************************************************************/
struct adf4371_channel_config {
    bool        enable;
    uint64_t    freq;
};
 
struct adf4371_cp_settings {
    uint32_t    icp;
    uint32_t    regval;
};
 
struct adf4371_chan_spec {
    uint32_t    num;
    uint64_t    power_up_frequency;
};
 
struct adf4371_dev {
    struct no_os_spi_desc   *spi_desc;
    bool        spi_3wire_en;
    uint32_t    num_channels;
    struct adf4371_channel_config   channel_cfg[4];
    struct adf4371_cp_settings  cp_settings;
    bool        differential_ref_clk;
    uint32_t    pd_pol;
    bool        mute_till_lock_en;
    uint32_t    muxout_default_mode;
    bool        muxout_en;
    bool        muxout_1v8_en;
    uint32_t    ref_div_factor;
    uint32_t    clkin_freq;
    uint32_t    fpfd;
    uint32_t    integer;
    uint32_t    fract1;
    uint32_t    fract2;
    uint32_t    mod2;
    uint32_t    rf_div_sel;
    uint8_t     buf[10];
};
 
struct adf4371_init_param {
    struct no_os_spi_init_param *spi_init;
    bool        spi_3wire_enable;
    uint32_t    clkin_frequency;
    bool        differential_ref_clock;
    bool        loop_filter_inverting;
    uint32_t    charge_pump_microamp;
    bool        mute_till_lock_enable;
    uint32_t    muxout_select;
    bool        muxout_level_1v8_enable;
    uint32_t    num_channels;
    struct adf4371_chan_spec    *channels;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
/* Initialize the device. */
int32_t adf4371_init(struct adf4371_dev **device,
             const struct adf4371_init_param *init_param);
 
/* Remove the device. */
int32_t adf4371_remove(struct adf4371_dev *device);
 
/* Recalculate rate corresponding to a channel. */
int32_t adf4371_clk_recalc_rate(struct adf4371_dev *dev, uint32_t chan,
                uint64_t *rate);
 
/* Calculate closest possible rate */
int32_t adf4371_clk_round_rate(struct adf4371_dev *dev, uint64_t rate,
                   uint64_t *rounded_rate);
 
/* Set channel rate. */
int32_t adf4371_clk_set_rate(struct adf4371_dev *dev, uint32_t chan,
                 uint64_t rate);
 
#endif