Staging: comedi: Remove comedi_insn typedef
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / staging / comedi / comedidev.h
CommitLineData
ed9eccbe
DS
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>
ed9eccbe
DS
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>
74b847f4 38#include "interrupt.h"
ed9eccbe 39#include <linux/dma-mapping.h>
e0dcef71
GKH
40#include <linux/uaccess.h>
41#include <linux/io.h>
ed9eccbe
DS
42
43#include "comedi.h"
44
e0dcef71
GKH
45#define DPRINTK(format, args...) do { \
46 if (comedi_debug) \
47 printk(KERN_DEBUG "comedi: " format , ## args); \
48} while (0)
ed9eccbe 49
e0dcef71
GKH
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)
ed9eccbe
DS
52#define COMEDI_RELEASE VERSION
53
54#define COMEDI_INITCLEANUP_NOMODULE(x) \
55 static int __init x ## _init_module(void) \
51b713a6 56 {return comedi_driver_register(&(x)); } \
ed9eccbe 57 static void __exit x ## _cleanup_module(void) \
51b713a6 58 {comedi_driver_unregister(&(x)); } \
ed9eccbe
DS
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, \
e0dcef71
GKH
84 .probe = &comedi_driver ## _pci_probe, \
85 .remove = __devexit_p(&comedi_driver ## _pci_remove) \
ed9eccbe
DS
86 }; \
87 static int __init comedi_driver ## _init_module(void) \
88 { \
89 int retval; \
e0dcef71
GKH
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); \
ed9eccbe
DS
95 } \
96 static void __exit comedi_driver ## _cleanup_module(void) \
97 { \
e0dcef71
GKH
98 pci_unregister_driver(&comedi_driver ## _pci_driver); \
99 comedi_driver_unregister(&comedi_driver); \
ed9eccbe
DS
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
ed9eccbe
DS
121#define COMEDI_NUM_BOARD_MINORS 0x30
122#define COMEDI_FIRST_SUBDEVICE_MINOR COMEDI_NUM_BOARD_MINORS
123
ed9eccbe
DS
124#define COMEDI_DEVICE_CREATE(cs, parent, devt, drvdata, device, fmt...) \
125 device_create(cs, ((parent) ? (parent) : (device)), devt, drvdata, fmt)
126
34c43922 127struct comedi_subdevice {
71b5f4f1 128 struct comedi_device *device;
ed9eccbe
DS
129 int type;
130 int n_chan;
131 volatile int subdev_flags;
132 int len_chanlist; /* maximum length of channel/gain list */
133
134 void *private;
135
d163679c 136 struct comedi_async *async;
ed9eccbe
DS
137
138 void *lock;
139 void *busy;
140 unsigned runflags;
141 spinlock_t spin_lock;
142
143 int io_bits;
144
790c5541
BP
145 unsigned int maxdata; /* if maxdata==0, use list */
146 const unsigned int *maxdata_list; /* list is channel specific */
ed9eccbe
DS
147
148 unsigned int flags;
149 const unsigned int *flaglist;
150
151 unsigned int settling_time_0;
152
9ced1de6
BP
153 const struct comedi_lrange *range_table;
154 const struct comedi_lrange *const *range_table_list;
ed9eccbe
DS
155
156 unsigned int *chanlist; /* driver-owned chanlist (not used) */
157
90035c08 158 int (*insn_read) (struct comedi_device *, struct comedi_subdevice *, struct comedi_insn *,
790c5541 159 unsigned int *);
90035c08 160 int (*insn_write) (struct comedi_device *, struct comedi_subdevice *, struct comedi_insn *,
790c5541 161 unsigned int *);
90035c08 162 int (*insn_bits) (struct comedi_device *, struct comedi_subdevice *, struct comedi_insn *,
790c5541 163 unsigned int *);
90035c08 164 int (*insn_config) (struct comedi_device *, struct comedi_subdevice *, struct comedi_insn *,
790c5541 165 unsigned int *);
ed9eccbe 166
34c43922 167 int (*do_cmd) (struct comedi_device *, struct comedi_subdevice *);
ea6d0d4c 168 int (*do_cmdtest) (struct comedi_device *, struct comedi_subdevice *, struct comedi_cmd *);
34c43922
BP
169 int (*poll) (struct comedi_device *, struct comedi_subdevice *);
170 int (*cancel) (struct comedi_device *, struct comedi_subdevice *);
171 /* int (*do_lock)(struct comedi_device *,struct comedi_subdevice *); */
172 /* int (*do_unlock)(struct comedi_device *,struct comedi_subdevice *); */
ed9eccbe
DS
173
174 /* called when the buffer changes */
34c43922 175 int (*buf_change) (struct comedi_device *dev, struct comedi_subdevice *s,
ed9eccbe
DS
176 unsigned long new_size);
177
34c43922 178 void (*munge) (struct comedi_device *dev, struct comedi_subdevice *s, void *data,
ed9eccbe
DS
179 unsigned int num_bytes, unsigned int start_chan_index);
180 enum dma_data_direction async_dma_dir;
181
182 unsigned int state;
183
0bfbbe8f 184 struct device *class_dev;
ed9eccbe
DS
185 int minor;
186};
187
188struct comedi_buf_page {
189 void *virt_addr;
190 dma_addr_t dma_addr;
191};
192
d163679c 193struct comedi_async {
34c43922 194 struct comedi_subdevice *subdevice;
ed9eccbe
DS
195
196 void *prealloc_buf; /* pre-allocated buffer */
197 unsigned int prealloc_bufsz; /* buffer size, in bytes */
198 struct comedi_buf_page *buf_page_list; /* virtual and dma address of each page */
199 unsigned n_buf_pages; /* num elements in buf_page_list */
200
201 unsigned int max_bufsize; /* maximum buffer size, bytes */
202 unsigned int mmap_count; /* current number of mmaps of prealloc_buf */
203
204 unsigned int buf_write_count; /* byte count for writer (write completed) */
205 unsigned int buf_write_alloc_count; /* byte count for writer (allocated for writing) */
206 unsigned int buf_read_count; /* byte count for reader (read completed) */
207 unsigned int buf_read_alloc_count; /* byte count for reader (allocated for reading) */
208
209 unsigned int buf_write_ptr; /* buffer marker for writer */
210 unsigned int buf_read_ptr; /* buffer marker for reader */
211
212 unsigned int cur_chan; /* useless channel marker for interrupt */
213 /* number of bytes that have been received for current scan */
214 unsigned int scan_progress;
215 /* keeps track of where we are in chanlist as for munging */
216 unsigned int munge_chan;
217 /* number of bytes that have been munged */
218 unsigned int munge_count;
219 /* buffer marker for munging */
220 unsigned int munge_ptr;
221
222 unsigned int events; /* events that have occurred */
223
ea6d0d4c 224 struct comedi_cmd cmd;
ed9eccbe
DS
225
226 wait_queue_head_t wait_head;
227
e0dcef71 228 /* callback stuff */
ed9eccbe
DS
229 unsigned int cb_mask;
230 int (*cb_func) (unsigned int flags, void *);
231 void *cb_arg;
232
34c43922 233 int (*inttrig) (struct comedi_device *dev, struct comedi_subdevice *s,
e0dcef71 234 unsigned int x);
ed9eccbe
DS
235};
236
139dfbdf
BP
237struct comedi_driver {
238 struct comedi_driver *next;
ed9eccbe
DS
239
240 const char *driver_name;
241 struct module *module;
71b5f4f1
BP
242 int (*attach) (struct comedi_device *, comedi_devconfig *);
243 int (*detach) (struct comedi_device *);
ed9eccbe
DS
244
245 /* number of elements in board_name and board_id arrays */
246 unsigned int num_names;
247 const char *const *board_name;
248 /* offset in bytes from one board name pointer to the next */
249 int offset;
250};
251
71b5f4f1 252struct comedi_device {
ed9eccbe 253 int use_count;
139dfbdf 254 struct comedi_driver *driver;
ed9eccbe
DS
255 void *private;
256
0bfbbe8f 257 struct device *class_dev;
ed9eccbe 258 int minor;
e0dcef71
GKH
259 /* hw_dev is passed to dma_alloc_coherent when allocating async buffers
260 * for subdevices that have async_dma_dir set to something other than
261 * DMA_NONE */
ed9eccbe
DS
262 struct device *hw_dev;
263
264 const char *board_name;
265 const void *board_ptr;
266 int attached;
267 int rt;
268 spinlock_t spinlock;
269 struct mutex mutex;
270 int in_request_module;
271
272 int n_subdevices;
34c43922 273 struct comedi_subdevice *subdevices;
ed9eccbe
DS
274
275 /* dumb */
276 unsigned long iobase;
277 unsigned int irq;
278
34c43922
BP
279 struct comedi_subdevice *read_subdev;
280 struct comedi_subdevice *write_subdev;
ed9eccbe
DS
281
282 struct fasync_struct *async_queue;
283
71b5f4f1
BP
284 void (*open) (struct comedi_device *dev);
285 void (*close) (struct comedi_device *dev);
ed9eccbe
DS
286};
287
288struct comedi_device_file_info {
71b5f4f1 289 struct comedi_device *device;
34c43922
BP
290 struct comedi_subdevice *read_subdevice;
291 struct comedi_subdevice *write_subdevice;
ed9eccbe
DS
292};
293
294#ifdef CONFIG_COMEDI_DEBUG
295extern int comedi_debug;
296#else
e0dcef71 297static const int comedi_debug;
ed9eccbe
DS
298#endif
299
300/*
301 * function prototypes
302 */
303
34c43922 304void comedi_event(struct comedi_device *dev, struct comedi_subdevice *s);
71b5f4f1 305void comedi_error(const struct comedi_device *dev, const char *s);
ed9eccbe
DS
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) */
310enum comedi_minor_bits {
311 COMEDI_DEVICE_MINOR_MASK = 0xf,
312 COMEDI_SUBDEVICE_MINOR_MASK = 0xf0
313};
314static const unsigned COMEDI_SUBDEVICE_MINOR_SHIFT = 4;
315static const unsigned COMEDI_SUBDEVICE_MINOR_OFFSET = 1;
316
e0dcef71 317struct comedi_device_file_info *comedi_get_device_file_info(unsigned minor);
ed9eccbe 318
34c43922 319static inline struct comedi_subdevice *comedi_get_read_subdevice(
e0dcef71 320 const struct comedi_device_file_info *info)
ed9eccbe 321{
e0dcef71
GKH
322 if (info->read_subdevice)
323 return info->read_subdevice;
324 if (info->device == NULL)
325 return NULL;
ed9eccbe
DS
326 return info->device->read_subdev;
327}
328
34c43922 329static inline struct comedi_subdevice *comedi_get_write_subdevice(
e0dcef71 330 const struct comedi_device_file_info *info)
ed9eccbe 331{
e0dcef71
GKH
332 if (info->write_subdevice)
333 return info->write_subdevice;
334 if (info->device == NULL)
335 return NULL;
ed9eccbe
DS
336 return info->device->write_subdev;
337}
338
71b5f4f1
BP
339void comedi_device_detach(struct comedi_device *dev);
340int comedi_device_attach(struct comedi_device *dev, comedi_devconfig *it);
139dfbdf
BP
341int comedi_driver_register(struct comedi_driver *);
342int comedi_driver_unregister(struct comedi_driver *);
ed9eccbe
DS
343
344void init_polling(void);
345void cleanup_polling(void);
71b5f4f1
BP
346void start_polling(struct comedi_device *);
347void stop_polling(struct comedi_device *);
ed9eccbe 348
34c43922 349int comedi_buf_alloc(struct comedi_device *dev, struct comedi_subdevice *s, unsigned long
ed9eccbe
DS
350 new_size);
351
352#ifdef CONFIG_PROC_FS
353void comedi_proc_init(void);
354void comedi_proc_cleanup(void);
355#else
356static inline void comedi_proc_init(void)
357{
358}
359static inline void comedi_proc_cleanup(void)
360{
361}
362#endif
363
364/* subdevice runflags */
365enum subdevice_runflags {
366 SRF_USER = 0x00000001,
367 SRF_RT = 0x00000002,
e0dcef71
GKH
368 /* indicates an COMEDI_CB_ERROR event has occurred since the last
369 * command was started */
ed9eccbe
DS
370 SRF_ERROR = 0x00000004,
371 SRF_RUNNING = 0x08000000
372};
373
374/*
375 various internal comedi functions
376 */
377
71b5f4f1 378int do_rangeinfo_ioctl(struct comedi_device *dev, comedi_rangeinfo *arg);
34c43922
BP
379int check_chanlist(struct comedi_subdevice *s, int n, unsigned int *chanlist);
380void comedi_set_subdevice_runflags(struct comedi_subdevice *s, unsigned mask,
ed9eccbe 381 unsigned bits);
34c43922
BP
382unsigned comedi_get_subdevice_runflags(struct comedi_subdevice *s);
383int insn_inval(struct comedi_device *dev, struct comedi_subdevice *s,
90035c08 384 struct comedi_insn *insn, unsigned int *data);
ed9eccbe
DS
385
386/* range stuff */
387
e0dcef71
GKH
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}
ed9eccbe 394
9ced1de6
BP
395extern const struct comedi_lrange range_bipolar10;
396extern const struct comedi_lrange range_bipolar5;
397extern const struct comedi_lrange range_bipolar2_5;
398extern const struct comedi_lrange range_unipolar10;
399extern const struct comedi_lrange range_unipolar5;
400extern const struct comedi_lrange range_unknown;
ed9eccbe
DS
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
9ced1de6 410struct comedi_lrange {
ed9eccbe
DS
411 int length;
412 comedi_krange range[GCC_ZERO_LENGTH_ARRAY];
413};
414
415/* some silly little inline functions */
416
71b5f4f1 417static inline int alloc_subdevices(struct comedi_device *dev,
e0dcef71 418 unsigned int num_subdevices)
ed9eccbe
DS
419{
420 unsigned i;
421
422 dev->n_subdevices = num_subdevices;
423 dev->subdevices =
34c43922 424 kcalloc(num_subdevices, sizeof(struct comedi_subdevice), GFP_KERNEL);
ed9eccbe
DS
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
71b5f4f1 436static inline int alloc_private(struct comedi_device *dev, int size)
ed9eccbe
DS
437{
438 dev->private = kzalloc(size, GFP_KERNEL);
439 if (!dev->private)
440 return -ENOMEM;
441 return 0;
442}
443
34c43922 444static inline unsigned int bytes_per_sample(const struct comedi_subdevice *subd)
ed9eccbe
DS
445{
446 if (subd->subdev_flags & SDF_LSAMPL)
790c5541 447 return sizeof(unsigned int);
ed9eccbe 448 else
790c5541 449 return sizeof(short);
ed9eccbe
DS
450}
451
452/* must be used in attach to set dev->hw_dev if you wish to dma directly
453into comedi's buffer */
71b5f4f1 454static inline void comedi_set_hw_dev(struct comedi_device *dev, struct device *hw_dev)
ed9eccbe 455{
e0dcef71 456 if (dev->hw_dev)
ed9eccbe 457 put_device(dev->hw_dev);
e0dcef71 458
ed9eccbe
DS
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
d163679c
BP
466int comedi_buf_put(struct comedi_async *async, short x);
467int comedi_buf_get(struct comedi_async *async, short *x);
ed9eccbe 468
d163679c
BP
469unsigned int comedi_buf_write_n_available(struct comedi_async *async);
470unsigned int comedi_buf_write_alloc(struct comedi_async *async, unsigned int nbytes);
471unsigned int comedi_buf_write_alloc_strict(struct comedi_async *async,
ed9eccbe 472 unsigned int nbytes);
d163679c
BP
473unsigned comedi_buf_write_free(struct comedi_async *async, unsigned int nbytes);
474unsigned comedi_buf_read_alloc(struct comedi_async *async, unsigned nbytes);
475unsigned comedi_buf_read_free(struct comedi_async *async, unsigned int nbytes);
476unsigned int comedi_buf_read_n_available(struct comedi_async *async);
477void comedi_buf_memcpy_to(struct comedi_async *async, unsigned int offset,
ed9eccbe 478 const void *source, unsigned int num_bytes);
d163679c 479void comedi_buf_memcpy_from(struct comedi_async *async, unsigned int offset,
ed9eccbe 480 void *destination, unsigned int num_bytes);
d163679c 481static inline unsigned comedi_buf_write_n_allocated(struct comedi_async *async)
ed9eccbe
DS
482{
483 return async->buf_write_alloc_count - async->buf_write_count;
484}
d163679c 485static inline unsigned comedi_buf_read_n_allocated(struct comedi_async *async)
ed9eccbe
DS
486{
487 return async->buf_read_alloc_count - async->buf_read_count;
488}
489
d163679c 490void comedi_reset_async_buf(struct comedi_async *async);
ed9eccbe
DS
491
492static 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
517int comedi_alloc_board_minor(struct device *hardware_device);
518void comedi_free_board_minor(unsigned minor);
34c43922
BP
519int comedi_alloc_subdevice_minor(struct comedi_device *dev, struct comedi_subdevice *s);
520void comedi_free_subdevice_minor(struct comedi_subdevice *s);
ed9eccbe
DS
521int comedi_pci_auto_config(struct pci_dev *pcidev, const char *board_name);
522void comedi_pci_auto_unconfig(struct pci_dev *pcidev);
c28264da
BP
523struct usb_device; /* forward declaration */
524int comedi_usb_auto_config(struct usb_device *usbdev, const char *board_name);
525void comedi_usb_auto_unconfig(struct usb_device *usbdev);
ed9eccbe 526
ed9eccbe 527#include "comedi_rt.h"
ed9eccbe
DS
528
529#endif /* _COMEDIDEV_H */