xref: /btstack/port/stm32-f4discovery-usb/Middlewares/ST/STM32_USB_Host_Library/Class/HID/Inc/usbh_hid_usage.h (revision a8f7f3fcbcd51f8d2e92aca076b6a9f812db358c)
1 /**
2   ******************************************************************************
3   * @file    usbh_hid_usage.c
4   * @author  MCD Application Team
5   * @brief   This file contain the USAGE page codes
6   ******************************************************************************
7   * @attention
8   *
9   * <h2><center>&copy; Copyright (c) 2015 STMicroelectronics.
10   * All rights reserved.</center></h2>
11   *
12   * This software component is licensed by ST under Ultimate Liberty license
13   * SLA0044, the "License"; You may not use this file except in compliance with
14   * the License. You may obtain a copy of the License at:
15   *                      www.st.com/SLA0044
16   *
17   ******************************************************************************
18   */
19 
20 /* Define to prevent recursive  ----------------------------------------------*/
21 #ifndef __USDH_HID_USAGE_H
22 #define __USDH_HID_USAGE_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /** @addtogroup USBH_LIB
29   * @{
30   */
31 
32 /** @addtogroup USBH_CLASS
33   * @{
34   */
35 
36 /** @addtogroup USBH_HID_CLASS
37   * @{
38   */
39 
40 /** @defgroup USBH_HID_USAGE
41   * @brief This file is the Header file for usbh_hid_usage.c
42   * @{
43   */
44 
45 
46 /** @defgroup USBH_HID_USAGE_Exported_Types
47   * @{
48   */
49 
50 /****************************************************/
51 /* HID 1.11 usage pages                             */
52 /****************************************************/
53 
54 #define HID_USAGE_PAGE_UNDEFINED  uint16_t (0x00)   /* Undefined */
55 /**** Top level pages */
56 #define HID_USAGE_PAGE_GEN_DES    uint16_t (0x01)   /* Generic Desktop Controls*/
57 #define HID_USAGE_PAGE_SIM_CTR    uint16_t (0x02)   /* Simulation Controls */
58 #define HID_USAGE_PAGE_VR_CTR     uint16_t (0x03)   /* VR Controls */
59 #define HID_USAGE_PAGE_SPORT_CTR  uint16_t (0x04)   /* Sport Controls */
60 #define HID_USAGE_PAGE_GAME_CTR   uint16_t (0x05)   /* Game Controls */
61 #define HID_USAGE_PAGE_GEN_DEV    uint16_t (0x06)   /* Generic Device Controls */
62 #define HID_USAGE_PAGE_KEYB       uint16_t (0x07)   /* Keyboard/Keypad */
63 #define HID_USAGE_PAGE_LED        uint16_t (0x08)   /* LEDs */
64 #define HID_USAGE_PAGE_BUTTON     uint16_t (0x09)   /* Button */
65 #define HID_USAGE_PAGE_ORDINAL    uint16_t (0x0A)   /* Ordinal */
66 #define HID_USAGE_PAGE_PHONE      uint16_t (0x0B)   /* Telephony */
67 #define HID_USAGE_PAGE_CONSUMER   uint16_t (0x0C)   /* Consumer */
68 #define HID_USAGE_PAGE_DIGITIZER  uint16_t (0x0D)   /* Digitizer*/
69 /* 0E    Reserved */
70 #define HID_USAGE_PAGE_PID        uint16_t (0x0F)   /* PID Page (force feedback and related devices) */
71 #define HID_USAGE_PAGE_UNICODE    uint16_t (0x10)   /* Unicode */
72 /* 11-13 Reserved */
73 #define HID_USAGE_PAGE_ALNUM_DISP uint16_t (0x14)   /* Alphanumeric Display */
74 /* 15-1f Reserved */
75 /**** END of top level pages */
76 /* 25-3f Reserved */
77 #define HID_USAGE_PAGE_MEDICAL    uint16_t (0x40)   /* Medical Instruments */
78 /* 41-7F Reserved */
79 /*80-83 Monitor pages USB Device Class Definition for Monitor Devices
80   84-87 Power pages USB Device Class Definition for Power Devices */
81 /* 88-8B Reserved */
82 #define HID_USAGE_PAGE_BARCODE    uint16_t (0x8C)   /* Bar Code Scanner page */
83 #define HID_USAGE_PAGE_SCALE      uint16_t (0x8D)   /* Scale page */
84 #define HID_USAGE_PAGE_MSR        uint16_t (0x8E)   /* Magnetic Stripe Reading (MSR) Devices */
85 #define HID_USAGE_PAGE_POS        uint16_t (0x8F)   /* Reserved Point of Sale pages */
86 #define HID_USAGE_PAGE_CAMERA_CTR uint16_t (0x90)   /* Camera Control Page */
87 #define HID_USAGE_PAGE_ARCADE     uint16_t (0x91)   /* Arcade Page */
88 
89 /****************************************************/
90 /* Usage definitions for the "Generic Desktop" page */
91 /****************************************************/
92 #define HID_USAGE_UNDEFINED     uint16_t (0x00)   /* Undefined */
93 #define HID_USAGE_POINTER       uint16_t (0x01)   /* Pointer (Physical Collection) */
94 #define HID_USAGE_MOUSE         uint16_t (0x02)   /* Mouse (Application Collection) */
95 /* 03 Reserved */
96 #define HID_USAGE_JOYSTICK      uint16_t (0x04)   /* Joystick (Application Collection) */
97 #define HID_USAGE_GAMEPAD       uint16_t (0x05)   /* Game Pad (Application Collection) */
98 #define HID_USAGE_KBD           uint16_t (0x06)   /* Keyboard (Application Collection) */
99 #define HID_USAGE_KEYPAD        uint16_t (0x07)   /* Keypad (Application Collection) */
100 #define HID_USAGE_MAX_CTR       uint16_t (0x08)   /* Multi-axis Controller (Application Collection) */
101 /* 09-2F Reserved */
102 #define HID_USAGE_X             uint16_t (0x30)   /* X (Dynamic Value) */
103 #define HID_USAGE_Y             uint16_t (0x31)   /* Y (Dynamic Value) */
104 #define HID_USAGE_Z             uint16_t (0x32)   /* Z (Dynamic Value) */
105 #define HID_USAGE_RX            uint16_t (0x33)   /* Rx (Dynamic Value) */
106 #define HID_USAGE_RY            uint16_t (0x34)   /* Ry (Dynamic Value) */
107 #define HID_USAGE_RZ            uint16_t (0x35)   /* Rz (Dynamic Value) */
108 #define HID_USAGE_SLIDER        uint16_t (0x36)   /* Slider (Dynamic Value) */
109 #define HID_USAGE_DIAL          uint16_t (0x37)   /* Dial (Dynamic Value) */
110 #define HID_USAGE_WHEEL         uint16_t (0x38)   /* Wheel (Dynamic Value) */
111 #define HID_USAGE_HATSW         uint16_t (0x39)   /* Hat switch (Dynamic Value) */
112 #define HID_USAGE_COUNTEDBUF    uint16_t (0x3A)   /* Counted Buffer (Logical Collection) */
113 #define HID_USAGE_BYTECOUNT     uint16_t (0x3B)   /* Byte Count (Dynamic Value) */
114 #define HID_USAGE_MOTIONWAKE    uint16_t (0x3C)   /* Motion Wakeup (One Shot Control) */
115 #define HID_USAGE_START         uint16_t (0x3D)   /* Start (On/Off Control) */
116 #define HID_USAGE_SELECT        uint16_t (0x3E)   /* Select (On/Off Control) */
117 /* 3F Reserved */
118 #define HID_USAGE_VX            uint16_t (0x40)   /* Vx (Dynamic Value) */
119 #define HID_USAGE_VY            uint16_t (0x41)   /* Vy (Dynamic Value) */
120 #define HID_USAGE_VZ            uint16_t (0x42)   /* Vz (Dynamic Value) */
121 #define HID_USAGE_VBRX          uint16_t (0x43)   /* Vbrx (Dynamic Value) */
122 #define HID_USAGE_VBRY          uint16_t (0x44)   /* Vbry (Dynamic Value) */
123 #define HID_USAGE_VBRZ          uint16_t (0x45)   /* Vbrz (Dynamic Value) */
124 #define HID_USAGE_VNO           uint16_t (0x46)   /* Vno (Dynamic Value) */
125 #define HID_USAGE_FEATNOTIF     uint16_t (0x47)   /* Feature Notification (Dynamic Value),(Dynamic Flag) */
126 /* 48-7F Reserved */
127 #define HID_USAGE_SYSCTL        uint16_t (0x80)   /* System Control (Application Collection) */
128 #define HID_USAGE_PWDOWN        uint16_t (0x81)   /* System Power Down (One Shot Control) */
129 #define HID_USAGE_SLEEP         uint16_t (0x82)   /* System Sleep (One Shot Control) */
130 #define HID_USAGE_WAKEUP        uint16_t (0x83)   /* System Wake Up (One Shot Control)  */
131 #define HID_USAGE_CONTEXTM      uint16_t (0x84)   /* System Context Menu (One Shot Control) */
132 #define HID_USAGE_MAINM         uint16_t (0x85)   /* System Main Menu (One Shot Control) */
133 #define HID_USAGE_APPM          uint16_t (0x86)   /* System App Menu (One Shot Control) */
134 #define HID_USAGE_MENUHELP      uint16_t (0x87)   /* System Menu Help (One Shot Control) */
135 #define HID_USAGE_MENUEXIT      uint16_t (0x88)   /* System Menu Exit (One Shot Control) */
136 #define HID_USAGE_MENUSELECT    uint16_t (0x89)   /* System Menu Select (One Shot Control) */
137 #define HID_USAGE_SYSM_RIGHT    uint16_t (0x8A)   /* System Menu Right (Re-Trigger Control) */
138 #define HID_USAGE_SYSM_LEFT     uint16_t (0x8B)   /* System Menu Left (Re-Trigger Control) */
139 #define HID_USAGE_SYSM_UP       uint16_t (0x8C)   /* System Menu Up (Re-Trigger Control) */
140 #define HID_USAGE_SYSM_DOWN     uint16_t (0x8D)   /* System Menu Down (Re-Trigger Control) */
141 #define HID_USAGE_COLDRESET     uint16_t (0x8E)   /* System Cold Restart (One Shot Control) */
142 #define HID_USAGE_WARMRESET     uint16_t (0x8F)   /* System Warm Restart (One Shot Control) */
143 #define HID_USAGE_DUP           uint16_t (0x90)   /* D-pad Up (On/Off Control) */
144 #define HID_USAGE_DDOWN         uint16_t (0x91)   /* D-pad Down (On/Off Control) */
145 #define HID_USAGE_DRIGHT        uint16_t (0x92)   /* D-pad Right (On/Off Control) */
146 #define HID_USAGE_DLEFT         uint16_t (0x93)   /* D-pad Left (On/Off Control) */
147 /* 94-9F Reserved */
148 #define HID_USAGE_SYS_DOCK      uint16_t (0xA0)   /* System Dock (One Shot Control) */
149 #define HID_USAGE_SYS_UNDOCK    uint16_t (0xA1)   /* System Undock (One Shot Control) */
150 #define HID_USAGE_SYS_SETUP     uint16_t (0xA2)   /* System Setup (One Shot Control) */
151 #define HID_USAGE_SYS_BREAK     uint16_t (0xA3)   /* System Break (One Shot Control) */
152 #define HID_USAGE_SYS_DBGBRK    uint16_t (0xA4)   /* System Debugger Break (One Shot Control) */
153 #define HID_USAGE_APP_BRK       uint16_t (0xA5)   /* Application Break (One Shot Control) */
154 #define HID_USAGE_APP_DBGBRK    uint16_t (0xA6)   /* Application Debugger Break (One Shot Control) */
155 #define HID_USAGE_SYS_SPKMUTE   uint16_t (0xA7)   /* System Speaker Mute (One Shot Control) */
156 #define HID_USAGE_SYS_HIBERN    uint16_t (0xA8)   /* System Hibernate (One Shot Control) */
157 /* A9-AF Reserved */
158 #define HID_USAGE_SYS_SIDPINV   uint16_t (0xB0)   /* System Display Invert (One Shot Control) */
159 #define HID_USAGE_SYS_DISPINT   uint16_t (0xB1)   /* System Display Internal (One Shot Control) */
160 #define HID_USAGE_SYS_DISPEXT   uint16_t (0xB2)   /* System Display External (One Shot Control) */
161 #define HID_USAGE_SYS_DISPBOTH  uint16_t (0xB3)   /* System Display Both (One Shot Control) */
162 #define HID_USAGE_SYS_DISPDUAL  uint16_t (0xB4)   /* System Display Dual (One Shot Control) */
163 #define HID_USAGE_SYS_DISPTGLIE uint16_t (0xB5)   /* System Display Toggle Int/Ext (One Shot Control) */
164 #define HID_USAGE_SYS_DISP_SWAP uint16_t (0xB6)   /* System Display Swap Primary/Secondary (One Shot Control) */
165 #define HID_USAGE_SYS_DIPS_LCDA uint16_t (0xB7)   /* System Display LCD Autoscale (One Shot Control) */
166 /* B8-FFFF Reserved */
167 
168 /**
169   * @}
170   */
171 
172 #ifdef __cplusplus
173 }
174 #endif
175 
176 #endif /* __USDH_HID_USAGE_H */
177 
178 /**
179   * @}
180   */
181 
182 /**
183   * @}
184   */
185 
186 /**
187   * @}
188   */
189 
190 /**
191   * @}
192   */
193 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
194