2 include/linux/comedidev.h
3 header file for kernel-only structures, variables, and constants
5 COMEDI - Linux Control and Measurement Device Interface
6 Copyright (C) 1997-2000 David A. Schleef <ds@schleef.org>
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.
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.
22 #include <linux/dma-mapping.h>
23 #include <linux/mutex.h>
24 #include <linux/spinlock_types.h>
25 #include <linux/rwsem.h>
26 #include <linux/kref.h>
30 #define COMEDI_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
31 #define COMEDI_VERSION_CODE COMEDI_VERSION(COMEDI_MAJORVERSION, \
32 COMEDI_MINORVERSION, COMEDI_MICROVERSION)
33 #define COMEDI_RELEASE VERSION
35 #define COMEDI_NUM_BOARD_MINORS 0x30
37 struct comedi_subdevice {
38 struct comedi_device *device;
43 int len_chanlist; /* maximum length of channel/gain list */
47 struct comedi_async *async;
56 unsigned int maxdata; /* if maxdata==0, use list */
57 const unsigned int *maxdata_list; /* list is channel specific */
59 const struct comedi_lrange *range_table;
60 const struct comedi_lrange *const *range_table_list;
62 unsigned int *chanlist; /* driver-owned chanlist (not used) */
64 int (*insn_read)(struct comedi_device *, struct comedi_subdevice *,
65 struct comedi_insn *, unsigned int *);
66 int (*insn_write)(struct comedi_device *, struct comedi_subdevice *,
67 struct comedi_insn *, unsigned int *);
68 int (*insn_bits)(struct comedi_device *, struct comedi_subdevice *,
69 struct comedi_insn *, unsigned int *);
70 int (*insn_config)(struct comedi_device *, struct comedi_subdevice *,
71 struct comedi_insn *, unsigned int *);
73 int (*do_cmd)(struct comedi_device *, struct comedi_subdevice *);
74 int (*do_cmdtest)(struct comedi_device *, struct comedi_subdevice *,
76 int (*poll)(struct comedi_device *, struct comedi_subdevice *);
77 int (*cancel)(struct comedi_device *, struct comedi_subdevice *);
78 /* int (*do_lock)(struct comedi_device *, struct comedi_subdevice *); */
79 /* int (*do_unlock)(struct comedi_device *, \
80 struct comedi_subdevice *); */
82 /* called when the buffer changes */
83 int (*buf_change)(struct comedi_device *dev,
84 struct comedi_subdevice *s, unsigned long new_size);
86 void (*munge)(struct comedi_device *dev, struct comedi_subdevice *s,
87 void *data, unsigned int num_bytes,
88 unsigned int start_chan_index);
89 enum dma_data_direction async_dma_dir;
93 struct device *class_dev;
97 struct comedi_buf_page {
102 struct comedi_buf_map {
103 struct device *dma_hw_dev;
104 struct comedi_buf_page *page_list;
105 unsigned int n_pages;
106 enum dma_data_direction dma_dir;
107 struct kref refcount;
111 * struct comedi_async - control data for asynchronous comedi commands
112 * @prealloc_buf: preallocated buffer
113 * @prealloc_bufsz: buffer size (in bytes)
114 * @buf_map: map of buffer pages
115 * @max_bufsize: maximum buffer size (in bytes)
116 * @buf_write_count: "write completed" count (in bytes, modulo 2**32)
117 * @buf_write_alloc_count: "allocated for writing" count (in bytes,
119 * @buf_read_count: "read completed" count (in bytes, modulo 2**32)
120 * @buf_read_alloc_count: "allocated for reading" count (in bytes,
122 * @buf_write_ptr: buffer position for writer
123 * @buf_read_ptr: buffer position for reader
124 * @cur_chan: current position in chanlist for scan (for those
125 * drivers that use it)
126 * @scan_progress: amount received or sent for current scan (in bytes)
127 * @munge_chan: current position in chanlist for "munging"
128 * @munge_count: "munge" count (in bytes, modulo 2**32)
129 * @munge_ptr: buffer position for "munging"
130 * @events: bit-vector of events that have occurred
131 * @cmd: details of comedi command in progress
132 * @wait_head: task wait queue for file reader or writer
133 * @cb_mask: bit-vector of events that should wake waiting tasks
134 * @inttrig: software trigger function for command, or NULL
136 * Note about the ..._count and ..._ptr members:
138 * Think of the _Count values being integers of unlimited size, indexing
139 * into a buffer of infinite length (though only an advancing portion
140 * of the buffer of fixed length prealloc_bufsz is accessible at any time).
143 * Buf_Read_Count <= Buf_Read_Alloc_Count <= Munge_Count <=
144 * Buf_Write_Count <= Buf_Write_Alloc_Count <=
145 * (Buf_Read_Count + prealloc_bufsz)
147 * (Those aren't the actual members, apart from prealloc_bufsz.) When
148 * the buffer is reset, those _Count values start at 0 and only increase
149 * in value, maintaining the above inequalities until the next time the
150 * buffer is reset. The buffer is divided into the following regions by
153 * [0, Buf_Read_Count):
154 * old region no longer accessible
155 * [Buf_Read_Count, Buf_Read_Alloc_Count):
156 * filled and munged region allocated for reading but not yet read
157 * [Buf_Read_Alloc_Count, Munge_Count):
158 * filled and munged region not yet allocated for reading
159 * [Munge_Count, Buf_Write_Count):
160 * filled region not yet munged
161 * [Buf_Write_Count, Buf_Write_Alloc_Count):
162 * unfilled region allocated for writing but not yet written
163 * [Buf_Write_Alloc_Count, Buf_Read_Count + prealloc_bufsz):
164 * unfilled region not yet allocated for writing
165 * [Buf_Read_Count + prealloc_bufsz, infinity):
166 * unfilled region not yet accessible
168 * Data needs to be written into the buffer before it can be read out,
169 * and may need to be converted (or "munged") between the two
170 * operations. Extra unfilled buffer space may need to allocated for
171 * writing (advancing Buf_Write_Alloc_Count) before new data is written.
172 * After writing new data, the newly filled space needs to be released
173 * (advancing Buf_Write_Count). This also results in the new data being
174 * "munged" (advancing Munge_Count). Before data is read out of the
175 * buffer, extra space may need to be allocated for reading (advancing
176 * Buf_Read_Alloc_Count). After the data has been read out, the space
177 * needs to be released (advancing Buf_Read_Count).
179 * The actual members, buf_read_count, buf_read_alloc_count,
180 * munge_count, buf_write_count, and buf_write_alloc_count take the
181 * value of the corresponding capitalized _Count values modulo 2^32
182 * (UINT_MAX+1). Subtracting a "higher" _count value from a "lower"
183 * _count value gives the same answer as subtracting a "higher" _Count
184 * value from a lower _Count value because prealloc_bufsz < UINT_MAX+1.
185 * The modulo operation is done implicitly.
187 * The buf_read_ptr, munge_ptr, and buf_write_ptr members take the value
188 * of the corresponding capitalized _Count values modulo prealloc_bufsz.
189 * These correspond to byte indices in the physical buffer. The modulo
190 * operation is done by subtracting prealloc_bufsz when the value
191 * exceeds prealloc_bufsz (assuming prealloc_bufsz plus the increment is
192 * less than or equal to UINT_MAX).
194 struct comedi_async {
196 unsigned int prealloc_bufsz;
197 struct comedi_buf_map *buf_map;
198 unsigned int max_bufsize;
199 unsigned int buf_write_count;
200 unsigned int buf_write_alloc_count;
201 unsigned int buf_read_count;
202 unsigned int buf_read_alloc_count;
203 unsigned int buf_write_ptr;
204 unsigned int buf_read_ptr;
205 unsigned int cur_chan;
206 unsigned int scan_progress;
207 unsigned int munge_chan;
208 unsigned int munge_count;
209 unsigned int munge_ptr;
211 struct comedi_cmd cmd;
212 wait_queue_head_t wait_head;
213 unsigned int cb_mask;
214 int (*inttrig)(struct comedi_device *dev, struct comedi_subdevice *s,
218 struct comedi_driver {
219 struct comedi_driver *next;
221 const char *driver_name;
222 struct module *module;
223 int (*attach)(struct comedi_device *, struct comedi_devconfig *);
224 void (*detach)(struct comedi_device *);
225 int (*auto_attach)(struct comedi_device *, unsigned long);
227 /* number of elements in board_name and board_id arrays */
228 unsigned int num_names;
229 const char *const *board_name;
230 /* offset in bytes from one board name pointer to the next */
234 struct comedi_device {
236 struct comedi_driver *driver;
239 struct device *class_dev;
241 unsigned int detach_count;
242 /* hw_dev is passed to dma_alloc_coherent when allocating async buffers
243 * for subdevices that have async_dma_dir set to something other than
245 struct device *hw_dev;
247 const char *board_name;
248 const void *board_ptr;
253 struct rw_semaphore attach_lock;
254 struct kref refcount;
257 struct comedi_subdevice *subdevices;
260 unsigned long iobase;
264 struct comedi_subdevice *read_subdev;
265 struct comedi_subdevice *write_subdev;
267 struct fasync_struct *async_queue;
269 int (*open)(struct comedi_device *dev);
270 void (*close)(struct comedi_device *dev);
273 static inline const void *comedi_board(const struct comedi_device *dev)
275 return dev->board_ptr;
279 * function prototypes
282 void comedi_event(struct comedi_device *dev, struct comedi_subdevice *s);
283 void comedi_error(const struct comedi_device *dev, const char *s);
285 /* we can expand the number of bits used to encode devices/subdevices into
286 the minor number soon, after more distros support > 8 bit minor numbers
287 (like after Debian Etch gets released) */
288 enum comedi_minor_bits {
289 COMEDI_DEVICE_MINOR_MASK = 0xf,
290 COMEDI_SUBDEVICE_MINOR_MASK = 0xf0
292 static const unsigned COMEDI_SUBDEVICE_MINOR_SHIFT = 4;
293 static const unsigned COMEDI_SUBDEVICE_MINOR_OFFSET = 1;
295 struct comedi_device *comedi_dev_get_from_minor(unsigned minor);
296 int comedi_dev_put(struct comedi_device *dev);
298 void init_polling(void);
299 void cleanup_polling(void);
300 void start_polling(struct comedi_device *);
301 void stop_polling(struct comedi_device *);
303 /* subdevice runflags */
304 enum subdevice_runflags {
306 /* indicates an COMEDI_CB_ERROR event has occurred since the last
307 * command was started */
308 SRF_ERROR = 0x00000004,
309 SRF_RUNNING = 0x08000000,
310 SRF_FREE_SPRIV = 0x80000000, /* free s->private on detach */
313 bool comedi_is_subdevice_running(struct comedi_subdevice *s);
315 void *comedi_alloc_spriv(struct comedi_subdevice *s, size_t size);
317 int comedi_check_chanlist(struct comedi_subdevice *s,
319 unsigned int *chanlist);
323 #define RANGE(a, b) {(a)*1e6, (b)*1e6, 0}
324 #define RANGE_ext(a, b) {(a)*1e6, (b)*1e6, RF_EXTERNAL}
325 #define RANGE_mA(a, b) {(a)*1e6, (b)*1e6, UNIT_mA}
326 #define RANGE_unitless(a, b) {(a)*1e6, (b)*1e6, 0}
327 #define BIP_RANGE(a) {-(a)*1e6, (a)*1e6, 0}
328 #define UNI_RANGE(a) {0, (a)*1e6, 0}
330 extern const struct comedi_lrange range_bipolar10;
331 extern const struct comedi_lrange range_bipolar5;
332 extern const struct comedi_lrange range_bipolar2_5;
333 extern const struct comedi_lrange range_unipolar10;
334 extern const struct comedi_lrange range_unipolar5;
335 extern const struct comedi_lrange range_unipolar2_5;
336 extern const struct comedi_lrange range_0_20mA;
337 extern const struct comedi_lrange range_4_20mA;
338 extern const struct comedi_lrange range_0_32mA;
339 extern const struct comedi_lrange range_unknown;
341 #define range_digital range_unipolar5
344 #define GCC_ZERO_LENGTH_ARRAY
346 #define GCC_ZERO_LENGTH_ARRAY 0
349 struct comedi_lrange {
351 struct comedi_krange range[GCC_ZERO_LENGTH_ARRAY];
354 static inline bool comedi_range_is_bipolar(struct comedi_subdevice *s,
357 return s->range_table->range[range].min < 0;
360 static inline bool comedi_range_is_unipolar(struct comedi_subdevice *s,
363 return s->range_table->range[range].min >= 0;
366 static inline bool comedi_chan_range_is_bipolar(struct comedi_subdevice *s,
370 return s->range_table_list[chan]->range[range].min < 0;
373 static inline bool comedi_chan_range_is_unipolar(struct comedi_subdevice *s,
377 return s->range_table_list[chan]->range[range].min >= 0;
380 /* munge between offset binary and two's complement values */
381 static inline unsigned int comedi_offset_munge(struct comedi_subdevice *s,
384 return val ^ s->maxdata ^ (s->maxdata >> 1);
387 static inline unsigned int bytes_per_sample(const struct comedi_subdevice *subd)
389 if (subd->subdev_flags & SDF_LSAMPL)
390 return sizeof(unsigned int);
392 return sizeof(short);
396 * Must set dev->hw_dev if you wish to dma directly into comedi's buffer.
397 * Also useful for retrieving a previously configured hardware device of
398 * known bus type. Set automatically for auto-configured devices.
399 * Automatically set to NULL when detaching hardware device.
401 int comedi_set_hw_dev(struct comedi_device *dev, struct device *hw_dev);
403 static inline unsigned int comedi_buf_n_bytes_ready(struct comedi_subdevice *s)
405 return s->async->buf_write_count - s->async->buf_read_count;
408 unsigned int comedi_buf_write_alloc(struct comedi_subdevice *s, unsigned int n);
409 unsigned int comedi_buf_write_free(struct comedi_subdevice *s, unsigned int n);
411 unsigned int comedi_buf_read_n_available(struct comedi_subdevice *s);
412 unsigned int comedi_buf_read_alloc(struct comedi_subdevice *s, unsigned int n);
413 unsigned int comedi_buf_read_free(struct comedi_subdevice *s, unsigned int n);
415 int comedi_buf_put(struct comedi_subdevice *s, unsigned short x);
416 int comedi_buf_get(struct comedi_subdevice *s, unsigned short *x);
418 void comedi_buf_memcpy_to(struct comedi_subdevice *s, unsigned int offset,
419 const void *source, unsigned int num_bytes);
420 void comedi_buf_memcpy_from(struct comedi_subdevice *s, unsigned int offset,
421 void *destination, unsigned int num_bytes);
423 /* drivers.c - general comedi driver functions */
425 #define COMEDI_TIMEOUT_MS 1000
427 int comedi_timeout(struct comedi_device *, struct comedi_subdevice *,
428 struct comedi_insn *,
429 int (*cb)(struct comedi_device *, struct comedi_subdevice *,
430 struct comedi_insn *, unsigned long context),
431 unsigned long context);
433 int comedi_dio_insn_config(struct comedi_device *, struct comedi_subdevice *,
434 struct comedi_insn *, unsigned int *data,
436 unsigned int comedi_dio_update_state(struct comedi_subdevice *,
439 void *comedi_alloc_devpriv(struct comedi_device *, size_t);
440 int comedi_alloc_subdevices(struct comedi_device *, int);
442 int comedi_load_firmware(struct comedi_device *, struct device *,
444 int (*cb)(struct comedi_device *,
445 const u8 *data, size_t size,
446 unsigned long context),
447 unsigned long context);
449 int __comedi_request_region(struct comedi_device *,
450 unsigned long start, unsigned long len);
451 int comedi_request_region(struct comedi_device *,
452 unsigned long start, unsigned long len);
453 void comedi_legacy_detach(struct comedi_device *);
455 int comedi_auto_config(struct device *, struct comedi_driver *,
456 unsigned long context);
457 void comedi_auto_unconfig(struct device *);
459 int comedi_driver_register(struct comedi_driver *);
460 void comedi_driver_unregister(struct comedi_driver *);
463 * module_comedi_driver() - Helper macro for registering a comedi driver
464 * @__comedi_driver: comedi_driver struct
466 * Helper macro for comedi drivers which do not do anything special in module
467 * init/exit. This eliminates a lot of boilerplate. Each module may only use
468 * this macro once, and calling it replaces module_init() and module_exit().
470 #define module_comedi_driver(__comedi_driver) \
471 module_driver(__comedi_driver, comedi_driver_register, \
472 comedi_driver_unregister)
474 #ifdef CONFIG_COMEDI_PCI_DRIVERS
476 /* comedi_pci.c - comedi PCI driver specific functions */
479 * PCI Vendor IDs not in <linux/pci_ids.h>
481 #define PCI_VENDOR_ID_KOLTER 0x1001
482 #define PCI_VENDOR_ID_ICP 0x104c
483 #define PCI_VENDOR_ID_DT 0x1116
484 #define PCI_VENDOR_ID_IOTECH 0x1616
485 #define PCI_VENDOR_ID_CONTEC 0x1221
486 #define PCI_VENDOR_ID_RTD 0x1435
487 #define PCI_VENDOR_ID_HUMUSOFT 0x186c
492 struct pci_dev *comedi_to_pci_dev(struct comedi_device *);
494 int comedi_pci_enable(struct comedi_device *);
495 void comedi_pci_disable(struct comedi_device *);
497 int comedi_pci_auto_config(struct pci_dev *, struct comedi_driver *,
498 unsigned long context);
499 void comedi_pci_auto_unconfig(struct pci_dev *);
501 int comedi_pci_driver_register(struct comedi_driver *, struct pci_driver *);
502 void comedi_pci_driver_unregister(struct comedi_driver *, struct pci_driver *);
505 * module_comedi_pci_driver() - Helper macro for registering a comedi PCI driver
506 * @__comedi_driver: comedi_driver struct
507 * @__pci_driver: pci_driver struct
509 * Helper macro for comedi PCI drivers which do not do anything special
510 * in module init/exit. This eliminates a lot of boilerplate. Each
511 * module may only use this macro once, and calling it replaces
512 * module_init() and module_exit()
514 #define module_comedi_pci_driver(__comedi_driver, __pci_driver) \
515 module_driver(__comedi_driver, comedi_pci_driver_register, \
516 comedi_pci_driver_unregister, &(__pci_driver))
521 * Some of the comedi mixed ISA/PCI drivers call the PCI specific
522 * functions. Provide some dummy functions if CONFIG_COMEDI_PCI_DRIVERS
526 static inline struct pci_dev *comedi_to_pci_dev(struct comedi_device *dev)
531 static inline int comedi_pci_enable(struct comedi_device *dev)
536 static inline void comedi_pci_disable(struct comedi_device *dev)
540 #endif /* CONFIG_COMEDI_PCI_DRIVERS */
542 #ifdef CONFIG_COMEDI_PCMCIA_DRIVERS
544 /* comedi_pcmcia.c - comedi PCMCIA driver specific functions */
546 struct pcmcia_driver;
547 struct pcmcia_device;
549 struct pcmcia_device *comedi_to_pcmcia_dev(struct comedi_device *);
551 int comedi_pcmcia_enable(struct comedi_device *,
552 int (*conf_check)(struct pcmcia_device *, void *));
553 void comedi_pcmcia_disable(struct comedi_device *);
555 int comedi_pcmcia_auto_config(struct pcmcia_device *, struct comedi_driver *);
556 void comedi_pcmcia_auto_unconfig(struct pcmcia_device *);
558 int comedi_pcmcia_driver_register(struct comedi_driver *,
559 struct pcmcia_driver *);
560 void comedi_pcmcia_driver_unregister(struct comedi_driver *,
561 struct pcmcia_driver *);
564 * module_comedi_pcmcia_driver() - Helper macro for registering a comedi PCMCIA driver
565 * @__comedi_driver: comedi_driver struct
566 * @__pcmcia_driver: pcmcia_driver struct
568 * Helper macro for comedi PCMCIA drivers which do not do anything special
569 * in module init/exit. This eliminates a lot of boilerplate. Each
570 * module may only use this macro once, and calling it replaces
571 * module_init() and module_exit()
573 #define module_comedi_pcmcia_driver(__comedi_driver, __pcmcia_driver) \
574 module_driver(__comedi_driver, comedi_pcmcia_driver_register, \
575 comedi_pcmcia_driver_unregister, &(__pcmcia_driver))
577 #endif /* CONFIG_COMEDI_PCMCIA_DRIVERS */
579 #ifdef CONFIG_COMEDI_USB_DRIVERS
581 /* comedi_usb.c - comedi USB driver specific functions */
584 struct usb_interface;
586 struct usb_interface *comedi_to_usb_interface(struct comedi_device *);
587 struct usb_device *comedi_to_usb_dev(struct comedi_device *);
589 int comedi_usb_auto_config(struct usb_interface *, struct comedi_driver *,
590 unsigned long context);
591 void comedi_usb_auto_unconfig(struct usb_interface *);
593 int comedi_usb_driver_register(struct comedi_driver *, struct usb_driver *);
594 void comedi_usb_driver_unregister(struct comedi_driver *, struct usb_driver *);
597 * module_comedi_usb_driver() - Helper macro for registering a comedi USB driver
598 * @__comedi_driver: comedi_driver struct
599 * @__usb_driver: usb_driver struct
601 * Helper macro for comedi USB drivers which do not do anything special
602 * in module init/exit. This eliminates a lot of boilerplate. Each
603 * module may only use this macro once, and calling it replaces
604 * module_init() and module_exit()
606 #define module_comedi_usb_driver(__comedi_driver, __usb_driver) \
607 module_driver(__comedi_driver, comedi_usb_driver_register, \
608 comedi_usb_driver_unregister, &(__usb_driver))
610 #endif /* CONFIG_COMEDI_USB_DRIVERS */
612 #endif /* _COMEDIDEV_H */