1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Industrial I/O event handling
4 * Copyright (c) 2008 Jonathan Cameron
6 * Based on elements of hwmon and input subsystems.
9 #include <linux/anon_inodes.h>
10 #include <linux/device.h>
12 #include <linux/kernel.h>
13 #include <linux/kfifo.h>
14 #include <linux/module.h>
15 #include <linux/poll.h>
16 #include <linux/sched.h>
17 #include <linux/slab.h>
18 #include <linux/uaccess.h>
19 #include <linux/wait.h>
20 #include <linux/iio/iio.h>
21 #include <linux/iio/iio-opaque.h>
23 #include <linux/iio/sysfs.h>
24 #include <linux/iio/events.h>
27 * struct iio_event_interface - chrdev interface for an event line
28 * @wait: wait queue to allow blocking reads of events
29 * @det_events: list of detected events
30 * @dev_attr_list: list of event interface sysfs attribute
31 * @flags: file operations related flags including busy flag.
32 * @group: event interface sysfs attribute group
33 * @read_lock: lock to protect kfifo read operations
34 * @ioctl_handler: handler for event ioctl() calls
36 struct iio_event_interface
{
37 wait_queue_head_t wait
;
38 DECLARE_KFIFO(det_events
, struct iio_event_data
, 16);
40 struct list_head dev_attr_list
;
42 struct attribute_group group
;
43 struct mutex read_lock
;
44 struct iio_ioctl_handler ioctl_handler
;
47 bool iio_event_enabled(const struct iio_event_interface
*ev_int
)
49 return !!test_bit(IIO_BUSY_BIT_POS
, &ev_int
->flags
);
53 * iio_push_event() - try to add event to the list for userspace reading
54 * @indio_dev: IIO device structure
55 * @ev_code: What event
56 * @timestamp: When the event occurred
58 * Note: The caller must make sure that this function is not running
59 * concurrently for the same indio_dev more than once.
61 * This function may be safely used as soon as a valid reference to iio_dev has
62 * been obtained via iio_device_alloc(), but any events that are submitted
63 * before iio_device_register() has successfully completed will be silently
66 int iio_push_event(struct iio_dev
*indio_dev
, u64 ev_code
, s64 timestamp
)
68 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
69 struct iio_event_interface
*ev_int
= iio_dev_opaque
->event_interface
;
70 struct iio_event_data ev
;
76 /* Does anyone care? */
77 if (iio_event_enabled(ev_int
)) {
80 ev
.timestamp
= timestamp
;
82 copied
= kfifo_put(&ev_int
->det_events
, ev
);
84 wake_up_poll(&ev_int
->wait
, EPOLLIN
);
89 EXPORT_SYMBOL(iio_push_event
);
92 * iio_event_poll() - poll the event queue to find out if it has data
93 * @filep: File structure pointer to identify the device
94 * @wait: Poll table pointer to add the wait queue on
96 * Return: (EPOLLIN | EPOLLRDNORM) if data is available for reading
97 * or a negative error code on failure
99 static __poll_t
iio_event_poll(struct file
*filep
,
100 struct poll_table_struct
*wait
)
102 struct iio_dev
*indio_dev
= filep
->private_data
;
103 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
104 struct iio_event_interface
*ev_int
= iio_dev_opaque
->event_interface
;
107 if (!indio_dev
->info
)
110 poll_wait(filep
, &ev_int
->wait
, wait
);
112 if (!kfifo_is_empty(&ev_int
->det_events
))
113 events
= EPOLLIN
| EPOLLRDNORM
;
118 static ssize_t
iio_event_chrdev_read(struct file
*filep
,
123 struct iio_dev
*indio_dev
= filep
->private_data
;
124 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
125 struct iio_event_interface
*ev_int
= iio_dev_opaque
->event_interface
;
129 if (!indio_dev
->info
)
132 if (count
< sizeof(struct iio_event_data
))
136 if (kfifo_is_empty(&ev_int
->det_events
)) {
137 if (filep
->f_flags
& O_NONBLOCK
)
140 ret
= wait_event_interruptible(ev_int
->wait
,
141 !kfifo_is_empty(&ev_int
->det_events
) ||
142 indio_dev
->info
== NULL
);
145 if (indio_dev
->info
== NULL
)
149 if (mutex_lock_interruptible(&ev_int
->read_lock
))
151 ret
= kfifo_to_user(&ev_int
->det_events
, buf
, count
, &copied
);
152 mutex_unlock(&ev_int
->read_lock
);
158 * If we couldn't read anything from the fifo (a different
159 * thread might have been faster) we either return -EAGAIN if
160 * the file descriptor is non-blocking, otherwise we go back to
161 * sleep and wait for more data to arrive.
163 if (copied
== 0 && (filep
->f_flags
& O_NONBLOCK
))
166 } while (copied
== 0);
171 static int iio_event_chrdev_release(struct inode
*inode
, struct file
*filep
)
173 struct iio_dev
*indio_dev
= filep
->private_data
;
174 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
175 struct iio_event_interface
*ev_int
= iio_dev_opaque
->event_interface
;
177 clear_bit(IIO_BUSY_BIT_POS
, &ev_int
->flags
);
179 iio_device_put(indio_dev
);
184 static const struct file_operations iio_event_chrdev_fileops
= {
185 .read
= iio_event_chrdev_read
,
186 .poll
= iio_event_poll
,
187 .release
= iio_event_chrdev_release
,
188 .owner
= THIS_MODULE
,
189 .llseek
= noop_llseek
,
192 static int iio_event_getfd(struct iio_dev
*indio_dev
)
194 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
195 struct iio_event_interface
*ev_int
= iio_dev_opaque
->event_interface
;
201 fd
= mutex_lock_interruptible(&iio_dev_opaque
->mlock
);
205 if (test_and_set_bit(IIO_BUSY_BIT_POS
, &ev_int
->flags
)) {
210 iio_device_get(indio_dev
);
212 fd
= anon_inode_getfd("iio:event", &iio_event_chrdev_fileops
,
213 indio_dev
, O_RDONLY
| O_CLOEXEC
);
215 clear_bit(IIO_BUSY_BIT_POS
, &ev_int
->flags
);
216 iio_device_put(indio_dev
);
218 kfifo_reset_out(&ev_int
->det_events
);
222 mutex_unlock(&iio_dev_opaque
->mlock
);
226 static const char * const iio_ev_type_text
[] = {
227 [IIO_EV_TYPE_THRESH
] = "thresh",
228 [IIO_EV_TYPE_MAG
] = "mag",
229 [IIO_EV_TYPE_ROC
] = "roc",
230 [IIO_EV_TYPE_THRESH_ADAPTIVE
] = "thresh_adaptive",
231 [IIO_EV_TYPE_MAG_ADAPTIVE
] = "mag_adaptive",
232 [IIO_EV_TYPE_CHANGE
] = "change",
233 [IIO_EV_TYPE_MAG_REFERENCED
] = "mag_referenced",
234 [IIO_EV_TYPE_GESTURE
] = "gesture",
237 static const char * const iio_ev_dir_text
[] = {
238 [IIO_EV_DIR_EITHER
] = "either",
239 [IIO_EV_DIR_RISING
] = "rising",
240 [IIO_EV_DIR_FALLING
] = "falling",
241 [IIO_EV_DIR_SINGLETAP
] = "singletap",
242 [IIO_EV_DIR_DOUBLETAP
] = "doubletap",
245 static const char * const iio_ev_info_text
[] = {
246 [IIO_EV_INFO_ENABLE
] = "en",
247 [IIO_EV_INFO_VALUE
] = "value",
248 [IIO_EV_INFO_HYSTERESIS
] = "hysteresis",
249 [IIO_EV_INFO_PERIOD
] = "period",
250 [IIO_EV_INFO_HIGH_PASS_FILTER_3DB
] = "high_pass_filter_3db",
251 [IIO_EV_INFO_LOW_PASS_FILTER_3DB
] = "low_pass_filter_3db",
252 [IIO_EV_INFO_TIMEOUT
] = "timeout",
253 [IIO_EV_INFO_RESET_TIMEOUT
] = "reset_timeout",
254 [IIO_EV_INFO_TAP2_MIN_DELAY
] = "tap2_min_delay",
255 [IIO_EV_INFO_RUNNING_PERIOD
] = "runningperiod",
256 [IIO_EV_INFO_RUNNING_COUNT
] = "runningcount",
259 static enum iio_event_direction
iio_ev_attr_dir(struct iio_dev_attr
*attr
)
261 return attr
->c
->event_spec
[attr
->address
& 0xffff].dir
;
264 static enum iio_event_type
iio_ev_attr_type(struct iio_dev_attr
*attr
)
266 return attr
->c
->event_spec
[attr
->address
& 0xffff].type
;
269 static enum iio_event_info
iio_ev_attr_info(struct iio_dev_attr
*attr
)
271 return (attr
->address
>> 16) & 0xffff;
274 static ssize_t
iio_ev_state_store(struct device
*dev
,
275 struct device_attribute
*attr
,
279 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
280 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
284 ret
= kstrtobool(buf
, &val
);
288 if (!indio_dev
->info
->write_event_config
)
291 ret
= indio_dev
->info
->write_event_config(indio_dev
,
292 this_attr
->c
, iio_ev_attr_type(this_attr
),
293 iio_ev_attr_dir(this_attr
), val
);
295 return (ret
< 0) ? ret
: len
;
298 static ssize_t
iio_ev_state_show(struct device
*dev
,
299 struct device_attribute
*attr
,
302 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
303 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
306 if (!indio_dev
->info
->read_event_config
)
309 val
= indio_dev
->info
->read_event_config(indio_dev
,
310 this_attr
->c
, iio_ev_attr_type(this_attr
),
311 iio_ev_attr_dir(this_attr
));
315 return sysfs_emit(buf
, "%d\n", val
);
318 static ssize_t
iio_ev_value_show(struct device
*dev
,
319 struct device_attribute
*attr
,
322 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
323 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
324 int val
, val2
, val_arr
[2];
327 if (!indio_dev
->info
->read_event_value
)
330 ret
= indio_dev
->info
->read_event_value(indio_dev
,
331 this_attr
->c
, iio_ev_attr_type(this_attr
),
332 iio_ev_attr_dir(this_attr
), iio_ev_attr_info(this_attr
),
338 return iio_format_value(buf
, ret
, 2, val_arr
);
341 static ssize_t
iio_ev_value_store(struct device
*dev
,
342 struct device_attribute
*attr
,
346 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
347 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
351 if (!indio_dev
->info
->write_event_value
)
354 ret
= iio_str_to_fixpoint(buf
, 100000, &val
, &val2
);
357 ret
= indio_dev
->info
->write_event_value(indio_dev
,
358 this_attr
->c
, iio_ev_attr_type(this_attr
),
359 iio_ev_attr_dir(this_attr
), iio_ev_attr_info(this_attr
),
367 static ssize_t
iio_ev_label_show(struct device
*dev
,
368 struct device_attribute
*attr
,
371 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
372 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
374 if (indio_dev
->info
->read_event_label
)
375 return indio_dev
->info
->read_event_label(indio_dev
,
376 this_attr
->c
, iio_ev_attr_type(this_attr
),
377 iio_ev_attr_dir(this_attr
), buf
);
382 static int iio_device_add_event(struct iio_dev
*indio_dev
,
383 const struct iio_chan_spec
*chan
, unsigned int spec_index
,
384 enum iio_event_type type
, enum iio_event_direction dir
,
385 enum iio_shared_by shared_by
, const unsigned long *mask
)
387 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
388 ssize_t (*show
)(struct device
*dev
, struct device_attribute
*attr
,
390 ssize_t (*store
)(struct device
*dev
, struct device_attribute
*attr
,
391 const char *buf
, size_t len
);
392 unsigned int attrcount
= 0;
397 for_each_set_bit(i
, mask
, sizeof(*mask
)*8) {
398 if (i
>= ARRAY_SIZE(iio_ev_info_text
))
400 if (dir
!= IIO_EV_DIR_NONE
)
401 postfix
= kasprintf(GFP_KERNEL
, "%s_%s_%s",
402 iio_ev_type_text
[type
],
403 iio_ev_dir_text
[dir
],
404 iio_ev_info_text
[i
]);
406 postfix
= kasprintf(GFP_KERNEL
, "%s_%s",
407 iio_ev_type_text
[type
],
408 iio_ev_info_text
[i
]);
412 if (i
== IIO_EV_INFO_ENABLE
) {
413 show
= iio_ev_state_show
;
414 store
= iio_ev_state_store
;
416 show
= iio_ev_value_show
;
417 store
= iio_ev_value_store
;
420 ret
= __iio_add_chan_devattr(postfix
, chan
, show
, store
,
421 (i
<< 16) | spec_index
, shared_by
, &indio_dev
->dev
,
423 &iio_dev_opaque
->event_interface
->dev_attr_list
);
426 if ((ret
== -EBUSY
) && (shared_by
!= IIO_SEPARATE
))
438 static int iio_device_add_event_label(struct iio_dev
*indio_dev
,
439 const struct iio_chan_spec
*chan
,
440 unsigned int spec_index
,
441 enum iio_event_type type
,
442 enum iio_event_direction dir
)
444 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
448 if (!indio_dev
->info
->read_event_label
)
451 if (dir
!= IIO_EV_DIR_NONE
)
452 postfix
= kasprintf(GFP_KERNEL
, "%s_%s_label",
453 iio_ev_type_text
[type
],
454 iio_ev_dir_text
[dir
]);
456 postfix
= kasprintf(GFP_KERNEL
, "%s_label",
457 iio_ev_type_text
[type
]);
461 ret
= __iio_add_chan_devattr(postfix
, chan
, &iio_ev_label_show
, NULL
,
462 spec_index
, IIO_SEPARATE
, &indio_dev
->dev
, NULL
,
463 &iio_dev_opaque
->event_interface
->dev_attr_list
);
473 static int iio_device_add_event_sysfs(struct iio_dev
*indio_dev
,
474 struct iio_chan_spec
const *chan
)
476 int ret
= 0, i
, attrcount
= 0;
477 enum iio_event_direction dir
;
478 enum iio_event_type type
;
480 for (i
= 0; i
< chan
->num_event_specs
; i
++) {
481 type
= chan
->event_spec
[i
].type
;
482 dir
= chan
->event_spec
[i
].dir
;
484 ret
= iio_device_add_event(indio_dev
, chan
, i
, type
, dir
,
485 IIO_SEPARATE
, &chan
->event_spec
[i
].mask_separate
);
490 ret
= iio_device_add_event(indio_dev
, chan
, i
, type
, dir
,
492 &chan
->event_spec
[i
].mask_shared_by_type
);
497 ret
= iio_device_add_event(indio_dev
, chan
, i
, type
, dir
,
499 &chan
->event_spec
[i
].mask_shared_by_dir
);
504 ret
= iio_device_add_event(indio_dev
, chan
, i
, type
, dir
,
506 &chan
->event_spec
[i
].mask_shared_by_all
);
511 ret
= iio_device_add_event_label(indio_dev
, chan
, i
, type
, dir
);
520 static inline int __iio_add_event_config_attrs(struct iio_dev
*indio_dev
)
522 int j
, ret
, attrcount
= 0;
524 /* Dynamically created from the channels array */
525 for (j
= 0; j
< indio_dev
->num_channels
; j
++) {
526 ret
= iio_device_add_event_sysfs(indio_dev
,
527 &indio_dev
->channels
[j
]);
535 static bool iio_check_for_dynamic_events(struct iio_dev
*indio_dev
)
539 for (j
= 0; j
< indio_dev
->num_channels
; j
++) {
540 if (indio_dev
->channels
[j
].num_event_specs
!= 0)
546 static void iio_setup_ev_int(struct iio_event_interface
*ev_int
)
548 INIT_KFIFO(ev_int
->det_events
);
549 init_waitqueue_head(&ev_int
->wait
);
550 mutex_init(&ev_int
->read_lock
);
553 static long iio_event_ioctl(struct iio_dev
*indio_dev
, struct file
*filp
,
554 unsigned int cmd
, unsigned long arg
)
556 int __user
*ip
= (int __user
*)arg
;
559 if (cmd
== IIO_GET_EVENT_FD_IOCTL
) {
560 fd
= iio_event_getfd(indio_dev
);
563 if (copy_to_user(ip
, &fd
, sizeof(fd
)))
568 return IIO_IOCTL_UNHANDLED
;
571 static const char *iio_event_group_name
= "events";
572 int iio_device_register_eventset(struct iio_dev
*indio_dev
)
574 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
575 struct iio_event_interface
*ev_int
;
576 struct iio_dev_attr
*p
;
577 int ret
= 0, attrcount_orig
= 0, attrcount
, attrn
;
578 struct attribute
**attr
;
580 if (!(indio_dev
->info
->event_attrs
||
581 iio_check_for_dynamic_events(indio_dev
)))
584 ev_int
= kzalloc(sizeof(*ev_int
), GFP_KERNEL
);
588 iio_dev_opaque
->event_interface
= ev_int
;
590 INIT_LIST_HEAD(&ev_int
->dev_attr_list
);
592 iio_setup_ev_int(ev_int
);
593 if (indio_dev
->info
->event_attrs
!= NULL
) {
594 attr
= indio_dev
->info
->event_attrs
->attrs
;
595 while (*attr
++ != NULL
)
598 attrcount
= attrcount_orig
;
599 if (indio_dev
->channels
) {
600 ret
= __iio_add_event_config_attrs(indio_dev
);
602 goto error_free_setup_event_lines
;
606 ev_int
->group
.name
= iio_event_group_name
;
607 ev_int
->group
.attrs
= kcalloc(attrcount
+ 1,
608 sizeof(ev_int
->group
.attrs
[0]),
610 if (ev_int
->group
.attrs
== NULL
) {
612 goto error_free_setup_event_lines
;
614 if (indio_dev
->info
->event_attrs
)
615 memcpy(ev_int
->group
.attrs
,
616 indio_dev
->info
->event_attrs
->attrs
,
617 sizeof(ev_int
->group
.attrs
[0]) * attrcount_orig
);
618 attrn
= attrcount_orig
;
619 /* Add all elements from the list. */
620 list_for_each_entry(p
, &ev_int
->dev_attr_list
, l
)
621 ev_int
->group
.attrs
[attrn
++] = &p
->dev_attr
.attr
;
623 ret
= iio_device_register_sysfs_group(indio_dev
, &ev_int
->group
);
625 goto error_free_group_attrs
;
627 ev_int
->ioctl_handler
.ioctl
= iio_event_ioctl
;
628 iio_device_ioctl_handler_register(&iio_dev_opaque
->indio_dev
,
629 &ev_int
->ioctl_handler
);
633 error_free_group_attrs
:
634 kfree(ev_int
->group
.attrs
);
635 error_free_setup_event_lines
:
636 iio_free_chan_devattr_list(&ev_int
->dev_attr_list
);
638 iio_dev_opaque
->event_interface
= NULL
;
643 * iio_device_wakeup_eventset - Wakes up the event waitqueue
644 * @indio_dev: The IIO device
646 * Wakes up the event waitqueue used for poll() and blocking read().
647 * Should usually be called when the device is unregistered.
649 void iio_device_wakeup_eventset(struct iio_dev
*indio_dev
)
651 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
653 if (iio_dev_opaque
->event_interface
== NULL
)
655 wake_up(&iio_dev_opaque
->event_interface
->wait
);
658 void iio_device_unregister_eventset(struct iio_dev
*indio_dev
)
660 struct iio_dev_opaque
*iio_dev_opaque
= to_iio_dev_opaque(indio_dev
);
661 struct iio_event_interface
*ev_int
= iio_dev_opaque
->event_interface
;
666 iio_device_ioctl_handler_unregister(&ev_int
->ioctl_handler
);
667 iio_free_chan_devattr_list(&ev_int
->dev_attr_list
);
668 kfree(ev_int
->group
.attrs
);
670 iio_dev_opaque
->event_interface
= NULL
;