1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */ 2*4882a593Smuzhiyun #ifndef __USBHID_H 3*4882a593Smuzhiyun #define __USBHID_H 4*4882a593Smuzhiyun 5*4882a593Smuzhiyun /* 6*4882a593Smuzhiyun * Copyright (c) 1999 Andreas Gal 7*4882a593Smuzhiyun * Copyright (c) 2000-2001 Vojtech Pavlik 8*4882a593Smuzhiyun * Copyright (c) 2006 Jiri Kosina 9*4882a593Smuzhiyun */ 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun /* 12*4882a593Smuzhiyun */ 13*4882a593Smuzhiyun 14*4882a593Smuzhiyun #include <linux/types.h> 15*4882a593Smuzhiyun #include <linux/slab.h> 16*4882a593Smuzhiyun #include <linux/list.h> 17*4882a593Smuzhiyun #include <linux/mutex.h> 18*4882a593Smuzhiyun #include <linux/timer.h> 19*4882a593Smuzhiyun #include <linux/wait.h> 20*4882a593Smuzhiyun #include <linux/workqueue.h> 21*4882a593Smuzhiyun #include <linux/input.h> 22*4882a593Smuzhiyun 23*4882a593Smuzhiyun /* API provided by hid-core.c for USB HID drivers */ 24*4882a593Smuzhiyun void usbhid_init_reports(struct hid_device *hid); 25*4882a593Smuzhiyun struct usb_interface *usbhid_find_interface(int minor); 26*4882a593Smuzhiyun 27*4882a593Smuzhiyun /* iofl flags */ 28*4882a593Smuzhiyun #define HID_CTRL_RUNNING 1 29*4882a593Smuzhiyun #define HID_OUT_RUNNING 2 30*4882a593Smuzhiyun #define HID_IN_RUNNING 3 31*4882a593Smuzhiyun #define HID_RESET_PENDING 4 32*4882a593Smuzhiyun #define HID_SUSPENDED 5 33*4882a593Smuzhiyun #define HID_CLEAR_HALT 6 34*4882a593Smuzhiyun #define HID_DISCONNECTED 7 35*4882a593Smuzhiyun #define HID_STARTED 8 36*4882a593Smuzhiyun #define HID_KEYS_PRESSED 10 37*4882a593Smuzhiyun #define HID_NO_BANDWIDTH 11 38*4882a593Smuzhiyun #define HID_RESUME_RUNNING 12 39*4882a593Smuzhiyun /* 40*4882a593Smuzhiyun * The device is opened, meaning there is a client that is interested 41*4882a593Smuzhiyun * in data coming from the device. 42*4882a593Smuzhiyun */ 43*4882a593Smuzhiyun #define HID_OPENED 13 44*4882a593Smuzhiyun /* 45*4882a593Smuzhiyun * We are polling input endpoint by [re]submitting IN URB, because 46*4882a593Smuzhiyun * either HID device is opened or ALWAYS POLL quirk is set for the 47*4882a593Smuzhiyun * device. 48*4882a593Smuzhiyun */ 49*4882a593Smuzhiyun #define HID_IN_POLLING 14 50*4882a593Smuzhiyun 51*4882a593Smuzhiyun /* 52*4882a593Smuzhiyun * USB-specific HID struct, to be pointed to 53*4882a593Smuzhiyun * from struct hid_device->driver_data 54*4882a593Smuzhiyun */ 55*4882a593Smuzhiyun 56*4882a593Smuzhiyun struct usbhid_device { 57*4882a593Smuzhiyun struct hid_device *hid; /* pointer to corresponding HID dev */ 58*4882a593Smuzhiyun 59*4882a593Smuzhiyun struct usb_interface *intf; /* USB interface */ 60*4882a593Smuzhiyun int ifnum; /* USB interface number */ 61*4882a593Smuzhiyun 62*4882a593Smuzhiyun unsigned int bufsize; /* URB buffer size */ 63*4882a593Smuzhiyun 64*4882a593Smuzhiyun struct urb *urbin; /* Input URB */ 65*4882a593Smuzhiyun char *inbuf; /* Input buffer */ 66*4882a593Smuzhiyun dma_addr_t inbuf_dma; /* Input buffer dma */ 67*4882a593Smuzhiyun 68*4882a593Smuzhiyun struct urb *urbctrl; /* Control URB */ 69*4882a593Smuzhiyun struct usb_ctrlrequest *cr; /* Control request struct */ 70*4882a593Smuzhiyun struct hid_control_fifo ctrl[HID_CONTROL_FIFO_SIZE]; /* Control fifo */ 71*4882a593Smuzhiyun unsigned char ctrlhead, ctrltail; /* Control fifo head & tail */ 72*4882a593Smuzhiyun char *ctrlbuf; /* Control buffer */ 73*4882a593Smuzhiyun dma_addr_t ctrlbuf_dma; /* Control buffer dma */ 74*4882a593Smuzhiyun unsigned long last_ctrl; /* record of last output for timeouts */ 75*4882a593Smuzhiyun 76*4882a593Smuzhiyun struct urb *urbout; /* Output URB */ 77*4882a593Smuzhiyun struct hid_output_fifo out[HID_CONTROL_FIFO_SIZE]; /* Output pipe fifo */ 78*4882a593Smuzhiyun unsigned char outhead, outtail; /* Output pipe fifo head & tail */ 79*4882a593Smuzhiyun char *outbuf; /* Output buffer */ 80*4882a593Smuzhiyun dma_addr_t outbuf_dma; /* Output buffer dma */ 81*4882a593Smuzhiyun unsigned long last_out; /* record of last output for timeouts */ 82*4882a593Smuzhiyun 83*4882a593Smuzhiyun struct mutex mutex; /* start/stop/open/close */ 84*4882a593Smuzhiyun spinlock_t lock; /* fifo spinlock */ 85*4882a593Smuzhiyun unsigned long iofl; /* I/O flags (CTRL_RUNNING, OUT_RUNNING) */ 86*4882a593Smuzhiyun struct timer_list io_retry; /* Retry timer */ 87*4882a593Smuzhiyun unsigned long stop_retry; /* Time to give up, in jiffies */ 88*4882a593Smuzhiyun unsigned int retry_delay; /* Delay length in ms */ 89*4882a593Smuzhiyun struct work_struct reset_work; /* Task context for resets */ 90*4882a593Smuzhiyun wait_queue_head_t wait; /* For sleeping */ 91*4882a593Smuzhiyun }; 92*4882a593Smuzhiyun 93*4882a593Smuzhiyun #define hid_to_usb_dev(hid_dev) \ 94*4882a593Smuzhiyun to_usb_device(hid_dev->dev.parent->parent) 95*4882a593Smuzhiyun 96*4882a593Smuzhiyun #endif 97*4882a593Smuzhiyun 98