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 if (!buffer
->watermark
)
197 buffer
->watermark
= 1;
199 EXPORT_SYMBOL(iio_buffer_init
);
201 static ssize_t
iio_show_scan_index(struct device
*dev
,
202 struct device_attribute
*attr
,
205 return sprintf(buf
, "%u\n", to_iio_dev_attr(attr
)->c
->scan_index
);
208 static ssize_t
iio_show_fixed_type(struct device
*dev
,
209 struct device_attribute
*attr
,
212 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
213 u8 type
= this_attr
->c
->scan_type
.endianness
;
215 if (type
== IIO_CPU
) {
216 #ifdef __LITTLE_ENDIAN
222 if (this_attr
->c
->scan_type
.repeat
> 1)
223 return sprintf(buf
, "%s:%c%d/%dX%d>>%u\n",
224 iio_endian_prefix
[type
],
225 this_attr
->c
->scan_type
.sign
,
226 this_attr
->c
->scan_type
.realbits
,
227 this_attr
->c
->scan_type
.storagebits
,
228 this_attr
->c
->scan_type
.repeat
,
229 this_attr
->c
->scan_type
.shift
);
231 return sprintf(buf
, "%s:%c%d/%d>>%u\n",
232 iio_endian_prefix
[type
],
233 this_attr
->c
->scan_type
.sign
,
234 this_attr
->c
->scan_type
.realbits
,
235 this_attr
->c
->scan_type
.storagebits
,
236 this_attr
->c
->scan_type
.shift
);
239 static ssize_t
iio_scan_el_show(struct device
*dev
,
240 struct device_attribute
*attr
,
244 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
246 /* Ensure ret is 0 or 1. */
247 ret
= !!test_bit(to_iio_dev_attr(attr
)->address
,
248 indio_dev
->buffer
->scan_mask
);
250 return sprintf(buf
, "%d\n", ret
);
253 /* Note NULL used as error indicator as it doesn't make sense. */
254 static const unsigned long *iio_scan_mask_match(const unsigned long *av_masks
,
255 unsigned int masklength
,
256 const unsigned long *mask
,
259 if (bitmap_empty(mask
, masklength
))
263 if (bitmap_equal(mask
, av_masks
, masklength
))
266 if (bitmap_subset(mask
, av_masks
, masklength
))
269 av_masks
+= BITS_TO_LONGS(masklength
);
274 static bool iio_validate_scan_mask(struct iio_dev
*indio_dev
,
275 const unsigned long *mask
)
277 if (!indio_dev
->setup_ops
->validate_scan_mask
)
280 return indio_dev
->setup_ops
->validate_scan_mask(indio_dev
, mask
);
284 * iio_scan_mask_set() - set particular bit in the scan mask
285 * @indio_dev: the iio device
286 * @buffer: the buffer whose scan mask we are interested in
287 * @bit: the bit to be set.
289 * Note that at this point we have no way of knowing what other
290 * buffers might request, hence this code only verifies that the
291 * individual buffers request is plausible.
293 static int iio_scan_mask_set(struct iio_dev
*indio_dev
,
294 struct iio_buffer
*buffer
, int bit
)
296 const unsigned long *mask
;
297 unsigned long *trialmask
;
299 trialmask
= kmalloc(sizeof(*trialmask
)*
300 BITS_TO_LONGS(indio_dev
->masklength
),
303 if (trialmask
== NULL
)
305 if (!indio_dev
->masklength
) {
306 WARN(1, "Trying to set scanmask prior to registering buffer\n");
307 goto err_invalid_mask
;
309 bitmap_copy(trialmask
, buffer
->scan_mask
, indio_dev
->masklength
);
310 set_bit(bit
, trialmask
);
312 if (!iio_validate_scan_mask(indio_dev
, trialmask
))
313 goto err_invalid_mask
;
315 if (indio_dev
->available_scan_masks
) {
316 mask
= iio_scan_mask_match(indio_dev
->available_scan_masks
,
317 indio_dev
->masklength
,
320 goto err_invalid_mask
;
322 bitmap_copy(buffer
->scan_mask
, trialmask
, indio_dev
->masklength
);
333 static int iio_scan_mask_clear(struct iio_buffer
*buffer
, int bit
)
335 clear_bit(bit
, buffer
->scan_mask
);
339 static ssize_t
iio_scan_el_store(struct device
*dev
,
340 struct device_attribute
*attr
,
346 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
347 struct iio_buffer
*buffer
= indio_dev
->buffer
;
348 struct iio_dev_attr
*this_attr
= to_iio_dev_attr(attr
);
350 ret
= strtobool(buf
, &state
);
353 mutex_lock(&indio_dev
->mlock
);
354 if (iio_buffer_is_active(indio_dev
->buffer
)) {
358 ret
= iio_scan_mask_query(indio_dev
, buffer
, this_attr
->address
);
362 ret
= iio_scan_mask_clear(buffer
, this_attr
->address
);
365 } else if (state
&& !ret
) {
366 ret
= iio_scan_mask_set(indio_dev
, buffer
, this_attr
->address
);
372 mutex_unlock(&indio_dev
->mlock
);
374 return ret
< 0 ? ret
: len
;
378 static ssize_t
iio_scan_el_ts_show(struct device
*dev
,
379 struct device_attribute
*attr
,
382 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
383 return sprintf(buf
, "%d\n", indio_dev
->buffer
->scan_timestamp
);
386 static ssize_t
iio_scan_el_ts_store(struct device
*dev
,
387 struct device_attribute
*attr
,
392 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
395 ret
= strtobool(buf
, &state
);
399 mutex_lock(&indio_dev
->mlock
);
400 if (iio_buffer_is_active(indio_dev
->buffer
)) {
404 indio_dev
->buffer
->scan_timestamp
= state
;
406 mutex_unlock(&indio_dev
->mlock
);
408 return ret
? ret
: len
;
411 static int iio_buffer_add_channel_sysfs(struct iio_dev
*indio_dev
,
412 const struct iio_chan_spec
*chan
)
414 int ret
, attrcount
= 0;
415 struct iio_buffer
*buffer
= indio_dev
->buffer
;
417 ret
= __iio_add_chan_devattr("index",
419 &iio_show_scan_index
,
424 &buffer
->scan_el_dev_attr_list
);
428 ret
= __iio_add_chan_devattr("type",
430 &iio_show_fixed_type
,
435 &buffer
->scan_el_dev_attr_list
);
439 if (chan
->type
!= IIO_TIMESTAMP
)
440 ret
= __iio_add_chan_devattr("en",
447 &buffer
->scan_el_dev_attr_list
);
449 ret
= __iio_add_chan_devattr("en",
451 &iio_scan_el_ts_show
,
452 &iio_scan_el_ts_store
,
456 &buffer
->scan_el_dev_attr_list
);
464 static ssize_t
iio_buffer_read_length(struct device
*dev
,
465 struct device_attribute
*attr
,
468 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
469 struct iio_buffer
*buffer
= indio_dev
->buffer
;
471 return sprintf(buf
, "%d\n", buffer
->length
);
474 static ssize_t
iio_buffer_write_length(struct device
*dev
,
475 struct device_attribute
*attr
,
476 const char *buf
, size_t len
)
478 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
479 struct iio_buffer
*buffer
= indio_dev
->buffer
;
483 ret
= kstrtouint(buf
, 10, &val
);
487 if (val
== buffer
->length
)
490 mutex_lock(&indio_dev
->mlock
);
491 if (iio_buffer_is_active(indio_dev
->buffer
)) {
494 buffer
->access
->set_length(buffer
, val
);
499 if (buffer
->length
&& buffer
->length
< buffer
->watermark
)
500 buffer
->watermark
= buffer
->length
;
502 mutex_unlock(&indio_dev
->mlock
);
504 return ret
? ret
: len
;
507 static ssize_t
iio_buffer_show_enable(struct device
*dev
,
508 struct device_attribute
*attr
,
511 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
512 return sprintf(buf
, "%d\n", iio_buffer_is_active(indio_dev
->buffer
));
515 static int iio_compute_scan_bytes(struct iio_dev
*indio_dev
,
516 const unsigned long *mask
, bool timestamp
)
518 const struct iio_chan_spec
*ch
;
522 /* How much space will the demuxed element take? */
523 for_each_set_bit(i
, mask
,
524 indio_dev
->masklength
) {
525 ch
= iio_find_channel_from_si(indio_dev
, i
);
526 if (ch
->scan_type
.repeat
> 1)
527 length
= ch
->scan_type
.storagebits
/ 8 *
528 ch
->scan_type
.repeat
;
530 length
= ch
->scan_type
.storagebits
/ 8;
531 bytes
= ALIGN(bytes
, length
);
535 ch
= iio_find_channel_from_si(indio_dev
,
536 indio_dev
->scan_index_timestamp
);
537 if (ch
->scan_type
.repeat
> 1)
538 length
= ch
->scan_type
.storagebits
/ 8 *
539 ch
->scan_type
.repeat
;
541 length
= ch
->scan_type
.storagebits
/ 8;
542 bytes
= ALIGN(bytes
, length
);
548 static void iio_buffer_activate(struct iio_dev
*indio_dev
,
549 struct iio_buffer
*buffer
)
551 iio_buffer_get(buffer
);
552 list_add(&buffer
->buffer_list
, &indio_dev
->buffer_list
);
555 static void iio_buffer_deactivate(struct iio_buffer
*buffer
)
557 list_del_init(&buffer
->buffer_list
);
558 wake_up_interruptible(&buffer
->pollq
);
559 iio_buffer_put(buffer
);
562 static void iio_buffer_deactivate_all(struct iio_dev
*indio_dev
)
564 struct iio_buffer
*buffer
, *_buffer
;
566 list_for_each_entry_safe(buffer
, _buffer
,
567 &indio_dev
->buffer_list
, buffer_list
)
568 iio_buffer_deactivate(buffer
);
571 static int iio_buffer_enable(struct iio_buffer
*buffer
,
572 struct iio_dev
*indio_dev
)
574 if (!buffer
->access
->enable
)
576 return buffer
->access
->enable(buffer
, indio_dev
);
579 static int iio_buffer_disable(struct iio_buffer
*buffer
,
580 struct iio_dev
*indio_dev
)
582 if (!buffer
->access
->disable
)
584 return buffer
->access
->disable(buffer
, indio_dev
);
587 static void iio_buffer_update_bytes_per_datum(struct iio_dev
*indio_dev
,
588 struct iio_buffer
*buffer
)
592 if (!buffer
->access
->set_bytes_per_datum
)
595 bytes
= iio_compute_scan_bytes(indio_dev
, buffer
->scan_mask
,
596 buffer
->scan_timestamp
);
598 buffer
->access
->set_bytes_per_datum(buffer
, bytes
);
601 static int iio_buffer_request_update(struct iio_dev
*indio_dev
,
602 struct iio_buffer
*buffer
)
606 iio_buffer_update_bytes_per_datum(indio_dev
, buffer
);
607 if (buffer
->access
->request_update
) {
608 ret
= buffer
->access
->request_update(buffer
);
610 dev_dbg(&indio_dev
->dev
,
611 "Buffer not started: buffer parameter update failed (%d)\n",
620 static void iio_free_scan_mask(struct iio_dev
*indio_dev
,
621 const unsigned long *mask
)
623 /* If the mask is dynamically allocated free it, otherwise do nothing */
624 if (!indio_dev
->available_scan_masks
)
628 struct iio_device_config
{
630 unsigned int watermark
;
631 const unsigned long *scan_mask
;
632 unsigned int scan_bytes
;
636 static int iio_verify_update(struct iio_dev
*indio_dev
,
637 struct iio_buffer
*insert_buffer
, struct iio_buffer
*remove_buffer
,
638 struct iio_device_config
*config
)
640 unsigned long *compound_mask
;
641 const unsigned long *scan_mask
;
642 bool strict_scanmask
= false;
643 struct iio_buffer
*buffer
;
647 memset(config
, 0, sizeof(*config
));
650 * If there is just one buffer and we are removing it there is nothing
653 if (remove_buffer
&& !insert_buffer
&&
654 list_is_singular(&indio_dev
->buffer_list
))
657 modes
= indio_dev
->modes
;
659 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
660 if (buffer
== remove_buffer
)
662 modes
&= buffer
->access
->modes
;
663 config
->watermark
= min(config
->watermark
, buffer
->watermark
);
667 modes
&= insert_buffer
->access
->modes
;
668 config
->watermark
= min(config
->watermark
,
669 insert_buffer
->watermark
);
672 /* Definitely possible for devices to support both of these. */
673 if ((modes
& INDIO_BUFFER_TRIGGERED
) && indio_dev
->trig
) {
674 config
->mode
= INDIO_BUFFER_TRIGGERED
;
675 } else if (modes
& INDIO_BUFFER_HARDWARE
) {
677 * Keep things simple for now and only allow a single buffer to
678 * be connected in hardware mode.
680 if (insert_buffer
&& !list_empty(&indio_dev
->buffer_list
))
682 config
->mode
= INDIO_BUFFER_HARDWARE
;
683 strict_scanmask
= true;
684 } else if (modes
& INDIO_BUFFER_SOFTWARE
) {
685 config
->mode
= INDIO_BUFFER_SOFTWARE
;
687 /* Can only occur on first buffer */
688 if (indio_dev
->modes
& INDIO_BUFFER_TRIGGERED
)
689 dev_dbg(&indio_dev
->dev
, "Buffer not started: no trigger\n");
693 /* What scan mask do we actually have? */
694 compound_mask
= kcalloc(BITS_TO_LONGS(indio_dev
->masklength
),
695 sizeof(long), GFP_KERNEL
);
696 if (compound_mask
== NULL
)
699 scan_timestamp
= false;
701 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
702 if (buffer
== remove_buffer
)
704 bitmap_or(compound_mask
, compound_mask
, buffer
->scan_mask
,
705 indio_dev
->masklength
);
706 scan_timestamp
|= buffer
->scan_timestamp
;
710 bitmap_or(compound_mask
, compound_mask
,
711 insert_buffer
->scan_mask
, indio_dev
->masklength
);
712 scan_timestamp
|= insert_buffer
->scan_timestamp
;
715 if (indio_dev
->available_scan_masks
) {
716 scan_mask
= iio_scan_mask_match(indio_dev
->available_scan_masks
,
717 indio_dev
->masklength
,
720 kfree(compound_mask
);
721 if (scan_mask
== NULL
)
724 scan_mask
= compound_mask
;
727 config
->scan_bytes
= iio_compute_scan_bytes(indio_dev
,
728 scan_mask
, scan_timestamp
);
729 config
->scan_mask
= scan_mask
;
730 config
->scan_timestamp
= scan_timestamp
;
735 static int iio_enable_buffers(struct iio_dev
*indio_dev
,
736 struct iio_device_config
*config
)
738 struct iio_buffer
*buffer
;
741 indio_dev
->active_scan_mask
= config
->scan_mask
;
742 indio_dev
->scan_timestamp
= config
->scan_timestamp
;
743 indio_dev
->scan_bytes
= config
->scan_bytes
;
745 iio_update_demux(indio_dev
);
748 if (indio_dev
->setup_ops
->preenable
) {
749 ret
= indio_dev
->setup_ops
->preenable(indio_dev
);
751 dev_dbg(&indio_dev
->dev
,
752 "Buffer not started: buffer preenable failed (%d)\n", ret
);
753 goto err_undo_config
;
757 if (indio_dev
->info
->update_scan_mode
) {
758 ret
= indio_dev
->info
759 ->update_scan_mode(indio_dev
,
760 indio_dev
->active_scan_mask
);
762 dev_dbg(&indio_dev
->dev
,
763 "Buffer not started: update scan mode failed (%d)\n",
765 goto err_run_postdisable
;
769 if (indio_dev
->info
->hwfifo_set_watermark
)
770 indio_dev
->info
->hwfifo_set_watermark(indio_dev
,
773 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
774 ret
= iio_buffer_enable(buffer
, indio_dev
);
776 goto err_disable_buffers
;
779 indio_dev
->currentmode
= config
->mode
;
781 if (indio_dev
->setup_ops
->postenable
) {
782 ret
= indio_dev
->setup_ops
->postenable(indio_dev
);
784 dev_dbg(&indio_dev
->dev
,
785 "Buffer not started: postenable failed (%d)\n", ret
);
786 goto err_disable_buffers
;
793 list_for_each_entry_continue_reverse(buffer
, &indio_dev
->buffer_list
,
795 iio_buffer_disable(buffer
, indio_dev
);
797 indio_dev
->currentmode
= INDIO_DIRECT_MODE
;
798 if (indio_dev
->setup_ops
->postdisable
)
799 indio_dev
->setup_ops
->postdisable(indio_dev
);
801 indio_dev
->active_scan_mask
= NULL
;
806 static int iio_disable_buffers(struct iio_dev
*indio_dev
)
808 struct iio_buffer
*buffer
;
812 /* Wind down existing buffers - iff there are any */
813 if (list_empty(&indio_dev
->buffer_list
))
817 * If things go wrong at some step in disable we still need to continue
818 * to perform the other steps, otherwise we leave the device in a
819 * inconsistent state. We return the error code for the first error we
823 if (indio_dev
->setup_ops
->predisable
) {
824 ret2
= indio_dev
->setup_ops
->predisable(indio_dev
);
829 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
830 ret2
= iio_buffer_disable(buffer
, indio_dev
);
835 indio_dev
->currentmode
= INDIO_DIRECT_MODE
;
837 if (indio_dev
->setup_ops
->postdisable
) {
838 ret2
= indio_dev
->setup_ops
->postdisable(indio_dev
);
843 iio_free_scan_mask(indio_dev
, indio_dev
->active_scan_mask
);
844 indio_dev
->active_scan_mask
= NULL
;
849 static int __iio_update_buffers(struct iio_dev
*indio_dev
,
850 struct iio_buffer
*insert_buffer
,
851 struct iio_buffer
*remove_buffer
)
853 struct iio_device_config new_config
;
856 ret
= iio_verify_update(indio_dev
, insert_buffer
, remove_buffer
,
862 ret
= iio_buffer_request_update(indio_dev
, insert_buffer
);
864 goto err_free_config
;
867 ret
= iio_disable_buffers(indio_dev
);
869 goto err_deactivate_all
;
872 iio_buffer_deactivate(remove_buffer
);
874 iio_buffer_activate(indio_dev
, insert_buffer
);
876 /* If no buffers in list, we are done */
877 if (list_empty(&indio_dev
->buffer_list
))
880 ret
= iio_enable_buffers(indio_dev
, &new_config
);
882 goto err_deactivate_all
;
888 * We've already verified that the config is valid earlier. If things go
889 * wrong in either enable or disable the most likely reason is an IO
890 * error from the device. In this case there is no good recovery
891 * strategy. Just make sure to disable everything and leave the device
892 * in a sane state. With a bit of luck the device might come back to
893 * life again later and userspace can try again.
895 iio_buffer_deactivate_all(indio_dev
);
898 iio_free_scan_mask(indio_dev
, new_config
.scan_mask
);
902 int iio_update_buffers(struct iio_dev
*indio_dev
,
903 struct iio_buffer
*insert_buffer
,
904 struct iio_buffer
*remove_buffer
)
908 if (insert_buffer
== remove_buffer
)
911 mutex_lock(&indio_dev
->info_exist_lock
);
912 mutex_lock(&indio_dev
->mlock
);
914 if (insert_buffer
&& iio_buffer_is_active(insert_buffer
))
915 insert_buffer
= NULL
;
917 if (remove_buffer
&& !iio_buffer_is_active(remove_buffer
))
918 remove_buffer
= NULL
;
920 if (!insert_buffer
&& !remove_buffer
) {
925 if (indio_dev
->info
== NULL
) {
930 ret
= __iio_update_buffers(indio_dev
, insert_buffer
, remove_buffer
);
933 mutex_unlock(&indio_dev
->mlock
);
934 mutex_unlock(&indio_dev
->info_exist_lock
);
938 EXPORT_SYMBOL_GPL(iio_update_buffers
);
940 void iio_disable_all_buffers(struct iio_dev
*indio_dev
)
942 iio_disable_buffers(indio_dev
);
943 iio_buffer_deactivate_all(indio_dev
);
946 static ssize_t
iio_buffer_store_enable(struct device
*dev
,
947 struct device_attribute
*attr
,
952 bool requested_state
;
953 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
956 ret
= strtobool(buf
, &requested_state
);
960 mutex_lock(&indio_dev
->mlock
);
962 /* Find out if it is in the list */
963 inlist
= iio_buffer_is_active(indio_dev
->buffer
);
964 /* Already in desired state */
965 if (inlist
== requested_state
)
969 ret
= __iio_update_buffers(indio_dev
,
970 indio_dev
->buffer
, NULL
);
972 ret
= __iio_update_buffers(indio_dev
,
973 NULL
, indio_dev
->buffer
);
976 mutex_unlock(&indio_dev
->mlock
);
977 return (ret
< 0) ? ret
: len
;
980 static const char * const iio_scan_elements_group_name
= "scan_elements";
982 static ssize_t
iio_buffer_show_watermark(struct device
*dev
,
983 struct device_attribute
*attr
,
986 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
987 struct iio_buffer
*buffer
= indio_dev
->buffer
;
989 return sprintf(buf
, "%u\n", buffer
->watermark
);
992 static ssize_t
iio_buffer_store_watermark(struct device
*dev
,
993 struct device_attribute
*attr
,
997 struct iio_dev
*indio_dev
= dev_to_iio_dev(dev
);
998 struct iio_buffer
*buffer
= indio_dev
->buffer
;
1002 ret
= kstrtouint(buf
, 10, &val
);
1008 mutex_lock(&indio_dev
->mlock
);
1010 if (val
> buffer
->length
) {
1015 if (iio_buffer_is_active(indio_dev
->buffer
)) {
1020 buffer
->watermark
= val
;
1022 mutex_unlock(&indio_dev
->mlock
);
1024 return ret
? ret
: len
;
1027 static DEVICE_ATTR(length
, S_IRUGO
| S_IWUSR
, iio_buffer_read_length
,
1028 iio_buffer_write_length
);
1029 static struct device_attribute dev_attr_length_ro
= __ATTR(length
,
1030 S_IRUGO
, iio_buffer_read_length
, NULL
);
1031 static DEVICE_ATTR(enable
, S_IRUGO
| S_IWUSR
,
1032 iio_buffer_show_enable
, iio_buffer_store_enable
);
1033 static DEVICE_ATTR(watermark
, S_IRUGO
| S_IWUSR
,
1034 iio_buffer_show_watermark
, iio_buffer_store_watermark
);
1035 static struct device_attribute dev_attr_watermark_ro
= __ATTR(watermark
,
1036 S_IRUGO
, iio_buffer_show_watermark
, NULL
);
1038 static struct attribute
*iio_buffer_attrs
[] = {
1039 &dev_attr_length
.attr
,
1040 &dev_attr_enable
.attr
,
1041 &dev_attr_watermark
.attr
,
1044 int iio_buffer_alloc_sysfs_and_mask(struct iio_dev
*indio_dev
)
1046 struct iio_dev_attr
*p
;
1047 struct attribute
**attr
;
1048 struct iio_buffer
*buffer
= indio_dev
->buffer
;
1049 int ret
, i
, attrn
, attrcount
, attrcount_orig
= 0;
1050 const struct iio_chan_spec
*channels
;
1052 channels
= indio_dev
->channels
;
1054 int ml
= indio_dev
->masklength
;
1056 for (i
= 0; i
< indio_dev
->num_channels
; i
++)
1057 ml
= max(ml
, channels
[i
].scan_index
+ 1);
1058 indio_dev
->masklength
= ml
;
1065 if (buffer
->attrs
) {
1066 while (buffer
->attrs
[attrcount
] != NULL
)
1070 attr
= kcalloc(attrcount
+ ARRAY_SIZE(iio_buffer_attrs
) + 1,
1071 sizeof(struct attribute
*), GFP_KERNEL
);
1075 memcpy(attr
, iio_buffer_attrs
, sizeof(iio_buffer_attrs
));
1076 if (!buffer
->access
->set_length
)
1077 attr
[0] = &dev_attr_length_ro
.attr
;
1079 if (buffer
->access
->flags
& INDIO_BUFFER_FLAG_FIXED_WATERMARK
)
1080 attr
[2] = &dev_attr_watermark_ro
.attr
;
1083 memcpy(&attr
[ARRAY_SIZE(iio_buffer_attrs
)], buffer
->attrs
,
1084 sizeof(struct attribute
*) * attrcount
);
1086 attr
[attrcount
+ ARRAY_SIZE(iio_buffer_attrs
)] = NULL
;
1088 buffer
->buffer_group
.name
= "buffer";
1089 buffer
->buffer_group
.attrs
= attr
;
1091 indio_dev
->groups
[indio_dev
->groupcounter
++] = &buffer
->buffer_group
;
1093 if (buffer
->scan_el_attrs
!= NULL
) {
1094 attr
= buffer
->scan_el_attrs
->attrs
;
1095 while (*attr
++ != NULL
)
1098 attrcount
= attrcount_orig
;
1099 INIT_LIST_HEAD(&buffer
->scan_el_dev_attr_list
);
1100 channels
= indio_dev
->channels
;
1103 for (i
= 0; i
< indio_dev
->num_channels
; i
++) {
1104 if (channels
[i
].scan_index
< 0)
1107 ret
= iio_buffer_add_channel_sysfs(indio_dev
,
1110 goto error_cleanup_dynamic
;
1112 if (channels
[i
].type
== IIO_TIMESTAMP
)
1113 indio_dev
->scan_index_timestamp
=
1114 channels
[i
].scan_index
;
1116 if (indio_dev
->masklength
&& buffer
->scan_mask
== NULL
) {
1117 buffer
->scan_mask
= kcalloc(BITS_TO_LONGS(indio_dev
->masklength
),
1118 sizeof(*buffer
->scan_mask
),
1120 if (buffer
->scan_mask
== NULL
) {
1122 goto error_cleanup_dynamic
;
1127 buffer
->scan_el_group
.name
= iio_scan_elements_group_name
;
1129 buffer
->scan_el_group
.attrs
= kcalloc(attrcount
+ 1,
1130 sizeof(buffer
->scan_el_group
.attrs
[0]),
1132 if (buffer
->scan_el_group
.attrs
== NULL
) {
1134 goto error_free_scan_mask
;
1136 if (buffer
->scan_el_attrs
)
1137 memcpy(buffer
->scan_el_group
.attrs
, buffer
->scan_el_attrs
,
1138 sizeof(buffer
->scan_el_group
.attrs
[0])*attrcount_orig
);
1139 attrn
= attrcount_orig
;
1141 list_for_each_entry(p
, &buffer
->scan_el_dev_attr_list
, l
)
1142 buffer
->scan_el_group
.attrs
[attrn
++] = &p
->dev_attr
.attr
;
1143 indio_dev
->groups
[indio_dev
->groupcounter
++] = &buffer
->scan_el_group
;
1147 error_free_scan_mask
:
1148 kfree(buffer
->scan_mask
);
1149 error_cleanup_dynamic
:
1150 iio_free_chan_devattr_list(&buffer
->scan_el_dev_attr_list
);
1151 kfree(indio_dev
->buffer
->buffer_group
.attrs
);
1156 void iio_buffer_free_sysfs_and_mask(struct iio_dev
*indio_dev
)
1158 if (!indio_dev
->buffer
)
1161 kfree(indio_dev
->buffer
->scan_mask
);
1162 kfree(indio_dev
->buffer
->buffer_group
.attrs
);
1163 kfree(indio_dev
->buffer
->scan_el_group
.attrs
);
1164 iio_free_chan_devattr_list(&indio_dev
->buffer
->scan_el_dev_attr_list
);
1168 * iio_validate_scan_mask_onehot() - Validates that exactly one channel is selected
1169 * @indio_dev: the iio device
1170 * @mask: scan mask to be checked
1172 * Return true if exactly one bit is set in the scan mask, false otherwise. It
1173 * can be used for devices where only one channel can be active for sampling at
1176 bool iio_validate_scan_mask_onehot(struct iio_dev
*indio_dev
,
1177 const unsigned long *mask
)
1179 return bitmap_weight(mask
, indio_dev
->masklength
) == 1;
1181 EXPORT_SYMBOL_GPL(iio_validate_scan_mask_onehot
);
1183 int iio_scan_mask_query(struct iio_dev
*indio_dev
,
1184 struct iio_buffer
*buffer
, int bit
)
1186 if (bit
> indio_dev
->masklength
)
1189 if (!buffer
->scan_mask
)
1192 /* Ensure return value is 0 or 1. */
1193 return !!test_bit(bit
, buffer
->scan_mask
);
1195 EXPORT_SYMBOL_GPL(iio_scan_mask_query
);
1198 * struct iio_demux_table - table describing demux memcpy ops
1199 * @from: index to copy from
1200 * @to: index to copy to
1201 * @length: how many bytes to copy
1202 * @l: list head used for management
1204 struct iio_demux_table
{
1211 static const void *iio_demux(struct iio_buffer
*buffer
,
1214 struct iio_demux_table
*t
;
1216 if (list_empty(&buffer
->demux_list
))
1218 list_for_each_entry(t
, &buffer
->demux_list
, l
)
1219 memcpy(buffer
->demux_bounce
+ t
->to
,
1220 datain
+ t
->from
, t
->length
);
1222 return buffer
->demux_bounce
;
1225 static int iio_push_to_buffer(struct iio_buffer
*buffer
, const void *data
)
1227 const void *dataout
= iio_demux(buffer
, data
);
1230 ret
= buffer
->access
->store_to(buffer
, dataout
);
1235 * We can't just test for watermark to decide if we wake the poll queue
1236 * because read may request less samples than the watermark.
1238 wake_up_interruptible_poll(&buffer
->pollq
, POLLIN
| POLLRDNORM
);
1242 static void iio_buffer_demux_free(struct iio_buffer
*buffer
)
1244 struct iio_demux_table
*p
, *q
;
1245 list_for_each_entry_safe(p
, q
, &buffer
->demux_list
, l
) {
1252 int iio_push_to_buffers(struct iio_dev
*indio_dev
, const void *data
)
1255 struct iio_buffer
*buf
;
1257 list_for_each_entry(buf
, &indio_dev
->buffer_list
, buffer_list
) {
1258 ret
= iio_push_to_buffer(buf
, data
);
1265 EXPORT_SYMBOL_GPL(iio_push_to_buffers
);
1267 static int iio_buffer_add_demux(struct iio_buffer
*buffer
,
1268 struct iio_demux_table
**p
, unsigned int in_loc
, unsigned int out_loc
,
1269 unsigned int length
)
1272 if (*p
&& (*p
)->from
+ (*p
)->length
== in_loc
&&
1273 (*p
)->to
+ (*p
)->length
== out_loc
) {
1274 (*p
)->length
+= length
;
1276 *p
= kmalloc(sizeof(**p
), GFP_KERNEL
);
1279 (*p
)->from
= in_loc
;
1281 (*p
)->length
= length
;
1282 list_add_tail(&(*p
)->l
, &buffer
->demux_list
);
1288 static int iio_buffer_update_demux(struct iio_dev
*indio_dev
,
1289 struct iio_buffer
*buffer
)
1291 const struct iio_chan_spec
*ch
;
1292 int ret
, in_ind
= -1, out_ind
, length
;
1293 unsigned in_loc
= 0, out_loc
= 0;
1294 struct iio_demux_table
*p
= NULL
;
1296 /* Clear out any old demux */
1297 iio_buffer_demux_free(buffer
);
1298 kfree(buffer
->demux_bounce
);
1299 buffer
->demux_bounce
= NULL
;
1301 /* First work out which scan mode we will actually have */
1302 if (bitmap_equal(indio_dev
->active_scan_mask
,
1304 indio_dev
->masklength
))
1307 /* Now we have the two masks, work from least sig and build up sizes */
1308 for_each_set_bit(out_ind
,
1310 indio_dev
->masklength
) {
1311 in_ind
= find_next_bit(indio_dev
->active_scan_mask
,
1312 indio_dev
->masklength
,
1314 while (in_ind
!= out_ind
) {
1315 in_ind
= find_next_bit(indio_dev
->active_scan_mask
,
1316 indio_dev
->masklength
,
1318 ch
= iio_find_channel_from_si(indio_dev
, in_ind
);
1319 if (ch
->scan_type
.repeat
> 1)
1320 length
= ch
->scan_type
.storagebits
/ 8 *
1321 ch
->scan_type
.repeat
;
1323 length
= ch
->scan_type
.storagebits
/ 8;
1324 /* Make sure we are aligned */
1325 in_loc
= roundup(in_loc
, length
) + length
;
1327 ch
= iio_find_channel_from_si(indio_dev
, in_ind
);
1328 if (ch
->scan_type
.repeat
> 1)
1329 length
= ch
->scan_type
.storagebits
/ 8 *
1330 ch
->scan_type
.repeat
;
1332 length
= ch
->scan_type
.storagebits
/ 8;
1333 out_loc
= roundup(out_loc
, length
);
1334 in_loc
= roundup(in_loc
, length
);
1335 ret
= iio_buffer_add_demux(buffer
, &p
, in_loc
, out_loc
, length
);
1337 goto error_clear_mux_table
;
1341 /* Relies on scan_timestamp being last */
1342 if (buffer
->scan_timestamp
) {
1343 ch
= iio_find_channel_from_si(indio_dev
,
1344 indio_dev
->scan_index_timestamp
);
1345 if (ch
->scan_type
.repeat
> 1)
1346 length
= ch
->scan_type
.storagebits
/ 8 *
1347 ch
->scan_type
.repeat
;
1349 length
= ch
->scan_type
.storagebits
/ 8;
1350 out_loc
= roundup(out_loc
, length
);
1351 in_loc
= roundup(in_loc
, length
);
1352 ret
= iio_buffer_add_demux(buffer
, &p
, in_loc
, out_loc
, length
);
1354 goto error_clear_mux_table
;
1358 buffer
->demux_bounce
= kzalloc(out_loc
, GFP_KERNEL
);
1359 if (buffer
->demux_bounce
== NULL
) {
1361 goto error_clear_mux_table
;
1365 error_clear_mux_table
:
1366 iio_buffer_demux_free(buffer
);
1371 int iio_update_demux(struct iio_dev
*indio_dev
)
1373 struct iio_buffer
*buffer
;
1376 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
) {
1377 ret
= iio_buffer_update_demux(indio_dev
, buffer
);
1379 goto error_clear_mux_table
;
1383 error_clear_mux_table
:
1384 list_for_each_entry(buffer
, &indio_dev
->buffer_list
, buffer_list
)
1385 iio_buffer_demux_free(buffer
);
1389 EXPORT_SYMBOL_GPL(iio_update_demux
);
1392 * iio_buffer_release() - Free a buffer's resources
1393 * @ref: Pointer to the kref embedded in the iio_buffer struct
1395 * This function is called when the last reference to the buffer has been
1396 * dropped. It will typically free all resources allocated by the buffer. Do not
1397 * call this function manually, always use iio_buffer_put() when done using a
1400 static void iio_buffer_release(struct kref
*ref
)
1402 struct iio_buffer
*buffer
= container_of(ref
, struct iio_buffer
, ref
);
1404 buffer
->access
->release(buffer
);
1408 * iio_buffer_get() - Grab a reference to the buffer
1409 * @buffer: The buffer to grab a reference for, may be NULL
1411 * Returns the pointer to the buffer that was passed into the function.
1413 struct iio_buffer
*iio_buffer_get(struct iio_buffer
*buffer
)
1416 kref_get(&buffer
->ref
);
1420 EXPORT_SYMBOL_GPL(iio_buffer_get
);
1423 * iio_buffer_put() - Release the reference to the buffer
1424 * @buffer: The buffer to release the reference for, may be NULL
1426 void iio_buffer_put(struct iio_buffer
*buffer
)
1429 kref_put(&buffer
->ref
, iio_buffer_release
);
1431 EXPORT_SYMBOL_GPL(iio_buffer_put
);