Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 1 | /* The industrial I/O core - generic buffer interfaces. |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 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 | |
Jonathan Cameron | 3811cd6 | 2011-09-21 11:15:56 +0100 | [diff] [blame] | 10 | #ifndef _IIO_BUFFER_GENERIC_H_ |
| 11 | #define _IIO_BUFFER_GENERIC_H_ |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 12 | #include <linux/sysfs.h> |
Jonathan Cameron | 06458e2 | 2012-04-25 15:54:58 +0100 | [diff] [blame] | 13 | #include <linux/iio/iio.h> |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 14 | |
Jonathan Cameron | f2a9624 | 2011-09-21 11:15:55 +0100 | [diff] [blame] | 15 | #ifdef CONFIG_IIO_BUFFER |
Jonathan Cameron | 2662051 | 2010-07-11 16:39:14 +0100 | [diff] [blame] | 16 | |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 17 | struct iio_buffer; |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 18 | |
| 19 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 20 | * struct iio_buffer_access_funcs - access functions for buffers. |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 21 | * @store_to: actually store stuff to the buffer |
Lars-Peter Clausen | 8fe6495 | 2011-12-12 09:33:14 +0100 | [diff] [blame] | 22 | * @read_first_n: try to get a specified number of bytes (must exist) |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 23 | * @request_update: if a parameter change has been marked, update underlying |
| 24 | * storage. |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 25 | * @get_bytes_per_datum:get current bytes per datum |
| 26 | * @set_bytes_per_datum:set number of bytes per datum |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 27 | * @get_length: get number of datums in buffer |
| 28 | * @set_length: set number of datums in buffer |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 29 | * |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 30 | * The purpose of this structure is to make the buffer element |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 31 | * modular as event for a given driver, different usecases may require |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 32 | * different buffer designs (space efficiency vs speed for example). |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 33 | * |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 34 | * It is worth noting that a given buffer implementation may only support a |
| 35 | * small proportion of these functions. The core code 'should' cope fine with |
| 36 | * any of them not existing. |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 37 | **/ |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 38 | struct iio_buffer_access_funcs { |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 39 | int (*store_to)(struct iio_buffer *buffer, u8 *data, s64 timestamp); |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 40 | int (*read_first_n)(struct iio_buffer *buffer, |
Jonathan Cameron | b428173 | 2011-04-15 18:55:55 +0100 | [diff] [blame] | 41 | size_t n, |
Jonathan Cameron | b26a218 | 2011-05-18 14:41:02 +0100 | [diff] [blame] | 42 | char __user *buf); |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 43 | |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 44 | int (*request_update)(struct iio_buffer *buffer); |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 45 | |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 46 | int (*get_bytes_per_datum)(struct iio_buffer *buffer); |
| 47 | int (*set_bytes_per_datum)(struct iio_buffer *buffer, size_t bpd); |
| 48 | int (*get_length)(struct iio_buffer *buffer); |
| 49 | int (*set_length)(struct iio_buffer *buffer, int length); |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 50 | }; |
| 51 | |
Jonathan Cameron | 6446e9c | 2011-08-30 12:41:13 +0100 | [diff] [blame] | 52 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 53 | * struct iio_buffer - general buffer structure |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 54 | * @length: [DEVICE] number of datums in buffer |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 55 | * @bytes_per_datum: [DEVICE] size of individual datum including timestamp |
Manuel Stahl | bf32963 | 2010-08-31 11:32:52 +0200 | [diff] [blame] | 56 | * @scan_el_attrs: [DRIVER] control of scan elements if that scan mode |
| 57 | * control method is used |
Manuel Stahl | bf32963 | 2010-08-31 11:32:52 +0200 | [diff] [blame] | 58 | * @scan_mask: [INTERN] bitmask used in masking scan mode elements |
| 59 | * @scan_timestamp: [INTERN] does the scan mode include a timestamp |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 60 | * @access: [DRIVER] buffer access functions associated with the |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 61 | * implementation. |
Jonathan Cameron | 5f070a3 | 2011-12-05 22:18:30 +0000 | [diff] [blame] | 62 | * @scan_el_dev_attr_list:[INTERN] list of scan element related attributes. |
| 63 | * @scan_el_group: [DRIVER] attribute group for those attributes not |
| 64 | * created from the iio_chan_info array. |
| 65 | * @pollq: [INTERN] wait queue to allow for polling on the buffer. |
| 66 | * @stufftoread: [INTERN] flag to indicate new data. |
Jonathan Cameron | 5ada4ea | 2011-12-05 21:37:14 +0000 | [diff] [blame] | 67 | * @demux_list: [INTERN] list of operations required to demux the scan. |
| 68 | * @demux_bounce: [INTERN] buffer for doing gather from incoming scan. |
Jonathan Cameron | 8d213f2 | 2011-05-18 14:42:34 +0100 | [diff] [blame] | 69 | **/ |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 70 | struct iio_buffer { |
Jonathan Cameron | 8d213f2 | 2011-05-18 14:42:34 +0100 | [diff] [blame] | 71 | int length; |
| 72 | int bytes_per_datum; |
Jonathan Cameron | 8d213f2 | 2011-05-18 14:42:34 +0100 | [diff] [blame] | 73 | struct attribute_group *scan_el_attrs; |
Jonathan Cameron | 32b5eec | 2011-09-02 17:14:38 +0100 | [diff] [blame] | 74 | long *scan_mask; |
Jonathan Cameron | 8d213f2 | 2011-05-18 14:42:34 +0100 | [diff] [blame] | 75 | bool scan_timestamp; |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 76 | const struct iio_buffer_access_funcs *access; |
Jonathan Cameron | 8d213f2 | 2011-05-18 14:42:34 +0100 | [diff] [blame] | 77 | struct list_head scan_el_dev_attr_list; |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 78 | struct attribute_group scan_el_group; |
Jonathan Cameron | 8d213f2 | 2011-05-18 14:42:34 +0100 | [diff] [blame] | 79 | wait_queue_head_t pollq; |
| 80 | bool stufftoread; |
Jonathan Cameron | 1aa0427 | 2011-08-30 12:32:47 +0100 | [diff] [blame] | 81 | const struct attribute_group *attrs; |
Jonathan Cameron | 5ada4ea | 2011-12-05 21:37:14 +0000 | [diff] [blame] | 82 | struct list_head demux_list; |
| 83 | unsigned char *demux_bounce; |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 84 | }; |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 85 | |
| 86 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 87 | * iio_buffer_init() - Initialize the buffer structure |
Peter Meerwald | 3bdff93 | 2012-07-01 00:47:43 +0200 | [diff] [blame] | 88 | * @buffer: buffer to be initialized |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 89 | **/ |
Jonathan Cameron | f79a909 | 2011-12-05 22:18:29 +0000 | [diff] [blame] | 90 | void iio_buffer_init(struct iio_buffer *buffer); |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 91 | |
| 92 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 93 | * __iio_update_buffer() - update common elements of buffers |
| 94 | * @buffer: buffer that is the event source |
Randy Dunlap | 4c57260 | 2009-10-04 19:34:02 -0700 | [diff] [blame] | 95 | * @bytes_per_datum: size of individual datum including timestamp |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 96 | * @length: number of datums in buffer |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 97 | **/ |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 98 | static inline void __iio_update_buffer(struct iio_buffer *buffer, |
| 99 | int bytes_per_datum, int length) |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 100 | { |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 101 | buffer->bytes_per_datum = bytes_per_datum; |
| 102 | buffer->length = length; |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 103 | } |
| 104 | |
Jonathan Cameron | f79a909 | 2011-12-05 22:18:29 +0000 | [diff] [blame] | 105 | int iio_scan_mask_query(struct iio_dev *indio_dev, |
| 106 | struct iio_buffer *buffer, int bit); |
Manuel Stahl | bf32963 | 2010-08-31 11:32:52 +0200 | [diff] [blame] | 107 | |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 108 | /** |
| 109 | * iio_scan_mask_set() - set particular bit in the scan mask |
Peter Meerwald | 3bdff93 | 2012-07-01 00:47:43 +0200 | [diff] [blame] | 110 | * @indio_dev IIO device structure |
| 111 | * @buffer: the buffer whose scan mask we are interested in |
| 112 | * @bit: the bit to be set. |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 113 | **/ |
Jonathan Cameron | f79a909 | 2011-12-05 22:18:29 +0000 | [diff] [blame] | 114 | int iio_scan_mask_set(struct iio_dev *indio_dev, |
| 115 | struct iio_buffer *buffer, int bit); |
Manuel Stahl | bf32963 | 2010-08-31 11:32:52 +0200 | [diff] [blame] | 116 | |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 117 | /** |
Jonathan Cameron | 5ada4ea | 2011-12-05 21:37:14 +0000 | [diff] [blame] | 118 | * iio_push_to_buffer() - push to a registered buffer. |
| 119 | * @buffer: IIO buffer structure for device |
Peter Meerwald | 3bdff93 | 2012-07-01 00:47:43 +0200 | [diff] [blame] | 120 | * @data: the data to push to the buffer |
| 121 | * @timestamp: timestamp to associate with the data |
Jonathan Cameron | 5ada4ea | 2011-12-05 21:37:14 +0000 | [diff] [blame] | 122 | */ |
| 123 | int iio_push_to_buffer(struct iio_buffer *buffer, unsigned char *data, |
| 124 | s64 timestamp); |
| 125 | |
| 126 | int iio_update_demux(struct iio_dev *indio_dev); |
| 127 | |
| 128 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 129 | * iio_buffer_register() - register the buffer with IIO core |
Peter Meerwald | 3bdff93 | 2012-07-01 00:47:43 +0200 | [diff] [blame] | 130 | * @indio_dev: device with the buffer to be registered |
| 131 | * @channels: the channel descriptions used to construct buffer |
| 132 | * @num_channels: the number of channels |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 133 | **/ |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 134 | int iio_buffer_register(struct iio_dev *indio_dev, |
| 135 | const struct iio_chan_spec *channels, |
| 136 | int num_channels); |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 137 | |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 138 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 139 | * iio_buffer_unregister() - unregister the buffer from IIO core |
Peter Meerwald | 3bdff93 | 2012-07-01 00:47:43 +0200 | [diff] [blame] | 140 | * @indio_dev: the device with the buffer to be unregistered |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 141 | **/ |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 142 | void iio_buffer_unregister(struct iio_dev *indio_dev); |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 143 | |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 144 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 145 | * iio_buffer_read_length() - attr func to get number of datums in the buffer |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 146 | **/ |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 147 | ssize_t iio_buffer_read_length(struct device *dev, |
| 148 | struct device_attribute *attr, |
| 149 | char *buf); |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 150 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 151 | * iio_buffer_write_length() - attr func to set number of datums in the buffer |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 152 | **/ |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 153 | ssize_t iio_buffer_write_length(struct device *dev, |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 154 | struct device_attribute *attr, |
| 155 | const char *buf, |
| 156 | size_t len); |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 157 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 158 | * iio_buffer_store_enable() - attr to turn the buffer on |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 159 | **/ |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 160 | ssize_t iio_buffer_store_enable(struct device *dev, |
| 161 | struct device_attribute *attr, |
| 162 | const char *buf, |
| 163 | size_t len); |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 164 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 165 | * iio_buffer_show_enable() - attr to see if the buffer is on |
Jonathan Cameron | c3e5d41 | 2010-09-04 17:54:45 +0100 | [diff] [blame] | 166 | **/ |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 167 | ssize_t iio_buffer_show_enable(struct device *dev, |
| 168 | struct device_attribute *attr, |
| 169 | char *buf); |
| 170 | #define IIO_BUFFER_LENGTH_ATTR DEVICE_ATTR(length, S_IRUGO | S_IWUSR, \ |
| 171 | iio_buffer_read_length, \ |
| 172 | iio_buffer_write_length) |
Jonathan Cameron | 5565a45 | 2011-05-18 14:42:24 +0100 | [diff] [blame] | 173 | |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 174 | #define IIO_BUFFER_ENABLE_ATTR DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, \ |
| 175 | iio_buffer_show_enable, \ |
| 176 | iio_buffer_store_enable) |
| 177 | |
| 178 | int iio_sw_buffer_preenable(struct iio_dev *indio_dev); |
Jonathan Cameron | 5565a45 | 2011-05-18 14:42:24 +0100 | [diff] [blame] | 179 | |
Lars-Peter Clausen | 8163663 | 2012-07-09 10:00:00 +0100 | [diff] [blame^] | 180 | bool iio_validate_scan_mask_onehot(struct iio_dev *indio_dev, |
| 181 | const unsigned long *mask); |
| 182 | |
Jonathan Cameron | f2a9624 | 2011-09-21 11:15:55 +0100 | [diff] [blame] | 183 | #else /* CONFIG_IIO_BUFFER */ |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 184 | |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 185 | static inline int iio_buffer_register(struct iio_dev *indio_dev, |
Jonathan Cameron | c009f7e | 2011-08-30 12:41:14 +0100 | [diff] [blame] | 186 | struct iio_chan_spec *channels, |
| 187 | int num_channels) |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 188 | { |
| 189 | return 0; |
| 190 | } |
| 191 | |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 192 | static inline void iio_buffer_unregister(struct iio_dev *indio_dev) |
Peter Meerwald | 19ea4752 | 2012-06-18 20:33:03 +0200 | [diff] [blame] | 193 | {} |
Jonathan Cameron | 2662051 | 2010-07-11 16:39:14 +0100 | [diff] [blame] | 194 | |
Jonathan Cameron | f2a9624 | 2011-09-21 11:15:55 +0100 | [diff] [blame] | 195 | #endif /* CONFIG_IIO_BUFFER */ |
Jonathan Cameron | 7026ea4 | 2009-08-18 18:06:24 +0100 | [diff] [blame] | 196 | |
Jonathan Cameron | 3811cd6 | 2011-09-21 11:15:56 +0100 | [diff] [blame] | 197 | #endif /* _IIO_BUFFER_GENERIC_H_ */ |