no-OS
Classes | Macros | Enumerations | Functions | Variables
iio_ad5791.h File Reference

Header of AD5791 IIO Driver. More...

#include "iio.h"
#include "no-os/util.h"
#include "ad5791.h"
Include dependency graph for iio_ad5791.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  ad5791_iio_desc
 D5791 IIO driver handler. More...
 
struct  ad5791_iio_init_param
 AD5791 IIO driver initialization structure. More...
 

Macros

#define AD5791_CH_NO   1
 

Enumerations

enum  ad5791_iio_powerdown_modes {
  AD5791_6kOHMS_TO_GND,
  AD5791_THREE_STATE
}
 AD5791 channel power down modes. More...
 

Functions

int32_t ad5791_iio_init (struct ad5791_iio_desc **iio_dev, struct ad5791_iio_init_param *init_param)
 Initialize the AD5791 IIO driver. More...
 
int32_t ad5791_iio_remove (struct ad5791_iio_desc *desc)
 Free memory allocated by ad5791_iio_init(). More...
 

Variables

struct iio_device const iio_ad5791_device
 

Detailed Description

Header of AD5791 IIO Driver.

Author
Andrei Drimbarean (andre.nosp@m.i.dr.nosp@m.imbar.nosp@m.ean@.nosp@m.analo.nosp@m.g.co.nosp@m.m)

Copyright 2021(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:

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

◆ AD5791_CH_NO

#define AD5791_CH_NO   1

Enumeration Type Documentation

◆ ad5791_iio_powerdown_modes

AD5791 channel power down modes.

Enumerator
AD5791_6kOHMS_TO_GND 
AD5791_THREE_STATE 

Function Documentation

◆ ad5791_iio_init()

int32_t ad5791_iio_init ( struct ad5791_iio_desc **  iio_dev,
struct ad5791_iio_init_param init_param 
)

Initialize the AD5791 IIO driver.

Parameters
iio_dev- Pointer to the IIO driver handler.
init_param- Pointer to the initialization structure.
Returns
SUCCESS in case of success, negative error code otherwise.
Here is the caller graph for this function:

◆ ad5791_iio_remove()

int32_t ad5791_iio_remove ( struct ad5791_iio_desc desc)

Free memory allocated by ad5791_iio_init().

Parameters
desc-Pointer to the driver handler.
Returns
SUCCESS in case of success, negative error code otherwise.

Variable Documentation

◆ iio_ad5791_device

struct iio_device const iio_ad5791_device