1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
|
/* The industrial I/O core
*
*Copyright (c) 2008 Jonathan Cameron
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 as published by
* the Free Software Foundation.
*
* General attributes
*/
#ifndef _INDUSTRIAL_IO_SYSFS_H_
#define _INDUSTRIAL_IO_SYSFS_H_
#include "iio.h"
/**
* struct iio_event_attr - event control attribute
* @dev_attr: underlying device attribute
* @mask: mask for the event when detecting
* @listel: list header to allow addition to list of event handlers
*/
struct iio_event_attr {
struct device_attribute dev_attr;
int mask;
struct iio_event_handler_list *listel;
};
#define to_iio_event_attr(_dev_attr) \
container_of(_dev_attr, struct iio_event_attr, dev_attr)
/**
* struct iio_chrdev_minor_attr - simple attribute to allow reading of chrdev
* minor number
* @dev_attr: underlying device attribute
* @minor: the minor number
*/
struct iio_chrdev_minor_attr {
struct device_attribute dev_attr;
int minor;
};
void
__init_iio_chrdev_minor_attr(struct iio_chrdev_minor_attr *minor_attr,
const char *name,
struct module *owner,
int id);
#define to_iio_chrdev_minor_attr(_dev_attr) \
container_of(_dev_attr, struct iio_chrdev_minor_attr, dev_attr);
/**
* struct iio_dev_attr - iio specific device attribute
* @dev_attr: underlying device attribute
* @address: associated register address
* @val2: secondary attribute value
*/
struct iio_dev_attr {
struct device_attribute dev_attr;
int address;
int val2;
};
#define to_iio_dev_attr(_dev_attr) \
container_of(_dev_attr, struct iio_dev_attr, dev_attr)
ssize_t iio_read_const_attr(struct device *dev,
struct device_attribute *attr,
char *len);
/**
* struct iio_const_attr - constant device specific attribute
* often used for things like available modes
* @string: attribute string
* @dev_attr: underlying device attribute
*/
struct iio_const_attr {
const char *string;
struct device_attribute dev_attr;
};
#define to_iio_const_attr(_dev_attr) \
container_of(_dev_attr, struct iio_const_attr, dev_attr)
/* Some attributes will be hard coded (device dependent) and not require an
address, in these cases pass a negative */
#define IIO_ATTR(_name, _mode, _show, _store, _addr) \
{ .dev_attr = __ATTR(_name, _mode, _show, _store), \
.address = _addr }
#define IIO_ATTR_2(_name, _mode, _show, _store, _addr, _val2) \
{ .dev_attr = __ATTR(_name, _mode, _show, _store), \
.address = _addr, \
.val2 = _val2 }
#define IIO_DEVICE_ATTR(_name, _mode, _show, _store, _addr) \
struct iio_dev_attr iio_dev_attr_##_name \
= IIO_ATTR(_name, _mode, _show, _store, _addr)
#define IIO_DEVICE_ATTR_2(_name, _mode, _show, _store, _addr, _val2) \
struct iio_dev_attr iio_dev_attr_##_name \
= IIO_ATTR_2(_name, _mode, _show, _store, _addr, _val2)
#define IIO_CONST_ATTR(_name, _string) \
struct iio_const_attr iio_const_attr_##_name \
= { .string = _string, \
.dev_attr = __ATTR(_name, S_IRUGO, iio_read_const_attr, NULL)}
/* Generic attributes of onetype or another */
/**
* IIO_DEV_ATTR_REV - revision number for the device
* @_show: output method for the attribute
*
* Very much device dependent.
**/
#define IIO_DEV_ATTR_REV(_show) \
IIO_DEVICE_ATTR(revision, S_IRUGO, _show, NULL, 0)
/**
* IIO_DEV_ATTR_NAME - chip type dependent identifier
* @_show: output method for the attribute
**/
#define IIO_DEV_ATTR_NAME(_show) \
IIO_DEVICE_ATTR(name, S_IRUGO, _show, NULL, 0)
/**
* IIO_DEV_ATTR_SAMP_FREQ - sets any internal clock frequency
* @_mode: sysfs file mode/permissions
* @_show: output method for the attribute
* @_store: input method for the attribute
**/
#define IIO_DEV_ATTR_SAMP_FREQ(_mode, _show, _store) \
IIO_DEVICE_ATTR(sampling_frequency, _mode, _show, _store, 0)
/**
* IIO_DEV_ATTR_AVAIL_SAMP_FREQ - list available sampling frequencies
* @_show: output method for the attribute
*
* May be mode dependent on some devices
**/
#define IIO_DEV_ATTR_AVAIL_SAMP_FREQ(_show) \
IIO_DEVICE_ATTR(available_sampling_frequency, S_IRUGO, _show, NULL, 0)
/**
* IIO_CONST_ATTR_AVAIL_SAMP_FREQ - list available sampling frequencies
* @_string: frequency string for the attribute
*
* Constant version
**/
#define IIO_CONST_ATTR_AVAIL_SAMP_FREQ(_string) \
IIO_CONST_ATTR(available_sampling_frequency, _string)
/**
* IIO_DEV_ATTR_SCAN_MODE - select a scan mode
* @_mode: sysfs file mode/permissions
* @_show: output method for the attribute
* @_store: input method for the attribute
*
* This is used when only certain combinations of inputs may be read in one
* scan.
**/
#define IIO_DEV_ATTR_SCAN_MODE(_mode, _show, _store) \
IIO_DEVICE_ATTR(scan_mode, _mode, _show, _store, 0)
/**
* IIO_DEV_ATTR_AVAIL_SCAN_MODES - list available scan modes
* @_show: output method for the attribute
**/
#define IIO_DEV_ATTR_AVAIL_SCAN_MODES(_show) \
IIO_DEVICE_ATTR(available_scan_modes, S_IRUGO, _show, NULL, 0)
/**
* IIO_DEV_ATTR_SCAN - result of scan of multiple channels
* @_show: output method for the attribute
**/
#define IIO_DEV_ATTR_SCAN(_show) \
IIO_DEVICE_ATTR(scan, S_IRUGO, _show, NULL, 0);
/**
* IIO_DEV_ATTR_INPUT - direct read of a single input channel
* @_number: input channel number
* @_show: output method for the attribute
**/
#define IIO_DEV_ATTR_INPUT(_number, _show) \
IIO_DEVICE_ATTR(in##_number, S_IRUGO, _show, NULL, _number)
/**
* IIO_DEV_ATTR_SW_RING_ENABLE - enable software ring buffer
* @_show: output method for the attribute
* @_store: input method for the attribute
*
* Success may be dependent on attachment of trigger previously.
**/
#define IIO_DEV_ATTR_SW_RING_ENABLE(_show, _store) \
IIO_DEVICE_ATTR(sw_ring_enable, S_IRUGO | S_IWUSR, _show, _store, 0)
/**
* IIO_DEV_ATTR_HW_RING_ENABLE - enable hardware ring buffer
* @_show: output method for the attribute
* @_store: input method for the attribute
*
* This is a different attribute from the software one as one can envision
* schemes where a combination of the two may be used.
**/
#define IIO_DEV_ATTR_HW_RING_ENABLE(_show, _store) \
IIO_DEVICE_ATTR(hw_ring_enable, S_IRUGO | S_IWUSR, _show, _store, 0)
/**
* IIO_DEV_ATTR_BPSE - set number of bits per scan element
* @_mode: sysfs file mode/permissions
* @_show: output method for the attribute
* @_store: input method for the attribute
**/
#define IIO_DEV_ATTR_BPSE(_mode, _show, _store) \
IIO_DEVICE_ATTR(bpse, _mode, _show, _store, 0)
/**
* IIO_DEV_ATTR_BPSE_AVAILABLE - number of bits per scan element supported
* @_show: output method for the attribute
**/
#define IIO_DEV_ATTR_BPSE_AVAILABLE(_show) \
IIO_DEVICE_ATTR(bpse_available, S_IRUGO, _show, NULL, 0)
/**
* IIO_DEV_ATTR_TEMP - many sensors have auxiliary temperature sensors
* @_show: output method for the attribute
**/
#define IIO_DEV_ATTR_TEMP(_show) \
IIO_DEVICE_ATTR(temp, S_IRUGO, _show, NULL, 0)
/**
* IIO_EVENT_SH - generic shared event handler
* @_name: event name
* @_handler: handler function to be called
*
* This is used in cases where more than one event may result from a single
* handler. Often the case that some alarm register must be read and multiple
* alarms may have been triggered.
**/
#define IIO_EVENT_SH(_name, _handler) \
static struct iio_event_handler_list \
iio_event_##_name = { \
.handler = _handler, \
.refcount = 0, \
.exist_lock = __MUTEX_INITIALIZER(iio_event_##_name \
.exist_lock), \
.list = { \
.next = &iio_event_##_name.list, \
.prev = &iio_event_##_name.list, \
}, \
};
/**
* IIO_EVENT_ATTR_SH - generic shared event attribute
* @_name: event name
* @_ev_list: event handler list
* @_show: output method for the attribute
* @_store: input method for the attribute
* @_mask: mask used when detecting the event
*
* An attribute with an associated IIO_EVENT_SH
**/
#define IIO_EVENT_ATTR_SH(_name, _ev_list, _show, _store, _mask) \
static struct iio_event_attr \
iio_event_attr_##_name \
= { .dev_attr = __ATTR(_name, S_IRUGO | S_IWUSR, \
_show, _store), \
.mask = _mask, \
.listel = &_ev_list };
/**
* IIO_EVENT_ATTR - non-shared event attribute
* @_name: event name
* @_show: output method for the attribute
* @_store: input method for the attribute
* @_mask: mask used when detecting the event
* @_handler: handler function to be called
**/
#define IIO_EVENT_ATTR(_name, _show, _store, _mask, _handler) \
static struct iio_event_handler_list \
iio_event_##_name = { \
.handler = _handler, \
}; \
static struct \
iio_event_attr \
iio_event_attr_##_name \
= { .dev_attr = __ATTR(_name, S_IRUGO | S_IWUSR, \
_show, _store), \
.mask = _mask, \
.listel = &iio_event_##_name }; \
/**
* IIO_EVENT_ATTR_DATA_RDY - event driven by data ready signal
* @_show: output method for the attribute
* @_store: input method for the attribute
* @_mask: mask used when detecting the event
* @_handler: handler function to be called
*
* Not typically implemented in devices where full triggering support
* has been implemented.
**/
#define IIO_EVENT_ATTR_DATA_RDY(_show, _store, _mask, _handler) \
IIO_EVENT_ATTR(data_rdy, _show, _store, _mask, _handler)
#define IIO_EVENT_CODE_DATA_RDY 100
#define IIO_EVENT_CODE_RING_BASE 200
#define IIO_EVENT_CODE_ACCEL_BASE 300
#define IIO_EVENT_CODE_GYRO_BASE 400
#define IIO_EVENT_CODE_ADC_BASE 500
#define IIO_EVENT_CODE_MISC_BASE 600
#define IIO_EVENT_CODE_DEVICE_SPECIFIC 1000
/**
* IIO_EVENT_ATTR_RING_50_FULL - ring buffer event to indicate 50% full
* @_show: output method for the attribute
* @_store: input method for the attribute
* @_mask: mask used when detecting the event
* @_handler: handler function to be called
**/
#define IIO_EVENT_ATTR_RING_50_FULL(_show, _store, _mask, _handler) \
IIO_EVENT_ATTR(ring_50_full, _show, _store, _mask, _handler)
/**
* IIO_EVENT_ATTR_RING_50_FULL_SH - shared ring event to indicate 50% full
* @_evlist: event handler list
* @_show: output method for the attribute
* @_store: input method for the attribute
* @_mask: mask used when detecting the event
**/
#define IIO_EVENT_ATTR_RING_50_FULL_SH(_evlist, _show, _store, _mask) \
IIO_EVENT_ATTR_SH(ring_50_full, _evlist, _show, _store, _mask)
/**
* IIO_EVENT_ATTR_RING_75_FULL_SH - shared ring event to indicate 75% full
* @_evlist: event handler list
* @_show: output method for the attribute
* @_store: input method for the attribute
* @_mask: mask used when detecting the event
**/
#define IIO_EVENT_ATTR_RING_75_FULL_SH(_evlist, _show, _store, _mask) \
IIO_EVENT_ATTR_SH(ring_75_full, _evlist, _show, _store, _mask)
#define IIO_EVENT_CODE_RING_50_FULL IIO_EVENT_CODE_RING_BASE
#define IIO_EVENT_CODE_RING_75_FULL (IIO_EVENT_CODE_RING_BASE + 1)
#define IIO_EVENT_CODE_RING_100_FULL (IIO_EVENT_CODE_RING_BASE + 2)
#endif /* _INDUSTRIAL_IO_SYSFS_H_ */
|
