ad9508.h File Reference

Header file of AD9508 Driver. More...

#include "no_os_spi.h"

Include dependency graph for ad9508.h:

Classes
struct	ad9508_init_param
struct	ad9508_dev

Macros
#define	AD9508_SPI_CONFIG   0x000
#define	AD9508_PART_ID_LOW   0x00C
#define	AD9508_PART_ID_HIGH   0x00D
#define	AD9508_OUT1_DIV_RATIO_LOW   0x01B
#define	AD9508_OUT1_DIV_RATIO_HIGH   0x01C
#define	AD9508_OUT1_PHASE_LOW   0x01D
#define	AD9508_OUT1_PHASE_HIGH   0x01E
#define	AD9508_PART_ID_VALUE   0x005
#define	AD9508_DIVIDE_RATIO_ONE   0x000

Functions
int32_t	ad9508_reg_read (struct ad9508_dev *dev, uint16_t reg_addr, uint8_t *reg_data)
	Reads from the ad9508 that is contected to the SPI.
int32_t	ad9508_reg_write (struct ad9508_dev *dev, uint16_t reg_addr, uint8_t reg_data)
	Write to the ad9508 that is conected to the SPI.
int32_t	ad9508_setup (struct ad9508_dev **device, const struct ad9508_init_param *init_param)
	Setup the working parameters of the ad9508 chip.
int32_t	ad9508_remove (struct ad9508_dev *dev)
	Free the resources allocated by ad9508_setup().

Detailed Description

Header file of AD9508 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

AD9508_DIVIDE_RATIO_ONE

#define AD9508_DIVIDE_RATIO_ONE   0x000

AD9508_OUT1_DIV_RATIO_HIGH

#define AD9508_OUT1_DIV_RATIO_HIGH   0x01C

AD9508_OUT1_DIV_RATIO_LOW

#define AD9508_OUT1_DIV_RATIO_LOW   0x01B

AD9508_OUT1_PHASE_HIGH

#define AD9508_OUT1_PHASE_HIGH   0x01E

AD9508_OUT1_PHASE_LOW

#define AD9508_OUT1_PHASE_LOW   0x01D

AD9508_PART_ID_HIGH

#define AD9508_PART_ID_HIGH   0x00D

AD9508_PART_ID_LOW

#define AD9508_PART_ID_LOW   0x00C

AD9508_PART_ID_VALUE

#define AD9508_PART_ID_VALUE   0x005

AD9508_SPI_CONFIG

#define AD9508_SPI_CONFIG   0x000

Function Documentation

ad9508_reg_read()

int32_t ad9508_reg_read	(	struct ad9508_dev *	dev,
		uint16_t	reg_addr,
		uint8_t *	reg_data )

Reads from the ad9508 that is contected to the SPI.

Parameters

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

Returns

0 if the value was successfully read, -1 otherwise

ad9508_reg_write()

int32_t ad9508_reg_write	(	struct ad9508_dev *	dev,
		uint16_t	reg_addr,
		uint8_t	reg_data )

Write to the ad9508 that is conected to the SPI.

Parameters

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

Returns

0 if the value was written successfully, -1 otherwise

ad9508_remove()

int32_t ad9508_remove

(

struct ad9508_dev *

dev

)

Free the resources allocated by ad9508_setup().

Parameters

dev	- The device structure.

Returns

0 in case of success, negative error code otherwise.

ad9508_setup()

int32_t ad9508_setup	(	struct ad9508_dev **	device,
		const struct ad9508_init_param *	init_param )

Setup the working parameters of the ad9508 chip.

Parameters

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

Returns

0 if device is ready for use, -1 otherwise