ad796x.h File Reference

Header file of AD796X Driver. More...

#include "no_os_gpio.h"
#include "no_os_pwm.h"
#include "axi_dmac.h"
#include "clk_axi_clkgen.h"
#include "axi_adc_core.h"

Include dependency graph for ad796x.h:

Classes
struct	ad796x_init_param
	AD796X Device initialization parameters. More...
struct	ad796x_dev
	AD796X Device structure. More...

Macros
#define	AD796X_NUM_GPIOS   4

Enumerations
enum	ad796x_mode {   AD796X_MODE0_POWER_DOWN ,   AD796X_MODE1_EXT_REF_5P0 ,   AD796X_MODE2_INT_REF_4P0 ,   AD796X_MODE3_EXT_REF_4P0 ,   AD796X_MODE4_SNOOZE ,   AD796X_MODE5_TEST ,   AD796X_MODE6_INVALID ,   AD796X_MODE7_EXT_REF_5P0_9MHZ ,   AD796X_MODE8_INT_REF_4P0_9MHZ ,   AD796X_MODE9_EXT_REF_4P0_9MHZ ,   AD796X_MODE10_SNOOZE2 }

Functions
int	ad796x_init (struct ad796x_dev **device, struct ad796x_init_param *init_param)
	Initialize the device.
int	ad796x_remove (struct ad796x_dev *dev)
	Remove the device and release resources.
int32_t	ad796x_read_data (struct ad796x_dev *dev, uint32_t *buf, uint16_t samples)
	Read data samples from adc.

Detailed Description

Header file of AD796X Driver.

Author

Axel Haslam (ahasl.nosp@m.am@b.nosp@m.aylib.nosp@m.re.c.nosp@m.om)

Copyright 2024(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Macro Definition Documentation

AD796X_NUM_GPIOS

#define AD796X_NUM_GPIOS   4

Enumeration Type Documentation

ad796x_mode

enum ad796x_mode

Enumerator
AD796X_MODE0_POWER_DOWN
AD796X_MODE1_EXT_REF_5P0
AD796X_MODE2_INT_REF_4P0
AD796X_MODE3_EXT_REF_4P0
AD796X_MODE4_SNOOZE
AD796X_MODE5_TEST
AD796X_MODE6_INVALID
AD796X_MODE7_EXT_REF_5P0_9MHZ
AD796X_MODE8_INT_REF_4P0_9MHZ
AD796X_MODE9_EXT_REF_4P0_9MHZ
AD796X_MODE10_SNOOZE2

Function Documentation

ad796x_init()

int ad796x_init	(	struct ad796x_dev **	device,
		struct ad796x_init_param *	init_param )

Initialize the device.

Parameters

device	- The device structure.
init_param	- The structure that contains the device initial parameters.

Returns

0 in case of success, negative error code otherwise.

ad796x_read_data()

int32_t ad796x_read_data	(	struct ad796x_dev *	dev,
		uint32_t *	buf,
		uint16_t	samples )

Read data samples from adc.

Parameters

dev	- The device structure.
buf	- The buffer to fill.
samples	- number of samples to read.

Returns

0 in case of success, negative error code otherwise.

ad796x_remove()

int ad796x_remove

(

struct ad796x_dev *

dev

)

Remove the device and release resources.

Parameters

dev	- The device structure.

Returns

0 in case of success, negative error code otherwise.