adf4157.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _ADF4157_H_
#define _ADF4157_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"
 
/******************************************************************************/
/********************* Macros and Constants Definitions ***********************/
/******************************************************************************/
/* FRAC/INT Register R0 */
/* MUXOUT Control */
#define ADF4157_MUXOUT_Z            (0x00 << 27)
#define ADF4157_MUXOUT_DVdd         (0x01 << 27)
#define ADF4157_MUXOUT_DGND         (0x02 << 27)
#define ADF4157_MUXOUT_RDIV         (0x03 << 27)
#define ADF4157_MUXOUT_NDIV         (0x04 << 27)
#define ADF4157_MUXOUT_ALOCK        (0x05 << 27)
#define ADF4157_MUXOUT_DLOCK        (0x06 << 27)
#define ADF4157_MUXOUT_SDO          (0x07 << 27)
#define ADF4157_MUXOUT_CLKDIV       (0x0A << 27)
#define ADF4157_MUXOUT_FLS          (0x0C << 27)
#define ADF4157_MUXOUT_RDIV2        (0x0D << 27)
#define ADF4157_MUXOUT_NDIV2        (0x0E << 27)
#define ADF4157_MUXOUT_RESERVED     (0x0F << 27)
/* 12-Bit Integer Value INT */
#define ADF4157_INT_VAL(x)          ((x & 0xFFF) << 15)
/* 12-Bit Fractional Value FRAC */
#define ADF4157_FRAC_VAL_MSB(x)     ((x & 0x1FFE000) >> 10)
/* Control bits */
#define ADF4157_R0_CTRL             0x00
 
/* LSB FRAC Register R1 */
#define ADF4157_FRAC_VAL_LSB(x)     ((x & 0x1FFF) << 15)
#define ADF4157_R1_CTRL             0x01
 
/* MOD/R Register R2 */
/* Noise Mode */
#define ADF4157_LOW_NOISE           (0x00 << 29)
#define ADF4157_LOW_SPUR            (0x03 << 29)
/* CSR EN */
#define ADF4157_CSR_EN(x)           ((x & 0x1) << 28)
/* Current setting */
#define ADF4157_CURR_SET(x)         ((x & 0xF) << 24)
/* Prescaler */
#define ADF4157_PRESCALER(x)        ((x & 0x1) << 22)
/* RDIV2 */
#define ADF4157_RDIV2(x)            ((x & 0x1) << 21)
/* Reference Doubler */
#define ADF4157_REF_DBL(x)          ((x & 0x1) << 20)
/* 5-Bit R-Counter */
#define ADF4157_R_CNT(x)            ((x & 0x1F) << 15)
/* Control bits */
#define ADF4157_R2_CTRL             0x02
 
/* Function Register R3 */
/* Sigma Delta Reset */
#define ADF4157_SIG_DEL_RST(x)      ((x & 0x1) << 14)
/* LDP */
#define ADF4157_LDP(x)              ((x & 0x1) << 7)
/* PD Polarity */
#define ADF4157_PD_POL(x)           ((x & 0x1)  << 6)
/* Power down */
#define ADF4157_PD                  ((x & 0x1) << 5)
/* CP Three State */
#define ADF4157_CP_Z(x)             ((x & 0x1) << 4)
/* Counter Reset */
#define ADF4157_CNT_RST(x)          ((x & 0x1) << 3)
/* Control bits */
#define ADF4157_R3_CTRL             0x03
 
/* CLK DIV Register R4 */
/* NEG BLEED Current*/
#define ADF4157_NEG_BLEED_CUR(x)    ((x && 0x3) << 23)
/* CLK DIV Mode */
#define ADF4157_CLK_DIV_OFF         (0x00 << 19)
#define ADF4157_CLK_FAST_LOCK       (0x01 << 19)
#define ADF4157_CLK_RESYNC_EN       (0x02 << 19)
/* CLK DIV VALUE */
#define ADF4157_CLK_DIV_VAL(x)      ((x & 0xFFF) << 7)
/* Control bits */
#define ADF4157_R4_CTRL             0x04
 
/* GPIO */
#define ADF4157_LE_OUT              no_os_gpio_direction_output(dev->gpio_le,  \
                        NO_OS_GPIO_HIGH);
#define ADF4157_LE_LOW              no_os_gpio_set_value(dev->gpio_le,         \
                        NO_OS_GPIO_LOW)
#define ADF4157_LE_HIGH             no_os_gpio_set_value(dev->gpio_le,         \
                        NO_OS_GPIO_HIGH)
 
#define ADF4157_MUX_OUT             no_os_gpio_direction_output(dev->gpio_mux, \
                        NO_OS_GPIO_HIGH);
#define ADF4157_MUX_LOW             no_os_gpio_set_value(dev->gpio_mux,        \
                        NO_OS_GPIO_LOW)
#define ADF4157_MUX_HIGH            no_os_gpio_set_value(dev->gpio_mux,        \
                        NO_OS_GPIO_HIGH)
 
#define ADF4157_CE_OUT              no_os_gpio_direction_output(dev->gpio_ce,  \
                        NO_OS_GPIO_HIGH);
#define ADF4157_CE_LOW              no_os_gpio_set_value(dev->gpio_ce,         \
                        NO_OS_GPIO_LOW)
#define ADF4157_CE_HIGH             no_os_gpio_set_value(dev->gpio_ce,         \
                        NO_OS_GPIO_HIGH)
 
#define ADF4157_LE2_OUT             no_os_gpio_direction_output(dev->gpio_le2, \
                        NO_OS_GPIO_HIGH);
#define ADF4157_LE2_LOW             no_os_gpio_set_value(dev->gpio_le2,        \
                        NO_OS_GPIO_LOW)
#define ADF4157_LE2_HIGH            no_os_gpio_set_value(dev->gpio_le2,        \
                        NO_OS_GPIO_HIGH)
 
#define ADF4157_CE2_OUT             no_os_gpio_direction_output(dev->gpio_ce2, \
                        NO_OS_GPIO_HIGH);
#define ADF4157_CE2_LOW             no_os_gpio_set_value(dev->gpio_ce2,        \
                        NO_OS_GPIO_LOW)
#define ADF4157_CE2_HIGH            no_os_gpio_set_value(dev->gpio_ce2,        \
                        NO_OS_GPIO_HIGH)
 
/* Specifications */
#define ADF4157_MAX_OUT_FREQ        6000          /* MHz */
#define ADF4157_MIN_OUT_FREQ        500           /* MHz */
#define ADF4157_MAX_FREQ_45_PRESC   3000          /* MHz */
#define ADF4157_MAX_FREQ_PFD        32000000      /* Hz */
#define ADF4157_MAX_FREQ_REFIN      300000000     /* Hz */
#define ADF4157_MIN_FREQ_REFIN      10000000      /* Hz */
#define ADF4157_FIXED_MODULUS       33554432      /* 2^25 */
#define ADF4157_MAX_R_CNT           32
#define ADF4157_MAX_REG_VAL         0x1FFFFFFF
 
/* Registers */
#define ADF4157_REG0                0
#define ADF4157_REG1                1
#define ADF4157_REG2                2
#define ADF4157_REG3                3
#define ADF4157_REG4                4
 
/******************************************************************************/
/**************************** Types Declarations ******************************/
/******************************************************************************/
struct adf4157_platform_data {
    uint32_t    clkin;
    uint8_t     ref_doubler_en;
    uint8_t     ref_div2_en;
    uint32_t    r0_user_settings;
    uint32_t    r2_user_settings;
    uint32_t    r3_user_settings;
    uint32_t    r4_user_settings;
};
 
struct adf4157_state {
    struct adf4157_platform_data    *pdata;
    uint32_t            fpfd;               /* Phase Frequency Detector */
    uint16_t            r_cnt;              /* R-counter */
    uint32_t            r0_fract;           /* Fractional value */
    uint32_t            r0_int;             /* Integer value */
    uint32_t            r2_mod;             /* Modulus value */
    float               channel_spacing;    /* Channel spacing */
    uint32_t            reg_val[5];         /* Actual register value */
};
 
struct adf4157_dev {
    /* SPI */
    struct no_os_spi_desc   *spi_desc;
    /* GPIO */
    struct no_os_gpio_desc  *gpio_le;
    struct no_os_gpio_desc  *gpio_ce;
    /* Device Settings */
    struct      adf4157_state adf4157_st;
};
 
struct adf4157_init_param {
    /* SPI */
    struct no_os_spi_init_param spi_init;
    /* GPIO */
    struct no_os_gpio_init_param    gpio_le;
    struct no_os_gpio_init_param    gpio_ce;
};
 
/******************************************************************************/
/************************** Functions Declarations ****************************/
/******************************************************************************/
/* Initialize the SPI communication with the device. */
int8_t adf4157_init(struct adf4157_dev **device,
            struct adf4157_init_param init_param);
 
/* Free the resources allocated by adf4157_init(). */
int32_t adf4157_remove(struct adf4157_dev *dev);
 
/* Transmits 32 bits on SPI. */
int8_t adf4157_set(struct adf4157_dev *dev,
           uint32_t value);
 
/* Increases the R counter value until the PFD frequency is smaller than
ADF4157_MAX_FREQ_PFD. */
int32_t adf4157_tune_r_cnt(struct adf4157_dev *dev,
               int32_t r_cnt);
 
/* Computes the greatest common divider of two numbers. */
uint32_t gcd(uint32_t x, uint32_t y);
 
/* Sets the ADF4157 output frequency. */
double adf4157_set_freq(struct adf4157_dev *dev,
            double freq);
 
#endif /* _ADF4157_H_ */