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
;
110 DEFINE_WAIT_FUNC(wait
, woken_wake_function
);
115 if (!indio_dev
->info
)
118 if (!rb
|| !rb
->access
->read_first_n
)
121 datum_size
= rb
->bytes_per_datum
;
124 * If datum_size is 0 there will never be anything to read from the
125 * buffer, so signal end of file now.
130 if (filp
->f_flags
& O_NONBLOCK
)
133 to_wait
= min_t(size_t, n
/ datum_size
, rb
->watermark
);
135 add_wait_queue(&rb
->pollq
, &wait
);
137 if (!indio_dev
->info
) {
142 if (!iio_buffer_ready(indio_dev
, rb
, to_wait
, n
/ datum_size
)) {
143 if (signal_pending(current
)) {
148 wait_woken(&wait
, TASK_INTERRUPTIBLE
,
149 MAX_SCHEDULE_TIMEOUT
);
153 ret
= rb
->access
->read_first_n(rb
, n
, buf
);
154 if (ret
== 0 && (filp
->f_flags
& O_NONBLOCK
))
157 remove_wait_queue(&rb
->pollq
, &wait
);
163 * iio_buffer_poll() - poll the buffer to find out if it has data
164 * @filp: File structure pointer for device access
165 * @wait: Poll table structure pointer for which the driver adds
168 * Return: (POLLIN | POLLRDNORM) if data is available for reading
169 * or 0 for other cases
171 unsigned int iio_buffer_poll(struct file
*filp
,
172 struct poll_table_struct
*wait
)
174 struct iio_dev
*indio_dev
= filp
->private_data
;
175 struct iio_buffer
*rb
= indio_dev
->buffer
;
177 if (!indio_dev
->info
|| rb
== NULL
)
180 poll_wait(filp
, &rb
->pollq
, wait
);
181 if (iio_buffer_ready(indio_dev
, rb
, rb
->watermark
, 0))
182 return POLLIN
| POLLRDNORM
;
187 * iio_buffer_wakeup_poll - Wakes up the buffer waitqueue
188 * @indio_dev: The IIO device
190 * Wakes up the event waitqueue used for poll(). Should usually
191 * be called when the device is unregistered.
193 void iio_buffer_wakeup_poll(struct iio_dev
*indio_dev
)
195 if (!indio_dev
->buffer
)
198 wake_up(&indio_dev
->buffer
->pollq
);
201 void iio_buffer_init(struct iio_buffer
*buffer
)
203 INIT_LIST_HEAD(&buffer
->demux_list
);
204 INIT_LIST_HEAD(&buffer
->buffer_list
);
205 init_waitqueue_head(&buffer
->pollq
);
206 kref_init(&buffer
->ref
);
207 buffer
->watermark
= 1;
209 EXPORT_SYMBOL(iio_buffer_init
);
211 static ssize_t
iio_show_scan_index(struct device
*dev
,
212 struct device_attribute
*attr
,
215 return sprintf(buf
, "%u\n", to_iio_dev_attr(attr
)->c
->scan_index
);
218 static ssize_t
iio_show_fixed_type(struct device
*dev
,
219 struct device_attribute
*attr
,
222 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
223 u8 type
= this_attr
->c
->scan_type
.endianness
;
225 if (type
== IIO_CPU
) {
226 #ifdef __LITTLE_ENDIAN
232 if (this_attr
->c
->scan_type
.repeat
> 1)
233 return sprintf(buf
, "%s:%c%d/%dX%d>>%u\n",
234 iio_endian_prefix
[type
],
235 this_attr
->c
->scan_type
.sign
,
236 this_attr
->c
->scan_type
.realbits
,
237 this_attr
->c
->scan_type
.storagebits
,
238 this_attr
->c
->scan_type
.repeat
,
239 this_attr
->c
->scan_type
.shift
);
241 return sprintf(buf
, "%s:%c%d/%d>>%u\n",
242 iio_endian_prefix
[type
],
243 this_attr
->c
->scan_type
.sign
,
244 this_attr
->c
->scan_type
.realbits
,
245 this_attr
->c
->scan_type
.storagebits
,
246 this_attr
->c
->scan_type
.shift
);
249 static ssize_t
iio_scan_el_show(struct device
*dev
,
250 struct device_attribute
*attr
,
254 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
256 /* Ensure ret is 0 or 1. */
257 ret
= !!test_bit(to_iio_dev_attr(attr
)->address
,
258 indio_dev
->buffer
->scan_mask
);
260 return sprintf(buf
, "%d\n", ret
);
263 /* Note NULL used as error indicator as it doesn't make sense. */
264 static const unsigned long *iio_scan_mask_match(const unsigned long *av_masks
,
265 unsigned int masklength
,
266 const unsigned long *mask
,
269 if (bitmap_empty(mask
, masklength
))
273 if (bitmap_equal(mask
, av_masks
, masklength
))
276 if (bitmap_subset(mask
, av_masks
, masklength
))
279 av_masks
+= BITS_TO_LONGS(masklength
);
284 static bool iio_validate_scan_mask(struct iio_dev
*indio_dev
,
285 const unsigned long *mask
)
287 if (!indio_dev
->setup_ops
->validate_scan_mask
)
290 return indio_dev
->setup_ops
->validate_scan_mask(indio_dev
, mask
);
294 * iio_scan_mask_set() - set particular bit in the scan mask
295 * @indio_dev: the iio device
296 * @buffer: the buffer whose scan mask we are interested in
297 * @bit: the bit to be set.
299 * Note that at this point we have no way of knowing what other
300 * buffers might request, hence this code only verifies that the
301 * individual buffers request is plausible.
303 static int iio_scan_mask_set(struct iio_dev
*indio_dev
,
304 struct iio_buffer
*buffer
, int bit
)
306 const unsigned long *mask
;
307 unsigned long *trialmask
;
309 trialmask
= kmalloc(sizeof(*trialmask
)*
310 BITS_TO_LONGS(indio_dev
->masklength
),
313 if (trialmask
== NULL
)
315 if (!indio_dev
->masklength
) {
316 WARN(1, "Trying to set scanmask prior to registering buffer\n");
317 goto err_invalid_mask
;
319 bitmap_copy(trialmask
, buffer
->scan_mask
, indio_dev
->masklength
);
320 set_bit(bit
, trialmask
);
322 if (!iio_validate_scan_mask(indio_dev
, trialmask
))
323 goto err_invalid_mask
;
325 if (indio_dev
->available_scan_masks
) {
326 mask
= iio_scan_mask_match(indio_dev
->available_scan_masks
,
327 indio_dev
->masklength
,
330 goto err_invalid_mask
;
332 bitmap_copy(buffer
->scan_mask
, trialmask
, indio_dev
->masklength
);
343 static int iio_scan_mask_clear(struct iio_buffer
*buffer
, int bit
)
345 clear_bit(bit
, buffer
->scan_mask
);
349 static ssize_t
iio_scan_el_store(struct device
*dev
,
350 struct device_attribute
*attr
,
356 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
357 struct iio_buffer
*buffer
= indio_dev
->buffer
;
358 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
360 ret
= strtobool(buf
, &state
);
363 mutex_lock(&indio_dev
->mlock
);
364 if (iio_buffer_is_active(indio_dev
->buffer
)) {
368 ret
= iio_scan_mask_query(indio_dev
, buffer
, this_attr
->address
);
372 ret
= iio_scan_mask_clear(buffer
, this_attr
->address
);
375 } else if (state
&& !ret
) {
376 ret
= iio_scan_mask_set(indio_dev
, buffer
, this_attr
->address
);
382 mutex_unlock(&indio_dev
->mlock
);
384 return ret
< 0 ? ret
: len
;
388 static ssize_t
iio_scan_el_ts_show(struct device
*dev
,
389 struct device_attribute
*attr
,
392 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
393 return sprintf(buf
, "%d\n", indio_dev
->buffer
->scan_timestamp
);
396 static ssize_t
iio_scan_el_ts_store(struct device
*dev
,
397 struct device_attribute
*attr
,
402 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
405 ret
= strtobool(buf
, &state
);
409 mutex_lock(&indio_dev
->mlock
);
410 if (iio_buffer_is_active(indio_dev
->buffer
)) {
414 indio_dev
->buffer
->scan_timestamp
= state
;
416 mutex_unlock(&indio_dev
->mlock
);
418 return ret
? ret
: len
;
421 static int iio_buffer_add_channel_sysfs(struct iio_dev
*indio_dev
,
422 const struct iio_chan_spec
*chan
)
424 int ret
, attrcount
= 0;
425 struct iio_buffer
*buffer
= indio_dev
->buffer
;
427 ret
= __iio_add_chan_devattr("index",
429 &iio_show_scan_index
,
434 &buffer
->scan_el_dev_attr_list
);
438 ret
= __iio_add_chan_devattr("type",
440 &iio_show_fixed_type
,
445 &buffer
->scan_el_dev_attr_list
);
449 if (chan
->type
!= IIO_TIMESTAMP
)
450 ret
= __iio_add_chan_devattr("en",
457 &buffer
->scan_el_dev_attr_list
);
459 ret
= __iio_add_chan_devattr("en",
461 &iio_scan_el_ts_show
,
462 &iio_scan_el_ts_store
,
466 &buffer
->scan_el_dev_attr_list
);
474 static ssize_t
iio_buffer_read_length(struct device
*dev
,
475 struct device_attribute
*attr
,
478 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
479 struct iio_buffer
*buffer
= indio_dev
->buffer
;
481 return sprintf(buf
, "%d\n", buffer
->length
);
484 static ssize_t
iio_buffer_write_length(struct device
*dev
,
485 struct device_attribute
*attr
,
486 const char *buf
, size_t len
)
488 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
489 struct iio_buffer
*buffer
= indio_dev
->buffer
;
493 ret
= kstrtouint(buf
, 10, &val
);
497 if (val
== buffer
->length
)
500 mutex_lock(&indio_dev
->mlock
);
501 if (iio_buffer_is_active(indio_dev
->buffer
)) {
504 buffer
->access
->set_length(buffer
, val
);
509 if (buffer
->length
&& buffer
->length
< buffer
->watermark
)
510 buffer
->watermark
= buffer
->length
;
512 mutex_unlock(&indio_dev
->mlock
);
514 return ret
? ret
: len
;
517 static ssize_t
iio_buffer_show_enable(struct device
*dev
,
518 struct device_attribute
*attr
,
521 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
522 return sprintf(buf
, "%d\n", iio_buffer_is_active(indio_dev
->buffer
));
525 static int iio_compute_scan_bytes(struct iio_dev
*indio_dev
,
526 const unsigned long *mask
, bool timestamp
)
528 const struct iio_chan_spec
*ch
;
532 /* How much space will the demuxed element take? */
533 for_each_set_bit(i
, mask
,
534 indio_dev
->masklength
) {
535 ch
= iio_find_channel_from_si(indio_dev
, i
);
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
);
545 ch
= iio_find_channel_from_si(indio_dev
,
546 indio_dev
->scan_index_timestamp
);
547 if (ch
->scan_type
.repeat
> 1)
548 length
= ch
->scan_type
.storagebits
/ 8 *
549 ch
->scan_type
.repeat
;
551 length
= ch
->scan_type
.storagebits
/ 8;
552 bytes
= ALIGN(bytes
, length
);
558 static void iio_buffer_activate(struct iio_dev
*indio_dev
,
559 struct iio_buffer
*buffer
)
561 iio_buffer_get(buffer
);
562 list_add(&buffer
->buffer_list
, &indio_dev
->buffer_list
);
565 static void iio_buffer_deactivate(struct iio_buffer
*buffer
)
567 list_del_init(&buffer
->buffer_list
);
568 wake_up_interruptible(&buffer
->pollq
);
569 iio_buffer_put(buffer
);
572 static void iio_buffer_deactivate_all(struct iio_dev
*indio_dev
)
574 struct iio_buffer
*buffer
, *_buffer
;
576 list_for_each_entry_safe(buffer
, _buffer
,
577 &indio_dev
->buffer_list
, buffer_list
)
578 iio_buffer_deactivate(buffer
);
581 static void iio_buffer_update_bytes_per_datum(struct iio_dev
*indio_dev
,
582 struct iio_buffer
*buffer
)
586 if (!buffer
->access
->set_bytes_per_datum
)
589 bytes
= iio_compute_scan_bytes(indio_dev
, buffer
->scan_mask
,
590 buffer
->scan_timestamp
);
592 buffer
->access
->set_bytes_per_datum(buffer
, bytes
);
595 static int iio_buffer_request_update(struct iio_dev
*indio_dev
,
596 struct iio_buffer
*buffer
)
600 iio_buffer_update_bytes_per_datum(indio_dev
, buffer
);
601 if (buffer
->access
->request_update
) {
602 ret
= buffer
->access
->request_update(buffer
);
604 dev_dbg(&indio_dev
->dev
,
605 "Buffer not started: buffer parameter update failed (%d)\n",
614 static void iio_free_scan_mask(struct iio_dev
*indio_dev
,
615 const unsigned long *mask
)
617 /* If the mask is dynamically allocated free it, otherwise do nothing */
618 if (!indio_dev
->available_scan_masks
)
622 struct iio_device_config
{
624 const unsigned long *scan_mask
;
625 unsigned int scan_bytes
;
629 static int iio_verify_update(struct iio_dev
*indio_dev
,
630 struct iio_buffer
*insert_buffer
, struct iio_buffer
*remove_buffer
,
631 struct iio_device_config
*config
)
633 unsigned long *compound_mask
;
634 const unsigned long *scan_mask
;
635 bool strict_scanmask
= false;
636 struct iio_buffer
*buffer
;
640 memset(config
, 0, sizeof(*config
));
643 * If there is just one buffer and we are removing it there is nothing
646 if (remove_buffer
&& !insert_buffer
&&
647 list_is_singular(&indio_dev
->buffer_list
))
650 modes
= indio_dev
->modes
;
652 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
653 if (buffer
== remove_buffer
)
655 modes
&= buffer
->access
->modes
;
659 modes
&= insert_buffer
->access
->modes
;
661 /* Definitely possible for devices to support both of these. */
662 if ((modes
& INDIO_BUFFER_TRIGGERED
) && indio_dev
->trig
) {
663 config
->mode
= INDIO_BUFFER_TRIGGERED
;
664 } else if (modes
& INDIO_BUFFER_HARDWARE
) {
666 * Keep things simple for now and only allow a single buffer to
667 * be connected in hardware mode.
669 if (insert_buffer
&& !list_empty(&indio_dev
->buffer_list
))
671 config
->mode
= INDIO_BUFFER_HARDWARE
;
672 strict_scanmask
= true;
673 } else if (modes
& INDIO_BUFFER_SOFTWARE
) {
674 config
->mode
= INDIO_BUFFER_SOFTWARE
;
676 /* Can only occur on first buffer */
677 if (indio_dev
->modes
& INDIO_BUFFER_TRIGGERED
)
678 dev_dbg(&indio_dev
->dev
, "Buffer not started: no trigger\n");
682 /* What scan mask do we actually have? */
683 compound_mask
= kcalloc(BITS_TO_LONGS(indio_dev
->masklength
),
684 sizeof(long), GFP_KERNEL
);
685 if (compound_mask
== NULL
)
688 scan_timestamp
= false;
690 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
691 if (buffer
== remove_buffer
)
693 bitmap_or(compound_mask
, compound_mask
, buffer
->scan_mask
,
694 indio_dev
->masklength
);
695 scan_timestamp
|= buffer
->scan_timestamp
;
699 bitmap_or(compound_mask
, compound_mask
,
700 insert_buffer
->scan_mask
, indio_dev
->masklength
);
701 scan_timestamp
|= insert_buffer
->scan_timestamp
;
704 if (indio_dev
->available_scan_masks
) {
705 scan_mask
= iio_scan_mask_match(indio_dev
->available_scan_masks
,
706 indio_dev
->masklength
,
709 kfree(compound_mask
);
710 if (scan_mask
== NULL
)
713 scan_mask
= compound_mask
;
716 config
->scan_bytes
= iio_compute_scan_bytes(indio_dev
,
717 scan_mask
, scan_timestamp
);
718 config
->scan_mask
= scan_mask
;
719 config
->scan_timestamp
= scan_timestamp
;
724 static int iio_enable_buffers(struct iio_dev
*indio_dev
,
725 struct iio_device_config
*config
)
729 indio_dev
->active_scan_mask
= config
->scan_mask
;
730 indio_dev
->scan_timestamp
= config
->scan_timestamp
;
731 indio_dev
->scan_bytes
= config
->scan_bytes
;
733 iio_update_demux(indio_dev
);
736 if (indio_dev
->setup_ops
->preenable
) {
737 ret
= indio_dev
->setup_ops
->preenable(indio_dev
);
739 dev_dbg(&indio_dev
->dev
,
740 "Buffer not started: buffer preenable failed (%d)\n", ret
);
741 goto err_undo_config
;
745 if (indio_dev
->info
->update_scan_mode
) {
746 ret
= indio_dev
->info
747 ->update_scan_mode(indio_dev
,
748 indio_dev
->active_scan_mask
);
750 dev_dbg(&indio_dev
->dev
,
751 "Buffer not started: update scan mode failed (%d)\n",
753 goto err_run_postdisable
;
757 indio_dev
->currentmode
= config
->mode
;
759 if (indio_dev
->setup_ops
->postenable
) {
760 ret
= indio_dev
->setup_ops
->postenable(indio_dev
);
762 dev_dbg(&indio_dev
->dev
,
763 "Buffer not started: postenable failed (%d)\n", ret
);
764 goto err_run_postdisable
;
771 indio_dev
->currentmode
= INDIO_DIRECT_MODE
;
772 if (indio_dev
->setup_ops
->postdisable
)
773 indio_dev
->setup_ops
->postdisable(indio_dev
);
775 indio_dev
->active_scan_mask
= NULL
;
780 static int iio_disable_buffers(struct iio_dev
*indio_dev
)
785 /* Wind down existing buffers - iff there are any */
786 if (list_empty(&indio_dev
->buffer_list
))
790 * If things go wrong at some step in disable we still need to continue
791 * to perform the other steps, otherwise we leave the device in a
792 * inconsistent state. We return the error code for the first error we
796 if (indio_dev
->setup_ops
->predisable
) {
797 ret2
= indio_dev
->setup_ops
->predisable(indio_dev
);
802 indio_dev
->currentmode
= INDIO_DIRECT_MODE
;
804 if (indio_dev
->setup_ops
->postdisable
) {
805 ret2
= indio_dev
->setup_ops
->postdisable(indio_dev
);
810 iio_free_scan_mask(indio_dev
, indio_dev
->active_scan_mask
);
811 indio_dev
->active_scan_mask
= NULL
;
816 static int __iio_update_buffers(struct iio_dev
*indio_dev
,
817 struct iio_buffer
*insert_buffer
,
818 struct iio_buffer
*remove_buffer
)
820 struct iio_device_config new_config
;
823 ret
= iio_verify_update(indio_dev
, insert_buffer
, remove_buffer
,
829 ret
= iio_buffer_request_update(indio_dev
, insert_buffer
);
831 goto err_free_config
;
834 ret
= iio_disable_buffers(indio_dev
);
836 goto err_deactivate_all
;
839 iio_buffer_deactivate(remove_buffer
);
841 iio_buffer_activate(indio_dev
, insert_buffer
);
843 /* If no buffers in list, we are done */
844 if (list_empty(&indio_dev
->buffer_list
))
847 ret
= iio_enable_buffers(indio_dev
, &new_config
);
849 goto err_deactivate_all
;
855 * We've already verified that the config is valid earlier. If things go
856 * wrong in either enable or disable the most likely reason is an IO
857 * error from the device. In this case there is no good recovery
858 * strategy. Just make sure to disable everything and leave the device
859 * in a sane state. With a bit of luck the device might come back to
860 * life again later and userspace can try again.
862 iio_buffer_deactivate_all(indio_dev
);
865 iio_free_scan_mask(indio_dev
, new_config
.scan_mask
);
869 int iio_update_buffers(struct iio_dev
*indio_dev
,
870 struct iio_buffer
*insert_buffer
,
871 struct iio_buffer
*remove_buffer
)
875 if (insert_buffer
== remove_buffer
)
878 mutex_lock(&indio_dev
->info_exist_lock
);
879 mutex_lock(&indio_dev
->mlock
);
881 if (insert_buffer
&& iio_buffer_is_active(insert_buffer
))
882 insert_buffer
= NULL
;
884 if (remove_buffer
&& !iio_buffer_is_active(remove_buffer
))
885 remove_buffer
= NULL
;
887 if (!insert_buffer
&& !remove_buffer
) {
892 if (indio_dev
->info
== NULL
) {
897 ret
= __iio_update_buffers(indio_dev
, insert_buffer
, remove_buffer
);
900 mutex_unlock(&indio_dev
->mlock
);
901 mutex_unlock(&indio_dev
->info_exist_lock
);
905 EXPORT_SYMBOL_GPL(iio_update_buffers
);
907 void iio_disable_all_buffers(struct iio_dev
*indio_dev
)
909 iio_disable_buffers(indio_dev
);
910 iio_buffer_deactivate_all(indio_dev
);
913 static ssize_t
iio_buffer_store_enable(struct device
*dev
,
914 struct device_attribute
*attr
,
919 bool requested_state
;
920 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
923 ret
= strtobool(buf
, &requested_state
);
927 mutex_lock(&indio_dev
->mlock
);
929 /* Find out if it is in the list */
930 inlist
= iio_buffer_is_active(indio_dev
->buffer
);
931 /* Already in desired state */
932 if (inlist
== requested_state
)
936 ret
= __iio_update_buffers(indio_dev
,
937 indio_dev
->buffer
, NULL
);
939 ret
= __iio_update_buffers(indio_dev
,
940 NULL
, indio_dev
->buffer
);
943 mutex_unlock(&indio_dev
->mlock
);
944 return (ret
< 0) ? ret
: len
;
947 static const char * const iio_scan_elements_group_name
= "scan_elements";
949 static ssize_t
iio_buffer_show_watermark(struct device
*dev
,
950 struct device_attribute
*attr
,
953 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
954 struct iio_buffer
*buffer
= indio_dev
->buffer
;
956 return sprintf(buf
, "%u\n", buffer
->watermark
);
959 static ssize_t
iio_buffer_store_watermark(struct device
*dev
,
960 struct device_attribute
*attr
,
964 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
965 struct iio_buffer
*buffer
= indio_dev
->buffer
;
969 ret
= kstrtouint(buf
, 10, &val
);
975 mutex_lock(&indio_dev
->mlock
);
977 if (val
> buffer
->length
) {
982 if (iio_buffer_is_active(indio_dev
->buffer
)) {
987 buffer
->watermark
= val
;
989 if (indio_dev
->info
->hwfifo_set_watermark
)
990 indio_dev
->info
->hwfifo_set_watermark(indio_dev
, val
);
992 mutex_unlock(&indio_dev
->mlock
);
994 return ret
? ret
: len
;
997 static DEVICE_ATTR(length
, S_IRUGO
| S_IWUSR
, iio_buffer_read_length
,
998 iio_buffer_write_length
);
999 static struct device_attribute dev_attr_length_ro
= __ATTR(length
,
1000 S_IRUGO
, iio_buffer_read_length
, NULL
);
1001 static DEVICE_ATTR(enable
, S_IRUGO
| S_IWUSR
,
1002 iio_buffer_show_enable
, iio_buffer_store_enable
);
1003 static DEVICE_ATTR(watermark
, S_IRUGO
| S_IWUSR
,
1004 iio_buffer_show_watermark
, iio_buffer_store_watermark
);
1006 static struct attribute
*iio_buffer_attrs
[] = {
1007 &dev_attr_length
.attr
,
1008 &dev_attr_enable
.attr
,
1009 &dev_attr_watermark
.attr
,
1012 int iio_buffer_alloc_sysfs_and_mask(struct iio_dev
*indio_dev
)
1014 struct iio_dev_attr
*p
;
1015 struct attribute
**attr
;
1016 struct iio_buffer
*buffer
= indio_dev
->buffer
;
1017 int ret
, i
, attrn
, attrcount
, attrcount_orig
= 0;
1018 const struct iio_chan_spec
*channels
;
1020 channels
= indio_dev
->channels
;
1022 int ml
= indio_dev
->masklength
;
1024 for (i
= 0; i
< indio_dev
->num_channels
; i
++)
1025 ml
= max(ml
, channels
[i
].scan_index
+ 1);
1026 indio_dev
->masklength
= ml
;
1033 if (buffer
->attrs
) {
1034 while (buffer
->attrs
[attrcount
] != NULL
)
1038 attr
= kcalloc(attrcount
+ ARRAY_SIZE(iio_buffer_attrs
) + 1,
1039 sizeof(struct attribute
*), GFP_KERNEL
);
1043 memcpy(attr
, iio_buffer_attrs
, sizeof(iio_buffer_attrs
));
1044 if (!buffer
->access
->set_length
)
1045 attr
[0] = &dev_attr_length_ro
.attr
;
1048 memcpy(&attr
[ARRAY_SIZE(iio_buffer_attrs
)], buffer
->attrs
,
1049 sizeof(struct attribute
*) * attrcount
);
1051 attr
[attrcount
+ ARRAY_SIZE(iio_buffer_attrs
)] = NULL
;
1053 buffer
->buffer_group
.name
= "buffer";
1054 buffer
->buffer_group
.attrs
= attr
;
1056 indio_dev
->groups
[indio_dev
->groupcounter
++] = &buffer
->buffer_group
;
1058 if (buffer
->scan_el_attrs
!= NULL
) {
1059 attr
= buffer
->scan_el_attrs
->attrs
;
1060 while (*attr
++ != NULL
)
1063 attrcount
= attrcount_orig
;
1064 INIT_LIST_HEAD(&buffer
->scan_el_dev_attr_list
);
1065 channels
= indio_dev
->channels
;
1068 for (i
= 0; i
< indio_dev
->num_channels
; i
++) {
1069 if (channels
[i
].scan_index
< 0)
1072 ret
= iio_buffer_add_channel_sysfs(indio_dev
,
1075 goto error_cleanup_dynamic
;
1077 if (channels
[i
].type
== IIO_TIMESTAMP
)
1078 indio_dev
->scan_index_timestamp
=
1079 channels
[i
].scan_index
;
1081 if (indio_dev
->masklength
&& buffer
->scan_mask
== NULL
) {
1082 buffer
->scan_mask
= kcalloc(BITS_TO_LONGS(indio_dev
->masklength
),
1083 sizeof(*buffer
->scan_mask
),
1085 if (buffer
->scan_mask
== NULL
) {
1087 goto error_cleanup_dynamic
;
1092 buffer
->scan_el_group
.name
= iio_scan_elements_group_name
;
1094 buffer
->scan_el_group
.attrs
= kcalloc(attrcount
+ 1,
1095 sizeof(buffer
->scan_el_group
.attrs
[0]),
1097 if (buffer
->scan_el_group
.attrs
== NULL
) {
1099 goto error_free_scan_mask
;
1101 if (buffer
->scan_el_attrs
)
1102 memcpy(buffer
->scan_el_group
.attrs
, buffer
->scan_el_attrs
,
1103 sizeof(buffer
->scan_el_group
.attrs
[0])*attrcount_orig
);
1104 attrn
= attrcount_orig
;
1106 list_for_each_entry(p
, &buffer
->scan_el_dev_attr_list
, l
)
1107 buffer
->scan_el_group
.attrs
[attrn
++] = &p
->dev_attr
.attr
;
1108 indio_dev
->groups
[indio_dev
->groupcounter
++] = &buffer
->scan_el_group
;
1112 error_free_scan_mask
:
1113 kfree(buffer
->scan_mask
);
1114 error_cleanup_dynamic
:
1115 iio_free_chan_devattr_list(&buffer
->scan_el_dev_attr_list
);
1116 kfree(indio_dev
->buffer
->buffer_group
.attrs
);
1121 void iio_buffer_free_sysfs_and_mask(struct iio_dev
*indio_dev
)
1123 if (!indio_dev
->buffer
)
1126 kfree(indio_dev
->buffer
->scan_mask
);
1127 kfree(indio_dev
->buffer
->buffer_group
.attrs
);
1128 kfree(indio_dev
->buffer
->scan_el_group
.attrs
);
1129 iio_free_chan_devattr_list(&indio_dev
->buffer
->scan_el_dev_attr_list
);
1133 * iio_validate_scan_mask_onehot() - Validates that exactly one channel is selected
1134 * @indio_dev: the iio device
1135 * @mask: scan mask to be checked
1137 * Return true if exactly one bit is set in the scan mask, false otherwise. It
1138 * can be used for devices where only one channel can be active for sampling at
1141 bool iio_validate_scan_mask_onehot(struct iio_dev
*indio_dev
,
1142 const unsigned long *mask
)
1144 return bitmap_weight(mask
, indio_dev
->masklength
) == 1;
1146 EXPORT_SYMBOL_GPL(iio_validate_scan_mask_onehot
);
1148 int iio_scan_mask_query(struct iio_dev
*indio_dev
,
1149 struct iio_buffer
*buffer
, int bit
)
1151 if (bit
> indio_dev
->masklength
)
1154 if (!buffer
->scan_mask
)
1157 /* Ensure return value is 0 or 1. */
1158 return !!test_bit(bit
, buffer
->scan_mask
);
1160 EXPORT_SYMBOL_GPL(iio_scan_mask_query
);
1163 * struct iio_demux_table - table describing demux memcpy ops
1164 * @from: index to copy from
1165 * @to: index to copy to
1166 * @length: how many bytes to copy
1167 * @l: list head used for management
1169 struct iio_demux_table
{
1176 static const void *iio_demux(struct iio_buffer
*buffer
,
1179 struct iio_demux_table
*t
;
1181 if (list_empty(&buffer
->demux_list
))
1183 list_for_each_entry(t
, &buffer
->demux_list
, l
)
1184 memcpy(buffer
->demux_bounce
+ t
->to
,
1185 datain
+ t
->from
, t
->length
);
1187 return buffer
->demux_bounce
;
1190 static int iio_push_to_buffer(struct iio_buffer
*buffer
, const void *data
)
1192 const void *dataout
= iio_demux(buffer
, data
);
1195 ret
= buffer
->access
->store_to(buffer
, dataout
);
1200 * We can't just test for watermark to decide if we wake the poll queue
1201 * because read may request less samples than the watermark.
1203 wake_up_interruptible_poll(&buffer
->pollq
, POLLIN
| POLLRDNORM
);
1207 static void iio_buffer_demux_free(struct iio_buffer
*buffer
)
1209 struct iio_demux_table
*p
, *q
;
1210 list_for_each_entry_safe(p
, q
, &buffer
->demux_list
, l
) {
1217 int iio_push_to_buffers(struct iio_dev
*indio_dev
, const void *data
)
1220 struct iio_buffer
*buf
;
1222 list_for_each_entry(buf
, &indio_dev
->buffer_list
, buffer_list
) {
1223 ret
= iio_push_to_buffer(buf
, data
);
1230 EXPORT_SYMBOL_GPL(iio_push_to_buffers
);
1232 static int iio_buffer_add_demux(struct iio_buffer
*buffer
,
1233 struct iio_demux_table
**p
, unsigned int in_loc
, unsigned int out_loc
,
1234 unsigned int length
)
1237 if (*p
&& (*p
)->from
+ (*p
)->length
== in_loc
&&
1238 (*p
)->to
+ (*p
)->length
== out_loc
) {
1239 (*p
)->length
+= length
;
1241 *p
= kmalloc(sizeof(**p
), GFP_KERNEL
);
1244 (*p
)->from
= in_loc
;
1246 (*p
)->length
= length
;
1247 list_add_tail(&(*p
)->l
, &buffer
->demux_list
);
1253 static int iio_buffer_update_demux(struct iio_dev
*indio_dev
,
1254 struct iio_buffer
*buffer
)
1256 const struct iio_chan_spec
*ch
;
1257 int ret
, in_ind
= -1, out_ind
, length
;
1258 unsigned in_loc
= 0, out_loc
= 0;
1259 struct iio_demux_table
*p
= NULL
;
1261 /* Clear out any old demux */
1262 iio_buffer_demux_free(buffer
);
1263 kfree(buffer
->demux_bounce
);
1264 buffer
->demux_bounce
= NULL
;
1266 /* First work out which scan mode we will actually have */
1267 if (bitmap_equal(indio_dev
->active_scan_mask
,
1269 indio_dev
->masklength
))
1272 /* Now we have the two masks, work from least sig and build up sizes */
1273 for_each_set_bit(out_ind
,
1275 indio_dev
->masklength
) {
1276 in_ind
= find_next_bit(indio_dev
->active_scan_mask
,
1277 indio_dev
->masklength
,
1279 while (in_ind
!= out_ind
) {
1280 in_ind
= find_next_bit(indio_dev
->active_scan_mask
,
1281 indio_dev
->masklength
,
1283 ch
= iio_find_channel_from_si(indio_dev
, in_ind
);
1284 if (ch
->scan_type
.repeat
> 1)
1285 length
= ch
->scan_type
.storagebits
/ 8 *
1286 ch
->scan_type
.repeat
;
1288 length
= ch
->scan_type
.storagebits
/ 8;
1289 /* Make sure we are aligned */
1290 in_loc
= roundup(in_loc
, length
) + length
;
1292 ch
= iio_find_channel_from_si(indio_dev
, in_ind
);
1293 if (ch
->scan_type
.repeat
> 1)
1294 length
= ch
->scan_type
.storagebits
/ 8 *
1295 ch
->scan_type
.repeat
;
1297 length
= ch
->scan_type
.storagebits
/ 8;
1298 out_loc
= roundup(out_loc
, length
);
1299 in_loc
= roundup(in_loc
, length
);
1300 ret
= iio_buffer_add_demux(buffer
, &p
, in_loc
, out_loc
, length
);
1302 goto error_clear_mux_table
;
1306 /* Relies on scan_timestamp being last */
1307 if (buffer
->scan_timestamp
) {
1308 ch
= iio_find_channel_from_si(indio_dev
,
1309 indio_dev
->scan_index_timestamp
);
1310 if (ch
->scan_type
.repeat
> 1)
1311 length
= ch
->scan_type
.storagebits
/ 8 *
1312 ch
->scan_type
.repeat
;
1314 length
= ch
->scan_type
.storagebits
/ 8;
1315 out_loc
= roundup(out_loc
, length
);
1316 in_loc
= roundup(in_loc
, length
);
1317 ret
= iio_buffer_add_demux(buffer
, &p
, in_loc
, out_loc
, length
);
1319 goto error_clear_mux_table
;
1323 buffer
->demux_bounce
= kzalloc(out_loc
, GFP_KERNEL
);
1324 if (buffer
->demux_bounce
== NULL
) {
1326 goto error_clear_mux_table
;
1330 error_clear_mux_table
:
1331 iio_buffer_demux_free(buffer
);
1336 int iio_update_demux(struct iio_dev
*indio_dev
)
1338 struct iio_buffer
*buffer
;
1341 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
1342 ret
= iio_buffer_update_demux(indio_dev
, buffer
);
1344 goto error_clear_mux_table
;
1348 error_clear_mux_table
:
1349 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
)
1350 iio_buffer_demux_free(buffer
);
1354 EXPORT_SYMBOL_GPL(iio_update_demux
);
1357 * iio_buffer_release() - Free a buffer's resources
1358 * @ref: Pointer to the kref embedded in the iio_buffer struct
1360 * This function is called when the last reference to the buffer has been
1361 * dropped. It will typically free all resources allocated by the buffer. Do not
1362 * call this function manually, always use iio_buffer_put() when done using a
1365 static void iio_buffer_release(struct kref
*ref
)
1367 struct iio_buffer
*buffer
= container_of(ref
, struct iio_buffer
, ref
);
1369 buffer
->access
->release(buffer
);
1373 * iio_buffer_get() - Grab a reference to the buffer
1374 * @buffer: The buffer to grab a reference for, may be NULL
1376 * Returns the pointer to the buffer that was passed into the function.
1378 struct iio_buffer
*iio_buffer_get(struct iio_buffer
*buffer
)
1381 kref_get(&buffer
->ref
);
1385 EXPORT_SYMBOL_GPL(iio_buffer_get
);
1388 * iio_buffer_put() - Release the reference to the buffer
1389 * @buffer: The buffer to release the reference for, may be NULL
1391 void iio_buffer_put(struct iio_buffer
*buffer
)
1394 kref_put(&buffer
->ref
, iio_buffer_release
);
1396 EXPORT_SYMBOL_GPL(iio_buffer_put
);