drivers/staging/iio/iio_simple_dummy_buffer.c

   1 /**
   2  * Copyright (c) 2011 Jonathan Cameron
   3  *
   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.
   7  *
   8  * Buffer handling elements of industrial I/O reference driver.
   9  * Uses the kfifo buffer.
  10  *
  11  * To test without hardware use the sysfs trigger.
  12  */
  13
  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>
  20
  21 #include "iio.h"
  22 #include "trigger_consumer.h"
  23 #include "kfifo_buf.h"
  24
  25 #include "iio_simple_dummy.h"
  26
  27 /* Some fake data */
  28
  29 static const s16 fakedata[] = {
  30         [voltage0] = 7,
  31         [diffvoltage1m2] = -33,
  32         [diffvoltage3m4] = -2,
  33         [accelx] = 344,
  34 };
  35 /**
  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.
  39  *
  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.
  44  */
  45 static irqreturn_t iio_simple_dummy_trigger_h(int irq, void *p)
  46 {
  47         struct iio_poll_func *pf = p;
  48         struct iio_dev *indio_dev = pf->indio_dev;
  49         struct iio_buffer *buffer = indio_dev->buffer;
  50         int len = 0;
  51         /*
  52          * The datasize is obtained from the buffer. It was stored when
  53          * the preenable setup function was called.
  54          */
  55         size_t datasize = buffer->access->get_bytes_per_datum(buffer);
  56         u16 *data = kmalloc(datasize, GFP_KERNEL);
  57         if (data == NULL)
  58                 return -ENOMEM;
  59
  60         if (!bitmap_empty(indio_dev->active_scan_mask, indio_dev->masklength)) {
  61                 /*
  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
  69                  *   transactions.
  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.
  76                  */
  77                 int i, j;
  78                 for (i = 0, j = 0;
  79                      i < bitmap_weight(indio_dev->active_scan_mask,
  80                                        indio_dev->masklength);
  81                      i++) {
  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];
  86                         len += 2;
  87                 }
  88         }
  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))
  93                         = iio_get_time_ns();
  94         buffer->access->store_to(buffer, (u8 *)data, pf->timestamp);
  95
  96         kfree(data);
  97
  98         /*
  99          * Tell the core we are done with this trigger and ready for the
 100          * next one.
 101          */
 102         iio_trigger_notify_done(indio_dev->trig);
 103
 104         return IRQ_HANDLED;
 105 }
 106
 107 static const struct iio_buffer_setup_ops iio_simple_dummy_buffer_setup_ops = {
 108         /*
 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).
 114          */
 115         .preenable = &iio_sw_buffer_preenable,
 116         /*
 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
 120          * trigger.
 121          */
 122         .postenable = &iio_triggered_buffer_postenable,
 123         /*
 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.
 128          */
 129         .predisable = &iio_triggered_buffer_predisable,
 130 };
 131
 132 int iio_simple_dummy_configure_buffer(struct iio_dev *indio_dev)
 133 {
 134         int ret;
 135         struct iio_buffer *buffer;
 136
 137         /* Allocate a buffer to use - here a kfifo */
 138         buffer = iio_kfifo_allocate(indio_dev);
 139         if (buffer == NULL) {
 140                 ret = -ENOMEM;
 141                 goto error_ret;
 142         }
 143
 144         indio_dev->buffer = buffer;
 145
 146         /* Enable timestamps by default */
 147         buffer->scan_timestamp = true;
 148
 149         /*
 150          * Tell the core what device type specific functions should
 151          * be run on either side of buffer capture enable / disable.
 152          */
 153         indio_dev->setup_ops = &iio_simple_dummy_buffer_setup_ops;
 154
 155         /*
 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
 159          * from the device.
 160          *
 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.
 164          *
 165          * IRQF_ONESHOT ensures irqs are masked such that only one instance
 166          * of the handler can run at a time.
 167          *
 168          * "iio_simple_dummy_consumer%d" formatting string for the irq 'name'
 169          * as seen under /proc/interrupts. Remaining parameters as per printk.
 170          */
 171         indio_dev->pollfunc = iio_alloc_pollfunc(NULL,
 172                                                  &iio_simple_dummy_trigger_h,
 173                                                  IRQF_ONESHOT,
 174                                                  indio_dev,
 175                                                  "iio_simple_dummy_consumer%d",
 176                                                  indio_dev->id);
 177
 178         if (indio_dev->pollfunc == NULL) {
 179                 ret = -ENOMEM;
 180                 goto error_free_buffer;
 181         }
 182
 183         /*
 184          * Notify the core that this device is capable of buffered capture
 185          * driven by a trigger.
 186          */
 187         indio_dev->modes |= INDIO_BUFFER_TRIGGERED;
 188         return 0;
 189
 190 error_free_buffer:
 191         iio_kfifo_free(indio_dev->buffer);
 192 error_ret:
 193         return ret;
 194
 195 }
 196
 197 /**
 198  * iio_simple_dummy_unconfigure_buffer() - release buffer resources
 199  * @indo_dev: device instance state
 200  */
 201 void iio_simple_dummy_unconfigure_buffer(struct iio_dev *indio_dev)
 202 {
 203         iio_dealloc_pollfunc(indio_dev->pollfunc);
 204         iio_kfifo_free(indio_dev->buffer);
 205 }