ad9508.h File Reference

Header file of AD9508 Driver. More...

#include "no_os_spi.h"

Include dependency graph for ad9508.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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. More...
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. More...
int32_t	ad9508_setup (struct ad9508_dev **device, const struct ad9508_init_param *init_param)
	Setup the working parameters of the ad9508 chip. More...
int32_t	ad9508_remove (struct ad9508_dev *dev)
	Free the resources allocated by ad9508_setup(). More...

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.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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.

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

Here is the caller graph for this function:

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

Here is the caller graph for this function:

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

Here is the caller graph for this function: