Implementation of adf4382 Driver. More...
#include <stdint.h>
#include <string.h>
#include "no_os_units.h"
#include "no_os_util.h"
#include "no_os_spi.h"
Go to the source code of this file.
Classes | |
struct | adf4382_init_param |
ADF4382 Initialization Parameters structure. More... | |
struct | adf4382_dev |
ADF4382 Device Descriptor. More... | |
struct | reg_sequence |
ADF4382 register format structure for default values. More... | |
Enumerations | |
enum | adf4382_dev_id { ID_ADF4382 , ID_ADF4382A , ID_ADF4383 } |
Supported device ids. More... | |
Functions | |
int | adf4382_spi_write (struct adf4382_dev *dev, uint16_t reg_addr, uint8_t data) |
Writes data to ADF4382 over SPI. | |
int | adf4382_spi_read (struct adf4382_dev *dev, uint16_t reg_addr, uint8_t *data) |
Reads data from ADF4382 over SPI. | |
int | adf4382_spi_update_bits (struct adf4382_dev *dev, uint16_t reg_addr, uint8_t mask, uint8_t data) |
Updates the values of the ADF4382 register. | |
int | adf4382_reg_dump (struct adf4382_dev *dev) |
Will output on the terminal the values of all the ADF4382 registers. | |
int | adf4382_set_ref_clk (struct adf4382_dev *dev, uint64_t val) |
Set the desired reference frequency and reset everything over to maximum supported value of 5GHz to the max. value and everything under the minimum supported value of 10MHz to the min. value. | |
int | adf4382_get_ref_clk (struct adf4382_dev *dev, uint64_t *val) |
Gets the user proposed reference frequency. | |
int | adf4382_set_en_ref_doubler (struct adf4382_dev *dev, bool en) |
Set the reference doubler to enable or disable based on the passed parameter. If the parameter is different then 0 it will set the doubler to enable. | |
int | adf4382_get_en_ref_doubler (struct adf4382_dev *dev, bool *en) |
Gets the value the doubler if it is enabled or disable and stores it it the dev structure. | |
int | adf4382_set_ref_div (struct adf4382_dev *dev, int32_t div) |
Set the reference divider value and reset everything over to maximum supported value of 63 to the max. value. | |
int | adf4382_get_ref_div (struct adf4382_dev *dev, int32_t *div) |
Gets the value the reference divider. | |
int | adf4382_set_cp_i (struct adf4382_dev *dev, int32_t reg_val) |
Set the charge pump value which will be written to the register. The value will be between 0 and 15 on 8 bits. For more information please consult the Datasheet. | |
int | adf4382_get_cp_i (struct adf4382_dev *dev, int32_t *reg_val) |
Gets the charge pump value from the register. The value will be between 0 and 15 on 8 bits. For more information please consult the Datasheet. | |
int | adf4382_set_bleed_word (struct adf4382_dev *dev, int32_t word) |
Set the bleed word, which represents the value of the bleed current written to the register space. | |
int | adf4382_get_bleed_word (struct adf4382_dev *dev, int32_t *word) |
Gets the value of the set bleed word. | |
int | adf4382_set_rfout (struct adf4382_dev *dev, uint64_t val) |
Set the desired output frequency and reset everything over to maximum supported value of 22GHz (21GHz for ADF4382A) to the max. value and everything under the minimum supported value of 687.5MHz (2.875GHz for ADF4382A) to the min. value. | |
int | adf4382_get_rfout (struct adf4382_dev *dev, uint64_t *val) |
Gets the user proposed output frequency. | |
int | adf4382_set_out_power (struct adf4382_dev *dev, uint8_t ch, int32_t pwr) |
Set the output power register value of a channel and reset everything over to maximum supported value of 15 to the max. value. | |
int | adf4382_get_out_power (struct adf4382_dev *dev, uint8_t ch, int32_t *pwr) |
Gets the output power register value. | |
int | adf4382_set_en_chan (struct adf4382_dev *dev, uint8_t ch, bool en) |
Set the output channel to enable or disable based on the passed parameter. If the parameter is different then 0 it will set the doubler to enable. | |
int | adf4382_get_en_chan (struct adf4382_dev *dev, uint8_t ch, bool *en) |
Gets the value the output channel if it is enabled or disable. | |
int | adf4382_set_freq (struct adf4382_dev *dev) |
Set the output frequency. | |
int | adf4382_set_en_fast_calibration (struct adf4382_dev *dev, bool en_fast_cal) |
Fast calibration function. Computes Minimum VCO frequency (fmin), uses the minimum NDIV value to generate fastcal Lookup table (LUT), and finally enables LUT Calibration. | |
int | adf4382_set_en_lut_calibration (struct adf4382_dev *dev, bool en_lut_cal) |
Sets Fast calibration LUT Calibration. Refer to en_fastcal function to first generate fastcal Lookup Table (LUT). | |
int | adf4382_get_en_lut_calibration (struct adf4382_dev *dev, bool *en) |
Gets Fast calibration LUT Calibration status. | |
int | adf4382_set_change_freq (struct adf4382_dev *dev) |
Set the output frequency. This will set the required registers to device but skip NDIV value, to be written separately. This Function will not start autocalibration until REG0010 is written. | |
int | adf4382_get_change_rfout (struct adf4382_dev *dev, uint64_t *val) |
Gets the user proposed output frequency from the device tree without reading from the device. This is to enable and accurate reading of device lock-time. | |
int | adf4382_set_change_rfout (struct adf4382_dev *dev, uint64_t val) |
Set the desired output frequency and reset everything over to maximum supported value of 22GHz (21GHz for ADF4382A) to the max without starting autocalibration. value and everything under the minimum supported value of 687.5MHz (2.875GHz for ADF4382A) to the min. value. | |
int | adf4382_set_start_calibration (struct adf4382_dev *dev) |
Set REG0010 value in device structure to the device to start autocal. | |
int | adf4382_get_start_calibration (struct adf4382_dev *dev, bool *start_cal) |
Get the status of start calibration. Will always return zero to allow users set it multiple times to trigger autocalibration. | |
int | adf4382_set_phase_adjust (struct adf4382_dev *dev, uint32_t phase_ps) |
Set the phase adjustment in pico-seconds. The phase adjust will enable the Bleed current option as well as delay mode to 0. | |
int | adf4382_set_phase_pol (struct adf4382_dev *dev, bool polarity) |
Set the phase polarity. If pol = 0 then it will add the phase value otherwise it will subtract the phase value. | |
int | adf4382_get_phase_pol (struct adf4382_dev *dev, bool *polarity) |
Gets the polarity of the phase adjust. | |
int | adf4382_set_ezsync_setup (struct adf4382_dev *dev, bool sync) |
Set the EZSYNC features' initial state. Awaits the SW_SYNC toggle. | |
int | adf4382_set_timed_sync_setup (struct adf4382_dev *dev, bool sync) |
Set Timed SYNC features' initial state. Uses SYNC pin. | |
int | adf4382_get_phase_sync_setup (struct adf4382_dev *dev, bool *en) |
Gets the value of the SYNC powerdown bit. | |
int | adf4382_set_sw_sync (struct adf4382_dev *dev, bool sw_sync) |
Set Software SYNC Request. Setting SW_SYNC resets the RF block. Clearing SW_SYNC makes ready for a new reference clock. | |
int | adf4382_get_sw_sync (struct adf4382_dev *dev, bool *sw_sync) |
Gets the value of the SW_SYNC bit. | |
int | adf4382_init (struct adf4382_dev **device, struct adf4382_init_param *init_param) |
Initializes the ADF4382. | |
int | adf4382_remove (struct adf4382_dev *dev) |
Free resources allocated for ADF4382. | |
Implementation of adf4382 Driver.
Copyright 2024(c) Analog Devices, Inc.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#define ADF4382_ABPW_WD_MSK NO_OS_BIT(3) |
#define ADF4382_ADC_C_CONV_MSK NO_OS_BIT(2) |
#define ADF4382_ADC_CLK_DIV_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_ADC_CLK_TEST_SEL_MSK NO_OS_BIT(6) |
#define ADF4382_ADC_F_CONV_MSK NO_OS_BIT(3) |
#define ADF4382_ADC_MUX_SEL_MSK NO_OS_BIT(4) |
#define ADF4382_ADC_ST_CNV_MSK NO_OS_BIT(0) |
#define ADF4382_ADC_VTEST_SEL_MSK NO_OS_BIT(5) |
#define ADF4382_ADDR_ASC_AUTO_DECR 0x0 |
#define ADF4382_ADDR_ASC_AUTO_INCR 0x1 |
#define ADF4382_ADDRESS_ASC_MSK NO_OS_BIT(2) |
#define ADF4382_ADDRESS_ASC_R_MSK NO_OS_BIT(5) |
#define ADF4382_BIAS_DEC_MODE_MSK NO_OS_GENMASK(5, 3) |
#define ADF4382_BLEED_ADJ_CAL_MSK NO_OS_BIT(6) |
#define ADF4382_BLEED_ADJ_SCALE_MSK NO_OS_GENMASK(3, 0) |
#define ADF4382_BLEED_MSB_MSK |
#define ADF4382_BLEED_POL_MSK NO_OS_BIT(5) |
#define ADF4382_BLEED_WORD_MAX 8191 |
#define ADF4382_BST_REF_MSK NO_OS_BIT(7) |
#define ADF4382_BUFF_SIZE_BYTES 3 |
#define ADF4382_CAL_BLEED_FINE_MAX_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_CAL_BLEED_FINE_MIN_MSK NO_OS_GENMASK(7, 4) |
#define ADF4382_CAL_COUNT_TO_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_CAL_CT_SEL_MSK NO_OS_BIT(1) |
#define ADF4382_CAL_VCO_TO_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_CAL_VCO_TO_MSB_MSK NO_OS_GENMASK(6, 0) |
#define ADF4382_CAL_VTUNE_TO_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_CAL_VTUNE_TO_MSB_MSK NO_OS_GENMASK(6, 0) |
#define ADF4382_CAP_TEST_STATE_MSK NO_OS_BIT(1) |
#define ADF4382_CHANNEL_SPACING_MAX 78125U |
#define ADF4382_CHIP_TYPE 0x06 |
#define ADF4382_CLK1_OPWR_MSK NO_OS_GENMASK(3, 0) |
#define ADF4382_CLK2_OPWR_MSK NO_OS_GENMASK(7, 4) |
#define ADF4382_CLKODIV_DB_MSK NO_OS_BIT(7) |
#define ADF4382_CLKOUT_BST_MSK NO_OS_BIT(5) |
#define ADF4382_CLKOUT_DIV_MSK NO_OS_GENMASK(7, 5) |
#define ADF4382_CLKOUT_DIV_REG_VAL_MAX 4 |
#define ADF4382_CMOS_OV_MSK NO_OS_BIT(5) |
#define ADF4382_CNTR_DIV_WORD_MSB_MSK NO_OS_GENMASK(3, 0) |
#define ADF4382_CNTR_DIV_WORD_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_COARSE_BLEED_CONST 180U |
#define ADF4382_COARSE_BLEED_MSK NO_OS_GENMASK(4, 1) |
#define ADF4382_CP_DOWN_MSK NO_OS_BIT(1) |
#define ADF4382_CP_I_MSK NO_OS_GENMASK(3, 0) |
#define ADF4382_CP_UP_MSK NO_OS_BIT(0) |
#define ADF4382_CPI_VAL_MAX 15 |
#define ADF4382_DCLK_DIV1_0_MAX 160000000U |
#define ADF4382_DCLK_DIV1_1_MAX 320000000U |
#define ADF4382_DCLK_DIV1_MSK NO_OS_GENMASK(1, 0) |
#define ADF4382_DCLK_DIV_DB_MSK NO_OS_BIT(6) |
#define ADF4382_DCLK_DIV_SEL_MSK NO_OS_BIT(4) |
#define ADF4382_DCLK_MODE_MSK NO_OS_BIT(0) |
#define ADF4382_DEL_CTRL_DB_MSK NO_OS_BIT(7) |
#define ADF4382_DEL_MODE_MSK NO_OS_BIT(5) |
#define ADF4382_DITHER1_SCALE_MSK NO_OS_GENMASK(4, 2) |
#define ADF4382_DNCLK_DEL_MSK NO_OS_GENMASK(3, 1) |
#define ADF4382_DNCLK_DIV1_MSK NO_OS_GENMASK(3, 2) |
#define ADF4382_DRCLK_DEL_MSK NO_OS_GENMASK(6, 4) |
#define ADF4382_EFM3_MODE_MSK NO_OS_GENMASK(2, 0) |
#define ADF4382_EN_ADC_CLK_MSK NO_OS_BIT(3) |
#define ADF4382_EN_ADC_CNV_MSK NO_OS_BIT(7) |
#define ADF4382_EN_ADC_MSK NO_OS_BIT(1) |
#define ADF4382_EN_ADC_VTEST_MSK NO_OS_BIT(6) |
#define ADF4382_EN_AUTO_ALIGN_MSK NO_OS_BIT(4) |
#define ADF4382_EN_AUTOCAL_MSK NO_OS_BIT(7) |
#define ADF4382_EN_BLEED_MSK NO_OS_BIT(4) |
#define ADF4382_EN_CALGEN_CAP_TEST_MSK NO_OS_BIT(3) |
#define ADF4382_EN_CP_CAP_TEST_MSK NO_OS_BIT(2) |
#define ADF4382_EN_CPTEST_MSK NO_OS_BIT(2) |
#define ADF4382_EN_DITHER1_MSK NO_OS_BIT(0) |
#define ADF4382_EN_DITHER2_MSK NO_OS_BIT(1) |
#define ADF4382_EN_DNCLK_MSK NO_OS_BIT(7) |
#define ADF4382_EN_DRCLK_MSK NO_OS_BIT(6) |
#define ADF4382_EN_LDWIN_MSK NO_OS_BIT(4) |
#define ADF4382_EN_LOL_MSK NO_OS_BIT(5) |
#define ADF4382_EN_LUT_CAL_MSK NO_OS_BIT(0) |
#define ADF4382_EN_LUT_GEN_MSK NO_OS_BIT(1) |
#define ADF4382_EN_PHASE_RESYNC_MSK NO_OS_BIT(7) |
#define ADF4382_EN_RDBLR_MSK NO_OS_BIT(6) |
#define ADF4382_EN_REF_RST_MSK NO_OS_BIT(6) |
#define ADF4382_EN_TWO_PASS_CAL_MSK NO_OS_BIT(4) |
#define ADF4382_EN_VCAL_MSK NO_OS_BIT(2) |
#define ADF4382_EN_VCO_CAP_TEST_MSK NO_OS_BIT(4) |
#define ADF4382_EXT_DIV_DEC_SEL_MSK NO_OS_BIT(7) |
#define ADF4382_EXT_DIV_MSK NO_OS_GENMASK(7, 5) |
#define ADF4382_FASTCAL_VCTAT_CALGEN 70 |
#define ADF4382_FASTCAL_VPTAT_CALGEN 30 |
#define ADF4382_FILT_REF_MSK NO_OS_BIT(6) |
#define ADF4382_FINE_BLEED_CONST_1 512U |
#define ADF4382_FINE_BLEED_CONST_2 250U |
#define ADF4382_FINE_BLEED_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_FINE_BLEED_MSB_MSK NO_OS_BIT(0) |
#define ADF4382_FN_DBL_MSK NO_OS_BIT(7) |
#define ADF4382_FRAC1WORD_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_FRAC1WORD_MID_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_FRAC1WORD_MSB NO_OS_BIT(0) |
#define ADF4382_FRAC1WORD_MSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_FRAC2WORD_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_FRAC2WORD_MID_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_FRAC2WORD_MSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_FSM_BUSY_MSK NO_OS_BIT(1) |
#define ADF4382_INT_MODE_MSK NO_OS_BIT(2) |
#define ADF4382_INV_CLK_OUT_MSK NO_OS_BIT(4) |
#define ADF4382_INV_RDBLR_MSK NO_OS_BIT(4) |
#define ADF4382_LD_COUNT_OPWR_MSK NO_OS_GENMASK(4, 0) |
#define ADF4382_LD_O_CTRL_MSK NO_OS_GENMASK(1, 0) |
#define ADF4382_LDWIN_PW_MSK NO_OS_GENMASK(7, 5) |
#define ADF4382_LKD_DELAY_US 500 |
#define ADF4382_LOCKED_MSK NO_OS_BIT(0) |
#define ADF4382_LSB_FIRST_LSB 0x1 |
#define ADF4382_LSB_FIRST_MSB 0x0 |
#define ADF4382_LSB_FIRST_MSK NO_OS_BIT(1) |
#define ADF4382_LSB_FIRST_R_MSK NO_OS_BIT(6) |
#define ADF4382_LSB_P1_MSK NO_OS_BIT(6) |
#define ADF4382_LUT_SCALE_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_LUT_WR_ADDR_MSK NO_OS_GENMASK(5, 1) |
#define ADF4382_M_LUT_BAND_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_M_LUT_BAND_MSB_MSK NO_OS_BIT(0) |
#define ADF4382_M_LUT_CORE_MSK NO_OS_BIT(1) |
#define ADF4382_M_LUT_N_LSB_MSK NO_OS_GENMASK(7, 2) |
#define ADF4382_M_LUT_N_MSB_MSK NO_OS_GENMASK(5, 0) |
#define ADF4382_M_S_TRANSF_NO_OS_BIT_MSK NO_OS_BIT(0) |
#define ADF4382_M_VCO_BAND_LSB_MSK NO_OS_BIT(7) |
#define ADF4382_M_VCO_BAND_MSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_M_VCO_BIAS_MSK NO_OS_GENMASK(5, 0) |
#define ADF4382_M_VCO_CORE_MSK NO_OS_BIT(6) |
#define ADF4382_MARGIN_MSK NO_OS_GENMASK(1, 0) |
#define ADF4382_MASTER_RB_CTRL_MSK NO_OS_BIT(5) |
#define ADF4382_MOD1WORD 0x2000000U |
#define ADF4382_MOD2WORD_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_MOD2WORD_MAX 0xFFFFFFU |
#define ADF4382_MOD2WORD_MID_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_MOD2WORD_MSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_MUTE_CLKOUT1_MSK NO_OS_GENMASK(2, 0) |
#define ADF4382_MUTE_CLKOUT2_MSK NO_OS_GENMASK(5, 3) |
#define ADF4382_MUTE_NCLK_MSK NO_OS_BIT(7) |
#define ADF4382_MUTE_RCLK_MSK NO_OS_BIT(6) |
#define ADF4382_MUXOUT_MSK NO_OS_GENMASK(7, 4) |
#define ADF4382_N_INT_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_N_INT_MSB_MSK NO_OS_GENMASK(3, 0) |
#define ADF4382_NDIV_PWRUP_TIMEOUT_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_NVMADDR_MSK NO_OS_GENMASK(6, 3) |
#define ADF4382_NVMDIN_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_NVMDOUT_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_NVMNO_OS_BIT_SEL NO_OS_GENMASK(2, 0) |
#define ADF4382_NVMON_MSK NO_OS_BIT(2) |
#define ADF4382_NVMPROG_MSK NO_OS_BIT(5) |
#define ADF4382_NVMRD_MSK NO_OS_BIT(4) |
#define ADF4382_NVMSTART_MSK NO_OS_BIT(3) |
#define ADF4382_NVMTEST_MSK NO_OS_BIT(6) |
#define ADF4382_O_VCO_BAND_MSK NO_OS_BIT(1) |
#define ADF4382_O_VCO_BIAS_MSK NO_OS_BIT(2) |
#define ADF4382_O_VCO_CORE_MSK NO_OS_BIT(0) |
#define ADF4382_O_VCO_DB_MSK NO_OS_BIT(7) |
#define ADF4382_O_VCO_LUT_MSK NO_OS_BIT(0) |
#define ADF4382_OUT_PWR_MAX 15 |
#define ADF4382_PD_ADC_MSK NO_OS_BIT(1) |
#define ADF4382_PD_ALL_MSK NO_OS_BIT(7) |
#define ADF4382_PD_CALGEN_MSK NO_OS_BIT(0) |
#define ADF4382_PD_CLK_MSK NO_OS_BIT(3) |
#define ADF4382_PD_CLKOUT1_MSK NO_OS_BIT(1) |
#define ADF4382_PD_CLKOUT2_MSK NO_OS_BIT(0) |
#define ADF4382_PD_LD_MSK NO_OS_BIT(3) |
#define ADF4382_PD_NDIV_MSK NO_OS_BIT(5) |
#define ADF4382_PD_NDIV_TL_MSK NO_OS_BIT(6) |
#define ADF4382_PD_PFDCP_MSK NO_OS_BIT(2) |
#define ADF4382_PD_RDET_MSK NO_OS_BIT(2) |
#define ADF4382_PD_RDIV_TL_MSK NO_OS_BIT(6) |
#define ADF4382_PD_SYNC_MON_MSK NO_OS_BIT(6) |
#define ADF4382_PD_SYNC_MSK NO_OS_BIT(4) |
#define ADF4382_PD_VCO_MSK NO_OS_BIT(4) |
#define ADF4382_PDET_POL_MSK NO_OS_BIT(3) |
#define ADF4382_PFD_FREQ_FRAC_MAX 250000000U |
#define ADF4382_PFD_FREQ_MAX 625000000U |
#define ADF4382_PFD_FREQ_MIN 5400000U |
#define ADF4382_PFD_POL_MSK NO_OS_BIT(1) |
#define ADF4382_PH_RESYNC_RB_SEL_MSK NO_OS_BIT(7) |
#define ADF4382_PHASE_ADJ_MSK NO_OS_BIT(7) |
#define ADF4382_PHASE_ADJ_POL_MSK NO_OS_BIT(3) |
#define ADF4382_PHASE_ADJUST_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_PHASE_BLEED_CNST 2044000 |
#define ADF4382_PHASE_RESYNC_MOD2WORD_MAX 0x1FFFFU |
#define ADF4382_PHASE_WORD_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_PHASE_WORD_MID_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_PHASE_WORD_MSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_POR_DELAY_US 200 |
#define ADF4382_PRODUCT_ID_LSB 0x0005 |
#define ADF4382_PRODUCT_ID_MSB 0x0005 |
#define ADF4382_R_DIV_MSK NO_OS_GENMASK(5, 0) |
#define ADF4382_RB_MASTER_REG 0x1 |
#define ADF4382_RB_SLAVE_REG 0x0 |
#define ADF4382_RDBLR_DC_MSK NO_OS_GENMASK(5, 0) |
#define ADF4382_RDBLR_DEL_SEL_MSK NO_OS_GENMASK(3, 0) |
#define ADF4382_READ_MODE_MSK NO_OS_BIT(4) |
#define ADF4382_REF_CLK_MAX 5000000000U |
#define ADF4382_REF_CLK_MIN 10000000 |
#define ADF4382_REF_DIV_MAX 63 |
#define ADF4382_REF_SEL_MSK NO_OS_BIT(5) |
#define ADF4382_RESET_CMD 0x81 |
#define ADF4382_RESYNC_WAIT_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_RESYNC_WAIT_MSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_RFOUT_MAX 22000000000U |
#define ADF4382_RFOUT_MIN 687500000U |
#define ADF4382_RST_CNTR_MSK NO_OS_BIT(0) |
#define ADF4382_RST_LD_MSK NO_OS_BIT(2) |
#define ADF4382_RST_SYNC_MON_MSK NO_OS_BIT(4) |
#define ADF4382_RST_SYS_MSK NO_OS_BIT(4) |
#define ADF4382_SCAN_MODE_CODE_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_SCRATCHPAD_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_SDO_ACTIVE_MSK NO_OS_BIT(3) |
#define ADF4382_SDO_ACTIVE_R_MSK NO_OS_BIT(4) |
#define ADF4382_SDO_ACTIVE_SPI_3W 0x0 |
#define ADF4382_SDO_ACTIVE_SPI_4W 0x1 |
#define ADF4382_SINGLE_INSTR_MSK NO_OS_BIT(7) |
#define ADF4382_SOFT_RESET_EN 0x1 |
#define ADF4382_SOFT_RESET_MSK NO_OS_BIT(0) |
#define ADF4382_SOFT_RESET_N_OP 0x0 |
#define ADF4382_SOFT_RESET_R_MSK NO_OS_BIT(7) |
#define ADF4382_SPARE0_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_SPARE1_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_SPARE_1F_MSK NO_OS_BIT(6) |
#define ADF4382_SPARE_24_MSK NO_OS_GENMASK(7, 5) |
#define ADF4382_SPARE_32_MSK NO_OS_BIT(7) |
#define ADF4382_SPARE_35_MSK NO_OS_GENMASK(7, 6) |
#define ADF4382_SPARE_36_MSK NO_OS_GENMASK(5, 2) |
#define ADF4382_SPARE_3D_MSK NO_OS_BIT(7) |
#define ADF4382_SPARE_3F_MSK NO_OS_BIT(0) |
#define ADF4382_SPARE_45_MSK NO_OS_BIT(7) |
#define ADF4382_SPARE_47_MSK NO_OS_BIT(7) |
#define ADF4382_SPARE_4C_MSK NO_OS_GENMASK(7, 6) |
#define ADF4382_SPARE_4D_MSK NO_OS_GENMASK(4, 3) |
#define ADF4382_SPARE_4E_MSK NO_OS_GENMASK(7, 5) |
#define ADF4382_SPARE_53_MSK NO_OS_BIT(7) |
#define ADF4382_SPI_3W_CFG | ( | x | ) |
#define ADF4382_SPI_DUMMY_DATA 0x00 |
#define ADF4382_SPI_READ_CMD 0x8000 |
#define ADF4382_SPI_SCRATCHPAD_TEST 0x5A |
#define ADF4382_SPI_STREAM_DIS 0x1 |
#define ADF4382_SPI_STREAM_EN 0x0 |
#define ADF4382_SPI_WRITE_CMD 0x0 |
#define ADF4382_SW_SYNC_MSK NO_OS_BIT(7) |
#define ADF4382_SYNC_DEL_MSK NO_OS_GENMASK(7, 5) |
#define ADF4382_SYNC_MON_DEL_MSK NO_OS_GENMASK(3, 0) |
#define ADF4382_SYNC_REF_SPARE_MSK NO_OS_GENMASK(7, 4) |
#define ADF4382_SYNC_SEL_MSK NO_OS_BIT(5) |
#define ADF4382_SYNC_SH_DEL_MSK NO_OS_GENMASK(3, 0) |
#define ADF4382_SYNC_SP_DB_MSK NO_OS_BIT(6) |
#define ADF4382_TEMP_OFFSET_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_TEMP_SLOPE_MSK NO_OS_GENMASK(5, 0) |
#define ADF4382_TIMED_SYNC_MSK NO_OS_BIT(5) |
#define ADF4382_TRANS_LOOP_SEL_MSK NO_OS_BIT(0) |
#define ADF4382_TRIM_LATCH_MSK NO_OS_BIT(7) |
#define ADF4382_TWO_PASS_BAND_START_MSK NO_OS_GENMASK(3, 0) |
#define ADF4382_VAR_MOD_EN_MSK NO_OS_BIT(5) |
#define ADF4382_VCAL_ZERO_MSK NO_OS_BIT(7) |
#define ADF4382_VCO_BAND_LSB_MSK NO_OS_GENMASK(7, 0) |
#define ADF4382_VCO_BAND_MSB_MSK NO_OS_BIT(0) |
#define ADF4382_VCO_CAL_ALC 123 |
#define ADF4382_VCO_CAL_CNT 183 |
#define ADF4382_VCO_CAL_VTUNE 640 |
#define ADF4382_VCO_CORE_MSK NO_OS_BIT(1) |
#define ADF4382_VCO_FREQ_MAX 22000000000U |
#define ADF4382_VCO_FREQ_MIN 11000000000U |
#define ADF4382_VCO_FSM_TEST_MUX_MSK NO_OS_GENMASK(7, 5) |
#define ADF4382_VCTAT_CALGEN 82 |
#define ADF4382_VCTAT_CALGEN_MSK NO_OS_GENMASK(6, 0) |
#define ADF4382_VENDOR_ID_LSB 0x56 |
#define ADF4382_VENDOR_ID_MSB 0x04 |
#define ADF4382_VPTAT_CALGEN 46 |
#define ADF4382_VPTAT_CALGEN_MSK NO_OS_GENMASK(6, 0) |
#define ADF4382A_CLKOUT_DIV_REG_VAL_MAX 2 |
#define ADF4382A_RFOUT_MAX 21000000000U |
#define ADF4382A_RFOUT_MIN 2875000000U |
#define ADF4382A_VCO_FREQ_MAX 21000000000U |
#define ADF4382A_VCO_FREQ_MIN 11500000000U |
#define ADF4383_RFOUT_MAX 20000000000U |
#define ADF4383_RFOUT_MIN 625000000U |
#define ADF4383_VCO_FREQ_MAX 20000000000U |
#define ADF4383_VCO_FREQ_MIN 10000000000U |
#define MHZ MEGA |
#define NS_TO_PS KHZ_PER_MHZ |
#define PS_TO_S PICO |
#define S_TO_NS NANO |
enum adf4382_dev_id |
int adf4382_get_bleed_word | ( | struct adf4382_dev * | dev, |
int32_t * | word ) |
Gets the value of the set bleed word.
ADF4382 Get bleed current attribute
dev | - The device structure. |
word | - The read bleed current register value. |
int adf4382_get_change_rfout | ( | struct adf4382_dev * | dev, |
uint64_t * | val ) |
Gets the user proposed output frequency from the device tree without reading from the device. This is to enable and accurate reading of device lock-time.
ADF4382 Get Change Output Frequency attribute value
dev | - The device structure. |
val | - Holds the software value of RFOUT Frequency set. |
int adf4382_get_cp_i | ( | struct adf4382_dev * | dev, |
int32_t * | reg_val ) |
Gets the charge pump value from the register. The value will be between 0 and 15 on 8 bits. For more information please consult the Datasheet.
ADF4382 Get charge pump current attribute
dev | - The device structure. |
reg_val | - The read charge pump register value. |
int adf4382_get_en_chan | ( | struct adf4382_dev * | dev, |
uint8_t | ch, | ||
bool * | en ) |
Gets the value the output channel if it is enabled or disable.
ADF4382 Get channel enable attributes
dev | - The device structure. |
ch | - The channel to get state. |
en | - The status of the output channel. |
int adf4382_get_en_lut_calibration | ( | struct adf4382_dev * | dev, |
bool * | en ) |
Gets Fast calibration LUT Calibration status.
ADF4382 Get Fast Calibration LUT Calibration attributes
dev | - The device structure. |
en | - The set value of LUT Calibration. |
int adf4382_get_en_ref_doubler | ( | struct adf4382_dev * | dev, |
bool * | en ) |
Gets the value the doubler if it is enabled or disable and stores it it the dev structure.
ADF4382 Get reference doubler attribute
dev | - The device structure. |
en | - The read value of the reference doubler. |
int adf4382_get_out_power | ( | struct adf4382_dev * | dev, |
uint8_t | ch, | ||
int32_t * | pwr ) |
Gets the output power register value.
ADF4382 Get output power attributes
dev | - The device structure. |
ch | - The channel to get the power off. |
pwr | - The output power register value. |
int adf4382_get_phase_pol | ( | struct adf4382_dev * | dev, |
bool * | polarity ) |
Gets the polarity of the phase adjust.
ADF4382 Gets Phase adjustment polarity
uint8_t pol;
dev | - The device structure. |
polarity | - The read polarity of the phase. |
int adf4382_get_phase_sync_setup | ( | struct adf4382_dev * | dev, |
bool * | en ) |
Gets the value of the SYNC powerdown bit.
ADF4382 Get EZSYNC and Timed SYNC feature attributes
dev | - The device structure. |
en | - The read status of the sync enable. |
int adf4382_get_ref_clk | ( | struct adf4382_dev * | dev, |
uint64_t * | val ) |
Gets the user proposed reference frequency.
ADF4382 Get reference frequency attribute
dev | - The device structure. |
val | - The set value of the reference frequency in Hz. |
int adf4382_get_ref_div | ( | struct adf4382_dev * | dev, |
int32_t * | div ) |
Gets the value the reference divider.
ADF4382 Get reference divider attribute
dev | - The device structure. |
div | - The read reference divider value. |
int adf4382_get_rfout | ( | struct adf4382_dev * | dev, |
uint64_t * | val ) |
Gets the user proposed output frequency.
ADF4382 Get output frequency attribute
dev | - The device structure. |
val | - The set value of the output frequency in Hz. |
int adf4382_get_start_calibration | ( | struct adf4382_dev * | dev, |
bool * | start_cal ) |
Get the status of start calibration. Will always return zero to allow users set it multiple times to trigger autocalibration.
ADF4382 Get the NDIV register attribute value as 0
dev | - The device structure. |
start_cal | - Overwrites start calibration attribute to 0. |
int adf4382_get_sw_sync | ( | struct adf4382_dev * | dev, |
bool * | sw_sync ) |
Gets the value of the SW_SYNC bit.
ADF4382 Get sw_sync attribute
dev | - The device structure. |
sw_sync | - The read value of the SW_SYNC. |
int adf4382_init | ( | struct adf4382_dev ** | dev, |
struct adf4382_init_param * | init_param ) |
Initializes the ADF4382.
ADF4382 Initialization
dev | - The device structure. |
init_param | - The structure containing the device initial parameters. |
int adf4382_reg_dump | ( | struct adf4382_dev * | dev | ) |
Will output on the terminal the values of all the ADF4382 registers.
ADF4382 Register dump
dev | - The device structure. |
int adf4382_remove | ( | struct adf4382_dev * | dev | ) |
Free resources allocated for ADF4382.
ADF4382 Remove
dev | - The device structure. |
int adf4382_set_bleed_word | ( | struct adf4382_dev * | dev, |
int32_t | word ) |
Set the bleed word, which represents the value of the bleed current written to the register space.
ADF4382 Set bleed current attribute
dev | - The device structure. |
word | - The bleed current register value. |
int adf4382_set_change_freq | ( | struct adf4382_dev * | dev | ) |
Set the output frequency. This will set the required registers to device but skip NDIV value, to be written separately. This Function will not start autocalibration until REG0010 is written.
ADF4382 Set Output Frequency without writing the Ndiv Register
dev | - The device structure. |
int adf4382_set_change_rfout | ( | struct adf4382_dev * | dev, |
uint64_t | val ) |
Set the desired output frequency and reset everything over to maximum supported value of 22GHz (21GHz for ADF4382A) to the max without starting autocalibration. value and everything under the minimum supported value of 687.5MHz (2.875GHz for ADF4382A) to the min. value.
ADF4382 Set Change Output Frequency attribute value
dev | - The device structure. |
val | - The desired output frequency in Hz. |
int adf4382_set_cp_i | ( | struct adf4382_dev * | dev, |
int32_t | reg_val ) |
Set the charge pump value which will be written to the register. The value will be between 0 and 15 on 8 bits. For more information please consult the Datasheet.
ADF4382 Set charge pump current attribute
dev | - The device structure. |
reg_val | - The desired charge pump register value. |
int adf4382_set_en_chan | ( | struct adf4382_dev * | dev, |
uint8_t | ch, | ||
bool | en ) |
Set the output channel to enable or disable based on the passed parameter. If the parameter is different then 0 it will set the doubler to enable.
ADF4382 Set channel enable attributes
dev | - The device structure. |
ch | - The channel to set state. |
en | - The enable or disable value of the output channel. |
int adf4382_set_en_fast_calibration | ( | struct adf4382_dev * | dev, |
bool | en_fast_cal ) |
Fast calibration function. Computes Minimum VCO frequency (fmin), uses the minimum NDIV value to generate fastcal Lookup table (LUT), and finally enables LUT Calibration.
ADF4382 Set fast calibration attributes
dev | - The device structure. |
en_fast_cal | - Enables the fast calibration routine. |
int adf4382_set_en_lut_calibration | ( | struct adf4382_dev * | dev, |
bool | en_lut_cal ) |
Sets Fast calibration LUT Calibration. Refer to en_fastcal function to first generate fastcal Lookup Table (LUT).
ADF4382 Set fast calibration LUT calibration attributes
dev | - The device structure. |
en_lut_cal | - Enable/Disable LUT Calibration. |
int adf4382_set_en_ref_doubler | ( | struct adf4382_dev * | dev, |
bool | en ) |
Set the reference doubler to enable or disable based on the passed parameter. If the parameter is different then 0 it will set the doubler to enable.
ADF4382 Set reference doubler attribute
dev | - The device structure. |
en | - The enable or disable value of the reference doubler. |
int adf4382_set_ezsync_setup | ( | struct adf4382_dev * | dev, |
bool | sync ) |
Set the EZSYNC features' initial state. Awaits the SW_SYNC toggle.
ADF4382 Set EZSYNC feature attributes
dev | - The device structure. |
sync | - The enable or disable sync. |
int adf4382_set_freq | ( | struct adf4382_dev * | dev | ) |
Set the output frequency.
ADF4382 Sets frequency
dev | - The device structure. |
int adf4382_set_out_power | ( | struct adf4382_dev * | dev, |
uint8_t | ch, | ||
int32_t | pwr ) |
Set the output power register value of a channel and reset everything over to maximum supported value of 15 to the max. value.
ADF4382 Set output power attributes
dev | - The device structure. |
ch | - The channel to set the power off. |
pwr | - The output power register value. |
int adf4382_set_phase_adjust | ( | struct adf4382_dev * | dev, |
uint32_t | phase_ps ) |
Set the phase adjustment in pico-seconds. The phase adjust will enable the Bleed current option as well as delay mode to 0.
ADF4382 Sets Phase adjustment
dev | - The device structure. |
phase_ps | - The phase adjustment in pico-seconds. |
int adf4382_set_phase_pol | ( | struct adf4382_dev * | dev, |
bool | polarity ) |
Set the phase polarity. If pol = 0 then it will add the phase value otherwise it will subtract the phase value.
ADF4382 Sets Phase adjustment polarity
dev | - The device structure. |
polarity | - The polarity to be set. |
int adf4382_set_ref_clk | ( | struct adf4382_dev * | dev, |
uint64_t | val ) |
Set the desired reference frequency and reset everything over to maximum supported value of 5GHz to the max. value and everything under the minimum supported value of 10MHz to the min. value.
ADF4382 Set reference frequency attribute
dev | - The device structure. |
val | - The desired reference frequency in Hz. |
int adf4382_set_ref_div | ( | struct adf4382_dev * | dev, |
int32_t | div ) |
Set the reference divider value and reset everything over to maximum supported value of 63 to the max. value.
ADF4382 Set reference divider attribute
dev | - The device structure. |
div | - The reference divider value. |
int adf4382_set_rfout | ( | struct adf4382_dev * | dev, |
uint64_t | val ) |
Set the desired output frequency and reset everything over to maximum supported value of 22GHz (21GHz for ADF4382A) to the max. value and everything under the minimum supported value of 687.5MHz (2.875GHz for ADF4382A) to the min. value.
ADF4382 Set output frequency attribute
dev | - The device structure. |
val | - The desired output frequency in Hz. |
int adf4382_set_start_calibration | ( | struct adf4382_dev * | dev | ) |
Set REG0010 value in device structure to the device to start autocal.
ADF4382 Set the NDIV register attribute value
dev | - The device structure. |
int adf4382_set_sw_sync | ( | struct adf4382_dev * | dev, |
bool | sw_sync ) |
Set Software SYNC Request. Setting SW_SYNC resets the RF block. Clearing SW_SYNC makes ready for a new reference clock.
ADF4382 Set sw_sync attribute
dev | - The device structure. |
sw_sync | - Set send SW_SYNC request |
int adf4382_set_timed_sync_setup | ( | struct adf4382_dev * | dev, |
bool | sync ) |
Set Timed SYNC features' initial state. Uses SYNC pin.
ADF4382 Set Timed SYNC feature attributes
dev | - The device structure. |
sync | - The enable or disable sync. |
int adf4382_spi_read | ( | struct adf4382_dev * | dev, |
uint16_t | reg_addr, | ||
uint8_t * | data ) |
Reads data from ADF4382 over SPI.
ADF4382 SPI Read
dev | - The device structure. |
reg_addr | - The register address. |
data | - Data read from the device. |
int adf4382_spi_update_bits | ( | struct adf4382_dev * | dev, |
uint16_t | reg_addr, | ||
uint8_t | mask, | ||
uint8_t | data ) |
Updates the values of the ADF4382 register.
ADF4382 updates a bit in the register space over SPI
dev | - The device structure. |
reg_addr | - The register address. |
mask | - Bits to be updated. |
data | - Update value for the mask. |
int adf4382_spi_write | ( | struct adf4382_dev * | dev, |
uint16_t | reg_addr, | ||
uint8_t | data ) |
Writes data to ADF4382 over SPI.
ADF4382 SPI write
dev | - The device structure. |
reg_addr | - The register address. |
data | - Data value to write. |