no-OS
Classes | Functions
iio_ltm4686.h File Reference

Header file for the LTM4686 IIO Driver. More...

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

Go to the source code of this file.

Classes

struct  ltm4686_iio_desc
 Structure holding the LTM4686 IIO device descriptor. More...
 
struct  ltm4686_iio_desc_init_param
 Structure holding the LTM4686 IIO initialization parameter. More...
 

Functions

int ltm4686_iio_init (struct ltm4686_iio_desc **, struct ltm4686_iio_desc_init_param *)
 Initializes the LTM4686 IIO descriptor. More...
 
int ltm4686_iio_remove (struct ltm4686_iio_desc *)
 Free resources allocated by the init function. More...
 

Detailed Description

Header file for the LTM4686 IIO Driver.

Author
Cedric Justine Encarnacion (cedri.nosp@m.cjus.nosp@m.tine..nosp@m.enca.nosp@m.rnaci.nosp@m.on@a.nosp@m.nalog.nosp@m..com)

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

◆ ltm4686_iio_init()

int ltm4686_iio_init ( struct ltm4686_iio_desc **  iio_desc,
struct ltm4686_iio_desc_init_param init_param 
)

Initializes the LTM4686 IIO descriptor.

Initializes the LTM4686 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:

◆ ltm4686_iio_remove()

int ltm4686_iio_remove ( struct ltm4686_iio_desc iio_desc)

Free resources allocated by the init function.

Free resources allocated by the initialization 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: