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

Header file of IIO MAX22200 Driver. More...

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

Go to the source code of this file.

Classes

struct  max22200_iio_desc
 MAX22200 specific IIO descriptor. More...
 
struct  max22200_iio_desc_init_param
 Initalization parameter fr the MAX22200 IIO descriptor. More...
 

Macros

#define MAX22200_HOLD_MAX_VAL   0xFF
 
#define MAX22200_HIT_T_MAX_VAL   0xFF
 

Enumerations

enum  max22200_iio_fault_mask {
  MAX22200_IIO_UVM_MASK = 1,
  MAX22200_IIO_COMER_MASK,
  MAX22200_IIO_DPM_MASK,
  MAX22200_IIO_HHF_MASK,
  MAX22200_IIO_OLF_MASK,
  MAX22200_IIO_OCP_MASK,
  MAX22200_IIO_OVT_MASK
}
 
enum  max22200_iio_ch_attrs {
  MAX22200_IIO_SCALE,
  MAX22200_IIO_HIT_CURRENT,
  MAX22200_IIO_HIT_TIME,
  MAX22200_IIO_HOLD_CURRENT,
  MAX22200_IIO_CH_TRIG,
  MAX22200_IIO_CH_DRIVE,
  MAX22200_IIO_CH_SIDE,
  MAX22200_IIO_CH_OP_MODE,
  MAX22200_IIO_CH_FREQ
}
 
enum  max22200_iio_available {
  MAX22200_IIO_SCALE_AVAILABLE,
  MAX22200_IIO_CH_TRIG_AVAILABLE,
  MAX22200_IIO_CH_FREQ_AVAILABLE,
  MAX22200_IIO_CHOP_FREQ_AVAILABLE,
  MAX22200_IIO_CH_DRIVE_AVAILABLE,
  MAX22200_IIO_CH_SIDE_AVAILABLE,
  MAX22200_IIO_CH_OP_MODE_AVAILABLE
}
 

Functions

int max22200_iio_init (struct max22200_iio_desc **, struct max22200_iio_desc_init_param *)
 Initializes the MAX22200 IIO descriptor. More...
 
int max22200_iio_remove (struct max22200_iio_desc *)
 Free resources allocated by the init function. More...
 

Detailed Description

Header file of IIO MAX22200 Driver.

Author
Radu Sabau (radu..nosp@m.saba.nosp@m.u@ana.nosp@m.log..nosp@m.com)

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

◆ MAX22200_HIT_T_MAX_VAL

#define MAX22200_HIT_T_MAX_VAL   0xFF

◆ MAX22200_HOLD_MAX_VAL

#define MAX22200_HOLD_MAX_VAL   0xFF

Enumeration Type Documentation

◆ max22200_iio_available

Enumerator
MAX22200_IIO_SCALE_AVAILABLE 
MAX22200_IIO_CH_TRIG_AVAILABLE 
MAX22200_IIO_CH_FREQ_AVAILABLE 
MAX22200_IIO_CHOP_FREQ_AVAILABLE 
MAX22200_IIO_CH_DRIVE_AVAILABLE 
MAX22200_IIO_CH_SIDE_AVAILABLE 
MAX22200_IIO_CH_OP_MODE_AVAILABLE 

◆ max22200_iio_ch_attrs

Enumerator
MAX22200_IIO_SCALE 
MAX22200_IIO_HIT_CURRENT 
MAX22200_IIO_HIT_TIME 
MAX22200_IIO_HOLD_CURRENT 
MAX22200_IIO_CH_TRIG 
MAX22200_IIO_CH_DRIVE 
MAX22200_IIO_CH_SIDE 
MAX22200_IIO_CH_OP_MODE 
MAX22200_IIO_CH_FREQ 

◆ max22200_iio_fault_mask

Enumerator
MAX22200_IIO_UVM_MASK 
MAX22200_IIO_COMER_MASK 
MAX22200_IIO_DPM_MASK 
MAX22200_IIO_HHF_MASK 
MAX22200_IIO_OLF_MASK 
MAX22200_IIO_OCP_MASK 
MAX22200_IIO_OVT_MASK 

Function Documentation

◆ max22200_iio_init()

int max22200_iio_init ( struct max22200_iio_desc **  iio_desc,
struct max22200_iio_desc_init_param init_param 
)

Initializes the MAX22200 IIO descriptor.

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

◆ max22200_iio_remove()

int max22200_iio_remove ( struct max22200_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: