Commit | Line | Data |
---|---|---|
14555b14 | 1 | /* The industrial I/O core - generic buffer interfaces. |
7026ea4b JC |
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 | ||
3811cd62 JC |
10 | #ifndef _IIO_BUFFER_GENERIC_H_ |
11 | #define _IIO_BUFFER_GENERIC_H_ | |
26d25ae3 | 12 | #include <linux/sysfs.h> |
06458e27 | 13 | #include <linux/iio/iio.h> |
7026ea4b | 14 | |
f2a96245 | 15 | #ifdef CONFIG_IIO_BUFFER |
2662051e | 16 | |
14555b14 | 17 | struct iio_buffer; |
7026ea4b | 18 | |
7026ea4b | 19 | /** |
14555b14 | 20 | * struct iio_buffer_access_funcs - access functions for buffers. |
14555b14 | 21 | * @store_to: actually store stuff to the buffer |
8fe64955 | 22 | * @read_first_n: try to get a specified number of bytes (must exist) |
7026ea4b JC |
23 | * @request_update: if a parameter change has been marked, update underlying |
24 | * storage. | |
c3e5d410 JC |
25 | * @get_bytes_per_datum:get current bytes per datum |
26 | * @set_bytes_per_datum:set number of bytes per datum | |
14555b14 JC |
27 | * @get_length: get number of datums in buffer |
28 | * @set_length: set number of datums in buffer | |
7026ea4b | 29 | * |
14555b14 | 30 | * The purpose of this structure is to make the buffer element |
7026ea4b | 31 | * modular as event for a given driver, different usecases may require |
14555b14 | 32 | * different buffer designs (space efficiency vs speed for example). |
7026ea4b | 33 | * |
14555b14 JC |
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. | |
7026ea4b | 37 | **/ |
14555b14 | 38 | struct iio_buffer_access_funcs { |
ce56ade6 | 39 | int (*store_to)(struct iio_buffer *buffer, u8 *data); |
14555b14 | 40 | int (*read_first_n)(struct iio_buffer *buffer, |
b4281733 | 41 | size_t n, |
b26a2188 | 42 | char __user *buf); |
7026ea4b | 43 | |
14555b14 | 44 | int (*request_update)(struct iio_buffer *buffer); |
7026ea4b | 45 | |
14555b14 JC |
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); | |
7026ea4b JC |
50 | }; |
51 | ||
52 | /** | |
14555b14 | 53 | * struct iio_buffer - general buffer structure |
14555b14 | 54 | * @length: [DEVICE] number of datums in buffer |
c3e5d410 | 55 | * @bytes_per_datum: [DEVICE] size of individual datum including timestamp |
bf32963c MS |
56 | * @scan_el_attrs: [DRIVER] control of scan elements if that scan mode |
57 | * control method is used | |
bf32963c MS |
58 | * @scan_mask: [INTERN] bitmask used in masking scan mode elements |
59 | * @scan_timestamp: [INTERN] does the scan mode include a timestamp | |
14555b14 | 60 | * @access: [DRIVER] buffer access functions associated with the |
7026ea4b | 61 | * implementation. |
5f070a36 JC |
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. | |
5ada4ea9 JC |
67 | * @demux_list: [INTERN] list of operations required to demux the scan. |
68 | * @demux_bounce: [INTERN] buffer for doing gather from incoming scan. | |
84b36ce5 JC |
69 | * @buffer_list: [INTERN] entry in the devices list of current buffers. |
70 | */ | |
14555b14 | 71 | struct iio_buffer { |
8d213f24 JC |
72 | int length; |
73 | int bytes_per_datum; | |
8d213f24 | 74 | struct attribute_group *scan_el_attrs; |
32b5eeca | 75 | long *scan_mask; |
8d213f24 | 76 | bool scan_timestamp; |
14555b14 | 77 | const struct iio_buffer_access_funcs *access; |
8d213f24 | 78 | struct list_head scan_el_dev_attr_list; |
26d25ae3 | 79 | struct attribute_group scan_el_group; |
8d213f24 JC |
80 | wait_queue_head_t pollq; |
81 | bool stufftoread; | |
1aa04278 | 82 | const struct attribute_group *attrs; |
5ada4ea9 JC |
83 | struct list_head demux_list; |
84 | unsigned char *demux_bounce; | |
84b36ce5 | 85 | struct list_head buffer_list; |
7026ea4b | 86 | }; |
c3e5d410 | 87 | |
84b36ce5 JC |
88 | /** |
89 | * iio_update_buffers() - add or remove buffer from active list | |
90 | * @indio_dev: device to add buffer to | |
91 | * @insert_buffer: buffer to insert | |
92 | * @remove_buffer: buffer_to_remove | |
93 | * | |
94 | * Note this will tear down the all buffering and build it up again | |
95 | */ | |
96 | int iio_update_buffers(struct iio_dev *indio_dev, | |
97 | struct iio_buffer *insert_buffer, | |
98 | struct iio_buffer *remove_buffer); | |
99 | ||
c3e5d410 | 100 | /** |
14555b14 | 101 | * iio_buffer_init() - Initialize the buffer structure |
3bdff937 | 102 | * @buffer: buffer to be initialized |
c3e5d410 | 103 | **/ |
f79a9098 | 104 | void iio_buffer_init(struct iio_buffer *buffer); |
7026ea4b | 105 | |
f79a9098 JC |
106 | int iio_scan_mask_query(struct iio_dev *indio_dev, |
107 | struct iio_buffer *buffer, int bit); | |
bf32963c | 108 | |
c3e5d410 JC |
109 | /** |
110 | * iio_scan_mask_set() - set particular bit in the scan mask | |
3bdff937 PM |
111 | * @indio_dev IIO device structure |
112 | * @buffer: the buffer whose scan mask we are interested in | |
113 | * @bit: the bit to be set. | |
c3e5d410 | 114 | **/ |
f79a9098 JC |
115 | int iio_scan_mask_set(struct iio_dev *indio_dev, |
116 | struct iio_buffer *buffer, int bit); | |
bf32963c | 117 | |
5ada4ea9 | 118 | /** |
84b36ce5 JC |
119 | * iio_push_to_buffers() - push to a registered buffer. |
120 | * @indio_dev: iio_dev structure for device. | |
121 | * @data: Full scan. | |
5ada4ea9 | 122 | */ |
84b36ce5 | 123 | int iio_push_to_buffers(struct iio_dev *indio_dev, unsigned char *data); |
5ada4ea9 JC |
124 | |
125 | int iio_update_demux(struct iio_dev *indio_dev); | |
126 | ||
c3e5d410 | 127 | /** |
14555b14 | 128 | * iio_buffer_register() - register the buffer with IIO core |
3bdff937 PM |
129 | * @indio_dev: device with the buffer to be registered |
130 | * @channels: the channel descriptions used to construct buffer | |
131 | * @num_channels: the number of channels | |
1d892719 | 132 | **/ |
14555b14 JC |
133 | int iio_buffer_register(struct iio_dev *indio_dev, |
134 | const struct iio_chan_spec *channels, | |
135 | int num_channels); | |
1d892719 | 136 | |
c3e5d410 | 137 | /** |
14555b14 | 138 | * iio_buffer_unregister() - unregister the buffer from IIO core |
3bdff937 | 139 | * @indio_dev: the device with the buffer to be unregistered |
c3e5d410 | 140 | **/ |
14555b14 | 141 | void iio_buffer_unregister(struct iio_dev *indio_dev); |
7026ea4b | 142 | |
c3e5d410 | 143 | /** |
14555b14 | 144 | * iio_buffer_read_length() - attr func to get number of datums in the buffer |
c3e5d410 | 145 | **/ |
14555b14 JC |
146 | ssize_t iio_buffer_read_length(struct device *dev, |
147 | struct device_attribute *attr, | |
148 | char *buf); | |
c3e5d410 | 149 | /** |
14555b14 | 150 | * iio_buffer_write_length() - attr func to set number of datums in the buffer |
c3e5d410 | 151 | **/ |
14555b14 | 152 | ssize_t iio_buffer_write_length(struct device *dev, |
7026ea4b JC |
153 | struct device_attribute *attr, |
154 | const char *buf, | |
155 | size_t len); | |
c3e5d410 | 156 | /** |
14555b14 | 157 | * iio_buffer_store_enable() - attr to turn the buffer on |
c3e5d410 | 158 | **/ |
14555b14 JC |
159 | ssize_t iio_buffer_store_enable(struct device *dev, |
160 | struct device_attribute *attr, | |
161 | const char *buf, | |
162 | size_t len); | |
c3e5d410 | 163 | /** |
14555b14 | 164 | * iio_buffer_show_enable() - attr to see if the buffer is on |
c3e5d410 | 165 | **/ |
14555b14 JC |
166 | ssize_t iio_buffer_show_enable(struct device *dev, |
167 | struct device_attribute *attr, | |
168 | char *buf); | |
169 | #define IIO_BUFFER_LENGTH_ATTR DEVICE_ATTR(length, S_IRUGO | S_IWUSR, \ | |
170 | iio_buffer_read_length, \ | |
171 | iio_buffer_write_length) | |
14555b14 JC |
172 | |
173 | #define IIO_BUFFER_ENABLE_ATTR DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, \ | |
174 | iio_buffer_show_enable, \ | |
175 | iio_buffer_store_enable) | |
176 | ||
177 | int iio_sw_buffer_preenable(struct iio_dev *indio_dev); | |
5565a450 | 178 | |
81636632 LPC |
179 | bool iio_validate_scan_mask_onehot(struct iio_dev *indio_dev, |
180 | const unsigned long *mask); | |
181 | ||
f2a96245 | 182 | #else /* CONFIG_IIO_BUFFER */ |
1d892719 | 183 | |
14555b14 | 184 | static inline int iio_buffer_register(struct iio_dev *indio_dev, |
50d69b51 | 185 | const struct iio_chan_spec *channels, |
c009f7e4 | 186 | int num_channels) |
1d892719 JC |
187 | { |
188 | return 0; | |
189 | } | |
190 | ||
14555b14 | 191 | static inline void iio_buffer_unregister(struct iio_dev *indio_dev) |
19ea4752 | 192 | {} |
2662051e | 193 | |
f2a96245 | 194 | #endif /* CONFIG_IIO_BUFFER */ |
7026ea4b | 195 | |
3811cd62 | 196 | #endif /* _IIO_BUFFER_GENERIC_H_ */ |