hid.h revision 1.11
1/* $OpenBSD: hid.h,v 1.11 2023/08/12 20:47:06 miod Exp $ */ 2/* $NetBSD: hid.h,v 1.8 2002/07/11 21:14:25 augustss Exp $ */ 3/* $FreeBSD: src/sys/dev/usb/hid.h,v 1.7 1999/11/17 22:33:40 n_hibma Exp $ */ 4 5/* 6 * Copyright (c) 1998 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to The NetBSD Foundation 10 * by Lennart Augustsson (lennart@augustsson.net) at 11 * Carlstedt Research & Technology. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35#ifndef _HIDHID_H_ 36#define _HIDHID_H_ 37 38#ifdef _KERNEL 39 40enum hid_kind { 41 hid_input, 42 hid_output, 43 hid_feature, 44 hid_collection, 45 hid_endcollection, 46 hid_all 47}; 48 49struct hid_location { 50 u_int32_t size; 51 u_int32_t count; 52 u_int32_t pos; 53}; 54 55struct hid_item { 56 /* Global */ 57 int32_t _usage_page; 58 int32_t logical_minimum; 59 int32_t logical_maximum; 60 int32_t physical_minimum; 61 int32_t physical_maximum; 62 int32_t unit_exponent; 63 int32_t unit; 64 int32_t report_ID; 65 /* Local */ 66 int32_t usage; 67 int32_t usage_minimum; 68 int32_t usage_maximum; 69 int32_t designator_index; 70 int32_t designator_minimum; 71 int32_t designator_maximum; 72 int32_t string_index; 73 int32_t string_minimum; 74 int32_t string_maximum; 75 int32_t set_delimiter; 76 /* Misc */ 77 int32_t collection; 78 int collevel; 79 enum hid_kind kind; 80 u_int32_t flags; 81 /* Location */ 82 struct hid_location loc; 83 /* */ 84 struct hid_item *next; 85}; 86 87struct hid_data *hid_start_parse(const void *, int, enum hid_kind); 88void hid_end_parse(struct hid_data *); 89int hid_get_item(struct hid_data *, struct hid_item *); 90int hid_report_size(const void *, int, enum hid_kind, uint8_t); 91int hid_locate(const void *, int, int32_t, uint8_t, enum hid_kind, 92 struct hid_location *, uint32_t *); 93int32_t hid_get_data(const uint8_t *buf, int, struct hid_location *); 94uint32_t hid_get_udata(const uint8_t *buf, int, struct hid_location *); 95int hid_is_collection(const void *, int, uint8_t, int32_t); 96struct hid_data *hid_get_collection_data(const void *, int, int32_t, uint32_t); 97int hid_get_id_of_collection(const void *, int, int32_t, uint32_t); 98 99#endif /* _KERNEL */ 100 101/* Usage pages */ 102#define HUP_UNDEFINED 0x0000 103#define HUP_GENERIC_DESKTOP 0x0001 104#define HUP_SIMULATION 0x0002 105#define HUP_VR_CONTROLS 0x0003 106#define HUP_SPORTS_CONTROLS 0x0004 107#define HUP_GAMING_CONTROLS 0x0005 108#define HUP_KEYBOARD 0x0007 109#define HUP_LED 0x0008 110#define HUP_BUTTON 0x0009 111#define HUP_ORDINALS 0x000a 112#define HUP_TELEPHONY 0x000b 113#define HUP_CONSUMER 0x000c 114#define HUP_DIGITIZERS 0x000d 115#define HUP_PHYSICAL_IFACE 0x000e 116#define HUP_UNICODE 0x0010 117#define HUP_ALPHANUM_DISPLAY 0x0014 118#define HUP_MONITOR 0x0080 119#define HUP_MONITOR_ENUM_VAL 0x0081 120#define HUP_VESA_VC 0x0082 121#define HUP_VESA_CMD 0x0083 122#define HUP_POWER 0x0084 123#define HUP_BATTERY 0x0085 124#define HUP_BARCODE_SCANNER 0x008b 125#define HUP_SCALE 0x008c 126#define HUP_CAMERA_CONTROL 0x0090 127#define HUP_ARCADE 0x0091 128#define HUP_VENDOR 0x00ff 129#define HUP_FIDO 0xf1d0 130#define HUP_MICROSOFT 0xff00 131/* XXX compat */ 132#define HUP_APPLE 0x00ff 133#define HUP_WACOM 0xff00 134 135/* Usages, Power Device */ 136#define HUP_INAME 0x0001 137#define HUP_PRESENT_STATUS 0x0002 138#define HUP_CHANGED_STATUS 0x0003 139#define HUP_UPS 0x0004 140#define HUP_POWER_SUPPLY 0x0005 141#define HUP_BATTERY_SYSTEM 0x0010 142#define HUP_BATTERY_SYSTEM_ID 0x0011 143#define HUP_PD_BATTERY 0x0012 144#define HUP_BATTERY_ID 0x0013 145#define HUP_CHARGER 0x0014 146#define HUP_CHARGER_ID 0x0015 147#define HUP_POWER_CONVERTER 0x0016 148#define HUP_POWER_CONVERTER_ID 0x0017 149#define HUP_OUTLET_SYSTEM 0x0018 150#define HUP_OUTLET_SYSTEM_ID 0x0019 151#define HUP_INPUT 0x001a 152#define HUP_INPUT_ID 0x001b 153#define HUP_OUTPUT 0x001c 154#define HUP_OUTPUT_ID 0x001d 155#define HUP_FLOW 0x001e 156#define HUP_FLOW_ID 0x001f 157#define HUP_OUTLET 0x0020 158#define HUP_OUTLET_ID 0x0021 159#define HUP_GANG 0x0022 160#define HUP_GANG_ID 0x0023 161#define HUP_POWER_SUMMARY 0x0024 162#define HUP_POWER_SUMMARY_ID 0x0025 163#define HUP_VOLTAGE 0x0030 164#define HUP_CURRENT 0x0031 165#define HUP_FREQUENCY 0x0032 166#define HUP_APPARENT_POWER 0x0033 167#define HUP_ACTIVE_POWER 0x0034 168#define HUP_PERCENT_LOAD 0x0035 169#define HUP_TEMPERATURE 0x0036 170#define HUP_HUMIDITY 0x0037 171#define HUP_BADCOUNT 0x0038 172#define HUP_CONFIG_VOLTAGE 0x0040 173#define HUP_CONFIG_CURRENT 0x0041 174#define HUP_CONFIG_FREQUENCY 0x0042 175#define HUP_CONFIG_APP_POWER 0x0043 176#define HUP_CONFIG_ACT_POWER 0x0044 177#define HUP_CONFIG_PERCENT_LOAD 0x0045 178#define HUP_CONFIG_TEMPERATURE 0x0046 179#define HUP_CONFIG_HUMIDITY 0x0047 180#define HUP_SWITCHON_CONTROL 0x0050 181#define HUP_SWITCHOFF_CONTROL 0x0051 182#define HUP_TOGGLE_CONTROL 0x0052 183#define HUP_LOW_VOLT_TRANSF 0x0053 184#define HUP_HIGH_VOLT_TRANSF 0x0054 185#define HUP_DELAYBEFORE_REBOOT 0x0055 186#define HUP_DELAYBEFORE_STARTUP 0x0056 187#define HUP_DELAYBEFORE_SHUTDWN 0x0057 188#define HUP_TEST 0x0058 189#define HUP_MODULE_RESET 0x0059 190#define HUP_AUDIBLE_ALRM_CTL 0x005a 191#define HUP_PRESENT 0x0060 192#define HUP_GOOD 0x0061 193#define HUP_INTERNAL_FAILURE 0x0062 194#define HUP_PD_VOLT_OUTOF_RANGE 0x0063 195#define HUP_FREQ_OUTOFRANGE 0x0064 196#define HUP_OVERLOAD 0x0065 197#define HUP_OVERCHARGED 0x0066 198#define HUP_OVERTEMPERATURE 0x0067 199#define HUP_SHUTDOWN_REQUESTED 0x0068 200#define HUP_SHUTDOWN_IMMINENT 0x0069 201#define HUP_SWITCH_ON_OFF 0x006b 202#define HUP_SWITCHABLE 0x006c 203#define HUP_USED 0x006d 204#define HUP_BOOST 0x006e 205#define HUP_BUCK 0x006f 206#define HUP_INITIALIZED 0x0070 207#define HUP_TESTED 0x0071 208#define HUP_AWAITING_POWER 0x0072 209#define HUP_COMMUNICATION_LOST 0x0073 210#define HUP_IMANUFACTURER 0x00fd 211#define HUP_IPRODUCT 0x00fe 212#define HUP_ISERIALNUMBER 0x00ff 213 214/* Usages, Battery */ 215#define HUB_SMB_BATTERY_MODE 0x0001 216#define HUB_SMB_BATTERY_STATUS 0x0002 217#define HUB_SMB_ALARM_WARNING 0x0003 218#define HUB_SMB_CHARGER_MODE 0x0004 219#define HUB_SMB_CHARGER_STATUS 0x0005 220#define HUB_SMB_CHARGER_SPECINF 0x0006 221#define HUB_SMB_SELECTR_STATE 0x0007 222#define HUB_SMB_SELECTR_PRESETS 0x0008 223#define HUB_SMB_SELECTR_INFO 0x0009 224#define HUB_SMB_OPT_MFGFUNC1 0x0010 225#define HUB_SMB_OPT_MFGFUNC2 0x0011 226#define HUB_SMB_OPT_MFGFUNC3 0x0012 227#define HUB_SMB_OPT_MFGFUNC4 0x0013 228#define HUB_SMB_OPT_MFGFUNC5 0x0014 229#define HUB_CONNECTIONTOSMBUS 0x0015 230#define HUB_OUTPUT_CONNECTION 0x0016 231#define HUB_CHARGER_CONNECTION 0x0017 232#define HUB_BATTERY_INSERTION 0x0018 233#define HUB_USENEXT 0x0019 234#define HUB_OKTOUSE 0x001a 235#define HUB_BATTERY_SUPPORTED 0x001b 236#define HUB_SELECTOR_REVISION 0x001c 237#define HUB_CHARGING_INDICATOR 0x001d 238#define HUB_MANUFACTURER_ACCESS 0x0028 239#define HUB_REM_CAPACITY_LIM 0x0029 240#define HUB_REM_TIME_LIM 0x002a 241#define HUB_ATRATE 0x002b 242#define HUB_CAPACITY_MODE 0x002c 243#define HUB_BCAST_TO_CHARGER 0x002d 244#define HUB_PRIMARY_BATTERY 0x002e 245#define HUB_CHANGE_CONTROLLER 0x002f 246#define HUB_TERMINATE_CHARGE 0x0040 247#define HUB_TERMINATE_DISCHARGE 0x0041 248#define HUB_BELOW_REM_CAP_LIM 0x0042 249#define HUB_REM_TIME_LIM_EXP 0x0043 250#define HUB_CHARGING 0x0044 251#define HUB_DISCHARGING 0x0045 252#define HUB_FULLY_CHARGED 0x0046 253#define HUB_FULLY_DISCHARGED 0x0047 254#define HUB_CONDITIONING_FLAG 0x0048 255#define HUB_ATRATE_OK 0x0049 256#define HUB_SMB_ERROR_CODE 0x004a 257#define HUB_NEED_REPLACEMENT 0x004b 258#define HUB_ATRATE_TIMETOFULL 0x0060 259#define HUB_ATRATE_TIMETOEMPTY 0x0061 260#define HUB_AVERAGE_CURRENT 0x0062 261#define HUB_MAXERROR 0x0063 262#define HUB_REL_STATEOF_CHARGE 0x0064 263#define HUB_ABS_STATEOF_CHARGE 0x0065 264#define HUB_REM_CAPACITY 0x0066 265#define HUB_FULLCHARGE_CAPACITY 0x0067 266#define HUB_RUNTIMETO_EMPTY 0x0068 267#define HUB_AVERAGETIMETO_EMPTY 0x0069 268#define HUB_AVERAGETIMETO_FULL 0x006a 269#define HUB_CYCLECOUNT 0x006b 270#define HUB_BATTPACKMODEL_LEVEL 0x0080 271#define HUB_INTERNAL_CHARGE_CTL 0x0081 272#define HUB_PRIMARY_BATTERY_SUP 0x0082 273#define HUB_DESIGN_CAPACITY 0x0083 274#define HUB_SPECIFICATION_INFO 0x0084 275#define HUB_MANUFACTURER_DATE 0x0085 276#define HUB_SERIAL_NUMBER 0x0086 277#define HUB_IMANUFACTURERNAME 0x0087 278#define HUB_IDEVICENAME 0x0088 279#define HUB_IDEVICECHEMISTERY 0x0089 280#define HUB_MANUFACTURERDATA 0x008a 281#define HUB_RECHARGABLE 0x008b 282#define HUB_WARN_CAPACITY_LIM 0x008c 283#define HUB_CAPACITY_GRANUL1 0x008d 284#define HUB_CAPACITY_GRANUL2 0x008e 285#define HUB_IOEM_INFORMATION 0x008f 286#define HUB_INHIBIT_CHARGE 0x00c0 287#define HUB_ENABLE_POLLING 0x00c1 288#define HUB_RESTORE_TO_ZERO 0x00c2 289#define HUB_AC_PRESENT 0x00d0 290#define HUB_BATTERY_PRESENT 0x00d1 291#define HUB_POWER_FAIL 0x00d2 292#define HUB_ALARM_INHIBITED 0x00d3 293#define HUB_THERMISTOR_UNDRANGE 0x00d4 294#define HUB_THERMISTOR_HOT 0x00d5 295#define HUB_THERMISTOR_COLD 0x00d6 296#define HUB_THERMISTOR_OVERANGE 0x00d7 297#define HUB_BS_VOLT_OUTOF_RANGE 0x00d8 298#define HUB_BS_CURR_OUTOF_RANGE 0x00d9 299#define HUB_BS_CURR_NOT_REGULTD 0x00da 300#define HUB_BS_VOLT_NOT_REGULTD 0x00db 301#define HUB_MASTER_MODE 0x00dc 302#define HUB_CHARGER_SELECTR_SUP 0x00f0 303#define HUB_CHARGER_SPEC 0x00f1 304#define HUB_LEVEL2 0x00f2 305#define HUB_LEVEL3 0x00f3 306 307/* Usages, generic desktop */ 308#define HUG_POINTER 0x0001 309#define HUG_MOUSE 0x0002 310#define HUG_FN_KEY 0x0003 311#define HUG_JOYSTICK 0x0004 312#define HUG_GAME_PAD 0x0005 313#define HUG_KEYBOARD 0x0006 314#define HUG_KEYPAD 0x0007 315#define HUG_X 0x0030 316#define HUG_Y 0x0031 317#define HUG_Z 0x0032 318#define HUG_RX 0x0033 319#define HUG_RY 0x0034 320#define HUG_RZ 0x0035 321#define HUG_SLIDER 0x0036 322#define HUG_DIAL 0x0037 323#define HUG_WHEEL 0x0038 324#define HUG_HAT_SWITCH 0x0039 325#define HUG_COUNTED_BUFFER 0x003a 326#define HUG_BYTE_COUNT 0x003b 327#define HUG_MOTION_WAKEUP 0x003c 328#define HUG_VX 0x0040 329#define HUG_VY 0x0041 330#define HUG_VZ 0x0042 331#define HUG_VBRX 0x0043 332#define HUG_VBRY 0x0044 333#define HUG_VBRZ 0x0045 334#define HUG_VNO 0x0046 335#define HUG_TWHEEL 0x0048 336#define HUG_SYSTEM_CONTROL 0x0080 337#define HUG_SYSTEM_POWER_DOWN 0x0081 338#define HUG_SYSTEM_SLEEP 0x0082 339#define HUG_SYSTEM_WAKEUP 0x0083 340#define HUG_SYSTEM_CONTEXT_MENU 0x0084 341#define HUG_SYSTEM_MAIN_MENU 0x0085 342#define HUG_SYSTEM_APP_MENU 0x0086 343#define HUG_SYSTEM_MENU_HELP 0x0087 344#define HUG_SYSTEM_MENU_EXIT 0x0088 345#define HUG_SYSTEM_MENU_SELECT 0x0089 346#define HUG_SYSTEM_MENU_RIGHT 0x008a 347#define HUG_SYSTEM_MENU_LEFT 0x008b 348#define HUG_SYSTEM_MENU_UP 0x008c 349#define HUG_SYSTEM_MENU_DOWN 0x008d 350 351/* Usages, Digitizers */ 352#define HUD_UNDEFINED 0x0000 353#define HUD_DIGITIZER 0x0001 354#define HUD_PEN 0x0002 355#define HUD_TOUCHSCREEN 0x0004 356#define HUD_TOUCHPAD 0x0005 357#define HUD_CONFIG 0x000e 358#define HUD_STYLUS 0x0020 359#define HUD_FINGER 0x0022 360#define HUD_TIP_PRESSURE 0x0030 361#define HUD_BARREL_PRESSURE 0x0031 362#define HUD_IN_RANGE 0x0032 363#define HUD_TOUCH 0x0033 364#define HUD_UNTOUCH 0x0034 365#define HUD_TAP 0x0035 366#define HUD_QUALITY 0x0036 367#define HUD_DATA_VALID 0x0037 368#define HUD_TRANSDUCER_INDEX 0x0038 369#define HUD_TABLET_FKEYS 0x0039 370#define HUD_PROGRAM_CHANGE_KEYS 0x003a 371#define HUD_BATTERY_STRENGTH 0x003b 372#define HUD_INVERT 0x003c 373#define HUD_X_TILT 0x003d 374#define HUD_Y_TILT 0x003e 375#define HUD_AZIMUTH 0x003f 376#define HUD_ALTITUDE 0x0040 377#define HUD_TWIST 0x0041 378#define HUD_TIP_SWITCH 0x0042 379#define HUD_SEC_TIP_SWITCH 0x0043 380#define HUD_BARREL_SWITCH 0x0044 381#define HUD_ERASER 0x0045 382#define HUD_TABLET_PICK 0x0046 383#define HUD_CONFIDENCE 0x0047 384#define HUD_WIDTH 0x0048 385#define HUD_HEIGHT 0x0049 386#define HUD_CONTACTID 0x0051 387#define HUD_INPUT_MODE 0x0052 388#define HUD_DEVICE_INDEX 0x0053 389#define HUD_CONTACTCOUNT 0x0054 390#define HUD_CONTACT_MAX 0x0055 391#define HUD_SCAN_TIME 0x0056 392#define HUD_BUTTON_TYPE 0x0059 393#define HUD_SECONDARY_BARREL_SWITCH 0x005A 394#define HUD_WACOM_X 0x0130 395#define HUD_WACOM_Y 0x0131 396#define HUD_WACOM_DISTANCE 0x0132 397#define HUD_WACOM_PAD_BUTTONS00 0x0910 398#define HUD_WACOM_BATTERY 0x1013 399 400/* Usages, LED */ 401#define HUL_NUM_LOCK 0x0001 402#define HUL_CAPS_LOCK 0x0002 403#define HUL_SCROLL_LOCK 0x0003 404#define HUL_COMPOSE 0x0004 405#define HUL_KANA 0x0005 406 407/* Usages, Consumer */ 408#define HUC_CONTROL 0x0001 409#define HUC_TRACK_NEXT 0x00b5 410#define HUC_TRACK_PREV 0x00b6 411#define HUC_STOP 0x00b7 412#define HUC_PLAY_PAUSE 0x00cd 413#define HUC_VOLUME 0x00e0 414#define HUC_MUTE 0x00e2 415#define HUC_VOL_INC 0x00e9 416#define HUC_VOL_DEC 0x00ea 417#define HUC_AC_PAN 0x0238 418 419/* Usages, FIDO */ 420#define HUF_U2FHID 0x0001 421#define HUF_RAW_IN_DATA_REPORT 0x0020 422#define HUF_RAW_OUT_DATA_REPORT 0x0021 423 424#define HID_USAGE2(p, u) (((p) << 16) | u) 425#define HID_GET_USAGE(u) ((u) & 0xffff) 426#define HID_GET_USAGE_PAGE(u) (((u) >> 16) & 0xffff) 427 428#define HCOLL_PHYSICAL 0 429#define HCOLL_APPLICATION 1 430#define HCOLL_LOGICAL 2 431 432/* Bits in the input/output/feature items */ 433#define HIO_CONST 0x001 434#define HIO_VARIABLE 0x002 435#define HIO_RELATIVE 0x004 436#define HIO_WRAP 0x008 437#define HIO_NONLINEAR 0x010 438#define HIO_NOPREF 0x020 439#define HIO_NULLSTATE 0x040 440#define HIO_VOLATILE 0x080 441#define HIO_BUFBYTES 0x100 442 443/* Valid values for the country codes */ 444#define HCC_UNDEFINED 0x00 445#define HCC_MAX 0x23 446 447#endif /* _HIDHID_H_ */ 448