[mirror_ubuntu-hirsute-kernel.git] / drivers / staging / comedi / comedidev.h

/*
    include/linux/comedidev.h
    header file for kernel-only structures, variables, and constants

    COMEDI - Linux Control and Measurement Device Interface
    Copyright (C) 1997-2000 David A. Schleef <ds@schleef.org>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef _COMEDIDEV_H
#define _COMEDIDEV_H

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/kdev_t.h>
#include <linux/slab.h>
#include <linux/delay.h>
#include <linux/errno.h>
#include <linux/spinlock.h>
#include <linux/mutex.h>
#include <linux/wait.h>
#include <linux/mm.h>
#include <linux/init.h>
#include <linux/vmalloc.h>
#include <linux/dma-mapping.h>
#include <linux/uaccess.h>
#include <linux/io.h>
#include <linux/timer.h>
#include <linux/pci.h>
#include <linux/usb.h>

#include "comedi.h"

#define DPRINTK(format, args...)	do {		\
	if (comedi_debug)				\
		pr_debug("comedi: " format, ## args);	\
} while (0)

#define COMEDI_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
#define COMEDI_VERSION_CODE COMEDI_VERSION(COMEDI_MAJORVERSION, \
	COMEDI_MINORVERSION, COMEDI_MICROVERSION)
#define COMEDI_RELEASE VERSION

/*
 * PCI Vendor IDs not in <linux/pci_ids.h>
 */
#define PCI_VENDOR_ID_KOLTER		0x1001
#define PCI_VENDOR_ID_ICP		0x104c
#define PCI_VENDOR_ID_AMCC		0x10e8
#define PCI_VENDOR_ID_DT		0x1116
#define PCI_VENDOR_ID_IOTECH		0x1616
#define PCI_VENDOR_ID_CONTEC		0x1221
#define PCI_VENDOR_ID_CB		0x1307	/* Measurement Computing */
#define PCI_VENDOR_ID_ADVANTECH		0x13fe
#define PCI_VENDOR_ID_MEILHAUS		0x1402
#define PCI_VENDOR_ID_RTD		0x1435
#define PCI_VENDOR_ID_ADLINK		0x144a
#define PCI_VENDOR_ID_AMPLICON		0x14dc

#define COMEDI_NUM_MINORS 0x100
#define COMEDI_NUM_BOARD_MINORS 0x30
#define COMEDI_FIRST_SUBDEVICE_MINOR COMEDI_NUM_BOARD_MINORS

struct comedi_subdevice {
	struct comedi_device *device;
	int type;
	int n_chan;
	int subdev_flags;
	int len_chanlist;	/* maximum length of channel/gain list */

	void *private;

	struct comedi_async *async;

	void *lock;
	void *busy;
	unsigned runflags;
	spinlock_t spin_lock;

	unsigned int io_bits;

	unsigned int maxdata;	/* if maxdata==0, use list */
	const unsigned int *maxdata_list;	/* list is channel specific */

	unsigned int flags;
	const unsigned int *flaglist;

	unsigned int settling_time_0;

	const struct comedi_lrange *range_table;
	const struct comedi_lrange *const *range_table_list;

	unsigned int *chanlist;	/* driver-owned chanlist (not used) */

	int (*insn_read) (struct comedi_device *, struct comedi_subdevice *,
			  struct comedi_insn *, unsigned int *);
	int (*insn_write) (struct comedi_device *, struct comedi_subdevice *,
			   struct comedi_insn *, unsigned int *);
	int (*insn_bits) (struct comedi_device *, struct comedi_subdevice *,
			  struct comedi_insn *, unsigned int *);
	int (*insn_config) (struct comedi_device *, struct comedi_subdevice *,
			    struct comedi_insn *, unsigned int *);

	int (*do_cmd) (struct comedi_device *, struct comedi_subdevice *);
	int (*do_cmdtest) (struct comedi_device *, struct comedi_subdevice *,
			   struct comedi_cmd *);
	int (*poll) (struct comedi_device *, struct comedi_subdevice *);
	int (*cancel) (struct comedi_device *, struct comedi_subdevice *);
	/* int (*do_lock)(struct comedi_device *, struct comedi_subdevice *); */
	/* int (*do_unlock)(struct comedi_device *, \
			struct comedi_subdevice *); */

	/* called when the buffer changes */
	int (*buf_change) (struct comedi_device *dev,
			   struct comedi_subdevice *s, unsigned long new_size);

	void (*munge) (struct comedi_device *dev, struct comedi_subdevice *s,
		       void *data, unsigned int num_bytes,
		       unsigned int start_chan_index);
	enum dma_data_direction async_dma_dir;

	unsigned int state;

	struct device *class_dev;
	int minor;
};

struct comedi_buf_page {
	void *virt_addr;
	dma_addr_t dma_addr;
};

struct comedi_async {
	struct comedi_subdevice *subdevice;

	void *prealloc_buf;	/* pre-allocated buffer */
	unsigned int prealloc_bufsz;	/* buffer size, in bytes */
	/* virtual and dma address of each page */
	struct comedi_buf_page *buf_page_list;
	unsigned n_buf_pages;	/* num elements in buf_page_list */

	unsigned int max_bufsize;	/* maximum buffer size, bytes */
	/* current number of mmaps of prealloc_buf */
	unsigned int mmap_count;

	/* byte count for writer (write completed) */
	unsigned int buf_write_count;
	/* byte count for writer (allocated for writing) */
	unsigned int buf_write_alloc_count;
	/* byte count for reader (read completed) */
	unsigned int buf_read_count;
	/* byte count for reader (allocated for reading) */
	unsigned int buf_read_alloc_count;

	unsigned int buf_write_ptr;	/* buffer marker for writer */
	unsigned int buf_read_ptr;	/* buffer marker for reader */

	unsigned int cur_chan;	/* useless channel marker for interrupt */
	/* number of bytes that have been received for current scan */
	unsigned int scan_progress;
	/* keeps track of where we are in chanlist as for munging */
	unsigned int munge_chan;
	/* number of bytes that have been munged */
	unsigned int munge_count;
	/* buffer marker for munging */
	unsigned int munge_ptr;

	unsigned int events;	/* events that have occurred */

	struct comedi_cmd cmd;

	wait_queue_head_t wait_head;

	/* callback stuff */
	unsigned int cb_mask;
	int (*cb_func) (unsigned int flags, void *);
	void *cb_arg;

	int (*inttrig) (struct comedi_device *dev, struct comedi_subdevice *s,
			unsigned int x);
};

struct comedi_driver {
	struct comedi_driver *next;

	const char *driver_name;
	struct module *module;
	int (*attach) (struct comedi_device *, struct comedi_devconfig *);
	void (*detach) (struct comedi_device *);
	int (*auto_attach) (struct comedi_device *, unsigned long);

	/* number of elements in board_name and board_id arrays */
	unsigned int num_names;
	const char *const *board_name;
	/* offset in bytes from one board name pointer to the next */
	int offset;
};

struct comedi_device {
	int use_count;
	struct comedi_driver *driver;
	void *private;

	struct device *class_dev;
	int minor;
	/* hw_dev is passed to dma_alloc_coherent when allocating async buffers
	 * for subdevices that have async_dma_dir set to something other than
	 * DMA_NONE */
	struct device *hw_dev;

	const char *board_name;
	const void *board_ptr;
	int attached;
	spinlock_t spinlock;
	struct mutex mutex;
	int in_request_module;

	int n_subdevices;
	struct comedi_subdevice *subdevices;

	/* dumb */
	unsigned long iobase;
	unsigned int irq;

	struct comedi_subdevice *read_subdev;
	struct comedi_subdevice *write_subdev;

	struct fasync_struct *async_queue;

	int (*open) (struct comedi_device *dev);
	void (*close) (struct comedi_device *dev);
};

static inline const void *comedi_board(const struct comedi_device *dev)
{
	return dev->board_ptr;
}

struct comedi_device_file_info {
	struct comedi_device *device;
	struct comedi_subdevice *read_subdevice;
	struct comedi_subdevice *write_subdevice;
	struct device *hardware_device;
};

#ifdef CONFIG_COMEDI_DEBUG
extern int comedi_debug;
#else
static const int comedi_debug;
#endif

/*
 * function prototypes
 */

void comedi_event(struct comedi_device *dev, struct comedi_subdevice *s);
void comedi_error(const struct comedi_device *dev, const char *s);

/* we can expand the number of bits used to encode devices/subdevices into
 the minor number soon, after more distros support > 8 bit minor numbers
 (like after Debian Etch gets released) */
enum comedi_minor_bits {
	COMEDI_DEVICE_MINOR_MASK = 0xf,
	COMEDI_SUBDEVICE_MINOR_MASK = 0xf0
};
static const unsigned COMEDI_SUBDEVICE_MINOR_SHIFT = 4;
static const unsigned COMEDI_SUBDEVICE_MINOR_OFFSET = 1;

struct comedi_device_file_info *comedi_get_device_file_info(unsigned minor);

static inline struct comedi_subdevice *comedi_get_read_subdevice(
	const struct comedi_device_file_info *info)
{
	if (info->read_subdevice)
		return info->read_subdevice;
	if (info->device == NULL)
		return NULL;
	return info->device->read_subdev;
}

static inline struct comedi_subdevice *comedi_get_write_subdevice(
	const struct comedi_device_file_info *info)
{
	if (info->write_subdevice)
		return info->write_subdevice;
	if (info->device == NULL)
		return NULL;
	return info->device->write_subdev;
}

int comedi_alloc_subdevices(struct comedi_device *, int);

void comedi_device_detach(struct comedi_device *dev);
int comedi_device_attach(struct comedi_device *dev,
			 struct comedi_devconfig *it);
int comedi_driver_register(struct comedi_driver *);
int comedi_driver_unregister(struct comedi_driver *);

/**
 * module_comedi_driver() - Helper macro for registering a comedi driver
 * @__comedi_driver: comedi_driver struct
 *
 * Helper macro for comedi drivers which do not do anything special in module
 * init/exit. This eliminates a lot of boilerplate. Each module may only use
 * this macro once, and calling it replaces module_init() and module_exit().
 */
#define module_comedi_driver(__comedi_driver) \
	module_driver(__comedi_driver, comedi_driver_register, \
			comedi_driver_unregister)

int comedi_pci_enable(struct pci_dev *, const char *);
void comedi_pci_disable(struct pci_dev *);

int comedi_pci_driver_register(struct comedi_driver *, struct pci_driver *);
void comedi_pci_driver_unregister(struct comedi_driver *, struct pci_driver *);

/**
 * module_comedi_pci_driver() - Helper macro for registering a comedi PCI driver
 * @__comedi_driver: comedi_driver struct
 * @__pci_driver: pci_driver struct
 *
 * Helper macro for comedi PCI drivers which do not do anything special
 * in module init/exit. This eliminates a lot of boilerplate. Each
 * module may only use this macro once, and calling it replaces
 * module_init() and module_exit()
 */
#define module_comedi_pci_driver(__comedi_driver, __pci_driver) \
	module_driver(__comedi_driver, comedi_pci_driver_register, \
			comedi_pci_driver_unregister, &(__pci_driver))

struct usb_driver;

int comedi_usb_driver_register(struct comedi_driver *, struct usb_driver *);
void comedi_usb_driver_unregister(struct comedi_driver *, struct usb_driver *);

/**
 * module_comedi_usb_driver() - Helper macro for registering a comedi USB driver
 * @__comedi_driver: comedi_driver struct
 * @__usb_driver: usb_driver struct
 *
 * Helper macro for comedi USB drivers which do not do anything special
 * in module init/exit. This eliminates a lot of boilerplate. Each
 * module may only use this macro once, and calling it replaces
 * module_init() and module_exit()
 */
#define module_comedi_usb_driver(__comedi_driver, __usb_driver) \
	module_driver(__comedi_driver, comedi_usb_driver_register, \
			comedi_usb_driver_unregister, &(__usb_driver))

void init_polling(void);
void cleanup_polling(void);
void start_polling(struct comedi_device *);
void stop_polling(struct comedi_device *);

#ifdef CONFIG_PROC_FS
void comedi_proc_init(void);
void comedi_proc_cleanup(void);
#else
static inline void comedi_proc_init(void)
{
}

static inline void comedi_proc_cleanup(void)
{
}
#endif

/* subdevice runflags */
enum subdevice_runflags {
	SRF_USER = 0x00000001,
	SRF_RT = 0x00000002,
	/* indicates an COMEDI_CB_ERROR event has occurred since the last
	 * command was started */
	SRF_ERROR = 0x00000004,
	SRF_RUNNING = 0x08000000
};

int comedi_check_chanlist(struct comedi_subdevice *s,
			  int n,
			  unsigned int *chanlist);
unsigned comedi_get_subdevice_runflags(struct comedi_subdevice *s);

/* range stuff */

#define RANGE(a, b)		{(a)*1e6, (b)*1e6, 0}
#define RANGE_ext(a, b)		{(a)*1e6, (b)*1e6, RF_EXTERNAL}
#define RANGE_mA(a, b)		{(a)*1e6, (b)*1e6, UNIT_mA}
#define RANGE_unitless(a, b)	{(a)*1e6, (b)*1e6, 0}
#define BIP_RANGE(a)		{-(a)*1e6, (a)*1e6, 0}
#define UNI_RANGE(a)		{0, (a)*1e6, 0}

extern const struct comedi_lrange range_bipolar10;
extern const struct comedi_lrange range_bipolar5;
extern const struct comedi_lrange range_bipolar2_5;
extern const struct comedi_lrange range_unipolar10;
extern const struct comedi_lrange range_unipolar5;
extern const struct comedi_lrange range_unknown;

#define range_digital		range_unipolar5

#if __GNUC__ >= 3
#define GCC_ZERO_LENGTH_ARRAY
#else
#define GCC_ZERO_LENGTH_ARRAY 0
#endif

struct comedi_lrange {
	int length;
	struct comedi_krange range[GCC_ZERO_LENGTH_ARRAY];
};

/* some silly little inline functions */

static inline unsigned int bytes_per_sample(const struct comedi_subdevice *subd)
{
	if (subd->subdev_flags & SDF_LSAMPL)
		return sizeof(unsigned int);
	else
		return sizeof(short);
}

/* must be used in attach to set dev->hw_dev if you wish to dma directly
into comedi's buffer */
static inline void comedi_set_hw_dev(struct comedi_device *dev,
				     struct device *hw_dev)
{
	if (dev->hw_dev == hw_dev)
		return;
	if (dev->hw_dev)
		put_device(dev->hw_dev);
	dev->hw_dev = hw_dev;
	if (dev->hw_dev) {
		dev->hw_dev = get_device(dev->hw_dev);
		BUG_ON(dev->hw_dev == NULL);
	}
}

static inline struct pci_dev *comedi_to_pci_dev(struct comedi_device *dev)
{
	return dev->hw_dev ? to_pci_dev(dev->hw_dev) : NULL;
}

static inline struct usb_interface *
comedi_to_usb_interface(struct comedi_device *dev)
{
	return dev->hw_dev ? to_usb_interface(dev->hw_dev) : NULL;
}

int comedi_buf_put(struct comedi_async *async, short x);
int comedi_buf_get(struct comedi_async *async, short *x);

unsigned int comedi_buf_write_n_available(struct comedi_async *async);
unsigned int comedi_buf_write_alloc(struct comedi_async *async,
				    unsigned int nbytes);
unsigned int comedi_buf_write_alloc_strict(struct comedi_async *async,
					   unsigned int nbytes);
unsigned comedi_buf_write_free(struct comedi_async *async, unsigned int nbytes);
unsigned comedi_buf_read_alloc(struct comedi_async *async, unsigned nbytes);
unsigned comedi_buf_read_free(struct comedi_async *async, unsigned int nbytes);
unsigned int comedi_buf_read_n_available(struct comedi_async *async);
void comedi_buf_memcpy_to(struct comedi_async *async, unsigned int offset,
			  const void *source, unsigned int num_bytes);
void comedi_buf_memcpy_from(struct comedi_async *async, unsigned int offset,
			    void *destination, unsigned int num_bytes);
static inline unsigned comedi_buf_write_n_allocated(struct comedi_async *async)
{
	return async->buf_write_alloc_count - async->buf_write_count;
}

static inline unsigned comedi_buf_read_n_allocated(struct comedi_async *async)
{
	return async->buf_read_alloc_count - async->buf_read_count;
}

static inline void *comedi_aux_data(int options[], int n)
{
	unsigned long address;
	unsigned long addressLow;
	int bit_shift;
	if (sizeof(int) >= sizeof(void *))
		address = options[COMEDI_DEVCONF_AUX_DATA_LO];
	else {
		address = options[COMEDI_DEVCONF_AUX_DATA_HI];
		bit_shift = sizeof(int) * 8;
		address <<= bit_shift;
		addressLow = options[COMEDI_DEVCONF_AUX_DATA_LO];
		addressLow &= (1UL << bit_shift) - 1;
		address |= addressLow;
	}
	if (n >= 1)
		address += options[COMEDI_DEVCONF_AUX_DATA0_LENGTH];
	if (n >= 2)
		address += options[COMEDI_DEVCONF_AUX_DATA1_LENGTH];
	if (n >= 3)
		address += options[COMEDI_DEVCONF_AUX_DATA2_LENGTH];
	BUG_ON(n > 3);
	return (void *)address;
}

int comedi_alloc_subdevice_minor(struct comedi_device *dev,
				 struct comedi_subdevice *s);
void comedi_free_subdevice_minor(struct comedi_subdevice *s);
int comedi_auto_config(struct device *hardware_device,
		       struct comedi_driver *driver, unsigned long context);
void comedi_auto_unconfig(struct device *hardware_device);

static inline int comedi_pci_auto_config(struct pci_dev *pcidev,
					 struct comedi_driver *driver)
{
	return comedi_auto_config(&pcidev->dev, driver, 0);
}

static inline void comedi_pci_auto_unconfig(struct pci_dev *pcidev)
{
	comedi_auto_unconfig(&pcidev->dev);
}

static inline int comedi_usb_auto_config(struct usb_interface *intf,
					 struct comedi_driver *driver)
{
	return comedi_auto_config(&intf->dev, driver, 0);
}

static inline void comedi_usb_auto_unconfig(struct usb_interface *intf)
{
	comedi_auto_unconfig(&intf->dev);
}

#endif /* _COMEDIDEV_H */
Commit	Line	Data
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>
ed9eccbe DS	30	#include <linux/slab.h>
f9c51375	31	#include <linux/delay.h>
ed9eccbe DS	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>
ed9eccbe	39	#include <linux/dma-mapping.h>
e0dcef71 GKH	40	#include <linux/uaccess.h>
e0dcef71 GKH	41	#include <linux/io.h>
c7a5d707	42	#include <linux/timer.h>
55c03cff	43	#include <linux/pci.h>
0a577b82	44	#include <linux/usb.h>
ed9eccbe DS	45
	46	#include "comedi.h"
	47
e0dcef71 GKH	48	#define DPRINTK(format, args...) do { \
e0dcef71 GKH	49	if (comedi_debug) \
4f870fe6	50	pr_debug("comedi: " format, ## args); \
e0dcef71	51	} while (0)
ed9eccbe	52
e0dcef71	53	#define COMEDI_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c))
62eeae93 SW	54	#define COMEDI_VERSION_CODE COMEDI_VERSION(COMEDI_MAJORVERSION, \
62eeae93 SW	55	COMEDI_MINORVERSION, COMEDI_MICROVERSION)
ed9eccbe DS	56	#define COMEDI_RELEASE VERSION
ed9eccbe DS	57
cb3e9d86 HS	58	/*
	59	* PCI Vendor IDs not in <linux/pci_ids.h>
	60	*/
0d374622	61	#define PCI_VENDOR_ID_KOLTER 0x1001
ed9eccbe	62	#define PCI_VENDOR_ID_ICP 0x104c
26853312	63	#define PCI_VENDOR_ID_AMCC 0x10e8
f656ef5b	64	#define PCI_VENDOR_ID_DT 0x1116
34f8d208	65	#define PCI_VENDOR_ID_IOTECH 0x1616
ed9eccbe	66	#define PCI_VENDOR_ID_CONTEC 0x1221
cb3e9d86	67	#define PCI_VENDOR_ID_CB 0x1307 /* Measurement Computing */
12f07ba5	68	#define PCI_VENDOR_ID_ADVANTECH 0x13fe
b77d93a0	69	#define PCI_VENDOR_ID_MEILHAUS 0x1402
50d3c3f5	70	#define PCI_VENDOR_ID_RTD 0x1435
cb3e9d86	71	#define PCI_VENDOR_ID_ADLINK 0x144a
2847ff5d	72	#define PCI_VENDOR_ID_AMPLICON 0x14dc
ed9eccbe DS	73
ed9eccbe DS	74	#define COMEDI_NUM_MINORS 0x100
ed9eccbe DS	75	#define COMEDI_NUM_BOARD_MINORS 0x30
	76	#define COMEDI_FIRST_SUBDEVICE_MINOR COMEDI_NUM_BOARD_MINORS
	77
34c43922	78	struct comedi_subdevice {
71b5f4f1	79	struct comedi_device *device;
ed9eccbe DS	80	int type;
ed9eccbe DS	81	int n_chan;
baf22b64	82	int subdev_flags;
ed9eccbe DS	83	int len_chanlist; /* maximum length of channel/gain list */
	84
	85	void *private;
	86
d163679c	87	struct comedi_async *async;
ed9eccbe DS	88
	89	void *lock;
	90	void *busy;
	91	unsigned runflags;
	92	spinlock_t spin_lock;
	93
d4a7dc85	94	unsigned int io_bits;
ed9eccbe	95
790c5541 BP	96	unsigned int maxdata; /* if maxdata==0, use list */
790c5541 BP	97	const unsigned int maxdata_list; / list is channel specific */
ed9eccbe DS	98
	99	unsigned int flags;
	100	const unsigned int *flaglist;
	101
	102	unsigned int settling_time_0;
	103
9ced1de6 BP	104	const struct comedi_lrange *range_table;
9ced1de6 BP	105	const struct comedi_lrange const range_table_list;
ed9eccbe DS	106
	107	unsigned int chanlist; / driver-owned chanlist (not used) */
	108
0a85b6f0 MT	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 );
ed9eccbe	117
34c43922	118	int (do_cmd) (struct comedi_device , struct comedi_subdevice *);
0a85b6f0 MT	119	int (do_cmdtest) (struct comedi_device , struct comedi_subdevice *,
0a85b6f0 MT	120	struct comedi_cmd *);
34c43922 BP	121	int (poll) (struct comedi_device , struct comedi_subdevice *);
34c43922 BP	122	int (cancel) (struct comedi_device , struct comedi_subdevice *);
62eeae93 SW	123	/* int (do_lock)(struct comedi_device , struct comedi_subdevice ); /
	124	/* int (do_unlock)(struct comedi_device , \
	125	struct comedi_subdevice ); /
ed9eccbe DS	126
ed9eccbe DS	127	/* called when the buffer changes */
62eeae93 SW	128	int (buf_change) (struct comedi_device dev,
62eeae93 SW	129	struct comedi_subdevice *s, unsigned long new_size);
ed9eccbe	130
62eeae93	131	void (munge) (struct comedi_device dev, struct comedi_subdevice *s,
0a85b6f0 MT	132	void *data, unsigned int num_bytes,
0a85b6f0 MT	133	unsigned int start_chan_index);
ed9eccbe DS	134	enum dma_data_direction async_dma_dir;
	135
	136	unsigned int state;
	137
0bfbbe8f	138	struct device *class_dev;
ed9eccbe DS	139	int minor;
	140	};
	141
	142	struct comedi_buf_page {
	143	void *virt_addr;
	144	dma_addr_t dma_addr;
	145	};
	146
d163679c	147	struct comedi_async {
34c43922	148	struct comedi_subdevice *subdevice;
ed9eccbe DS	149
	150	void prealloc_buf; / pre-allocated buffer */
	151	unsigned int prealloc_bufsz; /* buffer size, in bytes */
62eeae93 SW	152	/* virtual and dma address of each page */
62eeae93 SW	153	struct comedi_buf_page *buf_page_list;
ed9eccbe DS	154	unsigned n_buf_pages; /* num elements in buf_page_list */
	155
	156	unsigned int max_bufsize; /* maximum buffer size, bytes */
62eeae93 SW	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;
ed9eccbe DS	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
ea6d0d4c	184	struct comedi_cmd cmd;
ed9eccbe DS	185
	186	wait_queue_head_t wait_head;
	187
e0dcef71	188	/* callback stuff */
ed9eccbe DS	189	unsigned int cb_mask;
	190	int (cb_func) (unsigned int flags, void );
	191	void *cb_arg;
	192
62eeae93	193	int (inttrig) (struct comedi_device dev, struct comedi_subdevice *s,
e0dcef71	194	unsigned int x);
ed9eccbe DS	195	};
ed9eccbe DS	196
139dfbdf BP	197	struct comedi_driver {
139dfbdf BP	198	struct comedi_driver *next;
ed9eccbe DS	199
	200	const char *driver_name;
	201	struct module *module;
0707bb04	202	int (attach) (struct comedi_device , struct comedi_devconfig *);
484ecc95	203	void (detach) (struct comedi_device );
8ed705af	204	int (auto_attach) (struct comedi_device , unsigned long);
ed9eccbe DS	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
71b5f4f1	213	struct comedi_device {
ed9eccbe	214	int use_count;
139dfbdf	215	struct comedi_driver *driver;
ed9eccbe DS	216	void *private;
ed9eccbe DS	217
0bfbbe8f	218	struct device *class_dev;
ed9eccbe	219	int minor;
e0dcef71 GKH	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 */
ed9eccbe DS	223	struct device *hw_dev;
	224
	225	const char *board_name;
	226	const void *board_ptr;
	227	int attached;
ed9eccbe DS	228	spinlock_t spinlock;
	229	struct mutex mutex;
	230	int in_request_module;
	231
	232	int n_subdevices;
34c43922	233	struct comedi_subdevice *subdevices;
ed9eccbe DS	234
	235	/* dumb */
	236	unsigned long iobase;
	237	unsigned int irq;
	238
34c43922 BP	239	struct comedi_subdevice *read_subdev;
34c43922 BP	240	struct comedi_subdevice *write_subdev;
ed9eccbe DS	241
	242	struct fasync_struct *async_queue;
	243
3c17ba07	244	int (open) (struct comedi_device dev);
62eeae93	245	void (close) (struct comedi_device dev);
ed9eccbe DS	246	};
ed9eccbe DS	247
4dba6c02	248	static inline const void comedi_board(const struct comedi_device dev)
37859f88 HS	249	{
	250	return dev->board_ptr;
	251	}
	252
ed9eccbe	253	struct comedi_device_file_info {
71b5f4f1	254	struct comedi_device *device;
34c43922 BP	255	struct comedi_subdevice *read_subdevice;
34c43922 BP	256	struct comedi_subdevice *write_subdevice;
c43435d7	257	struct device *hardware_device;
ed9eccbe DS	258	};
	259
	260	#ifdef CONFIG_COMEDI_DEBUG
	261	extern int comedi_debug;
	262	#else
e0dcef71	263	static const int comedi_debug;
ed9eccbe DS	264	#endif
	265
	266	/*
	267	* function prototypes
	268	*/
	269
34c43922	270	void comedi_event(struct comedi_device dev, struct comedi_subdevice s);
71b5f4f1	271	void comedi_error(const struct comedi_device dev, const char s);
ed9eccbe DS	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
e0dcef71	283	struct comedi_device_file_info *comedi_get_device_file_info(unsigned minor);
ed9eccbe	284
62eeae93 SW	285	static inline struct comedi_subdevice *comedi_get_read_subdevice(
62eeae93 SW	286	const struct comedi_device_file_info *info)
ed9eccbe	287	{
e0dcef71 GKH	288	if (info->read_subdevice)
	289	return info->read_subdevice;
	290	if (info->device == NULL)
	291	return NULL;
ed9eccbe DS	292	return info->device->read_subdev;
	293	}
	294
62eeae93 SW	295	static inline struct comedi_subdevice *comedi_get_write_subdevice(
62eeae93 SW	296	const struct comedi_device_file_info *info)
ed9eccbe	297	{
e0dcef71 GKH	298	if (info->write_subdevice)
	299	return info->write_subdevice;
	300	if (info->device == NULL)
	301	return NULL;
ed9eccbe DS	302	return info->device->write_subdev;
	303	}
	304
8b9ba6e5	305	int comedi_alloc_subdevices(struct comedi_device *, int);
2f0b9d08	306
71b5f4f1	307	void comedi_device_detach(struct comedi_device *dev);
0a85b6f0 MT	308	int comedi_device_attach(struct comedi_device *dev,
0a85b6f0 MT	309	struct comedi_devconfig *it);
139dfbdf BP	310	int comedi_driver_register(struct comedi_driver *);
139dfbdf BP	311	int comedi_driver_unregister(struct comedi_driver *);
ed9eccbe	312
20416257 HS	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
55c03cff HS	325	int comedi_pci_enable(struct pci_dev , const char );
55c03cff HS	326	void comedi_pci_disable(struct pci_dev *);
d4899c6f HS	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
64255031 HS	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
ed9eccbe DS	364	void init_polling(void);
ed9eccbe DS	365	void cleanup_polling(void);
71b5f4f1 BP	366	void start_polling(struct comedi_device *);
71b5f4f1 BP	367	void stop_polling(struct comedi_device *);
ed9eccbe	368
ed9eccbe DS	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	}
0a85b6f0	376
ed9eccbe DS	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,
e0dcef71 GKH	386	/* indicates an COMEDI_CB_ERROR event has occurred since the last
e0dcef71 GKH	387	* command was started */
ed9eccbe DS	388	SRF_ERROR = 0x00000004,
	389	SRF_RUNNING = 0x08000000
	390	};
	391
5e220112 MR	392	int comedi_check_chanlist(struct comedi_subdevice *s,
	393	int n,
	394	unsigned int *chanlist);
34c43922	395	unsigned comedi_get_subdevice_runflags(struct comedi_subdevice *s);
ed9eccbe DS	396
	397	/* range stuff */
	398
e0dcef71 GKH	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}
baf22b64	402	#define RANGE_unitless(a, b) {(a)1e6, (b)1e6, 0}
e0dcef71 GKH	403	#define BIP_RANGE(a) {-(a)1e6, (a)1e6, 0}
e0dcef71 GKH	404	#define UNI_RANGE(a) {0, (a)*1e6, 0}
ed9eccbe	405
9ced1de6 BP	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;
ed9eccbe DS	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
9ced1de6	421	struct comedi_lrange {
ed9eccbe	422	int length;
1f6325d6	423	struct comedi_krange range[GCC_ZERO_LENGTH_ARRAY];
ed9eccbe DS	424	};
	425
	426	/* some silly little inline functions */
	427
34c43922	428	static inline unsigned int bytes_per_sample(const struct comedi_subdevice *subd)
ed9eccbe DS	429	{
ed9eccbe DS	430	if (subd->subdev_flags & SDF_LSAMPL)
790c5541	431	return sizeof(unsigned int);
ed9eccbe	432	else
790c5541	433	return sizeof(short);
ed9eccbe DS	434	}
	435
	436	/* must be used in attach to set dev->hw_dev if you wish to dma directly
	437	into comedi's buffer */
0a85b6f0 MT	438	static inline void comedi_set_hw_dev(struct comedi_device *dev,
0a85b6f0 MT	439	struct device *hw_dev)
ed9eccbe	440	{
0a7717df IA	441	if (dev->hw_dev == hw_dev)
0a7717df IA	442	return;
e0dcef71	443	if (dev->hw_dev)
ed9eccbe	444	put_device(dev->hw_dev);
ed9eccbe DS	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
ddb01367 HS	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
0a577b82 IA	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
d163679c BP	463	int comedi_buf_put(struct comedi_async *async, short x);
d163679c BP	464	int comedi_buf_get(struct comedi_async async, short x);
ed9eccbe	465
d163679c	466	unsigned int comedi_buf_write_n_available(struct comedi_async *async);
0a85b6f0 MT	467	unsigned int comedi_buf_write_alloc(struct comedi_async *async,
0a85b6f0 MT	468	unsigned int nbytes);
d163679c	469	unsigned int comedi_buf_write_alloc_strict(struct comedi_async *async,
0a85b6f0	470	unsigned int nbytes);
d163679c BP	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,
0a85b6f0	476	const void *source, unsigned int num_bytes);
d163679c	477	void comedi_buf_memcpy_from(struct comedi_async *async, unsigned int offset,
0a85b6f0	478	void *destination, unsigned int num_bytes);
d163679c	479	static inline unsigned comedi_buf_write_n_allocated(struct comedi_async *async)
ed9eccbe DS	480	{
	481	return async->buf_write_alloc_count - async->buf_write_count;
	482	}
0a85b6f0	483
d163679c	484	static inline unsigned comedi_buf_read_n_allocated(struct comedi_async *async)
ed9eccbe DS	485	{
	486	return async->buf_read_alloc_count - async->buf_read_count;
	487	}
	488
ed9eccbe DS	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
0a85b6f0 MT	514	int comedi_alloc_subdevice_minor(struct comedi_device *dev,
0a85b6f0 MT	515	struct comedi_subdevice *s);
34c43922	516	void comedi_free_subdevice_minor(struct comedi_subdevice *s);
8ed705af IA	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);
581a7dde IA	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	}
ed9eccbe	542
ed9eccbe	543	#endif /* _COMEDIDEV_H */