no-OS
Classes | Functions
iio_axi_adc.h File Reference

Header file of iio_axi_adc. More...

#include "iio_types.h"
#include "axi_adc_core.h"
#include "axi_dmac.h"
Include dependency graph for iio_axi_adc.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  iio_axi_adc_desc
 iio_axi_adc_descriptor More...
 
struct  iio_axi_adc_init_param
 iio configuration. More...
 

Functions

int32_t iio_axi_adc_init (struct iio_axi_adc_desc **desc, struct iio_axi_adc_init_param *param)
 Registers a iio_axi_adc_desc for reading/writing and parameterization of axi_adc device. More...
 
void iio_axi_adc_get_dev_descriptor (struct iio_axi_adc_desc *desc, struct iio_device **dev_descriptor)
 Get device descriptor. More...
 
int32_t iio_axi_adc_remove (struct iio_axi_adc_desc *desc)
 Release resources. More...
 

Detailed Description

Header file of iio_axi_adc.

Author
Cristian Pop (crist.nosp@m.ian..nosp@m.pop@a.nosp@m.nalo.nosp@m.g.com)

Copyright 2019(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.

Function Documentation

◆ iio_axi_adc_get_dev_descriptor()

void iio_axi_adc_get_dev_descriptor ( struct iio_axi_adc_desc desc,
struct iio_device **  dev_descriptor 
)

Get device descriptor.

Get device descriptor.

Parameters
desc- axi iio axi adc descriptor.
dev_descriptor- iio device.
Returns
None.
Here is the caller graph for this function:

◆ iio_axi_adc_init()

int32_t iio_axi_adc_init ( struct iio_axi_adc_desc **  desc,
struct iio_axi_adc_init_param init 
)

Registers a iio_axi_adc_desc for reading/writing and parameterization of axi_adc device.

Parameters
desc- Descriptor.
init- Configuration structure.
Returns
0 in case of success, -1 otherwise.
Here is the caller graph for this function:

◆ iio_axi_adc_remove()

int32_t iio_axi_adc_remove ( struct iio_axi_adc_desc desc)

Release resources.

Parameters
desc- Descriptor.
Returns
0 in case of success, -1 otherwise.
Here is the caller graph for this function: