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