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.h>
25 #include <linux/iio/iio.h>
27 #include <linux/iio/sysfs.h>
28 #include <linux/iio/buffer.h>
30 static const char * const iio_endian_prefix
[] = {
35 static bool iio_buffer_is_active(struct iio_buffer
*buf
)
37 return !list_empty(&buf
->buffer_list
);
40 static size_t iio_buffer_data_available(struct iio_buffer
*buf
)
42 return buf
->access
->data_available(buf
);
45 static int iio_buffer_flush_hwfifo(struct iio_dev
*indio_dev
,
46 struct iio_buffer
*buf
, size_t required
)
48 if (!indio_dev
->info
->hwfifo_flush_to_buffer
)
51 return indio_dev
->info
->hwfifo_flush_to_buffer(indio_dev
, required
);
54 static bool iio_buffer_ready(struct iio_dev
*indio_dev
, struct iio_buffer
*buf
,
55 size_t to_wait
, int to_flush
)
60 /* wakeup if the device was unregistered */
64 /* drain the buffer if it was disabled */
65 if (!iio_buffer_is_active(buf
)) {
66 to_wait
= min_t(size_t, to_wait
, 1);
70 avail
= iio_buffer_data_available(buf
);
72 if (avail
>= to_wait
) {
73 /* force a flush for non-blocking reads */
74 if (!to_wait
&& avail
< to_flush
)
75 iio_buffer_flush_hwfifo(indio_dev
, buf
,
81 flushed
= iio_buffer_flush_hwfifo(indio_dev
, buf
,
86 if (avail
+ flushed
>= to_wait
)
93 * iio_buffer_read_first_n_outer() - chrdev read for buffer access
94 * @filp: File structure pointer for the char device
95 * @buf: Destination buffer for iio buffer read
96 * @n: First n bytes to read
97 * @f_ps: Long offset provided by the user as a seek position
99 * This function relies on all buffer implementations having an
100 * iio_buffer as their first element.
102 * Return: negative values corresponding to error codes or ret != 0
103 * for ending the reading activity
105 ssize_t
iio_buffer_read_first_n_outer(struct file
*filp
, char __user
*buf
,
106 size_t n
, loff_t
*f_ps
)
108 struct iio_dev
*indio_dev
= filp
->private_data
;
109 struct iio_buffer
*rb
= indio_dev
->buffer
;
114 if (!indio_dev
->info
)
117 if (!rb
|| !rb
->access
->read_first_n
)
120 datum_size
= rb
->bytes_per_datum
;
123 * If datum_size is 0 there will never be anything to read from the
124 * buffer, so signal end of file now.
129 if (filp
->f_flags
& O_NONBLOCK
)
132 to_wait
= min_t(size_t, n
/ datum_size
, rb
->watermark
);
135 ret
= wait_event_interruptible(rb
->pollq
,
136 iio_buffer_ready(indio_dev
, rb
, to_wait
, n
/ datum_size
));
140 if (!indio_dev
->info
)
143 ret
= rb
->access
->read_first_n(rb
, n
, buf
);
144 if (ret
== 0 && (filp
->f_flags
& O_NONBLOCK
))
152 * iio_buffer_poll() - poll the buffer to find out if it has data
153 * @filp: File structure pointer for device access
154 * @wait: Poll table structure pointer for which the driver adds
157 * Return: (POLLIN | POLLRDNORM) if data is available for reading
158 * or 0 for other cases
160 unsigned int iio_buffer_poll(struct file
*filp
,
161 struct poll_table_struct
*wait
)
163 struct iio_dev
*indio_dev
= filp
->private_data
;
164 struct iio_buffer
*rb
= indio_dev
->buffer
;
166 if (!indio_dev
->info
)
169 poll_wait(filp
, &rb
->pollq
, wait
);
170 if (iio_buffer_ready(indio_dev
, rb
, rb
->watermark
, 0))
171 return POLLIN
| POLLRDNORM
;
176 * iio_buffer_wakeup_poll - Wakes up the buffer waitqueue
177 * @indio_dev: The IIO device
179 * Wakes up the event waitqueue used for poll(). Should usually
180 * be called when the device is unregistered.
182 void iio_buffer_wakeup_poll(struct iio_dev
*indio_dev
)
184 if (!indio_dev
->buffer
)
187 wake_up(&indio_dev
->buffer
->pollq
);
190 void iio_buffer_init(struct iio_buffer
*buffer
)
192 INIT_LIST_HEAD(&buffer
->demux_list
);
193 INIT_LIST_HEAD(&buffer
->buffer_list
);
194 init_waitqueue_head(&buffer
->pollq
);
195 kref_init(&buffer
->ref
);
196 buffer
->watermark
= 1;
198 EXPORT_SYMBOL(iio_buffer_init
);
200 static ssize_t
iio_show_scan_index(struct device
*dev
,
201 struct device_attribute
*attr
,
204 return sprintf(buf
, "%u\n", to_iio_dev_attr(attr
)->c
->scan_index
);
207 static ssize_t
iio_show_fixed_type(struct device
*dev
,
208 struct device_attribute
*attr
,
211 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
212 u8 type
= this_attr
->c
->scan_type
.endianness
;
214 if (type
== IIO_CPU
) {
215 #ifdef __LITTLE_ENDIAN
221 if (this_attr
->c
->scan_type
.repeat
> 1)
222 return sprintf(buf
, "%s:%c%d/%dX%d>>%u\n",
223 iio_endian_prefix
[type
],
224 this_attr
->c
->scan_type
.sign
,
225 this_attr
->c
->scan_type
.realbits
,
226 this_attr
->c
->scan_type
.storagebits
,
227 this_attr
->c
->scan_type
.repeat
,
228 this_attr
->c
->scan_type
.shift
);
230 return sprintf(buf
, "%s:%c%d/%d>>%u\n",
231 iio_endian_prefix
[type
],
232 this_attr
->c
->scan_type
.sign
,
233 this_attr
->c
->scan_type
.realbits
,
234 this_attr
->c
->scan_type
.storagebits
,
235 this_attr
->c
->scan_type
.shift
);
238 static ssize_t
iio_scan_el_show(struct device
*dev
,
239 struct device_attribute
*attr
,
243 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
245 /* Ensure ret is 0 or 1. */
246 ret
= !!test_bit(to_iio_dev_attr(attr
)->address
,
247 indio_dev
->buffer
->scan_mask
);
249 return sprintf(buf
, "%d\n", ret
);
252 /* Note NULL used as error indicator as it doesn't make sense. */
253 static const unsigned long *iio_scan_mask_match(const unsigned long *av_masks
,
254 unsigned int masklength
,
255 const unsigned long *mask
,
258 if (bitmap_empty(mask
, masklength
))
262 if (bitmap_equal(mask
, av_masks
, masklength
))
265 if (bitmap_subset(mask
, av_masks
, masklength
))
268 av_masks
+= BITS_TO_LONGS(masklength
);
273 static bool iio_validate_scan_mask(struct iio_dev
*indio_dev
,
274 const unsigned long *mask
)
276 if (!indio_dev
->setup_ops
->validate_scan_mask
)
279 return indio_dev
->setup_ops
->validate_scan_mask(indio_dev
, mask
);
283 * iio_scan_mask_set() - set particular bit in the scan mask
284 * @indio_dev: the iio device
285 * @buffer: the buffer whose scan mask we are interested in
286 * @bit: the bit to be set.
288 * Note that at this point we have no way of knowing what other
289 * buffers might request, hence this code only verifies that the
290 * individual buffers request is plausible.
292 static int iio_scan_mask_set(struct iio_dev
*indio_dev
,
293 struct iio_buffer
*buffer
, int bit
)
295 const unsigned long *mask
;
296 unsigned long *trialmask
;
298 trialmask
= kmalloc(sizeof(*trialmask
)*
299 BITS_TO_LONGS(indio_dev
->masklength
),
302 if (trialmask
== NULL
)
304 if (!indio_dev
->masklength
) {
305 WARN(1, "Trying to set scanmask prior to registering buffer\n");
306 goto err_invalid_mask
;
308 bitmap_copy(trialmask
, buffer
->scan_mask
, indio_dev
->masklength
);
309 set_bit(bit
, trialmask
);
311 if (!iio_validate_scan_mask(indio_dev
, trialmask
))
312 goto err_invalid_mask
;
314 if (indio_dev
->available_scan_masks
) {
315 mask
= iio_scan_mask_match(indio_dev
->available_scan_masks
,
316 indio_dev
->masklength
,
319 goto err_invalid_mask
;
321 bitmap_copy(buffer
->scan_mask
, trialmask
, indio_dev
->masklength
);
332 static int iio_scan_mask_clear(struct iio_buffer
*buffer
, int bit
)
334 clear_bit(bit
, buffer
->scan_mask
);
338 static ssize_t
iio_scan_el_store(struct device
*dev
,
339 struct device_attribute
*attr
,
345 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
346 struct iio_buffer
*buffer
= indio_dev
->buffer
;
347 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
349 ret
= strtobool(buf
, &state
);
352 mutex_lock(&indio_dev
->mlock
);
353 if (iio_buffer_is_active(indio_dev
->buffer
)) {
357 ret
= iio_scan_mask_query(indio_dev
, buffer
, this_attr
->address
);
361 ret
= iio_scan_mask_clear(buffer
, this_attr
->address
);
364 } else if (state
&& !ret
) {
365 ret
= iio_scan_mask_set(indio_dev
, buffer
, this_attr
->address
);
371 mutex_unlock(&indio_dev
->mlock
);
373 return ret
< 0 ? ret
: len
;
377 static ssize_t
iio_scan_el_ts_show(struct device
*dev
,
378 struct device_attribute
*attr
,
381 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
382 return sprintf(buf
, "%d\n", indio_dev
->buffer
->scan_timestamp
);
385 static ssize_t
iio_scan_el_ts_store(struct device
*dev
,
386 struct device_attribute
*attr
,
391 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
394 ret
= strtobool(buf
, &state
);
398 mutex_lock(&indio_dev
->mlock
);
399 if (iio_buffer_is_active(indio_dev
->buffer
)) {
403 indio_dev
->buffer
->scan_timestamp
= state
;
405 mutex_unlock(&indio_dev
->mlock
);
407 return ret
? ret
: len
;
410 static int iio_buffer_add_channel_sysfs(struct iio_dev
*indio_dev
,
411 const struct iio_chan_spec
*chan
)
413 int ret
, attrcount
= 0;
414 struct iio_buffer
*buffer
= indio_dev
->buffer
;
416 ret
= __iio_add_chan_devattr("index",
418 &iio_show_scan_index
,
423 &buffer
->scan_el_dev_attr_list
);
427 ret
= __iio_add_chan_devattr("type",
429 &iio_show_fixed_type
,
434 &buffer
->scan_el_dev_attr_list
);
438 if (chan
->type
!= IIO_TIMESTAMP
)
439 ret
= __iio_add_chan_devattr("en",
446 &buffer
->scan_el_dev_attr_list
);
448 ret
= __iio_add_chan_devattr("en",
450 &iio_scan_el_ts_show
,
451 &iio_scan_el_ts_store
,
455 &buffer
->scan_el_dev_attr_list
);
463 static ssize_t
iio_buffer_read_length(struct device
*dev
,
464 struct device_attribute
*attr
,
467 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
468 struct iio_buffer
*buffer
= indio_dev
->buffer
;
470 return sprintf(buf
, "%d\n", buffer
->length
);
473 static ssize_t
iio_buffer_write_length(struct device
*dev
,
474 struct device_attribute
*attr
,
475 const char *buf
, size_t len
)
477 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
478 struct iio_buffer
*buffer
= indio_dev
->buffer
;
482 ret
= kstrtouint(buf
, 10, &val
);
486 if (val
== buffer
->length
)
489 mutex_lock(&indio_dev
->mlock
);
490 if (iio_buffer_is_active(indio_dev
->buffer
)) {
493 buffer
->access
->set_length(buffer
, val
);
498 if (buffer
->length
&& buffer
->length
< buffer
->watermark
)
499 buffer
->watermark
= buffer
->length
;
501 mutex_unlock(&indio_dev
->mlock
);
503 return ret
? ret
: len
;
506 static ssize_t
iio_buffer_show_enable(struct device
*dev
,
507 struct device_attribute
*attr
,
510 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
511 return sprintf(buf
, "%d\n", iio_buffer_is_active(indio_dev
->buffer
));
514 static int iio_compute_scan_bytes(struct iio_dev
*indio_dev
,
515 const unsigned long *mask
, bool timestamp
)
517 const struct iio_chan_spec
*ch
;
521 /* How much space will the demuxed element take? */
522 for_each_set_bit(i
, mask
,
523 indio_dev
->masklength
) {
524 ch
= iio_find_channel_from_si(indio_dev
, i
);
525 if (ch
->scan_type
.repeat
> 1)
526 length
= ch
->scan_type
.storagebits
/ 8 *
527 ch
->scan_type
.repeat
;
529 length
= ch
->scan_type
.storagebits
/ 8;
530 bytes
= ALIGN(bytes
, length
);
534 ch
= iio_find_channel_from_si(indio_dev
,
535 indio_dev
->scan_index_timestamp
);
536 if (ch
->scan_type
.repeat
> 1)
537 length
= ch
->scan_type
.storagebits
/ 8 *
538 ch
->scan_type
.repeat
;
540 length
= ch
->scan_type
.storagebits
/ 8;
541 bytes
= ALIGN(bytes
, length
);
547 static void iio_buffer_activate(struct iio_dev
*indio_dev
,
548 struct iio_buffer
*buffer
)
550 iio_buffer_get(buffer
);
551 list_add(&buffer
->buffer_list
, &indio_dev
->buffer_list
);
554 static void iio_buffer_deactivate(struct iio_buffer
*buffer
)
556 list_del_init(&buffer
->buffer_list
);
557 wake_up_interruptible(&buffer
->pollq
);
558 iio_buffer_put(buffer
);
561 static void iio_buffer_deactivate_all(struct iio_dev
*indio_dev
)
563 struct iio_buffer
*buffer
, *_buffer
;
565 list_for_each_entry_safe(buffer
, _buffer
,
566 &indio_dev
->buffer_list
, buffer_list
)
567 iio_buffer_deactivate(buffer
);
570 static void iio_buffer_update_bytes_per_datum(struct iio_dev
*indio_dev
,
571 struct iio_buffer
*buffer
)
575 if (!buffer
->access
->set_bytes_per_datum
)
578 bytes
= iio_compute_scan_bytes(indio_dev
, buffer
->scan_mask
,
579 buffer
->scan_timestamp
);
581 buffer
->access
->set_bytes_per_datum(buffer
, bytes
);
584 static int iio_buffer_request_update(struct iio_dev
*indio_dev
,
585 struct iio_buffer
*buffer
)
589 iio_buffer_update_bytes_per_datum(indio_dev
, buffer
);
590 if (buffer
->access
->request_update
) {
591 ret
= buffer
->access
->request_update(buffer
);
593 dev_dbg(&indio_dev
->dev
,
594 "Buffer not started: buffer parameter update failed (%d)\n",
603 static void iio_free_scan_mask(struct iio_dev
*indio_dev
,
604 const unsigned long *mask
)
606 /* If the mask is dynamically allocated free it, otherwise do nothing */
607 if (!indio_dev
->available_scan_masks
)
611 struct iio_device_config
{
613 const unsigned long *scan_mask
;
614 unsigned int scan_bytes
;
618 static int iio_verify_update(struct iio_dev
*indio_dev
,
619 struct iio_buffer
*insert_buffer
, struct iio_buffer
*remove_buffer
,
620 struct iio_device_config
*config
)
622 unsigned long *compound_mask
;
623 const unsigned long *scan_mask
;
624 bool strict_scanmask
= false;
625 struct iio_buffer
*buffer
;
629 memset(config
, 0, sizeof(*config
));
632 * If there is just one buffer and we are removing it there is nothing
635 if (remove_buffer
&& !insert_buffer
&&
636 list_is_singular(&indio_dev
->buffer_list
))
639 modes
= indio_dev
->modes
;
641 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
642 if (buffer
== remove_buffer
)
644 modes
&= buffer
->access
->modes
;
648 modes
&= insert_buffer
->access
->modes
;
650 /* Definitely possible for devices to support both of these. */
651 if ((modes
& INDIO_BUFFER_TRIGGERED
) && indio_dev
->trig
) {
652 config
->mode
= INDIO_BUFFER_TRIGGERED
;
653 } else if (modes
& INDIO_BUFFER_HARDWARE
) {
655 * Keep things simple for now and only allow a single buffer to
656 * be connected in hardware mode.
658 if (insert_buffer
&& !list_empty(&indio_dev
->buffer_list
))
660 config
->mode
= INDIO_BUFFER_HARDWARE
;
661 strict_scanmask
= true;
662 } else if (modes
& INDIO_BUFFER_SOFTWARE
) {
663 config
->mode
= INDIO_BUFFER_SOFTWARE
;
665 /* Can only occur on first buffer */
666 if (indio_dev
->modes
& INDIO_BUFFER_TRIGGERED
)
667 dev_dbg(&indio_dev
->dev
, "Buffer not started: no trigger\n");
671 /* What scan mask do we actually have? */
672 compound_mask
= kcalloc(BITS_TO_LONGS(indio_dev
->masklength
),
673 sizeof(long), GFP_KERNEL
);
674 if (compound_mask
== NULL
)
677 scan_timestamp
= false;
679 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
680 if (buffer
== remove_buffer
)
682 bitmap_or(compound_mask
, compound_mask
, buffer
->scan_mask
,
683 indio_dev
->masklength
);
684 scan_timestamp
|= buffer
->scan_timestamp
;
688 bitmap_or(compound_mask
, compound_mask
,
689 insert_buffer
->scan_mask
, indio_dev
->masklength
);
690 scan_timestamp
|= insert_buffer
->scan_timestamp
;
693 if (indio_dev
->available_scan_masks
) {
694 scan_mask
= iio_scan_mask_match(indio_dev
->available_scan_masks
,
695 indio_dev
->masklength
,
698 kfree(compound_mask
);
699 if (scan_mask
== NULL
)
702 scan_mask
= compound_mask
;
705 config
->scan_bytes
= iio_compute_scan_bytes(indio_dev
,
706 scan_mask
, scan_timestamp
);
707 config
->scan_mask
= scan_mask
;
708 config
->scan_timestamp
= scan_timestamp
;
713 static int iio_enable_buffers(struct iio_dev
*indio_dev
,
714 struct iio_device_config
*config
)
718 indio_dev
->active_scan_mask
= config
->scan_mask
;
719 indio_dev
->scan_timestamp
= config
->scan_timestamp
;
720 indio_dev
->scan_bytes
= config
->scan_bytes
;
722 iio_update_demux(indio_dev
);
725 if (indio_dev
->setup_ops
->preenable
) {
726 ret
= indio_dev
->setup_ops
->preenable(indio_dev
);
728 dev_dbg(&indio_dev
->dev
,
729 "Buffer not started: buffer preenable failed (%d)\n", ret
);
730 goto err_undo_config
;
734 if (indio_dev
->info
->update_scan_mode
) {
735 ret
= indio_dev
->info
736 ->update_scan_mode(indio_dev
,
737 indio_dev
->active_scan_mask
);
739 dev_dbg(&indio_dev
->dev
,
740 "Buffer not started: update scan mode failed (%d)\n",
742 goto err_run_postdisable
;
746 indio_dev
->currentmode
= config
->mode
;
748 if (indio_dev
->setup_ops
->postenable
) {
749 ret
= indio_dev
->setup_ops
->postenable(indio_dev
);
751 dev_dbg(&indio_dev
->dev
,
752 "Buffer not started: postenable failed (%d)\n", ret
);
753 goto err_run_postdisable
;
760 indio_dev
->currentmode
= INDIO_DIRECT_MODE
;
761 if (indio_dev
->setup_ops
->postdisable
)
762 indio_dev
->setup_ops
->postdisable(indio_dev
);
764 indio_dev
->active_scan_mask
= NULL
;
769 static int iio_disable_buffers(struct iio_dev
*indio_dev
)
774 /* Wind down existing buffers - iff there are any */
775 if (list_empty(&indio_dev
->buffer_list
))
779 * If things go wrong at some step in disable we still need to continue
780 * to perform the other steps, otherwise we leave the device in a
781 * inconsistent state. We return the error code for the first error we
785 if (indio_dev
->setup_ops
->predisable
) {
786 ret2
= indio_dev
->setup_ops
->predisable(indio_dev
);
791 indio_dev
->currentmode
= INDIO_DIRECT_MODE
;
793 if (indio_dev
->setup_ops
->postdisable
) {
794 ret2
= indio_dev
->setup_ops
->postdisable(indio_dev
);
799 iio_free_scan_mask(indio_dev
, indio_dev
->active_scan_mask
);
800 indio_dev
->active_scan_mask
= NULL
;
805 static int __iio_update_buffers(struct iio_dev
*indio_dev
,
806 struct iio_buffer
*insert_buffer
,
807 struct iio_buffer
*remove_buffer
)
809 struct iio_device_config new_config
;
812 ret
= iio_verify_update(indio_dev
, insert_buffer
, remove_buffer
,
818 ret
= iio_buffer_request_update(indio_dev
, insert_buffer
);
820 goto err_free_config
;
823 ret
= iio_disable_buffers(indio_dev
);
825 goto err_deactivate_all
;
828 iio_buffer_deactivate(remove_buffer
);
830 iio_buffer_activate(indio_dev
, insert_buffer
);
832 /* If no buffers in list, we are done */
833 if (list_empty(&indio_dev
->buffer_list
))
836 ret
= iio_enable_buffers(indio_dev
, &new_config
);
838 goto err_deactivate_all
;
844 * We've already verified that the config is valid earlier. If things go
845 * wrong in either enable or disable the most likely reason is an IO
846 * error from the device. In this case there is no good recovery
847 * strategy. Just make sure to disable everything and leave the device
848 * in a sane state. With a bit of luck the device might come back to
849 * life again later and userspace can try again.
851 iio_buffer_deactivate_all(indio_dev
);
854 iio_free_scan_mask(indio_dev
, new_config
.scan_mask
);
858 int iio_update_buffers(struct iio_dev
*indio_dev
,
859 struct iio_buffer
*insert_buffer
,
860 struct iio_buffer
*remove_buffer
)
864 if (insert_buffer
== remove_buffer
)
867 mutex_lock(&indio_dev
->info_exist_lock
);
868 mutex_lock(&indio_dev
->mlock
);
870 if (insert_buffer
&& iio_buffer_is_active(insert_buffer
))
871 insert_buffer
= NULL
;
873 if (remove_buffer
&& !iio_buffer_is_active(remove_buffer
))
874 remove_buffer
= NULL
;
876 if (!insert_buffer
&& !remove_buffer
) {
881 if (indio_dev
->info
== NULL
) {
886 ret
= __iio_update_buffers(indio_dev
, insert_buffer
, remove_buffer
);
889 mutex_unlock(&indio_dev
->mlock
);
890 mutex_unlock(&indio_dev
->info_exist_lock
);
894 EXPORT_SYMBOL_GPL(iio_update_buffers
);
896 void iio_disable_all_buffers(struct iio_dev
*indio_dev
)
898 iio_disable_buffers(indio_dev
);
899 iio_buffer_deactivate_all(indio_dev
);
902 static ssize_t
iio_buffer_store_enable(struct device
*dev
,
903 struct device_attribute
*attr
,
908 bool requested_state
;
909 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
912 ret
= strtobool(buf
, &requested_state
);
916 mutex_lock(&indio_dev
->mlock
);
918 /* Find out if it is in the list */
919 inlist
= iio_buffer_is_active(indio_dev
->buffer
);
920 /* Already in desired state */
921 if (inlist
== requested_state
)
925 ret
= __iio_update_buffers(indio_dev
,
926 indio_dev
->buffer
, NULL
);
928 ret
= __iio_update_buffers(indio_dev
,
929 NULL
, indio_dev
->buffer
);
932 mutex_unlock(&indio_dev
->mlock
);
933 return (ret
< 0) ? ret
: len
;
936 static const char * const iio_scan_elements_group_name
= "scan_elements";
938 static ssize_t
iio_buffer_show_watermark(struct device
*dev
,
939 struct device_attribute
*attr
,
942 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
943 struct iio_buffer
*buffer
= indio_dev
->buffer
;
945 return sprintf(buf
, "%u\n", buffer
->watermark
);
948 static ssize_t
iio_buffer_store_watermark(struct device
*dev
,
949 struct device_attribute
*attr
,
953 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
954 struct iio_buffer
*buffer
= indio_dev
->buffer
;
958 ret
= kstrtouint(buf
, 10, &val
);
964 mutex_lock(&indio_dev
->mlock
);
966 if (val
> buffer
->length
) {
971 if (iio_buffer_is_active(indio_dev
->buffer
)) {
976 buffer
->watermark
= val
;
978 if (indio_dev
->info
->hwfifo_set_watermark
)
979 indio_dev
->info
->hwfifo_set_watermark(indio_dev
, val
);
981 mutex_unlock(&indio_dev
->mlock
);
983 return ret
? ret
: len
;
986 static DEVICE_ATTR(length
, S_IRUGO
| S_IWUSR
, iio_buffer_read_length
,
987 iio_buffer_write_length
);
988 static struct device_attribute dev_attr_length_ro
= __ATTR(length
,
989 S_IRUGO
, iio_buffer_read_length
, NULL
);
990 static DEVICE_ATTR(enable
, S_IRUGO
| S_IWUSR
,
991 iio_buffer_show_enable
, iio_buffer_store_enable
);
992 static DEVICE_ATTR(watermark
, S_IRUGO
| S_IWUSR
,
993 iio_buffer_show_watermark
, iio_buffer_store_watermark
);
995 static struct attribute
*iio_buffer_attrs
[] = {
996 &dev_attr_length
.attr
,
997 &dev_attr_enable
.attr
,
998 &dev_attr_watermark
.attr
,
1001 int iio_buffer_alloc_sysfs_and_mask(struct iio_dev
*indio_dev
)
1003 struct iio_dev_attr
*p
;
1004 struct attribute
**attr
;
1005 struct iio_buffer
*buffer
= indio_dev
->buffer
;
1006 int ret
, i
, attrn
, attrcount
, attrcount_orig
= 0;
1007 const struct iio_chan_spec
*channels
;
1009 channels
= indio_dev
->channels
;
1011 int ml
= indio_dev
->masklength
;
1013 for (i
= 0; i
< indio_dev
->num_channels
; i
++)
1014 ml
= max(ml
, channels
[i
].scan_index
+ 1);
1015 indio_dev
->masklength
= ml
;
1022 if (buffer
->attrs
) {
1023 while (buffer
->attrs
[attrcount
] != NULL
)
1027 attr
= kcalloc(attrcount
+ ARRAY_SIZE(iio_buffer_attrs
) + 1,
1028 sizeof(struct attribute
*), GFP_KERNEL
);
1032 memcpy(attr
, iio_buffer_attrs
, sizeof(iio_buffer_attrs
));
1033 if (!buffer
->access
->set_length
)
1034 attr
[0] = &dev_attr_length_ro
.attr
;
1037 memcpy(&attr
[ARRAY_SIZE(iio_buffer_attrs
)], buffer
->attrs
,
1038 sizeof(struct attribute
*) * attrcount
);
1040 attr
[attrcount
+ ARRAY_SIZE(iio_buffer_attrs
)] = NULL
;
1042 buffer
->buffer_group
.name
= "buffer";
1043 buffer
->buffer_group
.attrs
= attr
;
1045 indio_dev
->groups
[indio_dev
->groupcounter
++] = &buffer
->buffer_group
;
1047 if (buffer
->scan_el_attrs
!= NULL
) {
1048 attr
= buffer
->scan_el_attrs
->attrs
;
1049 while (*attr
++ != NULL
)
1052 attrcount
= attrcount_orig
;
1053 INIT_LIST_HEAD(&buffer
->scan_el_dev_attr_list
);
1054 channels
= indio_dev
->channels
;
1057 for (i
= 0; i
< indio_dev
->num_channels
; i
++) {
1058 if (channels
[i
].scan_index
< 0)
1061 ret
= iio_buffer_add_channel_sysfs(indio_dev
,
1064 goto error_cleanup_dynamic
;
1066 if (channels
[i
].type
== IIO_TIMESTAMP
)
1067 indio_dev
->scan_index_timestamp
=
1068 channels
[i
].scan_index
;
1070 if (indio_dev
->masklength
&& buffer
->scan_mask
== NULL
) {
1071 buffer
->scan_mask
= kcalloc(BITS_TO_LONGS(indio_dev
->masklength
),
1072 sizeof(*buffer
->scan_mask
),
1074 if (buffer
->scan_mask
== NULL
) {
1076 goto error_cleanup_dynamic
;
1081 buffer
->scan_el_group
.name
= iio_scan_elements_group_name
;
1083 buffer
->scan_el_group
.attrs
= kcalloc(attrcount
+ 1,
1084 sizeof(buffer
->scan_el_group
.attrs
[0]),
1086 if (buffer
->scan_el_group
.attrs
== NULL
) {
1088 goto error_free_scan_mask
;
1090 if (buffer
->scan_el_attrs
)
1091 memcpy(buffer
->scan_el_group
.attrs
, buffer
->scan_el_attrs
,
1092 sizeof(buffer
->scan_el_group
.attrs
[0])*attrcount_orig
);
1093 attrn
= attrcount_orig
;
1095 list_for_each_entry(p
, &buffer
->scan_el_dev_attr_list
, l
)
1096 buffer
->scan_el_group
.attrs
[attrn
++] = &p
->dev_attr
.attr
;
1097 indio_dev
->groups
[indio_dev
->groupcounter
++] = &buffer
->scan_el_group
;
1101 error_free_scan_mask
:
1102 kfree(buffer
->scan_mask
);
1103 error_cleanup_dynamic
:
1104 iio_free_chan_devattr_list(&buffer
->scan_el_dev_attr_list
);
1105 kfree(indio_dev
->buffer
->buffer_group
.attrs
);
1110 void iio_buffer_free_sysfs_and_mask(struct iio_dev
*indio_dev
)
1112 if (!indio_dev
->buffer
)
1115 kfree(indio_dev
->buffer
->scan_mask
);
1116 kfree(indio_dev
->buffer
->buffer_group
.attrs
);
1117 kfree(indio_dev
->buffer
->scan_el_group
.attrs
);
1118 iio_free_chan_devattr_list(&indio_dev
->buffer
->scan_el_dev_attr_list
);
1122 * iio_validate_scan_mask_onehot() - Validates that exactly one channel is selected
1123 * @indio_dev: the iio device
1124 * @mask: scan mask to be checked
1126 * Return true if exactly one bit is set in the scan mask, false otherwise. It
1127 * can be used for devices where only one channel can be active for sampling at
1130 bool iio_validate_scan_mask_onehot(struct iio_dev
*indio_dev
,
1131 const unsigned long *mask
)
1133 return bitmap_weight(mask
, indio_dev
->masklength
) == 1;
1135 EXPORT_SYMBOL_GPL(iio_validate_scan_mask_onehot
);
1137 int iio_scan_mask_query(struct iio_dev
*indio_dev
,
1138 struct iio_buffer
*buffer
, int bit
)
1140 if (bit
> indio_dev
->masklength
)
1143 if (!buffer
->scan_mask
)
1146 /* Ensure return value is 0 or 1. */
1147 return !!test_bit(bit
, buffer
->scan_mask
);
1149 EXPORT_SYMBOL_GPL(iio_scan_mask_query
);
1152 * struct iio_demux_table - table describing demux memcpy ops
1153 * @from: index to copy from
1154 * @to: index to copy to
1155 * @length: how many bytes to copy
1156 * @l: list head used for management
1158 struct iio_demux_table
{
1165 static const void *iio_demux(struct iio_buffer
*buffer
,
1168 struct iio_demux_table
*t
;
1170 if (list_empty(&buffer
->demux_list
))
1172 list_for_each_entry(t
, &buffer
->demux_list
, l
)
1173 memcpy(buffer
->demux_bounce
+ t
->to
,
1174 datain
+ t
->from
, t
->length
);
1176 return buffer
->demux_bounce
;
1179 static int iio_push_to_buffer(struct iio_buffer
*buffer
, const void *data
)
1181 const void *dataout
= iio_demux(buffer
, data
);
1184 ret
= buffer
->access
->store_to(buffer
, dataout
);
1189 * We can't just test for watermark to decide if we wake the poll queue
1190 * because read may request less samples than the watermark.
1192 wake_up_interruptible_poll(&buffer
->pollq
, POLLIN
| POLLRDNORM
);
1196 static void iio_buffer_demux_free(struct iio_buffer
*buffer
)
1198 struct iio_demux_table
*p
, *q
;
1199 list_for_each_entry_safe(p
, q
, &buffer
->demux_list
, l
) {
1206 int iio_push_to_buffers(struct iio_dev
*indio_dev
, const void *data
)
1209 struct iio_buffer
*buf
;
1211 list_for_each_entry(buf
, &indio_dev
->buffer_list
, buffer_list
) {
1212 ret
= iio_push_to_buffer(buf
, data
);
1219 EXPORT_SYMBOL_GPL(iio_push_to_buffers
);
1221 static int iio_buffer_add_demux(struct iio_buffer
*buffer
,
1222 struct iio_demux_table
**p
, unsigned int in_loc
, unsigned int out_loc
,
1223 unsigned int length
)
1226 if (*p
&& (*p
)->from
+ (*p
)->length
== in_loc
&&
1227 (*p
)->to
+ (*p
)->length
== out_loc
) {
1228 (*p
)->length
+= length
;
1230 *p
= kmalloc(sizeof(**p
), GFP_KERNEL
);
1233 (*p
)->from
= in_loc
;
1235 (*p
)->length
= length
;
1236 list_add_tail(&(*p
)->l
, &buffer
->demux_list
);
1242 static int iio_buffer_update_demux(struct iio_dev
*indio_dev
,
1243 struct iio_buffer
*buffer
)
1245 const struct iio_chan_spec
*ch
;
1246 int ret
, in_ind
= -1, out_ind
, length
;
1247 unsigned in_loc
= 0, out_loc
= 0;
1248 struct iio_demux_table
*p
= NULL
;
1250 /* Clear out any old demux */
1251 iio_buffer_demux_free(buffer
);
1252 kfree(buffer
->demux_bounce
);
1253 buffer
->demux_bounce
= NULL
;
1255 /* First work out which scan mode we will actually have */
1256 if (bitmap_equal(indio_dev
->active_scan_mask
,
1258 indio_dev
->masklength
))
1261 /* Now we have the two masks, work from least sig and build up sizes */
1262 for_each_set_bit(out_ind
,
1264 indio_dev
->masklength
) {
1265 in_ind
= find_next_bit(indio_dev
->active_scan_mask
,
1266 indio_dev
->masklength
,
1268 while (in_ind
!= out_ind
) {
1269 in_ind
= find_next_bit(indio_dev
->active_scan_mask
,
1270 indio_dev
->masklength
,
1272 ch
= iio_find_channel_from_si(indio_dev
, in_ind
);
1273 if (ch
->scan_type
.repeat
> 1)
1274 length
= ch
->scan_type
.storagebits
/ 8 *
1275 ch
->scan_type
.repeat
;
1277 length
= ch
->scan_type
.storagebits
/ 8;
1278 /* Make sure we are aligned */
1279 in_loc
= roundup(in_loc
, length
) + length
;
1281 ch
= iio_find_channel_from_si(indio_dev
, in_ind
);
1282 if (ch
->scan_type
.repeat
> 1)
1283 length
= ch
->scan_type
.storagebits
/ 8 *
1284 ch
->scan_type
.repeat
;
1286 length
= ch
->scan_type
.storagebits
/ 8;
1287 out_loc
= roundup(out_loc
, length
);
1288 in_loc
= roundup(in_loc
, length
);
1289 ret
= iio_buffer_add_demux(buffer
, &p
, in_loc
, out_loc
, length
);
1291 goto error_clear_mux_table
;
1295 /* Relies on scan_timestamp being last */
1296 if (buffer
->scan_timestamp
) {
1297 ch
= iio_find_channel_from_si(indio_dev
,
1298 indio_dev
->scan_index_timestamp
);
1299 if (ch
->scan_type
.repeat
> 1)
1300 length
= ch
->scan_type
.storagebits
/ 8 *
1301 ch
->scan_type
.repeat
;
1303 length
= ch
->scan_type
.storagebits
/ 8;
1304 out_loc
= roundup(out_loc
, length
);
1305 in_loc
= roundup(in_loc
, length
);
1306 ret
= iio_buffer_add_demux(buffer
, &p
, in_loc
, out_loc
, length
);
1308 goto error_clear_mux_table
;
1312 buffer
->demux_bounce
= kzalloc(out_loc
, GFP_KERNEL
);
1313 if (buffer
->demux_bounce
== NULL
) {
1315 goto error_clear_mux_table
;
1319 error_clear_mux_table
:
1320 iio_buffer_demux_free(buffer
);
1325 int iio_update_demux(struct iio_dev
*indio_dev
)
1327 struct iio_buffer
*buffer
;
1330 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
1331 ret
= iio_buffer_update_demux(indio_dev
, buffer
);
1333 goto error_clear_mux_table
;
1337 error_clear_mux_table
:
1338 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
)
1339 iio_buffer_demux_free(buffer
);
1343 EXPORT_SYMBOL_GPL(iio_update_demux
);
1346 * iio_buffer_release() - Free a buffer's resources
1347 * @ref: Pointer to the kref embedded in the iio_buffer struct
1349 * This function is called when the last reference to the buffer has been
1350 * dropped. It will typically free all resources allocated by the buffer. Do not
1351 * call this function manually, always use iio_buffer_put() when done using a
1354 static void iio_buffer_release(struct kref
*ref
)
1356 struct iio_buffer
*buffer
= container_of(ref
, struct iio_buffer
, ref
);
1358 buffer
->access
->release(buffer
);
1362 * iio_buffer_get() - Grab a reference to the buffer
1363 * @buffer: The buffer to grab a reference for, may be NULL
1365 * Returns the pointer to the buffer that was passed into the function.
1367 struct iio_buffer
*iio_buffer_get(struct iio_buffer
*buffer
)
1370 kref_get(&buffer
->ref
);
1374 EXPORT_SYMBOL_GPL(iio_buffer_get
);
1377 * iio_buffer_put() - Release the reference to the buffer
1378 * @buffer: The buffer to release the reference for, may be NULL
1380 void iio_buffer_put(struct iio_buffer
*buffer
)
1383 kref_put(&buffer
->ref
, iio_buffer_release
);
1385 EXPORT_SYMBOL_GPL(iio_buffer_put
);