drivers/staging/iio/buffer.h

   1 /* The industrial I/O core - generic buffer interfaces.
   2  *
   3  * Copyright (c) 2008 Jonathan Cameron
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published by
   7  * the Free Software Foundation.
   8  */
   9
  10 #ifndef _IIO_BUFFER_GENERIC_H_
  11 #define _IIO_BUFFER_GENERIC_H_
  12 #include <linux/sysfs.h>
  13 #include "iio.h"
  14
  15 #ifdef CONFIG_IIO_BUFFER
  16
  17 struct iio_buffer;
  18
  19 /**
  20  * struct iio_buffer_access_funcs - access functions for buffers.
  21  * @mark_in_use:        reference counting, typically to prevent module removal
  22  * @unmark_in_use:      reduce reference count when no longer using buffer
  23  * @store_to:           actually store stuff to the buffer
  24  * @read_first_n:       try to get a specified number of bytes (must exist)
  25  * @mark_param_change:  notify buffer that some relevant parameter has changed
  26  *                      Often this means the underlying storage may need to
  27  *                      change.
  28  * @request_update:     if a parameter change has been marked, update underlying
  29  *                      storage.
  30  * @get_bytes_per_datum:get current bytes per datum
  31  * @set_bytes_per_datum:set number of bytes per datum
  32  * @get_length:         get number of datums in buffer
  33  * @set_length:         set number of datums in buffer
  34  * @is_enabled:         query if buffer is currently being used
  35  * @enable:             enable the buffer
  36  *
  37  * The purpose of this structure is to make the buffer element
  38  * modular as event for a given driver, different usecases may require
  39  * different buffer designs (space efficiency vs speed for example).
  40  *
  41  * It is worth noting that a given buffer implementation may only support a
  42  * small proportion of these functions.  The core code 'should' cope fine with
  43  * any of them not existing.
  44  **/
  45 struct iio_buffer_access_funcs {
  46         void (*mark_in_use)(struct iio_buffer *buffer);
  47         void (*unmark_in_use)(struct iio_buffer *buffer);
  48
  49         int (*store_to)(struct iio_buffer *buffer, u8 *data, s64 timestamp);
  50         int (*read_first_n)(struct iio_buffer *buffer,
  51                             size_t n,
  52                             char __user *buf);
  53
  54         int (*mark_param_change)(struct iio_buffer *buffer);
  55         int (*request_update)(struct iio_buffer *buffer);
  56
  57         int (*get_bytes_per_datum)(struct iio_buffer *buffer);
  58         int (*set_bytes_per_datum)(struct iio_buffer *buffer, size_t bpd);
  59         int (*get_length)(struct iio_buffer *buffer);
  60         int (*set_length)(struct iio_buffer *buffer, int length);
  61
  62         int (*is_enabled)(struct iio_buffer *buffer);
  63         int (*enable)(struct iio_buffer *buffer);
  64 };
  65
  66 /**
  67  * struct iio_buffer - general buffer structure
  68  * @length:             [DEVICE] number of datums in buffer
  69  * @bytes_per_datum:    [DEVICE] size of individual datum including timestamp
  70  * @scan_el_attrs:      [DRIVER] control of scan elements if that scan mode
  71  *                      control method is used
  72  * @scan_mask:          [INTERN] bitmask used in masking scan mode elements
  73  * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
  74  * @scan_timestamp:     [INTERN] does the scan mode include a timestamp
  75  * @access:             [DRIVER] buffer access functions associated with the
  76  *                      implementation.
  77  * @scan_el_dev_attr_list:[INTERN] list of scan element related attributes.
  78  * @scan_el_group:      [DRIVER] attribute group for those attributes not
  79  *                      created from the iio_chan_info array.
  80  * @pollq:              [INTERN] wait queue to allow for polling on the buffer.
  81  * @stufftoread:        [INTERN] flag to indicate new data.
  82  * @demux_list:         [INTERN] list of operations required to demux the scan.
  83  * @demux_bounce:       [INTERN] buffer for doing gather from incoming scan.
  84  **/
  85 struct iio_buffer {
  86         int                                     length;
  87         int                                     bytes_per_datum;
  88         struct attribute_group                  *scan_el_attrs;
  89         long                                    *scan_mask;
  90         bool                                    scan_timestamp;
  91         unsigned                                scan_index_timestamp;
  92         const struct iio_buffer_access_funcs    *access;
  93         struct list_head                        scan_el_dev_attr_list;
  94         struct attribute_group                  scan_el_group;
  95         wait_queue_head_t                       pollq;
  96         bool                                    stufftoread;
  97         const struct attribute_group *attrs;
  98         struct list_head                        demux_list;
  99         unsigned char                           *demux_bounce;
 100 };
 101
 102 /**
 103  * iio_buffer_init() - Initialize the buffer structure
 104  * @buffer: buffer to be initialized
 105  **/
 106 void iio_buffer_init(struct iio_buffer *buffer);
 107
 108 void iio_buffer_deinit(struct iio_buffer *buffer);
 109
 110 /**
 111  * __iio_update_buffer() - update common elements of buffers
 112  * @buffer:             buffer that is the event source
 113  * @bytes_per_datum:    size of individual datum including timestamp
 114  * @length:             number of datums in buffer
 115  **/
 116 static inline void __iio_update_buffer(struct iio_buffer *buffer,
 117                                        int bytes_per_datum, int length)
 118 {
 119         buffer->bytes_per_datum = bytes_per_datum;
 120         buffer->length = length;
 121 }
 122
 123 int iio_scan_mask_query(struct iio_dev *indio_dev,
 124                         struct iio_buffer *buffer, int bit);
 125
 126 /**
 127  * iio_scan_mask_set() - set particular bit in the scan mask
 128  * @buffer: the buffer whose scan mask we are interested in
 129  * @bit: the bit to be set.
 130  **/
 131 int iio_scan_mask_set(struct iio_dev *indio_dev,
 132                       struct iio_buffer *buffer, int bit);
 133
 134 /**
 135  * iio_push_to_buffer() - push to a registered buffer.
 136  * @buffer:             IIO buffer structure for device
 137  * @scan:               Full scan.
 138  * @timestamp:
 139  */
 140 int iio_push_to_buffer(struct iio_buffer *buffer, unsigned char *data,
 141                        s64 timestamp);
 142
 143 int iio_update_demux(struct iio_dev *indio_dev);
 144
 145 /**
 146  * iio_buffer_register() - register the buffer with IIO core
 147  * @indio_dev: device with the buffer to be registered
 148  **/
 149 int iio_buffer_register(struct iio_dev *indio_dev,
 150                         const struct iio_chan_spec *channels,
 151                         int num_channels);
 152
 153 /**
 154  * iio_buffer_unregister() - unregister the buffer from IIO core
 155  * @indio_dev: the device with the buffer to be unregistered
 156  **/
 157 void iio_buffer_unregister(struct iio_dev *indio_dev);
 158
 159 /**
 160  * iio_buffer_read_length() - attr func to get number of datums in the buffer
 161  **/
 162 ssize_t iio_buffer_read_length(struct device *dev,
 163                                struct device_attribute *attr,
 164                                char *buf);
 165 /**
 166  * iio_buffer_write_length() - attr func to set number of datums in the buffer
 167  **/
 168 ssize_t iio_buffer_write_length(struct device *dev,
 169                               struct device_attribute *attr,
 170                               const char *buf,
 171                               size_t len);
 172 /**
 173  * iio_buffer_store_enable() - attr to turn the buffer on
 174  **/
 175 ssize_t iio_buffer_store_enable(struct device *dev,
 176                                 struct device_attribute *attr,
 177                                 const char *buf,
 178                                 size_t len);
 179 /**
 180  * iio_buffer_show_enable() - attr to see if the buffer is on
 181  **/
 182 ssize_t iio_buffer_show_enable(struct device *dev,
 183                                struct device_attribute *attr,
 184                                char *buf);
 185 #define IIO_BUFFER_LENGTH_ATTR DEVICE_ATTR(length, S_IRUGO | S_IWUSR,   \
 186                                            iio_buffer_read_length,      \
 187                                            iio_buffer_write_length)
 188
 189 #define IIO_BUFFER_ENABLE_ATTR DEVICE_ATTR(enable, S_IRUGO | S_IWUSR,   \
 190                                            iio_buffer_show_enable,      \
 191                                            iio_buffer_store_enable)
 192
 193 int iio_sw_buffer_preenable(struct iio_dev *indio_dev);
 194
 195 #else /* CONFIG_IIO_BUFFER */
 196
 197 static inline int iio_buffer_register(struct iio_dev *indio_dev,
 198                                            struct iio_chan_spec *channels,
 199                                            int num_channels)
 200 {
 201         return 0;
 202 }
 203
 204 static inline void iio_buffer_unregister(struct iio_dev *indio_dev)
 205 {};
 206
 207 #endif /* CONFIG_IIO_BUFFER */
 208
 209 #endif /* _IIO_BUFFER_GENERIC_H_ */