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 if (!buffer->watermark)
208 buffer->watermark = 1;
210 EXPORT_SYMBOL(iio_buffer_init);
212 static ssize_t iio_show_scan_index(struct device *dev,
213 struct device_attribute *attr,
216 return sprintf(buf, "%u\n", to_iio_dev_attr(attr)->c->scan_index);
219 static ssize_t iio_show_fixed_type(struct device *dev,
220 struct device_attribute *attr,
223 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
224 u8 type = this_attr->c->scan_type.endianness;
226 if (type == IIO_CPU) {
227 #ifdef __LITTLE_ENDIAN
233 if (this_attr->c->scan_type.repeat > 1)
234 return sprintf(buf, "%s:%c%d/%dX%d>>%u\n",
235 iio_endian_prefix[type],
236 this_attr->c->scan_type.sign,
237 this_attr->c->scan_type.realbits,
238 this_attr->c->scan_type.storagebits,
239 this_attr->c->scan_type.repeat,
240 this_attr->c->scan_type.shift);
242 return sprintf(buf, "%s:%c%d/%d>>%u\n",
243 iio_endian_prefix[type],
244 this_attr->c->scan_type.sign,
245 this_attr->c->scan_type.realbits,
246 this_attr->c->scan_type.storagebits,
247 this_attr->c->scan_type.shift);
250 static ssize_t iio_scan_el_show(struct device *dev,
251 struct device_attribute *attr,
255 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
257 /* Ensure ret is 0 or 1. */
258 ret = !!test_bit(to_iio_dev_attr(attr)->address,
259 indio_dev->buffer->scan_mask);
261 return sprintf(buf, "%d\n", ret);
264 /* Note NULL used as error indicator as it doesn't make sense. */
265 static const unsigned long *iio_scan_mask_match(const unsigned long *av_masks,
266 unsigned int masklength,
267 const unsigned long *mask,
270 if (bitmap_empty(mask, masklength))
274 if (bitmap_equal(mask, av_masks, masklength))
277 if (bitmap_subset(mask, av_masks, masklength))
280 av_masks += BITS_TO_LONGS(masklength);
285 static bool iio_validate_scan_mask(struct iio_dev *indio_dev,
286 const unsigned long *mask)
288 if (!indio_dev->setup_ops->validate_scan_mask)
291 return indio_dev->setup_ops->validate_scan_mask(indio_dev, mask);
295 * iio_scan_mask_set() - set particular bit in the scan mask
296 * @indio_dev: the iio device
297 * @buffer: the buffer whose scan mask we are interested in
298 * @bit: the bit to be set.
300 * Note that at this point we have no way of knowing what other
301 * buffers might request, hence this code only verifies that the
302 * individual buffers request is plausible.
304 static int iio_scan_mask_set(struct iio_dev *indio_dev,
305 struct iio_buffer *buffer, int bit)
307 const unsigned long *mask;
308 unsigned long *trialmask;
310 trialmask = kmalloc(sizeof(*trialmask)*
311 BITS_TO_LONGS(indio_dev->masklength),
314 if (trialmask == NULL)
316 if (!indio_dev->masklength) {
317 WARN(1, "Trying to set scanmask prior to registering buffer\n");
318 goto err_invalid_mask;
320 bitmap_copy(trialmask, buffer->scan_mask, indio_dev->masklength);
321 set_bit(bit, trialmask);
323 if (!iio_validate_scan_mask(indio_dev, trialmask))
324 goto err_invalid_mask;
326 if (indio_dev->available_scan_masks) {
327 mask = iio_scan_mask_match(indio_dev->available_scan_masks,
328 indio_dev->masklength,
331 goto err_invalid_mask;
333 bitmap_copy(buffer->scan_mask, trialmask, indio_dev->masklength);
344 static int iio_scan_mask_clear(struct iio_buffer *buffer, int bit)
346 clear_bit(bit, buffer->scan_mask);
350 static ssize_t iio_scan_el_store(struct device *dev,
351 struct device_attribute *attr,
357 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
358 struct iio_buffer *buffer = indio_dev->buffer;
359 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
361 ret = strtobool(buf, &state);
364 mutex_lock(&indio_dev->mlock);
365 if (iio_buffer_is_active(indio_dev->buffer)) {
369 ret = iio_scan_mask_query(indio_dev, buffer, this_attr->address);
373 ret = iio_scan_mask_clear(buffer, this_attr->address);
376 } else if (state && !ret) {
377 ret = iio_scan_mask_set(indio_dev, buffer, this_attr->address);
383 mutex_unlock(&indio_dev->mlock);
385 return ret < 0 ? ret : len;
389 static ssize_t iio_scan_el_ts_show(struct device *dev,
390 struct device_attribute *attr,
393 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
394 return sprintf(buf, "%d\n", indio_dev->buffer->scan_timestamp);
397 static ssize_t iio_scan_el_ts_store(struct device *dev,
398 struct device_attribute *attr,
403 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
406 ret = strtobool(buf, &state);
410 mutex_lock(&indio_dev->mlock);
411 if (iio_buffer_is_active(indio_dev->buffer)) {
415 indio_dev->buffer->scan_timestamp = state;
417 mutex_unlock(&indio_dev->mlock);
419 return ret ? ret : len;
422 static int iio_buffer_add_channel_sysfs(struct iio_dev *indio_dev,
423 const struct iio_chan_spec *chan)
425 int ret, attrcount = 0;
426 struct iio_buffer *buffer = indio_dev->buffer;
428 ret = __iio_add_chan_devattr("index",
430 &iio_show_scan_index,
435 &buffer->scan_el_dev_attr_list);
439 ret = __iio_add_chan_devattr("type",
441 &iio_show_fixed_type,
446 &buffer->scan_el_dev_attr_list);
450 if (chan->type != IIO_TIMESTAMP)
451 ret = __iio_add_chan_devattr("en",
458 &buffer->scan_el_dev_attr_list);
460 ret = __iio_add_chan_devattr("en",
462 &iio_scan_el_ts_show,
463 &iio_scan_el_ts_store,
467 &buffer->scan_el_dev_attr_list);
475 static ssize_t iio_buffer_read_length(struct device *dev,
476 struct device_attribute *attr,
479 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
480 struct iio_buffer *buffer = indio_dev->buffer;
482 return sprintf(buf, "%d\n", buffer->length);
485 static ssize_t iio_buffer_write_length(struct device *dev,
486 struct device_attribute *attr,
487 const char *buf, size_t len)
489 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
490 struct iio_buffer *buffer = indio_dev->buffer;
494 ret = kstrtouint(buf, 10, &val);
498 if (val == buffer->length)
501 mutex_lock(&indio_dev->mlock);
502 if (iio_buffer_is_active(indio_dev->buffer)) {
505 buffer->access->set_length(buffer, val);
510 if (buffer->length && buffer->length < buffer->watermark)
511 buffer->watermark = buffer->length;
513 mutex_unlock(&indio_dev->mlock);
515 return ret ? ret : len;
518 static ssize_t iio_buffer_show_enable(struct device *dev,
519 struct device_attribute *attr,
522 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
523 return sprintf(buf, "%d\n", iio_buffer_is_active(indio_dev->buffer));
526 static unsigned int iio_storage_bytes_for_si(struct iio_dev *indio_dev,
527 unsigned int scan_index)
529 const struct iio_chan_spec *ch;
532 ch = iio_find_channel_from_si(indio_dev, scan_index);
533 bytes = ch->scan_type.storagebits / 8;
534 if (ch->scan_type.repeat > 1)
535 bytes *= ch->scan_type.repeat;
539 static unsigned int iio_storage_bytes_for_timestamp(struct iio_dev *indio_dev)
541 return iio_storage_bytes_for_si(indio_dev,
542 indio_dev->scan_index_timestamp);
545 static int iio_compute_scan_bytes(struct iio_dev *indio_dev,
546 const unsigned long *mask, bool timestamp)
549 int length, i, largest = 0;
551 /* How much space will the demuxed element take? */
552 for_each_set_bit(i, mask,
553 indio_dev->masklength) {
554 length = iio_storage_bytes_for_si(indio_dev, i);
555 bytes = ALIGN(bytes, length);
557 largest = max(largest, length);
561 length = iio_storage_bytes_for_timestamp(indio_dev);
562 bytes = ALIGN(bytes, length);
564 largest = max(largest, length);
567 bytes = ALIGN(bytes, largest);
571 static void iio_buffer_activate(struct iio_dev *indio_dev,
572 struct iio_buffer *buffer)
574 iio_buffer_get(buffer);
575 list_add(&buffer->buffer_list, &indio_dev->buffer_list);
578 static void iio_buffer_deactivate(struct iio_buffer *buffer)
580 list_del_init(&buffer->buffer_list);
581 wake_up_interruptible(&buffer->pollq);
582 iio_buffer_put(buffer);
585 static void iio_buffer_deactivate_all(struct iio_dev *indio_dev)
587 struct iio_buffer *buffer, *_buffer;
589 list_for_each_entry_safe(buffer, _buffer,
590 &indio_dev->buffer_list, buffer_list)
591 iio_buffer_deactivate(buffer);
594 static int iio_buffer_enable(struct iio_buffer *buffer,
595 struct iio_dev *indio_dev)
597 if (!buffer->access->enable)
599 return buffer->access->enable(buffer, indio_dev);
602 static int iio_buffer_disable(struct iio_buffer *buffer,
603 struct iio_dev *indio_dev)
605 if (!buffer->access->disable)
607 return buffer->access->disable(buffer, indio_dev);
610 static void iio_buffer_update_bytes_per_datum(struct iio_dev *indio_dev,
611 struct iio_buffer *buffer)
615 if (!buffer->access->set_bytes_per_datum)
618 bytes = iio_compute_scan_bytes(indio_dev, buffer->scan_mask,
619 buffer->scan_timestamp);
621 buffer->access->set_bytes_per_datum(buffer, bytes);
624 static int iio_buffer_request_update(struct iio_dev *indio_dev,
625 struct iio_buffer *buffer)
629 iio_buffer_update_bytes_per_datum(indio_dev, buffer);
630 if (buffer->access->request_update) {
631 ret = buffer->access->request_update(buffer);
633 dev_dbg(&indio_dev->dev,
634 "Buffer not started: buffer parameter update failed (%d)\n",
643 static void iio_free_scan_mask(struct iio_dev *indio_dev,
644 const unsigned long *mask)
646 /* If the mask is dynamically allocated free it, otherwise do nothing */
647 if (!indio_dev->available_scan_masks)
651 struct iio_device_config {
653 unsigned int watermark;
654 const unsigned long *scan_mask;
655 unsigned int scan_bytes;
659 static int iio_verify_update(struct iio_dev *indio_dev,
660 struct iio_buffer *insert_buffer, struct iio_buffer *remove_buffer,
661 struct iio_device_config *config)
663 unsigned long *compound_mask;
664 const unsigned long *scan_mask;
665 bool strict_scanmask = false;
666 struct iio_buffer *buffer;
670 memset(config, 0, sizeof(*config));
671 config->watermark = ~0;
674 * If there is just one buffer and we are removing it there is nothing
677 if (remove_buffer && !insert_buffer &&
678 list_is_singular(&indio_dev->buffer_list))
681 modes = indio_dev->modes;
683 list_for_each_entry(buffer, &indio_dev->buffer_list, buffer_list) {
684 if (buffer == remove_buffer)
686 modes &= buffer->access->modes;
687 config->watermark = min(config->watermark, buffer->watermark);
691 modes &= insert_buffer->access->modes;
692 config->watermark = min(config->watermark,
693 insert_buffer->watermark);
696 /* Definitely possible for devices to support both of these. */
697 if ((modes & INDIO_BUFFER_TRIGGERED) && indio_dev->trig) {
698 config->mode = INDIO_BUFFER_TRIGGERED;
699 } else if (modes & INDIO_BUFFER_HARDWARE) {
701 * Keep things simple for now and only allow a single buffer to
702 * be connected in hardware mode.
704 if (insert_buffer && !list_empty(&indio_dev->buffer_list))
706 config->mode = INDIO_BUFFER_HARDWARE;
707 strict_scanmask = true;
708 } else if (modes & INDIO_BUFFER_SOFTWARE) {
709 config->mode = INDIO_BUFFER_SOFTWARE;
711 /* Can only occur on first buffer */
712 if (indio_dev->modes & INDIO_BUFFER_TRIGGERED)
713 dev_dbg(&indio_dev->dev, "Buffer not started: no trigger\n");
717 /* What scan mask do we actually have? */
718 compound_mask = kcalloc(BITS_TO_LONGS(indio_dev->masklength),
719 sizeof(long), GFP_KERNEL);
720 if (compound_mask == NULL)
723 scan_timestamp = false;
725 list_for_each_entry(buffer, &indio_dev->buffer_list, buffer_list) {
726 if (buffer == remove_buffer)
728 bitmap_or(compound_mask, compound_mask, buffer->scan_mask,
729 indio_dev->masklength);
730 scan_timestamp |= buffer->scan_timestamp;
734 bitmap_or(compound_mask, compound_mask,
735 insert_buffer->scan_mask, indio_dev->masklength);
736 scan_timestamp |= insert_buffer->scan_timestamp;
739 if (indio_dev->available_scan_masks) {
740 scan_mask = iio_scan_mask_match(indio_dev->available_scan_masks,
741 indio_dev->masklength,
744 kfree(compound_mask);
745 if (scan_mask == NULL)
748 scan_mask = compound_mask;
751 config->scan_bytes = iio_compute_scan_bytes(indio_dev,
752 scan_mask, scan_timestamp);
753 config->scan_mask = scan_mask;
754 config->scan_timestamp = scan_timestamp;
759 static int iio_enable_buffers(struct iio_dev *indio_dev,
760 struct iio_device_config *config)
762 struct iio_buffer *buffer;
765 indio_dev->active_scan_mask = config->scan_mask;
766 indio_dev->scan_timestamp = config->scan_timestamp;
767 indio_dev->scan_bytes = config->scan_bytes;
769 iio_update_demux(indio_dev);
772 if (indio_dev->setup_ops->preenable) {
773 ret = indio_dev->setup_ops->preenable(indio_dev);
775 dev_dbg(&indio_dev->dev,
776 "Buffer not started: buffer preenable failed (%d)\n", ret);
777 goto err_undo_config;
781 if (indio_dev->info->update_scan_mode) {
782 ret = indio_dev->info
783 ->update_scan_mode(indio_dev,
784 indio_dev->active_scan_mask);
786 dev_dbg(&indio_dev->dev,
787 "Buffer not started: update scan mode failed (%d)\n",
789 goto err_run_postdisable;
793 if (indio_dev->info->hwfifo_set_watermark)
794 indio_dev->info->hwfifo_set_watermark(indio_dev,
797 list_for_each_entry(buffer, &indio_dev->buffer_list, buffer_list) {
798 ret = iio_buffer_enable(buffer, indio_dev);
800 goto err_disable_buffers;
803 indio_dev->currentmode = config->mode;
805 if (indio_dev->setup_ops->postenable) {
806 ret = indio_dev->setup_ops->postenable(indio_dev);
808 dev_dbg(&indio_dev->dev,
809 "Buffer not started: postenable failed (%d)\n", ret);
810 goto err_disable_buffers;
817 list_for_each_entry_continue_reverse(buffer, &indio_dev->buffer_list,
819 iio_buffer_disable(buffer, indio_dev);
821 indio_dev->currentmode = INDIO_DIRECT_MODE;
822 if (indio_dev->setup_ops->postdisable)
823 indio_dev->setup_ops->postdisable(indio_dev);
825 indio_dev->active_scan_mask = NULL;
830 static int iio_disable_buffers(struct iio_dev *indio_dev)
832 struct iio_buffer *buffer;
836 /* Wind down existing buffers - iff there are any */
837 if (list_empty(&indio_dev->buffer_list))
841 * If things go wrong at some step in disable we still need to continue
842 * to perform the other steps, otherwise we leave the device in a
843 * inconsistent state. We return the error code for the first error we
847 if (indio_dev->setup_ops->predisable) {
848 ret2 = indio_dev->setup_ops->predisable(indio_dev);
853 list_for_each_entry(buffer, &indio_dev->buffer_list, buffer_list) {
854 ret2 = iio_buffer_disable(buffer, indio_dev);
859 indio_dev->currentmode = INDIO_DIRECT_MODE;
861 if (indio_dev->setup_ops->postdisable) {
862 ret2 = indio_dev->setup_ops->postdisable(indio_dev);
867 iio_free_scan_mask(indio_dev, indio_dev->active_scan_mask);
868 indio_dev->active_scan_mask = NULL;
873 static int __iio_update_buffers(struct iio_dev *indio_dev,
874 struct iio_buffer *insert_buffer,
875 struct iio_buffer *remove_buffer)
877 struct iio_device_config new_config;
880 ret = iio_verify_update(indio_dev, insert_buffer, remove_buffer,
886 ret = iio_buffer_request_update(indio_dev, insert_buffer);
888 goto err_free_config;
891 ret = iio_disable_buffers(indio_dev);
893 goto err_deactivate_all;
896 iio_buffer_deactivate(remove_buffer);
898 iio_buffer_activate(indio_dev, insert_buffer);
900 /* If no buffers in list, we are done */
901 if (list_empty(&indio_dev->buffer_list))
904 ret = iio_enable_buffers(indio_dev, &new_config);
906 goto err_deactivate_all;
912 * We've already verified that the config is valid earlier. If things go
913 * wrong in either enable or disable the most likely reason is an IO
914 * error from the device. In this case there is no good recovery
915 * strategy. Just make sure to disable everything and leave the device
916 * in a sane state. With a bit of luck the device might come back to
917 * life again later and userspace can try again.
919 iio_buffer_deactivate_all(indio_dev);
922 iio_free_scan_mask(indio_dev, new_config.scan_mask);
926 int iio_update_buffers(struct iio_dev *indio_dev,
927 struct iio_buffer *insert_buffer,
928 struct iio_buffer *remove_buffer)
932 if (insert_buffer == remove_buffer)
935 mutex_lock(&indio_dev->info_exist_lock);
936 mutex_lock(&indio_dev->mlock);
938 if (insert_buffer && iio_buffer_is_active(insert_buffer))
939 insert_buffer = NULL;
941 if (remove_buffer && !iio_buffer_is_active(remove_buffer))
942 remove_buffer = NULL;
944 if (!insert_buffer && !remove_buffer) {
949 if (indio_dev->info == NULL) {
954 ret = __iio_update_buffers(indio_dev, insert_buffer, remove_buffer);
957 mutex_unlock(&indio_dev->mlock);
958 mutex_unlock(&indio_dev->info_exist_lock);
962 EXPORT_SYMBOL_GPL(iio_update_buffers);
964 void iio_disable_all_buffers(struct iio_dev *indio_dev)
966 iio_disable_buffers(indio_dev);
967 iio_buffer_deactivate_all(indio_dev);
970 static ssize_t iio_buffer_store_enable(struct device *dev,
971 struct device_attribute *attr,
976 bool requested_state;
977 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
980 ret = strtobool(buf, &requested_state);
984 mutex_lock(&indio_dev->mlock);
986 /* Find out if it is in the list */
987 inlist = iio_buffer_is_active(indio_dev->buffer);
988 /* Already in desired state */
989 if (inlist == requested_state)
993 ret = __iio_update_buffers(indio_dev,
994 indio_dev->buffer, NULL);
996 ret = __iio_update_buffers(indio_dev,
997 NULL, indio_dev->buffer);
1000 mutex_unlock(&indio_dev->mlock);
1001 return (ret < 0) ? ret : len;
1004 static const char * const iio_scan_elements_group_name = "scan_elements";
1006 static ssize_t iio_buffer_show_watermark(struct device *dev,
1007 struct device_attribute *attr,
1010 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
1011 struct iio_buffer *buffer = indio_dev->buffer;
1013 return sprintf(buf, "%u\n", buffer->watermark);
1016 static ssize_t iio_buffer_store_watermark(struct device *dev,
1017 struct device_attribute *attr,
1021 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
1022 struct iio_buffer *buffer = indio_dev->buffer;
1026 ret = kstrtouint(buf, 10, &val);
1032 mutex_lock(&indio_dev->mlock);
1034 if (val > buffer->length) {
1039 if (iio_buffer_is_active(indio_dev->buffer)) {
1044 buffer->watermark = val;
1046 mutex_unlock(&indio_dev->mlock);
1048 return ret ? ret : len;
1051 static DEVICE_ATTR(length, S_IRUGO | S_IWUSR, iio_buffer_read_length,
1052 iio_buffer_write_length);
1053 static struct device_attribute dev_attr_length_ro = __ATTR(length,
1054 S_IRUGO, iio_buffer_read_length, NULL);
1055 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR,
1056 iio_buffer_show_enable, iio_buffer_store_enable);
1057 static DEVICE_ATTR(watermark, S_IRUGO | S_IWUSR,
1058 iio_buffer_show_watermark, iio_buffer_store_watermark);
1059 static struct device_attribute dev_attr_watermark_ro = __ATTR(watermark,
1060 S_IRUGO, iio_buffer_show_watermark, NULL);
1062 static struct attribute *iio_buffer_attrs[] = {
1063 &dev_attr_length.attr,
1064 &dev_attr_enable.attr,
1065 &dev_attr_watermark.attr,
1068 int iio_buffer_alloc_sysfs_and_mask(struct iio_dev *indio_dev)
1070 struct iio_dev_attr *p;
1071 struct attribute **attr;
1072 struct iio_buffer *buffer = indio_dev->buffer;
1073 int ret, i, attrn, attrcount, attrcount_orig = 0;
1074 const struct iio_chan_spec *channels;
1076 channels = indio_dev->channels;
1078 int ml = indio_dev->masklength;
1080 for (i = 0; i < indio_dev->num_channels; i++)
1081 ml = max(ml, channels[i].scan_index + 1);
1082 indio_dev->masklength = ml;
1089 if (buffer->attrs) {
1090 while (buffer->attrs[attrcount] != NULL)
1094 attr = kcalloc(attrcount + ARRAY_SIZE(iio_buffer_attrs) + 1,
1095 sizeof(struct attribute *), GFP_KERNEL);
1099 memcpy(attr, iio_buffer_attrs, sizeof(iio_buffer_attrs));
1100 if (!buffer->access->set_length)
1101 attr[0] = &dev_attr_length_ro.attr;
1103 if (buffer->access->flags & INDIO_BUFFER_FLAG_FIXED_WATERMARK)
1104 attr[2] = &dev_attr_watermark_ro.attr;
1107 memcpy(&attr[ARRAY_SIZE(iio_buffer_attrs)], buffer->attrs,
1108 sizeof(struct attribute *) * attrcount);
1110 attr[attrcount + ARRAY_SIZE(iio_buffer_attrs)] = NULL;
1112 buffer->buffer_group.name = "buffer";
1113 buffer->buffer_group.attrs = attr;
1115 indio_dev->groups[indio_dev->groupcounter++] = &buffer->buffer_group;
1117 if (buffer->scan_el_attrs != NULL) {
1118 attr = buffer->scan_el_attrs->attrs;
1119 while (*attr++ != NULL)
1122 attrcount = attrcount_orig;
1123 INIT_LIST_HEAD(&buffer->scan_el_dev_attr_list);
1124 channels = indio_dev->channels;
1127 for (i = 0; i < indio_dev->num_channels; i++) {
1128 if (channels[i].scan_index < 0)
1131 ret = iio_buffer_add_channel_sysfs(indio_dev,
1134 goto error_cleanup_dynamic;
1136 if (channels[i].type == IIO_TIMESTAMP)
1137 indio_dev->scan_index_timestamp =
1138 channels[i].scan_index;
1140 if (indio_dev->masklength && buffer->scan_mask == NULL) {
1141 buffer->scan_mask = kcalloc(BITS_TO_LONGS(indio_dev->masklength),
1142 sizeof(*buffer->scan_mask),
1144 if (buffer->scan_mask == NULL) {
1146 goto error_cleanup_dynamic;
1151 buffer->scan_el_group.name = iio_scan_elements_group_name;
1153 buffer->scan_el_group.attrs = kcalloc(attrcount + 1,
1154 sizeof(buffer->scan_el_group.attrs[0]),
1156 if (buffer->scan_el_group.attrs == NULL) {
1158 goto error_free_scan_mask;
1160 if (buffer->scan_el_attrs)
1161 memcpy(buffer->scan_el_group.attrs, buffer->scan_el_attrs,
1162 sizeof(buffer->scan_el_group.attrs[0])*attrcount_orig);
1163 attrn = attrcount_orig;
1165 list_for_each_entry(p, &buffer->scan_el_dev_attr_list, l)
1166 buffer->scan_el_group.attrs[attrn++] = &p->dev_attr.attr;
1167 indio_dev->groups[indio_dev->groupcounter++] = &buffer->scan_el_group;
1171 error_free_scan_mask:
1172 kfree(buffer->scan_mask);
1173 error_cleanup_dynamic:
1174 iio_free_chan_devattr_list(&buffer->scan_el_dev_attr_list);
1175 kfree(indio_dev->buffer->buffer_group.attrs);
1180 void iio_buffer_free_sysfs_and_mask(struct iio_dev *indio_dev)
1182 if (!indio_dev->buffer)
1185 kfree(indio_dev->buffer->scan_mask);
1186 kfree(indio_dev->buffer->buffer_group.attrs);
1187 kfree(indio_dev->buffer->scan_el_group.attrs);
1188 iio_free_chan_devattr_list(&indio_dev->buffer->scan_el_dev_attr_list);
1192 * iio_validate_scan_mask_onehot() - Validates that exactly one channel is selected
1193 * @indio_dev: the iio device
1194 * @mask: scan mask to be checked
1196 * Return true if exactly one bit is set in the scan mask, false otherwise. It
1197 * can be used for devices where only one channel can be active for sampling at
1200 bool iio_validate_scan_mask_onehot(struct iio_dev *indio_dev,
1201 const unsigned long *mask)
1203 return bitmap_weight(mask, indio_dev->masklength) == 1;
1205 EXPORT_SYMBOL_GPL(iio_validate_scan_mask_onehot);
1207 int iio_scan_mask_query(struct iio_dev *indio_dev,
1208 struct iio_buffer *buffer, int bit)
1210 if (bit > indio_dev->masklength)
1213 if (!buffer->scan_mask)
1216 /* Ensure return value is 0 or 1. */
1217 return !!test_bit(bit, buffer->scan_mask);
1219 EXPORT_SYMBOL_GPL(iio_scan_mask_query);
1222 * struct iio_demux_table - table describing demux memcpy ops
1223 * @from: index to copy from
1224 * @to: index to copy to
1225 * @length: how many bytes to copy
1226 * @l: list head used for management
1228 struct iio_demux_table {
1235 static const void *iio_demux(struct iio_buffer *buffer,
1238 struct iio_demux_table *t;
1240 if (list_empty(&buffer->demux_list))
1242 list_for_each_entry(t, &buffer->demux_list, l)
1243 memcpy(buffer->demux_bounce + t->to,
1244 datain + t->from, t->length);
1246 return buffer->demux_bounce;
1249 static int iio_push_to_buffer(struct iio_buffer *buffer, const void *data)
1251 const void *dataout = iio_demux(buffer, data);
1254 ret = buffer->access->store_to(buffer, dataout);
1259 * We can't just test for watermark to decide if we wake the poll queue
1260 * because read may request less samples than the watermark.
1262 wake_up_interruptible_poll(&buffer->pollq, POLLIN | POLLRDNORM);
1266 static void iio_buffer_demux_free(struct iio_buffer *buffer)
1268 struct iio_demux_table *p, *q;
1269 list_for_each_entry_safe(p, q, &buffer->demux_list, l) {
1276 int iio_push_to_buffers(struct iio_dev *indio_dev, const void *data)
1279 struct iio_buffer *buf;
1281 list_for_each_entry(buf, &indio_dev->buffer_list, buffer_list) {
1282 ret = iio_push_to_buffer(buf, data);
1289 EXPORT_SYMBOL_GPL(iio_push_to_buffers);
1291 static int iio_buffer_add_demux(struct iio_buffer *buffer,
1292 struct iio_demux_table **p, unsigned int in_loc, unsigned int out_loc,
1293 unsigned int length)
1296 if (*p && (*p)->from + (*p)->length == in_loc &&
1297 (*p)->to + (*p)->length == out_loc) {
1298 (*p)->length += length;
1300 *p = kmalloc(sizeof(**p), GFP_KERNEL);
1303 (*p)->from = in_loc;
1305 (*p)->length = length;
1306 list_add_tail(&(*p)->l, &buffer->demux_list);
1312 static int iio_buffer_update_demux(struct iio_dev *indio_dev,
1313 struct iio_buffer *buffer)
1315 int ret, in_ind = -1, out_ind, length;
1316 unsigned in_loc = 0, out_loc = 0;
1317 struct iio_demux_table *p = NULL;
1319 /* Clear out any old demux */
1320 iio_buffer_demux_free(buffer);
1321 kfree(buffer->demux_bounce);
1322 buffer->demux_bounce = NULL;
1324 /* First work out which scan mode we will actually have */
1325 if (bitmap_equal(indio_dev->active_scan_mask,
1327 indio_dev->masklength))
1330 /* Now we have the two masks, work from least sig and build up sizes */
1331 for_each_set_bit(out_ind,
1333 indio_dev->masklength) {
1334 in_ind = find_next_bit(indio_dev->active_scan_mask,
1335 indio_dev->masklength,
1337 while (in_ind != out_ind) {
1338 length = iio_storage_bytes_for_si(indio_dev, in_ind);
1339 /* Make sure we are aligned */
1340 in_loc = roundup(in_loc, length) + length;
1341 in_ind = find_next_bit(indio_dev->active_scan_mask,
1342 indio_dev->masklength,
1345 length = iio_storage_bytes_for_si(indio_dev, in_ind);
1346 out_loc = roundup(out_loc, length);
1347 in_loc = roundup(in_loc, length);
1348 ret = iio_buffer_add_demux(buffer, &p, in_loc, out_loc, length);
1350 goto error_clear_mux_table;
1354 /* Relies on scan_timestamp being last */
1355 if (buffer->scan_timestamp) {
1356 length = iio_storage_bytes_for_timestamp(indio_dev);
1357 out_loc = roundup(out_loc, length);
1358 in_loc = roundup(in_loc, length);
1359 ret = iio_buffer_add_demux(buffer, &p, in_loc, out_loc, length);
1361 goto error_clear_mux_table;
1365 buffer->demux_bounce = kzalloc(out_loc, GFP_KERNEL);
1366 if (buffer->demux_bounce == NULL) {
1368 goto error_clear_mux_table;
1372 error_clear_mux_table:
1373 iio_buffer_demux_free(buffer);
1378 int iio_update_demux(struct iio_dev *indio_dev)
1380 struct iio_buffer *buffer;
1383 list_for_each_entry(buffer, &indio_dev->buffer_list, buffer_list) {
1384 ret = iio_buffer_update_demux(indio_dev, buffer);
1386 goto error_clear_mux_table;
1390 error_clear_mux_table:
1391 list_for_each_entry(buffer, &indio_dev->buffer_list, buffer_list)
1392 iio_buffer_demux_free(buffer);
1396 EXPORT_SYMBOL_GPL(iio_update_demux);
1399 * iio_buffer_release() - Free a buffer's resources
1400 * @ref: Pointer to the kref embedded in the iio_buffer struct
1402 * This function is called when the last reference to the buffer has been
1403 * dropped. It will typically free all resources allocated by the buffer. Do not
1404 * call this function manually, always use iio_buffer_put() when done using a
1407 static void iio_buffer_release(struct kref *ref)
1409 struct iio_buffer *buffer = container_of(ref, struct iio_buffer, ref);
1411 buffer->access->release(buffer);
1415 * iio_buffer_get() - Grab a reference to the buffer
1416 * @buffer: The buffer to grab a reference for, may be NULL
1418 * Returns the pointer to the buffer that was passed into the function.
1420 struct iio_buffer *iio_buffer_get(struct iio_buffer *buffer)
1423 kref_get(&buffer->ref);
1427 EXPORT_SYMBOL_GPL(iio_buffer_get);
1430 * iio_buffer_put() - Release the reference to the buffer
1431 * @buffer: The buffer to release the reference for, may be NULL
1433 void iio_buffer_put(struct iio_buffer *buffer)
1436 kref_put(&buffer->ref, iio_buffer_release);
1438 EXPORT_SYMBOL_GPL(iio_buffer_put);