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