hid.h 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670
  1. #ifndef __HID_H
  2. #define __HID_H
  3. /*
  4. * Copyright (c) 1999 Andreas Gal
  5. * Copyright (c) 2000-2001 Vojtech Pavlik
  6. * Copyright (c) 2006-2007 Jiri Kosina
  7. */
  8. /*
  9. * This program is free software; you can redistribute it and/or modify
  10. * it under the terms of the GNU General Public License as published by
  11. * the Free Software Foundation; either version 2 of the License, or
  12. * (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU General Public License
  20. * along with this program; if not, write to the Free Software
  21. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22. *
  23. * Should you need to contact me, the author, you can do so either by
  24. * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  25. * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  26. */
  27. /*
  28. * USB HID (Human Interface Device) interface class code
  29. */
  30. #define USB_INTERFACE_CLASS_HID 3
  31. /*
  32. * USB HID interface subclass and protocol codes
  33. */
  34. #define USB_INTERFACE_SUBCLASS_BOOT 1
  35. #define USB_INTERFACE_PROTOCOL_KEYBOARD 1
  36. #define USB_INTERFACE_PROTOCOL_MOUSE 2
  37. /*
  38. * HID class requests
  39. */
  40. #define HID_REQ_GET_REPORT 0x01
  41. #define HID_REQ_GET_IDLE 0x02
  42. #define HID_REQ_GET_PROTOCOL 0x03
  43. #define HID_REQ_SET_REPORT 0x09
  44. #define HID_REQ_SET_IDLE 0x0A
  45. #define HID_REQ_SET_PROTOCOL 0x0B
  46. /*
  47. * HID class descriptor types
  48. */
  49. #define HID_DT_HID (USB_TYPE_CLASS | 0x01)
  50. #define HID_DT_REPORT (USB_TYPE_CLASS | 0x02)
  51. #define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
  52. #define HID_MAX_DESCRIPTOR_SIZE 4096
  53. #ifdef __KERNEL__
  54. #include <linux/types.h>
  55. #include <linux/slab.h>
  56. #include <linux/list.h>
  57. #include <linux/mod_devicetable.h> /* hid_device_id */
  58. #include <linux/timer.h>
  59. #include <linux/workqueue.h>
  60. #include <linux/input.h>
  61. /*
  62. * We parse each description item into this structure. Short items data
  63. * values are expanded to 32-bit signed int, long items contain a pointer
  64. * into the data area.
  65. */
  66. struct hid_item {
  67. unsigned format;
  68. __u8 size;
  69. __u8 type;
  70. __u8 tag;
  71. union {
  72. __u8 u8;
  73. __s8 s8;
  74. __u16 u16;
  75. __s16 s16;
  76. __u32 u32;
  77. __s32 s32;
  78. __u8 *longdata;
  79. } data;
  80. };
  81. /*
  82. * HID report item format
  83. */
  84. #define HID_ITEM_FORMAT_SHORT 0
  85. #define HID_ITEM_FORMAT_LONG 1
  86. /*
  87. * Special tag indicating long items
  88. */
  89. #define HID_ITEM_TAG_LONG 15
  90. /*
  91. * HID report descriptor item type (prefix bit 2,3)
  92. */
  93. #define HID_ITEM_TYPE_MAIN 0
  94. #define HID_ITEM_TYPE_GLOBAL 1
  95. #define HID_ITEM_TYPE_LOCAL 2
  96. #define HID_ITEM_TYPE_RESERVED 3
  97. /*
  98. * HID report descriptor main item tags
  99. */
  100. #define HID_MAIN_ITEM_TAG_INPUT 8
  101. #define HID_MAIN_ITEM_TAG_OUTPUT 9
  102. #define HID_MAIN_ITEM_TAG_FEATURE 11
  103. #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
  104. #define HID_MAIN_ITEM_TAG_END_COLLECTION 12
  105. /*
  106. * HID report descriptor main item contents
  107. */
  108. #define HID_MAIN_ITEM_CONSTANT 0x001
  109. #define HID_MAIN_ITEM_VARIABLE 0x002
  110. #define HID_MAIN_ITEM_RELATIVE 0x004
  111. #define HID_MAIN_ITEM_WRAP 0x008
  112. #define HID_MAIN_ITEM_NONLINEAR 0x010
  113. #define HID_MAIN_ITEM_NO_PREFERRED 0x020
  114. #define HID_MAIN_ITEM_NULL_STATE 0x040
  115. #define HID_MAIN_ITEM_VOLATILE 0x080
  116. #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
  117. /*
  118. * HID report descriptor collection item types
  119. */
  120. #define HID_COLLECTION_PHYSICAL 0
  121. #define HID_COLLECTION_APPLICATION 1
  122. #define HID_COLLECTION_LOGICAL 2
  123. /*
  124. * HID report descriptor global item tags
  125. */
  126. #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
  127. #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
  128. #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
  129. #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
  130. #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
  131. #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
  132. #define HID_GLOBAL_ITEM_TAG_UNIT 6
  133. #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
  134. #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
  135. #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
  136. #define HID_GLOBAL_ITEM_TAG_PUSH 10
  137. #define HID_GLOBAL_ITEM_TAG_POP 11
  138. /*
  139. * HID report descriptor local item tags
  140. */
  141. #define HID_LOCAL_ITEM_TAG_USAGE 0
  142. #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
  143. #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
  144. #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
  145. #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
  146. #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
  147. #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
  148. #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
  149. #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
  150. #define HID_LOCAL_ITEM_TAG_DELIMITER 10
  151. /*
  152. * HID usage tables
  153. */
  154. #define HID_USAGE_PAGE 0xffff0000
  155. #define HID_UP_UNDEFINED 0x00000000
  156. #define HID_UP_GENDESK 0x00010000
  157. #define HID_UP_SIMULATION 0x00020000
  158. #define HID_UP_KEYBOARD 0x00070000
  159. #define HID_UP_LED 0x00080000
  160. #define HID_UP_BUTTON 0x00090000
  161. #define HID_UP_ORDINAL 0x000a0000
  162. #define HID_UP_CONSUMER 0x000c0000
  163. #define HID_UP_DIGITIZER 0x000d0000
  164. #define HID_UP_PID 0x000f0000
  165. #define HID_UP_HPVENDOR 0xff7f0000
  166. #define HID_UP_MSVENDOR 0xff000000
  167. #define HID_UP_CUSTOM 0x00ff0000
  168. #define HID_UP_LOGIVENDOR 0xffbc0000
  169. #define HID_USAGE 0x0000ffff
  170. #define HID_GD_POINTER 0x00010001
  171. #define HID_GD_MOUSE 0x00010002
  172. #define HID_GD_JOYSTICK 0x00010004
  173. #define HID_GD_GAMEPAD 0x00010005
  174. #define HID_GD_KEYBOARD 0x00010006
  175. #define HID_GD_KEYPAD 0x00010007
  176. #define HID_GD_MULTIAXIS 0x00010008
  177. #define HID_GD_X 0x00010030
  178. #define HID_GD_Y 0x00010031
  179. #define HID_GD_Z 0x00010032
  180. #define HID_GD_RX 0x00010033
  181. #define HID_GD_RY 0x00010034
  182. #define HID_GD_RZ 0x00010035
  183. #define HID_GD_SLIDER 0x00010036
  184. #define HID_GD_DIAL 0x00010037
  185. #define HID_GD_WHEEL 0x00010038
  186. #define HID_GD_HATSWITCH 0x00010039
  187. #define HID_GD_BUFFER 0x0001003a
  188. #define HID_GD_BYTECOUNT 0x0001003b
  189. #define HID_GD_MOTION 0x0001003c
  190. #define HID_GD_START 0x0001003d
  191. #define HID_GD_SELECT 0x0001003e
  192. #define HID_GD_VX 0x00010040
  193. #define HID_GD_VY 0x00010041
  194. #define HID_GD_VZ 0x00010042
  195. #define HID_GD_VBRX 0x00010043
  196. #define HID_GD_VBRY 0x00010044
  197. #define HID_GD_VBRZ 0x00010045
  198. #define HID_GD_VNO 0x00010046
  199. #define HID_GD_FEATURE 0x00010047
  200. #define HID_GD_UP 0x00010090
  201. #define HID_GD_DOWN 0x00010091
  202. #define HID_GD_RIGHT 0x00010092
  203. #define HID_GD_LEFT 0x00010093
  204. /*
  205. * HID report types --- Ouch! HID spec says 1 2 3!
  206. */
  207. #define HID_INPUT_REPORT 0
  208. #define HID_OUTPUT_REPORT 1
  209. #define HID_FEATURE_REPORT 2
  210. /*
  211. * HID device quirks.
  212. */
  213. /*
  214. * Increase this if you need to configure more HID quirks at module load time
  215. */
  216. #define MAX_USBHID_BOOT_QUIRKS 4
  217. #define HID_QUIRK_INVERT 0x00000001
  218. #define HID_QUIRK_NOTOUCH 0x00000002
  219. #define HID_QUIRK_IGNORE 0x00000004
  220. #define HID_QUIRK_NOGET 0x00000008
  221. #define HID_QUIRK_HIDDEV 0x00000010
  222. #define HID_QUIRK_BADPAD 0x00000020
  223. #define HID_QUIRK_MULTI_INPUT 0x00000040
  224. #define HID_QUIRK_2WHEEL_MOUSE_HACK_7 0x00000080
  225. #define HID_QUIRK_2WHEEL_MOUSE_HACK_5 0x00000100
  226. #define HID_QUIRK_2WHEEL_MOUSE_HACK_ON 0x00000200
  227. #define HID_QUIRK_MIGHTYMOUSE 0x00000400
  228. #define HID_QUIRK_APPLE_HAS_FN 0x00000800
  229. #define HID_QUIRK_APPLE_FN_ON 0x00001000
  230. #define HID_QUIRK_INVERT_HWHEEL 0x00002000
  231. #define HID_QUIRK_APPLE_ISO_KEYBOARD 0x00004000
  232. #define HID_QUIRK_BAD_RELATIVE_KEYS 0x00008000
  233. #define HID_QUIRK_SKIP_OUTPUT_REPORTS 0x00010000
  234. #define HID_QUIRK_IGNORE_MOUSE 0x00020000
  235. #define HID_QUIRK_SONY_PS3_CONTROLLER 0x00040000
  236. #define HID_QUIRK_DUPLICATE_USAGES 0x00080000
  237. #define HID_QUIRK_RESET_LEDS 0x00100000
  238. #define HID_QUIRK_HIDINPUT 0x00200000
  239. #define HID_QUIRK_LOGITECH_IGNORE_DOUBLED_WHEEL 0x00400000
  240. #define HID_QUIRK_LOGITECH_EXPANDED_KEYMAP 0x00800000
  241. #define HID_QUIRK_IGNORE_HIDINPUT 0x01000000
  242. #define HID_QUIRK_2WHEEL_MOUSE_HACK_B8 0x02000000
  243. #define HID_QUIRK_HWHEEL_WHEEL_INVERT 0x04000000
  244. #define HID_QUIRK_MICROSOFT_KEYS 0x08000000
  245. #define HID_QUIRK_FULLSPEED_INTERVAL 0x10000000
  246. #define HID_QUIRK_APPLE_NUMLOCK_EMULATION 0x20000000
  247. /*
  248. * Separate quirks for runtime report descriptor fixup
  249. */
  250. #define HID_QUIRK_RDESC_CYMOTION 0x00000001
  251. #define HID_QUIRK_RDESC_LOGITECH 0x00000002
  252. #define HID_QUIRK_RDESC_SWAPPED_MIN_MAX 0x00000004
  253. #define HID_QUIRK_RDESC_PETALYNX 0x00000008
  254. #define HID_QUIRK_RDESC_MACBOOK_JIS 0x00000010
  255. #define HID_QUIRK_RDESC_BUTTON_CONSUMER 0x00000020
  256. #define HID_QUIRK_RDESC_SAMSUNG_REMOTE 0x00000040
  257. #define HID_QUIRK_RDESC_MICROSOFT_RECV_1028 0x00000080
  258. #define HID_QUIRK_RDESC_SUNPLUS_WDESKTOP 0x00000100
  259. /*
  260. * This is the global environment of the parser. This information is
  261. * persistent for main-items. The global environment can be saved and
  262. * restored with PUSH/POP statements.
  263. */
  264. struct hid_global {
  265. unsigned usage_page;
  266. __s32 logical_minimum;
  267. __s32 logical_maximum;
  268. __s32 physical_minimum;
  269. __s32 physical_maximum;
  270. __s32 unit_exponent;
  271. unsigned unit;
  272. unsigned report_id;
  273. unsigned report_size;
  274. unsigned report_count;
  275. };
  276. /*
  277. * This is the local environment. It is persistent up the next main-item.
  278. */
  279. #define HID_MAX_USAGES 12288
  280. #define HID_DEFAULT_NUM_COLLECTIONS 16
  281. struct hid_local {
  282. unsigned usage[HID_MAX_USAGES]; /* usage array */
  283. unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
  284. unsigned usage_index;
  285. unsigned usage_minimum;
  286. unsigned delimiter_depth;
  287. unsigned delimiter_branch;
  288. };
  289. /*
  290. * This is the collection stack. We climb up the stack to determine
  291. * application and function of each field.
  292. */
  293. struct hid_collection {
  294. unsigned type;
  295. unsigned usage;
  296. unsigned level;
  297. };
  298. struct hid_usage {
  299. unsigned hid; /* hid usage code */
  300. unsigned collection_index; /* index into collection array */
  301. /* hidinput data */
  302. __u16 code; /* input driver code */
  303. __u8 type; /* input driver type */
  304. __s8 hat_min; /* hat switch fun */
  305. __s8 hat_max; /* ditto */
  306. __s8 hat_dir; /* ditto */
  307. };
  308. struct hid_input;
  309. struct hid_field {
  310. unsigned physical; /* physical usage for this field */
  311. unsigned logical; /* logical usage for this field */
  312. unsigned application; /* application usage for this field */
  313. struct hid_usage *usage; /* usage table for this function */
  314. unsigned maxusage; /* maximum usage index */
  315. unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
  316. unsigned report_offset; /* bit offset in the report */
  317. unsigned report_size; /* size of this field in the report */
  318. unsigned report_count; /* number of this field in the report */
  319. unsigned report_type; /* (input,output,feature) */
  320. __s32 *value; /* last known value(s) */
  321. __s32 logical_minimum;
  322. __s32 logical_maximum;
  323. __s32 physical_minimum;
  324. __s32 physical_maximum;
  325. __s32 unit_exponent;
  326. unsigned unit;
  327. struct hid_report *report; /* associated report */
  328. unsigned index; /* index into report->field[] */
  329. /* hidinput data */
  330. struct hid_input *hidinput; /* associated input structure */
  331. __u16 dpad; /* dpad input code */
  332. };
  333. #define HID_MAX_FIELDS 64
  334. struct hid_report {
  335. struct list_head list;
  336. unsigned id; /* id of this report */
  337. unsigned type; /* report type */
  338. struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
  339. unsigned maxfield; /* maximum valid field index */
  340. unsigned size; /* size of the report (bits) */
  341. struct hid_device *device; /* associated device */
  342. };
  343. struct hid_report_enum {
  344. unsigned numbered;
  345. struct list_head report_list;
  346. struct hid_report *report_id_hash[256];
  347. };
  348. #define HID_REPORT_TYPES 3
  349. #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
  350. #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
  351. #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
  352. #define HID_OUTPUT_FIFO_SIZE 64
  353. struct hid_control_fifo {
  354. unsigned char dir;
  355. struct hid_report *report;
  356. };
  357. #define HID_CLAIMED_INPUT 1
  358. #define HID_CLAIMED_HIDDEV 2
  359. #define HID_CLAIMED_HIDRAW 4
  360. #define HID_STAT_ADDED 1
  361. #define HID_CTRL_RUNNING 1
  362. #define HID_OUT_RUNNING 2
  363. #define HID_IN_RUNNING 3
  364. #define HID_RESET_PENDING 4
  365. #define HID_SUSPENDED 5
  366. #define HID_CLEAR_HALT 6
  367. #define HID_DISCONNECTED 7
  368. struct hid_input {
  369. struct list_head list;
  370. struct hid_report *report;
  371. struct input_dev *input;
  372. };
  373. struct hid_driver;
  374. struct hid_device { /* device report descriptor */
  375. __u8 *rdesc;
  376. unsigned rsize;
  377. struct hid_collection *collection; /* List of HID collections */
  378. unsigned collection_size; /* Number of allocated hid_collections */
  379. unsigned maxcollection; /* Number of parsed collections */
  380. unsigned maxapplication; /* Number of applications */
  381. __u16 bus; /* BUS ID */
  382. __u32 vendor; /* Vendor ID */
  383. __u32 product; /* Product ID */
  384. __u32 version; /* HID version */
  385. unsigned country; /* HID country */
  386. struct hid_report_enum report_enum[HID_REPORT_TYPES];
  387. struct device dev; /* device */
  388. struct hid_driver *driver;
  389. unsigned int status; /* see STAT flags above */
  390. unsigned claimed; /* Claimed by hidinput, hiddev? */
  391. unsigned quirks; /* Various quirks the device can pull on us */
  392. struct list_head inputs; /* The list of inputs */
  393. void *hiddev; /* The hiddev structure */
  394. void *hidraw;
  395. int minor; /* Hiddev minor number */
  396. int open; /* is the device open by anyone? */
  397. char name[128]; /* Device name */
  398. char phys[64]; /* Device physical location */
  399. char uniq[64]; /* Device unique identifier (serial #) */
  400. void *driver_data;
  401. __s32 delayed_value; /* For A4 Tech mice hwheel quirk */
  402. /* device-specific function pointers */
  403. int (*hidinput_input_event) (struct input_dev *, unsigned int, unsigned int, int);
  404. int (*hid_open) (struct hid_device *);
  405. void (*hid_close) (struct hid_device *);
  406. /* hiddev event handler */
  407. void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
  408. struct hid_usage *, __s32);
  409. void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
  410. /* handler for raw output data, used by hidraw */
  411. int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
  412. #ifdef CONFIG_USB_HIDINPUT_POWERBOOK
  413. unsigned long apple_pressed_fn[BITS_TO_LONGS(KEY_CNT)];
  414. unsigned long pb_pressed_numlock[BITS_TO_LONGS(KEY_CNT)];
  415. #endif
  416. };
  417. static inline void *hid_get_drvdata(struct hid_device *hdev)
  418. {
  419. return dev_get_drvdata(&hdev->dev);
  420. }
  421. static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
  422. {
  423. dev_set_drvdata(&hdev->dev, data);
  424. }
  425. #define HID_GLOBAL_STACK_SIZE 4
  426. #define HID_COLLECTION_STACK_SIZE 4
  427. struct hid_parser {
  428. struct hid_global global;
  429. struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
  430. unsigned global_stack_ptr;
  431. struct hid_local local;
  432. unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
  433. unsigned collection_stack_ptr;
  434. struct hid_device *device;
  435. };
  436. struct hid_class_descriptor {
  437. __u8 bDescriptorType;
  438. __le16 wDescriptorLength;
  439. } __attribute__ ((packed));
  440. struct hid_descriptor {
  441. __u8 bLength;
  442. __u8 bDescriptorType;
  443. __le16 bcdHID;
  444. __u8 bCountryCode;
  445. __u8 bNumDescriptors;
  446. struct hid_class_descriptor desc[1];
  447. } __attribute__ ((packed));
  448. #define HID_DEVICE(b, ven, prod) \
  449. .bus = (b), \
  450. .vendor = (ven), .product = (prod)
  451. #define HID_USB_DEVICE(ven, prod) HID_DEVICE(BUS_USB, ven, prod)
  452. #define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
  453. #define HID_REPORT_ID(rep) \
  454. .report_type = (rep)
  455. #define HID_USAGE_ID(uhid, utype, ucode) \
  456. .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
  457. /* we don't want to catch types and codes equal to 0 */
  458. #define HID_TERMINATOR (HID_ANY_ID - 1)
  459. struct hid_report_id {
  460. __u32 report_type;
  461. };
  462. struct hid_usage_id {
  463. __u32 usage_hid;
  464. __u32 usage_type;
  465. __u32 usage_code;
  466. };
  467. /**
  468. * struct hid_driver
  469. * @name: driver name (e.g. "Footech_bar-wheel")
  470. * @id_table: which devices is this driver for (must be non-NULL for probe
  471. * to be called)
  472. * @probe: new device inserted
  473. * @remove: device removed (NULL if not a hot-plug capable driver)
  474. * @report_table: on which reports to call raw_event (NULL means all)
  475. * @raw_event: if report in report_table, this hook is called (NULL means nop)
  476. * @usage_table: on which events to call event (NULL means all)
  477. * @event: if usage in usage_table, this hook is called (NULL means nop)
  478. *
  479. * raw_event and event should return 0 on no action performed, 1 when no
  480. * further processing should be done and negative on error
  481. */
  482. struct hid_driver {
  483. char *name;
  484. const struct hid_device_id *id_table;
  485. int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
  486. void (*remove)(struct hid_device *dev);
  487. const struct hid_report_id *report_table;
  488. int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
  489. u8 *data, int size);
  490. const struct hid_usage_id *usage_table;
  491. int (*event)(struct hid_device *hdev, struct hid_field *field,
  492. struct hid_usage *usage, __s32 value);
  493. /* private: */
  494. struct device_driver driver;
  495. };
  496. /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
  497. /* We ignore a few input applications that are not widely used */
  498. #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
  499. /* HID core API */
  500. #ifdef CONFIG_HID_DEBUG
  501. extern int hid_debug;
  502. #endif
  503. extern int hid_add_device(struct hid_device *);
  504. extern void hid_destroy_device(struct hid_device *);
  505. extern int __must_check __hid_register_driver(struct hid_driver *,
  506. struct module *, const char *mod_name);
  507. static inline int __must_check hid_register_driver(struct hid_driver *driver)
  508. {
  509. return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
  510. }
  511. extern void hid_unregister_driver(struct hid_driver *);
  512. extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
  513. extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
  514. extern int hidinput_connect(struct hid_device *);
  515. extern void hidinput_disconnect(struct hid_device *);
  516. int hid_set_field(struct hid_field *, unsigned, __s32);
  517. int hid_input_report(struct hid_device *, int type, u8 *, int, int);
  518. int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
  519. int hidinput_mapping_quirks(struct hid_usage *, struct input_dev *, unsigned long **, int *);
  520. int hidinput_event_quirks(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
  521. int hidinput_apple_event(struct hid_device *, struct input_dev *, struct hid_usage *, __s32);
  522. void hid_output_report(struct hid_report *report, __u8 *data);
  523. struct hid_device *hid_allocate_device(void);
  524. int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
  525. void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
  526. int interrupt);
  527. extern int hid_generic_init(void);
  528. extern void hid_generic_exit(void);
  529. /* HID quirks API */
  530. u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
  531. int usbhid_quirks_init(char **quirks_param);
  532. void usbhid_quirks_exit(void);
  533. void usbhid_fixup_report_descriptor(const u16, const u16, char *, unsigned, char **);
  534. #ifdef CONFIG_HID_FF
  535. int hid_ff_init(struct hid_device *hid);
  536. int hid_lgff_init(struct hid_device *hid);
  537. int hid_lg2ff_init(struct hid_device *hid);
  538. int hid_plff_init(struct hid_device *hid);
  539. int hid_tmff_init(struct hid_device *hid);
  540. int hid_zpff_init(struct hid_device *hid);
  541. #ifdef CONFIG_HID_PID
  542. int hid_pidff_init(struct hid_device *hid);
  543. #else
  544. static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
  545. #endif
  546. #else
  547. static inline int hid_ff_init(struct hid_device *hid) { return -1; }
  548. #endif
  549. #ifdef CONFIG_HID_DEBUG
  550. #define dbg_hid(format, arg...) if (hid_debug) \
  551. printk(KERN_DEBUG "%s: " format ,\
  552. __FILE__ , ## arg)
  553. #define dbg_hid_line(format, arg...) if (hid_debug) \
  554. printk(format, ## arg)
  555. #else
  556. static inline int __attribute__((format(printf, 1, 2)))
  557. dbg_hid(const char *fmt, ...)
  558. {
  559. return 0;
  560. }
  561. #define dbg_hid_line dbg_hid
  562. #endif
  563. #define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
  564. __FILE__ , ## arg)
  565. #endif
  566. #endif