drivers/staging/comedi/comedidev.h

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