comedidev.h revision 139dfbdfacb02e3ef3df936d2fabd1ad5f14ea88
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/errno.h> 32#include <linux/spinlock.h> 33#include <linux/mutex.h> 34#include <linux/wait.h> 35#include <linux/mm.h> 36#include <linux/init.h> 37#include <linux/vmalloc.h> 38#include "interrupt.h" 39#include <linux/dma-mapping.h> 40#include <linux/uaccess.h> 41#include <linux/io.h> 42 43#include "comedi.h" 44 45#define DPRINTK(format, args...) do { \ 46 if (comedi_debug) \ 47 printk(KERN_DEBUG "comedi: " format , ## args); \ 48} while (0) 49 50#define COMEDI_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c)) 51#define COMEDI_VERSION_CODE COMEDI_VERSION(COMEDI_MAJORVERSION, COMEDI_MINORVERSION, COMEDI_MICROVERSION) 52#define COMEDI_RELEASE VERSION 53 54#define COMEDI_INITCLEANUP_NOMODULE(x) \ 55 static int __init x ## _init_module(void) \ 56 {return comedi_driver_register(&(x)); } \ 57 static void __exit x ## _cleanup_module(void) \ 58 {comedi_driver_unregister(&(x)); } \ 59 module_init(x ## _init_module); \ 60 module_exit(x ## _cleanup_module); \ 61 62#define COMEDI_MODULE_MACROS \ 63 MODULE_AUTHOR("Comedi http://www.comedi.org"); \ 64 MODULE_DESCRIPTION("Comedi low-level driver"); \ 65 MODULE_LICENSE("GPL"); \ 66 67#define COMEDI_INITCLEANUP(x) \ 68 COMEDI_MODULE_MACROS \ 69 COMEDI_INITCLEANUP_NOMODULE(x) 70 71#define COMEDI_PCI_INITCLEANUP_NOMODULE(comedi_driver, pci_id_table) \ 72 static int __devinit comedi_driver ## _pci_probe(struct pci_dev *dev, \ 73 const struct pci_device_id *ent) \ 74 { \ 75 return comedi_pci_auto_config(dev, comedi_driver.driver_name); \ 76 } \ 77 static void __devexit comedi_driver ## _pci_remove(struct pci_dev *dev) \ 78 { \ 79 comedi_pci_auto_unconfig(dev); \ 80 } \ 81 static struct pci_driver comedi_driver ## _pci_driver = \ 82 { \ 83 .id_table = pci_id_table, \ 84 .probe = &comedi_driver ## _pci_probe, \ 85 .remove = __devexit_p(&comedi_driver ## _pci_remove) \ 86 }; \ 87 static int __init comedi_driver ## _init_module(void) \ 88 { \ 89 int retval; \ 90 retval = comedi_driver_register(&comedi_driver); \ 91 if (retval < 0) \ 92 return retval; \ 93 comedi_driver ## _pci_driver.name = (char *)comedi_driver.driver_name; \ 94 return pci_register_driver(&comedi_driver ## _pci_driver); \ 95 } \ 96 static void __exit comedi_driver ## _cleanup_module(void) \ 97 { \ 98 pci_unregister_driver(&comedi_driver ## _pci_driver); \ 99 comedi_driver_unregister(&comedi_driver); \ 100 } \ 101 module_init(comedi_driver ## _init_module); \ 102 module_exit(comedi_driver ## _cleanup_module); 103 104#define COMEDI_PCI_INITCLEANUP(comedi_driver, pci_id_table) \ 105 COMEDI_MODULE_MACROS \ 106 COMEDI_PCI_INITCLEANUP_NOMODULE(comedi_driver, pci_id_table) 107 108#define PCI_VENDOR_ID_INOVA 0x104c 109#define PCI_VENDOR_ID_NATINST 0x1093 110#define PCI_VENDOR_ID_DATX 0x1116 111#define PCI_VENDOR_ID_COMPUTERBOARDS 0x1307 112#define PCI_VENDOR_ID_ADVANTECH 0x13fe 113#define PCI_VENDOR_ID_RTD 0x1435 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 124typedef struct comedi_lrange_struct comedi_lrange; 125 126typedef struct device device_create_result_type; 127 128#define COMEDI_DEVICE_CREATE(cs, parent, devt, drvdata, device, fmt...) \ 129 device_create(cs, ((parent) ? (parent) : (device)), devt, drvdata, fmt) 130 131struct comedi_subdevice { 132 struct comedi_device *device; 133 int type; 134 int n_chan; 135 volatile int subdev_flags; 136 int len_chanlist; /* maximum length of channel/gain list */ 137 138 void *private; 139 140 struct comedi_async *async; 141 142 void *lock; 143 void *busy; 144 unsigned runflags; 145 spinlock_t spin_lock; 146 147 int io_bits; 148 149 unsigned int maxdata; /* if maxdata==0, use list */ 150 const unsigned int *maxdata_list; /* list is channel specific */ 151 152 unsigned int flags; 153 const unsigned int *flaglist; 154 155 unsigned int settling_time_0; 156 157 const comedi_lrange *range_table; 158 const comedi_lrange *const *range_table_list; 159 160 unsigned int *chanlist; /* driver-owned chanlist (not used) */ 161 162 int (*insn_read) (struct comedi_device *, struct comedi_subdevice *, comedi_insn *, 163 unsigned int *); 164 int (*insn_write) (struct comedi_device *, struct comedi_subdevice *, comedi_insn *, 165 unsigned int *); 166 int (*insn_bits) (struct comedi_device *, struct comedi_subdevice *, comedi_insn *, 167 unsigned int *); 168 int (*insn_config) (struct comedi_device *, struct comedi_subdevice *, comedi_insn *, 169 unsigned int *); 170 171 int (*do_cmd) (struct comedi_device *, struct comedi_subdevice *); 172 int (*do_cmdtest) (struct comedi_device *, struct comedi_subdevice *, 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 *,struct comedi_subdevice *); */ 177 178 /* called when the buffer changes */ 179 int (*buf_change) (struct comedi_device *dev, struct comedi_subdevice *s, 180 unsigned long new_size); 181 182 void (*munge) (struct comedi_device *dev, struct comedi_subdevice *s, void *data, 183 unsigned int num_bytes, unsigned int start_chan_index); 184 enum dma_data_direction async_dma_dir; 185 186 unsigned int state; 187 188 device_create_result_type *class_dev; 189 int minor; 190}; 191 192struct comedi_buf_page { 193 void *virt_addr; 194 dma_addr_t dma_addr; 195}; 196 197struct comedi_async { 198 struct comedi_subdevice *subdevice; 199 200 void *prealloc_buf; /* pre-allocated buffer */ 201 unsigned int prealloc_bufsz; /* buffer size, in bytes */ 202 struct comedi_buf_page *buf_page_list; /* virtual and dma address of each page */ 203 unsigned n_buf_pages; /* num elements in buf_page_list */ 204 205 unsigned int max_bufsize; /* maximum buffer size, bytes */ 206 unsigned int mmap_count; /* current number of mmaps of prealloc_buf */ 207 208 unsigned int buf_write_count; /* byte count for writer (write completed) */ 209 unsigned int buf_write_alloc_count; /* byte count for writer (allocated for writing) */ 210 unsigned int buf_read_count; /* byte count for reader (read completed) */ 211 unsigned int buf_read_alloc_count; /* byte count for reader (allocated for reading) */ 212 213 unsigned int buf_write_ptr; /* buffer marker for writer */ 214 unsigned int buf_read_ptr; /* buffer marker for reader */ 215 216 unsigned int cur_chan; /* useless channel marker for interrupt */ 217 /* number of bytes that have been received for current scan */ 218 unsigned int scan_progress; 219 /* keeps track of where we are in chanlist as for munging */ 220 unsigned int munge_chan; 221 /* number of bytes that have been munged */ 222 unsigned int munge_count; 223 /* buffer marker for munging */ 224 unsigned int munge_ptr; 225 226 unsigned int events; /* events that have occurred */ 227 228 comedi_cmd cmd; 229 230 wait_queue_head_t wait_head; 231 232 /* callback stuff */ 233 unsigned int cb_mask; 234 int (*cb_func) (unsigned int flags, void *); 235 void *cb_arg; 236 237 int (*inttrig) (struct comedi_device *dev, struct comedi_subdevice *s, 238 unsigned int x); 239}; 240 241struct comedi_driver { 242 struct comedi_driver *next; 243 244 const char *driver_name; 245 struct module *module; 246 int (*attach) (struct comedi_device *, comedi_devconfig *); 247 int (*detach) (struct comedi_device *); 248 249 /* number of elements in board_name and board_id arrays */ 250 unsigned int num_names; 251 const char *const *board_name; 252 /* offset in bytes from one board name pointer to the next */ 253 int offset; 254}; 255 256struct comedi_device { 257 int use_count; 258 struct comedi_driver *driver; 259 void *private; 260 261 device_create_result_type *class_dev; 262 int minor; 263 /* hw_dev is passed to dma_alloc_coherent when allocating async buffers 264 * for subdevices that have async_dma_dir set to something other than 265 * DMA_NONE */ 266 struct device *hw_dev; 267 268 const char *board_name; 269 const void *board_ptr; 270 int attached; 271 int rt; 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, comedi_devconfig *it); 345int comedi_driver_register(struct comedi_driver *); 346int comedi_driver_unregister(struct comedi_driver *); 347 348void init_polling(void); 349void cleanup_polling(void); 350void start_polling(struct comedi_device *); 351void stop_polling(struct comedi_device *); 352 353int comedi_buf_alloc(struct comedi_device *dev, struct comedi_subdevice *s, unsigned long 354 new_size); 355 356#ifdef CONFIG_PROC_FS 357void comedi_proc_init(void); 358void comedi_proc_cleanup(void); 359#else 360static inline void comedi_proc_init(void) 361{ 362} 363static inline void comedi_proc_cleanup(void) 364{ 365} 366#endif 367 368/* subdevice runflags */ 369enum subdevice_runflags { 370 SRF_USER = 0x00000001, 371 SRF_RT = 0x00000002, 372 /* indicates an COMEDI_CB_ERROR event has occurred since the last 373 * command was started */ 374 SRF_ERROR = 0x00000004, 375 SRF_RUNNING = 0x08000000 376}; 377 378/* 379 various internal comedi functions 380 */ 381 382int do_rangeinfo_ioctl(struct comedi_device *dev, comedi_rangeinfo *arg); 383int check_chanlist(struct comedi_subdevice *s, int n, unsigned int *chanlist); 384void comedi_set_subdevice_runflags(struct comedi_subdevice *s, unsigned mask, 385 unsigned bits); 386unsigned comedi_get_subdevice_runflags(struct comedi_subdevice *s); 387int insn_inval(struct comedi_device *dev, struct comedi_subdevice *s, 388 comedi_insn *insn, unsigned int *data); 389 390/* range stuff */ 391 392#define RANGE(a, b) {(a)*1e6, (b)*1e6, 0} 393#define RANGE_ext(a, b) {(a)*1e6, (b)*1e6, RF_EXTERNAL} 394#define RANGE_mA(a, b) {(a)*1e6, (b)*1e6, UNIT_mA} 395#define RANGE_unitless(a, b) {(a)*1e6, (b)*1e6, 0} /* XXX */ 396#define BIP_RANGE(a) {-(a)*1e6, (a)*1e6, 0} 397#define UNI_RANGE(a) {0, (a)*1e6, 0} 398 399extern const comedi_lrange range_bipolar10; 400extern const comedi_lrange range_bipolar5; 401extern const comedi_lrange range_bipolar2_5; 402extern const comedi_lrange range_unipolar10; 403extern const comedi_lrange range_unipolar5; 404extern const comedi_lrange range_unknown; 405 406#define range_digital range_unipolar5 407 408#if __GNUC__ >= 3 409#define GCC_ZERO_LENGTH_ARRAY 410#else 411#define GCC_ZERO_LENGTH_ARRAY 0 412#endif 413 414struct comedi_lrange_struct { 415 int length; 416 comedi_krange range[GCC_ZERO_LENGTH_ARRAY]; 417}; 418 419/* some silly little inline functions */ 420 421static inline int alloc_subdevices(struct comedi_device *dev, 422 unsigned int num_subdevices) 423{ 424 unsigned i; 425 426 dev->n_subdevices = num_subdevices; 427 dev->subdevices = 428 kcalloc(num_subdevices, sizeof(struct comedi_subdevice), GFP_KERNEL); 429 if (!dev->subdevices) 430 return -ENOMEM; 431 for (i = 0; i < num_subdevices; ++i) { 432 dev->subdevices[i].device = dev; 433 dev->subdevices[i].async_dma_dir = DMA_NONE; 434 spin_lock_init(&dev->subdevices[i].spin_lock); 435 dev->subdevices[i].minor = -1; 436 } 437 return 0; 438} 439 440static inline int alloc_private(struct comedi_device *dev, int size) 441{ 442 dev->private = kzalloc(size, GFP_KERNEL); 443 if (!dev->private) 444 return -ENOMEM; 445 return 0; 446} 447 448static inline unsigned int bytes_per_sample(const struct comedi_subdevice *subd) 449{ 450 if (subd->subdev_flags & SDF_LSAMPL) 451 return sizeof(unsigned int); 452 else 453 return sizeof(short); 454} 455 456/* must be used in attach to set dev->hw_dev if you wish to dma directly 457into comedi's buffer */ 458static inline void comedi_set_hw_dev(struct comedi_device *dev, struct device *hw_dev) 459{ 460 if (dev->hw_dev) 461 put_device(dev->hw_dev); 462 463 dev->hw_dev = hw_dev; 464 if (dev->hw_dev) { 465 dev->hw_dev = get_device(dev->hw_dev); 466 BUG_ON(dev->hw_dev == NULL); 467 } 468} 469 470int comedi_buf_put(struct comedi_async *async, short x); 471int comedi_buf_get(struct comedi_async *async, short *x); 472 473unsigned int comedi_buf_write_n_available(struct comedi_async *async); 474unsigned int comedi_buf_write_alloc(struct comedi_async *async, unsigned int nbytes); 475unsigned int comedi_buf_write_alloc_strict(struct comedi_async *async, 476 unsigned int nbytes); 477unsigned comedi_buf_write_free(struct comedi_async *async, unsigned int nbytes); 478unsigned comedi_buf_read_alloc(struct comedi_async *async, unsigned nbytes); 479unsigned comedi_buf_read_free(struct comedi_async *async, unsigned int nbytes); 480unsigned int comedi_buf_read_n_available(struct comedi_async *async); 481void comedi_buf_memcpy_to(struct comedi_async *async, unsigned int offset, 482 const void *source, unsigned int num_bytes); 483void comedi_buf_memcpy_from(struct comedi_async *async, unsigned int offset, 484 void *destination, unsigned int num_bytes); 485static inline unsigned comedi_buf_write_n_allocated(struct comedi_async *async) 486{ 487 return async->buf_write_alloc_count - async->buf_write_count; 488} 489static inline unsigned comedi_buf_read_n_allocated(struct comedi_async *async) 490{ 491 return async->buf_read_alloc_count - async->buf_read_count; 492} 493 494void comedi_reset_async_buf(struct comedi_async *async); 495 496static inline void *comedi_aux_data(int options[], int n) 497{ 498 unsigned long address; 499 unsigned long addressLow; 500 int bit_shift; 501 if (sizeof(int) >= sizeof(void *)) 502 address = options[COMEDI_DEVCONF_AUX_DATA_LO]; 503 else { 504 address = options[COMEDI_DEVCONF_AUX_DATA_HI]; 505 bit_shift = sizeof(int) * 8; 506 address <<= bit_shift; 507 addressLow = options[COMEDI_DEVCONF_AUX_DATA_LO]; 508 addressLow &= (1UL << bit_shift) - 1; 509 address |= addressLow; 510 } 511 if (n >= 1) 512 address += options[COMEDI_DEVCONF_AUX_DATA0_LENGTH]; 513 if (n >= 2) 514 address += options[COMEDI_DEVCONF_AUX_DATA1_LENGTH]; 515 if (n >= 3) 516 address += options[COMEDI_DEVCONF_AUX_DATA2_LENGTH]; 517 BUG_ON(n > 3); 518 return (void *)address; 519} 520 521int comedi_alloc_board_minor(struct device *hardware_device); 522void comedi_free_board_minor(unsigned minor); 523int comedi_alloc_subdevice_minor(struct comedi_device *dev, struct comedi_subdevice *s); 524void comedi_free_subdevice_minor(struct comedi_subdevice *s); 525int comedi_pci_auto_config(struct pci_dev *pcidev, const char *board_name); 526void comedi_pci_auto_unconfig(struct pci_dev *pcidev); 527struct usb_device; /* forward declaration */ 528int comedi_usb_auto_config(struct usb_device *usbdev, const char *board_name); 529void comedi_usb_auto_unconfig(struct usb_device *usbdev); 530 531#include "comedi_rt.h" 532 533#endif /* _COMEDIDEV_H */ 534