]>
Commit | Line | Data |
---|---|---|
7d438178 | 1 | |
847ec80b JC |
2 | /* The industrial I/O core |
3 | * | |
4 | * Copyright (c) 2008 Jonathan Cameron | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify it | |
7 | * under the terms of the GNU General Public License version 2 as published by | |
8 | * the Free Software Foundation. | |
9 | */ | |
847ec80b JC |
10 | #ifndef _INDUSTRIAL_IO_H_ |
11 | #define _INDUSTRIAL_IO_H_ | |
12 | ||
13 | #include <linux/device.h> | |
14 | #include <linux/cdev.h> | |
06458e27 | 15 | #include <linux/iio/types.h> |
acd82567 | 16 | #include <linux/of.h> |
847ec80b | 17 | /* IIO TODO LIST */ |
751a3700 | 18 | /* |
847ec80b JC |
19 | * Provide means of adjusting timer accuracy. |
20 | * Currently assumes nano seconds. | |
21 | */ | |
22 | ||
1d892719 | 23 | enum iio_chan_info_enum { |
5ccb3adb JC |
24 | IIO_CHAN_INFO_RAW = 0, |
25 | IIO_CHAN_INFO_PROCESSED, | |
26 | IIO_CHAN_INFO_SCALE, | |
c8a9f805 JC |
27 | IIO_CHAN_INFO_OFFSET, |
28 | IIO_CHAN_INFO_CALIBSCALE, | |
29 | IIO_CHAN_INFO_CALIBBIAS, | |
30 | IIO_CHAN_INFO_PEAK, | |
31 | IIO_CHAN_INFO_PEAK_SCALE, | |
32 | IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW, | |
33 | IIO_CHAN_INFO_AVERAGE_RAW, | |
df94aba8 | 34 | IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY, |
3f7f642b | 35 | IIO_CHAN_INFO_HIGH_PASS_FILTER_3DB_FREQUENCY, |
ce85a1cb | 36 | IIO_CHAN_INFO_SAMP_FREQ, |
a6b12855 MH |
37 | IIO_CHAN_INFO_FREQUENCY, |
38 | IIO_CHAN_INFO_PHASE, | |
b65d6212 | 39 | IIO_CHAN_INFO_HARDWAREGAIN, |
7c9ab035 | 40 | IIO_CHAN_INFO_HYSTERESIS, |
899d90bd | 41 | IIO_CHAN_INFO_INT_TIME, |
a88bfe78 | 42 | IIO_CHAN_INFO_ENABLE, |
bcdf28fb | 43 | IIO_CHAN_INFO_CALIBHEIGHT, |
d37f6836 | 44 | IIO_CHAN_INFO_CALIBWEIGHT, |
2f0ecb7c IT |
45 | IIO_CHAN_INFO_DEBOUNCE_COUNT, |
46 | IIO_CHAN_INFO_DEBOUNCE_TIME, | |
c8a85854 | 47 | IIO_CHAN_INFO_CALIBEMISSIVITY, |
faaa4495 | 48 | IIO_CHAN_INFO_OVERSAMPLING_RATIO, |
1d892719 JC |
49 | }; |
50 | ||
3704432f JC |
51 | enum iio_shared_by { |
52 | IIO_SEPARATE, | |
c006ec83 JC |
53 | IIO_SHARED_BY_TYPE, |
54 | IIO_SHARED_BY_DIR, | |
55 | IIO_SHARED_BY_ALL | |
3704432f JC |
56 | }; |
57 | ||
8310b86c JC |
58 | enum iio_endian { |
59 | IIO_CPU, | |
60 | IIO_BE, | |
61 | IIO_LE, | |
62 | }; | |
63 | ||
5f420b42 LPC |
64 | struct iio_chan_spec; |
65 | struct iio_dev; | |
66 | ||
67 | /** | |
68 | * struct iio_chan_spec_ext_info - Extended channel info attribute | |
69 | * @name: Info attribute name | |
70 | * @shared: Whether this attribute is shared between all channels. | |
71 | * @read: Read callback for this info attribute, may be NULL. | |
72 | * @write: Write callback for this info attribute, may be NULL. | |
fc6d1139 | 73 | * @private: Data private to the driver. |
5f420b42 LPC |
74 | */ |
75 | struct iio_chan_spec_ext_info { | |
76 | const char *name; | |
3704432f | 77 | enum iio_shared_by shared; |
fc6d1139 MH |
78 | ssize_t (*read)(struct iio_dev *, uintptr_t private, |
79 | struct iio_chan_spec const *, char *buf); | |
80 | ssize_t (*write)(struct iio_dev *, uintptr_t private, | |
81 | struct iio_chan_spec const *, const char *buf, | |
82 | size_t len); | |
83 | uintptr_t private; | |
5f420b42 LPC |
84 | }; |
85 | ||
5212cc8a LPC |
86 | /** |
87 | * struct iio_enum - Enum channel info attribute | |
7dcd7b60 PM |
88 | * @items: An array of strings. |
89 | * @num_items: Length of the item array. | |
90 | * @set: Set callback function, may be NULL. | |
91 | * @get: Get callback function, may be NULL. | |
5212cc8a LPC |
92 | * |
93 | * The iio_enum struct can be used to implement enum style channel attributes. | |
94 | * Enum style attributes are those which have a set of strings which map to | |
95 | * unsigned integer values. The IIO enum helper code takes care of mapping | |
96 | * between value and string as well as generating a "_available" file which | |
97 | * contains a list of all available items. The set callback will be called when | |
98 | * the attribute is updated. The last parameter is the index to the newly | |
99 | * activated item. The get callback will be used to query the currently active | |
100 | * item and is supposed to return the index for it. | |
101 | */ | |
102 | struct iio_enum { | |
103 | const char * const *items; | |
104 | unsigned int num_items; | |
105 | int (*set)(struct iio_dev *, const struct iio_chan_spec *, unsigned int); | |
106 | int (*get)(struct iio_dev *, const struct iio_chan_spec *); | |
107 | }; | |
108 | ||
109 | ssize_t iio_enum_available_read(struct iio_dev *indio_dev, | |
110 | uintptr_t priv, const struct iio_chan_spec *chan, char *buf); | |
111 | ssize_t iio_enum_read(struct iio_dev *indio_dev, | |
112 | uintptr_t priv, const struct iio_chan_spec *chan, char *buf); | |
113 | ssize_t iio_enum_write(struct iio_dev *indio_dev, | |
114 | uintptr_t priv, const struct iio_chan_spec *chan, const char *buf, | |
115 | size_t len); | |
116 | ||
117 | /** | |
118 | * IIO_ENUM() - Initialize enum extended channel attribute | |
7dcd7b60 PM |
119 | * @_name: Attribute name |
120 | * @_shared: Whether the attribute is shared between all channels | |
d25b3808 | 121 | * @_e: Pointer to an iio_enum struct |
5212cc8a LPC |
122 | * |
123 | * This should usually be used together with IIO_ENUM_AVAILABLE() | |
124 | */ | |
125 | #define IIO_ENUM(_name, _shared, _e) \ | |
126 | { \ | |
127 | .name = (_name), \ | |
128 | .shared = (_shared), \ | |
129 | .read = iio_enum_read, \ | |
130 | .write = iio_enum_write, \ | |
131 | .private = (uintptr_t)(_e), \ | |
132 | } | |
133 | ||
134 | /** | |
135 | * IIO_ENUM_AVAILABLE() - Initialize enum available extended channel attribute | |
7dcd7b60 | 136 | * @_name: Attribute name ("_available" will be appended to the name) |
d25b3808 | 137 | * @_e: Pointer to an iio_enum struct |
5212cc8a | 138 | * |
d25b3808 | 139 | * Creates a read only attribute which lists all the available enum items in a |
5212cc8a LPC |
140 | * space separated list. This should usually be used together with IIO_ENUM() |
141 | */ | |
142 | #define IIO_ENUM_AVAILABLE(_name, _e) \ | |
143 | { \ | |
144 | .name = (_name "_available"), \ | |
3704432f | 145 | .shared = IIO_SHARED_BY_TYPE, \ |
5212cc8a LPC |
146 | .read = iio_enum_available_read, \ |
147 | .private = (uintptr_t)(_e), \ | |
148 | } | |
149 | ||
dfc57732 GB |
150 | /** |
151 | * struct iio_mount_matrix - iio mounting matrix | |
152 | * @rotation: 3 dimensional space rotation matrix defining sensor alignment with | |
153 | * main hardware | |
154 | */ | |
155 | struct iio_mount_matrix { | |
156 | const char *rotation[9]; | |
157 | }; | |
158 | ||
159 | ssize_t iio_show_mount_matrix(struct iio_dev *indio_dev, uintptr_t priv, | |
160 | const struct iio_chan_spec *chan, char *buf); | |
161 | int of_iio_read_mount_matrix(const struct device *dev, const char *propname, | |
162 | struct iio_mount_matrix *matrix); | |
163 | ||
164 | typedef const struct iio_mount_matrix * | |
165 | (iio_get_mount_matrix_t)(const struct iio_dev *indio_dev, | |
166 | const struct iio_chan_spec *chan); | |
167 | ||
168 | /** | |
169 | * IIO_MOUNT_MATRIX() - Initialize mount matrix extended channel attribute | |
170 | * @_shared: Whether the attribute is shared between all channels | |
171 | * @_get: Pointer to an iio_get_mount_matrix_t accessor | |
172 | */ | |
173 | #define IIO_MOUNT_MATRIX(_shared, _get) \ | |
174 | { \ | |
175 | .name = "mount_matrix", \ | |
176 | .shared = (_shared), \ | |
177 | .read = iio_show_mount_matrix, \ | |
178 | .private = (uintptr_t)(_get), \ | |
179 | } | |
180 | ||
b4e3ac0a LPC |
181 | /** |
182 | * struct iio_event_spec - specification for a channel event | |
183 | * @type: Type of the event | |
184 | * @dir: Direction of the event | |
185 | * @mask_separate: Bit mask of enum iio_event_info values. Attributes | |
186 | * set in this mask will be registered per channel. | |
187 | * @mask_shared_by_type: Bit mask of enum iio_event_info values. Attributes | |
188 | * set in this mask will be shared by channel type. | |
189 | * @mask_shared_by_dir: Bit mask of enum iio_event_info values. Attributes | |
190 | * set in this mask will be shared by channel type and | |
191 | * direction. | |
192 | * @mask_shared_by_all: Bit mask of enum iio_event_info values. Attributes | |
193 | * set in this mask will be shared by all channels. | |
194 | */ | |
195 | struct iio_event_spec { | |
196 | enum iio_event_type type; | |
197 | enum iio_event_direction dir; | |
198 | unsigned long mask_separate; | |
199 | unsigned long mask_shared_by_type; | |
200 | unsigned long mask_shared_by_dir; | |
201 | unsigned long mask_shared_by_all; | |
202 | }; | |
203 | ||
1d892719 JC |
204 | /** |
205 | * struct iio_chan_spec - specification of a single channel | |
206 | * @type: What type of measurement is the channel making. | |
a16561c6 | 207 | * @channel: What number do we wish to assign the channel. |
1d892719 JC |
208 | * @channel2: If there is a second number for a differential |
209 | * channel then this is it. If modified is set then the | |
210 | * value here specifies the modifier. | |
211 | * @address: Driver specific identifier. | |
7dcd7b60 | 212 | * @scan_index: Monotonic index to give ordering in scans when read |
1d892719 | 213 | * from a buffer. |
3347a065 | 214 | * @scan_type: sign: 's' or 'u' to specify signed or unsigned |
1d892719 | 215 | * realbits: Number of valid bits of data |
3347a065 | 216 | * storagebits: Realbits + padding |
1d892719 JC |
217 | * shift: Shift right by this before masking out |
218 | * realbits. | |
0ee8546a SP |
219 | * repeat: Number of times real/storage bits |
220 | * repeats. When the repeat element is | |
221 | * more than 1, then the type element in | |
222 | * sysfs will show a repeat value. | |
223 | * Otherwise, the number of repetitions is | |
224 | * omitted. | |
3347a065 | 225 | * endianness: little or big endian |
8655cc49 JC |
226 | * @info_mask_separate: What information is to be exported that is specific to |
227 | * this channel. | |
228 | * @info_mask_shared_by_type: What information is to be exported that is shared | |
9761696f | 229 | * by all channels of the same type. |
c006ec83 JC |
230 | * @info_mask_shared_by_dir: What information is to be exported that is shared |
231 | * by all channels of the same direction. | |
232 | * @info_mask_shared_by_all: What information is to be exported that is shared | |
233 | * by all channels. | |
b4e3ac0a LPC |
234 | * @event_spec: Array of events which should be registered for this |
235 | * channel. | |
236 | * @num_event_specs: Size of the event_spec array. | |
5f420b42 LPC |
237 | * @ext_info: Array of extended info attributes for this channel. |
238 | * The array is NULL terminated, the last element should | |
9cc113bc | 239 | * have its name field set to NULL. |
1d892719 JC |
240 | * @extend_name: Allows labeling of channel attributes with an |
241 | * informative name. Note this has no effect codes etc, | |
242 | * unlike modifiers. | |
17879488 | 243 | * @datasheet_name: A name used in in-kernel mapping of channels. It should |
4abf6f8b | 244 | * correspond to the first name that the channel is referred |
6c63dded JC |
245 | * to by in the datasheet (e.g. IND), or the nearest |
246 | * possible compound name (e.g. IND-INC). | |
1d892719 JC |
247 | * @modified: Does a modifier apply to this channel. What these are |
248 | * depends on the channel type. Modifier is set in | |
249 | * channel2. Examples are IIO_MOD_X for axial sensors about | |
250 | * the 'x' axis. | |
251 | * @indexed: Specify the channel has a numerical index. If not, | |
a16561c6 PM |
252 | * the channel index number will be suppressed for sysfs |
253 | * attributes but not for event codes. | |
c3668a0f | 254 | * @output: Channel is output. |
ade7ef7b | 255 | * @differential: Channel is differential. |
1d892719 JC |
256 | */ |
257 | struct iio_chan_spec { | |
258 | enum iio_chan_type type; | |
259 | int channel; | |
260 | int channel2; | |
261 | unsigned long address; | |
262 | int scan_index; | |
263 | struct { | |
264 | char sign; | |
265 | u8 realbits; | |
266 | u8 storagebits; | |
267 | u8 shift; | |
0ee8546a | 268 | u8 repeat; |
8310b86c | 269 | enum iio_endian endianness; |
1d892719 | 270 | } scan_type; |
8655cc49 JC |
271 | long info_mask_separate; |
272 | long info_mask_shared_by_type; | |
c006ec83 JC |
273 | long info_mask_shared_by_dir; |
274 | long info_mask_shared_by_all; | |
b4e3ac0a LPC |
275 | const struct iio_event_spec *event_spec; |
276 | unsigned int num_event_specs; | |
5f420b42 | 277 | const struct iio_chan_spec_ext_info *ext_info; |
344692b1 | 278 | const char *extend_name; |
6c63dded | 279 | const char *datasheet_name; |
1d892719 JC |
280 | unsigned modified:1; |
281 | unsigned indexed:1; | |
c6fc8062 | 282 | unsigned output:1; |
ade7ef7b | 283 | unsigned differential:1; |
1d892719 | 284 | }; |
df9c1c42 | 285 | |
48e44ce0 LPC |
286 | |
287 | /** | |
288 | * iio_channel_has_info() - Checks whether a channel supports a info attribute | |
289 | * @chan: The channel to be queried | |
290 | * @type: Type of the info attribute to be checked | |
291 | * | |
292 | * Returns true if the channels supports reporting values for the given info | |
293 | * attribute type, false otherwise. | |
294 | */ | |
295 | static inline bool iio_channel_has_info(const struct iio_chan_spec *chan, | |
296 | enum iio_chan_info_enum type) | |
297 | { | |
1c297a66 | 298 | return (chan->info_mask_separate & BIT(type)) | |
c006ec83 JC |
299 | (chan->info_mask_shared_by_type & BIT(type)) | |
300 | (chan->info_mask_shared_by_dir & BIT(type)) | | |
301 | (chan->info_mask_shared_by_all & BIT(type)); | |
48e44ce0 LPC |
302 | } |
303 | ||
07d4655b JC |
304 | #define IIO_CHAN_SOFT_TIMESTAMP(_si) { \ |
305 | .type = IIO_TIMESTAMP, \ | |
306 | .channel = -1, \ | |
307 | .scan_index = _si, \ | |
308 | .scan_type = { \ | |
309 | .sign = 's', \ | |
310 | .realbits = 64, \ | |
311 | .storagebits = 64, \ | |
312 | }, \ | |
313 | } | |
1d892719 | 314 | |
bc2b7dab GB |
315 | s64 iio_get_time_ns(const struct iio_dev *indio_dev); |
316 | unsigned int iio_get_time_res(const struct iio_dev *indio_dev); | |
847ec80b | 317 | |
847ec80b JC |
318 | /* Device operating modes */ |
319 | #define INDIO_DIRECT_MODE 0x01 | |
ec3afa40 | 320 | #define INDIO_BUFFER_TRIGGERED 0x02 |
03af03ad | 321 | #define INDIO_BUFFER_SOFTWARE 0x04 |
ec3afa40 | 322 | #define INDIO_BUFFER_HARDWARE 0x08 |
735ad074 | 323 | #define INDIO_EVENT_TRIGGERED 0x10 |
847ec80b | 324 | |
ec3afa40 | 325 | #define INDIO_ALL_BUFFER_MODES \ |
03af03ad | 326 | (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE | INDIO_BUFFER_SOFTWARE) |
847ec80b | 327 | |
9fbfb4b3 SP |
328 | #define INDIO_MAX_RAW_ELEMENTS 4 |
329 | ||
43a4360e | 330 | struct iio_trigger; /* forward declaration */ |
7ae8cf62 | 331 | struct iio_dev; |
43a4360e | 332 | |
6fe8135f JC |
333 | /** |
334 | * struct iio_info - constant information about device | |
335 | * @driver_module: module structure used to ensure correct | |
336 | * ownership of chrdevs etc | |
6fe8135f JC |
337 | * @event_attrs: event control attributes |
338 | * @attrs: general purpose device attributes | |
339 | * @read_raw: function to request a value from the device. | |
340 | * mask specifies which value. Note 0 means a reading of | |
341 | * the channel in question. Return value will specify the | |
342 | * type of value returned by the device. val and val2 will | |
343 | * contain the elements making up the returned value. | |
9fbfb4b3 SP |
344 | * @read_raw_multi: function to return values from the device. |
345 | * mask specifies which value. Note 0 means a reading of | |
346 | * the channel in question. Return value will specify the | |
347 | * type of value returned by the device. vals pointer | |
348 | * contain the elements making up the returned value. | |
349 | * max_len specifies maximum number of elements | |
350 | * vals pointer can contain. val_len is used to return | |
351 | * length of valid elements in vals. | |
6fe8135f JC |
352 | * @write_raw: function to write a value to the device. |
353 | * Parameters are the same as for read_raw. | |
5c04af04 MH |
354 | * @write_raw_get_fmt: callback function to query the expected |
355 | * format/precision. If not set by the driver, write_raw | |
356 | * returns IIO_VAL_INT_PLUS_MICRO. | |
6fe8135f JC |
357 | * @read_event_config: find out if the event is enabled. |
358 | * @write_event_config: set if the event is enabled. | |
cb955852 LPC |
359 | * @read_event_value: read a configuration value associated with the event. |
360 | * @write_event_value: write a configuration value for the event. | |
43a4360e MH |
361 | * @validate_trigger: function to validate the trigger when the |
362 | * current trigger gets changed. | |
c3668a0f PM |
363 | * @update_scan_mode: function to configure device and scan buffer when |
364 | * channels have changed | |
365 | * @debugfs_reg_access: function to read or write register value of device | |
acd82567 II |
366 | * @of_xlate: function pointer to obtain channel specifier index. |
367 | * When #iio-cells is greater than '0', the driver could | |
368 | * provide a custom of_xlate function that reads the | |
369 | * *args* and returns the appropriate index in registered | |
370 | * IIO channels array. | |
f4f4673b OP |
371 | * @hwfifo_set_watermark: function pointer to set the current hardware |
372 | * fifo watermark level; see hwfifo_* entries in | |
373 | * Documentation/ABI/testing/sysfs-bus-iio for details on | |
374 | * how the hardware fifo operates | |
375 | * @hwfifo_flush_to_buffer: function pointer to flush the samples stored | |
376 | * in the hardware fifo to the device buffer. The driver | |
377 | * should not flush more than count samples. The function | |
378 | * must return the number of samples flushed, 0 if no | |
379 | * samples were flushed or a negative integer if no samples | |
380 | * were flushed and there was an error. | |
6fe8135f JC |
381 | **/ |
382 | struct iio_info { | |
383 | struct module *driver_module; | |
6fe8135f JC |
384 | struct attribute_group *event_attrs; |
385 | const struct attribute_group *attrs; | |
386 | ||
387 | int (*read_raw)(struct iio_dev *indio_dev, | |
388 | struct iio_chan_spec const *chan, | |
389 | int *val, | |
390 | int *val2, | |
391 | long mask); | |
392 | ||
9fbfb4b3 SP |
393 | int (*read_raw_multi)(struct iio_dev *indio_dev, |
394 | struct iio_chan_spec const *chan, | |
395 | int max_len, | |
396 | int *vals, | |
397 | int *val_len, | |
398 | long mask); | |
399 | ||
6fe8135f JC |
400 | int (*write_raw)(struct iio_dev *indio_dev, |
401 | struct iio_chan_spec const *chan, | |
402 | int val, | |
403 | int val2, | |
404 | long mask); | |
405 | ||
5c04af04 MH |
406 | int (*write_raw_get_fmt)(struct iio_dev *indio_dev, |
407 | struct iio_chan_spec const *chan, | |
408 | long mask); | |
409 | ||
6fe8135f | 410 | int (*read_event_config)(struct iio_dev *indio_dev, |
b4e3ac0a LPC |
411 | const struct iio_chan_spec *chan, |
412 | enum iio_event_type type, | |
413 | enum iio_event_direction dir); | |
414 | ||
cb955852 | 415 | int (*write_event_config)(struct iio_dev *indio_dev, |
b4e3ac0a LPC |
416 | const struct iio_chan_spec *chan, |
417 | enum iio_event_type type, | |
418 | enum iio_event_direction dir, | |
419 | int state); | |
420 | ||
cb955852 | 421 | int (*read_event_value)(struct iio_dev *indio_dev, |
b4e3ac0a LPC |
422 | const struct iio_chan_spec *chan, |
423 | enum iio_event_type type, | |
424 | enum iio_event_direction dir, | |
425 | enum iio_event_info info, int *val, int *val2); | |
426 | ||
cb955852 | 427 | int (*write_event_value)(struct iio_dev *indio_dev, |
b4e3ac0a LPC |
428 | const struct iio_chan_spec *chan, |
429 | enum iio_event_type type, | |
430 | enum iio_event_direction dir, | |
431 | enum iio_event_info info, int val, int val2); | |
432 | ||
43a4360e MH |
433 | int (*validate_trigger)(struct iio_dev *indio_dev, |
434 | struct iio_trigger *trig); | |
4d5f8d3d JC |
435 | int (*update_scan_mode)(struct iio_dev *indio_dev, |
436 | const unsigned long *scan_mask); | |
e553f182 MH |
437 | int (*debugfs_reg_access)(struct iio_dev *indio_dev, |
438 | unsigned reg, unsigned writeval, | |
439 | unsigned *readval); | |
acd82567 II |
440 | int (*of_xlate)(struct iio_dev *indio_dev, |
441 | const struct of_phandle_args *iiospec); | |
f4f4673b OP |
442 | int (*hwfifo_set_watermark)(struct iio_dev *indio_dev, unsigned val); |
443 | int (*hwfifo_flush_to_buffer)(struct iio_dev *indio_dev, | |
444 | unsigned count); | |
6fe8135f JC |
445 | }; |
446 | ||
1612244f JC |
447 | /** |
448 | * struct iio_buffer_setup_ops - buffer setup related callbacks | |
449 | * @preenable: [DRIVER] function to run prior to marking buffer enabled | |
450 | * @postenable: [DRIVER] function to run after marking buffer enabled | |
451 | * @predisable: [DRIVER] function to run prior to marking buffer | |
452 | * disabled | |
453 | * @postdisable: [DRIVER] function to run after marking buffer disabled | |
939546d1 LPC |
454 | * @validate_scan_mask: [DRIVER] function callback to check whether a given |
455 | * scan mask is valid for the device. | |
1612244f JC |
456 | */ |
457 | struct iio_buffer_setup_ops { | |
99698b45 PM |
458 | int (*preenable)(struct iio_dev *); |
459 | int (*postenable)(struct iio_dev *); | |
460 | int (*predisable)(struct iio_dev *); | |
461 | int (*postdisable)(struct iio_dev *); | |
939546d1 LPC |
462 | bool (*validate_scan_mask)(struct iio_dev *indio_dev, |
463 | const unsigned long *scan_mask); | |
1612244f JC |
464 | }; |
465 | ||
847ec80b JC |
466 | /** |
467 | * struct iio_dev - industrial I/O device | |
468 | * @id: [INTERN] used to identify device internally | |
847ec80b JC |
469 | * @modes: [DRIVER] operating modes supported by device |
470 | * @currentmode: [DRIVER] current operating mode | |
471 | * @dev: [DRIVER] device structure, should be assigned a parent | |
472 | * and owner | |
5aa96188 | 473 | * @event_interface: [INTERN] event chrdevs associated with interrupt lines |
14555b14 | 474 | * @buffer: [DRIVER] any buffer present |
84b36ce5 | 475 | * @buffer_list: [INTERN] list of all buffers currently attached |
420fe2e9 | 476 | * @scan_bytes: [INTERN] num bytes captured to be fed to buffer demux |
0118de7b | 477 | * @mlock: [DRIVER] lock used to prevent simultaneous device state |
847ec80b | 478 | * changes |
e5c003ae | 479 | * @available_scan_masks: [DRIVER] optional array of allowed bitmasks |
32b5eeca JC |
480 | * @masklength: [INTERN] the length of the mask established from |
481 | * channels | |
959d2952 | 482 | * @active_scan_mask: [INTERN] union of all scan masks requested by buffers |
fd6487f8 | 483 | * @scan_timestamp: [INTERN] set if any buffers have requested timestamp |
f1264809 | 484 | * @scan_index_timestamp:[INTERN] cache of the index to the timestamp |
14555b14 | 485 | * @trig: [INTERN] current device trigger (buffer modes) |
25985edc | 486 | * @pollfunc: [DRIVER] function run on trigger being received |
735ad074 | 487 | * @pollfunc_event: [DRIVER] function run on events trigger being received |
1d892719 | 488 | * @channels: [DRIVER] channel specification structure table |
17879488 | 489 | * @num_channels: [DRIVER] number of channels specified in @channels. |
1d892719 | 490 | * @channel_attr_list: [INTERN] keep track of automatically created channel |
1a25e592 | 491 | * attributes |
26d25ae3 | 492 | * @chan_attr_group: [INTERN] group for all attrs in base directory |
1d892719 | 493 | * @name: [DRIVER] name of the device. |
1a25e592 | 494 | * @info: [DRIVER] callbacks and constant info from driver |
bc2b7dab | 495 | * @clock_id: [INTERN] timestamping clock posix identifier |
ac917a81 | 496 | * @info_exist_lock: [INTERN] lock to prevent use during removal |
ecbf20ca JC |
497 | * @setup_ops: [DRIVER] callbacks to call before and after buffer |
498 | * enable/disable | |
1a25e592 | 499 | * @chrdev: [INTERN] associated character device |
26d25ae3 JC |
500 | * @groups: [INTERN] attribute groups |
501 | * @groupcounter: [INTERN] index of next attribute group | |
bb01443e | 502 | * @flags: [INTERN] file ops related flags including busy flag. |
e553f182 MH |
503 | * @debugfs_dentry: [INTERN] device specific debugfs dentry. |
504 | * @cached_reg_addr: [INTERN] cached register address for debugfs reads. | |
505 | */ | |
847ec80b JC |
506 | struct iio_dev { |
507 | int id; | |
4024bc73 | 508 | |
847ec80b JC |
509 | int modes; |
510 | int currentmode; | |
511 | struct device dev; | |
847ec80b | 512 | |
5aa96188 | 513 | struct iio_event_interface *event_interface; |
847ec80b | 514 | |
14555b14 | 515 | struct iio_buffer *buffer; |
84b36ce5 | 516 | struct list_head buffer_list; |
420fe2e9 | 517 | int scan_bytes; |
847ec80b JC |
518 | struct mutex mlock; |
519 | ||
cd4361c7 | 520 | const unsigned long *available_scan_masks; |
32b5eeca | 521 | unsigned masklength; |
cd4361c7 | 522 | const unsigned long *active_scan_mask; |
fd6487f8 | 523 | bool scan_timestamp; |
f1264809 | 524 | unsigned scan_index_timestamp; |
847ec80b JC |
525 | struct iio_trigger *trig; |
526 | struct iio_poll_func *pollfunc; | |
735ad074 | 527 | struct iio_poll_func *pollfunc_event; |
1d892719 | 528 | |
1a25e592 JC |
529 | struct iio_chan_spec const *channels; |
530 | int num_channels; | |
1d892719 | 531 | |
1a25e592 | 532 | struct list_head channel_attr_list; |
26d25ae3 | 533 | struct attribute_group chan_attr_group; |
1a25e592 JC |
534 | const char *name; |
535 | const struct iio_info *info; | |
bc2b7dab | 536 | clockid_t clock_id; |
ac917a81 | 537 | struct mutex info_exist_lock; |
1612244f | 538 | const struct iio_buffer_setup_ops *setup_ops; |
1a25e592 | 539 | struct cdev chrdev; |
26d25ae3 JC |
540 | #define IIO_MAX_GROUPS 6 |
541 | const struct attribute_group *groups[IIO_MAX_GROUPS + 1]; | |
542 | int groupcounter; | |
bb01443e LPC |
543 | |
544 | unsigned long flags; | |
e553f182 MH |
545 | #if defined(CONFIG_DEBUG_FS) |
546 | struct dentry *debugfs_dentry; | |
547 | unsigned cached_reg_addr; | |
548 | #endif | |
847ec80b JC |
549 | }; |
550 | ||
5fb21c82 JC |
551 | const struct iio_chan_spec |
552 | *iio_find_channel_from_si(struct iio_dev *indio_dev, int si); | |
f8c6f4e9 | 553 | int iio_device_register(struct iio_dev *indio_dev); |
f8c6f4e9 | 554 | void iio_device_unregister(struct iio_dev *indio_dev); |
8caa07c0 SK |
555 | int devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev); |
556 | void devm_iio_device_unregister(struct device *dev, struct iio_dev *indio_dev); | |
f8c6f4e9 | 557 | int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp); |
08a33805 AS |
558 | int iio_device_claim_direct_mode(struct iio_dev *indio_dev); |
559 | void iio_device_release_direct_mode(struct iio_dev *indio_dev); | |
847ec80b | 560 | |
5aaaeba8 | 561 | extern struct bus_type iio_bus_type; |
847ec80b JC |
562 | |
563 | /** | |
7cbb7537 | 564 | * iio_device_put() - reference counted deallocation of struct device |
bc2b7dab | 565 | * @indio_dev: IIO device structure containing the device |
847ec80b | 566 | **/ |
7cbb7537 | 567 | static inline void iio_device_put(struct iio_dev *indio_dev) |
847ec80b | 568 | { |
f8c6f4e9 JC |
569 | if (indio_dev) |
570 | put_device(&indio_dev->dev); | |
6898eb89 | 571 | } |
847ec80b | 572 | |
bc2b7dab GB |
573 | /** |
574 | * iio_device_get_clock() - Retrieve current timestamping clock for the device | |
575 | * @indio_dev: IIO device structure containing the device | |
576 | */ | |
577 | static inline clockid_t iio_device_get_clock(const struct iio_dev *indio_dev) | |
578 | { | |
579 | return indio_dev->clock_id; | |
580 | } | |
581 | ||
7a7913f1 LPC |
582 | /** |
583 | * dev_to_iio_dev() - Get IIO device struct from a device struct | |
7dcd7b60 | 584 | * @dev: The device embedded in the IIO device |
7a7913f1 LPC |
585 | * |
586 | * Note: The device must be a IIO device, otherwise the result is undefined. | |
587 | */ | |
588 | static inline struct iio_dev *dev_to_iio_dev(struct device *dev) | |
589 | { | |
590 | return container_of(dev, struct iio_dev, dev); | |
591 | } | |
592 | ||
e4e8b776 LPC |
593 | /** |
594 | * iio_device_get() - increment reference count for the device | |
7dcd7b60 | 595 | * @indio_dev: IIO device structure |
e4e8b776 LPC |
596 | * |
597 | * Returns: The passed IIO device | |
598 | **/ | |
599 | static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev) | |
600 | { | |
601 | return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL; | |
602 | } | |
603 | ||
2d66f389 LPC |
604 | |
605 | /** | |
606 | * iio_device_set_drvdata() - Set device driver data | |
607 | * @indio_dev: IIO device structure | |
608 | * @data: Driver specific data | |
609 | * | |
610 | * Allows to attach an arbitrary pointer to an IIO device, which can later be | |
611 | * retrieved by iio_device_get_drvdata(). | |
612 | */ | |
613 | static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data) | |
614 | { | |
615 | dev_set_drvdata(&indio_dev->dev, data); | |
616 | } | |
617 | ||
618 | /** | |
619 | * iio_device_get_drvdata() - Get device driver data | |
620 | * @indio_dev: IIO device structure | |
621 | * | |
622 | * Returns the data previously set with iio_device_set_drvdata() | |
623 | */ | |
624 | static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev) | |
625 | { | |
626 | return dev_get_drvdata(&indio_dev->dev); | |
627 | } | |
628 | ||
6f7c8ee5 JC |
629 | /* Can we make this smaller? */ |
630 | #define IIO_ALIGN L1_CACHE_BYTES | |
7cbb7537 | 631 | struct iio_dev *iio_device_alloc(int sizeof_priv); |
6f7c8ee5 | 632 | |
f8c6f4e9 | 633 | static inline void *iio_priv(const struct iio_dev *indio_dev) |
6f7c8ee5 | 634 | { |
f8c6f4e9 | 635 | return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN); |
6f7c8ee5 JC |
636 | } |
637 | ||
638 | static inline struct iio_dev *iio_priv_to_dev(void *priv) | |
639 | { | |
640 | return (struct iio_dev *)((char *)priv - | |
641 | ALIGN(sizeof(struct iio_dev), IIO_ALIGN)); | |
642 | } | |
847ec80b | 643 | |
7cbb7537 | 644 | void iio_device_free(struct iio_dev *indio_dev); |
9dabaf5e | 645 | struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv); |
9bc54102 | 646 | void devm_iio_device_free(struct device *dev, struct iio_dev *indio_dev); |
d536321d JA |
647 | struct iio_trigger *devm_iio_trigger_alloc(struct device *dev, |
648 | const char *fmt, ...); | |
d536321d JA |
649 | void devm_iio_trigger_free(struct device *dev, struct iio_trigger *iio_trig); |
650 | ||
847ec80b | 651 | /** |
14555b14 | 652 | * iio_buffer_enabled() - helper function to test if the buffer is enabled |
7dcd7b60 | 653 | * @indio_dev: IIO device structure for device |
847ec80b | 654 | **/ |
f8c6f4e9 | 655 | static inline bool iio_buffer_enabled(struct iio_dev *indio_dev) |
847ec80b | 656 | { |
f8c6f4e9 | 657 | return indio_dev->currentmode |
03af03ad KW |
658 | & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE | |
659 | INDIO_BUFFER_SOFTWARE); | |
6898eb89 | 660 | } |
847ec80b | 661 | |
e553f182 MH |
662 | /** |
663 | * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry | |
7dcd7b60 | 664 | * @indio_dev: IIO device structure for device |
e553f182 MH |
665 | **/ |
666 | #if defined(CONFIG_DEBUG_FS) | |
667 | static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev) | |
668 | { | |
669 | return indio_dev->debugfs_dentry; | |
6898eb89 | 670 | } |
e553f182 MH |
671 | #else |
672 | static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev) | |
673 | { | |
674 | return NULL; | |
6898eb89 | 675 | } |
e553f182 MH |
676 | #endif |
677 | ||
7d2c2aca AD |
678 | ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals); |
679 | ||
6807d721 LPC |
680 | int iio_str_to_fixpoint(const char *str, int fract_mult, int *integer, |
681 | int *fract); | |
682 | ||
9dbf8ccd LPC |
683 | /** |
684 | * IIO_DEGREE_TO_RAD() - Convert degree to rad | |
685 | * @deg: A value in degree | |
686 | * | |
687 | * Returns the given value converted from degree to rad | |
688 | */ | |
689 | #define IIO_DEGREE_TO_RAD(deg) (((deg) * 314159ULL + 9000000ULL) / 18000000ULL) | |
690 | ||
c689a923 LPC |
691 | /** |
692 | * IIO_RAD_TO_DEGREE() - Convert rad to degree | |
693 | * @rad: A value in rad | |
694 | * | |
695 | * Returns the given value converted from rad to degree | |
696 | */ | |
697 | #define IIO_RAD_TO_DEGREE(rad) \ | |
698 | (((rad) * 18000000ULL + 314159ULL / 2) / 314159ULL) | |
699 | ||
9dbf8ccd LPC |
700 | /** |
701 | * IIO_G_TO_M_S_2() - Convert g to meter / second**2 | |
702 | * @g: A value in g | |
703 | * | |
704 | * Returns the given value converted from g to meter / second**2 | |
705 | */ | |
706 | #define IIO_G_TO_M_S_2(g) ((g) * 980665ULL / 100000ULL) | |
707 | ||
c689a923 LPC |
708 | /** |
709 | * IIO_M_S_2_TO_G() - Convert meter / second**2 to g | |
710 | * @ms2: A value in meter / second**2 | |
711 | * | |
712 | * Returns the given value converted from meter / second**2 to g | |
713 | */ | |
714 | #define IIO_M_S_2_TO_G(ms2) (((ms2) * 100000ULL + 980665ULL / 2) / 980665ULL) | |
715 | ||
847ec80b | 716 | #endif /* _INDUSTRIAL_IO_H_ */ |