]>
Commit | Line | Data |
---|---|---|
ed9eccbe | 1 | /* |
27509143 IA |
2 | * comedidev.h |
3 | * header file for kernel-only structures, variables, and constants | |
4 | * | |
5 | * COMEDI - Linux Control and Measurement Device Interface | |
6 | * Copyright (C) 1997-2000 David A. Schleef <ds@schleef.org> | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation; either version 2 of the License, or | |
11 | * (at your option) any later version. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | */ | |
ed9eccbe DS |
18 | |
19 | #ifndef _COMEDIDEV_H | |
20 | #define _COMEDIDEV_H | |
21 | ||
ed9eccbe | 22 | #include <linux/dma-mapping.h> |
ab3cb2e3 IA |
23 | #include <linux/mutex.h> |
24 | #include <linux/spinlock_types.h> | |
2f3fdcd7 | 25 | #include <linux/rwsem.h> |
5b13ed94 | 26 | #include <linux/kref.h> |
ed9eccbe DS |
27 | |
28 | #include "comedi.h" | |
29 | ||
e0dcef71 | 30 | #define COMEDI_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c)) |
62eeae93 SW |
31 | #define COMEDI_VERSION_CODE COMEDI_VERSION(COMEDI_MAJORVERSION, \ |
32 | COMEDI_MINORVERSION, COMEDI_MICROVERSION) | |
ed9eccbe DS |
33 | #define COMEDI_RELEASE VERSION |
34 | ||
ed9eccbe | 35 | #define COMEDI_NUM_BOARD_MINORS 0x30 |
ed9eccbe | 36 | |
0f952fa8 IA |
37 | /** |
38 | * struct comedi_subdevice - Working data for a COMEDI subdevice | |
39 | * @device: COMEDI device to which this subdevice belongs. (Initialized by | |
40 | * comedi_alloc_subdevices().) | |
41 | * @index: Index of this subdevice within device's array of subdevices. | |
42 | * (Initialized by comedi_alloc_subdevices().) | |
43 | * @type: Type of subdevice from &enum comedi_subdevice_type. (Initialized by | |
44 | * the low-level driver.) | |
45 | * @n_chan: Number of channels the subdevice supports. (Initialized by the | |
46 | * low-level driver.) | |
47 | * @subdev_flags: Various "SDF" flags indicating aspects of the subdevice to | |
48 | * the COMEDI core and user application. (Initialized by the low-level | |
49 | * driver.) | |
50 | * @len_chanlist: Maximum length of a channel list if the subdevice supports | |
51 | * asynchronous acquisition commands. (Optionally initialized by the | |
52 | * low-level driver, or changed from 0 to 1 during post-configuration.) | |
53 | * @private: Private data pointer which is either set by the low-level driver | |
54 | * itself, or by a call to comedi_alloc_spriv() which allocates storage. | |
55 | * In the latter case, the storage is automatically freed after the | |
56 | * low-level driver's "detach" handler is called for the device. | |
57 | * (Initialized by the low-level driver.) | |
58 | * @async: Pointer to &struct comedi_async id the subdevice supports | |
59 | * asynchronous acquisition commands. (Allocated and initialized during | |
60 | * post-configuration if needed.) | |
61 | * @lock: Pointer to a file object that performed a %COMEDI_LOCK ioctl on the | |
62 | * subdevice. (Initially NULL.) | |
63 | * @busy: Pointer to a file object that is performing an asynchronous | |
64 | * acquisition command on the subdevice. (Initially NULL.) | |
65 | * @runflags: Internal flags for use by COMEDI core, mostly indicating whether | |
66 | * an asynchronous acquisition command is running. | |
67 | * @spin_lock: Generic spin-lock for use by the COMEDI core and the low-level | |
68 | * driver. (Initialized by comedi_alloc_subdevices().) | |
69 | * @io_bits: Bit-mask indicating the channel directions for a DIO subdevice | |
70 | * with no more than 32 channels. A '1' at a bit position indicates the | |
71 | * corresponding channel is configured as an output. (Initialized by the | |
72 | * low-level driver for a DIO subdevice. Forced to all-outputs during | |
73 | * post-configuration for a digital output subdevice.) | |
74 | * @maxdata: If non-zero, this is the maximum raw data value of each channel. | |
75 | * If zero, the maximum data value is channel-specific. (Initialized by | |
76 | * the low-level driver.) | |
77 | * @maxdata_list: If the maximum data value is channel-specific, this points | |
78 | * to an array of maximum data values indexed by channel index. | |
79 | * (Initialized by the low-level driver.) | |
80 | * @range_table: If non-NULL, this points to a COMEDI range table for the | |
81 | * subdevice. If NULL, the range table is channel-specific. (Initialized | |
82 | * by the low-level driver, will be set to an "invalid" range table during | |
83 | * post-configuration if @range_table and @range_table_list are both | |
84 | * NULL.) | |
85 | * @range_table_list: If the COMEDI range table is channel-specific, this | |
86 | * points to an array of pointers to COMEDI range tables indexed by | |
87 | * channel number. (Initialized by the low-level driver.) | |
88 | * @chanlist: Not used. | |
89 | * @insn_read: Optional pointer to a handler for the %INSN_READ instruction. | |
90 | * (Initialized by the low-level driver, or set to a default handler | |
91 | * during post-configuration.) | |
92 | * @insn_write: Optional pointer to a handler for the %INSN_WRITE instruction. | |
93 | * (Initialized by the low-level driver, or set to a default handler | |
94 | * during post-configuration.) | |
95 | * @insn_bits: Optional pointer to a handler for the %INSN_BITS instruction | |
96 | * for a digital input, digital output or digital input/output subdevice. | |
97 | * (Initialized by the low-level driver, or set to a default handler | |
98 | * during post-configuration.) | |
99 | * @insn_config: Optional pointer to a handler for the %INSN_CONFIG | |
100 | * instruction. (Initialized by the low-level driver, or set to a default | |
101 | * handler during post-configuration.) | |
102 | * @do_cmd: If the subdevice supports asynchronous acquisition commands, this | |
103 | * points to a handler to set it up in hardware. (Initialized by the | |
104 | * low-level driver.) | |
105 | * @do_cmdtest: If the subdevice supports asynchronous acquisition commands, | |
106 | * this points to a handler used to check and possibly tweak a prospective | |
107 | * acquisition command without setting it up in hardware. (Initialized by | |
108 | * the low-level driver.) | |
109 | * @poll: If the subdevice supports asynchronous acquisition commands, this | |
110 | * is an optional pointer to a handler for the %COMEDI_POLL ioctl which | |
111 | * instructs the low-level driver to synchronize buffers. (Initialized by | |
112 | * the low-level driver if needed.) | |
113 | * @cancel: If the subdevice supports asynchronous acquisition commands, this | |
114 | * points to a handler used to terminate a running command. (Initialized | |
115 | * by the low-level driver.) | |
116 | * @buf_change: If the subdevice supports asynchronous acquisition commands, | |
117 | * this is an optional pointer to a handler that is called when the data | |
118 | * buffer for handling asynchronous commands is allocated or reallocated. | |
119 | * (Initialized by the low-level driver if needed.) | |
120 | * @munge: If the subdevice supports asynchronous acquisition commands and | |
121 | * uses DMA to transfer data from the hardware to the acquisition buffer, | |
122 | * this points to a function used to "munge" the data values from the | |
123 | * hardware into the format expected by COMEDI. (Initialized by the | |
124 | * low-level driver if needed.) | |
125 | * @async_dma_dir: If the subdevice supports asynchronous acquisition commands | |
126 | * and uses DMA to transfer data from the hardware to the acquisition | |
127 | * buffer, this sets the DMA direction for the buffer. (initialized to | |
128 | * %DMA_NONE by comedi_alloc_subdevices() and changed by the low-level | |
129 | * driver if necessary.) | |
130 | * @state: Handy bit-mask indicating the output states for a DIO or digital | |
131 | * output subdevice with no more than 32 channels. (Initialized by the | |
132 | * low-level driver.) | |
133 | * @class_dev: If the subdevice supports asynchronous acquisition commands, | |
134 | * this points to a sysfs comediX_subdY device where X is the minor device | |
135 | * number of the COMEDI device and Y is the subdevice number. The minor | |
136 | * device number for the sysfs device is allocated dynamically in the | |
137 | * range 48 to 255. This is used to allow the COMEDI device to be opened | |
138 | * with a different default read or write subdevice. (Allocated during | |
139 | * post-configuration if needed.) | |
140 | * @minor: If @class_dev is set, this is its dynamically allocated minor | |
141 | * device number. (Set during post-configuration if necessary.) | |
142 | * @readback: Optional pointer to memory allocated by | |
143 | * comedi_alloc_subdev_readback() used to hold the values written to | |
144 | * analog output channels so they can be read back. The storage is | |
145 | * automatically freed after the low-level driver's "detach" handler is | |
146 | * called for the device. (Initialized by the low-level driver.) | |
147 | * | |
148 | * This is the main control structure for a COMEDI subdevice. If the subdevice | |
149 | * supports asynchronous acquisition commands, additional information is stored | |
150 | * in the &struct comedi_async pointed to by @async. | |
151 | * | |
152 | * Most of the subdevice is initialized by the low-level driver's "attach" or | |
153 | * "auto_attach" handlers but parts of it are initialized by | |
154 | * comedi_alloc_subdevices(), and other parts are initialized during | |
155 | * post-configuration on return from that handler. | |
156 | * | |
157 | * A low-level driver that sets @insn_bits for a digital input, digital output, | |
158 | * or DIO subdevice may leave @insn_read and @insn_write uninitialized, in | |
159 | * which case they will be set to a default handler during post-configuration | |
160 | * that uses @insn_bits to emulate the %INSN_READ and %INSN_WRITE instructions. | |
161 | */ | |
34c43922 | 162 | struct comedi_subdevice { |
71b5f4f1 | 163 | struct comedi_device *device; |
90a35c15 | 164 | int index; |
ed9eccbe DS |
165 | int type; |
166 | int n_chan; | |
baf22b64 | 167 | int subdev_flags; |
ed9eccbe DS |
168 | int len_chanlist; /* maximum length of channel/gain list */ |
169 | ||
170 | void *private; | |
171 | ||
d163679c | 172 | struct comedi_async *async; |
ed9eccbe DS |
173 | |
174 | void *lock; | |
175 | void *busy; | |
ae6b0867 | 176 | unsigned int runflags; |
214e3842 | 177 | spinlock_t spin_lock; /* generic spin-lock for COMEDI and drivers */ |
ed9eccbe | 178 | |
d4a7dc85 | 179 | unsigned int io_bits; |
ed9eccbe | 180 | |
790c5541 BP |
181 | unsigned int maxdata; /* if maxdata==0, use list */ |
182 | const unsigned int *maxdata_list; /* list is channel specific */ | |
ed9eccbe | 183 | |
9ced1de6 BP |
184 | const struct comedi_lrange *range_table; |
185 | const struct comedi_lrange *const *range_table_list; | |
ed9eccbe DS |
186 | |
187 | unsigned int *chanlist; /* driver-owned chanlist (not used) */ | |
188 | ||
0cb4c151 MA |
189 | int (*insn_read)(struct comedi_device *, struct comedi_subdevice *, |
190 | struct comedi_insn *, unsigned int *); | |
191 | int (*insn_write)(struct comedi_device *, struct comedi_subdevice *, | |
0a85b6f0 | 192 | struct comedi_insn *, unsigned int *); |
0cb4c151 MA |
193 | int (*insn_bits)(struct comedi_device *, struct comedi_subdevice *, |
194 | struct comedi_insn *, unsigned int *); | |
195 | int (*insn_config)(struct comedi_device *, struct comedi_subdevice *, | |
0a85b6f0 | 196 | struct comedi_insn *, unsigned int *); |
0cb4c151 MA |
197 | |
198 | int (*do_cmd)(struct comedi_device *, struct comedi_subdevice *); | |
199 | int (*do_cmdtest)(struct comedi_device *, struct comedi_subdevice *, | |
200 | struct comedi_cmd *); | |
201 | int (*poll)(struct comedi_device *, struct comedi_subdevice *); | |
202 | int (*cancel)(struct comedi_device *, struct comedi_subdevice *); | |
ed9eccbe DS |
203 | |
204 | /* called when the buffer changes */ | |
d546b896 | 205 | int (*buf_change)(struct comedi_device *, struct comedi_subdevice *); |
ed9eccbe | 206 | |
0cb4c151 MA |
207 | void (*munge)(struct comedi_device *dev, struct comedi_subdevice *s, |
208 | void *data, unsigned int num_bytes, | |
209 | unsigned int start_chan_index); | |
ed9eccbe DS |
210 | enum dma_data_direction async_dma_dir; |
211 | ||
212 | unsigned int state; | |
213 | ||
0bfbbe8f | 214 | struct device *class_dev; |
ed9eccbe | 215 | int minor; |
d2762066 HS |
216 | |
217 | unsigned int *readback; | |
ed9eccbe DS |
218 | }; |
219 | ||
11a10830 IA |
220 | /** |
221 | * struct comedi_buf_page - Describe a page of a COMEDI buffer | |
222 | * @virt_addr: Kernel address of page. | |
223 | * @dma_addr: DMA address of page if in DMA coherent memory. | |
224 | */ | |
ed9eccbe DS |
225 | struct comedi_buf_page { |
226 | void *virt_addr; | |
227 | dma_addr_t dma_addr; | |
228 | }; | |
229 | ||
11a10830 IA |
230 | /** |
231 | * struct comedi_buf_map - Describe pages in a COMEDI buffer | |
232 | * @dma_hw_dev: Low-level hardware &struct device pointer copied from the | |
233 | * COMEDI device's hw_dev member. | |
234 | * @page_list: Pointer to array of &struct comedi_buf_page, one for each | |
235 | * page in the buffer. | |
236 | * @n_pages: Number of pages in the buffer. | |
237 | * @dma_dir: DMA direction used to allocate pages of DMA coherent memory, | |
238 | * or %DMA_NONE if pages allocated from regular memory. | |
239 | * @refcount: &struct kref reference counter used to free the buffer. | |
240 | * | |
241 | * A COMEDI data buffer is allocated as individual pages, either in | |
242 | * conventional memory or DMA coherent memory, depending on the attached, | |
243 | * low-level hardware device. (The buffer pages also get mapped into the | |
244 | * kernel's contiguous virtual address space pointed to by the 'prealloc_buf' | |
245 | * member of &struct comedi_async.) | |
246 | * | |
247 | * The buffer is normally freed when the COMEDI device is detached from the | |
248 | * low-level driver (which may happen due to device removal), but if it happens | |
249 | * to be mmapped at the time, the pages cannot be freed until the buffer has | |
250 | * been munmapped. That is what the reference counter is for. (The virtual | |
251 | * address space pointed by 'prealloc_buf' is freed when the COMEDI device is | |
252 | * detached.) | |
253 | */ | |
af93da31 IA |
254 | struct comedi_buf_map { |
255 | struct device *dma_hw_dev; | |
256 | struct comedi_buf_page *page_list; | |
257 | unsigned int n_pages; | |
258 | enum dma_data_direction dma_dir; | |
259 | struct kref refcount; | |
260 | }; | |
261 | ||
55d128bf | 262 | /** |
9f2f5d34 IA |
263 | * struct comedi_async - Control data for asynchronous COMEDI commands |
264 | * @prealloc_buf: Kernel virtual address of allocated acquisition buffer. | |
265 | * @prealloc_bufsz: Buffer size (in bytes). | |
266 | * @buf_map: Map of buffer pages. | |
267 | * @max_bufsize: Maximum allowed buffer size (in bytes). | |
268 | * @buf_write_count: "Write completed" count (in bytes, modulo 2**32). | |
269 | * @buf_write_alloc_count: "Allocated for writing" count (in bytes, | |
270 | * modulo 2**32). | |
271 | * @buf_read_count: "Read completed" count (in bytes, modulo 2**32). | |
272 | * @buf_read_alloc_count: "Allocated for reading" count (in bytes, | |
273 | * modulo 2**32). | |
274 | * @buf_write_ptr: Buffer position for writer. | |
275 | * @buf_read_ptr: Buffer position for reader. | |
276 | * @cur_chan: Current position in chanlist for scan (for those drivers that | |
277 | * use it). | |
278 | * @scans_done: The number of scans completed. | |
279 | * @scan_progress: Amount received or sent for current scan (in bytes). | |
280 | * @munge_chan: Current position in chanlist for "munging". | |
281 | * @munge_count: "Munge" count (in bytes, modulo 2**32). | |
282 | * @munge_ptr: Buffer position for "munging". | |
283 | * @events: Bit-vector of events that have occurred. | |
284 | * @cmd: Details of comedi command in progress. | |
285 | * @wait_head: Task wait queue for file reader or writer. | |
286 | * @cb_mask: Bit-vector of events that should wake waiting tasks. | |
287 | * @inttrig: Software trigger function for command, or NULL. | |
55d128bf IA |
288 | * |
289 | * Note about the ..._count and ..._ptr members: | |
290 | * | |
291 | * Think of the _Count values being integers of unlimited size, indexing | |
292 | * into a buffer of infinite length (though only an advancing portion | |
a871773f IA |
293 | * of the buffer of fixed length prealloc_bufsz is accessible at any |
294 | * time). Then: | |
55d128bf IA |
295 | * |
296 | * Buf_Read_Count <= Buf_Read_Alloc_Count <= Munge_Count <= | |
297 | * Buf_Write_Count <= Buf_Write_Alloc_Count <= | |
298 | * (Buf_Read_Count + prealloc_bufsz) | |
299 | * | |
a871773f IA |
300 | * (Those aren't the actual members, apart from prealloc_bufsz.) When the |
301 | * buffer is reset, those _Count values start at 0 and only increase in value, | |
302 | * maintaining the above inequalities until the next time the buffer is | |
303 | * reset. The buffer is divided into the following regions by the inequalities: | |
55d128bf IA |
304 | * |
305 | * [0, Buf_Read_Count): | |
306 | * old region no longer accessible | |
a871773f | 307 | * |
55d128bf IA |
308 | * [Buf_Read_Count, Buf_Read_Alloc_Count): |
309 | * filled and munged region allocated for reading but not yet read | |
a871773f | 310 | * |
55d128bf IA |
311 | * [Buf_Read_Alloc_Count, Munge_Count): |
312 | * filled and munged region not yet allocated for reading | |
a871773f | 313 | * |
55d128bf IA |
314 | * [Munge_Count, Buf_Write_Count): |
315 | * filled region not yet munged | |
a871773f | 316 | * |
55d128bf IA |
317 | * [Buf_Write_Count, Buf_Write_Alloc_Count): |
318 | * unfilled region allocated for writing but not yet written | |
a871773f | 319 | * |
55d128bf IA |
320 | * [Buf_Write_Alloc_Count, Buf_Read_Count + prealloc_bufsz): |
321 | * unfilled region not yet allocated for writing | |
a871773f | 322 | * |
55d128bf IA |
323 | * [Buf_Read_Count + prealloc_bufsz, infinity): |
324 | * unfilled region not yet accessible | |
325 | * | |
326 | * Data needs to be written into the buffer before it can be read out, | |
327 | * and may need to be converted (or "munged") between the two | |
328 | * operations. Extra unfilled buffer space may need to allocated for | |
329 | * writing (advancing Buf_Write_Alloc_Count) before new data is written. | |
330 | * After writing new data, the newly filled space needs to be released | |
331 | * (advancing Buf_Write_Count). This also results in the new data being | |
332 | * "munged" (advancing Munge_Count). Before data is read out of the | |
333 | * buffer, extra space may need to be allocated for reading (advancing | |
334 | * Buf_Read_Alloc_Count). After the data has been read out, the space | |
335 | * needs to be released (advancing Buf_Read_Count). | |
336 | * | |
337 | * The actual members, buf_read_count, buf_read_alloc_count, | |
338 | * munge_count, buf_write_count, and buf_write_alloc_count take the | |
339 | * value of the corresponding capitalized _Count values modulo 2^32 | |
340 | * (UINT_MAX+1). Subtracting a "higher" _count value from a "lower" | |
341 | * _count value gives the same answer as subtracting a "higher" _Count | |
342 | * value from a lower _Count value because prealloc_bufsz < UINT_MAX+1. | |
343 | * The modulo operation is done implicitly. | |
344 | * | |
345 | * The buf_read_ptr, munge_ptr, and buf_write_ptr members take the value | |
346 | * of the corresponding capitalized _Count values modulo prealloc_bufsz. | |
347 | * These correspond to byte indices in the physical buffer. The modulo | |
348 | * operation is done by subtracting prealloc_bufsz when the value | |
349 | * exceeds prealloc_bufsz (assuming prealloc_bufsz plus the increment is | |
350 | * less than or equal to UINT_MAX). | |
351 | */ | |
d163679c | 352 | struct comedi_async { |
55d128bf IA |
353 | void *prealloc_buf; |
354 | unsigned int prealloc_bufsz; | |
355 | struct comedi_buf_map *buf_map; | |
356 | unsigned int max_bufsize; | |
62eeae93 | 357 | unsigned int buf_write_count; |
62eeae93 | 358 | unsigned int buf_write_alloc_count; |
62eeae93 | 359 | unsigned int buf_read_count; |
62eeae93 | 360 | unsigned int buf_read_alloc_count; |
55d128bf IA |
361 | unsigned int buf_write_ptr; |
362 | unsigned int buf_read_ptr; | |
363 | unsigned int cur_chan; | |
1dacbe5b | 364 | unsigned int scans_done; |
ed9eccbe | 365 | unsigned int scan_progress; |
ed9eccbe | 366 | unsigned int munge_chan; |
ed9eccbe | 367 | unsigned int munge_count; |
ed9eccbe | 368 | unsigned int munge_ptr; |
55d128bf | 369 | unsigned int events; |
ea6d0d4c | 370 | struct comedi_cmd cmd; |
ed9eccbe | 371 | wait_queue_head_t wait_head; |
ed9eccbe | 372 | unsigned int cb_mask; |
0cb4c151 MA |
373 | int (*inttrig)(struct comedi_device *dev, struct comedi_subdevice *s, |
374 | unsigned int x); | |
ed9eccbe DS |
375 | }; |
376 | ||
bb856b6c | 377 | /** |
251a16ab | 378 | * enum comedi_cb - &struct comedi_async callback "events" |
bb856b6c HS |
379 | * @COMEDI_CB_EOS: end-of-scan |
380 | * @COMEDI_CB_EOA: end-of-acquisition/output | |
381 | * @COMEDI_CB_BLOCK: data has arrived, wakes up read() / write() | |
382 | * @COMEDI_CB_EOBUF: DEPRECATED: end of buffer | |
383 | * @COMEDI_CB_ERROR: card error during acquisition | |
384 | * @COMEDI_CB_OVERFLOW: buffer overflow/underflow | |
781f933c HS |
385 | * @COMEDI_CB_ERROR_MASK: events that indicate an error has occurred |
386 | * @COMEDI_CB_CANCEL_MASK: events that will cancel an async command | |
bb856b6c | 387 | */ |
251a16ab IA |
388 | enum comedi_cb { |
389 | COMEDI_CB_EOS = BIT(0), | |
390 | COMEDI_CB_EOA = BIT(1), | |
391 | COMEDI_CB_BLOCK = BIT(2), | |
392 | COMEDI_CB_EOBUF = BIT(3), | |
393 | COMEDI_CB_ERROR = BIT(4), | |
394 | COMEDI_CB_OVERFLOW = BIT(5), | |
395 | /* masks */ | |
396 | COMEDI_CB_ERROR_MASK = (COMEDI_CB_ERROR | COMEDI_CB_OVERFLOW), | |
397 | COMEDI_CB_CANCEL_MASK = (COMEDI_CB_EOA | COMEDI_CB_ERROR_MASK) | |
398 | }; | |
781f933c | 399 | |
a3ed91f8 IA |
400 | /** |
401 | * struct comedi_driver - COMEDI driver registration | |
402 | * @driver_name: Name of driver. | |
403 | * @module: Owning module. | |
404 | * @attach: The optional "attach" handler for manually configured COMEDI | |
405 | * devices. | |
406 | * @detach: The "detach" handler for deconfiguring COMEDI devices. | |
407 | * @auto_attach: The optional "auto_attach" handler for automatically | |
408 | * configured COMEDI devices. | |
409 | * @num_names: Optional number of "board names" supported. | |
410 | * @board_name: Optional pointer to a pointer to a board name. The pointer | |
411 | * to a board name is embedded in an element of a driver-defined array | |
412 | * of static, read-only board type information. | |
413 | * @offset: Optional size of each element of the driver-defined array of | |
414 | * static, read-only board type information, i.e. the offset between each | |
415 | * pointer to a board name. | |
416 | * | |
417 | * This is used with comedi_driver_register() and comedi_driver_unregister() to | |
418 | * register and unregister a low-level COMEDI driver with the COMEDI core. | |
419 | * | |
420 | * If @num_names is non-zero, @board_name should be non-NULL, and @offset | |
421 | * should be at least sizeof(*board_name). These are used by the handler for | |
422 | * the %COMEDI_DEVCONFIG ioctl to match a hardware device and its driver by | |
423 | * board name. If @num_names is zero, the %COMEDI_DEVCONFIG ioctl matches a | |
424 | * hardware device and its driver by driver name. This is only useful if the | |
425 | * @attach handler is set. If @num_names is non-zero, the driver's @attach | |
426 | * handler will be called with the COMEDI device structure's board_ptr member | |
427 | * pointing to the matched pointer to a board name within the driver's private | |
428 | * array of static, read-only board type information. | |
3e0f9b2c IA |
429 | * |
430 | * The @detach handler has two roles. If a COMEDI device was successfully | |
431 | * configured by the @attach or @auto_attach handler, it is called when the | |
432 | * device is being deconfigured (by the %COMEDI_DEVCONFIG ioctl, or due to | |
433 | * unloading of the driver, or due to device removal). It is also called when | |
434 | * the @attach or @auto_attach handler returns an error. Therefore, the | |
435 | * @attach or @auto_attach handlers can defer clean-up on error until the | |
436 | * @detach handler is called. If the @attach or @auto_attach handlers free | |
437 | * any resources themselves, they must prevent the @detach handler from | |
438 | * freeing the same resources. The @detach handler must not assume that all | |
439 | * resources requested by the @attach or @auto_attach handler were | |
440 | * successfully allocated. | |
a3ed91f8 | 441 | */ |
139dfbdf | 442 | struct comedi_driver { |
a3ed91f8 IA |
443 | /* private: */ |
444 | struct comedi_driver *next; /* Next in list of COMEDI drivers. */ | |
445 | /* public: */ | |
ed9eccbe DS |
446 | const char *driver_name; |
447 | struct module *module; | |
0cb4c151 MA |
448 | int (*attach)(struct comedi_device *, struct comedi_devconfig *); |
449 | void (*detach)(struct comedi_device *); | |
450 | int (*auto_attach)(struct comedi_device *, unsigned long); | |
ed9eccbe DS |
451 | unsigned int num_names; |
452 | const char *const *board_name; | |
ed9eccbe DS |
453 | int offset; |
454 | }; | |
455 | ||
9ac5b44f IA |
456 | /** |
457 | * struct comedi_device - Working data for a COMEDI device | |
458 | * @use_count: Number of open file objects. | |
459 | * @driver: Low-level COMEDI driver attached to this COMEDI device. | |
460 | * @pacer: Optional pointer to a dynamically allocated acquisition pacer | |
461 | * control. It is freed automatically after the COMEDI device is | |
462 | * detached from the low-level driver. | |
463 | * @private: Optional pointer to private data allocated by the low-level | |
464 | * driver. It is freed automatically after the COMEDI device is | |
465 | * detached from the low-level driver. | |
466 | * @class_dev: Sysfs comediX device. | |
467 | * @minor: Minor device number of COMEDI char device (0-47). | |
468 | * @detach_count: Counter incremented every time the COMEDI device is detached. | |
469 | * Used for checking a previous attachment is still valid. | |
470 | * @hw_dev: Optional pointer to the low-level hardware &struct device. It is | |
471 | * required for automatically configured COMEDI devices and optional for | |
472 | * COMEDI devices configured by the %COMEDI_DEVCONFIG ioctl, although | |
473 | * the bus-specific COMEDI functions only work if it is set correctly. | |
474 | * It is also passed to dma_alloc_coherent() for COMEDI subdevices that | |
475 | * have their 'async_dma_dir' member set to something other than | |
476 | * %DMA_NONE. | |
477 | * @board_name: Pointer to a COMEDI board name or a COMEDI driver name. When | |
478 | * the low-level driver's "attach" handler is called by the handler for | |
479 | * the %COMEDI_DEVCONFIG ioctl, it either points to a matched board name | |
480 | * string if the 'num_names' member of the &struct comedi_driver is | |
481 | * non-zero, otherwise it points to the low-level driver name string. | |
482 | * When the low-lever driver's "auto_attach" handler is called for an | |
483 | * automatically configured COMEDI device, it points to the low-level | |
484 | * driver name string. The low-level driver is free to change it in its | |
485 | * "attach" or "auto_attach" handler if it wishes. | |
486 | * @board_ptr: Optional pointer to private, read-only board type information in | |
487 | * the low-level driver. If the 'num_names' member of the &struct | |
488 | * comedi_driver is non-zero, the handler for the %COMEDI_DEVCONFIG ioctl | |
489 | * will point it to a pointer to a matched board name string within the | |
490 | * driver's private array of static, read-only board type information when | |
491 | * calling the driver's "attach" handler. The low-level driver is free to | |
492 | * change it. | |
493 | * @attached: Flag indicating that the COMEDI device is attached to a low-level | |
494 | * driver. | |
495 | * @ioenabled: Flag used to indicate that a PCI device has been enabled and | |
496 | * its regions requested. | |
497 | * @spinlock: Generic spin-lock for use by the low-level driver. | |
498 | * @mutex: Generic mutex for use by the COMEDI core module. | |
499 | * @attach_lock: &struct rw_semaphore used to guard against the COMEDI device | |
500 | * being detached while an operation is in progress. The down_write() | |
501 | * operation is only allowed while @mutex is held and is used when | |
502 | * changing @attached and @detach_count and calling the low-level driver's | |
503 | * "detach" handler. The down_read() operation is generally used without | |
504 | * holding @mutex. | |
505 | * @refcount: &struct kref reference counter for freeing COMEDI device. | |
506 | * @n_subdevices: Number of COMEDI subdevices allocated by the low-level | |
507 | * driver for this device. | |
508 | * @subdevices: Dynamically allocated array of COMEDI subdevices. | |
509 | * @mmio: Optional pointer to a remapped MMIO region set by the low-level | |
510 | * driver. | |
511 | * @iobase: Optional base of an I/O port region requested by the low-level | |
512 | * driver. | |
513 | * @iolen: Length of I/O port region requested at @iobase. | |
514 | * @irq: Optional IRQ number requested by the low-level driver. | |
515 | * @read_subdev: Optional pointer to a default COMEDI subdevice operated on by | |
516 | * the read() file operation. Set by the low-level driver. | |
517 | * @write_subdev: Optional pointer to a default COMEDI subdevice operated on by | |
518 | * the write() file operation. Set by the low-level driver. | |
519 | * @async_queue: Storage for fasync_helper(). | |
520 | * @open: Optional pointer to a function set by the low-level driver to be | |
521 | * called when @use_count changes from 0 to 1. | |
522 | * @close: Optional pointer to a function set by the low-level driver to be | |
523 | * called when @use_count changed from 1 to 0. | |
524 | * | |
525 | * This is the main control data structure for a COMEDI device (as far as the | |
526 | * COMEDI core is concerned). There are two groups of COMEDI devices - | |
527 | * "legacy" devices that are configured by the handler for the | |
528 | * %COMEDI_DEVCONFIG ioctl, and automatically configured devices resulting | |
529 | * from a call to comedi_auto_config() as a result of a bus driver probe in | |
530 | * a low-level COMEDI driver. The "legacy" COMEDI devices are allocated | |
531 | * during module initialization if the "comedi_num_legacy_minors" module | |
532 | * parameter is non-zero and use minor device numbers from 0 to | |
533 | * comedi_num_legacy_minors minus one. The automatically configured COMEDI | |
534 | * devices are allocated on demand and use minor device numbers from | |
535 | * comedi_num_legacy_minors to 47. | |
536 | */ | |
71b5f4f1 | 537 | struct comedi_device { |
ed9eccbe | 538 | int use_count; |
139dfbdf | 539 | struct comedi_driver *driver; |
43db062a | 540 | struct comedi_8254 *pacer; |
ed9eccbe DS |
541 | void *private; |
542 | ||
0bfbbe8f | 543 | struct device *class_dev; |
ed9eccbe | 544 | int minor; |
ef77c0b2 | 545 | unsigned int detach_count; |
ed9eccbe DS |
546 | struct device *hw_dev; |
547 | ||
548 | const char *board_name; | |
549 | const void *board_ptr; | |
a7401cdd | 550 | bool attached:1; |
00ca6884 | 551 | bool ioenabled:1; |
214e3842 IA |
552 | spinlock_t spinlock; /* generic spin-lock for low-level driver */ |
553 | struct mutex mutex; /* generic mutex for COMEDI core */ | |
2f3fdcd7 | 554 | struct rw_semaphore attach_lock; |
5b13ed94 | 555 | struct kref refcount; |
ed9eccbe DS |
556 | |
557 | int n_subdevices; | |
34c43922 | 558 | struct comedi_subdevice *subdevices; |
ed9eccbe DS |
559 | |
560 | /* dumb */ | |
d7e6dc13 | 561 | void __iomem *mmio; |
ed9eccbe | 562 | unsigned long iobase; |
316f97f1 | 563 | unsigned long iolen; |
ed9eccbe DS |
564 | unsigned int irq; |
565 | ||
34c43922 BP |
566 | struct comedi_subdevice *read_subdev; |
567 | struct comedi_subdevice *write_subdev; | |
ed9eccbe DS |
568 | |
569 | struct fasync_struct *async_queue; | |
570 | ||
0cb4c151 MA |
571 | int (*open)(struct comedi_device *dev); |
572 | void (*close)(struct comedi_device *dev); | |
ed9eccbe DS |
573 | }; |
574 | ||
ed9eccbe DS |
575 | /* |
576 | * function prototypes | |
577 | */ | |
578 | ||
34c43922 | 579 | void comedi_event(struct comedi_device *dev, struct comedi_subdevice *s); |
ed9eccbe | 580 | |
ae6b0867 | 581 | struct comedi_device *comedi_dev_get_from_minor(unsigned int minor); |
b449c1ca | 582 | int comedi_dev_put(struct comedi_device *dev); |
85104e9b | 583 | |
e0dac318 | 584 | bool comedi_is_subdevice_running(struct comedi_subdevice *s); |
0480bcb9 HS |
585 | |
586 | void *comedi_alloc_spriv(struct comedi_subdevice *s, size_t size); | |
8fc369ae | 587 | void comedi_set_spriv_auto_free(struct comedi_subdevice *s); |
e0dac318 | 588 | |
5e220112 MR |
589 | int comedi_check_chanlist(struct comedi_subdevice *s, |
590 | int n, | |
591 | unsigned int *chanlist); | |
ed9eccbe DS |
592 | |
593 | /* range stuff */ | |
594 | ||
eb36cc28 IA |
595 | #define RANGE(a, b) {(a) * 1e6, (b) * 1e6, 0} |
596 | #define RANGE_ext(a, b) {(a) * 1e6, (b) * 1e6, RF_EXTERNAL} | |
597 | #define RANGE_mA(a, b) {(a) * 1e6, (b) * 1e6, UNIT_mA} | |
598 | #define RANGE_unitless(a, b) {(a) * 1e6, (b) * 1e6, 0} | |
599 | #define BIP_RANGE(a) {-(a) * 1e6, (a) * 1e6, 0} | |
600 | #define UNI_RANGE(a) {0, (a) * 1e6, 0} | |
ed9eccbe | 601 | |
9ced1de6 BP |
602 | extern const struct comedi_lrange range_bipolar10; |
603 | extern const struct comedi_lrange range_bipolar5; | |
604 | extern const struct comedi_lrange range_bipolar2_5; | |
605 | extern const struct comedi_lrange range_unipolar10; | |
606 | extern const struct comedi_lrange range_unipolar5; | |
5f8eb72c | 607 | extern const struct comedi_lrange range_unipolar2_5; |
2c71c4ff HS |
608 | extern const struct comedi_lrange range_0_20mA; |
609 | extern const struct comedi_lrange range_4_20mA; | |
610 | extern const struct comedi_lrange range_0_32mA; | |
9ced1de6 | 611 | extern const struct comedi_lrange range_unknown; |
ed9eccbe DS |
612 | |
613 | #define range_digital range_unipolar5 | |
614 | ||
615 | #if __GNUC__ >= 3 | |
616 | #define GCC_ZERO_LENGTH_ARRAY | |
617 | #else | |
618 | #define GCC_ZERO_LENGTH_ARRAY 0 | |
619 | #endif | |
620 | ||
5459bc12 IA |
621 | /** |
622 | * struct comedi_lrange - Describes a COMEDI range table | |
623 | * @length: Number of entries in the range table. | |
624 | * @range: Array of &struct comedi_krange, one for each range. | |
625 | * | |
626 | * Each element of @range[] describes the minimum and maximum physical range | |
627 | * range and the type of units. Typically, the type of unit is %UNIT_volt | |
628 | * (i.e. volts) and the minimum and maximum are in millionths of a volt. | |
629 | * There may also be a flag that indicates the minimum and maximum are merely | |
630 | * scale factors for an unknown, external reference. | |
631 | */ | |
9ced1de6 | 632 | struct comedi_lrange { |
ed9eccbe | 633 | int length; |
1f6325d6 | 634 | struct comedi_krange range[GCC_ZERO_LENGTH_ARRAY]; |
ed9eccbe DS |
635 | }; |
636 | ||
42e55839 IA |
637 | /** |
638 | * comedi_range_is_bipolar() - Test if subdevice range is bipolar | |
639 | * @s: COMEDI subdevice. | |
640 | * @range: Index of range within a range table. | |
641 | * | |
642 | * Tests whether a range is bipolar by checking whether its minimum value | |
643 | * is negative. | |
644 | * | |
645 | * Assumes @range is valid. Does not work for subdevices using a | |
646 | * channel-specific range table list. | |
647 | * | |
648 | * Return: | |
649 | * %true if the range is bipolar. | |
650 | * %false if the range is unipolar. | |
651 | */ | |
e3693fd3 HS |
652 | static inline bool comedi_range_is_bipolar(struct comedi_subdevice *s, |
653 | unsigned int range) | |
654 | { | |
655 | return s->range_table->range[range].min < 0; | |
656 | } | |
657 | ||
42e55839 IA |
658 | /** |
659 | * comedi_range_is_unipolar() - Test if subdevice range is unipolar | |
660 | * @s: COMEDI subdevice. | |
661 | * @range: Index of range within a range table. | |
662 | * | |
663 | * Tests whether a range is unipolar by checking whether its minimum value | |
664 | * is at least 0. | |
665 | * | |
666 | * Assumes @range is valid. Does not work for subdevices using a | |
667 | * channel-specific range table list. | |
668 | * | |
669 | * Return: | |
670 | * %true if the range is unipolar. | |
671 | * %false if the range is bipolar. | |
672 | */ | |
e3693fd3 HS |
673 | static inline bool comedi_range_is_unipolar(struct comedi_subdevice *s, |
674 | unsigned int range) | |
675 | { | |
676 | return s->range_table->range[range].min >= 0; | |
677 | } | |
678 | ||
42e55839 IA |
679 | /** |
680 | * comedi_range_is_external() - Test if subdevice range is external | |
681 | * @s: COMEDI subdevice. | |
682 | * @range: Index of range within a range table. | |
683 | * | |
684 | * Tests whether a range is externally reference by checking whether its | |
685 | * %RF_EXTERNAL flag is set. | |
686 | * | |
687 | * Assumes @range is valid. Does not work for subdevices using a | |
688 | * channel-specific range table list. | |
689 | * | |
690 | * Return: | |
691 | * %true if the range is external. | |
692 | * %false if the range is internal. | |
693 | */ | |
a8b677cb HS |
694 | static inline bool comedi_range_is_external(struct comedi_subdevice *s, |
695 | unsigned int range) | |
696 | { | |
697 | return !!(s->range_table->range[range].flags & RF_EXTERNAL); | |
698 | } | |
699 | ||
42e55839 IA |
700 | /** |
701 | * comedi_chan_range_is_bipolar() - Test if channel-specific range is bipolar | |
702 | * @s: COMEDI subdevice. | |
703 | * @chan: The channel number. | |
704 | * @range: Index of range within a range table. | |
705 | * | |
706 | * Tests whether a range is bipolar by checking whether its minimum value | |
707 | * is negative. | |
708 | * | |
709 | * Assumes @chan and @range are valid. Only works for subdevices with a | |
710 | * channel-specific range table list. | |
711 | * | |
712 | * Return: | |
713 | * %true if the range is bipolar. | |
714 | * %false if the range is unipolar. | |
715 | */ | |
49162116 HS |
716 | static inline bool comedi_chan_range_is_bipolar(struct comedi_subdevice *s, |
717 | unsigned int chan, | |
718 | unsigned int range) | |
719 | { | |
720 | return s->range_table_list[chan]->range[range].min < 0; | |
721 | } | |
722 | ||
42e55839 IA |
723 | /** |
724 | * comedi_chan_range_is_unipolar() - Test if channel-specific range is unipolar | |
725 | * @s: COMEDI subdevice. | |
726 | * @chan: The channel number. | |
727 | * @range: Index of range within a range table. | |
728 | * | |
729 | * Tests whether a range is unipolar by checking whether its minimum value | |
730 | * is at least 0. | |
731 | * | |
732 | * Assumes @chan and @range are valid. Only works for subdevices with a | |
733 | * channel-specific range table list. | |
734 | * | |
735 | * Return: | |
736 | * %true if the range is unipolar. | |
737 | * %false if the range is bipolar. | |
738 | */ | |
49162116 HS |
739 | static inline bool comedi_chan_range_is_unipolar(struct comedi_subdevice *s, |
740 | unsigned int chan, | |
741 | unsigned int range) | |
742 | { | |
743 | return s->range_table_list[chan]->range[range].min >= 0; | |
744 | } | |
745 | ||
42e55839 IA |
746 | /** |
747 | * comedi_chan_range_is_external() - Test if channel-specific range is external | |
748 | * @s: COMEDI subdevice. | |
749 | * @chan: The channel number. | |
750 | * @range: Index of range within a range table. | |
751 | * | |
752 | * Tests whether a range is externally reference by checking whether its | |
753 | * %RF_EXTERNAL flag is set. | |
754 | * | |
755 | * Assumes @chan and @range are valid. Only works for subdevices with a | |
756 | * channel-specific range table list. | |
757 | * | |
758 | * Return: | |
759 | * %true if the range is bipolar. | |
760 | * %false if the range is unipolar. | |
761 | */ | |
a8b677cb HS |
762 | static inline bool comedi_chan_range_is_external(struct comedi_subdevice *s, |
763 | unsigned int chan, | |
764 | unsigned int range) | |
765 | { | |
766 | return !!(s->range_table_list[chan]->range[range].flags & RF_EXTERNAL); | |
767 | } | |
768 | ||
42e55839 IA |
769 | /** |
770 | * comedi_offset_munge() - Convert between offset binary and 2's complement | |
771 | * @s: COMEDI subdevice. | |
772 | * @val: Value to be converted. | |
773 | * | |
774 | * Toggles the highest bit of a sample value to toggle between offset binary | |
775 | * and 2's complement. Assumes that @s->maxdata is a power of 2 minus 1. | |
776 | * | |
777 | * Return: The converted value. | |
778 | */ | |
f0b215d6 HS |
779 | static inline unsigned int comedi_offset_munge(struct comedi_subdevice *s, |
780 | unsigned int val) | |
781 | { | |
782 | return val ^ s->maxdata ^ (s->maxdata >> 1); | |
783 | } | |
ed9eccbe | 784 | |
bf33eb4b | 785 | /** |
8f78264c IA |
786 | * comedi_bytes_per_sample() - Determine subdevice sample size |
787 | * @s: COMEDI subdevice. | |
bf33eb4b IA |
788 | * |
789 | * The sample size will be 4 (sizeof int) or 2 (sizeof short) depending on | |
8f78264c | 790 | * whether the %SDF_LSAMPL subdevice flag is set or not. |
bf33eb4b | 791 | * |
8f78264c | 792 | * Return: The subdevice sample size. |
bf33eb4b IA |
793 | */ |
794 | static inline unsigned int comedi_bytes_per_sample(struct comedi_subdevice *s) | |
ed9eccbe | 795 | { |
bf33eb4b IA |
796 | return s->subdev_flags & SDF_LSAMPL ? sizeof(int) : sizeof(short); |
797 | } | |
cb3aadae | 798 | |
bf33eb4b | 799 | /** |
8f78264c IA |
800 | * comedi_sample_shift() - Determine log2 of subdevice sample size |
801 | * @s: COMEDI subdevice. | |
bf33eb4b IA |
802 | * |
803 | * The sample size will be 4 (sizeof int) or 2 (sizeof short) depending on | |
8f78264c | 804 | * whether the %SDF_LSAMPL subdevice flag is set or not. The log2 of the |
bf33eb4b IA |
805 | * sample size will be 2 or 1 and can be used as the right operand of a |
806 | * bit-shift operator to multiply or divide something by the sample size. | |
807 | * | |
8f78264c | 808 | * Return: log2 of the subdevice sample size. |
bf33eb4b IA |
809 | */ |
810 | static inline unsigned int comedi_sample_shift(struct comedi_subdevice *s) | |
811 | { | |
812 | return s->subdev_flags & SDF_LSAMPL ? 2 : 1; | |
813 | } | |
814 | ||
815 | /** | |
8f78264c IA |
816 | * comedi_bytes_to_samples() - Convert a number of bytes to a number of samples |
817 | * @s: COMEDI subdevice. | |
818 | * @nbytes: Number of bytes | |
bf33eb4b | 819 | * |
8f78264c | 820 | * Return: The number of bytes divided by the subdevice sample size. |
bf33eb4b IA |
821 | */ |
822 | static inline unsigned int comedi_bytes_to_samples(struct comedi_subdevice *s, | |
823 | unsigned int nbytes) | |
824 | { | |
825 | return nbytes >> comedi_sample_shift(s); | |
826 | } | |
827 | ||
828 | /** | |
8f78264c IA |
829 | * comedi_samples_to_bytes() - Convert a number of samples to a number of bytes |
830 | * @s: COMEDI subdevice. | |
831 | * @nsamples: Number of samples. | |
bf33eb4b | 832 | * |
8f78264c IA |
833 | * Return: The number of samples multiplied by the subdevice sample size. |
834 | * (Does not check for arithmetic overflow.) | |
bf33eb4b IA |
835 | */ |
836 | static inline unsigned int comedi_samples_to_bytes(struct comedi_subdevice *s, | |
837 | unsigned int nsamples) | |
838 | { | |
839 | return nsamples << comedi_sample_shift(s); | |
ed9eccbe DS |
840 | } |
841 | ||
5e1a6192 | 842 | /** |
8f78264c IA |
843 | * comedi_check_trigger_src() - Trivially validate a comedi_cmd trigger source |
844 | * @src: Pointer to the trigger source to validate. | |
845 | * @flags: Bitmask of valid %TRIG_* for the trigger. | |
5e1a6192 IA |
846 | * |
847 | * This is used in "step 1" of the do_cmdtest functions of comedi drivers | |
8f78264c | 848 | * to validate the comedi_cmd triggers. The mask of the @src against the |
5e1a6192 | 849 | * @flags allows the userspace comedilib to pass all the comedi_cmd |
8f78264c IA |
850 | * triggers as %TRIG_ANY and get back a bitmask of the valid trigger sources. |
851 | * | |
852 | * Return: | |
853 | * 0 if trigger sources in *@src are all supported. | |
854 | * -EINVAL if any trigger source in *@src is unsupported. | |
5e1a6192 IA |
855 | */ |
856 | static inline int comedi_check_trigger_src(unsigned int *src, | |
857 | unsigned int flags) | |
858 | { | |
859 | unsigned int orig_src = *src; | |
860 | ||
861 | *src = orig_src & flags; | |
862 | if (*src == TRIG_INVALID || *src != orig_src) | |
863 | return -EINVAL; | |
864 | return 0; | |
865 | } | |
866 | ||
867 | /** | |
8f78264c IA |
868 | * comedi_check_trigger_is_unique() - Make sure a trigger source is unique |
869 | * @src: The trigger source to check. | |
870 | * | |
871 | * Return: | |
872 | * 0 if no more than one trigger source is set. | |
873 | * -EINVAL if more than one trigger source is set. | |
5e1a6192 IA |
874 | */ |
875 | static inline int comedi_check_trigger_is_unique(unsigned int src) | |
876 | { | |
877 | /* this test is true if more than one _src bit is set */ | |
878 | if ((src & (src - 1)) != 0) | |
879 | return -EINVAL; | |
880 | return 0; | |
881 | } | |
882 | ||
883 | /** | |
8f78264c IA |
884 | * comedi_check_trigger_arg_is() - Trivially validate a trigger argument |
885 | * @arg: Pointer to the trigger arg to validate. | |
886 | * @val: The value the argument should be. | |
887 | * | |
888 | * Forces *@arg to be @val. | |
889 | * | |
890 | * Return: | |
891 | * 0 if *@arg was already @val. | |
892 | * -EINVAL if *@arg differed from @val. | |
5e1a6192 IA |
893 | */ |
894 | static inline int comedi_check_trigger_arg_is(unsigned int *arg, | |
895 | unsigned int val) | |
896 | { | |
897 | if (*arg != val) { | |
898 | *arg = val; | |
899 | return -EINVAL; | |
900 | } | |
901 | return 0; | |
902 | } | |
903 | ||
904 | /** | |
8f78264c IA |
905 | * comedi_check_trigger_arg_min() - Trivially validate a trigger argument min |
906 | * @arg: Pointer to the trigger arg to validate. | |
907 | * @val: The minimum value the argument should be. | |
908 | * | |
909 | * Forces *@arg to be at least @val, setting it to @val if necessary. | |
910 | * | |
911 | * Return: | |
912 | * 0 if *@arg was already at least @val. | |
913 | * -EINVAL if *@arg was less than @val. | |
5e1a6192 IA |
914 | */ |
915 | static inline int comedi_check_trigger_arg_min(unsigned int *arg, | |
916 | unsigned int val) | |
917 | { | |
918 | if (*arg < val) { | |
919 | *arg = val; | |
920 | return -EINVAL; | |
921 | } | |
922 | return 0; | |
923 | } | |
924 | ||
925 | /** | |
8f78264c IA |
926 | * comedi_check_trigger_arg_max() - Trivially validate a trigger argument max |
927 | * @arg: Pointer to the trigger arg to validate. | |
928 | * @val: The maximum value the argument should be. | |
929 | * | |
930 | * Forces *@arg to be no more than @val, setting it to @val if necessary. | |
931 | * | |
932 | * Return: | |
933 | * 0 if*@arg was already no more than @val. | |
934 | * -EINVAL if *@arg was greater than @val. | |
5e1a6192 IA |
935 | */ |
936 | static inline int comedi_check_trigger_arg_max(unsigned int *arg, | |
937 | unsigned int val) | |
938 | { | |
939 | if (*arg > val) { | |
940 | *arg = val; | |
941 | return -EINVAL; | |
942 | } | |
943 | return 0; | |
944 | } | |
945 | ||
bc3954b8 IA |
946 | /* |
947 | * Must set dev->hw_dev if you wish to dma directly into comedi's buffer. | |
948 | * Also useful for retrieving a previously configured hardware device of | |
949 | * known bus type. Set automatically for auto-configured devices. | |
950 | * Automatically set to NULL when detaching hardware device. | |
951 | */ | |
da717511 | 952 | int comedi_set_hw_dev(struct comedi_device *dev, struct device *hw_dev); |
ed9eccbe | 953 | |
42e55839 IA |
954 | /** |
955 | * comedi_buf_n_bytes_ready - Determine amount of unread data in buffer | |
956 | * @s: COMEDI subdevice. | |
957 | * | |
958 | * Determines the number of bytes of unread data in the asynchronous | |
959 | * acquisition data buffer for a subdevice. The data in question might not | |
960 | * have been fully "munged" yet. | |
961 | * | |
962 | * Returns: The amount of unread data in bytes. | |
963 | */ | |
f4f3f7cf HS |
964 | static inline unsigned int comedi_buf_n_bytes_ready(struct comedi_subdevice *s) |
965 | { | |
966 | return s->async->buf_write_count - s->async->buf_read_count; | |
967 | } | |
968 | ||
24e894bb | 969 | unsigned int comedi_buf_write_alloc(struct comedi_subdevice *s, unsigned int n); |
940dd35d | 970 | unsigned int comedi_buf_write_free(struct comedi_subdevice *s, unsigned int n); |
8ae560a1 | 971 | |
e9edef3a | 972 | unsigned int comedi_buf_read_n_available(struct comedi_subdevice *s); |
d13be55a | 973 | unsigned int comedi_buf_read_alloc(struct comedi_subdevice *s, unsigned int n); |
f1df8662 | 974 | unsigned int comedi_buf_read_free(struct comedi_subdevice *s, unsigned int n); |
8ae560a1 | 975 | |
5438da85 HS |
976 | unsigned int comedi_buf_write_samples(struct comedi_subdevice *s, |
977 | const void *data, unsigned int nsamples); | |
4455d7c3 HS |
978 | unsigned int comedi_buf_read_samples(struct comedi_subdevice *s, |
979 | void *data, unsigned int nsamples); | |
0a85b6f0 | 980 | |
1ae6b20b HS |
981 | /* drivers.c - general comedi driver functions */ |
982 | ||
91506408 HS |
983 | #define COMEDI_TIMEOUT_MS 1000 |
984 | ||
985 | int comedi_timeout(struct comedi_device *, struct comedi_subdevice *, | |
986 | struct comedi_insn *, | |
987 | int (*cb)(struct comedi_device *, struct comedi_subdevice *, | |
988 | struct comedi_insn *, unsigned long context), | |
989 | unsigned long context); | |
990 | ||
5a780359 IA |
991 | unsigned int comedi_handle_events(struct comedi_device *dev, |
992 | struct comedi_subdevice *s); | |
993 | ||
e523c6c8 HS |
994 | int comedi_dio_insn_config(struct comedi_device *, struct comedi_subdevice *, |
995 | struct comedi_insn *, unsigned int *data, | |
996 | unsigned int mask); | |
05e60b13 HS |
997 | unsigned int comedi_dio_update_state(struct comedi_subdevice *, |
998 | unsigned int *data); | |
f146fe63 | 999 | unsigned int comedi_bytes_per_scan(struct comedi_subdevice *s); |
2ee37750 HS |
1000 | unsigned int comedi_nscans_left(struct comedi_subdevice *s, |
1001 | unsigned int nscans); | |
f615915e HS |
1002 | unsigned int comedi_nsamples_left(struct comedi_subdevice *s, |
1003 | unsigned int nsamples); | |
2b4e1f63 IA |
1004 | void comedi_inc_scan_progress(struct comedi_subdevice *s, |
1005 | unsigned int num_bytes); | |
e523c6c8 | 1006 | |
54db996e | 1007 | void *comedi_alloc_devpriv(struct comedi_device *, size_t); |
1ae6b20b | 1008 | int comedi_alloc_subdevices(struct comedi_device *, int); |
d2762066 HS |
1009 | int comedi_alloc_subdev_readback(struct comedi_subdevice *); |
1010 | ||
1011 | int comedi_readback_insn_read(struct comedi_device *, struct comedi_subdevice *, | |
1012 | struct comedi_insn *, unsigned int *data); | |
1ae6b20b | 1013 | |
9ff8b151 HS |
1014 | int comedi_load_firmware(struct comedi_device *, struct device *, |
1015 | const char *name, | |
1016 | int (*cb)(struct comedi_device *, | |
d569541e HS |
1017 | const u8 *data, size_t size, |
1018 | unsigned long context), | |
1019 | unsigned long context); | |
9ff8b151 | 1020 | |
ca8b2964 HS |
1021 | int __comedi_request_region(struct comedi_device *, |
1022 | unsigned long start, unsigned long len); | |
f375ac5f HS |
1023 | int comedi_request_region(struct comedi_device *, |
1024 | unsigned long start, unsigned long len); | |
316f97f1 | 1025 | void comedi_legacy_detach(struct comedi_device *); |
f375ac5f | 1026 | |
1ae6b20b HS |
1027 | int comedi_auto_config(struct device *, struct comedi_driver *, |
1028 | unsigned long context); | |
1029 | void comedi_auto_unconfig(struct device *); | |
1030 | ||
1031 | int comedi_driver_register(struct comedi_driver *); | |
99c0e269 | 1032 | void comedi_driver_unregister(struct comedi_driver *); |
1ae6b20b HS |
1033 | |
1034 | /** | |
1035 | * module_comedi_driver() - Helper macro for registering a comedi driver | |
1036 | * @__comedi_driver: comedi_driver struct | |
1037 | * | |
1038 | * Helper macro for comedi drivers which do not do anything special in module | |
1039 | * init/exit. This eliminates a lot of boilerplate. Each module may only use | |
1040 | * this macro once, and calling it replaces module_init() and module_exit(). | |
1041 | */ | |
1042 | #define module_comedi_driver(__comedi_driver) \ | |
1043 | module_driver(__comedi_driver, comedi_driver_register, \ | |
1044 | comedi_driver_unregister) | |
581a7dde | 1045 | |
ed9eccbe | 1046 | #endif /* _COMEDIDEV_H */ |