hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

iio:buffer.h Reformat structure comments to be inline. 

This should make it easier to see how the structure is split into
public and private parts - reflected in the generated documentation.

Deliberately use /* instead of /** for the private elements to avoid
warnings when kernel-doc script runs.

Signed-off-by: Jonathan Cameron <jic23@kernel.org>
Reviewed-by: Lars-Peter Clausen <lars@metafoo.de>
This commit is contained in:
Jonathan Cameron 2017-01-02 19:28:25 +00:00
parent 78c9981f61
commit 263cf5e657
1 changed files with 63 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
include/linux/iio/buffer.h
View File

@ -74,45 +74,71 @@ struct iio_buffer_access_funcs {
/** /**
* struct iio_buffer - general buffer structure * struct iio_buffer - general buffer structure
* @length: [DEVICE] number of datums in buffer *
* @bytes_per_datum: [DEVICE] size of individual datum including timestamp * Note that the internals of this structure should only be of interest to
* @scan_el_attrs: [DRIVER] control of scan elements if that scan mode * those writing new buffer implementations.
* control method is used
* @scan_mask: [INTERN] bitmask used in masking scan mode elements
* @scan_timestamp: [INTERN] does the scan mode include a timestamp
* @access: [DRIVER] buffer access functions associated with the
* implementation.
* @scan_el_dev_attr_list:[INTERN] list of scan element related attributes.
* @buffer_group: [INTERN] attributes of the buffer group
* @scan_el_group: [DRIVER] attribute group for those attributes not
* created from the iio_chan_info array.
* @pollq: [INTERN] wait queue to allow for polling on the buffer.
* @stufftoread: [INTERN] flag to indicate new data.
* @attrs: [INTERN] standard attributes of the buffer
* @demux_list: [INTERN] list of operations required to demux the scan.
* @demux_bounce: [INTERN] buffer for doing gather from incoming scan.
* @buffer_list: [INTERN] entry in the devices list of current buffers.
* @ref: [INTERN] reference count of the buffer.
* @watermark: [INTERN] number of datums to wait for poll/read.
*/ */
struct iio_buffer { struct iio_buffer {
/** @length: Number of datums in buffer. */
int length; int length;
/** @bytes_per_datum: Size of individual datum including timestamp. */
int bytes_per_datum; int bytes_per_datum;
struct attribute_group *scan_el_attrs;
long *scan_mask; /**
bool scan_timestamp; * @access: Buffer access functions associated with the
* implementation.
*/
const struct iio_buffer_access_funcs *access; const struct iio_buffer_access_funcs *access;
struct list_head scan_el_dev_attr_list;
struct attribute_group buffer_group; /** @scan_mask: Bitmask used in masking scan mode elements. */
struct attribute_group scan_el_group; long *scan_mask;
wait_queue_head_t pollq;
bool stufftoread; /** @demux_list: List of operations required to demux the scan. */
const struct attribute **attrs;
struct list_head demux_list; struct list_head demux_list;
void *demux_bounce;
struct list_head buffer_list; /** @pollq: Wait queue to allow for polling on the buffer. */
struct kref ref; wait_queue_head_t pollq;
/** @watermark: Number of datums to wait for poll/read. */
unsigned int watermark; unsigned int watermark;
/* private: */
/*
* @scan_el_attrs: Control of scan elements if that scan mode
* control method is used.
*/
struct attribute_group *scan_el_attrs;
/* @scan_timestamp: Does the scan mode include a timestamp. */
bool scan_timestamp;
/* @scan_el_dev_attr_list: List of scan element related attributes. */
struct list_head scan_el_dev_attr_list;
/* @buffer_group: Attributes of the buffer group. */
struct attribute_group buffer_group;
/*
* @scan_el_group: Attribute group for those attributes not
* created from the iio_chan_info array.
*/
struct attribute_group scan_el_group;
/* @stufftoread: Flag to indicate new data. */
bool stufftoread;
/* @attrs: Standard attributes of the buffer. */
const struct attribute **attrs;
/* @demux_bounce: Buffer for doing gather from incoming scan. */
void *demux_bounce;
/* @buffer_list: Entry in the devices list of current buffers. */
struct list_head buffer_list;
/* @ref: Reference count of the buffer. */
struct kref ref;
}; };
/** /**