1 /* $NetBSD: usbhid.h,v 1.4 1999/04/22 01:57:01 augustss Exp $ */ 2 /* $FreeBSD$ */ 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 (augustss@carlstedt.se) 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 typedef struct usb_hid_descriptor { 58 uByte bLength; 59 uByte bDescriptorType; 60 uWord bcdHID; 61 uByte bCountryCode; 62 uByte bNumDescriptors; 63 struct { 64 uByte bDescriptorType; 65 uWord wDescriptorLength; 66 } descrs[1]; 67 } usb_hid_descriptor_t; 68 #define USB_HID_DESCRIPTOR_SIZE(n) (9+(n)*3) 69 70 /* Usage pages */ 71 #define HUP_GENERIC_DESKTOP 0x0001 72 #define HUP_SIMULATION 0x0002 73 #define HUP_LEDS 0x0008 74 #define HUP_BUTTON 0x0009 75 #define HUP_DIGITIZERS 0x000d 76 77 /* Usages, generic desktop */ 78 #define HUG_POINTER 0x0001 79 #define HUG_MOUSE 0x0002 80 #define HUG_JOYSTICK 0x0004 81 #define HUG_GAME_PAD 0x0005 82 #define HUG_KEYBOARD 0x0006 83 #define HUG_KEYPAD 0x0007 84 #define HUG_X 0x0030 85 #define HUG_Y 0x0031 86 #define HUG_Z 0x0032 87 #define HUG_RX 0x0033 88 #define HUG_RY 0x0034 89 #define HUG_RZ 0x0035 90 #define HUG_SLIDER 0x0036 91 #define HUG_DIAL 0x0037 92 #define HUG_WHEEL 0x0038 93 #define HUG_HAT_SWITCH 0x0039 94 #define HUG_COUNTED_BUFFER 0x003a 95 #define HUG_BYTE_COUNT 0x003b 96 #define HUG_MOTION_WAKEUP 0x003c 97 #define HUG_VX 0x0040 98 #define HUG_VY 0x0041 99 #define HUG_VZ 0x0042 100 #define HUG_VBRX 0x0043 101 #define HUG_VBRY 0x0044 102 #define HUG_VBRZ 0x0045 103 #define HUG_VNO 0x0046 104 #define HUG_SYSTEM_CONTROL 0x0080 105 #define HUG_SYSTEM_POWER_DOWN 0x0081 106 #define HUG_SYSTEM_SLEEP 0x0082 107 #define HUG_SYSTEM_WAKEUP 0x0083 108 #define HUG_SYSTEM_CONTEXT_MENU 0x0084 109 #define HUG_SYSTEM_MAIN_MENU 0x0085 110 #define HUG_SYSTEM_APP_MENU 0x0086 111 #define HUG_SYSTEM_MENU_HELP 0x0087 112 #define HUG_SYSTEM_MENU_EXIT 0x0088 113 #define HUG_SYSTEM_MENU_SELECT 0x0089 114 #define HUG_SYSTEM_MENU_RIGHT 0x008a 115 #define HUG_SYSTEM_MENU_LEFT 0x008b 116 #define HUG_SYSTEM_MENU_UP 0x008c 117 #define HUG_SYSTEM_MENU_DOWN 0x008d 118 119 /* Usages Digitizers */ 120 #define HUD_TIP_PRESSURE 0x0030 121 #define HUD_BARREL_PRESSURE 0x0031 122 #define HUD_IN_RANGE 0x0032 123 #define HUD_TOUCH 0x0033 124 #define HUD_UNTOUCH 0x0034 125 #define HUD_TAP 0x0035 126 #define HUD_QUALITY 0x0036 127 #define HUD_INVERT 0x003c 128 #define HUD_X_TILT 0x003d 129 #define HUD_Y_TILT 0x003e 130 #define HUD_AZIMUTH 0x003f 131 #define HUD_ALTITUDE 0x0040 132 #define HUD_TWIST 0x0041 133 #define HUD_TIP_SWITCH 0x0042 134 #define HUD_SEC_TIP_SWITCH 0x0043 135 #define HUD_BARREL_SWITCH 0x0044 136 #define HUD_ERASER 0x0045 137 #define HUD_TABLET_PICK 0x0046 138 139 #define HID_USAGE2(p,u) (((p) << 16) | u) 140 141 #define UHID_INPUT_REPORT 0x01 142 #define UHID_OUTPUT_REPORT 0x02 143 #define UHID_FEATURE_REPORT 0x03 144 145 /* Bits in the input/output/feature items */ 146 #define HIO_CONST 0x001 147 #define HIO_VARIABLE 0x002 148 #define HIO_RELATIVE 0x004 149 #define HIO_WRAP 0x008 150 #define HIO_NONLINEAR 0x010 151 #define HIO_NOPREF 0x020 152 #define HIO_NULLSTATE 0x040 153 #define HIO_VOLATILE 0x080 154 #define HIO_BUFBYTES 0x100 155 156 #endif /* _USBHID_H_ */ 157