libiio: Channel

libiio 1.0 Library for interfacing with IIO devices

Loading...
Searching...
No Matches
Data Structures | Functions
Channel

## Data Structures
struct | iio_channel
| Represents an input or output channel of a device. More...

## Functions
__api __check_ret __pure const struct iio_device * | iio_channel_get_device (const struct iio_channel *chn)
| Retrieve a pointer to the iio_device structure.
__api __check_ret __pure const char * | iio_channel_get_id (const struct iio_channel *chn)
| Retrieve the channel ID (e.g. voltage0)
__api __check_ret __pure const char * | iio_channel_get_name (const struct iio_channel *chn)
| Retrieve the channel name (e.g. vccint)
__api __check_ret __pure const char * | iio_channel_get_label (const struct iio_channel *chn)
| Retrieve the channel label (e.g. anglY)
__api __check_ret __pure bool | iio_channel_is_output (const struct iio_channel *chn)
| Return True if the given channel is an output channel.
__api __check_ret __pure bool | iio_channel_is_scan_element (const struct iio_channel *chn)
| Return True if the given channel is a scan element.
__api __check_ret __pure unsigned int | iio_channel_get_attrs_count (const struct iio_channel *chn)
| Enumerate the channel-specific attributes of the given channel.
__api __check_ret __pure const struct iio_attr * | iio_channel_get_attr (const struct iio_channel *chn, unsigned int index)
| Get the channel-specific attribute present at the given index.
__api __check_ret __pure const struct iio_attr * | iio_channel_find_attr (const struct iio_channel *chn, const char *name)
| Try to find a channel-specific attribute by its name.
__api void | iio_channel_enable (const struct iio_channel *chn, struct iio_channels_mask *mask)
| Enable the given channel.
__api void | iio_channel_disable (const struct iio_channel *chn, struct iio_channels_mask *mask)
| Disable the given channel.
__api __check_ret bool | iio_channel_is_enabled (const struct iio_channel *chn, const struct iio_channels_mask *mask)
| Returns True if the channel is enabled.
__api __check_ret size_t | iio_channel_read (const struct iio_channel *chn, const struct iio_block *block, void *dst, size_t len, bool raw)
| Demultiplex and convert the samples of a given channel.
__api __check_ret size_t | iio_channel_write (const struct iio_channel *chn, struct iio_block *block, const void *src, size_t len, bool raw)
| Convert and multiplex the samples of a given channel.
__api void | iio_channel_set_data (struct iio_channel *chn, void *data)
| Associate a pointer to an iio_channel structure.
__api void * | iio_channel_get_data (const struct iio_channel *chn)
| Retrieve a previously associated pointer of an iio_channel structure.
__api __check_ret __pure enum iio_chan_type | iio_channel_get_type (const struct iio_channel *chn)
| Get the type of the given channel.
__api __check_ret __pure enum iio_modifier | iio_channel_get_modifier (const struct iio_channel *chn)
| Get the modifier type of the given channel.

## Detailed Description

## Function Documentation

## ◆ iio_channel_disable()

__api void iio_channel_disable | ( | const struct iio_channel * | chn,
|  | struct iio_channels_mask * | mask
| ) |  |

Disable the given channel.

Parameters

  chn | A pointer to an iio_channel structure
  mask | The channels mask to manipulate

## ◆ iio_channel_enable()

__api void iio_channel_enable | ( | const struct iio_channel * | chn,
|  | struct iio_channels_mask * | mask
| ) |  |

Enable the given channel.

Parameters

  chn | A pointer to an iio_channel structure
  mask | The channels mask to manipulate

## ◆ iio_channel_find_attr()

__api __check_ret __pure const struct iio_attr * iio_channel_find_attr | ( | const struct iio_channel * | chn,
|  | const char * | name
| ) |  |

Try to find a channel-specific attribute by its name.

Parameters

  chn | A pointer to an iio_channel structure
  name | A NULL-terminated string corresponding to the name of the attribute

Returns
  On success, a pointer to an iio_attr structure
  If the name does not correspond to any known attribute of the given channel, NULL is returned

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_get_attr()

__api __check_ret __pure const struct iio_attr * iio_channel_get_attr | ( | const struct iio_channel * | chn,
|  | unsigned int | index
| ) |  |

Get the channel-specific attribute present at the given index.

Parameters

  chn | A pointer to an iio_channel structure
  index | The index corresponding to the attribute

Returns
  On success, a pointer to an iio_attr structure
  If the index is invalid, NULL is returned

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_get_attrs_count()

__api __check_ret __pure unsigned int iio_channel_get_attrs_count | ( | const struct iio_channel * | chn | ) |

Enumerate the channel-specific attributes of the given channel.

Parameters

  chn | A pointer to an iio_channel structure

Returns
  The number of channel-specific attributes found

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_get_data()

__api void * iio_channel_get_data | ( | const struct iio_channel * | chn | ) |

Retrieve a previously associated pointer of an iio_channel structure.

Parameters

  chn | A pointer to an iio_channel structure

Returns
  The pointer previously associated if present, or NULL

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_get_device()

__api __check_ret __pure const struct iio_device * iio_channel_get_device | ( | const struct iio_channel * | chn | ) |

Retrieve a pointer to the iio_device structure.

Parameters

  chn | A pointer to an iio_channel structure

Returns
  A pointer to an iio_device structure

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_get_id()

__api __check_ret __pure const char * iio_channel_get_id | ( | const struct iio_channel * | chn | ) |

Retrieve the channel ID (e.g. voltage0)

Parameters

  chn | A pointer to an iio_channel structure

Returns
  A pointer to a static NULL-terminated string

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_get_label()

__api __check_ret __pure const char * iio_channel_get_label | ( | const struct iio_channel * | chn | ) |

Retrieve the channel label (e.g. anglY)

Parameters

  chn | A pointer to an iio_channel structure

Returns
  A pointer to a static NULL-terminated string

NOTE: if the channel has no label, NULL is returned.

## ◆ iio_channel_get_modifier()

__api __check_ret __pure enum iio_modifier iio_channel_get_modifier | ( | const struct iio_channel * | chn | ) |

Get the modifier type of the given channel.

Parameters

  chn | A pointer to an iio_channel structure

Returns
  The modifier type of the channel

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_get_name()

__api __check_ret __pure const char * iio_channel_get_name | ( | const struct iio_channel * | chn | ) |

Retrieve the channel name (e.g. vccint)

Parameters

  chn | A pointer to an iio_channel structure

Returns
  A pointer to a static NULL-terminated string

NOTE: if the channel has no name, NULL is returned.

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_get_type()

__api __check_ret __pure enum iio_chan_type iio_channel_get_type | ( | const struct iio_channel * | chn | ) |

Get the type of the given channel.

Parameters

  chn | A pointer to an iio_channel structure

Returns
  The type of the channel NOTE: Before calling this function, iio_device_is_hwmon() should be called to verify that the passed channel object does not belong to a HWMON device.

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_is_enabled()

__api __check_ret bool iio_channel_is_enabled | ( | const struct iio_channel * | chn,
|  | const struct iio_channels_mask * | mask
| ) |  |

Returns True if the channel is enabled.

Parameters

  chn | A pointer to an iio_channel structure
  mask | A pointer to an iio_channels_mask structure

Returns
  True if the channel is enabled, False otherwise

## ◆ iio_channel_is_output()

__api __check_ret __pure bool iio_channel_is_output | ( | const struct iio_channel * | chn | ) |

Return True if the given channel is an output channel.

Parameters

  chn | A pointer to an iio_channel structure

Returns
  True if the channel is an output channel, False otherwise

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_is_scan_element()

__api __check_ret __pure bool iio_channel_is_scan_element | ( | const struct iio_channel * | chn | ) |

Return True if the given channel is a scan element.

Parameters

  chn | A pointer to an iio_channel structure

Returns
  True if the channel is a scan element, False otherwise

NOTE: a channel that is a scan element is a channel that can generate samples (for an input channel) or receive samples (for an output channel) after being enabled.

Here is the call graph for this function:
Here is the caller graph for this function:

## ◆ iio_channel_read()

__api __check_ret size_t iio_channel_read | ( | const struct iio_channel * | chn,
|  | const struct iio_block * | block,
|  | void * | dst,
|  | size_t | len,
|  | bool | raw
| ) |  |

Demultiplex and convert the samples of a given channel.

Parameters

  chn | A pointer to an iio_channel structure
  block | A pointer to an iio_block structure
  dst | A pointer to the memory area where the converted data will be stored
  len | The available length of the memory area, in bytes
  raw | True to read samples in the hardware format, false to read converted samples.

Returns
  The size of the converted data, in bytes

Here is the call graph for this function:

## ◆ iio_channel_set_data()

__api void iio_channel_set_data | ( | struct iio_channel * | chn,
|  | void * | data
| ) |  |

Associate a pointer to an iio_channel structure.

Parameters

  chn | A pointer to an iio_channel structure
  data | The pointer to be associated

Here is the call graph for this function:

## ◆ iio_channel_write()

__api __check_ret size_t iio_channel_write | ( | const struct iio_channel * | chn,
|  | struct iio_block * | block,
|  | const void * | src,
|  | size_t | len,
|  | bool | raw
| ) |  |

Convert and multiplex the samples of a given channel.

Parameters

  chn | A pointer to an iio_channel structure
  block | A pointer to an iio_block structure
  src | A pointer to the memory area where the sequential data will be read from
  len | The length of the memory area, in bytes
  raw | True if the samples are already in hardware format, false if they need to be converted.

Returns
  The number of bytes actually converted and multiplexed

Here is the call graph for this function: