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"
Go to the source code of this file.
Classes | |
| struct | ad796x_init_param |
| AD796X Device initialization parameters. More... | |
| struct | ad796x_dev |
| AD796X Device structure. More... | |
Macros | |
| #define | AD796X_NUM_GPIOS 4 |
Functions | |
| int | ad796x_init (struct ad796x_dev **device, struct ad796x_init_param *init_param) |
| Initialize the device. More... | |
| int | ad796x_remove (struct ad796x_dev *dev) |
| Remove the device and release resources. More... | |
| int32_t | ad796x_read_data (struct ad796x_dev *dev, uint32_t *buf, uint16_t samples) |
| Read data samples from adc. More... | |
Detailed Description
Header file of AD796X Driver.
Copyright 2024(c) Analog Devices, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- 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.
- 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.
- The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
- Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.
THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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
◆ AD796X_NUM_GPIOS
| #define AD796X_NUM_GPIOS 4 |
Enumeration Type Documentation
◆ ad796x_mode
| enum ad796x_mode |
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.
