1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 5 * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved. 6 * Copyright (c) 1998 Lennart Augustsson. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 #ifndef _HID_HID_H_ 31 #define _HID_HID_H_ 32 33 /* Usage pages */ 34 #define HUP_UNDEFINED 0x0000 35 #define HUP_GENERIC_DESKTOP 0x0001 36 #define HUP_SIMULATION 0x0002 37 #define HUP_VR_CONTROLS 0x0003 38 #define HUP_SPORTS_CONTROLS 0x0004 39 #define HUP_GAMING_CONTROLS 0x0005 40 #define HUP_KEYBOARD 0x0007 41 #define HUP_LEDS 0x0008 42 #define HUP_BUTTON 0x0009 43 #define HUP_ORDINALS 0x000a 44 #define HUP_TELEPHONY 0x000b 45 #define HUP_CONSUMER 0x000c 46 #define HUP_DIGITIZERS 0x000d 47 #define HUP_PHYSICAL_IFACE 0x000e 48 #define HUP_UNICODE 0x0010 49 #define HUP_ALPHANUM_DISPLAY 0x0014 50 #define HUP_MONITOR 0x0080 51 #define HUP_MONITOR_ENUM_VAL 0x0081 52 #define HUP_VESA_VC 0x0082 53 #define HUP_VESA_CMD 0x0083 54 #define HUP_POWER 0x0084 55 #define HUP_BATTERY_SYSTEM 0x0085 56 #define HUP_BARCODE_SCANNER 0x008b 57 #define HUP_SCALE 0x008c 58 #define HUP_CAMERA_CONTROL 0x0090 59 #define HUP_ARCADE 0x0091 60 #define HUP_APPLE 0x00ff 61 #define HUP_FIDO 0xf1d0 62 #define HUP_MICROSOFT 0xff00 63 #define HUP_HP 0xff01 64 65 /* Usages, generic desktop */ 66 #define HUG_POINTER 0x0001 67 #define HUG_MOUSE 0x0002 68 #define HUG_JOYSTICK 0x0004 69 #define HUG_GAME_PAD 0x0005 70 #define HUG_KEYBOARD 0x0006 71 #define HUG_KEYPAD 0x0007 72 #define HUG_MULTIAXIS_CNTROLLER 0x0008 73 #define HUG_X 0x0030 74 #define HUG_Y 0x0031 75 #define HUG_Z 0x0032 76 #define HUG_RX 0x0033 77 #define HUG_RY 0x0034 78 #define HUG_RZ 0x0035 79 #define HUG_SLIDER 0x0036 80 #define HUG_DIAL 0x0037 81 #define HUG_WHEEL 0x0038 82 #define HUG_HAT_SWITCH 0x0039 83 #define HUG_COUNTED_BUFFER 0x003a 84 #define HUG_BYTE_COUNT 0x003b 85 #define HUG_MOTION_WAKEUP 0x003c 86 #define HUG_VX 0x0040 87 #define HUG_VY 0x0041 88 #define HUG_VZ 0x0042 89 #define HUG_VBRX 0x0043 90 #define HUG_VBRY 0x0044 91 #define HUG_VBRZ 0x0045 92 #define HUG_VNO 0x0046 93 #define HUG_TWHEEL 0x0048 /* M$ Wireless Intellimouse Wheel */ 94 #define HUG_SYSTEM_CONTROL 0x0080 95 #define HUG_SYSTEM_POWER_DOWN 0x0081 96 #define HUG_SYSTEM_SLEEP 0x0082 97 #define HUG_SYSTEM_WAKEUP 0x0083 98 #define HUG_SYSTEM_CONTEXT_MENU 0x0084 99 #define HUG_SYSTEM_MAIN_MENU 0x0085 100 #define HUG_SYSTEM_APP_MENU 0x0086 101 #define HUG_SYSTEM_MENU_HELP 0x0087 102 #define HUG_SYSTEM_MENU_EXIT 0x0088 103 #define HUG_SYSTEM_MENU_SELECT 0x0089 104 #define HUG_SYSTEM_MENU_RIGHT 0x008a 105 #define HUG_SYSTEM_MENU_LEFT 0x008b 106 #define HUG_SYSTEM_MENU_UP 0x008c 107 #define HUG_SYSTEM_MENU_DOWN 0x008d 108 #define HUG_SYSTEM_POWER_UP 0x008e 109 #define HUG_SYSTEM_RESTART 0x008f 110 #define HUG_D_PAD_UP 0x0090 111 #define HUG_D_PAD_DOWN 0x0091 112 #define HUG_D_PAD_RIGHT 0x0092 113 #define HUG_D_PAD_LEFT 0x0093 114 #define HUG_APPLE_EJECT 0x00b8 115 116 /* Usages Digitizers */ 117 #define HUD_UNDEFINED 0x0000 118 #define HUD_DIGITIZER 0x0001 119 #define HUD_PEN 0x0002 120 #define HUD_TOUCHSCREEN 0x0004 121 #define HUD_TOUCHPAD 0x0005 122 #define HUD_CONFIG 0x000e 123 #define HUD_FINGER 0x0022 124 #define HUD_TIP_PRESSURE 0x0030 125 #define HUD_BARREL_PRESSURE 0x0031 126 #define HUD_IN_RANGE 0x0032 127 #define HUD_TOUCH 0x0033 128 #define HUD_UNTOUCH 0x0034 129 #define HUD_TAP 0x0035 130 #define HUD_QUALITY 0x0036 131 #define HUD_DATA_VALID 0x0037 132 #define HUD_TRANSDUCER_INDEX 0x0038 133 #define HUD_TABLET_FKEYS 0x0039 134 #define HUD_PROGRAM_CHANGE_KEYS 0x003a 135 #define HUD_BATTERY_STRENGTH 0x003b 136 #define HUD_INVERT 0x003c 137 #define HUD_X_TILT 0x003d 138 #define HUD_Y_TILT 0x003e 139 #define HUD_AZIMUTH 0x003f 140 #define HUD_ALTITUDE 0x0040 141 #define HUD_TWIST 0x0041 142 #define HUD_TIP_SWITCH 0x0042 143 #define HUD_SEC_TIP_SWITCH 0x0043 144 #define HUD_BARREL_SWITCH 0x0044 145 #define HUD_ERASER 0x0045 146 #define HUD_TABLET_PICK 0x0046 147 #define HUD_CONFIDENCE 0x0047 148 #define HUD_WIDTH 0x0048 149 #define HUD_HEIGHT 0x0049 150 #define HUD_CONTACTID 0x0051 151 #define HUD_INPUT_MODE 0x0052 152 #define HUD_DEVICE_INDEX 0x0053 153 #define HUD_CONTACTCOUNT 0x0054 154 #define HUD_CONTACT_MAX 0x0055 155 #define HUD_SCAN_TIME 0x0056 156 #define HUD_SURFACE_SWITCH 0x0057 157 #define HUD_BUTTONS_SWITCH 0x0058 158 #define HUD_BUTTON_TYPE 0x0059 159 #define HUD_SEC_BARREL_SWITCH 0x005a 160 #define HUD_LATENCY_MODE 0x0060 161 162 /* Usages, Consumer */ 163 #define HUC_CONTROL 0x0001 164 #define HUC_HEADPHONE 0x0005 165 #define HUC_AC_PAN 0x0238 166 167 /* Usages, FIDO */ 168 #define HUF_U2FHID 0x0001 169 170 #define HID_USAGE2(p,u) (((p) << 16) | (u)) 171 #define HID_GET_USAGE(u) ((u) & 0xffff) 172 #define HID_GET_USAGE_PAGE(u) (((u) >> 16) & 0xffff) 173 174 #define HID_INPUT_REPORT 0x01 175 #define HID_OUTPUT_REPORT 0x02 176 #define HID_FEATURE_REPORT 0x03 177 178 /* Bits in the input/output/feature items */ 179 #define HIO_CONST 0x001 180 #define HIO_VARIABLE 0x002 181 #define HIO_RELATIVE 0x004 182 #define HIO_WRAP 0x008 183 #define HIO_NONLINEAR 0x010 184 #define HIO_NOPREF 0x020 185 #define HIO_NULLSTATE 0x040 186 #define HIO_VOLATILE 0x080 187 #define HIO_BUFBYTES 0x100 188 189 /* Units of Measure */ 190 #define HUM_CENTIMETER 0x11 191 #define HUM_RADIAN 0x12 192 #define HUM_INCH 0x13 193 #define HUM_INCH_EGALAX 0x33 194 #define HUM_DEGREE 0x14 195 196 #if defined(_KERNEL) || defined(_STANDALONE) 197 198 #define HID_ITEM_MAXUSAGE 8 199 #define HID_MAX_AUTO_QUIRK 8 /* maximum number of dynamic quirks */ 200 #define HID_PNP_ID_SIZE 20 /* includes null terminator */ 201 202 /* Declare global HID debug variable. */ 203 extern int hid_debug; 204 205 /* Check if HID debugging is enabled. */ 206 #ifdef HID_DEBUG_VAR 207 #ifdef HID_DEBUG 208 #define DPRINTFN(n,fmt,...) do { \ 209 if ((HID_DEBUG_VAR) >= (n)) { \ 210 printf("%s: " fmt, \ 211 __FUNCTION__ ,##__VA_ARGS__); \ 212 } \ 213 } while (0) 214 #define DPRINTF(...) DPRINTFN(1, __VA_ARGS__) 215 #else 216 #define DPRINTF(...) do { } while (0) 217 #define DPRINTFN(...) do { } while (0) 218 #endif 219 #endif 220 221 /* Declare parent SYSCTL HID node. */ 222 #ifdef SYSCTL_DECL 223 SYSCTL_DECL(_hw_hid); 224 #endif 225 226 typedef uint32_t hid_size_t; 227 228 #define HID_IN_POLLING_MODE() (SCHEDULER_STOPPED() || kdb_active) 229 230 enum hid_kind { 231 hid_input, hid_output, hid_feature, hid_collection, hid_endcollection 232 }; 233 234 struct hid_location { 235 uint32_t size; 236 uint32_t count; 237 uint32_t pos; 238 }; 239 240 struct hid_item { 241 /* Global */ 242 uint32_t _usage_page; 243 int32_t logical_minimum; 244 int32_t logical_maximum; 245 int32_t physical_minimum; 246 int32_t physical_maximum; 247 uint32_t unit_exponent; 248 uint32_t unit; 249 uint32_t report_ID; 250 /* Local */ 251 int nusages; 252 union { 253 uint32_t usage; 254 uint32_t usages[HID_ITEM_MAXUSAGE]; 255 }; 256 uint32_t usage_minimum; 257 uint32_t usage_maximum; 258 uint32_t designator_index; 259 uint32_t designator_minimum; 260 uint32_t designator_maximum; 261 uint32_t string_index; 262 uint32_t string_minimum; 263 uint32_t string_maximum; 264 uint32_t set_delimiter; 265 /* Misc */ 266 uint32_t collection; 267 int collevel; 268 enum hid_kind kind; 269 uint32_t flags; 270 /* Location */ 271 struct hid_location loc; 272 }; 273 274 struct hid_absinfo { 275 int32_t min; 276 int32_t max; 277 int32_t res; 278 }; 279 280 struct hid_device_info { 281 char name[80]; 282 char serial[80]; 283 char idPnP[HID_PNP_ID_SIZE]; 284 uint16_t idBus; 285 uint16_t idVendor; 286 uint16_t idProduct; 287 uint16_t idVersion; 288 hid_size_t rdescsize; /* Report descriptor size */ 289 uint8_t autoQuirk[HID_MAX_AUTO_QUIRK]; 290 }; 291 292 struct hid_rdesc_info { 293 void *data; 294 hid_size_t len; 295 hid_size_t isize; 296 hid_size_t osize; 297 hid_size_t fsize; 298 uint8_t iid; 299 uint8_t oid; 300 uint8_t fid; 301 /* Max sizes for HID requests supported by transport backend */ 302 hid_size_t rdsize; 303 hid_size_t wrsize; 304 hid_size_t grsize; 305 hid_size_t srsize; 306 }; 307 308 typedef void hid_intr_t(void *context, void *data, hid_size_t len); 309 typedef bool hid_test_quirk_t(const struct hid_device_info *dev_info, 310 uint16_t quirk); 311 312 extern hid_test_quirk_t *hid_test_quirk_p; 313 314 /* prototypes from "usb_hid.c" */ 315 316 struct hid_data *hid_start_parse(const void *d, hid_size_t len, int kindset); 317 void hid_end_parse(struct hid_data *s); 318 int hid_get_item(struct hid_data *s, struct hid_item *h); 319 int hid_report_size(const void *buf, hid_size_t len, enum hid_kind k, 320 uint8_t id); 321 int hid_report_size_max(const void *buf, hid_size_t len, enum hid_kind k, 322 uint8_t *id); 323 int hid_locate(const void *desc, hid_size_t size, int32_t usage, 324 enum hid_kind kind, uint8_t index, struct hid_location *loc, 325 uint32_t *flags, uint8_t *id); 326 int32_t hid_get_data(const uint8_t *buf, hid_size_t len, 327 struct hid_location *loc); 328 uint32_t hid_get_udata(const uint8_t *buf, hid_size_t len, 329 struct hid_location *loc); 330 void hid_put_udata(uint8_t *buf, hid_size_t len, 331 struct hid_location *loc, unsigned int value); 332 int hid_is_collection(const void *desc, hid_size_t size, int32_t usage); 333 int32_t hid_item_resolution(struct hid_item *hi); 334 int hid_is_mouse(const void *d_ptr, uint16_t d_len); 335 int hid_is_keyboard(const void *d_ptr, uint16_t d_len); 336 bool hid_test_quirk(const struct hid_device_info *dev_info, uint16_t quirk); 337 int hid_add_dynamic_quirk(struct hid_device_info *dev_info, 338 uint16_t quirk); 339 void hid_quirk_unload(void *arg); 340 341 int hid_intr_start(device_t); 342 int hid_intr_stop(device_t); 343 void hid_intr_poll(device_t); 344 int hid_get_rdesc(device_t, void *, hid_size_t); 345 int hid_read(device_t, void *, hid_size_t, hid_size_t *); 346 int hid_write(device_t, const void *, hid_size_t); 347 int hid_get_report(device_t, void *, hid_size_t, hid_size_t *, uint8_t, 348 uint8_t); 349 int hid_set_report(device_t, const void *, hid_size_t, uint8_t, uint8_t); 350 int hid_set_idle(device_t, uint16_t, uint8_t); 351 int hid_set_protocol(device_t, uint16_t); 352 int hid_ioctl(device_t, unsigned long, uintptr_t); 353 #endif /* _KERNEL || _STANDALONE */ 354 #endif /* _HID_HID_H_ */ 355