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