[deliverable/linux.git] / drivers / hid / usbhid / usbhid.h

#ifndef __USBHID_H
#define __USBHID_H

/*
 *  Copyright (c) 1999 Andreas Gal
 *  Copyright (c) 2000-2001 Vojtech Pavlik
 *  Copyright (c) 2006 Jiri Kosina
 */

/*
 * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */

#include <linux/types.h>
#include <linux/slab.h>
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/timer.h>
#include <linux/wait.h>
#include <linux/workqueue.h>
#include <linux/input.h>

/*  API provided by hid-core.c for USB HID drivers */
int usbhid_wait_io(struct hid_device* hid);
void usbhid_close(struct hid_device *hid);
int usbhid_open(struct hid_device *hid);
void usbhid_init_reports(struct hid_device *hid);
void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir);

/* iofl flags */
#define HID_CTRL_RUNNING	1
#define HID_OUT_RUNNING		2
#define HID_IN_RUNNING		3
#define HID_RESET_PENDING	4
#define HID_SUSPENDED		5
#define HID_CLEAR_HALT		6
#define HID_DISCONNECTED	7
#define HID_STARTED		8

/*
 * USB-specific HID struct, to be pointed to
 * from struct hid_device->driver_data
 */

struct usbhid_device {
	struct hid_device *hid;						/* pointer to corresponding HID dev */

	struct usb_interface *intf;                                     /* USB interface */
	int ifnum;                                                      /* USB interface number */

	unsigned int bufsize;                                           /* URB buffer size */

	struct urb *urbin;                                              /* Input URB */
	char *inbuf;                                                    /* Input buffer */
	dma_addr_t inbuf_dma;                                           /* Input buffer dma */
	spinlock_t inlock;                                              /* Input fifo spinlock */

	struct urb *urbctrl;                                            /* Control URB */
	struct usb_ctrlrequest *cr;                                     /* Control request struct */
	dma_addr_t cr_dma;                                              /* Control request struct dma */
	struct hid_control_fifo ctrl[HID_CONTROL_FIFO_SIZE];  		/* Control fifo */
	unsigned char ctrlhead, ctrltail;                               /* Control fifo head & tail */
	char *ctrlbuf;                                                  /* Control buffer */
	dma_addr_t ctrlbuf_dma;                                         /* Control buffer dma */
	spinlock_t ctrllock;                                            /* Control fifo spinlock */

	struct urb *urbout;                                             /* Output URB */
	struct hid_output_fifo out[HID_CONTROL_FIFO_SIZE];              /* Output pipe fifo */
	unsigned char outhead, outtail;                                 /* Output pipe fifo head & tail */
	char *outbuf;                                                   /* Output buffer */
	dma_addr_t outbuf_dma;                                          /* Output buffer dma */
	spinlock_t outlock;                                             /* Output fifo spinlock */

	unsigned long iofl;                                             /* I/O flags (CTRL_RUNNING, OUT_RUNNING) */
	struct timer_list io_retry;                                     /* Retry timer */
	unsigned long stop_retry;                                       /* Time to give up, in jiffies */
	unsigned int retry_delay;                                       /* Delay length in ms */
	struct work_struct reset_work;                                  /* Task context for resets */
	wait_queue_head_t wait;						/* For sleeping */
};

#define	hid_to_usb_dev(hid_dev) \
	container_of(hid_dev->dev.parent->parent, struct usb_device, dev)

#endif
Commit	Line	Data
4916b3a5 JK	1	#ifndef __USBHID_H
	2	#define __USBHID_H
	3
	4	/*
	5	* Copyright (c) 1999 Andreas Gal
	6	* Copyright (c) 2000-2001 Vojtech Pavlik
	7	* Copyright (c) 2006 Jiri Kosina
	8	*/
	9
	10	/*
	11	* This program is free software; you can redistribute it and/or modify
	12	* it under the terms of the GNU General Public License as published by
	13	* the Free Software Foundation; either version 2 of the License, or
	14	* (at your option) any later version.
	15	*
	16	* This program is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	* GNU General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	24	*
	25	*/
	26
	27	#include <linux/types.h>
	28	#include <linux/slab.h>
	29	#include <linux/list.h>
3d5afd32	30	#include <linux/mutex.h>
4916b3a5	31	#include <linux/timer.h>
1d1bdd20	32	#include <linux/wait.h>
4916b3a5 JK	33	#include <linux/workqueue.h>
	34	#include <linux/input.h>
	35
	36	/* API provided by hid-core.c for USB HID drivers */
	37	int usbhid_wait_io(struct hid_device* hid);
	38	void usbhid_close(struct hid_device *hid);
	39	int usbhid_open(struct hid_device *hid);
	40	void usbhid_init_reports(struct hid_device *hid);
	41	void usbhid_submit_report(struct hid_device hid, struct hid_report report, unsigned char dir);
	42
0ed94b33 JS	43	/* iofl flags */
	44	#define HID_CTRL_RUNNING 1
	45	#define HID_OUT_RUNNING 2
	46	#define HID_IN_RUNNING 3
	47	#define HID_RESET_PENDING 4
	48	#define HID_SUSPENDED 5
	49	#define HID_CLEAR_HALT 6
	50	#define HID_DISCONNECTED 7
	51	#define HID_STARTED 8
	52
4916b3a5 JK	53	/*
	54	* USB-specific HID struct, to be pointed to
	55	* from struct hid_device->driver_data
	56	*/
	57
	58	struct usbhid_device {
	59	struct hid_device hid; / pointer to corresponding HID dev */
	60
	61	struct usb_interface intf; / USB interface */
	62	int ifnum; /* USB interface number */
	63
	64	unsigned int bufsize; /* URB buffer size */
	65
	66	struct urb urbin; / Input URB */
	67	char inbuf; / Input buffer */
	68	dma_addr_t inbuf_dma; /* Input buffer dma */
	69	spinlock_t inlock; /* Input fifo spinlock */
	70
	71	struct urb urbctrl; / Control URB */
	72	struct usb_ctrlrequest cr; / Control request struct */
	73	dma_addr_t cr_dma; /* Control request struct dma */
	74	struct hid_control_fifo ctrl[HID_CONTROL_FIFO_SIZE]; /* Control fifo */
	75	unsigned char ctrlhead, ctrltail; /* Control fifo head & tail */
	76	char ctrlbuf; / Control buffer */
	77	dma_addr_t ctrlbuf_dma; /* Control buffer dma */
	78	spinlock_t ctrllock; /* Control fifo spinlock */
	79
	80	struct urb urbout; / Output URB */
f129ea6d	81	struct hid_output_fifo out[HID_CONTROL_FIFO_SIZE]; /* Output pipe fifo */
4916b3a5 JK	82	unsigned char outhead, outtail; /* Output pipe fifo head & tail */
	83	char outbuf; / Output buffer */
	84	dma_addr_t outbuf_dma; /* Output buffer dma */
	85	spinlock_t outlock; /* Output fifo spinlock */
	86
	87	unsigned long iofl; /* I/O flags (CTRL_RUNNING, OUT_RUNNING) */
	88	struct timer_list io_retry; /* Retry timer */
	89	unsigned long stop_retry; /* Time to give up, in jiffies */
	90	unsigned int retry_delay; /* Delay length in ms */
	91	struct work_struct reset_work; /* Task context for resets */
1d1bdd20	92	wait_queue_head_t wait; /* For sleeping */
4916b3a5 JK	93	};
4916b3a5 JK	94
be820975	95	#define hid_to_usb_dev(hid_dev) \
85cdaf52	96	container_of(hid_dev->dev.parent->parent, struct usb_device, dev)
be820975	97
4916b3a5 JK	98	#endif
4916b3a5 JK	99