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