]>
Commit | Line | Data |
---|---|---|
1 | ||
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 | */ | |
10 | #ifndef _INDUSTRIAL_IO_H_ | |
11 | #define _INDUSTRIAL_IO_H_ | |
12 | ||
13 | #include <linux/device.h> | |
14 | #include <linux/cdev.h> | |
15 | #include <linux/iio/types.h> | |
16 | #include <linux/of.h> | |
17 | /* IIO TODO LIST */ | |
18 | /* | |
19 | * Provide means of adjusting timer accuracy. | |
20 | * Currently assumes nano seconds. | |
21 | */ | |
22 | ||
23 | enum iio_chan_info_enum { | |
24 | IIO_CHAN_INFO_RAW = 0, | |
25 | IIO_CHAN_INFO_PROCESSED, | |
26 | IIO_CHAN_INFO_SCALE, | |
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, | |
34 | IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY, | |
35 | IIO_CHAN_INFO_HIGH_PASS_FILTER_3DB_FREQUENCY, | |
36 | IIO_CHAN_INFO_SAMP_FREQ, | |
37 | IIO_CHAN_INFO_FREQUENCY, | |
38 | IIO_CHAN_INFO_PHASE, | |
39 | IIO_CHAN_INFO_HARDWAREGAIN, | |
40 | IIO_CHAN_INFO_HYSTERESIS, | |
41 | IIO_CHAN_INFO_INT_TIME, | |
42 | IIO_CHAN_INFO_ENABLE, | |
43 | IIO_CHAN_INFO_CALIBHEIGHT, | |
44 | IIO_CHAN_INFO_CALIBWEIGHT, | |
45 | IIO_CHAN_INFO_DEBOUNCE_COUNT, | |
46 | IIO_CHAN_INFO_DEBOUNCE_TIME, | |
47 | IIO_CHAN_INFO_CALIBEMISSIVITY, | |
48 | IIO_CHAN_INFO_OVERSAMPLING_RATIO, | |
49 | }; | |
50 | ||
51 | enum iio_shared_by { | |
52 | IIO_SEPARATE, | |
53 | IIO_SHARED_BY_TYPE, | |
54 | IIO_SHARED_BY_DIR, | |
55 | IIO_SHARED_BY_ALL | |
56 | }; | |
57 | ||
58 | enum iio_endian { | |
59 | IIO_CPU, | |
60 | IIO_BE, | |
61 | IIO_LE, | |
62 | }; | |
63 | ||
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. | |
73 | * @private: Data private to the driver. | |
74 | */ | |
75 | struct iio_chan_spec_ext_info { | |
76 | const char *name; | |
77 | enum iio_shared_by shared; | |
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; | |
84 | }; | |
85 | ||
86 | /** | |
87 | * struct iio_enum - Enum channel info attribute | |
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. | |
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 | |
119 | * @_name: Attribute name | |
120 | * @_shared: Whether the attribute is shared between all channels | |
121 | * @_e: Pointer to an iio_enum struct | |
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 | |
136 | * @_name: Attribute name ("_available" will be appended to the name) | |
137 | * @_e: Pointer to an iio_enum struct | |
138 | * | |
139 | * Creates a read only attribute which lists all the available enum items in a | |
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"), \ | |
145 | .shared = IIO_SHARED_BY_TYPE, \ | |
146 | .read = iio_enum_available_read, \ | |
147 | .private = (uintptr_t)(_e), \ | |
148 | } | |
149 | ||
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 | ||
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 | ||
204 | /** | |
205 | * struct iio_chan_spec - specification of a single channel | |
206 | * @type: What type of measurement is the channel making. | |
207 | * @channel: What number do we wish to assign the channel. | |
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. | |
212 | * @scan_index: Monotonic index to give ordering in scans when read | |
213 | * from a buffer. | |
214 | * @scan_type: sign: 's' or 'u' to specify signed or unsigned | |
215 | * realbits: Number of valid bits of data | |
216 | * storagebits: Realbits + padding | |
217 | * shift: Shift right by this before masking out | |
218 | * realbits. | |
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. | |
225 | * endianness: little or big endian | |
226 | * @info_mask_separate: What information is to be exported that is specific to | |
227 | * this channel. | |
228 | * @info_mask_separate_available: What availability information is to be | |
229 | * exported that is specific to this channel. | |
230 | * @info_mask_shared_by_type: What information is to be exported that is shared | |
231 | * by all channels of the same type. | |
232 | * @info_mask_shared_by_type_available: What availability information is to be | |
233 | * exported that is shared by all channels of the same | |
234 | * type. | |
235 | * @info_mask_shared_by_dir: What information is to be exported that is shared | |
236 | * by all channels of the same direction. | |
237 | * @info_mask_shared_by_dir_available: What availability information is to be | |
238 | * exported that is shared by all channels of the same | |
239 | * direction. | |
240 | * @info_mask_shared_by_all: What information is to be exported that is shared | |
241 | * by all channels. | |
242 | * @info_mask_shared_by_all_available: What availability information is to be | |
243 | * exported that is shared by all channels. | |
244 | * @event_spec: Array of events which should be registered for this | |
245 | * channel. | |
246 | * @num_event_specs: Size of the event_spec array. | |
247 | * @ext_info: Array of extended info attributes for this channel. | |
248 | * The array is NULL terminated, the last element should | |
249 | * have its name field set to NULL. | |
250 | * @extend_name: Allows labeling of channel attributes with an | |
251 | * informative name. Note this has no effect codes etc, | |
252 | * unlike modifiers. | |
253 | * @datasheet_name: A name used in in-kernel mapping of channels. It should | |
254 | * correspond to the first name that the channel is referred | |
255 | * to by in the datasheet (e.g. IND), or the nearest | |
256 | * possible compound name (e.g. IND-INC). | |
257 | * @modified: Does a modifier apply to this channel. What these are | |
258 | * depends on the channel type. Modifier is set in | |
259 | * channel2. Examples are IIO_MOD_X for axial sensors about | |
260 | * the 'x' axis. | |
261 | * @indexed: Specify the channel has a numerical index. If not, | |
262 | * the channel index number will be suppressed for sysfs | |
263 | * attributes but not for event codes. | |
264 | * @output: Channel is output. | |
265 | * @differential: Channel is differential. | |
266 | */ | |
267 | struct iio_chan_spec { | |
268 | enum iio_chan_type type; | |
269 | int channel; | |
270 | int channel2; | |
271 | unsigned long address; | |
272 | int scan_index; | |
273 | struct { | |
274 | char sign; | |
275 | u8 realbits; | |
276 | u8 storagebits; | |
277 | u8 shift; | |
278 | u8 repeat; | |
279 | enum iio_endian endianness; | |
280 | } scan_type; | |
281 | long info_mask_separate; | |
282 | long info_mask_separate_available; | |
283 | long info_mask_shared_by_type; | |
284 | long info_mask_shared_by_type_available; | |
285 | long info_mask_shared_by_dir; | |
286 | long info_mask_shared_by_dir_available; | |
287 | long info_mask_shared_by_all; | |
288 | long info_mask_shared_by_all_available; | |
289 | const struct iio_event_spec *event_spec; | |
290 | unsigned int num_event_specs; | |
291 | const struct iio_chan_spec_ext_info *ext_info; | |
292 | const char *extend_name; | |
293 | const char *datasheet_name; | |
294 | unsigned modified:1; | |
295 | unsigned indexed:1; | |
296 | unsigned output:1; | |
297 | unsigned differential:1; | |
298 | }; | |
299 | ||
300 | ||
301 | /** | |
302 | * iio_channel_has_info() - Checks whether a channel supports a info attribute | |
303 | * @chan: The channel to be queried | |
304 | * @type: Type of the info attribute to be checked | |
305 | * | |
306 | * Returns true if the channels supports reporting values for the given info | |
307 | * attribute type, false otherwise. | |
308 | */ | |
309 | static inline bool iio_channel_has_info(const struct iio_chan_spec *chan, | |
310 | enum iio_chan_info_enum type) | |
311 | { | |
312 | return (chan->info_mask_separate & BIT(type)) | | |
313 | (chan->info_mask_shared_by_type & BIT(type)) | | |
314 | (chan->info_mask_shared_by_dir & BIT(type)) | | |
315 | (chan->info_mask_shared_by_all & BIT(type)); | |
316 | } | |
317 | ||
318 | /** | |
319 | * iio_channel_has_available() - Checks if a channel has an available attribute | |
320 | * @chan: The channel to be queried | |
321 | * @type: Type of the available attribute to be checked | |
322 | * | |
323 | * Returns true if the channel supports reporting available values for the | |
324 | * given attribute type, false otherwise. | |
325 | */ | |
326 | static inline bool iio_channel_has_available(const struct iio_chan_spec *chan, | |
327 | enum iio_chan_info_enum type) | |
328 | { | |
329 | return (chan->info_mask_separate_available & BIT(type)) | | |
330 | (chan->info_mask_shared_by_type_available & BIT(type)) | | |
331 | (chan->info_mask_shared_by_dir_available & BIT(type)) | | |
332 | (chan->info_mask_shared_by_all_available & BIT(type)); | |
333 | } | |
334 | ||
335 | #define IIO_CHAN_SOFT_TIMESTAMP(_si) { \ | |
336 | .type = IIO_TIMESTAMP, \ | |
337 | .channel = -1, \ | |
338 | .scan_index = _si, \ | |
339 | .scan_type = { \ | |
340 | .sign = 's', \ | |
341 | .realbits = 64, \ | |
342 | .storagebits = 64, \ | |
343 | }, \ | |
344 | } | |
345 | ||
346 | s64 iio_get_time_ns(const struct iio_dev *indio_dev); | |
347 | unsigned int iio_get_time_res(const struct iio_dev *indio_dev); | |
348 | ||
349 | /* Device operating modes */ | |
350 | #define INDIO_DIRECT_MODE 0x01 | |
351 | #define INDIO_BUFFER_TRIGGERED 0x02 | |
352 | #define INDIO_BUFFER_SOFTWARE 0x04 | |
353 | #define INDIO_BUFFER_HARDWARE 0x08 | |
354 | #define INDIO_EVENT_TRIGGERED 0x10 | |
355 | ||
356 | #define INDIO_ALL_BUFFER_MODES \ | |
357 | (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE | INDIO_BUFFER_SOFTWARE) | |
358 | ||
359 | #define INDIO_MAX_RAW_ELEMENTS 4 | |
360 | ||
361 | struct iio_trigger; /* forward declaration */ | |
362 | struct iio_dev; | |
363 | ||
364 | /** | |
365 | * struct iio_info - constant information about device | |
366 | * @driver_module: module structure used to ensure correct | |
367 | * ownership of chrdevs etc | |
368 | * @event_attrs: event control attributes | |
369 | * @attrs: general purpose device attributes | |
370 | * @read_raw: function to request a value from the device. | |
371 | * mask specifies which value. Note 0 means a reading of | |
372 | * the channel in question. Return value will specify the | |
373 | * type of value returned by the device. val and val2 will | |
374 | * contain the elements making up the returned value. | |
375 | * @read_raw_multi: function to return values from the device. | |
376 | * mask specifies which value. Note 0 means a reading of | |
377 | * the channel in question. Return value will specify the | |
378 | * type of value returned by the device. vals pointer | |
379 | * contain the elements making up the returned value. | |
380 | * max_len specifies maximum number of elements | |
381 | * vals pointer can contain. val_len is used to return | |
382 | * length of valid elements in vals. | |
383 | * @read_avail: function to return the available values from the device. | |
384 | * mask specifies which value. Note 0 means the available | |
385 | * values for the channel in question. Return value | |
386 | * specifies if a IIO_AVAIL_LIST or a IIO_AVAIL_RANGE is | |
387 | * returned in vals. The type of the vals are returned in | |
388 | * type and the number of vals is returned in length. For | |
389 | * ranges, there are always three vals returned; min, step | |
390 | * and max. For lists, all possible values are enumerated. | |
391 | * @write_raw: function to write a value to the device. | |
392 | * Parameters are the same as for read_raw. | |
393 | * @write_raw_get_fmt: callback function to query the expected | |
394 | * format/precision. If not set by the driver, write_raw | |
395 | * returns IIO_VAL_INT_PLUS_MICRO. | |
396 | * @read_event_config: find out if the event is enabled. | |
397 | * @write_event_config: set if the event is enabled. | |
398 | * @read_event_value: read a configuration value associated with the event. | |
399 | * @write_event_value: write a configuration value for the event. | |
400 | * @validate_trigger: function to validate the trigger when the | |
401 | * current trigger gets changed. | |
402 | * @update_scan_mode: function to configure device and scan buffer when | |
403 | * channels have changed | |
404 | * @debugfs_reg_access: function to read or write register value of device | |
405 | * @of_xlate: function pointer to obtain channel specifier index. | |
406 | * When #iio-cells is greater than '0', the driver could | |
407 | * provide a custom of_xlate function that reads the | |
408 | * *args* and returns the appropriate index in registered | |
409 | * IIO channels array. | |
410 | * @hwfifo_set_watermark: function pointer to set the current hardware | |
411 | * fifo watermark level; see hwfifo_* entries in | |
412 | * Documentation/ABI/testing/sysfs-bus-iio for details on | |
413 | * how the hardware fifo operates | |
414 | * @hwfifo_flush_to_buffer: function pointer to flush the samples stored | |
415 | * in the hardware fifo to the device buffer. The driver | |
416 | * should not flush more than count samples. The function | |
417 | * must return the number of samples flushed, 0 if no | |
418 | * samples were flushed or a negative integer if no samples | |
419 | * were flushed and there was an error. | |
420 | **/ | |
421 | struct iio_info { | |
422 | struct module *driver_module; | |
423 | const struct attribute_group *event_attrs; | |
424 | const struct attribute_group *attrs; | |
425 | ||
426 | int (*read_raw)(struct iio_dev *indio_dev, | |
427 | struct iio_chan_spec const *chan, | |
428 | int *val, | |
429 | int *val2, | |
430 | long mask); | |
431 | ||
432 | int (*read_raw_multi)(struct iio_dev *indio_dev, | |
433 | struct iio_chan_spec const *chan, | |
434 | int max_len, | |
435 | int *vals, | |
436 | int *val_len, | |
437 | long mask); | |
438 | ||
439 | int (*read_avail)(struct iio_dev *indio_dev, | |
440 | struct iio_chan_spec const *chan, | |
441 | const int **vals, | |
442 | int *type, | |
443 | int *length, | |
444 | long mask); | |
445 | ||
446 | int (*write_raw)(struct iio_dev *indio_dev, | |
447 | struct iio_chan_spec const *chan, | |
448 | int val, | |
449 | int val2, | |
450 | long mask); | |
451 | ||
452 | int (*write_raw_get_fmt)(struct iio_dev *indio_dev, | |
453 | struct iio_chan_spec const *chan, | |
454 | long mask); | |
455 | ||
456 | int (*read_event_config)(struct iio_dev *indio_dev, | |
457 | const struct iio_chan_spec *chan, | |
458 | enum iio_event_type type, | |
459 | enum iio_event_direction dir); | |
460 | ||
461 | int (*write_event_config)(struct iio_dev *indio_dev, | |
462 | const struct iio_chan_spec *chan, | |
463 | enum iio_event_type type, | |
464 | enum iio_event_direction dir, | |
465 | int state); | |
466 | ||
467 | int (*read_event_value)(struct iio_dev *indio_dev, | |
468 | const struct iio_chan_spec *chan, | |
469 | enum iio_event_type type, | |
470 | enum iio_event_direction dir, | |
471 | enum iio_event_info info, int *val, int *val2); | |
472 | ||
473 | int (*write_event_value)(struct iio_dev *indio_dev, | |
474 | const struct iio_chan_spec *chan, | |
475 | enum iio_event_type type, | |
476 | enum iio_event_direction dir, | |
477 | enum iio_event_info info, int val, int val2); | |
478 | ||
479 | int (*validate_trigger)(struct iio_dev *indio_dev, | |
480 | struct iio_trigger *trig); | |
481 | int (*update_scan_mode)(struct iio_dev *indio_dev, | |
482 | const unsigned long *scan_mask); | |
483 | int (*debugfs_reg_access)(struct iio_dev *indio_dev, | |
484 | unsigned reg, unsigned writeval, | |
485 | unsigned *readval); | |
486 | int (*of_xlate)(struct iio_dev *indio_dev, | |
487 | const struct of_phandle_args *iiospec); | |
488 | int (*hwfifo_set_watermark)(struct iio_dev *indio_dev, unsigned val); | |
489 | int (*hwfifo_flush_to_buffer)(struct iio_dev *indio_dev, | |
490 | unsigned count); | |
491 | }; | |
492 | ||
493 | /** | |
494 | * struct iio_buffer_setup_ops - buffer setup related callbacks | |
495 | * @preenable: [DRIVER] function to run prior to marking buffer enabled | |
496 | * @postenable: [DRIVER] function to run after marking buffer enabled | |
497 | * @predisable: [DRIVER] function to run prior to marking buffer | |
498 | * disabled | |
499 | * @postdisable: [DRIVER] function to run after marking buffer disabled | |
500 | * @validate_scan_mask: [DRIVER] function callback to check whether a given | |
501 | * scan mask is valid for the device. | |
502 | */ | |
503 | struct iio_buffer_setup_ops { | |
504 | int (*preenable)(struct iio_dev *); | |
505 | int (*postenable)(struct iio_dev *); | |
506 | int (*predisable)(struct iio_dev *); | |
507 | int (*postdisable)(struct iio_dev *); | |
508 | bool (*validate_scan_mask)(struct iio_dev *indio_dev, | |
509 | const unsigned long *scan_mask); | |
510 | }; | |
511 | ||
512 | /** | |
513 | * struct iio_dev - industrial I/O device | |
514 | * @id: [INTERN] used to identify device internally | |
515 | * @modes: [DRIVER] operating modes supported by device | |
516 | * @currentmode: [DRIVER] current operating mode | |
517 | * @dev: [DRIVER] device structure, should be assigned a parent | |
518 | * and owner | |
519 | * @event_interface: [INTERN] event chrdevs associated with interrupt lines | |
520 | * @buffer: [DRIVER] any buffer present | |
521 | * @buffer_list: [INTERN] list of all buffers currently attached | |
522 | * @scan_bytes: [INTERN] num bytes captured to be fed to buffer demux | |
523 | * @mlock: [DRIVER] lock used to prevent simultaneous device state | |
524 | * changes | |
525 | * @available_scan_masks: [DRIVER] optional array of allowed bitmasks | |
526 | * @masklength: [INTERN] the length of the mask established from | |
527 | * channels | |
528 | * @active_scan_mask: [INTERN] union of all scan masks requested by buffers | |
529 | * @scan_timestamp: [INTERN] set if any buffers have requested timestamp | |
530 | * @scan_index_timestamp:[INTERN] cache of the index to the timestamp | |
531 | * @trig: [INTERN] current device trigger (buffer modes) | |
532 | * @trig_readonly [INTERN] mark the current trigger immutable | |
533 | * @pollfunc: [DRIVER] function run on trigger being received | |
534 | * @pollfunc_event: [DRIVER] function run on events trigger being received | |
535 | * @channels: [DRIVER] channel specification structure table | |
536 | * @num_channels: [DRIVER] number of channels specified in @channels. | |
537 | * @channel_attr_list: [INTERN] keep track of automatically created channel | |
538 | * attributes | |
539 | * @chan_attr_group: [INTERN] group for all attrs in base directory | |
540 | * @name: [DRIVER] name of the device. | |
541 | * @info: [DRIVER] callbacks and constant info from driver | |
542 | * @clock_id: [INTERN] timestamping clock posix identifier | |
543 | * @info_exist_lock: [INTERN] lock to prevent use during removal | |
544 | * @setup_ops: [DRIVER] callbacks to call before and after buffer | |
545 | * enable/disable | |
546 | * @chrdev: [INTERN] associated character device | |
547 | * @groups: [INTERN] attribute groups | |
548 | * @groupcounter: [INTERN] index of next attribute group | |
549 | * @flags: [INTERN] file ops related flags including busy flag. | |
550 | * @debugfs_dentry: [INTERN] device specific debugfs dentry. | |
551 | * @cached_reg_addr: [INTERN] cached register address for debugfs reads. | |
552 | */ | |
553 | struct iio_dev { | |
554 | int id; | |
555 | ||
556 | int modes; | |
557 | int currentmode; | |
558 | struct device dev; | |
559 | ||
560 | struct iio_event_interface *event_interface; | |
561 | ||
562 | struct iio_buffer *buffer; | |
563 | struct list_head buffer_list; | |
564 | int scan_bytes; | |
565 | struct mutex mlock; | |
566 | ||
567 | const unsigned long *available_scan_masks; | |
568 | unsigned masklength; | |
569 | const unsigned long *active_scan_mask; | |
570 | bool scan_timestamp; | |
571 | unsigned scan_index_timestamp; | |
572 | struct iio_trigger *trig; | |
573 | bool trig_readonly; | |
574 | struct iio_poll_func *pollfunc; | |
575 | struct iio_poll_func *pollfunc_event; | |
576 | ||
577 | struct iio_chan_spec const *channels; | |
578 | int num_channels; | |
579 | ||
580 | struct list_head channel_attr_list; | |
581 | struct attribute_group chan_attr_group; | |
582 | const char *name; | |
583 | const struct iio_info *info; | |
584 | clockid_t clock_id; | |
585 | struct mutex info_exist_lock; | |
586 | const struct iio_buffer_setup_ops *setup_ops; | |
587 | struct cdev chrdev; | |
588 | #define IIO_MAX_GROUPS 6 | |
589 | const struct attribute_group *groups[IIO_MAX_GROUPS + 1]; | |
590 | int groupcounter; | |
591 | ||
592 | unsigned long flags; | |
593 | #if defined(CONFIG_DEBUG_FS) | |
594 | struct dentry *debugfs_dentry; | |
595 | unsigned cached_reg_addr; | |
596 | #endif | |
597 | }; | |
598 | ||
599 | const struct iio_chan_spec | |
600 | *iio_find_channel_from_si(struct iio_dev *indio_dev, int si); | |
601 | int iio_device_register(struct iio_dev *indio_dev); | |
602 | void iio_device_unregister(struct iio_dev *indio_dev); | |
603 | int devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev); | |
604 | void devm_iio_device_unregister(struct device *dev, struct iio_dev *indio_dev); | |
605 | int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp); | |
606 | int iio_device_claim_direct_mode(struct iio_dev *indio_dev); | |
607 | void iio_device_release_direct_mode(struct iio_dev *indio_dev); | |
608 | ||
609 | extern struct bus_type iio_bus_type; | |
610 | ||
611 | /** | |
612 | * iio_device_put() - reference counted deallocation of struct device | |
613 | * @indio_dev: IIO device structure containing the device | |
614 | **/ | |
615 | static inline void iio_device_put(struct iio_dev *indio_dev) | |
616 | { | |
617 | if (indio_dev) | |
618 | put_device(&indio_dev->dev); | |
619 | } | |
620 | ||
621 | /** | |
622 | * iio_device_get_clock() - Retrieve current timestamping clock for the device | |
623 | * @indio_dev: IIO device structure containing the device | |
624 | */ | |
625 | static inline clockid_t iio_device_get_clock(const struct iio_dev *indio_dev) | |
626 | { | |
627 | return indio_dev->clock_id; | |
628 | } | |
629 | ||
630 | /** | |
631 | * dev_to_iio_dev() - Get IIO device struct from a device struct | |
632 | * @dev: The device embedded in the IIO device | |
633 | * | |
634 | * Note: The device must be a IIO device, otherwise the result is undefined. | |
635 | */ | |
636 | static inline struct iio_dev *dev_to_iio_dev(struct device *dev) | |
637 | { | |
638 | return container_of(dev, struct iio_dev, dev); | |
639 | } | |
640 | ||
641 | /** | |
642 | * iio_device_get() - increment reference count for the device | |
643 | * @indio_dev: IIO device structure | |
644 | * | |
645 | * Returns: The passed IIO device | |
646 | **/ | |
647 | static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev) | |
648 | { | |
649 | return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL; | |
650 | } | |
651 | ||
652 | ||
653 | /** | |
654 | * iio_device_set_drvdata() - Set device driver data | |
655 | * @indio_dev: IIO device structure | |
656 | * @data: Driver specific data | |
657 | * | |
658 | * Allows to attach an arbitrary pointer to an IIO device, which can later be | |
659 | * retrieved by iio_device_get_drvdata(). | |
660 | */ | |
661 | static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data) | |
662 | { | |
663 | dev_set_drvdata(&indio_dev->dev, data); | |
664 | } | |
665 | ||
666 | /** | |
667 | * iio_device_get_drvdata() - Get device driver data | |
668 | * @indio_dev: IIO device structure | |
669 | * | |
670 | * Returns the data previously set with iio_device_set_drvdata() | |
671 | */ | |
672 | static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev) | |
673 | { | |
674 | return dev_get_drvdata(&indio_dev->dev); | |
675 | } | |
676 | ||
677 | /* Can we make this smaller? */ | |
678 | #define IIO_ALIGN L1_CACHE_BYTES | |
679 | struct iio_dev *iio_device_alloc(int sizeof_priv); | |
680 | ||
681 | static inline void *iio_priv(const struct iio_dev *indio_dev) | |
682 | { | |
683 | return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN); | |
684 | } | |
685 | ||
686 | static inline struct iio_dev *iio_priv_to_dev(void *priv) | |
687 | { | |
688 | return (struct iio_dev *)((char *)priv - | |
689 | ALIGN(sizeof(struct iio_dev), IIO_ALIGN)); | |
690 | } | |
691 | ||
692 | void iio_device_free(struct iio_dev *indio_dev); | |
693 | int devm_iio_device_match(struct device *dev, void *res, void *data); | |
694 | struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv); | |
695 | void devm_iio_device_free(struct device *dev, struct iio_dev *indio_dev); | |
696 | struct iio_trigger *devm_iio_trigger_alloc(struct device *dev, | |
697 | const char *fmt, ...); | |
698 | void devm_iio_trigger_free(struct device *dev, struct iio_trigger *iio_trig); | |
699 | ||
700 | /** | |
701 | * iio_buffer_enabled() - helper function to test if the buffer is enabled | |
702 | * @indio_dev: IIO device structure for device | |
703 | **/ | |
704 | static inline bool iio_buffer_enabled(struct iio_dev *indio_dev) | |
705 | { | |
706 | return indio_dev->currentmode | |
707 | & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE | | |
708 | INDIO_BUFFER_SOFTWARE); | |
709 | } | |
710 | ||
711 | /** | |
712 | * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry | |
713 | * @indio_dev: IIO device structure for device | |
714 | **/ | |
715 | #if defined(CONFIG_DEBUG_FS) | |
716 | static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev) | |
717 | { | |
718 | return indio_dev->debugfs_dentry; | |
719 | } | |
720 | #else | |
721 | static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev) | |
722 | { | |
723 | return NULL; | |
724 | } | |
725 | #endif | |
726 | ||
727 | ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals); | |
728 | ||
729 | int iio_str_to_fixpoint(const char *str, int fract_mult, int *integer, | |
730 | int *fract); | |
731 | ||
732 | /** | |
733 | * IIO_DEGREE_TO_RAD() - Convert degree to rad | |
734 | * @deg: A value in degree | |
735 | * | |
736 | * Returns the given value converted from degree to rad | |
737 | */ | |
738 | #define IIO_DEGREE_TO_RAD(deg) (((deg) * 314159ULL + 9000000ULL) / 18000000ULL) | |
739 | ||
740 | /** | |
741 | * IIO_RAD_TO_DEGREE() - Convert rad to degree | |
742 | * @rad: A value in rad | |
743 | * | |
744 | * Returns the given value converted from rad to degree | |
745 | */ | |
746 | #define IIO_RAD_TO_DEGREE(rad) \ | |
747 | (((rad) * 18000000ULL + 314159ULL / 2) / 314159ULL) | |
748 | ||
749 | /** | |
750 | * IIO_G_TO_M_S_2() - Convert g to meter / second**2 | |
751 | * @g: A value in g | |
752 | * | |
753 | * Returns the given value converted from g to meter / second**2 | |
754 | */ | |
755 | #define IIO_G_TO_M_S_2(g) ((g) * 980665ULL / 100000ULL) | |
756 | ||
757 | /** | |
758 | * IIO_M_S_2_TO_G() - Convert meter / second**2 to g | |
759 | * @ms2: A value in meter / second**2 | |
760 | * | |
761 | * Returns the given value converted from meter / second**2 to g | |
762 | */ | |
763 | #define IIO_M_S_2_TO_G(ms2) (((ms2) * 100000ULL + 980665ULL / 2) / 980665ULL) | |
764 | ||
765 | #endif /* _INDUSTRIAL_IO_H_ */ |