Jonathan Cameron | 7d43817 | 2011-08-12 17:47:53 +0100 | [diff] [blame] | 1 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 2 | /* The industrial I/O core |
| 3 | * |
| 4 | * Copyright (c) 2008 Jonathan Cameron |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify it |
| 7 | * under the terms of the GNU General Public License version 2 as published by |
| 8 | * the Free Software Foundation. |
| 9 | */ |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 10 | #ifndef _INDUSTRIAL_IO_H_ |
| 11 | #define _INDUSTRIAL_IO_H_ |
| 12 | |
| 13 | #include <linux/device.h> |
| 14 | #include <linux/cdev.h> |
Jonathan Cameron | af5046a | 2011-10-26 17:41:32 +0100 | [diff] [blame] | 15 | #include "types.h" |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 16 | /* IIO TODO LIST */ |
Jonathan Cameron | 751a370 | 2010-06-26 12:54:19 +0100 | [diff] [blame] | 17 | /* |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 18 | * Provide means of adjusting timer accuracy. |
| 19 | * Currently assumes nano seconds. |
| 20 | */ |
| 21 | |
Jonathan Cameron | 1e8dfcc | 2011-08-30 12:41:11 +0100 | [diff] [blame] | 22 | enum iio_data_type { |
| 23 | IIO_RAW, |
| 24 | IIO_PROCESSED, |
| 25 | }; |
| 26 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 27 | /* Could add the raw attributes as well - allowing buffer only devices */ |
| 28 | enum iio_chan_info_enum { |
Justin P. Mattock | 4abf6f8 | 2012-02-29 22:00:38 -0800 | [diff] [blame] | 29 | /* 0 is reserved for raw attributes */ |
Jonathan Cameron | c8a9f80 | 2011-10-26 17:41:36 +0100 | [diff] [blame] | 30 | IIO_CHAN_INFO_SCALE = 1, |
| 31 | IIO_CHAN_INFO_OFFSET, |
| 32 | IIO_CHAN_INFO_CALIBSCALE, |
| 33 | IIO_CHAN_INFO_CALIBBIAS, |
| 34 | IIO_CHAN_INFO_PEAK, |
| 35 | IIO_CHAN_INFO_PEAK_SCALE, |
| 36 | IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW, |
| 37 | IIO_CHAN_INFO_AVERAGE_RAW, |
Jonathan Cameron | df94aba | 2011-11-27 11:39:12 +0000 | [diff] [blame] | 38 | IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY, |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 39 | }; |
| 40 | |
Jonathan Cameron | c8a9f80 | 2011-10-26 17:41:36 +0100 | [diff] [blame] | 41 | #define IIO_CHAN_INFO_SHARED_BIT(type) BIT(type*2) |
| 42 | #define IIO_CHAN_INFO_SEPARATE_BIT(type) BIT(type*2 + 1) |
| 43 | |
| 44 | #define IIO_CHAN_INFO_SCALE_SEPARATE_BIT \ |
| 45 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SCALE) |
| 46 | #define IIO_CHAN_INFO_SCALE_SHARED_BIT \ |
| 47 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SCALE) |
| 48 | #define IIO_CHAN_INFO_OFFSET_SEPARATE_BIT \ |
| 49 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_OFFSET) |
| 50 | #define IIO_CHAN_INFO_OFFSET_SHARED_BIT \ |
| 51 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_OFFSET) |
| 52 | #define IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT \ |
| 53 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBSCALE) |
| 54 | #define IIO_CHAN_INFO_CALIBSCALE_SHARED_BIT \ |
| 55 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBSCALE) |
| 56 | #define IIO_CHAN_INFO_CALIBBIAS_SEPARATE_BIT \ |
| 57 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBBIAS) |
| 58 | #define IIO_CHAN_INFO_CALIBBIAS_SHARED_BIT \ |
| 59 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBBIAS) |
| 60 | #define IIO_CHAN_INFO_PEAK_SEPARATE_BIT \ |
| 61 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAK) |
| 62 | #define IIO_CHAN_INFO_PEAK_SHARED_BIT \ |
| 63 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAK) |
| 64 | #define IIO_CHAN_INFO_PEAKSCALE_SEPARATE_BIT \ |
| 65 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAKSCALE) |
| 66 | #define IIO_CHAN_INFO_PEAKSCALE_SHARED_BIT \ |
| 67 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAKSCALE) |
| 68 | #define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SEPARATE_BIT \ |
| 69 | IIO_CHAN_INFO_SEPARATE_BIT( \ |
| 70 | IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW) |
| 71 | #define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SHARED_BIT \ |
| 72 | IIO_CHAN_INFO_SHARED_BIT( \ |
| 73 | IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW) |
| 74 | #define IIO_CHAN_INFO_AVERAGE_RAW_SEPARATE_BIT \ |
| 75 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_AVERAGE_RAW) |
| 76 | #define IIO_CHAN_INFO_AVERAGE_RAW_SHARED_BIT \ |
| 77 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_AVERAGE_RAW) |
Jonathan Cameron | df94aba | 2011-11-27 11:39:12 +0000 | [diff] [blame] | 78 | #define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SHARED_BIT \ |
| 79 | IIO_CHAN_INFO_SHARED_BIT( \ |
| 80 | IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY) |
| 81 | #define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SEPARATE_BIT \ |
| 82 | IIO_CHAN_INFO_SEPARATE_BIT( \ |
| 83 | IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY) |
Jonathan Cameron | c8a9f80 | 2011-10-26 17:41:36 +0100 | [diff] [blame] | 84 | |
Jonathan Cameron | 8310b86 | 2011-09-02 17:14:36 +0100 | [diff] [blame] | 85 | enum iio_endian { |
| 86 | IIO_CPU, |
| 87 | IIO_BE, |
| 88 | IIO_LE, |
| 89 | }; |
| 90 | |
Lars-Peter Clausen | 5f420b4 | 2012-02-21 18:38:12 +0100 | [diff] [blame] | 91 | struct iio_chan_spec; |
| 92 | struct iio_dev; |
| 93 | |
| 94 | /** |
| 95 | * struct iio_chan_spec_ext_info - Extended channel info attribute |
| 96 | * @name: Info attribute name |
| 97 | * @shared: Whether this attribute is shared between all channels. |
| 98 | * @read: Read callback for this info attribute, may be NULL. |
| 99 | * @write: Write callback for this info attribute, may be NULL. |
| 100 | */ |
| 101 | struct iio_chan_spec_ext_info { |
| 102 | const char *name; |
| 103 | bool shared; |
| 104 | ssize_t (*read)(struct iio_dev *, struct iio_chan_spec const *, |
| 105 | char *buf); |
| 106 | ssize_t (*write)(struct iio_dev *, struct iio_chan_spec const *, |
| 107 | const char *buf, size_t len); |
| 108 | }; |
| 109 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 110 | /** |
| 111 | * struct iio_chan_spec - specification of a single channel |
| 112 | * @type: What type of measurement is the channel making. |
Justin P. Mattock | 4abf6f8 | 2012-02-29 22:00:38 -0800 | [diff] [blame] | 113 | * @channel: What number or name do we wish to assign the channel. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 114 | * @channel2: If there is a second number for a differential |
| 115 | * channel then this is it. If modified is set then the |
| 116 | * value here specifies the modifier. |
| 117 | * @address: Driver specific identifier. |
| 118 | * @scan_index: Monotonic index to give ordering in scans when read |
| 119 | * from a buffer. |
| 120 | * @scan_type: Sign: 's' or 'u' to specify signed or unsigned |
| 121 | * realbits: Number of valid bits of data |
| 122 | * storage_bits: Realbits + padding |
| 123 | * shift: Shift right by this before masking out |
| 124 | * realbits. |
Jonathan Cameron | 8310b86 | 2011-09-02 17:14:36 +0100 | [diff] [blame] | 125 | * endianness: little or big endian |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 126 | * @info_mask: What information is to be exported about this channel. |
| 127 | * This includes calibbias, scale etc. |
| 128 | * @event_mask: What events can this channel produce. |
Lars-Peter Clausen | 5f420b4 | 2012-02-21 18:38:12 +0100 | [diff] [blame] | 129 | * @ext_info: Array of extended info attributes for this channel. |
| 130 | * The array is NULL terminated, the last element should |
| 131 | * have it's name field set to NULL. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 132 | * @extend_name: Allows labeling of channel attributes with an |
| 133 | * informative name. Note this has no effect codes etc, |
| 134 | * unlike modifiers. |
Jonathan Cameron | 6c63dde | 2011-12-05 21:56:00 +0000 | [diff] [blame] | 135 | * @datasheet_name: A name used in in kernel mapping of channels. It should |
Justin P. Mattock | 4abf6f8 | 2012-02-29 22:00:38 -0800 | [diff] [blame] | 136 | * correspond to the first name that the channel is referred |
Jonathan Cameron | 6c63dde | 2011-12-05 21:56:00 +0000 | [diff] [blame] | 137 | * to by in the datasheet (e.g. IND), or the nearest |
| 138 | * possible compound name (e.g. IND-INC). |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 139 | * @processed_val: Flag to specify the data access attribute should be |
| 140 | * *_input rather than *_raw. |
| 141 | * @modified: Does a modifier apply to this channel. What these are |
| 142 | * depends on the channel type. Modifier is set in |
| 143 | * channel2. Examples are IIO_MOD_X for axial sensors about |
| 144 | * the 'x' axis. |
| 145 | * @indexed: Specify the channel has a numerical index. If not, |
| 146 | * the value in channel will be suppressed for attribute |
| 147 | * but not for event codes. Typically set it to 0 when |
| 148 | * the index is false. |
Jonathan Cameron | ade7ef7 | 2011-09-02 17:14:45 +0100 | [diff] [blame] | 149 | * @differential: Channel is differential. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 150 | */ |
| 151 | struct iio_chan_spec { |
| 152 | enum iio_chan_type type; |
| 153 | int channel; |
| 154 | int channel2; |
| 155 | unsigned long address; |
| 156 | int scan_index; |
| 157 | struct { |
| 158 | char sign; |
| 159 | u8 realbits; |
| 160 | u8 storagebits; |
| 161 | u8 shift; |
Jonathan Cameron | 8310b86 | 2011-09-02 17:14:36 +0100 | [diff] [blame] | 162 | enum iio_endian endianness; |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 163 | } scan_type; |
Michael Hennerich | 1c5e6a3 | 2011-07-20 15:03:07 +0200 | [diff] [blame] | 164 | long info_mask; |
| 165 | long event_mask; |
Lars-Peter Clausen | 5f420b4 | 2012-02-21 18:38:12 +0100 | [diff] [blame] | 166 | const struct iio_chan_spec_ext_info *ext_info; |
Michael Hennerich | 1c5e6a3 | 2011-07-20 15:03:07 +0200 | [diff] [blame] | 167 | char *extend_name; |
Jonathan Cameron | 6c63dde | 2011-12-05 21:56:00 +0000 | [diff] [blame] | 168 | const char *datasheet_name; |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 169 | unsigned processed_val:1; |
| 170 | unsigned modified:1; |
| 171 | unsigned indexed:1; |
Jonathan Cameron | c6fc806 | 2011-09-02 17:14:34 +0100 | [diff] [blame] | 172 | unsigned output:1; |
Jonathan Cameron | ade7ef7 | 2011-09-02 17:14:45 +0100 | [diff] [blame] | 173 | unsigned differential:1; |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 174 | }; |
Jonathan Cameron | df9c1c4 | 2011-08-12 17:56:03 +0100 | [diff] [blame] | 175 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 176 | #define IIO_ST(si, rb, sb, sh) \ |
| 177 | { .sign = si, .realbits = rb, .storagebits = sb, .shift = sh } |
| 178 | |
Jonathan Cameron | c6fc806 | 2011-09-02 17:14:34 +0100 | [diff] [blame] | 179 | /* Macro assumes input channels */ |
| 180 | #define IIO_CHAN(_type, _mod, _indexed, _proc, _name, _chan, _chan2, \ |
Jonathan Cameron | aaf370d | 2011-05-18 14:41:16 +0100 | [diff] [blame] | 181 | _inf_mask, _address, _si, _stype, _event_mask) \ |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 182 | { .type = _type, \ |
Jonathan Cameron | c6fc806 | 2011-09-02 17:14:34 +0100 | [diff] [blame] | 183 | .output = 0, \ |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 184 | .modified = _mod, \ |
| 185 | .indexed = _indexed, \ |
| 186 | .processed_val = _proc, \ |
| 187 | .extend_name = _name, \ |
| 188 | .channel = _chan, \ |
| 189 | .channel2 = _chan2, \ |
| 190 | .info_mask = _inf_mask, \ |
| 191 | .address = _address, \ |
| 192 | .scan_index = _si, \ |
| 193 | .scan_type = _stype, \ |
Jonathan Cameron | aaf370d | 2011-05-18 14:41:16 +0100 | [diff] [blame] | 194 | .event_mask = _event_mask } |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 195 | |
| 196 | #define IIO_CHAN_SOFT_TIMESTAMP(_si) \ |
| 197 | { .type = IIO_TIMESTAMP, .channel = -1, \ |
| 198 | .scan_index = _si, .scan_type = IIO_ST('s', 64, 64, 0) } |
| 199 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 200 | /** |
| 201 | * iio_get_time_ns() - utility function to get a time stamp for events etc |
| 202 | **/ |
| 203 | static inline s64 iio_get_time_ns(void) |
| 204 | { |
| 205 | struct timespec ts; |
| 206 | /* |
| 207 | * calls getnstimeofday. |
| 208 | * If hrtimers then up to ns accurate, if not microsecond. |
| 209 | */ |
| 210 | ktime_get_real_ts(&ts); |
| 211 | |
| 212 | return timespec_to_ns(&ts); |
| 213 | } |
| 214 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 215 | /* Device operating modes */ |
| 216 | #define INDIO_DIRECT_MODE 0x01 |
Jonathan Cameron | ec3afa4 | 2011-09-21 11:15:54 +0100 | [diff] [blame] | 217 | #define INDIO_BUFFER_TRIGGERED 0x02 |
| 218 | #define INDIO_BUFFER_HARDWARE 0x08 |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 219 | |
Jonathan Cameron | ec3afa4 | 2011-09-21 11:15:54 +0100 | [diff] [blame] | 220 | #define INDIO_ALL_BUFFER_MODES \ |
| 221 | (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE) |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 222 | |
Michael Hennerich | 43a4360 | 2011-06-27 13:07:09 +0100 | [diff] [blame] | 223 | struct iio_trigger; /* forward declaration */ |
Jonathan Cameron | 7ae8cf6 | 2011-08-30 12:32:44 +0100 | [diff] [blame] | 224 | struct iio_dev; |
Michael Hennerich | 43a4360 | 2011-06-27 13:07:09 +0100 | [diff] [blame] | 225 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 226 | /** |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 227 | * struct iio_info - constant information about device |
| 228 | * @driver_module: module structure used to ensure correct |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 229 | * ownership of chrdevs etc |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 230 | * @event_attrs: event control attributes |
| 231 | * @attrs: general purpose device attributes |
| 232 | * @read_raw: function to request a value from the device. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 233 | * mask specifies which value. Note 0 means a reading of |
| 234 | * the channel in question. Return value will specify the |
| 235 | * type of value returned by the device. val and val2 will |
| 236 | * contain the elements making up the returned value. |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 237 | * @write_raw: function to write a value to the device. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 238 | * Parameters are the same as for read_raw. |
Michael Hennerich | 5c04af0 | 2011-06-27 13:07:10 +0100 | [diff] [blame] | 239 | * @write_raw_get_fmt: callback function to query the expected |
| 240 | * format/precision. If not set by the driver, write_raw |
| 241 | * returns IIO_VAL_INT_PLUS_MICRO. |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 242 | * @read_event_config: find out if the event is enabled. |
| 243 | * @write_event_config: set if the event is enabled. |
| 244 | * @read_event_value: read a value associated with the event. Meaning |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 245 | * is event dependant. event_code specifies which event. |
Justin P. Mattock | 4abf6f8 | 2012-02-29 22:00:38 -0800 | [diff] [blame] | 246 | * @write_event_value: write the value associated with the event. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 247 | * Meaning is event dependent. |
Michael Hennerich | 43a4360 | 2011-06-27 13:07:09 +0100 | [diff] [blame] | 248 | * @validate_trigger: function to validate the trigger when the |
| 249 | * current trigger gets changed. |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 250 | **/ |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 251 | struct iio_info { |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 252 | struct module *driver_module; |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 253 | struct attribute_group *event_attrs; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 254 | const struct attribute_group *attrs; |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 255 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 256 | int (*read_raw)(struct iio_dev *indio_dev, |
| 257 | struct iio_chan_spec const *chan, |
| 258 | int *val, |
| 259 | int *val2, |
| 260 | long mask); |
| 261 | |
| 262 | int (*write_raw)(struct iio_dev *indio_dev, |
| 263 | struct iio_chan_spec const *chan, |
| 264 | int val, |
| 265 | int val2, |
| 266 | long mask); |
| 267 | |
Michael Hennerich | 5c04af0 | 2011-06-27 13:07:10 +0100 | [diff] [blame] | 268 | int (*write_raw_get_fmt)(struct iio_dev *indio_dev, |
| 269 | struct iio_chan_spec const *chan, |
| 270 | long mask); |
| 271 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 272 | int (*read_event_config)(struct iio_dev *indio_dev, |
Jonathan Cameron | 330c6c5 | 2011-09-02 17:14:39 +0100 | [diff] [blame] | 273 | u64 event_code); |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 274 | |
| 275 | int (*write_event_config)(struct iio_dev *indio_dev, |
Jonathan Cameron | 330c6c5 | 2011-09-02 17:14:39 +0100 | [diff] [blame] | 276 | u64 event_code, |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 277 | int state); |
| 278 | |
| 279 | int (*read_event_value)(struct iio_dev *indio_dev, |
Jonathan Cameron | 330c6c5 | 2011-09-02 17:14:39 +0100 | [diff] [blame] | 280 | u64 event_code, |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 281 | int *val); |
| 282 | int (*write_event_value)(struct iio_dev *indio_dev, |
Jonathan Cameron | 330c6c5 | 2011-09-02 17:14:39 +0100 | [diff] [blame] | 283 | u64 event_code, |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 284 | int val); |
Michael Hennerich | 43a4360 | 2011-06-27 13:07:09 +0100 | [diff] [blame] | 285 | int (*validate_trigger)(struct iio_dev *indio_dev, |
| 286 | struct iio_trigger *trig); |
Jonathan Cameron | 4d5f8d3 | 2011-12-05 21:37:12 +0000 | [diff] [blame] | 287 | int (*update_scan_mode)(struct iio_dev *indio_dev, |
| 288 | const unsigned long *scan_mask); |
Michael Hennerich | e553f18 | 2012-03-01 10:51:03 +0100 | [diff] [blame] | 289 | int (*debugfs_reg_access)(struct iio_dev *indio_dev, |
| 290 | unsigned reg, unsigned writeval, |
| 291 | unsigned *readval); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 292 | }; |
| 293 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 294 | /** |
Jonathan Cameron | 1612244 | 2011-12-05 22:18:14 +0000 | [diff] [blame] | 295 | * struct iio_buffer_setup_ops - buffer setup related callbacks |
| 296 | * @preenable: [DRIVER] function to run prior to marking buffer enabled |
| 297 | * @postenable: [DRIVER] function to run after marking buffer enabled |
| 298 | * @predisable: [DRIVER] function to run prior to marking buffer |
| 299 | * disabled |
| 300 | * @postdisable: [DRIVER] function to run after marking buffer disabled |
| 301 | */ |
| 302 | struct iio_buffer_setup_ops { |
| 303 | int (*preenable)(struct iio_dev *); |
| 304 | int (*postenable)(struct iio_dev *); |
| 305 | int (*predisable)(struct iio_dev *); |
| 306 | int (*postdisable)(struct iio_dev *); |
| 307 | }; |
| 308 | |
| 309 | /** |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 310 | * struct iio_dev - industrial I/O device |
| 311 | * @id: [INTERN] used to identify device internally |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 312 | * @modes: [DRIVER] operating modes supported by device |
| 313 | * @currentmode: [DRIVER] current operating mode |
| 314 | * @dev: [DRIVER] device structure, should be assigned a parent |
| 315 | * and owner |
Jonathan Cameron | 5aa9618 | 2011-08-30 12:41:06 +0100 | [diff] [blame] | 316 | * @event_interface: [INTERN] event chrdevs associated with interrupt lines |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 317 | * @buffer: [DRIVER] any buffer present |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 318 | * @mlock: [INTERN] lock used to prevent simultaneous device state |
| 319 | * changes |
| 320 | * @available_scan_masks: [DRIVER] optional array of allowed bitmasks |
Jonathan Cameron | 32b5eec | 2011-09-02 17:14:38 +0100 | [diff] [blame] | 321 | * @masklength: [INTERN] the length of the mask established from |
| 322 | * channels |
Jonathan Cameron | 959d295 | 2011-12-05 21:37:13 +0000 | [diff] [blame] | 323 | * @active_scan_mask: [INTERN] union of all scan masks requested by buffers |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 324 | * @trig: [INTERN] current device trigger (buffer modes) |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 325 | * @pollfunc: [DRIVER] function run on trigger being received |
| 326 | * @channels: [DRIVER] channel specification structure table |
| 327 | * @num_channels: [DRIVER] number of chanels specified in @channels. |
| 328 | * @channel_attr_list: [INTERN] keep track of automatically created channel |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 329 | * attributes |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 330 | * @chan_attr_group: [INTERN] group for all attrs in base directory |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 331 | * @name: [DRIVER] name of the device. |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 332 | * @info: [DRIVER] callbacks and constant info from driver |
Jonathan Cameron | ac917a8 | 2012-02-15 19:48:00 +0000 | [diff] [blame] | 333 | * @info_exist_lock: [INTERN] lock to prevent use during removal |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 334 | * @chrdev: [INTERN] associated character device |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 335 | * @groups: [INTERN] attribute groups |
| 336 | * @groupcounter: [INTERN] index of next attribute group |
Lars-Peter Clausen | bb01443 | 2011-12-19 15:23:45 +0100 | [diff] [blame] | 337 | * @flags: [INTERN] file ops related flags including busy flag. |
Michael Hennerich | e553f18 | 2012-03-01 10:51:03 +0100 | [diff] [blame] | 338 | * @debugfs_dentry: [INTERN] device specific debugfs dentry. |
| 339 | * @cached_reg_addr: [INTERN] cached register address for debugfs reads. |
| 340 | */ |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 341 | struct iio_dev { |
| 342 | int id; |
Jonathan Cameron | 4024bc7 | 2011-08-12 17:08:53 +0100 | [diff] [blame] | 343 | |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 344 | int modes; |
| 345 | int currentmode; |
| 346 | struct device dev; |
| 347 | |
Jonathan Cameron | 5aa9618 | 2011-08-30 12:41:06 +0100 | [diff] [blame] | 348 | struct iio_event_interface *event_interface; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 349 | |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 350 | struct iio_buffer *buffer; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 351 | struct mutex mlock; |
| 352 | |
Michael Hennerich | cd4361c | 2012-02-22 13:16:49 +0100 | [diff] [blame] | 353 | const unsigned long *available_scan_masks; |
Jonathan Cameron | 32b5eec | 2011-09-02 17:14:38 +0100 | [diff] [blame] | 354 | unsigned masklength; |
Michael Hennerich | cd4361c | 2012-02-22 13:16:49 +0100 | [diff] [blame] | 355 | const unsigned long *active_scan_mask; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 356 | struct iio_trigger *trig; |
| 357 | struct iio_poll_func *pollfunc; |
| 358 | |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 359 | struct iio_chan_spec const *channels; |
| 360 | int num_channels; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 361 | |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 362 | struct list_head channel_attr_list; |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 363 | struct attribute_group chan_attr_group; |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 364 | const char *name; |
| 365 | const struct iio_info *info; |
Jonathan Cameron | ac917a8 | 2012-02-15 19:48:00 +0000 | [diff] [blame] | 366 | struct mutex info_exist_lock; |
Jonathan Cameron | 1612244 | 2011-12-05 22:18:14 +0000 | [diff] [blame] | 367 | const struct iio_buffer_setup_ops *setup_ops; |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 368 | struct cdev chrdev; |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 369 | #define IIO_MAX_GROUPS 6 |
| 370 | const struct attribute_group *groups[IIO_MAX_GROUPS + 1]; |
| 371 | int groupcounter; |
Lars-Peter Clausen | bb01443 | 2011-12-19 15:23:45 +0100 | [diff] [blame] | 372 | |
| 373 | unsigned long flags; |
Michael Hennerich | e553f18 | 2012-03-01 10:51:03 +0100 | [diff] [blame] | 374 | #if defined(CONFIG_DEBUG_FS) |
| 375 | struct dentry *debugfs_dentry; |
| 376 | unsigned cached_reg_addr; |
| 377 | #endif |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 378 | }; |
| 379 | |
| 380 | /** |
Jonathan Cameron | 5fb21c8 | 2011-12-05 21:37:10 +0000 | [diff] [blame] | 381 | * iio_find_channel_from_si() - get channel from its scan index |
| 382 | * @indio_dev: device |
| 383 | * @si: scan index to match |
| 384 | */ |
| 385 | const struct iio_chan_spec |
| 386 | *iio_find_channel_from_si(struct iio_dev *indio_dev, int si); |
| 387 | |
| 388 | /** |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 389 | * iio_device_register() - register a device with the IIO subsystem |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 390 | * @indio_dev: Device structure filled by the device driver |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 391 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 392 | int iio_device_register(struct iio_dev *indio_dev); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 393 | |
| 394 | /** |
| 395 | * iio_device_unregister() - unregister a device from the IIO subsystem |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 396 | * @indio_dev: Device structure representing the device. |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 397 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 398 | void iio_device_unregister(struct iio_dev *indio_dev); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 399 | |
| 400 | /** |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 401 | * iio_push_event() - try to add event to the list for userspace reading |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 402 | * @indio_dev: IIO device structure |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 403 | * @ev_code: What event |
Randy Dunlap | 4c57260 | 2009-10-04 19:34:02 -0700 | [diff] [blame] | 404 | * @timestamp: When the event occurred |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 405 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 406 | int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 407 | |
Jonathan Cameron | 5aaaeba | 2010-05-04 14:43:00 +0100 | [diff] [blame] | 408 | extern struct bus_type iio_bus_type; |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 409 | |
| 410 | /** |
Randy Dunlap | 4c57260 | 2009-10-04 19:34:02 -0700 | [diff] [blame] | 411 | * iio_put_device() - reference counted deallocation of struct device |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 412 | * @dev: the iio_device containing the device |
| 413 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 414 | static inline void iio_put_device(struct iio_dev *indio_dev) |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 415 | { |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 416 | if (indio_dev) |
| 417 | put_device(&indio_dev->dev); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 418 | }; |
| 419 | |
Jonathan Cameron | 6f7c8ee | 2011-04-15 18:55:56 +0100 | [diff] [blame] | 420 | /* Can we make this smaller? */ |
| 421 | #define IIO_ALIGN L1_CACHE_BYTES |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 422 | /** |
| 423 | * iio_allocate_device() - allocate an iio_dev from a driver |
Jonathan Cameron | 6f7c8ee | 2011-04-15 18:55:56 +0100 | [diff] [blame] | 424 | * @sizeof_priv: Space to allocate for private structure. |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 425 | **/ |
Jonathan Cameron | 6f7c8ee | 2011-04-15 18:55:56 +0100 | [diff] [blame] | 426 | struct iio_dev *iio_allocate_device(int sizeof_priv); |
| 427 | |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 428 | static inline void *iio_priv(const struct iio_dev *indio_dev) |
Jonathan Cameron | 6f7c8ee | 2011-04-15 18:55:56 +0100 | [diff] [blame] | 429 | { |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 430 | return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN); |
Jonathan Cameron | 6f7c8ee | 2011-04-15 18:55:56 +0100 | [diff] [blame] | 431 | } |
| 432 | |
| 433 | static inline struct iio_dev *iio_priv_to_dev(void *priv) |
| 434 | { |
| 435 | return (struct iio_dev *)((char *)priv - |
| 436 | ALIGN(sizeof(struct iio_dev), IIO_ALIGN)); |
| 437 | } |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 438 | |
| 439 | /** |
| 440 | * iio_free_device() - free an iio_dev from a driver |
Randy Dunlap | 4c57260 | 2009-10-04 19:34:02 -0700 | [diff] [blame] | 441 | * @dev: the iio_dev associated with the device |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 442 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 443 | void iio_free_device(struct iio_dev *indio_dev); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 444 | |
| 445 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 446 | * iio_buffer_enabled() - helper function to test if the buffer is enabled |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 447 | * @indio_dev: IIO device info structure for device |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 448 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 449 | static inline bool iio_buffer_enabled(struct iio_dev *indio_dev) |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 450 | { |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 451 | return indio_dev->currentmode |
Jonathan Cameron | ec3afa4 | 2011-09-21 11:15:54 +0100 | [diff] [blame] | 452 | & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 453 | }; |
| 454 | |
Michael Hennerich | e553f18 | 2012-03-01 10:51:03 +0100 | [diff] [blame] | 455 | /** |
| 456 | * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry |
| 457 | * @indio_dev: IIO device info structure for device |
| 458 | **/ |
| 459 | #if defined(CONFIG_DEBUG_FS) |
| 460 | static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev) |
| 461 | { |
| 462 | return indio_dev->debugfs_dentry; |
| 463 | }; |
| 464 | #else |
| 465 | static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev) |
| 466 | { |
| 467 | return NULL; |
| 468 | }; |
| 469 | #endif |
| 470 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 471 | #endif /* _INDUSTRIAL_IO_H_ */ |