no-OS
Classes | Macros | Functions
iio_max14906.h File Reference

Header file of MAX14906 IIO Driver. More...

#include <stdint.h>
#include <stdbool.h>
#include "iio.h"
#include "max14906.h"
Include dependency graph for iio_max14906.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  max14906_ch_config
 Configuration structure for a MAX14906 channel. More...
 
struct  max14906_iio_desc
 MAX14906 specific IIO descriptor. More...
 
struct  max14906_iio_desc_init_param
 Initialization parameter for the MAX14906 IIO descriptor. More...
 

Macros

#define MAX14906_FUNCTION_CNT   3
 

Functions

int max14906_iio_init (struct max14906_iio_desc **, struct max14906_iio_desc_init_param *)
 Initializes the MAX14906 IIO descriptor. More...
 
int max14906_iio_remove (struct max14906_iio_desc *)
 Free resources allocated by the init function. More...
 

Detailed Description

Header file of MAX14906 IIO Driver.

Author
Ciprian Regus (cipri.nosp@m.an.r.nosp@m.egus@.nosp@m.anal.nosp@m.og.co.nosp@m.m)

Copyright 2023(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

◆ MAX14906_FUNCTION_CNT

#define MAX14906_FUNCTION_CNT   3

Function Documentation

◆ max14906_iio_init()

int max14906_iio_init ( struct max14906_iio_desc **  iio_desc,
struct max14906_iio_desc_init_param init_param 
)

Initializes the MAX14906 IIO descriptor.

Initializes the MAX14906 IIO descriptor

Parameters
iio_desc- The iio device descriptor.
init_param- The structure that contains the device initial parameters.
Returns
0 in case of success, an error code otherwise.
Here is the caller graph for this function:

◆ max14906_iio_remove()

int max14906_iio_remove ( struct max14906_iio_desc iio_desc)

Free resources allocated by the init function.

Free resources allocated by the init function

Parameters
iio_desc- The iio device descriptor.
Returns
0 in case of success, an error code otherwise.
Here is the caller graph for this function: