hid.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526
  1. #ifndef __HID_H
  2. #define __HID_H
  3. /*
  4. * $Id: hid.h,v 1.24 2001/12/27 10:37:41 vojtech Exp $
  5. *
  6. * Copyright (c) 1999 Andreas Gal
  7. * Copyright (c) 2000-2001 Vojtech Pavlik
  8. * Copyright (c) 2006 Jiri Kosina
  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. * Should you need to contact me, the author, you can do so either by
  26. * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  27. * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  28. */
  29. #include <linux/types.h>
  30. #include <linux/slab.h>
  31. #include <linux/list.h>
  32. #include <linux/timer.h>
  33. #include <linux/workqueue.h>
  34. #include <linux/input.h>
  35. /*
  36. * USB HID (Human Interface Device) interface class code
  37. */
  38. #define USB_INTERFACE_CLASS_HID 3
  39. /*
  40. * USB HID interface subclass and protocol codes
  41. */
  42. #define USB_INTERFACE_SUBCLASS_BOOT 1
  43. #define USB_INTERFACE_PROTOCOL_KEYBOARD 1
  44. #define USB_INTERFACE_PROTOCOL_MOUSE 2
  45. /*
  46. * HID class requests
  47. */
  48. #define HID_REQ_GET_REPORT 0x01
  49. #define HID_REQ_GET_IDLE 0x02
  50. #define HID_REQ_GET_PROTOCOL 0x03
  51. #define HID_REQ_SET_REPORT 0x09
  52. #define HID_REQ_SET_IDLE 0x0A
  53. #define HID_REQ_SET_PROTOCOL 0x0B
  54. /*
  55. * HID class descriptor types
  56. */
  57. #define HID_DT_HID (USB_TYPE_CLASS | 0x01)
  58. #define HID_DT_REPORT (USB_TYPE_CLASS | 0x02)
  59. #define HID_DT_PHYSICAL (USB_TYPE_CLASS | 0x03)
  60. /*
  61. * We parse each description item into this structure. Short items data
  62. * values are expanded to 32-bit signed int, long items contain a pointer
  63. * into the data area.
  64. */
  65. struct hid_item {
  66. unsigned format;
  67. __u8 size;
  68. __u8 type;
  69. __u8 tag;
  70. union {
  71. __u8 u8;
  72. __s8 s8;
  73. __u16 u16;
  74. __s16 s16;
  75. __u32 u32;
  76. __s32 s32;
  77. __u8 *longdata;
  78. } data;
  79. };
  80. /*
  81. * HID report item format
  82. */
  83. #define HID_ITEM_FORMAT_SHORT 0
  84. #define HID_ITEM_FORMAT_LONG 1
  85. /*
  86. * Special tag indicating long items
  87. */
  88. #define HID_ITEM_TAG_LONG 15
  89. /*
  90. * HID report descriptor item type (prefix bit 2,3)
  91. */
  92. #define HID_ITEM_TYPE_MAIN 0
  93. #define HID_ITEM_TYPE_GLOBAL 1
  94. #define HID_ITEM_TYPE_LOCAL 2
  95. #define HID_ITEM_TYPE_RESERVED 3
  96. /*
  97. * HID report descriptor main item tags
  98. */
  99. #define HID_MAIN_ITEM_TAG_INPUT 8
  100. #define HID_MAIN_ITEM_TAG_OUTPUT 9
  101. #define HID_MAIN_ITEM_TAG_FEATURE 11
  102. #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10
  103. #define HID_MAIN_ITEM_TAG_END_COLLECTION 12
  104. /*
  105. * HID report descriptor main item contents
  106. */
  107. #define HID_MAIN_ITEM_CONSTANT 0x001
  108. #define HID_MAIN_ITEM_VARIABLE 0x002
  109. #define HID_MAIN_ITEM_RELATIVE 0x004
  110. #define HID_MAIN_ITEM_WRAP 0x008
  111. #define HID_MAIN_ITEM_NONLINEAR 0x010
  112. #define HID_MAIN_ITEM_NO_PREFERRED 0x020
  113. #define HID_MAIN_ITEM_NULL_STATE 0x040
  114. #define HID_MAIN_ITEM_VOLATILE 0x080
  115. #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
  116. /*
  117. * HID report descriptor collection item types
  118. */
  119. #define HID_COLLECTION_PHYSICAL 0
  120. #define HID_COLLECTION_APPLICATION 1
  121. #define HID_COLLECTION_LOGICAL 2
  122. /*
  123. * HID report descriptor global item tags
  124. */
  125. #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0
  126. #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1
  127. #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2
  128. #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3
  129. #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4
  130. #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5
  131. #define HID_GLOBAL_ITEM_TAG_UNIT 6
  132. #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7
  133. #define HID_GLOBAL_ITEM_TAG_REPORT_ID 8
  134. #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9
  135. #define HID_GLOBAL_ITEM_TAG_PUSH 10
  136. #define HID_GLOBAL_ITEM_TAG_POP 11
  137. /*
  138. * HID report descriptor local item tags
  139. */
  140. #define HID_LOCAL_ITEM_TAG_USAGE 0
  141. #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1
  142. #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2
  143. #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3
  144. #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
  145. #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
  146. #define HID_LOCAL_ITEM_TAG_STRING_INDEX 7
  147. #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8
  148. #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9
  149. #define HID_LOCAL_ITEM_TAG_DELIMITER 10
  150. /*
  151. * HID usage tables
  152. */
  153. #define HID_USAGE_PAGE 0xffff0000
  154. #define HID_UP_UNDEFINED 0x00000000
  155. #define HID_UP_GENDESK 0x00010000
  156. #define HID_UP_SIMULATION 0x00020000
  157. #define HID_UP_KEYBOARD 0x00070000
  158. #define HID_UP_LED 0x00080000
  159. #define HID_UP_BUTTON 0x00090000
  160. #define HID_UP_ORDINAL 0x000a0000
  161. #define HID_UP_CONSUMER 0x000c0000
  162. #define HID_UP_DIGITIZER 0x000d0000
  163. #define HID_UP_PID 0x000f0000
  164. #define HID_UP_HPVENDOR 0xff7f0000
  165. #define HID_UP_MSVENDOR 0xff000000
  166. #define HID_UP_CUSTOM 0x00ff0000
  167. #define HID_UP_LOGIVENDOR 0xffbc0000
  168. #define HID_USAGE 0x0000ffff
  169. #define HID_GD_POINTER 0x00010001
  170. #define HID_GD_MOUSE 0x00010002
  171. #define HID_GD_JOYSTICK 0x00010004
  172. #define HID_GD_GAMEPAD 0x00010005
  173. #define HID_GD_KEYBOARD 0x00010006
  174. #define HID_GD_KEYPAD 0x00010007
  175. #define HID_GD_MULTIAXIS 0x00010008
  176. #define HID_GD_X 0x00010030
  177. #define HID_GD_Y 0x00010031
  178. #define HID_GD_Z 0x00010032
  179. #define HID_GD_RX 0x00010033
  180. #define HID_GD_RY 0x00010034
  181. #define HID_GD_RZ 0x00010035
  182. #define HID_GD_SLIDER 0x00010036
  183. #define HID_GD_DIAL 0x00010037
  184. #define HID_GD_WHEEL 0x00010038
  185. #define HID_GD_HATSWITCH 0x00010039
  186. #define HID_GD_BUFFER 0x0001003a
  187. #define HID_GD_BYTECOUNT 0x0001003b
  188. #define HID_GD_MOTION 0x0001003c
  189. #define HID_GD_START 0x0001003d
  190. #define HID_GD_SELECT 0x0001003e
  191. #define HID_GD_VX 0x00010040
  192. #define HID_GD_VY 0x00010041
  193. #define HID_GD_VZ 0x00010042
  194. #define HID_GD_VBRX 0x00010043
  195. #define HID_GD_VBRY 0x00010044
  196. #define HID_GD_VBRZ 0x00010045
  197. #define HID_GD_VNO 0x00010046
  198. #define HID_GD_FEATURE 0x00010047
  199. #define HID_GD_UP 0x00010090
  200. #define HID_GD_DOWN 0x00010091
  201. #define HID_GD_RIGHT 0x00010092
  202. #define HID_GD_LEFT 0x00010093
  203. /*
  204. * HID report types --- Ouch! HID spec says 1 2 3!
  205. */
  206. #define HID_INPUT_REPORT 0
  207. #define HID_OUTPUT_REPORT 1
  208. #define HID_FEATURE_REPORT 2
  209. /*
  210. * HID device quirks.
  211. */
  212. #define HID_QUIRK_INVERT 0x00000001
  213. #define HID_QUIRK_NOTOUCH 0x00000002
  214. #define HID_QUIRK_IGNORE 0x00000004
  215. #define HID_QUIRK_NOGET 0x00000008
  216. #define HID_QUIRK_HIDDEV 0x00000010
  217. #define HID_QUIRK_BADPAD 0x00000020
  218. #define HID_QUIRK_MULTI_INPUT 0x00000040
  219. #define HID_QUIRK_2WHEEL_MOUSE_HACK_7 0x00000080
  220. #define HID_QUIRK_2WHEEL_MOUSE_HACK_5 0x00000100
  221. #define HID_QUIRK_2WHEEL_MOUSE_HACK_ON 0x00000200
  222. #define HID_QUIRK_MIGHTYMOUSE 0x00000400
  223. #define HID_QUIRK_CYMOTION 0x00000800
  224. #define HID_QUIRK_POWERBOOK_HAS_FN 0x00001000
  225. #define HID_QUIRK_POWERBOOK_FN_ON 0x00002000
  226. #define HID_QUIRK_INVERT_HWHEEL 0x00004000
  227. #define HID_QUIRK_POWERBOOK_ISO_KEYBOARD 0x00008000
  228. #define HID_QUIRK_BAD_RELATIVE_KEYS 0x00010000
  229. /*
  230. * This is the global environment of the parser. This information is
  231. * persistent for main-items. The global environment can be saved and
  232. * restored with PUSH/POP statements.
  233. */
  234. struct hid_global {
  235. unsigned usage_page;
  236. __s32 logical_minimum;
  237. __s32 logical_maximum;
  238. __s32 physical_minimum;
  239. __s32 physical_maximum;
  240. __s32 unit_exponent;
  241. unsigned unit;
  242. unsigned report_id;
  243. unsigned report_size;
  244. unsigned report_count;
  245. };
  246. /*
  247. * This is the local environment. It is persistent up the next main-item.
  248. */
  249. #define HID_MAX_DESCRIPTOR_SIZE 4096
  250. #define HID_MAX_USAGES 1024
  251. #define HID_DEFAULT_NUM_COLLECTIONS 16
  252. struct hid_local {
  253. unsigned usage[HID_MAX_USAGES]; /* usage array */
  254. unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
  255. unsigned usage_index;
  256. unsigned usage_minimum;
  257. unsigned delimiter_depth;
  258. unsigned delimiter_branch;
  259. };
  260. /*
  261. * This is the collection stack. We climb up the stack to determine
  262. * application and function of each field.
  263. */
  264. struct hid_collection {
  265. unsigned type;
  266. unsigned usage;
  267. unsigned level;
  268. };
  269. struct hid_usage {
  270. unsigned hid; /* hid usage code */
  271. unsigned collection_index; /* index into collection array */
  272. /* hidinput data */
  273. __u16 code; /* input driver code */
  274. __u8 type; /* input driver type */
  275. __s8 hat_min; /* hat switch fun */
  276. __s8 hat_max; /* ditto */
  277. __s8 hat_dir; /* ditto */
  278. };
  279. struct hid_input;
  280. struct hid_field {
  281. unsigned physical; /* physical usage for this field */
  282. unsigned logical; /* logical usage for this field */
  283. unsigned application; /* application usage for this field */
  284. struct hid_usage *usage; /* usage table for this function */
  285. unsigned maxusage; /* maximum usage index */
  286. unsigned flags; /* main-item flags (i.e. volatile,array,constant) */
  287. unsigned report_offset; /* bit offset in the report */
  288. unsigned report_size; /* size of this field in the report */
  289. unsigned report_count; /* number of this field in the report */
  290. unsigned report_type; /* (input,output,feature) */
  291. __s32 *value; /* last known value(s) */
  292. __s32 logical_minimum;
  293. __s32 logical_maximum;
  294. __s32 physical_minimum;
  295. __s32 physical_maximum;
  296. __s32 unit_exponent;
  297. unsigned unit;
  298. struct hid_report *report; /* associated report */
  299. unsigned index; /* index into report->field[] */
  300. /* hidinput data */
  301. struct hid_input *hidinput; /* associated input structure */
  302. __u16 dpad; /* dpad input code */
  303. };
  304. #define HID_MAX_FIELDS 64
  305. struct hid_report {
  306. struct list_head list;
  307. unsigned id; /* id of this report */
  308. unsigned type; /* report type */
  309. struct hid_field *field[HID_MAX_FIELDS]; /* fields of the report */
  310. unsigned maxfield; /* maximum valid field index */
  311. unsigned size; /* size of the report (bits) */
  312. struct hid_device *device; /* associated device */
  313. };
  314. struct hid_report_enum {
  315. unsigned numbered;
  316. struct list_head report_list;
  317. struct hid_report *report_id_hash[256];
  318. };
  319. #define HID_REPORT_TYPES 3
  320. #define HID_MIN_BUFFER_SIZE 64 /* make sure there is at least a packet size of space */
  321. #define HID_MAX_BUFFER_SIZE 4096 /* 4kb */
  322. #define HID_CONTROL_FIFO_SIZE 256 /* to init devices with >100 reports */
  323. #define HID_OUTPUT_FIFO_SIZE 64
  324. struct hid_control_fifo {
  325. unsigned char dir;
  326. struct hid_report *report;
  327. };
  328. #define HID_CLAIMED_INPUT 1
  329. #define HID_CLAIMED_HIDDEV 2
  330. #define HID_CTRL_RUNNING 1
  331. #define HID_OUT_RUNNING 2
  332. #define HID_IN_RUNNING 3
  333. #define HID_RESET_PENDING 4
  334. #define HID_SUSPENDED 5
  335. #define HID_CLEAR_HALT 6
  336. struct hid_input {
  337. struct list_head list;
  338. struct hid_report *report;
  339. struct input_dev *input;
  340. };
  341. struct hid_device { /* device report descriptor */
  342. __u8 *rdesc;
  343. unsigned rsize;
  344. struct hid_collection *collection; /* List of HID collections */
  345. unsigned collection_size; /* Number of allocated hid_collections */
  346. unsigned maxcollection; /* Number of parsed collections */
  347. unsigned maxapplication; /* Number of applications */
  348. unsigned short bus; /* BUS ID */
  349. unsigned short vendor; /* Vendor ID */
  350. unsigned short product; /* Product ID */
  351. unsigned version; /* HID version */
  352. unsigned country; /* HID country */
  353. struct hid_report_enum report_enum[HID_REPORT_TYPES];
  354. struct device *dev; /* device */
  355. unsigned claimed; /* Claimed by hidinput, hiddev? */
  356. unsigned quirks; /* Various quirks the device can pull on us */
  357. struct list_head inputs; /* The list of inputs */
  358. void *hiddev; /* The hiddev structure */
  359. int minor; /* Hiddev minor number */
  360. wait_queue_head_t wait; /* For sleeping */
  361. int open; /* is the device open by anyone? */
  362. char name[128]; /* Device name */
  363. char phys[64]; /* Device physical location */
  364. char uniq[64]; /* Device unique identifier (serial #) */
  365. void *driver_data;
  366. /* device-specific function pointers */
  367. int (*hidinput_input_event) (struct input_dev *, unsigned int, unsigned int, int);
  368. int (*hidinput_open) (struct input_dev *);
  369. void (*hidinput_close) (struct input_dev *);
  370. /* hiddev event handler */
  371. void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
  372. struct hid_usage *, __s32);
  373. #ifdef CONFIG_USB_HIDINPUT_POWERBOOK
  374. unsigned long pb_pressed_fn[NBITS(KEY_MAX)];
  375. unsigned long pb_pressed_numlock[NBITS(KEY_MAX)];
  376. #endif
  377. };
  378. #define HID_GLOBAL_STACK_SIZE 4
  379. #define HID_COLLECTION_STACK_SIZE 4
  380. struct hid_parser {
  381. struct hid_global global;
  382. struct hid_global global_stack[HID_GLOBAL_STACK_SIZE];
  383. unsigned global_stack_ptr;
  384. struct hid_local local;
  385. unsigned collection_stack[HID_COLLECTION_STACK_SIZE];
  386. unsigned collection_stack_ptr;
  387. struct hid_device *device;
  388. };
  389. struct hid_class_descriptor {
  390. __u8 bDescriptorType;
  391. __u16 wDescriptorLength;
  392. } __attribute__ ((packed));
  393. struct hid_descriptor {
  394. __u8 bLength;
  395. __u8 bDescriptorType;
  396. __u16 bcdHID;
  397. __u8 bCountryCode;
  398. __u8 bNumDescriptors;
  399. struct hid_class_descriptor desc[1];
  400. } __attribute__ ((packed));
  401. #ifdef DEBUG
  402. #include "hid-debug.h"
  403. #else
  404. #define hid_dump_input(a,b) do { } while (0)
  405. #define hid_dump_device(c) do { } while (0)
  406. #define hid_dump_field(a,b) do { } while (0)
  407. #define resolv_usage(a) do { } while (0)
  408. #define resolv_event(a,b) do { } while (0)
  409. #endif
  410. /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
  411. /* We ignore a few input applications that are not widely used */
  412. #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001))
  413. /* HID core API */
  414. extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
  415. extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
  416. extern int hidinput_connect(struct hid_device *);
  417. extern void hidinput_disconnect(struct hid_device *);
  418. int hid_set_field(struct hid_field *, unsigned, __s32);
  419. int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
  420. void hid_input_field(struct hid_device *hid, struct hid_field *field, __u8 *data, int interrupt);
  421. void hid_output_report(struct hid_report *report, __u8 *data);
  422. void hid_free_device(struct hid_device *device);
  423. struct hid_device *hid_parse_report(__u8 *start, unsigned size);
  424. #ifdef CONFIG_HID_FF
  425. int hid_ff_init(struct hid_device *hid);
  426. int hid_lgff_init(struct hid_device *hid);
  427. int hid_tmff_init(struct hid_device *hid);
  428. int hid_zpff_init(struct hid_device *hid);
  429. #ifdef CONFIG_HID_PID
  430. int hid_pidff_init(struct hid_device *hid);
  431. #else
  432. static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
  433. #endif
  434. #else
  435. static inline int hid_ff_init(struct hid_device *hid) { return -1; }
  436. #endif
  437. #ifdef DEBUG
  438. #define dbg(format, arg...) printk(KERN_DEBUG "%s: " format "\n" , \
  439. __FILE__ , ## arg)
  440. #else
  441. #define dbg(format, arg...) do {} while (0)
  442. #endif
  443. #define err(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
  444. __FILE__ , ## arg)
  445. #endif