1 /* The industrial I/O core
3 * Copyright (c) 2008 Jonathan Cameron
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
9 * Handling of buffer allocation / resizing.
12 * Things to look at here.
13 * - Better memory allocation techniques?
14 * - Alternative access techniques?
16 #include <linux/kernel.h>
17 #include <linux/export.h>
18 #include <linux/device.h>
20 #include <linux/cdev.h>
21 #include <linux/slab.h>
22 #include <linux/poll.h>
23 #include <linux/sched/signal.h>
25 #include <linux/iio/iio.h>
27 #include <linux/iio/sysfs.h>
28 #include <linux/iio/buffer.h>
29 #include <linux/iio/buffer_impl.h>
31 static const char * const iio_endian_prefix
[] = {
36 static bool iio_buffer_is_active(struct iio_buffer
*buf
)
38 return !list_empty(&buf
->buffer_list
);
41 static size_t iio_buffer_data_available(struct iio_buffer
*buf
)
43 return buf
->access
->data_available(buf
);
46 static int iio_buffer_flush_hwfifo(struct iio_dev
*indio_dev
,
47 struct iio_buffer
*buf
, size_t required
)
49 if (!indio_dev
->info
->hwfifo_flush_to_buffer
)
52 return indio_dev
->info
->hwfifo_flush_to_buffer(indio_dev
, required
);
55 static bool iio_buffer_ready(struct iio_dev
*indio_dev
, struct iio_buffer
*buf
,
56 size_t to_wait
, int to_flush
)
61 /* wakeup if the device was unregistered */
65 /* drain the buffer if it was disabled */
66 if (!iio_buffer_is_active(buf
)) {
67 to_wait
= min_t(size_t, to_wait
, 1);
71 avail
= iio_buffer_data_available(buf
);
73 if (avail
>= to_wait
) {
74 /* force a flush for non-blocking reads */
75 if (!to_wait
&& avail
< to_flush
)
76 iio_buffer_flush_hwfifo(indio_dev
, buf
,
82 flushed
= iio_buffer_flush_hwfifo(indio_dev
, buf
,
87 if (avail
+ flushed
>= to_wait
)
94 * iio_buffer_read_first_n_outer() - chrdev read for buffer access
95 * @filp: File structure pointer for the char device
96 * @buf: Destination buffer for iio buffer read
97 * @n: First n bytes to read
98 * @f_ps: Long offset provided by the user as a seek position
100 * This function relies on all buffer implementations having an
101 * iio_buffer as their first element.
103 * Return: negative values corresponding to error codes or ret != 0
104 * for ending the reading activity
106 ssize_t
iio_buffer_read_first_n_outer(struct file
*filp
, char __user
*buf
,
107 size_t n
, loff_t
*f_ps
)
109 struct iio_dev
*indio_dev
= filp
->private_data
;
110 struct iio_buffer
*rb
= indio_dev
->buffer
;
111 DEFINE_WAIT_FUNC(wait
, woken_wake_function
);
116 if (!indio_dev
->info
)
119 if (!rb
|| !rb
->access
->read_first_n
)
122 datum_size
= rb
->bytes_per_datum
;
125 * If datum_size is 0 there will never be anything to read from the
126 * buffer, so signal end of file now.
131 if (filp
->f_flags
& O_NONBLOCK
)
134 to_wait
= min_t(size_t, n
/ datum_size
, rb
->watermark
);
136 add_wait_queue(&rb
->pollq
, &wait
);
138 if (!indio_dev
->info
) {
143 if (!iio_buffer_ready(indio_dev
, rb
, to_wait
, n
/ datum_size
)) {
144 if (signal_pending(current
)) {
149 wait_woken(&wait
, TASK_INTERRUPTIBLE
,
150 MAX_SCHEDULE_TIMEOUT
);
154 ret
= rb
->access
->read_first_n(rb
, n
, buf
);
155 if (ret
== 0 && (filp
->f_flags
& O_NONBLOCK
))
158 remove_wait_queue(&rb
->pollq
, &wait
);
164 * iio_buffer_poll() - poll the buffer to find out if it has data
165 * @filp: File structure pointer for device access
166 * @wait: Poll table structure pointer for which the driver adds
169 * Return: (EPOLLIN | EPOLLRDNORM) if data is available for reading
170 * or 0 for other cases
172 __poll_t
iio_buffer_poll(struct file
*filp
,
173 struct poll_table_struct
*wait
)
175 struct iio_dev
*indio_dev
= filp
->private_data
;
176 struct iio_buffer
*rb
= indio_dev
->buffer
;
178 if (!indio_dev
->info
|| rb
== NULL
)
181 poll_wait(filp
, &rb
->pollq
, wait
);
182 if (iio_buffer_ready(indio_dev
, rb
, rb
->watermark
, 0))
183 return EPOLLIN
| EPOLLRDNORM
;
188 * iio_buffer_wakeup_poll - Wakes up the buffer waitqueue
189 * @indio_dev: The IIO device
191 * Wakes up the event waitqueue used for poll(). Should usually
192 * be called when the device is unregistered.
194 void iio_buffer_wakeup_poll(struct iio_dev
*indio_dev
)
196 if (!indio_dev
->buffer
)
199 wake_up(&indio_dev
->buffer
->pollq
);
202 void iio_buffer_init(struct iio_buffer
*buffer
)
204 INIT_LIST_HEAD(&buffer
->demux_list
);
205 INIT_LIST_HEAD(&buffer
->buffer_list
);
206 init_waitqueue_head(&buffer
->pollq
);
207 kref_init(&buffer
->ref
);
208 if (!buffer
->watermark
)
209 buffer
->watermark
= 1;
211 EXPORT_SYMBOL(iio_buffer_init
);
214 * iio_buffer_set_attrs - Set buffer specific attributes
215 * @buffer: The buffer for which we are setting attributes
216 * @attrs: Pointer to a null terminated list of pointers to attributes
218 void iio_buffer_set_attrs(struct iio_buffer
*buffer
,
219 const struct attribute
**attrs
)
221 buffer
->attrs
= attrs
;
223 EXPORT_SYMBOL_GPL(iio_buffer_set_attrs
);
225 static ssize_t
iio_show_scan_index(struct device
*dev
,
226 struct device_attribute
*attr
,
229 return sprintf(buf
, "%u\n", to_iio_dev_attr(attr
)->c
->scan_index
);
232 static ssize_t
iio_show_fixed_type(struct device
*dev
,
233 struct device_attribute
*attr
,
236 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
237 u8 type
= this_attr
->c
->scan_type
.endianness
;
239 if (type
== IIO_CPU
) {
240 #ifdef __LITTLE_ENDIAN
246 if (this_attr
->c
->scan_type
.repeat
> 1)
247 return sprintf(buf
, "%s:%c%d/%dX%d>>%u\n",
248 iio_endian_prefix
[type
],
249 this_attr
->c
->scan_type
.sign
,
250 this_attr
->c
->scan_type
.realbits
,
251 this_attr
->c
->scan_type
.storagebits
,
252 this_attr
->c
->scan_type
.repeat
,
253 this_attr
->c
->scan_type
.shift
);
255 return sprintf(buf
, "%s:%c%d/%d>>%u\n",
256 iio_endian_prefix
[type
],
257 this_attr
->c
->scan_type
.sign
,
258 this_attr
->c
->scan_type
.realbits
,
259 this_attr
->c
->scan_type
.storagebits
,
260 this_attr
->c
->scan_type
.shift
);
263 static ssize_t
iio_scan_el_show(struct device
*dev
,
264 struct device_attribute
*attr
,
268 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
270 /* Ensure ret is 0 or 1. */
271 ret
= !!test_bit(to_iio_dev_attr(attr
)->address
,
272 indio_dev
->buffer
->scan_mask
);
274 return sprintf(buf
, "%d\n", ret
);
277 /* Note NULL used as error indicator as it doesn't make sense. */
278 static const unsigned long *iio_scan_mask_match(const unsigned long *av_masks
,
279 unsigned int masklength
,
280 const unsigned long *mask
,
283 if (bitmap_empty(mask
, masklength
))
287 if (bitmap_equal(mask
, av_masks
, masklength
))
290 if (bitmap_subset(mask
, av_masks
, masklength
))
293 av_masks
+= BITS_TO_LONGS(masklength
);
298 static bool iio_validate_scan_mask(struct iio_dev
*indio_dev
,
299 const unsigned long *mask
)
301 if (!indio_dev
->setup_ops
->validate_scan_mask
)
304 return indio_dev
->setup_ops
->validate_scan_mask(indio_dev
, mask
);
308 * iio_scan_mask_set() - set particular bit in the scan mask
309 * @indio_dev: the iio device
310 * @buffer: the buffer whose scan mask we are interested in
311 * @bit: the bit to be set.
313 * Note that at this point we have no way of knowing what other
314 * buffers might request, hence this code only verifies that the
315 * individual buffers request is plausible.
317 static int iio_scan_mask_set(struct iio_dev
*indio_dev
,
318 struct iio_buffer
*buffer
, int bit
)
320 const unsigned long *mask
;
321 unsigned long *trialmask
;
323 trialmask
= kmalloc_array(BITS_TO_LONGS(indio_dev
->masklength
),
326 if (trialmask
== NULL
)
328 if (!indio_dev
->masklength
) {
329 WARN(1, "Trying to set scanmask prior to registering buffer\n");
330 goto err_invalid_mask
;
332 bitmap_copy(trialmask
, buffer
->scan_mask
, indio_dev
->masklength
);
333 set_bit(bit
, trialmask
);
335 if (!iio_validate_scan_mask(indio_dev
, trialmask
))
336 goto err_invalid_mask
;
338 if (indio_dev
->available_scan_masks
) {
339 mask
= iio_scan_mask_match(indio_dev
->available_scan_masks
,
340 indio_dev
->masklength
,
343 goto err_invalid_mask
;
345 bitmap_copy(buffer
->scan_mask
, trialmask
, indio_dev
->masklength
);
356 static int iio_scan_mask_clear(struct iio_buffer
*buffer
, int bit
)
358 clear_bit(bit
, buffer
->scan_mask
);
362 static int iio_scan_mask_query(struct iio_dev
*indio_dev
,
363 struct iio_buffer
*buffer
, int bit
)
365 if (bit
> indio_dev
->masklength
)
368 if (!buffer
->scan_mask
)
371 /* Ensure return value is 0 or 1. */
372 return !!test_bit(bit
, buffer
->scan_mask
);
375 static ssize_t
iio_scan_el_store(struct device
*dev
,
376 struct device_attribute
*attr
,
382 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
383 struct iio_buffer
*buffer
= indio_dev
->buffer
;
384 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
386 ret
= strtobool(buf
, &state
);
389 mutex_lock(&indio_dev
->mlock
);
390 if (iio_buffer_is_active(indio_dev
->buffer
)) {
394 ret
= iio_scan_mask_query(indio_dev
, buffer
, this_attr
->address
);
398 ret
= iio_scan_mask_clear(buffer
, this_attr
->address
);
401 } else if (state
&& !ret
) {
402 ret
= iio_scan_mask_set(indio_dev
, buffer
, this_attr
->address
);
408 mutex_unlock(&indio_dev
->mlock
);
410 return ret
< 0 ? ret
: len
;
414 static ssize_t
iio_scan_el_ts_show(struct device
*dev
,
415 struct device_attribute
*attr
,
418 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
419 return sprintf(buf
, "%d\n", indio_dev
->buffer
->scan_timestamp
);
422 static ssize_t
iio_scan_el_ts_store(struct device
*dev
,
423 struct device_attribute
*attr
,
428 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
431 ret
= strtobool(buf
, &state
);
435 mutex_lock(&indio_dev
->mlock
);
436 if (iio_buffer_is_active(indio_dev
->buffer
)) {
440 indio_dev
->buffer
->scan_timestamp
= state
;
442 mutex_unlock(&indio_dev
->mlock
);
444 return ret
? ret
: len
;
447 static int iio_buffer_add_channel_sysfs(struct iio_dev
*indio_dev
,
448 const struct iio_chan_spec
*chan
)
450 int ret
, attrcount
= 0;
451 struct iio_buffer
*buffer
= indio_dev
->buffer
;
453 ret
= __iio_add_chan_devattr("index",
455 &iio_show_scan_index
,
460 &buffer
->scan_el_dev_attr_list
);
464 ret
= __iio_add_chan_devattr("type",
466 &iio_show_fixed_type
,
471 &buffer
->scan_el_dev_attr_list
);
475 if (chan
->type
!= IIO_TIMESTAMP
)
476 ret
= __iio_add_chan_devattr("en",
483 &buffer
->scan_el_dev_attr_list
);
485 ret
= __iio_add_chan_devattr("en",
487 &iio_scan_el_ts_show
,
488 &iio_scan_el_ts_store
,
492 &buffer
->scan_el_dev_attr_list
);
500 static ssize_t
iio_buffer_read_length(struct device
*dev
,
501 struct device_attribute
*attr
,
504 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
505 struct iio_buffer
*buffer
= indio_dev
->buffer
;
507 return sprintf(buf
, "%d\n", buffer
->length
);
510 static ssize_t
iio_buffer_write_length(struct device
*dev
,
511 struct device_attribute
*attr
,
512 const char *buf
, size_t len
)
514 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
515 struct iio_buffer
*buffer
= indio_dev
->buffer
;
519 ret
= kstrtouint(buf
, 10, &val
);
523 if (val
== buffer
->length
)
526 mutex_lock(&indio_dev
->mlock
);
527 if (iio_buffer_is_active(indio_dev
->buffer
)) {
530 buffer
->access
->set_length(buffer
, val
);
535 if (buffer
->length
&& buffer
->length
< buffer
->watermark
)
536 buffer
->watermark
= buffer
->length
;
538 mutex_unlock(&indio_dev
->mlock
);
540 return ret
? ret
: len
;
543 static ssize_t
iio_buffer_show_enable(struct device
*dev
,
544 struct device_attribute
*attr
,
547 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
548 return sprintf(buf
, "%d\n", iio_buffer_is_active(indio_dev
->buffer
));
551 static unsigned int iio_storage_bytes_for_si(struct iio_dev
*indio_dev
,
552 unsigned int scan_index
)
554 const struct iio_chan_spec
*ch
;
557 ch
= iio_find_channel_from_si(indio_dev
, scan_index
);
558 bytes
= ch
->scan_type
.storagebits
/ 8;
559 if (ch
->scan_type
.repeat
> 1)
560 bytes
*= ch
->scan_type
.repeat
;
564 static unsigned int iio_storage_bytes_for_timestamp(struct iio_dev
*indio_dev
)
566 return iio_storage_bytes_for_si(indio_dev
,
567 indio_dev
->scan_index_timestamp
);
570 static int iio_compute_scan_bytes(struct iio_dev
*indio_dev
,
571 const unsigned long *mask
, bool timestamp
)
576 /* How much space will the demuxed element take? */
577 for_each_set_bit(i
, mask
,
578 indio_dev
->masklength
) {
579 length
= iio_storage_bytes_for_si(indio_dev
, i
);
580 bytes
= ALIGN(bytes
, length
);
585 length
= iio_storage_bytes_for_timestamp(indio_dev
);
586 bytes
= ALIGN(bytes
, length
);
592 static void iio_buffer_activate(struct iio_dev
*indio_dev
,
593 struct iio_buffer
*buffer
)
595 iio_buffer_get(buffer
);
596 list_add(&buffer
->buffer_list
, &indio_dev
->buffer_list
);
599 static void iio_buffer_deactivate(struct iio_buffer
*buffer
)
601 list_del_init(&buffer
->buffer_list
);
602 wake_up_interruptible(&buffer
->pollq
);
603 iio_buffer_put(buffer
);
606 static void iio_buffer_deactivate_all(struct iio_dev
*indio_dev
)
608 struct iio_buffer
*buffer
, *_buffer
;
610 list_for_each_entry_safe(buffer
, _buffer
,
611 &indio_dev
->buffer_list
, buffer_list
)
612 iio_buffer_deactivate(buffer
);
615 static int iio_buffer_enable(struct iio_buffer
*buffer
,
616 struct iio_dev
*indio_dev
)
618 if (!buffer
->access
->enable
)
620 return buffer
->access
->enable(buffer
, indio_dev
);
623 static int iio_buffer_disable(struct iio_buffer
*buffer
,
624 struct iio_dev
*indio_dev
)
626 if (!buffer
->access
->disable
)
628 return buffer
->access
->disable(buffer
, indio_dev
);
631 static void iio_buffer_update_bytes_per_datum(struct iio_dev
*indio_dev
,
632 struct iio_buffer
*buffer
)
636 if (!buffer
->access
->set_bytes_per_datum
)
639 bytes
= iio_compute_scan_bytes(indio_dev
, buffer
->scan_mask
,
640 buffer
->scan_timestamp
);
642 buffer
->access
->set_bytes_per_datum(buffer
, bytes
);
645 static int iio_buffer_request_update(struct iio_dev
*indio_dev
,
646 struct iio_buffer
*buffer
)
650 iio_buffer_update_bytes_per_datum(indio_dev
, buffer
);
651 if (buffer
->access
->request_update
) {
652 ret
= buffer
->access
->request_update(buffer
);
654 dev_dbg(&indio_dev
->dev
,
655 "Buffer not started: buffer parameter update failed (%d)\n",
664 static void iio_free_scan_mask(struct iio_dev
*indio_dev
,
665 const unsigned long *mask
)
667 /* If the mask is dynamically allocated free it, otherwise do nothing */
668 if (!indio_dev
->available_scan_masks
)
672 struct iio_device_config
{
674 unsigned int watermark
;
675 const unsigned long *scan_mask
;
676 unsigned int scan_bytes
;
680 static int iio_verify_update(struct iio_dev
*indio_dev
,
681 struct iio_buffer
*insert_buffer
, struct iio_buffer
*remove_buffer
,
682 struct iio_device_config
*config
)
684 unsigned long *compound_mask
;
685 const unsigned long *scan_mask
;
686 bool strict_scanmask
= false;
687 struct iio_buffer
*buffer
;
691 memset(config
, 0, sizeof(*config
));
692 config
->watermark
= ~0;
695 * If there is just one buffer and we are removing it there is nothing
698 if (remove_buffer
&& !insert_buffer
&&
699 list_is_singular(&indio_dev
->buffer_list
))
702 modes
= indio_dev
->modes
;
704 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
705 if (buffer
== remove_buffer
)
707 modes
&= buffer
->access
->modes
;
708 config
->watermark
= min(config
->watermark
, buffer
->watermark
);
712 modes
&= insert_buffer
->access
->modes
;
713 config
->watermark
= min(config
->watermark
,
714 insert_buffer
->watermark
);
717 /* Definitely possible for devices to support both of these. */
718 if ((modes
& INDIO_BUFFER_TRIGGERED
) && indio_dev
->trig
) {
719 config
->mode
= INDIO_BUFFER_TRIGGERED
;
720 } else if (modes
& INDIO_BUFFER_HARDWARE
) {
722 * Keep things simple for now and only allow a single buffer to
723 * be connected in hardware mode.
725 if (insert_buffer
&& !list_empty(&indio_dev
->buffer_list
))
727 config
->mode
= INDIO_BUFFER_HARDWARE
;
728 strict_scanmask
= true;
729 } else if (modes
& INDIO_BUFFER_SOFTWARE
) {
730 config
->mode
= INDIO_BUFFER_SOFTWARE
;
732 /* Can only occur on first buffer */
733 if (indio_dev
->modes
& INDIO_BUFFER_TRIGGERED
)
734 dev_dbg(&indio_dev
->dev
, "Buffer not started: no trigger\n");
738 /* What scan mask do we actually have? */
739 compound_mask
= kcalloc(BITS_TO_LONGS(indio_dev
->masklength
),
740 sizeof(long), GFP_KERNEL
);
741 if (compound_mask
== NULL
)
744 scan_timestamp
= false;
746 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
747 if (buffer
== remove_buffer
)
749 bitmap_or(compound_mask
, compound_mask
, buffer
->scan_mask
,
750 indio_dev
->masklength
);
751 scan_timestamp
|= buffer
->scan_timestamp
;
755 bitmap_or(compound_mask
, compound_mask
,
756 insert_buffer
->scan_mask
, indio_dev
->masklength
);
757 scan_timestamp
|= insert_buffer
->scan_timestamp
;
760 if (indio_dev
->available_scan_masks
) {
761 scan_mask
= iio_scan_mask_match(indio_dev
->available_scan_masks
,
762 indio_dev
->masklength
,
765 kfree(compound_mask
);
766 if (scan_mask
== NULL
)
769 scan_mask
= compound_mask
;
772 config
->scan_bytes
= iio_compute_scan_bytes(indio_dev
,
773 scan_mask
, scan_timestamp
);
774 config
->scan_mask
= scan_mask
;
775 config
->scan_timestamp
= scan_timestamp
;
781 * struct iio_demux_table - table describing demux memcpy ops
782 * @from: index to copy from
783 * @to: index to copy to
784 * @length: how many bytes to copy
785 * @l: list head used for management
787 struct iio_demux_table
{
794 static void iio_buffer_demux_free(struct iio_buffer
*buffer
)
796 struct iio_demux_table
*p
, *q
;
797 list_for_each_entry_safe(p
, q
, &buffer
->demux_list
, l
) {
803 static int iio_buffer_add_demux(struct iio_buffer
*buffer
,
804 struct iio_demux_table
**p
, unsigned int in_loc
, unsigned int out_loc
,
808 if (*p
&& (*p
)->from
+ (*p
)->length
== in_loc
&&
809 (*p
)->to
+ (*p
)->length
== out_loc
) {
810 (*p
)->length
+= length
;
812 *p
= kmalloc(sizeof(**p
), GFP_KERNEL
);
817 (*p
)->length
= length
;
818 list_add_tail(&(*p
)->l
, &buffer
->demux_list
);
824 static int iio_buffer_update_demux(struct iio_dev
*indio_dev
,
825 struct iio_buffer
*buffer
)
827 int ret
, in_ind
= -1, out_ind
, length
;
828 unsigned in_loc
= 0, out_loc
= 0;
829 struct iio_demux_table
*p
= NULL
;
831 /* Clear out any old demux */
832 iio_buffer_demux_free(buffer
);
833 kfree(buffer
->demux_bounce
);
834 buffer
->demux_bounce
= NULL
;
836 /* First work out which scan mode we will actually have */
837 if (bitmap_equal(indio_dev
->active_scan_mask
,
839 indio_dev
->masklength
))
842 /* Now we have the two masks, work from least sig and build up sizes */
843 for_each_set_bit(out_ind
,
845 indio_dev
->masklength
) {
846 in_ind
= find_next_bit(indio_dev
->active_scan_mask
,
847 indio_dev
->masklength
,
849 while (in_ind
!= out_ind
) {
850 in_ind
= find_next_bit(indio_dev
->active_scan_mask
,
851 indio_dev
->masklength
,
853 length
= iio_storage_bytes_for_si(indio_dev
, in_ind
);
854 /* Make sure we are aligned */
855 in_loc
= roundup(in_loc
, length
) + length
;
857 length
= iio_storage_bytes_for_si(indio_dev
, in_ind
);
858 out_loc
= roundup(out_loc
, length
);
859 in_loc
= roundup(in_loc
, length
);
860 ret
= iio_buffer_add_demux(buffer
, &p
, in_loc
, out_loc
, length
);
862 goto error_clear_mux_table
;
866 /* Relies on scan_timestamp being last */
867 if (buffer
->scan_timestamp
) {
868 length
= iio_storage_bytes_for_timestamp(indio_dev
);
869 out_loc
= roundup(out_loc
, length
);
870 in_loc
= roundup(in_loc
, length
);
871 ret
= iio_buffer_add_demux(buffer
, &p
, in_loc
, out_loc
, length
);
873 goto error_clear_mux_table
;
877 buffer
->demux_bounce
= kzalloc(out_loc
, GFP_KERNEL
);
878 if (buffer
->demux_bounce
== NULL
) {
880 goto error_clear_mux_table
;
884 error_clear_mux_table
:
885 iio_buffer_demux_free(buffer
);
890 static int iio_update_demux(struct iio_dev
*indio_dev
)
892 struct iio_buffer
*buffer
;
895 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
896 ret
= iio_buffer_update_demux(indio_dev
, buffer
);
898 goto error_clear_mux_table
;
902 error_clear_mux_table
:
903 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
)
904 iio_buffer_demux_free(buffer
);
909 static int iio_enable_buffers(struct iio_dev
*indio_dev
,
910 struct iio_device_config
*config
)
912 struct iio_buffer
*buffer
;
915 indio_dev
->active_scan_mask
= config
->scan_mask
;
916 indio_dev
->scan_timestamp
= config
->scan_timestamp
;
917 indio_dev
->scan_bytes
= config
->scan_bytes
;
919 iio_update_demux(indio_dev
);
922 if (indio_dev
->setup_ops
->preenable
) {
923 ret
= indio_dev
->setup_ops
->preenable(indio_dev
);
925 dev_dbg(&indio_dev
->dev
,
926 "Buffer not started: buffer preenable failed (%d)\n", ret
);
927 goto err_undo_config
;
931 if (indio_dev
->info
->update_scan_mode
) {
932 ret
= indio_dev
->info
933 ->update_scan_mode(indio_dev
,
934 indio_dev
->active_scan_mask
);
936 dev_dbg(&indio_dev
->dev
,
937 "Buffer not started: update scan mode failed (%d)\n",
939 goto err_run_postdisable
;
943 if (indio_dev
->info
->hwfifo_set_watermark
)
944 indio_dev
->info
->hwfifo_set_watermark(indio_dev
,
947 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
948 ret
= iio_buffer_enable(buffer
, indio_dev
);
950 goto err_disable_buffers
;
953 indio_dev
->currentmode
= config
->mode
;
955 if (indio_dev
->setup_ops
->postenable
) {
956 ret
= indio_dev
->setup_ops
->postenable(indio_dev
);
958 dev_dbg(&indio_dev
->dev
,
959 "Buffer not started: postenable failed (%d)\n", ret
);
960 goto err_disable_buffers
;
967 list_for_each_entry_continue_reverse(buffer
, &indio_dev
->buffer_list
,
969 iio_buffer_disable(buffer
, indio_dev
);
971 indio_dev
->currentmode
= INDIO_DIRECT_MODE
;
972 if (indio_dev
->setup_ops
->postdisable
)
973 indio_dev
->setup_ops
->postdisable(indio_dev
);
975 indio_dev
->active_scan_mask
= NULL
;
980 static int iio_disable_buffers(struct iio_dev
*indio_dev
)
982 struct iio_buffer
*buffer
;
986 /* Wind down existing buffers - iff there are any */
987 if (list_empty(&indio_dev
->buffer_list
))
991 * If things go wrong at some step in disable we still need to continue
992 * to perform the other steps, otherwise we leave the device in a
993 * inconsistent state. We return the error code for the first error we
997 if (indio_dev
->setup_ops
->predisable
) {
998 ret2
= indio_dev
->setup_ops
->predisable(indio_dev
);
1003 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
1004 ret2
= iio_buffer_disable(buffer
, indio_dev
);
1009 indio_dev
->currentmode
= INDIO_DIRECT_MODE
;
1011 if (indio_dev
->setup_ops
->postdisable
) {
1012 ret2
= indio_dev
->setup_ops
->postdisable(indio_dev
);
1017 iio_free_scan_mask(indio_dev
, indio_dev
->active_scan_mask
);
1018 indio_dev
->active_scan_mask
= NULL
;
1023 static int __iio_update_buffers(struct iio_dev
*indio_dev
,
1024 struct iio_buffer
*insert_buffer
,
1025 struct iio_buffer
*remove_buffer
)
1027 struct iio_device_config new_config
;
1030 ret
= iio_verify_update(indio_dev
, insert_buffer
, remove_buffer
,
1035 if (insert_buffer
) {
1036 ret
= iio_buffer_request_update(indio_dev
, insert_buffer
);
1038 goto err_free_config
;
1041 ret
= iio_disable_buffers(indio_dev
);
1043 goto err_deactivate_all
;
1046 iio_buffer_deactivate(remove_buffer
);
1048 iio_buffer_activate(indio_dev
, insert_buffer
);
1050 /* If no buffers in list, we are done */
1051 if (list_empty(&indio_dev
->buffer_list
))
1054 ret
= iio_enable_buffers(indio_dev
, &new_config
);
1056 goto err_deactivate_all
;
1062 * We've already verified that the config is valid earlier. If things go
1063 * wrong in either enable or disable the most likely reason is an IO
1064 * error from the device. In this case there is no good recovery
1065 * strategy. Just make sure to disable everything and leave the device
1066 * in a sane state. With a bit of luck the device might come back to
1067 * life again later and userspace can try again.
1069 iio_buffer_deactivate_all(indio_dev
);
1072 iio_free_scan_mask(indio_dev
, new_config
.scan_mask
);
1076 int iio_update_buffers(struct iio_dev
*indio_dev
,
1077 struct iio_buffer
*insert_buffer
,
1078 struct iio_buffer
*remove_buffer
)
1082 if (insert_buffer
== remove_buffer
)
1085 mutex_lock(&indio_dev
->info_exist_lock
);
1086 mutex_lock(&indio_dev
->mlock
);
1088 if (insert_buffer
&& iio_buffer_is_active(insert_buffer
))
1089 insert_buffer
= NULL
;
1091 if (remove_buffer
&& !iio_buffer_is_active(remove_buffer
))
1092 remove_buffer
= NULL
;
1094 if (!insert_buffer
&& !remove_buffer
) {
1099 if (indio_dev
->info
== NULL
) {
1104 ret
= __iio_update_buffers(indio_dev
, insert_buffer
, remove_buffer
);
1107 mutex_unlock(&indio_dev
->mlock
);
1108 mutex_unlock(&indio_dev
->info_exist_lock
);
1112 EXPORT_SYMBOL_GPL(iio_update_buffers
);
1114 void iio_disable_all_buffers(struct iio_dev
*indio_dev
)
1116 iio_disable_buffers(indio_dev
);
1117 iio_buffer_deactivate_all(indio_dev
);
1120 static ssize_t
iio_buffer_store_enable(struct device
*dev
,
1121 struct device_attribute
*attr
,
1126 bool requested_state
;
1127 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
1130 ret
= strtobool(buf
, &requested_state
);
1134 mutex_lock(&indio_dev
->mlock
);
1136 /* Find out if it is in the list */
1137 inlist
= iio_buffer_is_active(indio_dev
->buffer
);
1138 /* Already in desired state */
1139 if (inlist
== requested_state
)
1142 if (requested_state
)
1143 ret
= __iio_update_buffers(indio_dev
,
1144 indio_dev
->buffer
, NULL
);
1146 ret
= __iio_update_buffers(indio_dev
,
1147 NULL
, indio_dev
->buffer
);
1150 mutex_unlock(&indio_dev
->mlock
);
1151 return (ret
< 0) ? ret
: len
;
1154 static const char * const iio_scan_elements_group_name
= "scan_elements";
1156 static ssize_t
iio_buffer_show_watermark(struct device
*dev
,
1157 struct device_attribute
*attr
,
1160 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
1161 struct iio_buffer
*buffer
= indio_dev
->buffer
;
1163 return sprintf(buf
, "%u\n", buffer
->watermark
);
1166 static ssize_t
iio_buffer_store_watermark(struct device
*dev
,
1167 struct device_attribute
*attr
,
1171 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
1172 struct iio_buffer
*buffer
= indio_dev
->buffer
;
1176 ret
= kstrtouint(buf
, 10, &val
);
1182 mutex_lock(&indio_dev
->mlock
);
1184 if (val
> buffer
->length
) {
1189 if (iio_buffer_is_active(indio_dev
->buffer
)) {
1194 buffer
->watermark
= val
;
1196 mutex_unlock(&indio_dev
->mlock
);
1198 return ret
? ret
: len
;
1201 static ssize_t
iio_dma_show_data_available(struct device
*dev
,
1202 struct device_attribute
*attr
,
1205 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
1208 bytes
= iio_buffer_data_available(indio_dev
->buffer
);
1210 return sprintf(buf
, "%zu\n", bytes
);
1213 static DEVICE_ATTR(length
, S_IRUGO
| S_IWUSR
, iio_buffer_read_length
,
1214 iio_buffer_write_length
);
1215 static struct device_attribute dev_attr_length_ro
= __ATTR(length
,
1216 S_IRUGO
, iio_buffer_read_length
, NULL
);
1217 static DEVICE_ATTR(enable
, S_IRUGO
| S_IWUSR
,
1218 iio_buffer_show_enable
, iio_buffer_store_enable
);
1219 static DEVICE_ATTR(watermark
, S_IRUGO
| S_IWUSR
,
1220 iio_buffer_show_watermark
, iio_buffer_store_watermark
);
1221 static struct device_attribute dev_attr_watermark_ro
= __ATTR(watermark
,
1222 S_IRUGO
, iio_buffer_show_watermark
, NULL
);
1223 static DEVICE_ATTR(data_available
, S_IRUGO
,
1224 iio_dma_show_data_available
, NULL
);
1226 static struct attribute
*iio_buffer_attrs
[] = {
1227 &dev_attr_length
.attr
,
1228 &dev_attr_enable
.attr
,
1229 &dev_attr_watermark
.attr
,
1230 &dev_attr_data_available
.attr
,
1233 int iio_buffer_alloc_sysfs_and_mask(struct iio_dev
*indio_dev
)
1235 struct iio_dev_attr
*p
;
1236 struct attribute
**attr
;
1237 struct iio_buffer
*buffer
= indio_dev
->buffer
;
1238 int ret
, i
, attrn
, attrcount
, attrcount_orig
= 0;
1239 const struct iio_chan_spec
*channels
;
1241 channels
= indio_dev
->channels
;
1243 int ml
= indio_dev
->masklength
;
1245 for (i
= 0; i
< indio_dev
->num_channels
; i
++)
1246 ml
= max(ml
, channels
[i
].scan_index
+ 1);
1247 indio_dev
->masklength
= ml
;
1254 if (buffer
->attrs
) {
1255 while (buffer
->attrs
[attrcount
] != NULL
)
1259 attr
= kcalloc(attrcount
+ ARRAY_SIZE(iio_buffer_attrs
) + 1,
1260 sizeof(struct attribute
*), GFP_KERNEL
);
1264 memcpy(attr
, iio_buffer_attrs
, sizeof(iio_buffer_attrs
));
1265 if (!buffer
->access
->set_length
)
1266 attr
[0] = &dev_attr_length_ro
.attr
;
1268 if (buffer
->access
->flags
& INDIO_BUFFER_FLAG_FIXED_WATERMARK
)
1269 attr
[2] = &dev_attr_watermark_ro
.attr
;
1272 memcpy(&attr
[ARRAY_SIZE(iio_buffer_attrs
)], buffer
->attrs
,
1273 sizeof(struct attribute
*) * attrcount
);
1275 attr
[attrcount
+ ARRAY_SIZE(iio_buffer_attrs
)] = NULL
;
1277 buffer
->buffer_group
.name
= "buffer";
1278 buffer
->buffer_group
.attrs
= attr
;
1280 indio_dev
->groups
[indio_dev
->groupcounter
++] = &buffer
->buffer_group
;
1282 if (buffer
->scan_el_attrs
!= NULL
) {
1283 attr
= buffer
->scan_el_attrs
->attrs
;
1284 while (*attr
++ != NULL
)
1287 attrcount
= attrcount_orig
;
1288 INIT_LIST_HEAD(&buffer
->scan_el_dev_attr_list
);
1289 channels
= indio_dev
->channels
;
1292 for (i
= 0; i
< indio_dev
->num_channels
; i
++) {
1293 if (channels
[i
].scan_index
< 0)
1296 ret
= iio_buffer_add_channel_sysfs(indio_dev
,
1299 goto error_cleanup_dynamic
;
1301 if (channels
[i
].type
== IIO_TIMESTAMP
)
1302 indio_dev
->scan_index_timestamp
=
1303 channels
[i
].scan_index
;
1305 if (indio_dev
->masklength
&& buffer
->scan_mask
== NULL
) {
1306 buffer
->scan_mask
= kcalloc(BITS_TO_LONGS(indio_dev
->masklength
),
1307 sizeof(*buffer
->scan_mask
),
1309 if (buffer
->scan_mask
== NULL
) {
1311 goto error_cleanup_dynamic
;
1316 buffer
->scan_el_group
.name
= iio_scan_elements_group_name
;
1318 buffer
->scan_el_group
.attrs
= kcalloc(attrcount
+ 1,
1319 sizeof(buffer
->scan_el_group
.attrs
[0]),
1321 if (buffer
->scan_el_group
.attrs
== NULL
) {
1323 goto error_free_scan_mask
;
1325 if (buffer
->scan_el_attrs
)
1326 memcpy(buffer
->scan_el_group
.attrs
, buffer
->scan_el_attrs
,
1327 sizeof(buffer
->scan_el_group
.attrs
[0])*attrcount_orig
);
1328 attrn
= attrcount_orig
;
1330 list_for_each_entry(p
, &buffer
->scan_el_dev_attr_list
, l
)
1331 buffer
->scan_el_group
.attrs
[attrn
++] = &p
->dev_attr
.attr
;
1332 indio_dev
->groups
[indio_dev
->groupcounter
++] = &buffer
->scan_el_group
;
1336 error_free_scan_mask
:
1337 kfree(buffer
->scan_mask
);
1338 error_cleanup_dynamic
:
1339 iio_free_chan_devattr_list(&buffer
->scan_el_dev_attr_list
);
1340 kfree(indio_dev
->buffer
->buffer_group
.attrs
);
1345 void iio_buffer_free_sysfs_and_mask(struct iio_dev
*indio_dev
)
1347 if (!indio_dev
->buffer
)
1350 kfree(indio_dev
->buffer
->scan_mask
);
1351 kfree(indio_dev
->buffer
->buffer_group
.attrs
);
1352 kfree(indio_dev
->buffer
->scan_el_group
.attrs
);
1353 iio_free_chan_devattr_list(&indio_dev
->buffer
->scan_el_dev_attr_list
);
1357 * iio_validate_scan_mask_onehot() - Validates that exactly one channel is selected
1358 * @indio_dev: the iio device
1359 * @mask: scan mask to be checked
1361 * Return true if exactly one bit is set in the scan mask, false otherwise. It
1362 * can be used for devices where only one channel can be active for sampling at
1365 bool iio_validate_scan_mask_onehot(struct iio_dev
*indio_dev
,
1366 const unsigned long *mask
)
1368 return bitmap_weight(mask
, indio_dev
->masklength
) == 1;
1370 EXPORT_SYMBOL_GPL(iio_validate_scan_mask_onehot
);
1372 static const void *iio_demux(struct iio_buffer
*buffer
,
1375 struct iio_demux_table
*t
;
1377 if (list_empty(&buffer
->demux_list
))
1379 list_for_each_entry(t
, &buffer
->demux_list
, l
)
1380 memcpy(buffer
->demux_bounce
+ t
->to
,
1381 datain
+ t
->from
, t
->length
);
1383 return buffer
->demux_bounce
;
1386 static int iio_push_to_buffer(struct iio_buffer
*buffer
, const void *data
)
1388 const void *dataout
= iio_demux(buffer
, data
);
1391 ret
= buffer
->access
->store_to(buffer
, dataout
);
1396 * We can't just test for watermark to decide if we wake the poll queue
1397 * because read may request less samples than the watermark.
1399 wake_up_interruptible_poll(&buffer
->pollq
, EPOLLIN
| EPOLLRDNORM
);
1404 * iio_push_to_buffers() - push to a registered buffer.
1405 * @indio_dev: iio_dev structure for device.
1408 int iio_push_to_buffers(struct iio_dev
*indio_dev
, const void *data
)
1411 struct iio_buffer
*buf
;
1413 list_for_each_entry(buf
, &indio_dev
->buffer_list
, buffer_list
) {
1414 ret
= iio_push_to_buffer(buf
, data
);
1421 EXPORT_SYMBOL_GPL(iio_push_to_buffers
);
1424 * iio_buffer_release() - Free a buffer's resources
1425 * @ref: Pointer to the kref embedded in the iio_buffer struct
1427 * This function is called when the last reference to the buffer has been
1428 * dropped. It will typically free all resources allocated by the buffer. Do not
1429 * call this function manually, always use iio_buffer_put() when done using a
1432 static void iio_buffer_release(struct kref
*ref
)
1434 struct iio_buffer
*buffer
= container_of(ref
, struct iio_buffer
, ref
);
1436 buffer
->access
->release(buffer
);
1440 * iio_buffer_get() - Grab a reference to the buffer
1441 * @buffer: The buffer to grab a reference for, may be NULL
1443 * Returns the pointer to the buffer that was passed into the function.
1445 struct iio_buffer
*iio_buffer_get(struct iio_buffer
*buffer
)
1448 kref_get(&buffer
->ref
);
1452 EXPORT_SYMBOL_GPL(iio_buffer_get
);
1455 * iio_buffer_put() - Release the reference to the buffer
1456 * @buffer: The buffer to release the reference for, may be NULL
1458 void iio_buffer_put(struct iio_buffer
*buffer
)
1461 kref_put(&buffer
->ref
, iio_buffer_release
);
1463 EXPORT_SYMBOL_GPL(iio_buffer_put
);
1466 * iio_device_attach_buffer - Attach a buffer to a IIO device
1467 * @indio_dev: The device the buffer should be attached to
1468 * @buffer: The buffer to attach to the device
1470 * This function attaches a buffer to a IIO device. The buffer stays attached to
1471 * the device until the device is freed. The function should only be called at
1472 * most once per device.
1474 void iio_device_attach_buffer(struct iio_dev
*indio_dev
,
1475 struct iio_buffer
*buffer
)
1477 indio_dev
->buffer
= iio_buffer_get(buffer
);
1479 EXPORT_SYMBOL_GPL(iio_device_attach_buffer
);