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