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