colin/iio-sensor-proxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

iio: Better struct documentation for iio_channel_info

Browse Source
This commit is contained in:
Bastien Nocera
2019-05-13 11:29:44 +02:00
committed by hadess
parent 51524ec8b4
commit 55cf113780
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/iio-buffer-utils.c
View File

@@ -22,13 +22,18 @@
/**
* iio_channel_info - information about a given channel
* @name: channel name
* @scale: scale factor to be applied for conversion to si units
* @offset: offset to be applied for conversion to si units
* @generic_name: the generic name of the channel
* @scale: scale factor to be applied for conversion to SI units
* @offset: offset to be applied for conversion to SI units
* @index: the channel index in the buffer output
* @bytes: number of bytes occupied in buffer output
* @is_signed: signed or unsigned
* @bits_used: number of valid bits of data
* @bytes: number of bytes occupied in buffer output (bits_used + padding)
* @shift: shift right by this before masking out bits_used
* @mask: a bit mask for the raw output
* @is_signed: is the raw value stored signed
* @be: little or big endian
* @enabled: is this channel enabled
* @location: data offset for this channel inside the buffer (in bytes)
**/
struct iio_channel_info {
char *name;
@@ -36,12 +41,12 @@ struct iio_channel_info {
float scale;
float offset;
unsigned index;
unsigned bytes;
unsigned is_signed;
unsigned bits_used;
unsigned bytes;
unsigned shift;
guint64 mask;
unsigned be;
unsigned is_signed;
unsigned enabled;
unsigned location;
};