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_MICROSOFT 0xff00 61 62/* Usages, generic desktop */ 63#define HUG_POINTER 0x0001 64#define HUG_MOUSE 0x0002 65#define HUG_JOYSTICK 0x0004 66#define HUG_GAME_PAD 0x0005 67#define HUG_KEYBOARD 0x0006 68#define HUG_KEYPAD 0x0007 69#define HUG_MULTIAXIS_CNTROLLER 0x0008 70#define HUG_X 0x0030 71#define HUG_Y 0x0031 72#define HUG_Z 0x0032 73#define HUG_RX 0x0033 74#define HUG_RY 0x0034 75#define HUG_RZ 0x0035 76#define HUG_SLIDER 0x0036 77#define HUG_DIAL 0x0037 78#define HUG_WHEEL 0x0038 79#define HUG_HAT_SWITCH 0x0039 80#define HUG_COUNTED_BUFFER 0x003a 81#define HUG_BYTE_COUNT 0x003b 82#define HUG_MOTION_WAKEUP 0x003c 83#define HUG_VX 0x0040 84#define HUG_VY 0x0041 85#define HUG_VZ 0x0042 86#define HUG_VBRX 0x0043 87#define HUG_VBRY 0x0044 88#define HUG_VBRZ 0x0045 89#define HUG_VNO 0x0046 90#define HUG_TWHEEL 0x0048 /* M$ Wireless Intellimouse Wheel */ 91#define HUG_SYSTEM_CONTROL 0x0080 92#define HUG_SYSTEM_POWER_DOWN 0x0081 93#define HUG_SYSTEM_SLEEP 0x0082 94#define HUG_SYSTEM_WAKEUP 0x0083 95#define HUG_SYSTEM_CONTEXT_MENU 0x0084 96#define HUG_SYSTEM_MAIN_MENU 0x0085 97#define HUG_SYSTEM_APP_MENU 0x0086 98#define HUG_SYSTEM_MENU_HELP 0x0087 99#define HUG_SYSTEM_MENU_EXIT 0x0088 100#define HUG_SYSTEM_MENU_SELECT 0x0089 101#define HUG_SYSTEM_MENU_RIGHT 0x008a 102#define HUG_SYSTEM_MENU_LEFT 0x008b 103#define HUG_SYSTEM_MENU_UP 0x008c 104#define HUG_SYSTEM_MENU_DOWN 0x008d 105#define HUG_SYSTEM_POWER_UP 0x008e 106#define HUG_SYSTEM_RESTART 0x008f 107#define HUG_D_PAD_UP 0x0090 108#define HUG_D_PAD_DOWN 0x0091 109#define HUG_D_PAD_RIGHT 0x0092 110#define HUG_D_PAD_LEFT 0x0093 111#define HUG_APPLE_EJECT 0x00b8 112 113/* Usages Digitizers */ 114#define HUD_UNDEFINED 0x0000 115#define HUD_DIGITIZER 0x0001 116#define HUD_PEN 0x0002 117#define HUD_TOUCHSCREEN 0x0004 118#define HUD_TOUCHPAD 0x0005 119#define HUD_CONFIG 0x000e 120#define HUD_FINGER 0x0022 121#define HUD_TIP_PRESSURE 0x0030 122#define HUD_BARREL_PRESSURE 0x0031 123#define HUD_IN_RANGE 0x0032 124#define HUD_TOUCH 0x0033 125#define HUD_UNTOUCH 0x0034 126#define HUD_TAP 0x0035 127#define HUD_QUALITY 0x0036 128#define HUD_DATA_VALID 0x0037 129#define HUD_TRANSDUCER_INDEX 0x0038 130#define HUD_TABLET_FKEYS 0x0039 131#define HUD_PROGRAM_CHANGE_KEYS 0x003a 132#define HUD_BATTERY_STRENGTH 0x003b 133#define HUD_INVERT 0x003c 134#define HUD_X_TILT 0x003d 135#define HUD_Y_TILT 0x003e 136#define HUD_AZIMUTH 0x003f 137#define HUD_ALTITUDE 0x0040 138#define HUD_TWIST 0x0041 139#define HUD_TIP_SWITCH 0x0042 140#define HUD_SEC_TIP_SWITCH 0x0043 141#define HUD_BARREL_SWITCH 0x0044 142#define HUD_ERASER 0x0045 143#define HUD_TABLET_PICK 0x0046 144#define HUD_CONFIDENCE 0x0047 145#define HUD_WIDTH 0x0048 146#define HUD_HEIGHT 0x0049 147#define HUD_CONTACTID 0x0051 148#define HUD_INPUT_MODE 0x0052 149#define HUD_DEVICE_INDEX 0x0053 150#define HUD_CONTACTCOUNT 0x0054 151#define HUD_CONTACT_MAX 0x0055 152#define HUD_SCAN_TIME 0x0056 153#define HUD_SURFACE_SWITCH 0x0057 154#define HUD_BUTTONS_SWITCH 0x0058 155#define HUD_BUTTON_TYPE 0x0059 156#define HUD_SEC_BARREL_SWITCH 0x005a 157#define HUD_LATENCY_MODE 0x0060 158 159/* Usages, Consumer */ 160#define HUC_CONTROL 0x0001 161#define HUC_HEADPHONE 0x0005 162#define HUC_AC_PAN 0x0238 163 164#define HID_USAGE2(p,u) (((p) << 16) | (u)) 165#define HID_GET_USAGE(u) ((u) & 0xffff) 166#define HID_GET_USAGE_PAGE(u) (((u) >> 16) & 0xffff) 167 168#define HID_INPUT_REPORT 0x01 169#define HID_OUTPUT_REPORT 0x02 170#define HID_FEATURE_REPORT 0x03 171 172/* Bits in the input/output/feature items */ 173#define HIO_CONST 0x001 174#define HIO_VARIABLE 0x002 175#define HIO_RELATIVE 0x004 176#define HIO_WRAP 0x008 177#define HIO_NONLINEAR 0x010 178#define HIO_NOPREF 0x020 179#define HIO_NULLSTATE 0x040 180#define HIO_VOLATILE 0x080 181#define HIO_BUFBYTES 0x100 182 183/* Units of Measure */ 184#define HUM_CENTIMETER 0x11 185#define HUM_RADIAN 0x12 186#define HUM_INCH 0x13 187#define HUM_INCH_EGALAX 0x33 188#define HUM_DEGREE 0x14 189 190#if defined(_KERNEL) || defined(_STANDALONE) 191 192#define HID_ITEM_MAXUSAGE 8 193#define HID_MAX_AUTO_QUIRK 8 /* maximum number of dynamic quirks */ 194#define HID_PNP_ID_SIZE 20 /* includes null terminator */ 195 196/* Declare global HID debug variable. */ 197extern int hid_debug; 198 199/* Check if HID debugging is enabled. */ 200#ifdef HID_DEBUG_VAR 201#ifdef HID_DEBUG 202#define DPRINTFN(n,fmt,...) do { \ 203 if ((HID_DEBUG_VAR) >= (n)) { \ 204 printf("%s: " fmt, \ 205 __FUNCTION__ ,##__VA_ARGS__); \ 206 } \ 207} while (0) 208#define DPRINTF(...) DPRINTFN(1, __VA_ARGS__) 209#else 210#define DPRINTF(...) do { } while (0) 211#define DPRINTFN(...) do { } while (0) 212#endif 213#endif 214 215/* Declare parent SYSCTL HID node. */ 216#ifdef SYSCTL_DECL 217SYSCTL_DECL(_hw_hid); 218#endif 219 220typedef uint32_t hid_size_t; 221 222#define HID_IN_POLLING_MODE() (SCHEDULER_STOPPED() || kdb_active) 223 224enum hid_kind { 225 hid_input, hid_output, hid_feature, hid_collection, hid_endcollection 226}; 227 228struct hid_location { 229 uint32_t size; 230 uint32_t count; 231 uint32_t pos; 232}; 233 234struct hid_item { 235 /* Global */ 236 int32_t _usage_page; 237 int32_t logical_minimum; 238 int32_t logical_maximum; 239 int32_t physical_minimum; 240 int32_t physical_maximum; 241 int32_t unit_exponent; 242 int32_t unit; 243 int32_t report_ID; 244 /* Local */ 245 int nusages; 246 union { 247 int32_t usage; 248 int32_t usages[HID_ITEM_MAXUSAGE]; 249 }; 250 int32_t usage_minimum; 251 int32_t usage_maximum; 252 int32_t designator_index; 253 int32_t designator_minimum; 254 int32_t designator_maximum; 255 int32_t string_index; 256 int32_t string_minimum; 257 int32_t string_maximum; 258 int32_t set_delimiter; 259 /* Misc */ 260 int32_t collection; 261 int collevel; 262 enum hid_kind kind; 263 uint32_t flags; 264 /* Location */ 265 struct hid_location loc; 266}; 267 268struct hid_absinfo { 269 int32_t min; 270 int32_t max; 271 int32_t res; 272}; 273 274struct hid_device_info { 275 char name[80]; 276 char serial[80]; 277 char idPnP[HID_PNP_ID_SIZE]; 278 uint16_t idBus; 279 uint16_t idVendor; 280 uint16_t idProduct; 281 uint16_t idVersion; 282 hid_size_t rdescsize; /* Report descriptor size */ 283 uint8_t autoQuirk[HID_MAX_AUTO_QUIRK]; 284}; 285 286struct hid_rdesc_info { 287 void *data; 288 hid_size_t len; 289 hid_size_t isize; 290 hid_size_t osize; 291 hid_size_t fsize; 292 uint8_t iid; 293 uint8_t oid; 294 uint8_t fid; 295 /* Max sizes for HID requests supported by transport backend */ 296 hid_size_t rdsize; 297 hid_size_t wrsize; 298 hid_size_t grsize; 299 hid_size_t srsize; 300}; 301 302typedef void hid_intr_t(void *context, void *data, hid_size_t len); 303typedef bool hid_test_quirk_t(const struct hid_device_info *dev_info, 304 uint16_t quirk); 305 306extern hid_test_quirk_t *hid_test_quirk_p; 307 308/* prototypes from "usb_hid.c" */ 309 310struct hid_data *hid_start_parse(const void *d, hid_size_t len, int kindset); 311void hid_end_parse(struct hid_data *s); 312int hid_get_item(struct hid_data *s, struct hid_item *h); 313int hid_report_size(const void *buf, hid_size_t len, enum hid_kind k, 314 uint8_t id); 315int hid_report_size_max(const void *buf, hid_size_t len, enum hid_kind k, 316 uint8_t *id); 317int hid_locate(const void *desc, hid_size_t size, int32_t usage, 318 enum hid_kind kind, uint8_t index, struct hid_location *loc, 319 uint32_t *flags, uint8_t *id); 320int32_t hid_get_data(const uint8_t *buf, hid_size_t len, 321 struct hid_location *loc); 322uint32_t hid_get_udata(const uint8_t *buf, hid_size_t len, 323 struct hid_location *loc); 324void hid_put_udata(uint8_t *buf, hid_size_t len, 325 struct hid_location *loc, unsigned int value); 326int hid_is_collection(const void *desc, hid_size_t size, int32_t usage); 327int32_t hid_item_resolution(struct hid_item *hi); 328int hid_is_mouse(const void *d_ptr, uint16_t d_len); 329int hid_is_keyboard(const void *d_ptr, uint16_t d_len); 330bool hid_test_quirk(const struct hid_device_info *dev_info, uint16_t quirk); 331int hid_add_dynamic_quirk(struct hid_device_info *dev_info, 332 uint16_t quirk); 333void hid_quirk_unload(void *arg); 334 335int hid_intr_start(device_t); 336int hid_intr_stop(device_t); 337void hid_intr_poll(device_t); 338int hid_get_rdesc(device_t, void *, hid_size_t); 339int hid_read(device_t, void *, hid_size_t, hid_size_t *); 340int hid_write(device_t, const void *, hid_size_t); 341int hid_get_report(device_t, void *, hid_size_t, hid_size_t *, uint8_t, 342 uint8_t); 343int hid_set_report(device_t, const void *, hid_size_t, uint8_t, uint8_t); 344int hid_set_idle(device_t, uint16_t, uint8_t); 345int hid_set_protocol(device_t, uint16_t); 346int hid_ioctl(device_t, unsigned long, uintptr_t); 347#endif /* _KERNEL || _STANDALONE */ 348#endif /* _HID_HID_H_ */ 349