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 DPRINTK(format, args...) do { \
32 pr_debug("comedi: " format, ## args); \
35 #define COMEDI_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
36 #define COMEDI_VERSION_CODE COMEDI_VERSION(COMEDI_MAJORVERSION, \
37 COMEDI_MINORVERSION, COMEDI_MICROVERSION)
38 #define COMEDI_RELEASE VERSION
40 #define COMEDI_NUM_BOARD_MINORS 0x30
42 struct comedi_subdevice {
43 struct comedi_device *device;
48 int len_chanlist; /* maximum length of channel/gain list */
52 struct comedi_async *async;
61 unsigned int maxdata; /* if maxdata==0, use list */
62 const unsigned int *maxdata_list; /* list is channel specific */
64 const struct comedi_lrange *range_table;
65 const struct comedi_lrange *const *range_table_list;
67 unsigned int *chanlist; /* driver-owned chanlist (not used) */
69 int (*insn_read) (struct comedi_device *, struct comedi_subdevice *,
70 struct comedi_insn *, unsigned int *);
71 int (*insn_write) (struct comedi_device *, struct comedi_subdevice *,
72 struct comedi_insn *, unsigned int *);
73 int (*insn_bits) (struct comedi_device *, struct comedi_subdevice *,
74 struct comedi_insn *, unsigned int *);
75 int (*insn_config) (struct comedi_device *, struct comedi_subdevice *,
76 struct comedi_insn *, unsigned int *);
78 int (*do_cmd) (struct comedi_device *, struct comedi_subdevice *);
79 int (*do_cmdtest) (struct comedi_device *, struct comedi_subdevice *,
81 int (*poll) (struct comedi_device *, struct comedi_subdevice *);
82 int (*cancel) (struct comedi_device *, struct comedi_subdevice *);
83 /* int (*do_lock)(struct comedi_device *, struct comedi_subdevice *); */
84 /* int (*do_unlock)(struct comedi_device *, \
85 struct comedi_subdevice *); */
87 /* called when the buffer changes */
88 int (*buf_change) (struct comedi_device *dev,
89 struct comedi_subdevice *s, unsigned long new_size);
91 void (*munge) (struct comedi_device *dev, struct comedi_subdevice *s,
92 void *data, unsigned int num_bytes,
93 unsigned int start_chan_index);
94 enum dma_data_direction async_dma_dir;
98 struct device *class_dev;
102 struct comedi_buf_page {
107 struct comedi_async {
108 struct comedi_subdevice *subdevice;
110 void *prealloc_buf; /* pre-allocated buffer */
111 unsigned int prealloc_bufsz; /* buffer size, in bytes */
112 /* virtual and dma address of each page */
113 struct comedi_buf_page *buf_page_list;
114 unsigned n_buf_pages; /* num elements in buf_page_list */
116 unsigned int max_bufsize; /* maximum buffer size, bytes */
117 /* current number of mmaps of prealloc_buf */
118 unsigned int mmap_count;
120 /* byte count for writer (write completed) */
121 unsigned int buf_write_count;
122 /* byte count for writer (allocated for writing) */
123 unsigned int buf_write_alloc_count;
124 /* byte count for reader (read completed) */
125 unsigned int buf_read_count;
126 /* byte count for reader (allocated for reading) */
127 unsigned int buf_read_alloc_count;
129 unsigned int buf_write_ptr; /* buffer marker for writer */
130 unsigned int buf_read_ptr; /* buffer marker for reader */
132 unsigned int cur_chan; /* useless channel marker for interrupt */
133 /* number of bytes that have been received for current scan */
134 unsigned int scan_progress;
135 /* keeps track of where we are in chanlist as for munging */
136 unsigned int munge_chan;
137 /* number of bytes that have been munged */
138 unsigned int munge_count;
139 /* buffer marker for munging */
140 unsigned int munge_ptr;
142 unsigned int events; /* events that have occurred */
144 struct comedi_cmd cmd;
146 wait_queue_head_t wait_head;
148 unsigned int cb_mask;
150 int (*inttrig) (struct comedi_device *dev, struct comedi_subdevice *s,
154 struct comedi_driver {
155 struct comedi_driver *next;
157 const char *driver_name;
158 struct module *module;
159 int (*attach) (struct comedi_device *, struct comedi_devconfig *);
160 void (*detach) (struct comedi_device *);
161 int (*auto_attach) (struct comedi_device *, unsigned long);
163 /* number of elements in board_name and board_id arrays */
164 unsigned int num_names;
165 const char *const *board_name;
166 /* offset in bytes from one board name pointer to the next */
170 struct comedi_device {
172 struct comedi_driver *driver;
175 struct device *class_dev;
177 unsigned int detach_count;
178 /* hw_dev is passed to dma_alloc_coherent when allocating async buffers
179 * for subdevices that have async_dma_dir set to something other than
181 struct device *hw_dev;
183 const char *board_name;
184 const void *board_ptr;
186 bool in_request_module:1;
190 struct rw_semaphore attach_lock;
191 struct kref refcount;
194 struct comedi_subdevice *subdevices;
197 unsigned long iobase;
201 struct comedi_subdevice *read_subdev;
202 struct comedi_subdevice *write_subdev;
204 struct fasync_struct *async_queue;
206 int (*open) (struct comedi_device *dev);
207 void (*close) (struct comedi_device *dev);
210 static inline const void *comedi_board(const struct comedi_device *dev)
212 return dev->board_ptr;
215 #ifdef CONFIG_COMEDI_DEBUG
216 extern int comedi_debug;
218 static const int comedi_debug;
222 * function prototypes
225 void comedi_event(struct comedi_device *dev, struct comedi_subdevice *s);
226 void comedi_error(const struct comedi_device *dev, const char *s);
228 /* we can expand the number of bits used to encode devices/subdevices into
229 the minor number soon, after more distros support > 8 bit minor numbers
230 (like after Debian Etch gets released) */
231 enum comedi_minor_bits {
232 COMEDI_DEVICE_MINOR_MASK = 0xf,
233 COMEDI_SUBDEVICE_MINOR_MASK = 0xf0
235 static const unsigned COMEDI_SUBDEVICE_MINOR_SHIFT = 4;
236 static const unsigned COMEDI_SUBDEVICE_MINOR_OFFSET = 1;
238 struct comedi_device *comedi_dev_get_from_minor(unsigned minor);
239 int comedi_dev_put(struct comedi_device *dev);
241 void init_polling(void);
242 void cleanup_polling(void);
243 void start_polling(struct comedi_device *);
244 void stop_polling(struct comedi_device *);
246 /* subdevice runflags */
247 enum subdevice_runflags {
249 /* indicates an COMEDI_CB_ERROR event has occurred since the last
250 * command was started */
251 SRF_ERROR = 0x00000004,
252 SRF_RUNNING = 0x08000000,
253 SRF_FREE_SPRIV = 0x80000000, /* free s->private on detach */
256 bool comedi_is_subdevice_running(struct comedi_subdevice *s);
258 void *comedi_alloc_spriv(struct comedi_subdevice *s, size_t size);
260 int comedi_check_chanlist(struct comedi_subdevice *s,
262 unsigned int *chanlist);
266 #define RANGE(a, b) {(a)*1e6, (b)*1e6, 0}
267 #define RANGE_ext(a, b) {(a)*1e6, (b)*1e6, RF_EXTERNAL}
268 #define RANGE_mA(a, b) {(a)*1e6, (b)*1e6, UNIT_mA}
269 #define RANGE_unitless(a, b) {(a)*1e6, (b)*1e6, 0}
270 #define BIP_RANGE(a) {-(a)*1e6, (a)*1e6, 0}
271 #define UNI_RANGE(a) {0, (a)*1e6, 0}
273 extern const struct comedi_lrange range_bipolar10;
274 extern const struct comedi_lrange range_bipolar5;
275 extern const struct comedi_lrange range_bipolar2_5;
276 extern const struct comedi_lrange range_unipolar10;
277 extern const struct comedi_lrange range_unipolar5;
278 extern const struct comedi_lrange range_unipolar2_5;
279 extern const struct comedi_lrange range_0_20mA;
280 extern const struct comedi_lrange range_4_20mA;
281 extern const struct comedi_lrange range_0_32mA;
282 extern const struct comedi_lrange range_unknown;
284 #define range_digital range_unipolar5
287 #define GCC_ZERO_LENGTH_ARRAY
289 #define GCC_ZERO_LENGTH_ARRAY 0
292 struct comedi_lrange {
294 struct comedi_krange range[GCC_ZERO_LENGTH_ARRAY];
297 static inline bool comedi_range_is_bipolar(struct comedi_subdevice *s,
300 return s->range_table->range[range].min < 0;
303 static inline bool comedi_range_is_unipolar(struct comedi_subdevice *s,
306 return s->range_table->range[range].min >= 0;
309 static inline bool comedi_chan_range_is_bipolar(struct comedi_subdevice *s,
313 return s->range_table_list[chan]->range[range].min < 0;
316 static inline bool comedi_chan_range_is_unipolar(struct comedi_subdevice *s,
320 return s->range_table_list[chan]->range[range].min >= 0;
323 /* munge between offset binary and two's complement values */
324 static inline unsigned int comedi_offset_munge(struct comedi_subdevice *s,
327 return val ^ s->maxdata ^ (s->maxdata >> 1);
330 static inline unsigned int bytes_per_sample(const struct comedi_subdevice *subd)
332 if (subd->subdev_flags & SDF_LSAMPL)
333 return sizeof(unsigned int);
335 return sizeof(short);
339 * Must set dev->hw_dev if you wish to dma directly into comedi's buffer.
340 * Also useful for retrieving a previously configured hardware device of
341 * known bus type. Set automatically for auto-configured devices.
342 * Automatically set to NULL when detaching hardware device.
344 int comedi_set_hw_dev(struct comedi_device *dev, struct device *hw_dev);
346 unsigned int comedi_buf_write_alloc(struct comedi_async *, unsigned int);
347 unsigned int comedi_buf_write_free(struct comedi_async *, unsigned int);
349 unsigned int comedi_buf_read_n_available(struct comedi_async *);
350 unsigned int comedi_buf_read_alloc(struct comedi_async *, unsigned int);
351 unsigned int comedi_buf_read_free(struct comedi_async *, unsigned int);
353 int comedi_buf_put(struct comedi_async *, unsigned short);
354 int comedi_buf_get(struct comedi_async *, unsigned short *);
356 void comedi_buf_memcpy_to(struct comedi_async *async, unsigned int offset,
357 const void *source, unsigned int num_bytes);
358 void comedi_buf_memcpy_from(struct comedi_async *async, unsigned int offset,
359 void *destination, unsigned int num_bytes);
361 /* drivers.c - general comedi driver functions */
363 int comedi_dio_insn_config(struct comedi_device *, struct comedi_subdevice *,
364 struct comedi_insn *, unsigned int *data,
366 unsigned int comedi_dio_update_state(struct comedi_subdevice *,
369 void *comedi_alloc_devpriv(struct comedi_device *, size_t);
370 int comedi_alloc_subdevices(struct comedi_device *, int);
372 int comedi_load_firmware(struct comedi_device *, struct device *,
374 int (*cb)(struct comedi_device *,
375 const u8 *data, size_t size,
376 unsigned long context),
377 unsigned long context);
379 int __comedi_request_region(struct comedi_device *,
380 unsigned long start, unsigned long len);
381 int comedi_request_region(struct comedi_device *,
382 unsigned long start, unsigned long len);
383 void comedi_legacy_detach(struct comedi_device *);
385 int comedi_auto_config(struct device *, struct comedi_driver *,
386 unsigned long context);
387 void comedi_auto_unconfig(struct device *);
389 int comedi_driver_register(struct comedi_driver *);
390 void comedi_driver_unregister(struct comedi_driver *);
393 * module_comedi_driver() - Helper macro for registering a comedi driver
394 * @__comedi_driver: comedi_driver struct
396 * Helper macro for comedi drivers which do not do anything special in module
397 * init/exit. This eliminates a lot of boilerplate. Each module may only use
398 * this macro once, and calling it replaces module_init() and module_exit().
400 #define module_comedi_driver(__comedi_driver) \
401 module_driver(__comedi_driver, comedi_driver_register, \
402 comedi_driver_unregister)
404 #ifdef CONFIG_COMEDI_PCI_DRIVERS
406 /* comedi_pci.c - comedi PCI driver specific functions */
409 * PCI Vendor IDs not in <linux/pci_ids.h>
411 #define PCI_VENDOR_ID_KOLTER 0x1001
412 #define PCI_VENDOR_ID_ICP 0x104c
413 #define PCI_VENDOR_ID_DT 0x1116
414 #define PCI_VENDOR_ID_IOTECH 0x1616
415 #define PCI_VENDOR_ID_CONTEC 0x1221
416 #define PCI_VENDOR_ID_RTD 0x1435
421 struct pci_dev *comedi_to_pci_dev(struct comedi_device *);
423 int comedi_pci_enable(struct comedi_device *);
424 void comedi_pci_disable(struct comedi_device *);
426 int comedi_pci_auto_config(struct pci_dev *, struct comedi_driver *,
427 unsigned long context);
428 void comedi_pci_auto_unconfig(struct pci_dev *);
430 int comedi_pci_driver_register(struct comedi_driver *, struct pci_driver *);
431 void comedi_pci_driver_unregister(struct comedi_driver *, struct pci_driver *);
434 * module_comedi_pci_driver() - Helper macro for registering a comedi PCI driver
435 * @__comedi_driver: comedi_driver struct
436 * @__pci_driver: pci_driver struct
438 * Helper macro for comedi PCI drivers which do not do anything special
439 * in module init/exit. This eliminates a lot of boilerplate. Each
440 * module may only use this macro once, and calling it replaces
441 * module_init() and module_exit()
443 #define module_comedi_pci_driver(__comedi_driver, __pci_driver) \
444 module_driver(__comedi_driver, comedi_pci_driver_register, \
445 comedi_pci_driver_unregister, &(__pci_driver))
450 * Some of the comedi mixed ISA/PCI drivers call the PCI specific
451 * functions. Provide some dummy functions if CONFIG_COMEDI_PCI_DRIVERS
455 static inline struct pci_dev *comedi_to_pci_dev(struct comedi_device *dev)
460 static inline int comedi_pci_enable(struct comedi_device *dev)
465 static inline void comedi_pci_disable(struct comedi_device *dev)
469 #endif /* CONFIG_COMEDI_PCI_DRIVERS */
471 #ifdef CONFIG_COMEDI_PCMCIA_DRIVERS
473 /* comedi_pcmcia.c - comedi PCMCIA driver specific functions */
475 struct pcmcia_driver;
476 struct pcmcia_device;
478 struct pcmcia_device *comedi_to_pcmcia_dev(struct comedi_device *);
480 int comedi_pcmcia_enable(struct comedi_device *,
481 int (*conf_check)(struct pcmcia_device *, void *));
482 void comedi_pcmcia_disable(struct comedi_device *);
484 int comedi_pcmcia_auto_config(struct pcmcia_device *, struct comedi_driver *);
485 void comedi_pcmcia_auto_unconfig(struct pcmcia_device *);
487 int comedi_pcmcia_driver_register(struct comedi_driver *,
488 struct pcmcia_driver *);
489 void comedi_pcmcia_driver_unregister(struct comedi_driver *,
490 struct pcmcia_driver *);
493 * module_comedi_pcmcia_driver() - Helper macro for registering a comedi PCMCIA driver
494 * @__comedi_driver: comedi_driver struct
495 * @__pcmcia_driver: pcmcia_driver struct
497 * Helper macro for comedi PCMCIA drivers which do not do anything special
498 * in module init/exit. This eliminates a lot of boilerplate. Each
499 * module may only use this macro once, and calling it replaces
500 * module_init() and module_exit()
502 #define module_comedi_pcmcia_driver(__comedi_driver, __pcmcia_driver) \
503 module_driver(__comedi_driver, comedi_pcmcia_driver_register, \
504 comedi_pcmcia_driver_unregister, &(__pcmcia_driver))
506 #endif /* CONFIG_COMEDI_PCMCIA_DRIVERS */
508 #ifdef CONFIG_COMEDI_USB_DRIVERS
510 /* comedi_usb.c - comedi USB driver specific functions */
513 struct usb_interface;
515 struct usb_interface *comedi_to_usb_interface(struct comedi_device *);
516 struct usb_device *comedi_to_usb_dev(struct comedi_device *);
518 int comedi_usb_auto_config(struct usb_interface *, struct comedi_driver *,
519 unsigned long context);
520 void comedi_usb_auto_unconfig(struct usb_interface *);
522 int comedi_usb_driver_register(struct comedi_driver *, struct usb_driver *);
523 void comedi_usb_driver_unregister(struct comedi_driver *, struct usb_driver *);
526 * module_comedi_usb_driver() - Helper macro for registering a comedi USB driver
527 * @__comedi_driver: comedi_driver struct
528 * @__usb_driver: usb_driver struct
530 * Helper macro for comedi USB drivers which do not do anything special
531 * in module init/exit. This eliminates a lot of boilerplate. Each
532 * module may only use this macro once, and calling it replaces
533 * module_init() and module_exit()
535 #define module_comedi_usb_driver(__comedi_driver, __usb_driver) \
536 module_driver(__comedi_driver, comedi_usb_driver_register, \
537 comedi_usb_driver_unregister, &(__usb_driver))
539 #endif /* CONFIG_COMEDI_USB_DRIVERS */
541 #endif /* _COMEDIDEV_H */