comedidev.h revision 7a102e0ef173ff936efb6ea33b6a9db865c82645
1/* 2 include/linux/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 18 You should have received a copy of the GNU General Public License 19 along with this program; if not, write to the Free Software 20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 21 22*/ 23 24#ifndef _COMEDIDEV_H 25#define _COMEDIDEV_H 26 27#include <linux/kernel.h> 28#include <linux/module.h> 29#include <linux/kdev_t.h> 30#include <linux/slab.h> 31#include <linux/delay.h> 32#include <linux/errno.h> 33#include <linux/spinlock.h> 34#include <linux/mutex.h> 35#include <linux/wait.h> 36#include <linux/mm.h> 37#include <linux/init.h> 38#include <linux/vmalloc.h> 39#include <linux/dma-mapping.h> 40#include <linux/uaccess.h> 41#include <linux/io.h> 42#include <linux/timer.h> 43 44#include "comedi.h" 45 46#define DPRINTK(format, args...) do { \ 47 if (comedi_debug) \ 48 printk(KERN_DEBUG "comedi: " format , ## args); \ 49} while (0) 50 51#define COMEDI_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c)) 52#define COMEDI_VERSION_CODE COMEDI_VERSION(COMEDI_MAJORVERSION, \ 53 COMEDI_MINORVERSION, COMEDI_MICROVERSION) 54#define COMEDI_RELEASE VERSION 55 56#define COMEDI_INITCLEANUP_NOMODULE(x) \ 57 static int __init x ## _init_module(void) \ 58 {return comedi_driver_register(&(x)); } \ 59 static void __exit x ## _cleanup_module(void) \ 60 {comedi_driver_unregister(&(x)); } \ 61 module_init(x ## _init_module); \ 62 module_exit(x ## _cleanup_module); 63 64#define COMEDI_MODULE_MACROS \ 65 MODULE_AUTHOR("Comedi http://www.comedi.org"); \ 66 MODULE_DESCRIPTION("Comedi low-level driver"); \ 67 MODULE_LICENSE("GPL"); 68 69#define COMEDI_INITCLEANUP(x) \ 70 COMEDI_MODULE_MACROS \ 71 COMEDI_INITCLEANUP_NOMODULE(x) 72 73#define COMEDI_PCI_INITCLEANUP_NOMODULE(comedi_driver, pci_id_table) \ 74 static int __devinit comedi_driver ## _pci_probe(struct pci_dev *dev, \ 75 const struct pci_device_id *ent) \ 76 { \ 77 return comedi_pci_auto_config(dev, comedi_driver.driver_name); \ 78 } \ 79 static void __devexit comedi_driver ## _pci_remove(\ 80 struct pci_dev *dev) \ 81 { \ 82 comedi_pci_auto_unconfig(dev); \ 83 } \ 84 static struct pci_driver comedi_driver ## _pci_driver = \ 85 { \ 86 .id_table = pci_id_table, \ 87 .probe = &comedi_driver ## _pci_probe, \ 88 .remove = __devexit_p(&comedi_driver ## _pci_remove) \ 89 }; \ 90 static int __init comedi_driver ## _init_module(void) \ 91 { \ 92 int retval; \ 93 retval = comedi_driver_register(&comedi_driver); \ 94 if (retval < 0) \ 95 return retval; \ 96 comedi_driver ## _pci_driver.name = \ 97 (char *)comedi_driver.driver_name; \ 98 return pci_register_driver(&comedi_driver ## _pci_driver); \ 99 } \ 100 static void __exit comedi_driver ## _cleanup_module(void) \ 101 { \ 102 pci_unregister_driver(&comedi_driver ## _pci_driver); \ 103 comedi_driver_unregister(&comedi_driver); \ 104 } \ 105 module_init(comedi_driver ## _init_module); \ 106 module_exit(comedi_driver ## _cleanup_module); 107 108#define COMEDI_PCI_INITCLEANUP(comedi_driver, pci_id_table) \ 109 COMEDI_MODULE_MACROS \ 110 COMEDI_PCI_INITCLEANUP_NOMODULE(comedi_driver, pci_id_table) 111 112#define PCI_VENDOR_ID_COMPUTERBOARDS 0x1307 113#define PCI_VENDOR_ID_ADVANTECH 0x13fe 114#define PCI_VENDOR_ID_AMPLICON 0x14dc 115#define PCI_VENDOR_ID_ADLINK 0x144a 116#define PCI_VENDOR_ID_ICP 0x104c 117#define PCI_VENDOR_ID_CONTEC 0x1221 118#define PCI_VENDOR_ID_MEILHAUS 0x1402 119 120#define COMEDI_NUM_MINORS 0x100 121#define COMEDI_NUM_BOARD_MINORS 0x30 122#define COMEDI_FIRST_SUBDEVICE_MINOR COMEDI_NUM_BOARD_MINORS 123 124#define COMEDI_DEVICE_CREATE(cs, parent, devt, drvdata, device, fmt...) \ 125 device_create(cs, ((parent) ? (parent) : (device)), devt, drvdata, fmt) 126 127struct comedi_subdevice { 128 struct comedi_device *device; 129 int type; 130 int n_chan; 131 int subdev_flags; 132 int len_chanlist; /* maximum length of channel/gain list */ 133 134 void *private; 135 136 struct comedi_async *async; 137 138 void *lock; 139 void *busy; 140 unsigned runflags; 141 spinlock_t spin_lock; 142 143 int io_bits; 144 145 unsigned int maxdata; /* if maxdata==0, use list */ 146 const unsigned int *maxdata_list; /* list is channel specific */ 147 148 unsigned int flags; 149 const unsigned int *flaglist; 150 151 unsigned int settling_time_0; 152 153 const struct comedi_lrange *range_table; 154 const struct comedi_lrange *const *range_table_list; 155 156 unsigned int *chanlist; /* driver-owned chanlist (not used) */ 157 158 int (*insn_read) (struct comedi_device *, struct comedi_subdevice *, 159 struct comedi_insn *, unsigned int *); 160 int (*insn_write) (struct comedi_device *, struct comedi_subdevice *, 161 struct comedi_insn *, unsigned int *); 162 int (*insn_bits) (struct comedi_device *, struct comedi_subdevice *, 163 struct comedi_insn *, unsigned int *); 164 int (*insn_config) (struct comedi_device *, struct comedi_subdevice *, 165 struct comedi_insn *, unsigned int *); 166 167 int (*do_cmd) (struct comedi_device *, struct comedi_subdevice *); 168 int (*do_cmdtest) (struct comedi_device *, struct comedi_subdevice *, 169 struct comedi_cmd *); 170 int (*poll) (struct comedi_device *, struct comedi_subdevice *); 171 int (*cancel) (struct comedi_device *, struct comedi_subdevice *); 172 /* int (*do_lock)(struct comedi_device *, struct comedi_subdevice *); */ 173 /* int (*do_unlock)(struct comedi_device *, \ 174 struct comedi_subdevice *); */ 175 176 /* called when the buffer changes */ 177 int (*buf_change) (struct comedi_device *dev, 178 struct comedi_subdevice *s, unsigned long new_size); 179 180 void (*munge) (struct comedi_device *dev, struct comedi_subdevice *s, 181 void *data, unsigned int num_bytes, 182 unsigned int start_chan_index); 183 enum dma_data_direction async_dma_dir; 184 185 unsigned int state; 186 187 struct device *class_dev; 188 int minor; 189}; 190 191struct comedi_buf_page { 192 void *virt_addr; 193 dma_addr_t dma_addr; 194}; 195 196struct comedi_async { 197 struct comedi_subdevice *subdevice; 198 199 void *prealloc_buf; /* pre-allocated buffer */ 200 unsigned int prealloc_bufsz; /* buffer size, in bytes */ 201 /* virtual and dma address of each page */ 202 struct comedi_buf_page *buf_page_list; 203 unsigned n_buf_pages; /* num elements in buf_page_list */ 204 205 unsigned int max_bufsize; /* maximum buffer size, bytes */ 206 /* current number of mmaps of prealloc_buf */ 207 unsigned int mmap_count; 208 209 /* byte count for writer (write completed) */ 210 unsigned int buf_write_count; 211 /* byte count for writer (allocated for writing) */ 212 unsigned int buf_write_alloc_count; 213 /* byte count for reader (read completed) */ 214 unsigned int buf_read_count; 215 /* byte count for reader (allocated for reading) */ 216 unsigned int buf_read_alloc_count; 217 218 unsigned int buf_write_ptr; /* buffer marker for writer */ 219 unsigned int buf_read_ptr; /* buffer marker for reader */ 220 221 unsigned int cur_chan; /* useless channel marker for interrupt */ 222 /* number of bytes that have been received for current scan */ 223 unsigned int scan_progress; 224 /* keeps track of where we are in chanlist as for munging */ 225 unsigned int munge_chan; 226 /* number of bytes that have been munged */ 227 unsigned int munge_count; 228 /* buffer marker for munging */ 229 unsigned int munge_ptr; 230 231 unsigned int events; /* events that have occurred */ 232 233 struct comedi_cmd cmd; 234 235 wait_queue_head_t wait_head; 236 237 /* callback stuff */ 238 unsigned int cb_mask; 239 int (*cb_func) (unsigned int flags, void *); 240 void *cb_arg; 241 242 int (*inttrig) (struct comedi_device *dev, struct comedi_subdevice *s, 243 unsigned int x); 244}; 245 246struct comedi_driver { 247 struct comedi_driver *next; 248 249 const char *driver_name; 250 struct module *module; 251 int (*attach) (struct comedi_device *, struct comedi_devconfig *); 252 int (*detach) (struct comedi_device *); 253 254 /* number of elements in board_name and board_id arrays */ 255 unsigned int num_names; 256 const char *const *board_name; 257 /* offset in bytes from one board name pointer to the next */ 258 int offset; 259}; 260 261struct comedi_device { 262 int use_count; 263 struct comedi_driver *driver; 264 void *private; 265 266 struct device *class_dev; 267 int minor; 268 /* hw_dev is passed to dma_alloc_coherent when allocating async buffers 269 * for subdevices that have async_dma_dir set to something other than 270 * DMA_NONE */ 271 struct device *hw_dev; 272 273 const char *board_name; 274 const void *board_ptr; 275 int attached; 276 spinlock_t spinlock; 277 struct mutex mutex; 278 int in_request_module; 279 280 int n_subdevices; 281 struct comedi_subdevice *subdevices; 282 283 /* dumb */ 284 unsigned long iobase; 285 unsigned int irq; 286 287 struct comedi_subdevice *read_subdev; 288 struct comedi_subdevice *write_subdev; 289 290 struct fasync_struct *async_queue; 291 292 void (*open) (struct comedi_device *dev); 293 void (*close) (struct comedi_device *dev); 294}; 295 296struct comedi_device_file_info { 297 struct comedi_device *device; 298 struct comedi_subdevice *read_subdevice; 299 struct comedi_subdevice *write_subdevice; 300}; 301 302#ifdef CONFIG_COMEDI_DEBUG 303extern int comedi_debug; 304#else 305static const int comedi_debug; 306#endif 307 308/* 309 * function prototypes 310 */ 311 312void comedi_event(struct comedi_device *dev, struct comedi_subdevice *s); 313void comedi_error(const struct comedi_device *dev, const char *s); 314 315/* we can expand the number of bits used to encode devices/subdevices into 316 the minor number soon, after more distros support > 8 bit minor numbers 317 (like after Debian Etch gets released) */ 318enum comedi_minor_bits { 319 COMEDI_DEVICE_MINOR_MASK = 0xf, 320 COMEDI_SUBDEVICE_MINOR_MASK = 0xf0 321}; 322static const unsigned COMEDI_SUBDEVICE_MINOR_SHIFT = 4; 323static const unsigned COMEDI_SUBDEVICE_MINOR_OFFSET = 1; 324 325struct comedi_device_file_info *comedi_get_device_file_info(unsigned minor); 326 327static inline struct comedi_subdevice *comedi_get_read_subdevice( 328 const struct comedi_device_file_info *info) 329{ 330 if (info->read_subdevice) 331 return info->read_subdevice; 332 if (info->device == NULL) 333 return NULL; 334 return info->device->read_subdev; 335} 336 337static inline struct comedi_subdevice *comedi_get_write_subdevice( 338 const struct comedi_device_file_info *info) 339{ 340 if (info->write_subdevice) 341 return info->write_subdevice; 342 if (info->device == NULL) 343 return NULL; 344 return info->device->write_subdev; 345} 346 347void comedi_device_detach(struct comedi_device *dev); 348int comedi_device_attach(struct comedi_device *dev, 349 struct comedi_devconfig *it); 350int comedi_driver_register(struct comedi_driver *); 351int comedi_driver_unregister(struct comedi_driver *); 352 353void init_polling(void); 354void cleanup_polling(void); 355void start_polling(struct comedi_device *); 356void stop_polling(struct comedi_device *); 357 358int comedi_buf_alloc(struct comedi_device *dev, struct comedi_subdevice *s, 359 unsigned long new_size); 360 361#ifdef CONFIG_PROC_FS 362void comedi_proc_init(void); 363void comedi_proc_cleanup(void); 364#else 365static inline void comedi_proc_init(void) 366{ 367} 368 369static inline void comedi_proc_cleanup(void) 370{ 371} 372#endif 373 374/* subdevice runflags */ 375enum subdevice_runflags { 376 SRF_USER = 0x00000001, 377 SRF_RT = 0x00000002, 378 /* indicates an COMEDI_CB_ERROR event has occurred since the last 379 * command was started */ 380 SRF_ERROR = 0x00000004, 381 SRF_RUNNING = 0x08000000 382}; 383 384/* 385 various internal comedi functions 386 */ 387 388int do_rangeinfo_ioctl(struct comedi_device *dev, struct comedi_rangeinfo *arg); 389int check_chanlist(struct comedi_subdevice *s, int n, unsigned int *chanlist); 390void comedi_set_subdevice_runflags(struct comedi_subdevice *s, unsigned mask, 391 unsigned bits); 392unsigned comedi_get_subdevice_runflags(struct comedi_subdevice *s); 393int insn_inval(struct comedi_device *dev, struct comedi_subdevice *s, 394 struct comedi_insn *insn, unsigned int *data); 395 396/* range stuff */ 397 398#define RANGE(a, b) {(a)*1e6, (b)*1e6, 0} 399#define RANGE_ext(a, b) {(a)*1e6, (b)*1e6, RF_EXTERNAL} 400#define RANGE_mA(a, b) {(a)*1e6, (b)*1e6, UNIT_mA} 401#define RANGE_unitless(a, b) {(a)*1e6, (b)*1e6, 0} 402#define BIP_RANGE(a) {-(a)*1e6, (a)*1e6, 0} 403#define UNI_RANGE(a) {0, (a)*1e6, 0} 404 405extern const struct comedi_lrange range_bipolar10; 406extern const struct comedi_lrange range_bipolar5; 407extern const struct comedi_lrange range_bipolar2_5; 408extern const struct comedi_lrange range_unipolar10; 409extern const struct comedi_lrange range_unipolar5; 410extern const struct comedi_lrange range_unknown; 411 412#define range_digital range_unipolar5 413 414#if __GNUC__ >= 3 415#define GCC_ZERO_LENGTH_ARRAY 416#else 417#define GCC_ZERO_LENGTH_ARRAY 0 418#endif 419 420struct comedi_lrange { 421 int length; 422 struct comedi_krange range[GCC_ZERO_LENGTH_ARRAY]; 423}; 424 425/* some silly little inline functions */ 426 427static inline int alloc_subdevices(struct comedi_device *dev, 428 unsigned int num_subdevices) 429{ 430 unsigned i; 431 432 dev->n_subdevices = num_subdevices; 433 dev->subdevices = 434 kcalloc(num_subdevices, sizeof(struct comedi_subdevice), 435 GFP_KERNEL); 436 if (!dev->subdevices) 437 return -ENOMEM; 438 for (i = 0; i < num_subdevices; ++i) { 439 dev->subdevices[i].device = dev; 440 dev->subdevices[i].async_dma_dir = DMA_NONE; 441 spin_lock_init(&dev->subdevices[i].spin_lock); 442 dev->subdevices[i].minor = -1; 443 } 444 return 0; 445} 446 447static inline int alloc_private(struct comedi_device *dev, int size) 448{ 449 dev->private = kzalloc(size, GFP_KERNEL); 450 if (!dev->private) 451 return -ENOMEM; 452 return 0; 453} 454 455static inline unsigned int bytes_per_sample(const struct comedi_subdevice *subd) 456{ 457 if (subd->subdev_flags & SDF_LSAMPL) 458 return sizeof(unsigned int); 459 else 460 return sizeof(short); 461} 462 463/* must be used in attach to set dev->hw_dev if you wish to dma directly 464into comedi's buffer */ 465static inline void comedi_set_hw_dev(struct comedi_device *dev, 466 struct device *hw_dev) 467{ 468 if (dev->hw_dev) 469 put_device(dev->hw_dev); 470 471 dev->hw_dev = hw_dev; 472 if (dev->hw_dev) { 473 dev->hw_dev = get_device(dev->hw_dev); 474 BUG_ON(dev->hw_dev == NULL); 475 } 476} 477 478int comedi_buf_put(struct comedi_async *async, short x); 479int comedi_buf_get(struct comedi_async *async, short *x); 480 481unsigned int comedi_buf_write_n_available(struct comedi_async *async); 482unsigned int comedi_buf_write_alloc(struct comedi_async *async, 483 unsigned int nbytes); 484unsigned int comedi_buf_write_alloc_strict(struct comedi_async *async, 485 unsigned int nbytes); 486unsigned comedi_buf_write_free(struct comedi_async *async, unsigned int nbytes); 487unsigned comedi_buf_read_alloc(struct comedi_async *async, unsigned nbytes); 488unsigned comedi_buf_read_free(struct comedi_async *async, unsigned int nbytes); 489unsigned int comedi_buf_read_n_available(struct comedi_async *async); 490void comedi_buf_memcpy_to(struct comedi_async *async, unsigned int offset, 491 const void *source, unsigned int num_bytes); 492void comedi_buf_memcpy_from(struct comedi_async *async, unsigned int offset, 493 void *destination, unsigned int num_bytes); 494static inline unsigned comedi_buf_write_n_allocated(struct comedi_async *async) 495{ 496 return async->buf_write_alloc_count - async->buf_write_count; 497} 498 499static inline unsigned comedi_buf_read_n_allocated(struct comedi_async *async) 500{ 501 return async->buf_read_alloc_count - async->buf_read_count; 502} 503 504void comedi_reset_async_buf(struct comedi_async *async); 505 506static inline void *comedi_aux_data(int options[], int n) 507{ 508 unsigned long address; 509 unsigned long addressLow; 510 int bit_shift; 511 if (sizeof(int) >= sizeof(void *)) 512 address = options[COMEDI_DEVCONF_AUX_DATA_LO]; 513 else { 514 address = options[COMEDI_DEVCONF_AUX_DATA_HI]; 515 bit_shift = sizeof(int) * 8; 516 address <<= bit_shift; 517 addressLow = options[COMEDI_DEVCONF_AUX_DATA_LO]; 518 addressLow &= (1UL << bit_shift) - 1; 519 address |= addressLow; 520 } 521 if (n >= 1) 522 address += options[COMEDI_DEVCONF_AUX_DATA0_LENGTH]; 523 if (n >= 2) 524 address += options[COMEDI_DEVCONF_AUX_DATA1_LENGTH]; 525 if (n >= 3) 526 address += options[COMEDI_DEVCONF_AUX_DATA2_LENGTH]; 527 BUG_ON(n > 3); 528 return (void *)address; 529} 530 531int comedi_alloc_board_minor(struct device *hardware_device); 532void comedi_free_board_minor(unsigned minor); 533int comedi_alloc_subdevice_minor(struct comedi_device *dev, 534 struct comedi_subdevice *s); 535void comedi_free_subdevice_minor(struct comedi_subdevice *s); 536int comedi_pci_auto_config(struct pci_dev *pcidev, const char *board_name); 537void comedi_pci_auto_unconfig(struct pci_dev *pcidev); 538struct usb_device; /* forward declaration */ 539int comedi_usb_auto_config(struct usb_device *usbdev, const char *board_name); 540void comedi_usb_auto_unconfig(struct usb_device *usbdev); 541 542#ifdef CONFIG_COMEDI_PCI_DRIVERS 543#define CONFIG_COMEDI_PCI 544#endif 545#ifdef CONFIG_COMEDI_PCI_DRIVERS_MODULE 546#define CONFIG_COMEDI_PCI 547#endif 548#ifdef CONFIG_COMEDI_PCMCIA_DRIVERS 549#define CONFIG_COMEDI_PCMCIA 550#endif 551#ifdef CONFIG_COMEDI_PCMCIA_DRIVERS_MODULE 552#define CONFIG_COMEDI_PCMCIA 553#endif 554 555#endif /* _COMEDIDEV_H */ 556