2 * Copyright (c) 2011 Jonathan Cameron
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published by
6 * the Free Software Foundation.
8 * Buffer handling elements of industrial I/O reference driver.
9 * Uses the kfifo buffer.
11 * To test without hardware use the sysfs trigger.
14 #include <linux/kernel.h>
15 #include <linux/export.h>
16 #include <linux/slab.h>
17 #include <linux/interrupt.h>
18 #include <linux/irq.h>
19 #include <linux/bitmap.h>
22 #include "trigger_consumer.h"
23 #include "kfifo_buf.h"
25 #include "iio_simple_dummy.h"
29 static const s16 fakedata[] = {
31 [diffvoltage1m2] = -33,
32 [diffvoltage3m4] = -2,
36 * iio_simple_dummy_trigger_h() - the trigger handler function
37 * @irq: the interrupt number
38 * @p: private data - always a pointer to the poll func.
40 * This is the guts of buffered capture. On a trigger event occuring,
41 * if the pollfunc is attached then this handler is called as a threaded
42 * interrupt (and hence may sleep). It is responsible for grabbing data
43 * from the device and pushing it into the associated buffer.
45 static irqreturn_t iio_simple_dummy_trigger_h(int irq, void *p)
47 struct iio_poll_func *pf = p;
48 struct iio_dev *indio_dev = pf->indio_dev;
49 struct iio_buffer *buffer = indio_dev->buffer;
52 * The datasize is obtained from the buffer. It was stored when
53 * the preenable setup function was called.
55 size_t datasize = buffer->access->get_bytes_per_datum(buffer);
56 u16 *data = kmalloc(datasize, GFP_KERNEL);
60 if (!bitmap_empty(indio_dev->active_scan_mask, indio_dev->masklength)) {
62 * Three common options here:
63 * hardware scans: certain combinations of channels make
64 * up a fast read. The capture will consist of all of them.
65 * Hence we just call the grab data function and fill the
66 * buffer without processing.
67 * sofware scans: can be considered to be random access
68 * so efficient reading is just a case of minimal bus
70 * software culled hardware scans:
71 * occasionally a driver may process the nearest hardware
72 * scan to avoid storing elements that are not desired. This
73 * is the fidliest option by far.
74 * Here lets pretend we have random access. And the values are
75 * in the constant table fakedata.
79 i < bitmap_weight(indio_dev->active_scan_mask,
80 indio_dev->masklength);
82 j = find_next_bit(buffer->scan_mask,
83 indio_dev->masklength, j + 1);
84 /* random access read form the 'device' */
85 data[i] = fakedata[j];
89 /* Store a timestampe at an 8 byte boundary */
90 if (buffer->scan_timestamp)
91 *(s64 *)(((phys_addr_t)data + len
92 + sizeof(s64) - 1) & ~(sizeof(s64) - 1))
94 buffer->access->store_to(buffer, (u8 *)data, pf->timestamp);
99 * Tell the core we are done with this trigger and ready for the
102 iio_trigger_notify_done(indio_dev->trig);
107 static const struct iio_buffer_setup_ops iio_simple_dummy_buffer_setup_ops = {
109 * iio_sw_buffer_preenable:
110 * Generic function for equal sized ring elements + 64 bit timestamp
111 * Assumes that any combination of channels can be enabled.
112 * Typically replaced to implement restrictions on what combinations
113 * can be captured (hardware scan modes).
115 .preenable = &iio_sw_buffer_preenable,
117 * iio_triggered_buffer_postenable:
118 * Generic function that simply attaches the pollfunc to the trigger.
119 * Replace this to mess with hardware state before we attach the
122 .postenable = &iio_triggered_buffer_postenable,
124 * iio_triggered_buffer_predisable:
125 * Generic function that simple detaches the pollfunc from the trigger.
126 * Replace this to put hardware state back again after the trigger is
127 * detached but before userspace knows we have disabled the ring.
129 .predisable = &iio_triggered_buffer_predisable,
132 int iio_simple_dummy_configure_buffer(struct iio_dev *indio_dev)
135 struct iio_buffer *buffer;
137 /* Allocate a buffer to use - here a kfifo */
138 buffer = iio_kfifo_allocate(indio_dev);
139 if (buffer == NULL) {
144 indio_dev->buffer = buffer;
146 /* Enable timestamps by default */
147 buffer->scan_timestamp = true;
150 * Tell the core what device type specific functions should
151 * be run on either side of buffer capture enable / disable.
153 indio_dev->setup_ops = &iio_simple_dummy_buffer_setup_ops;
156 * Configure a polling function.
157 * When a trigger event with this polling function connected
158 * occurs, this function is run. Typically this grabs data
161 * NULL for the top half. This is normally implemented only if we
162 * either want to ping a capture now pin (no sleeping) or grab
163 * a timestamp as close as possible to a data ready trigger firing.
165 * IRQF_ONESHOT ensures irqs are masked such that only one instance
166 * of the handler can run at a time.
168 * "iio_simple_dummy_consumer%d" formatting string for the irq 'name'
169 * as seen under /proc/interrupts. Remaining parameters as per printk.
171 indio_dev->pollfunc = iio_alloc_pollfunc(NULL,
172 &iio_simple_dummy_trigger_h,
175 "iio_simple_dummy_consumer%d",
178 if (indio_dev->pollfunc == NULL) {
180 goto error_free_buffer;
184 * Notify the core that this device is capable of buffered capture
185 * driven by a trigger.
187 indio_dev->modes |= INDIO_BUFFER_TRIGGERED;
191 iio_kfifo_free(indio_dev->buffer);
198 * iio_simple_dummy_unconfigure_buffer() - release buffer resources
199 * @indo_dev: device instance state
201 void iio_simple_dummy_unconfigure_buffer(struct iio_dev *indio_dev)
203 iio_dealloc_pollfunc(indio_dev->pollfunc);
204 iio_kfifo_free(indio_dev->buffer);