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