ad9553.h File Reference

Header file of AD9553 Driver. More...

#include "no_os_spi.h"

Include dependency graph for ad9553.h:

Classes
struct	ad9553_init_param
struct	ad9553_dev

Macros
#define	AD9553_SPI_CONFIG   0x000
#define	AD9553_PLL_CHARGE_PUMP_PFD_CTRL   0x00B
#define	AD9553_PLL_CTRL   0x00D
#define	AD9553_P1_DIV_HIGH   0x015
#define	AD9553_P1_DIV_LOW_P2_DIV_HIGH   0x016
#define	AD9553_P2_DIV_LOW   0x017
#define	AD9553_P0_DIV   0x018
#define	AD9553_N_DIV_HIGH   0x012
#define	AD9553_N_DIV_MEDIUM   0x013
#define	AD9553_N_DIV_LOW   0x014
#define	AD9553_REFA_DIV_HIGH   0x01F
#define	AD9553_REFA_DIV_LOW   0x020
#define	AD9553_K_VALUE   0x021
#define	AD9553_REFA_DIFF   0x029
#define	AD9553_OUT1_DRIVER_CTRL   0x032
#define	AD9553_OUT2_DRIVER_CTRL   0x034
#define	AD9553_IO_UPDATE   0x005

Functions
int32_t	ad9553_reg_read (struct ad9553_dev *dev, uint16_t reg_addr, uint8_t *reg_data)
	Reads from the ad9553 that is contected to the SPI.
int32_t	ad9553_reg_write (struct ad9553_dev *dev, uint16_t reg_addr, uint8_t reg_data)
	Write to the ad9553 that is conected to the SPI.
int32_t	ad9553_setup (struct ad9553_dev **device, const struct ad9553_init_param *init_param)
	Setup the working parameters of the ad9553 chip.
int32_t	ad9553_remove (struct ad9553_dev *dev)
	Free the resources allocated by ad9553_setup().

Detailed Description

Header file of AD9553 Driver.

Author

DHotolea (dan.h.nosp@m.otol.nosp@m.eanu@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2020(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Macro Definition Documentation

AD9553_IO_UPDATE

#define AD9553_IO_UPDATE   0x005

AD9553_K_VALUE

#define AD9553_K_VALUE   0x021

AD9553_N_DIV_HIGH

#define AD9553_N_DIV_HIGH   0x012

AD9553_N_DIV_LOW

#define AD9553_N_DIV_LOW   0x014

AD9553_N_DIV_MEDIUM

#define AD9553_N_DIV_MEDIUM   0x013

AD9553_OUT1_DRIVER_CTRL

#define AD9553_OUT1_DRIVER_CTRL   0x032

AD9553_OUT2_DRIVER_CTRL

#define AD9553_OUT2_DRIVER_CTRL   0x034

AD9553_P0_DIV

#define AD9553_P0_DIV   0x018

AD9553_P1_DIV_HIGH

#define AD9553_P1_DIV_HIGH   0x015

AD9553_P1_DIV_LOW_P2_DIV_HIGH

#define AD9553_P1_DIV_LOW_P2_DIV_HIGH   0x016

AD9553_P2_DIV_LOW

#define AD9553_P2_DIV_LOW   0x017

AD9553_PLL_CHARGE_PUMP_PFD_CTRL

#define AD9553_PLL_CHARGE_PUMP_PFD_CTRL   0x00B

AD9553_PLL_CTRL

#define AD9553_PLL_CTRL   0x00D

AD9553_REFA_DIFF

#define AD9553_REFA_DIFF   0x029

AD9553_REFA_DIV_HIGH

#define AD9553_REFA_DIV_HIGH   0x01F

AD9553_REFA_DIV_LOW

#define AD9553_REFA_DIV_LOW   0x020

AD9553_SPI_CONFIG

#define AD9553_SPI_CONFIG   0x000

Function Documentation

ad9553_reg_read()

int32_t ad9553_reg_read	(	struct ad9553_dev *	dev,
		uint16_t	reg_addr,
		uint8_t *	reg_data )

Reads from the ad9553 that is contected to the SPI.

Parameters

dev	- The ad9553 device handler
reg_addr	- The address of the internal register of the ad9553 chip
reg_data	- The value read from the internal register

Returns

0 if the value was successfully read, -1 otherwise

ad9553_reg_write()

int32_t ad9553_reg_write	(	struct ad9553_dev *	dev,
		uint16_t	reg_addr,
		uint8_t	reg_data )

Write to the ad9553 that is conected to the SPI.

Parameters

dev	- The device handler for the ad9553 chip
reg_addr	- Address of the internal register of the ad9553 chip
reg_data	- Value to be written to the register

Returns

0 if the value was written successfully, -1 otherwise

ad9553_remove()

int32_t ad9553_remove

(

struct ad9553_dev *

dev

)

Free the resources allocated by ad9553_setup().

Parameters

dev	- The device structure.

Returns

0 in case of success, negative error code otherwise.

ad9553_setup()

int32_t ad9553_setup	(	struct ad9553_dev **	device,
		const struct ad9553_init_param *	init_param )

Setup the working parameters of the ad9553 chip.

Parameters

device	- The device handler of the ad9553 chip
init_param	- Values for the working parameters of ad9553

Returns

0 if device is ready for use, -1 otherwise