linux/iio/consumer.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
19  * struct iio_channel - everything needed for a consumer to use a channel
20  * @indio_dev:		Device on which the channel exists.
21  * @channel:		Full description of the channel.
22  * @data:		Data about the channel used by consumer.
26 	const struct iio_chan_spec *channel;  member
31  * iio_channel_get() - get description of all that is needed to access channel.
36  * @consumer_channel:	Unique name to identify the channel on the consumer
37  *			side. This typically describes the channels use within
44  * iio_channel_release() - release channels obtained via iio_channel_get
45  * @chan:		The channel to be released.
50  * devm_iio_channel_get() - Resource managed version of iio_channel_get().
55  * @consumer_channel:	Unique name to identify the channel on the consumer
56  *			side. This typically describes the channels use within
59  * Returns a pointer to negative errno if it is not able to get the iio channel
60  * otherwise returns valid pointer for iio channel.
62  * The allocated iio channel is automatically released when the device is
68  * iio_channel_get_all() - get all channels associated with a client
79  * iio_channel_release_all() - reverse iio_channel_get_all
85  * devm_iio_channel_get_all() - Resource managed version of
89  * Returns a pointer to negative errno if it is not able to get the iio channel
102  * fwnode_iio_channel_get_by_name() - get description of all that is needed to access channel.
104  * @consumer_channel:	Unique name to identify the channel on the consumer
105  *			side. This typically describes the channels use within
112  * devm_fwnode_iio_channel_get_by_name() - Resource managed version of
116  * @consumer_channel:	Unique name to identify the channel on the consumer
117  *			side. This typically describes the channels use within
120  * Returns a pointer to negative errno if it is not able to get the iio channel
121  * otherwise returns valid pointer for iio channel.
123  * The allocated iio channel is automatically released when the device is
132  * iio_channel_get_all_cb() - register callback for triggered capture
146  * iio_channel_cb_set_buffer_watermark() - set the buffer watermark.
147  * @cb_buffer:		The callback buffer from whom we want the channel
157  * iio_channel_release_all_cb() - release and unregister the callback.
163  * iio_channel_start_all_cb() - start the flow of data through callback.
169  * iio_channel_stop_all_cb() - stop the flow of data through the callback.
175  * iio_channel_cb_get_channels() - get access to the underlying channels.
176  * @cb_buffer:		The callback buffer from whom we want the channel
181  * primary aim is to allow drivers that are consuming a channel to query
182  * things like scaling of the channel.
188  * iio_channel_cb_get_iio_dev() - get access to the underlying device.
200  * iio_read_channel_raw() - read from a given channel
201  * @chan:		The channel being queried.
212  * iio_read_channel_average_raw() - read from a given channel
213  * @chan:		The channel being queried.
226  * iio_read_channel_processed() - read processed value from a given channel
227  * @chan:		The channel being queried.
232  * This function will read a processed value from a channel. A processed value
241  * iio_read_channel_processed_scale() - read and scale a processed value
242  * @chan:		The channel being queried.
248  * This function will read a processed value from a channel. This will work
256  * iio_write_channel_attribute() - Write values to the device attribute.
257  * @chan:	The channel being queried.
259  * @val2:	Value being written.val2 use depends on attribute type.
268  * iio_read_channel_attribute() - Read values from the device attribute.
269  * @chan:	The channel being queried.
271  * @val2:	Value being written.Val2 use depends on attribute type.
282  * iio_write_channel_raw() - write to a given channel
283  * @chan:		The channel being queried.
288  * as (value / scale) - offset.
293  * iio_read_max_channel_raw() - read maximum available raw value from a given
294  *				channel, i.e. the maximum possible value.
295  * @chan:		The channel being queried.
305  * iio_read_min_channel_raw() - read minimum available raw value from a given
306  *				channel, i.e. the minimum possible value.
307  * @chan:		The channel being queried.
317  * iio_read_avail_channel_raw() - read available raw values from a given channel
318  * @chan:		The channel being queried.
335  * iio_read_avail_channel_attribute() - read available channel attribute values
336  * @chan:		The channel being queried.
349  * iio_get_channel_type() - get the type of a channel
350  * @channel:		The channel being queried.
351  * @type:		The type of the channel.
353  * returns the enum iio_chan_type of the channel
355 int iio_get_channel_type(struct iio_channel *channel,
359  * iio_read_channel_offset() - read the offset value for a channel
360  * @chan:		The channel being queried.
372  * iio_read_channel_scale() - read the scale value for a channel
373  * @chan:		The channel being queried.
385  * iio_convert_raw_to_processed() - Converts a raw value to a processed value
386  * @chan:		The channel being queried
393  * This function converts a raw value to processed value for a specific channel.
401  * unit for the channel type. E.g. millivolt for voltage channels, if you want
408  * iio_get_channel_ext_info_count() - get number of ext_info attributes
409  *				      connected to the channel.
410  * @chan:		The channel being queried
417  * iio_read_channel_ext_info() - read ext_info attribute from a given channel
418  * @chan:		The channel being queried.
430  * iio_write_channel_ext_info() - write ext_info attribute from a given channel
431  * @chan:		The channel being queried.
433  * @buf:		The new attribute value. Strings needs to be zero-
445  * iio_read_channel_label() - read label for a given channel
446  * @chan:		The channel being queried.