xref: /openbmc/linux/drivers/hid/usbhid/usbhid.h (revision f129ea6d)
16db3dfefSJiri Kosina #ifndef __USBHID_H
26db3dfefSJiri Kosina #define __USBHID_H
36db3dfefSJiri Kosina 
46db3dfefSJiri Kosina /*
56db3dfefSJiri Kosina  *  Copyright (c) 1999 Andreas Gal
66db3dfefSJiri Kosina  *  Copyright (c) 2000-2001 Vojtech Pavlik
76db3dfefSJiri Kosina  *  Copyright (c) 2006 Jiri Kosina
86db3dfefSJiri Kosina  */
96db3dfefSJiri Kosina 
106db3dfefSJiri Kosina /*
116db3dfefSJiri Kosina  * This program is free software; you can redistribute it and/or modify
126db3dfefSJiri Kosina  * it under the terms of the GNU General Public License as published by
136db3dfefSJiri Kosina  * the Free Software Foundation; either version 2 of the License, or
146db3dfefSJiri Kosina  * (at your option) any later version.
156db3dfefSJiri Kosina  *
166db3dfefSJiri Kosina  * This program is distributed in the hope that it will be useful,
176db3dfefSJiri Kosina  * but WITHOUT ANY WARRANTY; without even the implied warranty of
186db3dfefSJiri Kosina  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
196db3dfefSJiri Kosina  * GNU General Public License for more details.
206db3dfefSJiri Kosina  *
216db3dfefSJiri Kosina  * You should have received a copy of the GNU General Public License
226db3dfefSJiri Kosina  * along with this program; if not, write to the Free Software
236db3dfefSJiri Kosina  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
246db3dfefSJiri Kosina  *
256db3dfefSJiri Kosina  */
266db3dfefSJiri Kosina 
276db3dfefSJiri Kosina #include <linux/types.h>
286db3dfefSJiri Kosina #include <linux/slab.h>
296db3dfefSJiri Kosina #include <linux/list.h>
306db3dfefSJiri Kosina #include <linux/timer.h>
311d1bdd20SJiri Slaby #include <linux/wait.h>
326db3dfefSJiri Kosina #include <linux/workqueue.h>
336db3dfefSJiri Kosina #include <linux/input.h>
346db3dfefSJiri Kosina 
356db3dfefSJiri Kosina /*  API provided by hid-core.c for USB HID drivers */
366db3dfefSJiri Kosina int usbhid_wait_io(struct hid_device* hid);
376db3dfefSJiri Kosina void usbhid_close(struct hid_device *hid);
386db3dfefSJiri Kosina int usbhid_open(struct hid_device *hid);
396db3dfefSJiri Kosina void usbhid_init_reports(struct hid_device *hid);
406db3dfefSJiri Kosina void usbhid_submit_report(struct hid_device *hid, struct hid_report *report, unsigned char dir);
416db3dfefSJiri Kosina 
426db3dfefSJiri Kosina /*
436db3dfefSJiri Kosina  * USB-specific HID struct, to be pointed to
446db3dfefSJiri Kosina  * from struct hid_device->driver_data
456db3dfefSJiri Kosina  */
466db3dfefSJiri Kosina 
476db3dfefSJiri Kosina struct usbhid_device {
486db3dfefSJiri Kosina 	struct hid_device *hid;						/* pointer to corresponding HID dev */
496db3dfefSJiri Kosina 
506db3dfefSJiri Kosina 	struct usb_interface *intf;                                     /* USB interface */
516db3dfefSJiri Kosina 	int ifnum;                                                      /* USB interface number */
526db3dfefSJiri Kosina 
536db3dfefSJiri Kosina 	unsigned int bufsize;                                           /* URB buffer size */
546db3dfefSJiri Kosina 
556db3dfefSJiri Kosina 	struct urb *urbin;                                              /* Input URB */
566db3dfefSJiri Kosina 	char *inbuf;                                                    /* Input buffer */
576db3dfefSJiri Kosina 	dma_addr_t inbuf_dma;                                           /* Input buffer dma */
586db3dfefSJiri Kosina 	spinlock_t inlock;                                              /* Input fifo spinlock */
596db3dfefSJiri Kosina 
606db3dfefSJiri Kosina 	struct urb *urbctrl;                                            /* Control URB */
616db3dfefSJiri Kosina 	struct usb_ctrlrequest *cr;                                     /* Control request struct */
626db3dfefSJiri Kosina 	dma_addr_t cr_dma;                                              /* Control request struct dma */
636db3dfefSJiri Kosina 	struct hid_control_fifo ctrl[HID_CONTROL_FIFO_SIZE];  		/* Control fifo */
646db3dfefSJiri Kosina 	unsigned char ctrlhead, ctrltail;                               /* Control fifo head & tail */
656db3dfefSJiri Kosina 	char *ctrlbuf;                                                  /* Control buffer */
666db3dfefSJiri Kosina 	dma_addr_t ctrlbuf_dma;                                         /* Control buffer dma */
676db3dfefSJiri Kosina 	spinlock_t ctrllock;                                            /* Control fifo spinlock */
686db3dfefSJiri Kosina 
696db3dfefSJiri Kosina 	struct urb *urbout;                                             /* Output URB */
70f129ea6dSAnssi Hannula 	struct hid_output_fifo out[HID_CONTROL_FIFO_SIZE];              /* Output pipe fifo */
716db3dfefSJiri Kosina 	unsigned char outhead, outtail;                                 /* Output pipe fifo head & tail */
726db3dfefSJiri Kosina 	char *outbuf;                                                   /* Output buffer */
736db3dfefSJiri Kosina 	dma_addr_t outbuf_dma;                                          /* Output buffer dma */
746db3dfefSJiri Kosina 	spinlock_t outlock;                                             /* Output fifo spinlock */
756db3dfefSJiri Kosina 
766db3dfefSJiri Kosina 	unsigned long iofl;                                             /* I/O flags (CTRL_RUNNING, OUT_RUNNING) */
776db3dfefSJiri Kosina 	struct timer_list io_retry;                                     /* Retry timer */
786db3dfefSJiri Kosina 	unsigned long stop_retry;                                       /* Time to give up, in jiffies */
796db3dfefSJiri Kosina 	unsigned int retry_delay;                                       /* Delay length in ms */
806db3dfefSJiri Kosina 	struct work_struct reset_work;                                  /* Task context for resets */
811d1bdd20SJiri Slaby 	wait_queue_head_t wait;						/* For sleeping */
826db3dfefSJiri Kosina };
836db3dfefSJiri Kosina 
846db3dfefSJiri Kosina #define	hid_to_usb_dev(hid_dev) \
8585cdaf52SJiri Slaby 	container_of(hid_dev->dev.parent->parent, struct usb_device, dev)
866db3dfefSJiri Kosina 
876db3dfefSJiri Kosina #endif
886db3dfefSJiri Kosina 
89