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 | 06458e2 | 2012-04-25 15:54:58 +0100 | [diff] [blame] | 15 | #include <linux/iio/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 | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 22 | enum iio_chan_info_enum { |
Jonathan Cameron | 5ccb3ad | 2012-04-15 17:41:16 +0100 | [diff] [blame] | 23 | IIO_CHAN_INFO_RAW = 0, |
| 24 | IIO_CHAN_INFO_PROCESSED, |
| 25 | IIO_CHAN_INFO_SCALE, |
Jonathan Cameron | c8a9f80 | 2011-10-26 17:41:36 +0100 | [diff] [blame] | 26 | IIO_CHAN_INFO_OFFSET, |
| 27 | IIO_CHAN_INFO_CALIBSCALE, |
| 28 | IIO_CHAN_INFO_CALIBBIAS, |
| 29 | IIO_CHAN_INFO_PEAK, |
| 30 | IIO_CHAN_INFO_PEAK_SCALE, |
| 31 | IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW, |
| 32 | IIO_CHAN_INFO_AVERAGE_RAW, |
Jonathan Cameron | df94aba | 2011-11-27 11:39:12 +0000 | [diff] [blame] | 33 | IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY, |
Laxman Dewangan | ce85a1c | 2012-04-13 16:03:31 +0530 | [diff] [blame] | 34 | IIO_CHAN_INFO_SAMP_FREQ, |
Michael Hennerich | a6b1285 | 2012-04-27 10:58:34 +0200 | [diff] [blame] | 35 | IIO_CHAN_INFO_FREQUENCY, |
| 36 | IIO_CHAN_INFO_PHASE, |
Michael Hennerich | b65d621 | 2012-05-11 11:36:53 +0200 | [diff] [blame] | 37 | IIO_CHAN_INFO_HARDWAREGAIN, |
srinivas pandruvada | 7c9ab03 | 2012-09-05 13:56:00 +0100 | [diff] [blame^] | 38 | IIO_CHAN_INFO_HYSTERESIS, |
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 | |
Jonathan Cameron | 5ccb3ad | 2012-04-15 17:41:16 +0100 | [diff] [blame] | 44 | #define IIO_CHAN_INFO_RAW_SEPARATE_BIT \ |
| 45 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_RAW) |
| 46 | #define IIO_CHAN_INFO_PROCESSED_SEPARATE_BIT \ |
| 47 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PROCESSED) |
Jonathan Cameron | c8a9f80 | 2011-10-26 17:41:36 +0100 | [diff] [blame] | 48 | #define IIO_CHAN_INFO_SCALE_SEPARATE_BIT \ |
| 49 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SCALE) |
| 50 | #define IIO_CHAN_INFO_SCALE_SHARED_BIT \ |
| 51 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SCALE) |
| 52 | #define IIO_CHAN_INFO_OFFSET_SEPARATE_BIT \ |
| 53 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_OFFSET) |
| 54 | #define IIO_CHAN_INFO_OFFSET_SHARED_BIT \ |
| 55 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_OFFSET) |
| 56 | #define IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT \ |
| 57 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBSCALE) |
| 58 | #define IIO_CHAN_INFO_CALIBSCALE_SHARED_BIT \ |
| 59 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBSCALE) |
| 60 | #define IIO_CHAN_INFO_CALIBBIAS_SEPARATE_BIT \ |
| 61 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBBIAS) |
| 62 | #define IIO_CHAN_INFO_CALIBBIAS_SHARED_BIT \ |
| 63 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBBIAS) |
| 64 | #define IIO_CHAN_INFO_PEAK_SEPARATE_BIT \ |
| 65 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAK) |
| 66 | #define IIO_CHAN_INFO_PEAK_SHARED_BIT \ |
| 67 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAK) |
| 68 | #define IIO_CHAN_INFO_PEAKSCALE_SEPARATE_BIT \ |
| 69 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAKSCALE) |
| 70 | #define IIO_CHAN_INFO_PEAKSCALE_SHARED_BIT \ |
| 71 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAKSCALE) |
| 72 | #define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SEPARATE_BIT \ |
| 73 | IIO_CHAN_INFO_SEPARATE_BIT( \ |
| 74 | IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW) |
| 75 | #define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SHARED_BIT \ |
| 76 | IIO_CHAN_INFO_SHARED_BIT( \ |
| 77 | IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW) |
| 78 | #define IIO_CHAN_INFO_AVERAGE_RAW_SEPARATE_BIT \ |
| 79 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_AVERAGE_RAW) |
| 80 | #define IIO_CHAN_INFO_AVERAGE_RAW_SHARED_BIT \ |
| 81 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_AVERAGE_RAW) |
Jonathan Cameron | df94aba | 2011-11-27 11:39:12 +0000 | [diff] [blame] | 82 | #define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SHARED_BIT \ |
| 83 | IIO_CHAN_INFO_SHARED_BIT( \ |
| 84 | IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY) |
| 85 | #define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SEPARATE_BIT \ |
| 86 | IIO_CHAN_INFO_SEPARATE_BIT( \ |
| 87 | IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY) |
Laxman Dewangan | ce85a1c | 2012-04-13 16:03:31 +0530 | [diff] [blame] | 88 | #define IIO_CHAN_INFO_SAMP_FREQ_SEPARATE_BIT \ |
| 89 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SAMP_FREQ) |
| 90 | #define IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT \ |
| 91 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SAMP_FREQ) |
Michael Hennerich | a6b1285 | 2012-04-27 10:58:34 +0200 | [diff] [blame] | 92 | #define IIO_CHAN_INFO_FREQUENCY_SEPARATE_BIT \ |
| 93 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_FREQUENCY) |
| 94 | #define IIO_CHAN_INFO_FREQUENCY_SHARED_BIT \ |
| 95 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_FREQUENCY) |
| 96 | #define IIO_CHAN_INFO_PHASE_SEPARATE_BIT \ |
| 97 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PHASE) |
| 98 | #define IIO_CHAN_INFO_PHASE_SHARED_BIT \ |
| 99 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PHASE) |
Michael Hennerich | b65d621 | 2012-05-11 11:36:53 +0200 | [diff] [blame] | 100 | #define IIO_CHAN_INFO_HARDWAREGAIN_SEPARATE_BIT \ |
| 101 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_HARDWAREGAIN) |
| 102 | #define IIO_CHAN_INFO_HARDWAREGAIN_SHARED_BIT \ |
| 103 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_HARDWAREGAIN) |
srinivas pandruvada | 7c9ab03 | 2012-09-05 13:56:00 +0100 | [diff] [blame^] | 104 | #define IIO_CHAN_INFO_HYSTERESIS_SEPARATE_BIT \ |
| 105 | IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_HYSTERESIS) |
| 106 | #define IIO_CHAN_INFO_HYSTERESIS_SHARED_BIT \ |
| 107 | IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_HYSTERESIS) |
Jonathan Cameron | c8a9f80 | 2011-10-26 17:41:36 +0100 | [diff] [blame] | 108 | |
Jonathan Cameron | 8310b86 | 2011-09-02 17:14:36 +0100 | [diff] [blame] | 109 | enum iio_endian { |
| 110 | IIO_CPU, |
| 111 | IIO_BE, |
| 112 | IIO_LE, |
| 113 | }; |
| 114 | |
Lars-Peter Clausen | 5f420b4 | 2012-02-21 18:38:12 +0100 | [diff] [blame] | 115 | struct iio_chan_spec; |
| 116 | struct iio_dev; |
| 117 | |
| 118 | /** |
| 119 | * struct iio_chan_spec_ext_info - Extended channel info attribute |
| 120 | * @name: Info attribute name |
| 121 | * @shared: Whether this attribute is shared between all channels. |
| 122 | * @read: Read callback for this info attribute, may be NULL. |
| 123 | * @write: Write callback for this info attribute, may be NULL. |
Michael Hennerich | fc6d113 | 2012-04-27 10:58:36 +0200 | [diff] [blame] | 124 | * @private: Data private to the driver. |
Lars-Peter Clausen | 5f420b4 | 2012-02-21 18:38:12 +0100 | [diff] [blame] | 125 | */ |
| 126 | struct iio_chan_spec_ext_info { |
| 127 | const char *name; |
| 128 | bool shared; |
Michael Hennerich | fc6d113 | 2012-04-27 10:58:36 +0200 | [diff] [blame] | 129 | ssize_t (*read)(struct iio_dev *, uintptr_t private, |
| 130 | struct iio_chan_spec const *, char *buf); |
| 131 | ssize_t (*write)(struct iio_dev *, uintptr_t private, |
| 132 | struct iio_chan_spec const *, const char *buf, |
| 133 | size_t len); |
| 134 | uintptr_t private; |
Lars-Peter Clausen | 5f420b4 | 2012-02-21 18:38:12 +0100 | [diff] [blame] | 135 | }; |
| 136 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 137 | /** |
Lars-Peter Clausen | 5212cc8 | 2012-06-04 11:36:11 +0200 | [diff] [blame] | 138 | * struct iio_enum - Enum channel info attribute |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 139 | * @items: An array of strings. |
| 140 | * @num_items: Length of the item array. |
| 141 | * @set: Set callback function, may be NULL. |
| 142 | * @get: Get callback function, may be NULL. |
Lars-Peter Clausen | 5212cc8 | 2012-06-04 11:36:11 +0200 | [diff] [blame] | 143 | * |
| 144 | * The iio_enum struct can be used to implement enum style channel attributes. |
| 145 | * Enum style attributes are those which have a set of strings which map to |
| 146 | * unsigned integer values. The IIO enum helper code takes care of mapping |
| 147 | * between value and string as well as generating a "_available" file which |
| 148 | * contains a list of all available items. The set callback will be called when |
| 149 | * the attribute is updated. The last parameter is the index to the newly |
| 150 | * activated item. The get callback will be used to query the currently active |
| 151 | * item and is supposed to return the index for it. |
| 152 | */ |
| 153 | struct iio_enum { |
| 154 | const char * const *items; |
| 155 | unsigned int num_items; |
| 156 | int (*set)(struct iio_dev *, const struct iio_chan_spec *, unsigned int); |
| 157 | int (*get)(struct iio_dev *, const struct iio_chan_spec *); |
| 158 | }; |
| 159 | |
| 160 | ssize_t iio_enum_available_read(struct iio_dev *indio_dev, |
| 161 | uintptr_t priv, const struct iio_chan_spec *chan, char *buf); |
| 162 | ssize_t iio_enum_read(struct iio_dev *indio_dev, |
| 163 | uintptr_t priv, const struct iio_chan_spec *chan, char *buf); |
| 164 | ssize_t iio_enum_write(struct iio_dev *indio_dev, |
| 165 | uintptr_t priv, const struct iio_chan_spec *chan, const char *buf, |
| 166 | size_t len); |
| 167 | |
| 168 | /** |
| 169 | * IIO_ENUM() - Initialize enum extended channel attribute |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 170 | * @_name: Attribute name |
| 171 | * @_shared: Whether the attribute is shared between all channels |
Peter Meerwald | d25b380 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 172 | * @_e: Pointer to an iio_enum struct |
Lars-Peter Clausen | 5212cc8 | 2012-06-04 11:36:11 +0200 | [diff] [blame] | 173 | * |
| 174 | * This should usually be used together with IIO_ENUM_AVAILABLE() |
| 175 | */ |
| 176 | #define IIO_ENUM(_name, _shared, _e) \ |
| 177 | { \ |
| 178 | .name = (_name), \ |
| 179 | .shared = (_shared), \ |
| 180 | .read = iio_enum_read, \ |
| 181 | .write = iio_enum_write, \ |
| 182 | .private = (uintptr_t)(_e), \ |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * IIO_ENUM_AVAILABLE() - Initialize enum available extended channel attribute |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 187 | * @_name: Attribute name ("_available" will be appended to the name) |
Peter Meerwald | d25b380 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 188 | * @_e: Pointer to an iio_enum struct |
Lars-Peter Clausen | 5212cc8 | 2012-06-04 11:36:11 +0200 | [diff] [blame] | 189 | * |
Peter Meerwald | d25b380 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 190 | * Creates a read only attribute which lists all the available enum items in a |
Lars-Peter Clausen | 5212cc8 | 2012-06-04 11:36:11 +0200 | [diff] [blame] | 191 | * space separated list. This should usually be used together with IIO_ENUM() |
| 192 | */ |
| 193 | #define IIO_ENUM_AVAILABLE(_name, _e) \ |
| 194 | { \ |
| 195 | .name = (_name "_available"), \ |
| 196 | .shared = true, \ |
| 197 | .read = iio_enum_available_read, \ |
| 198 | .private = (uintptr_t)(_e), \ |
| 199 | } |
| 200 | |
| 201 | /** |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 202 | * struct iio_chan_spec - specification of a single channel |
| 203 | * @type: What type of measurement is the channel making. |
Peter Meerwald | a16561c | 2012-06-12 15:38:46 +0200 | [diff] [blame] | 204 | * @channel: What number do we wish to assign the channel. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 205 | * @channel2: If there is a second number for a differential |
| 206 | * channel then this is it. If modified is set then the |
| 207 | * value here specifies the modifier. |
| 208 | * @address: Driver specific identifier. |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 209 | * @scan_index: Monotonic index to give ordering in scans when read |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 210 | * from a buffer. |
| 211 | * @scan_type: Sign: 's' or 'u' to specify signed or unsigned |
| 212 | * realbits: Number of valid bits of data |
| 213 | * storage_bits: Realbits + padding |
| 214 | * shift: Shift right by this before masking out |
| 215 | * realbits. |
Jonathan Cameron | 8310b86 | 2011-09-02 17:14:36 +0100 | [diff] [blame] | 216 | * endianness: little or big endian |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 217 | * @info_mask: What information is to be exported about this channel. |
| 218 | * This includes calibbias, scale etc. |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 219 | * @event_mask: What events can this channel produce. |
Lars-Peter Clausen | 5f420b4 | 2012-02-21 18:38:12 +0100 | [diff] [blame] | 220 | * @ext_info: Array of extended info attributes for this channel. |
| 221 | * The array is NULL terminated, the last element should |
Peter Meerwald | 9cc113b | 2012-06-18 20:33:01 +0200 | [diff] [blame] | 222 | * have its name field set to NULL. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 223 | * @extend_name: Allows labeling of channel attributes with an |
| 224 | * informative name. Note this has no effect codes etc, |
| 225 | * unlike modifiers. |
Peter Meerwald | 1787948 | 2012-06-12 15:38:45 +0200 | [diff] [blame] | 226 | * @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] | 227 | * correspond to the first name that the channel is referred |
Jonathan Cameron | 6c63dde | 2011-12-05 21:56:00 +0000 | [diff] [blame] | 228 | * to by in the datasheet (e.g. IND), or the nearest |
| 229 | * possible compound name (e.g. IND-INC). |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 230 | * @modified: Does a modifier apply to this channel. What these are |
| 231 | * depends on the channel type. Modifier is set in |
| 232 | * channel2. Examples are IIO_MOD_X for axial sensors about |
| 233 | * the 'x' axis. |
| 234 | * @indexed: Specify the channel has a numerical index. If not, |
Peter Meerwald | a16561c | 2012-06-12 15:38:46 +0200 | [diff] [blame] | 235 | * the channel index number will be suppressed for sysfs |
| 236 | * attributes but not for event codes. |
Peter Meerwald | c3668a0 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 237 | * @output: Channel is output. |
Jonathan Cameron | ade7ef7 | 2011-09-02 17:14:45 +0100 | [diff] [blame] | 238 | * @differential: Channel is differential. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 239 | */ |
| 240 | struct iio_chan_spec { |
| 241 | enum iio_chan_type type; |
| 242 | int channel; |
| 243 | int channel2; |
| 244 | unsigned long address; |
| 245 | int scan_index; |
| 246 | struct { |
| 247 | char sign; |
| 248 | u8 realbits; |
| 249 | u8 storagebits; |
| 250 | u8 shift; |
Jonathan Cameron | 8310b86 | 2011-09-02 17:14:36 +0100 | [diff] [blame] | 251 | enum iio_endian endianness; |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 252 | } scan_type; |
Michael Hennerich | 1c5e6a3 | 2011-07-20 15:03:07 +0200 | [diff] [blame] | 253 | long info_mask; |
| 254 | long event_mask; |
Lars-Peter Clausen | 5f420b4 | 2012-02-21 18:38:12 +0100 | [diff] [blame] | 255 | const struct iio_chan_spec_ext_info *ext_info; |
Jonathan Cameron | 344692b | 2012-04-13 10:24:21 +0100 | [diff] [blame] | 256 | const char *extend_name; |
Jonathan Cameron | 6c63dde | 2011-12-05 21:56:00 +0000 | [diff] [blame] | 257 | const char *datasheet_name; |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 258 | unsigned modified:1; |
| 259 | unsigned indexed:1; |
Jonathan Cameron | c6fc806 | 2011-09-02 17:14:34 +0100 | [diff] [blame] | 260 | unsigned output:1; |
Jonathan Cameron | ade7ef7 | 2011-09-02 17:14:45 +0100 | [diff] [blame] | 261 | unsigned differential:1; |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 262 | }; |
Jonathan Cameron | df9c1c4 | 2011-08-12 17:56:03 +0100 | [diff] [blame] | 263 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 264 | #define IIO_ST(si, rb, sb, sh) \ |
| 265 | { .sign = si, .realbits = rb, .storagebits = sb, .shift = sh } |
| 266 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 267 | #define IIO_CHAN_SOFT_TIMESTAMP(_si) \ |
| 268 | { .type = IIO_TIMESTAMP, .channel = -1, \ |
| 269 | .scan_index = _si, .scan_type = IIO_ST('s', 64, 64, 0) } |
| 270 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 271 | /** |
| 272 | * iio_get_time_ns() - utility function to get a time stamp for events etc |
| 273 | **/ |
| 274 | static inline s64 iio_get_time_ns(void) |
| 275 | { |
| 276 | struct timespec ts; |
| 277 | /* |
| 278 | * calls getnstimeofday. |
| 279 | * If hrtimers then up to ns accurate, if not microsecond. |
| 280 | */ |
| 281 | ktime_get_real_ts(&ts); |
| 282 | |
| 283 | return timespec_to_ns(&ts); |
| 284 | } |
| 285 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 286 | /* Device operating modes */ |
| 287 | #define INDIO_DIRECT_MODE 0x01 |
Jonathan Cameron | ec3afa4 | 2011-09-21 11:15:54 +0100 | [diff] [blame] | 288 | #define INDIO_BUFFER_TRIGGERED 0x02 |
| 289 | #define INDIO_BUFFER_HARDWARE 0x08 |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 290 | |
Jonathan Cameron | ec3afa4 | 2011-09-21 11:15:54 +0100 | [diff] [blame] | 291 | #define INDIO_ALL_BUFFER_MODES \ |
| 292 | (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE) |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 293 | |
Michael Hennerich | 43a4360 | 2011-06-27 13:07:09 +0100 | [diff] [blame] | 294 | struct iio_trigger; /* forward declaration */ |
Jonathan Cameron | 7ae8cf6 | 2011-08-30 12:32:44 +0100 | [diff] [blame] | 295 | struct iio_dev; |
Michael Hennerich | 43a4360 | 2011-06-27 13:07:09 +0100 | [diff] [blame] | 296 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 297 | /** |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 298 | * struct iio_info - constant information about device |
| 299 | * @driver_module: module structure used to ensure correct |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 300 | * ownership of chrdevs etc |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 301 | * @event_attrs: event control attributes |
| 302 | * @attrs: general purpose device attributes |
| 303 | * @read_raw: function to request a value from the device. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 304 | * mask specifies which value. Note 0 means a reading of |
| 305 | * the channel in question. Return value will specify the |
| 306 | * type of value returned by the device. val and val2 will |
| 307 | * contain the elements making up the returned value. |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 308 | * @write_raw: function to write a value to the device. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 309 | * Parameters are the same as for read_raw. |
Michael Hennerich | 5c04af0 | 2011-06-27 13:07:10 +0100 | [diff] [blame] | 310 | * @write_raw_get_fmt: callback function to query the expected |
| 311 | * format/precision. If not set by the driver, write_raw |
| 312 | * returns IIO_VAL_INT_PLUS_MICRO. |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 313 | * @read_event_config: find out if the event is enabled. |
| 314 | * @write_event_config: set if the event is enabled. |
| 315 | * @read_event_value: read a value associated with the event. Meaning |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 316 | * is event dependant. event_code specifies which event. |
Justin P. Mattock | 4abf6f8 | 2012-02-29 22:00:38 -0800 | [diff] [blame] | 317 | * @write_event_value: write the value associated with the event. |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 318 | * Meaning is event dependent. |
Michael Hennerich | 43a4360 | 2011-06-27 13:07:09 +0100 | [diff] [blame] | 319 | * @validate_trigger: function to validate the trigger when the |
| 320 | * current trigger gets changed. |
Peter Meerwald | c3668a0 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 321 | * @update_scan_mode: function to configure device and scan buffer when |
| 322 | * channels have changed |
| 323 | * @debugfs_reg_access: function to read or write register value of device |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 324 | **/ |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 325 | struct iio_info { |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 326 | struct module *driver_module; |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 327 | struct attribute_group *event_attrs; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 328 | const struct attribute_group *attrs; |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 329 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 330 | int (*read_raw)(struct iio_dev *indio_dev, |
| 331 | struct iio_chan_spec const *chan, |
| 332 | int *val, |
| 333 | int *val2, |
| 334 | long mask); |
| 335 | |
| 336 | int (*write_raw)(struct iio_dev *indio_dev, |
| 337 | struct iio_chan_spec const *chan, |
| 338 | int val, |
| 339 | int val2, |
| 340 | long mask); |
| 341 | |
Michael Hennerich | 5c04af0 | 2011-06-27 13:07:10 +0100 | [diff] [blame] | 342 | int (*write_raw_get_fmt)(struct iio_dev *indio_dev, |
| 343 | struct iio_chan_spec const *chan, |
| 344 | long mask); |
| 345 | |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 346 | int (*read_event_config)(struct iio_dev *indio_dev, |
Jonathan Cameron | 330c6c5 | 2011-09-02 17:14:39 +0100 | [diff] [blame] | 347 | u64 event_code); |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 348 | |
| 349 | int (*write_event_config)(struct iio_dev *indio_dev, |
Jonathan Cameron | 330c6c5 | 2011-09-02 17:14:39 +0100 | [diff] [blame] | 350 | u64 event_code, |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 351 | int state); |
| 352 | |
| 353 | int (*read_event_value)(struct iio_dev *indio_dev, |
Jonathan Cameron | 330c6c5 | 2011-09-02 17:14:39 +0100 | [diff] [blame] | 354 | u64 event_code, |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 355 | int *val); |
| 356 | int (*write_event_value)(struct iio_dev *indio_dev, |
Jonathan Cameron | 330c6c5 | 2011-09-02 17:14:39 +0100 | [diff] [blame] | 357 | u64 event_code, |
Jonathan Cameron | 1d89271 | 2011-05-18 14:40:51 +0100 | [diff] [blame] | 358 | int val); |
Michael Hennerich | 43a4360 | 2011-06-27 13:07:09 +0100 | [diff] [blame] | 359 | int (*validate_trigger)(struct iio_dev *indio_dev, |
| 360 | struct iio_trigger *trig); |
Jonathan Cameron | 4d5f8d3 | 2011-12-05 21:37:12 +0000 | [diff] [blame] | 361 | int (*update_scan_mode)(struct iio_dev *indio_dev, |
| 362 | const unsigned long *scan_mask); |
Michael Hennerich | e553f18 | 2012-03-01 10:51:03 +0100 | [diff] [blame] | 363 | int (*debugfs_reg_access)(struct iio_dev *indio_dev, |
| 364 | unsigned reg, unsigned writeval, |
| 365 | unsigned *readval); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 366 | }; |
| 367 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 368 | /** |
Jonathan Cameron | 1612244 | 2011-12-05 22:18:14 +0000 | [diff] [blame] | 369 | * struct iio_buffer_setup_ops - buffer setup related callbacks |
| 370 | * @preenable: [DRIVER] function to run prior to marking buffer enabled |
| 371 | * @postenable: [DRIVER] function to run after marking buffer enabled |
| 372 | * @predisable: [DRIVER] function to run prior to marking buffer |
| 373 | * disabled |
| 374 | * @postdisable: [DRIVER] function to run after marking buffer disabled |
Lars-Peter Clausen | 939546d | 2012-07-09 10:00:00 +0100 | [diff] [blame] | 375 | * @validate_scan_mask: [DRIVER] function callback to check whether a given |
| 376 | * scan mask is valid for the device. |
Jonathan Cameron | 1612244 | 2011-12-05 22:18:14 +0000 | [diff] [blame] | 377 | */ |
| 378 | struct iio_buffer_setup_ops { |
Peter Meerwald | 99698b4 | 2012-08-26 13:43:00 +0100 | [diff] [blame] | 379 | int (*preenable)(struct iio_dev *); |
| 380 | int (*postenable)(struct iio_dev *); |
| 381 | int (*predisable)(struct iio_dev *); |
| 382 | int (*postdisable)(struct iio_dev *); |
Lars-Peter Clausen | 939546d | 2012-07-09 10:00:00 +0100 | [diff] [blame] | 383 | bool (*validate_scan_mask)(struct iio_dev *indio_dev, |
| 384 | const unsigned long *scan_mask); |
Jonathan Cameron | 1612244 | 2011-12-05 22:18:14 +0000 | [diff] [blame] | 385 | }; |
| 386 | |
| 387 | /** |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 388 | * struct iio_dev - industrial I/O device |
| 389 | * @id: [INTERN] used to identify device internally |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 390 | * @modes: [DRIVER] operating modes supported by device |
| 391 | * @currentmode: [DRIVER] current operating mode |
| 392 | * @dev: [DRIVER] device structure, should be assigned a parent |
| 393 | * and owner |
Jonathan Cameron | 5aa9618 | 2011-08-30 12:41:06 +0100 | [diff] [blame] | 394 | * @event_interface: [INTERN] event chrdevs associated with interrupt lines |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 395 | * @buffer: [DRIVER] any buffer present |
Jonathan Cameron | 420fe2e | 2012-04-21 10:09:35 +0100 | [diff] [blame] | 396 | * @scan_bytes: [INTERN] num bytes captured to be fed to buffer demux |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 397 | * @mlock: [INTERN] lock used to prevent simultaneous device state |
| 398 | * changes |
| 399 | * @available_scan_masks: [DRIVER] optional array of allowed bitmasks |
Jonathan Cameron | 32b5eec | 2011-09-02 17:14:38 +0100 | [diff] [blame] | 400 | * @masklength: [INTERN] the length of the mask established from |
| 401 | * channels |
Jonathan Cameron | 959d295 | 2011-12-05 21:37:13 +0000 | [diff] [blame] | 402 | * @active_scan_mask: [INTERN] union of all scan masks requested by buffers |
Jonathan Cameron | fd6487f | 2012-04-21 10:09:44 +0100 | [diff] [blame] | 403 | * @scan_timestamp: [INTERN] set if any buffers have requested timestamp |
Jonathan Cameron | f126480 | 2012-04-21 10:09:34 +0100 | [diff] [blame] | 404 | * @scan_index_timestamp:[INTERN] cache of the index to the timestamp |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 405 | * @trig: [INTERN] current device trigger (buffer modes) |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 406 | * @pollfunc: [DRIVER] function run on trigger being received |
| 407 | * @channels: [DRIVER] channel specification structure table |
Peter Meerwald | 1787948 | 2012-06-12 15:38:45 +0200 | [diff] [blame] | 408 | * @num_channels: [DRIVER] number of channels specified in @channels. |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 409 | * @channel_attr_list: [INTERN] keep track of automatically created channel |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 410 | * attributes |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 411 | * @chan_attr_group: [INTERN] group for all attrs in base directory |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 412 | * @name: [DRIVER] name of the device. |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 413 | * @info: [DRIVER] callbacks and constant info from driver |
Jonathan Cameron | ac917a8 | 2012-02-15 19:48:00 +0000 | [diff] [blame] | 414 | * @info_exist_lock: [INTERN] lock to prevent use during removal |
Jonathan Cameron | ecbf20c | 2012-04-10 21:11:06 +0100 | [diff] [blame] | 415 | * @setup_ops: [DRIVER] callbacks to call before and after buffer |
| 416 | * enable/disable |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 417 | * @chrdev: [INTERN] associated character device |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 418 | * @groups: [INTERN] attribute groups |
| 419 | * @groupcounter: [INTERN] index of next attribute group |
Lars-Peter Clausen | bb01443 | 2011-12-19 15:23:45 +0100 | [diff] [blame] | 420 | * @flags: [INTERN] file ops related flags including busy flag. |
Michael Hennerich | e553f18 | 2012-03-01 10:51:03 +0100 | [diff] [blame] | 421 | * @debugfs_dentry: [INTERN] device specific debugfs dentry. |
| 422 | * @cached_reg_addr: [INTERN] cached register address for debugfs reads. |
| 423 | */ |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 424 | struct iio_dev { |
| 425 | int id; |
Jonathan Cameron | 4024bc7 | 2011-08-12 17:08:53 +0100 | [diff] [blame] | 426 | |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 427 | int modes; |
| 428 | int currentmode; |
| 429 | struct device dev; |
| 430 | |
Jonathan Cameron | 5aa9618 | 2011-08-30 12:41:06 +0100 | [diff] [blame] | 431 | struct iio_event_interface *event_interface; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 432 | |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 433 | struct iio_buffer *buffer; |
Jonathan Cameron | 420fe2e | 2012-04-21 10:09:35 +0100 | [diff] [blame] | 434 | int scan_bytes; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 435 | struct mutex mlock; |
| 436 | |
Michael Hennerich | cd4361c | 2012-02-22 13:16:49 +0100 | [diff] [blame] | 437 | const unsigned long *available_scan_masks; |
Jonathan Cameron | 32b5eec | 2011-09-02 17:14:38 +0100 | [diff] [blame] | 438 | unsigned masklength; |
Michael Hennerich | cd4361c | 2012-02-22 13:16:49 +0100 | [diff] [blame] | 439 | const unsigned long *active_scan_mask; |
Jonathan Cameron | fd6487f | 2012-04-21 10:09:44 +0100 | [diff] [blame] | 440 | bool scan_timestamp; |
Jonathan Cameron | f126480 | 2012-04-21 10:09:34 +0100 | [diff] [blame] | 441 | unsigned scan_index_timestamp; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 442 | struct iio_trigger *trig; |
| 443 | struct iio_poll_func *pollfunc; |
| 444 | |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 445 | struct iio_chan_spec const *channels; |
| 446 | int num_channels; |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 447 | |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 448 | struct list_head channel_attr_list; |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 449 | struct attribute_group chan_attr_group; |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 450 | const char *name; |
| 451 | const struct iio_info *info; |
Jonathan Cameron | ac917a8 | 2012-02-15 19:48:00 +0000 | [diff] [blame] | 452 | struct mutex info_exist_lock; |
Jonathan Cameron | 1612244 | 2011-12-05 22:18:14 +0000 | [diff] [blame] | 453 | const struct iio_buffer_setup_ops *setup_ops; |
Jonathan Cameron | 1a25e59 | 2011-08-30 12:41:12 +0100 | [diff] [blame] | 454 | struct cdev chrdev; |
Jonathan Cameron | 26d25ae | 2011-09-02 17:14:40 +0100 | [diff] [blame] | 455 | #define IIO_MAX_GROUPS 6 |
| 456 | const struct attribute_group *groups[IIO_MAX_GROUPS + 1]; |
| 457 | int groupcounter; |
Lars-Peter Clausen | bb01443 | 2011-12-19 15:23:45 +0100 | [diff] [blame] | 458 | |
| 459 | unsigned long flags; |
Michael Hennerich | e553f18 | 2012-03-01 10:51:03 +0100 | [diff] [blame] | 460 | #if defined(CONFIG_DEBUG_FS) |
| 461 | struct dentry *debugfs_dentry; |
| 462 | unsigned cached_reg_addr; |
| 463 | #endif |
Jonathan Cameron | 6fe8135 | 2011-05-18 14:42:37 +0100 | [diff] [blame] | 464 | }; |
| 465 | |
| 466 | /** |
Jonathan Cameron | 5fb21c8 | 2011-12-05 21:37:10 +0000 | [diff] [blame] | 467 | * iio_find_channel_from_si() - get channel from its scan index |
| 468 | * @indio_dev: device |
| 469 | * @si: scan index to match |
| 470 | */ |
| 471 | const struct iio_chan_spec |
| 472 | *iio_find_channel_from_si(struct iio_dev *indio_dev, int si); |
| 473 | |
| 474 | /** |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 475 | * iio_device_register() - register a device with the IIO subsystem |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 476 | * @indio_dev: Device structure filled by the device driver |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 477 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 478 | int iio_device_register(struct iio_dev *indio_dev); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 479 | |
| 480 | /** |
| 481 | * iio_device_unregister() - unregister a device from the IIO subsystem |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 482 | * @indio_dev: Device structure representing the device. |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 483 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 484 | void iio_device_unregister(struct iio_dev *indio_dev); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 485 | |
| 486 | /** |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 487 | * 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] | 488 | * @indio_dev: IIO device structure |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 489 | * @ev_code: What event |
Randy Dunlap | 4c57260 | 2009-10-04 19:34:02 -0700 | [diff] [blame] | 490 | * @timestamp: When the event occurred |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 491 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 492 | 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] | 493 | |
Jonathan Cameron | 5aaaeba | 2010-05-04 14:43:00 +0100 | [diff] [blame] | 494 | extern struct bus_type iio_bus_type; |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 495 | |
| 496 | /** |
Lars-Peter Clausen | 7cbb753 | 2012-04-26 13:35:01 +0200 | [diff] [blame] | 497 | * iio_device_put() - reference counted deallocation of struct device |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 498 | * @indio_dev: IIO device structure containing the device |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 499 | **/ |
Lars-Peter Clausen | 7cbb753 | 2012-04-26 13:35:01 +0200 | [diff] [blame] | 500 | static inline void iio_device_put(struct iio_dev *indio_dev) |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 501 | { |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 502 | if (indio_dev) |
| 503 | put_device(&indio_dev->dev); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 504 | }; |
| 505 | |
Lars-Peter Clausen | 7a7913f | 2012-05-12 15:39:32 +0200 | [diff] [blame] | 506 | /** |
| 507 | * dev_to_iio_dev() - Get IIO device struct from a device struct |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 508 | * @dev: The device embedded in the IIO device |
Lars-Peter Clausen | 7a7913f | 2012-05-12 15:39:32 +0200 | [diff] [blame] | 509 | * |
| 510 | * Note: The device must be a IIO device, otherwise the result is undefined. |
| 511 | */ |
| 512 | static inline struct iio_dev *dev_to_iio_dev(struct device *dev) |
| 513 | { |
| 514 | return container_of(dev, struct iio_dev, dev); |
| 515 | } |
| 516 | |
Lars-Peter Clausen | e4e8b77 | 2012-06-04 10:50:02 +0200 | [diff] [blame] | 517 | /** |
| 518 | * iio_device_get() - increment reference count for the device |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 519 | * @indio_dev: IIO device structure |
Lars-Peter Clausen | e4e8b77 | 2012-06-04 10:50:02 +0200 | [diff] [blame] | 520 | * |
| 521 | * Returns: The passed IIO device |
| 522 | **/ |
| 523 | static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev) |
| 524 | { |
| 525 | return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL; |
| 526 | } |
| 527 | |
Lars-Peter Clausen | 2d66f38 | 2012-08-10 17:36:00 +0100 | [diff] [blame] | 528 | |
| 529 | /** |
| 530 | * iio_device_set_drvdata() - Set device driver data |
| 531 | * @indio_dev: IIO device structure |
| 532 | * @data: Driver specific data |
| 533 | * |
| 534 | * Allows to attach an arbitrary pointer to an IIO device, which can later be |
| 535 | * retrieved by iio_device_get_drvdata(). |
| 536 | */ |
| 537 | static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data) |
| 538 | { |
| 539 | dev_set_drvdata(&indio_dev->dev, data); |
| 540 | } |
| 541 | |
| 542 | /** |
| 543 | * iio_device_get_drvdata() - Get device driver data |
| 544 | * @indio_dev: IIO device structure |
| 545 | * |
| 546 | * Returns the data previously set with iio_device_set_drvdata() |
| 547 | */ |
| 548 | static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev) |
| 549 | { |
| 550 | return dev_get_drvdata(&indio_dev->dev); |
| 551 | } |
| 552 | |
Jonathan Cameron | 6f7c8ee | 2011-04-15 18:55:56 +0100 | [diff] [blame] | 553 | /* Can we make this smaller? */ |
| 554 | #define IIO_ALIGN L1_CACHE_BYTES |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 555 | /** |
Lars-Peter Clausen | 7cbb753 | 2012-04-26 13:35:01 +0200 | [diff] [blame] | 556 | * iio_device_alloc() - allocate an iio_dev from a driver |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 557 | * @sizeof_priv: Space to allocate for private structure. |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 558 | **/ |
Lars-Peter Clausen | 7cbb753 | 2012-04-26 13:35:01 +0200 | [diff] [blame] | 559 | struct iio_dev *iio_device_alloc(int sizeof_priv); |
Jonathan Cameron | 6f7c8ee | 2011-04-15 18:55:56 +0100 | [diff] [blame] | 560 | |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 561 | static inline void *iio_priv(const struct iio_dev *indio_dev) |
Jonathan Cameron | 6f7c8ee | 2011-04-15 18:55:56 +0100 | [diff] [blame] | 562 | { |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 563 | return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN); |
Jonathan Cameron | 6f7c8ee | 2011-04-15 18:55:56 +0100 | [diff] [blame] | 564 | } |
| 565 | |
| 566 | static inline struct iio_dev *iio_priv_to_dev(void *priv) |
| 567 | { |
| 568 | return (struct iio_dev *)((char *)priv - |
| 569 | ALIGN(sizeof(struct iio_dev), IIO_ALIGN)); |
| 570 | } |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 571 | |
| 572 | /** |
Lars-Peter Clausen | 7cbb753 | 2012-04-26 13:35:01 +0200 | [diff] [blame] | 573 | * iio_device_free() - free an iio_dev from a driver |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 574 | * @indio_dev: the iio_dev associated with the device |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 575 | **/ |
Lars-Peter Clausen | 7cbb753 | 2012-04-26 13:35:01 +0200 | [diff] [blame] | 576 | void iio_device_free(struct iio_dev *indio_dev); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 577 | |
| 578 | /** |
Jonathan Cameron | 14555b1 | 2011-09-21 11:15:57 +0100 | [diff] [blame] | 579 | * iio_buffer_enabled() - helper function to test if the buffer is enabled |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 580 | * @indio_dev: IIO device structure for device |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 581 | **/ |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 582 | static inline bool iio_buffer_enabled(struct iio_dev *indio_dev) |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 583 | { |
Jonathan Cameron | f8c6f4e | 2011-10-06 17:14:35 +0100 | [diff] [blame] | 584 | return indio_dev->currentmode |
Jonathan Cameron | ec3afa4 | 2011-09-21 11:15:54 +0100 | [diff] [blame] | 585 | & (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE); |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 586 | }; |
| 587 | |
Michael Hennerich | e553f18 | 2012-03-01 10:51:03 +0100 | [diff] [blame] | 588 | /** |
| 589 | * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry |
Peter Meerwald | 7dcd7b6 | 2012-06-12 15:38:48 +0200 | [diff] [blame] | 590 | * @indio_dev: IIO device structure for device |
Michael Hennerich | e553f18 | 2012-03-01 10:51:03 +0100 | [diff] [blame] | 591 | **/ |
| 592 | #if defined(CONFIG_DEBUG_FS) |
| 593 | static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev) |
| 594 | { |
| 595 | return indio_dev->debugfs_dentry; |
| 596 | }; |
| 597 | #else |
| 598 | static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev) |
| 599 | { |
| 600 | return NULL; |
| 601 | }; |
| 602 | #endif |
| 603 | |
Jonathan Cameron | 847ec80 | 2009-08-18 18:06:19 +0100 | [diff] [blame] | 604 | #endif /* _INDUSTRIAL_IO_H_ */ |