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