sys/bus/usb/usbhid.h

   1 /*      $NetBSD: usbhid.h,v 1.9 2000/09/03 19:09:14 augustss Exp $      */
   2 /*      $FreeBSD: src/sys/dev/usb/usbhid.h,v 1.7.2.2 2000/10/31 23:03:00 n_hibma Exp $ */
   3 /*      $DragonFly: src/sys/bus/usb/usbhid.h,v 1.2 2003/06/17 04:28:32 dillon 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  * 3. All advertising materials mentioning features or use of this software
  22  *    must display the following acknowledgement:
  23  *        This product includes software developed by the NetBSD
  24  *        Foundation, Inc. and its contributors.
  25  * 4. Neither the name of The NetBSD Foundation nor the names of its
  26  *    contributors may be used to endorse or promote products derived
  27  *    from this software without specific prior written permission.
  28  *
  29  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  30  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  31  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  32  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  33  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  34  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  35  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  36  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  37  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  39  * POSSIBILITY OF SUCH DAMAGE.
  40  */
  41
  42
  43 #ifndef _USBHID_H_
  44 #define _USBHID_H_
  45
  46 #define UR_GET_HID_DESCRIPTOR   0x06
  47 #define  UDESC_HID              0x21
  48 #define  UDESC_REPORT           0x22
  49 #define  UDESC_PHYSICAL         0x23
  50 #define UR_SET_HID_DESCRIPTOR   0x07
  51 #define UR_GET_REPORT           0x01
  52 #define UR_SET_REPORT           0x09
  53 #define UR_GET_IDLE             0x02
  54 #define UR_SET_IDLE             0x0a
  55 #define UR_GET_PROTOCOL         0x03
  56 #define UR_SET_PROTOCOL         0x0b
  57
  58 #if defined(__FreeBSD__)
  59 #define UPACKED __attribute__ ((packed))
  60 #endif
  61
  62 typedef struct usb_hid_descriptor {
  63         uByte           bLength;
  64         uByte           bDescriptorType;
  65         uWord           bcdHID;
  66         uByte           bCountryCode;
  67         uByte           bNumDescriptors;
  68         struct {
  69                 uByte           bDescriptorType;
  70                 uWord           wDescriptorLength;
  71         } descrs[1];
  72 } UPACKED usb_hid_descriptor_t;
  73 #define USB_HID_DESCRIPTOR_SIZE(n) (9+(n)*3)
  74
  75 /* Usage pages */
  76 #define HUP_UNDEFINED           0x0000
  77 #define HUP_GENERIC_DESKTOP     0x0001
  78 #define HUP_SIMULATION          0x0002
  79 #define HUP_VR_CONTROLS         0x0003
  80 #define HUP_SPORTS_CONTROLS     0x0004
  81 #define HUP_GAMING_CONTROLS     0x0005
  82 #define HUP_KEYBOARD            0x0007
  83 #define HUP_LEDS                0x0008
  84 #define HUP_BUTTON              0x0009
  85 #define HUP_ORDINALS            0x000a
  86 #define HUP_TELEPHONY           0x000b
  87 #define HUP_CONSUMER            0x000c
  88 #define HUP_DIGITIZERS          0x000d
  89 #define HUP_PHYSICAL_IFACE      0x000e
  90 #define HUP_UNICODE             0x0010
  91 #define HUP_ALPHANUM_DISPLAY    0x0014
  92 #define HUP_MONITOR             0x0080
  93 #define HUP_MONITOR_ENUM_VAL    0x0081
  94 #define HUP_VESA_VC             0x0082
  95 #define HUP_VESA_CMD            0x0083
  96 #define HUP_POWER               0x0084
  97 #define HUP_BATTERY_SYSTEM      0x0085
  98 #define HUP_BARCODE_SCANNER     0x008b
  99 #define HUP_SCALE               0x008c
 100 #define HUP_CAMERA_CONTROL      0x0090
 101 #define HUP_ARCADE              0x0091
 102 #define HUP_MICROSOFT           0xff00
 103
 104 /* Usages, generic desktop */
 105 #define HUG_POINTER             0x0001
 106 #define HUG_MOUSE               0x0002
 107 #define HUG_JOYSTICK            0x0004
 108 #define HUG_GAME_PAD            0x0005
 109 #define HUG_KEYBOARD            0x0006
 110 #define HUG_KEYPAD              0x0007
 111 #define HUG_X                   0x0030
 112 #define HUG_Y                   0x0031
 113 #define HUG_Z                   0x0032
 114 #define HUG_RX                  0x0033
 115 #define HUG_RY                  0x0034
 116 #define HUG_RZ                  0x0035
 117 #define HUG_SLIDER              0x0036
 118 #define HUG_DIAL                0x0037
 119 #define HUG_WHEEL               0x0038
 120 #define HUG_HAT_SWITCH          0x0039
 121 #define HUG_COUNTED_BUFFER      0x003a
 122 #define HUG_BYTE_COUNT          0x003b
 123 #define HUG_MOTION_WAKEUP       0x003c
 124 #define HUG_VX                  0x0040
 125 #define HUG_VY                  0x0041
 126 #define HUG_VZ                  0x0042
 127 #define HUG_VBRX                0x0043
 128 #define HUG_VBRY                0x0044
 129 #define HUG_VBRZ                0x0045
 130 #define HUG_VNO                 0x0046
 131 #define HUG_SYSTEM_CONTROL      0x0080
 132 #define HUG_SYSTEM_POWER_DOWN   0x0081
 133 #define HUG_SYSTEM_SLEEP        0x0082
 134 #define HUG_SYSTEM_WAKEUP       0x0083
 135 #define HUG_SYSTEM_CONTEXT_MENU 0x0084
 136 #define HUG_SYSTEM_MAIN_MENU    0x0085
 137 #define HUG_SYSTEM_APP_MENU     0x0086
 138 #define HUG_SYSTEM_MENU_HELP    0x0087
 139 #define HUG_SYSTEM_MENU_EXIT    0x0088
 140 #define HUG_SYSTEM_MENU_SELECT  0x0089
 141 #define HUG_SYSTEM_MENU_RIGHT   0x008a
 142 #define HUG_SYSTEM_MENU_LEFT    0x008b
 143 #define HUG_SYSTEM_MENU_UP      0x008c
 144 #define HUG_SYSTEM_MENU_DOWN    0x008d
 145
 146 /* Usages Digitizers */
 147 #define HUD_UNDEFINED           0x0000
 148 #define HUD_TIP_PRESSURE        0x0030
 149 #define HUD_BARREL_PRESSURE     0x0031
 150 #define HUD_IN_RANGE            0x0032
 151 #define HUD_TOUCH               0x0033
 152 #define HUD_UNTOUCH             0x0034
 153 #define HUD_TAP                 0x0035
 154 #define HUD_QUALITY             0x0036
 155 #define HUD_DATA_VALID          0x0037
 156 #define HUD_TRANSDUCER_INDEX    0x0038
 157 #define HUD_TABLET_FKEYS        0x0039
 158 #define HUD_PROGRAM_CHANGE_KEYS 0x003a
 159 #define HUD_BATTERY_STRENGTH    0x003b
 160 #define HUD_INVERT              0x003c
 161 #define HUD_X_TILT              0x003d
 162 #define HUD_Y_TILT              0x003e
 163 #define HUD_AZIMUTH             0x003f
 164 #define HUD_ALTITUDE            0x0040
 165 #define HUD_TWIST               0x0041
 166 #define HUD_TIP_SWITCH          0x0042
 167 #define HUD_SEC_TIP_SWITCH      0x0043
 168 #define HUD_BARREL_SWITCH       0x0044
 169 #define HUD_ERASER              0x0045
 170 #define HUD_TABLET_PICK         0x0046
 171
 172 #define HID_USAGE2(p,u) (((p) << 16) | u)
 173
 174 #define UHID_INPUT_REPORT 0x01
 175 #define UHID_OUTPUT_REPORT 0x02
 176 #define UHID_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 #endif /* _USBHID_H_ */