Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[sfrench/cifs-2.6.git] / drivers / hid / usbhid / usbhid.h
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>
30 #include <linux/mutex.h>
31 #include <linux/timer.h>
32 #include <linux/wait.h>
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
42 (struct hid_device *hid, struct hid_report *report, unsigned char dir);
43 int usbhid_get_power(struct hid_device *hid);
44 void usbhid_put_power(struct hid_device *hid);
45
46 /* iofl flags */
47 #define HID_CTRL_RUNNING        1
48 #define HID_OUT_RUNNING         2
49 #define HID_IN_RUNNING          3
50 #define HID_RESET_PENDING       4
51 #define HID_SUSPENDED           5
52 #define HID_CLEAR_HALT          6
53 #define HID_DISCONNECTED        7
54 #define HID_STARTED             8
55 #define HID_REPORTED_IDLE       9
56 #define HID_KEYS_PRESSED        10
57 #define HID_LED_ON              11
58
59 /*
60  * USB-specific HID struct, to be pointed to
61  * from struct hid_device->driver_data
62  */
63
64 struct usbhid_device {
65         struct hid_device *hid;                                         /* pointer to corresponding HID dev */
66
67         struct usb_interface *intf;                                     /* USB interface */
68         int ifnum;                                                      /* USB interface number */
69
70         unsigned int bufsize;                                           /* URB buffer size */
71
72         struct urb *urbin;                                              /* Input URB */
73         char *inbuf;                                                    /* Input buffer */
74         dma_addr_t inbuf_dma;                                           /* Input buffer dma */
75
76         struct urb *urbctrl;                                            /* Control URB */
77         struct usb_ctrlrequest *cr;                                     /* Control request struct */
78         dma_addr_t cr_dma;                                              /* Control request struct dma */
79         struct hid_control_fifo ctrl[HID_CONTROL_FIFO_SIZE];            /* Control fifo */
80         unsigned char ctrlhead, ctrltail;                               /* Control fifo head & tail */
81         char *ctrlbuf;                                                  /* Control buffer */
82         dma_addr_t ctrlbuf_dma;                                         /* Control buffer dma */
83
84         struct urb *urbout;                                             /* Output URB */
85         struct hid_output_fifo out[HID_CONTROL_FIFO_SIZE];              /* Output pipe fifo */
86         unsigned char outhead, outtail;                                 /* Output pipe fifo head & tail */
87         char *outbuf;                                                   /* Output buffer */
88         dma_addr_t outbuf_dma;                                          /* Output buffer dma */
89
90         spinlock_t lock;                                                /* fifo spinlock */
91         unsigned long iofl;                                             /* I/O flags (CTRL_RUNNING, OUT_RUNNING) */
92         struct timer_list io_retry;                                     /* Retry timer */
93         unsigned long stop_retry;                                       /* Time to give up, in jiffies */
94         unsigned int retry_delay;                                       /* Delay length in ms */
95         struct work_struct reset_work;                                  /* Task context for resets */
96         struct work_struct restart_work;                                /* waking up for output to be done in a task */
97         wait_queue_head_t wait;                                         /* For sleeping */
98         int ledcount;                                                   /* counting the number of active leds */
99 };
100
101 #define hid_to_usb_dev(hid_dev) \
102         container_of(hid_dev->dev.parent->parent, struct usb_device, dev)
103
104 #endif
105