ATMEL: usb_commun_hid.h File Reference

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

# usb_commun_hid.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Defines

Global Class, SubClass & Protocol constants for HID
#define | HID_CLASS 0x03
#define | HID_SUB_CLASS_BOOT 0x01
| Is used to signal the BIOS BOOT support (0=no no sub class,1=boot interface SubClass).
#define | HID_PROTOCOL_KEYBOARD 0x01
| Protocol keyboard standard.
#define | HID_PROTOCOL_MOUSE 0x02
| Protocol mouse standard.
Specific setup requests from HID driver (USB_SETUP_SET_CLASS_INTER or USB_SETUP_GET_CLASS_INTER)
#define | SETUP_HID_GET_REPORT 0x01
#define | SETUP_HID_GET_IDLE 0x02
#define | SETUP_HID_GET_PROTOCOL 0x03
#define | SETUP_HID_SET_REPORT 0x09
#define | SETUP_HID_SET_IDLE 0x0A
#define | SETUP_HID_SET_PROTOCOL 0x0B
HID Descriptor types
#define | DESCRIPTOR_HID 0x21
#define | DESCRIPTOR_REPORT 0x22
#define | DESCRIPTOR_PHYSICAL 0x23
HID Report type (used by SETUP_HID_GET_REPORT & SETUP_HID_SET_REPORT)
#define | REPORT_TYPE_INPUT 0x01
#define | REPORT_TYPE_OUTPUT 0x02
#define | REPORT_TYPE_FEATURE 0x03
Constants of field DESCRIPTOR_HID
#define | HID_BDC 0x0111
| Numeric expression identifying the HID Class Specification release (here V1.11).
#define | HID_CLASS_DESC_NB_DEFAULT 0x01
| Numeric expression specifying the number of class descriptors (always at least one i.e. Report descriptor.).
Country code
#define | HID_NO_COUNTRY_CODE 0
#define | HID_COUNTRY_ARABIC 1
#define | HID_COUNTRY_BELGIAN 2
#define | HID_COUNTRY_CANADIAN_BILINGUAL 3
#define | HID_COUNTRY_CANADIAN_FRENCH 4
#define | HID_COUNTRY_CZECH_REPUBLIC 5
#define | HID_COUNTRY_DANISH 6
#define | HID_COUNTRY_FINNISH 7
#define | HID_COUNTRY_FRENCH 8
#define | HID_COUNTRY_GERMAN 9
#define | HID_COUNTRY_GREEK 10
#define | HID_COUNTRY_HEBREW 11
#define | HID_COUNTRY_HUNGARY 12
#define | HID_COUNTRY_INTERNATIONAL_ISO 13
#define | HID_COUNTRY_ITALIAN 14
#define | HID_COUNTRY_JAPAN_KATAKANA 15
#define | HID_COUNTRY_KOREAN 16
#define | HID_COUNTRY_LATIN_AMERICAN 17
#define | HID_COUNTRY_NETHERLANDS_DUTCH 18
#define | HID_COUNTRY_NORWEGIAN 19
#define | HID_COUNTRY_PERSIAN_FARSI 20
#define | HID_COUNTRY_POLAND 21
#define | HID_COUNTRY_PORTUGUESE 22
#define | HID_COUNTRY_RUSSIA 23
#define | HID_COUNTRY_SLOVAKIA 24
#define | HID_COUNTRY_SPANISH 25
#define | HID_COUNTRY_SWEDISH 26
#define | HID_COUNTRY_SWISS_FRENCH 27
#define | HID_COUNTRY_SWISS_GERMAN 28
#define | HID_COUNTRY_SWITZERLAND 29
#define | HID_COUNTRY_TAIWAN 30
#define | HID_COUNTRY_TURKISH_Q 31
#define | HID_COUNTRY_UK 32
#define | HID_COUNTRY_US 33
#define | HID_COUNTRY_YUGOSLAVIA 34
#define | HID_COUNTRY_TURKISH_F 35
HID KEYS values
#define | HID_A 4
#define | HID_B 5
#define | HID_C 6
#define | HID_D 7
#define | HID_E 8
#define | HID_F 9
#define | HID_G 10
#define | HID_H 11
#define | HID_I 12
#define | HID_J 13
#define | HID_K 14
#define | HID_L 15
#define | HID_M 16
#define | HID_N 17
#define | HID_O 18
#define | HID_P 19
#define | HID_Q 20
#define | HID_R 21
#define | HID_S 22
#define | HID_T 23
#define | HID_U 24
#define | HID_V 25
#define | HID_W 26
#define | HID_X 27
#define | HID_Y 28
#define | HID_Z 29
#define | HID_1 30
#define | HID_2 31
#define | HID_3 32
#define | HID_4 33
#define | HID_5 34
#define | HID_6 35
#define | HID_7 36
#define | HID_8 37
#define | HID_9 38
#define | HID_0 39
#define | HID_ENTER 40
#define | HID_ESCAPE 41
#define | HID_BACKSPACE 42
#define | HID_TAB 43
#define | HID_SPACEBAR 44
#define | HID_UNDERSCORE 45
#define | HID_PLUS 46
#define | HID_BACKSLASH 49
#define | HID_TILDE 53
#define | HID_COMMA 54
#define | HID_DOT 55
#define | HID_SLASH 56
#define | HID_CAPS LOCK 57
#define | HID_F1 58
#define | HID_F2 59
#define | HID_F3 60
#define | HID_F4 61
#define | HID_F5 62
#define | HID_F6 63
#define | HID_F7 64
#define | HID_F8 65
#define | HID_F9 66
#define | HID_F10 67
#define | HID_F11 68
#define | HID_F12 69
#define | HID_PRINTSCREEN 70
#define | HID_SCROLL LOCK 71
#define | HID_PAUSE 72
#define | HID_INSERT 73
#define | HID_HOME 74
#define | HID_PAGEUP 75
#define | HID_DELETE 76
#define | HID_END 77
#define | HID_PAGEDOWN 78
#define | HID_RIGHT 79
#define | HID_LEFT 80
#define | HID_DOWN 81
#define | HID_UP 82
#define | HID_KEYPAD_NUM_LOCK 83
#define | HID_KEYPAD_DIVIDE 84
#define | HID_KEYPAD_AT 85
#define | HID_KEYPAD_MULTIPLY 85
#define | HID_KEYPAD_MINUS 86
#define | HID_KEYPAD_PLUS 87
#define | HID_KEYPAD_ENTER 88
#define | HID_KEYPAD_1 89
#define | HID_KEYPAD_2 90
#define | HID_KEYPAD_3 91
#define | HID_KEYPAD_4 92
#define | HID_KEYPAD_5 93
#define | HID_KEYPAD_6 94
#define | HID_KEYPAD_7 95
#define | HID_KEYPAD_8 96
#define | HID_KEYPAD_9 97
#define | HID_KEYPAD_0 98
HID modifier values
#define | HID_MODIFIER_NONE 0x00
#define | HID_MODIFIER_LEFT_CTRL 0x01
#define | HID_MODIFIER_LEFT_SHIFT 0x02
#define | HID_MODIFIER_LEFT_ALT 0x04
#define | HID_MODIFIER_LEFT_GUI 0x08
#define | HID_MODIFIER_RIGHT_CTRL 0x10
#define | HID_MODIFIER_RIGHT_SHIFT 0x20
#define | HID_MODIFIER_RIGHT_ALT 0x40
#define | HID_MODIFIER_RIGHT_GUI 0x80

## Detailed Description

This file contains the usb HID definition constant parameters from Firmware Specification Version 1.11 - Compiler: IAR EWAVR and GNU GCC for AVR

Author:
  Atmel Corporation: http://www.atmel.com
  Support and FAQ: http://support.atmel.no/

Definition in file usb_commun_hid.h.

## Define Documentation

#define HID_CLASS 0x03

Definition at line 50 of file usb_commun_hid.h.

Referenced by host_hid_task(), and host_mouse_task().

#define HID_SUB_CLASS_BOOT 0x01

Is used to signal the BIOS BOOT support (0=no no sub class,1=boot interface SubClass).

Definition at line 51 of file usb_commun_hid.h.

#define HID_PROTOCOL_KEYBOARD 0x01

Protocol keyboard standard.

Definition at line 52 of file usb_commun_hid.h.

#define HID_PROTOCOL_MOUSE 0x02

Protocol mouse standard.

Definition at line 53 of file usb_commun_hid.h.

Referenced by host_mouse_task().

#define SETUP_HID_GET_REPORT 0x01

Definition at line 59 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define SETUP_HID_GET_IDLE 0x02

Definition at line 60 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define SETUP_HID_GET_PROTOCOL 0x03

Definition at line 61 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define SETUP_HID_SET_REPORT 0x09

Definition at line 62 of file usb_commun_hid.h.

Referenced by host_hid_task(), and usb_user_read_request().

#define SETUP_HID_SET_IDLE 0x0A

Definition at line 63 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define SETUP_HID_SET_PROTOCOL 0x0B

Definition at line 64 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define DESCRIPTOR_HID 0x21

Definition at line 68 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define DESCRIPTOR_REPORT 0x22

Definition at line 69 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define DESCRIPTOR_PHYSICAL 0x23

Definition at line 70 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define REPORT_TYPE_INPUT 0x01

Definition at line 75 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define REPORT_TYPE_OUTPUT 0x02

Definition at line 76 of file usb_commun_hid.h.

Referenced by usb_user_read_request().

#define REPORT_TYPE_FEATURE 0x03

Definition at line 77 of file usb_commun_hid.h.

Referenced by host_hid_task(), and usb_user_read_request().

#define HID_BDC 0x0111

Numeric expression identifying the HID Class Specification release (here V1.11).

Definition at line 82 of file usb_commun_hid.h.

#define HID_CLASS_DESC_NB_DEFAULT 0x01

Numeric expression specifying the number of class descriptors (always at least one i.e. Report descriptor.).

Definition at line 83 of file usb_commun_hid.h.

#define HID_NO_COUNTRY_CODE 0

Definition at line 87 of file usb_commun_hid.h.

#define HID_COUNTRY_ARABIC 1

Definition at line 88 of file usb_commun_hid.h.

#define HID_COUNTRY_BELGIAN 2

Definition at line 89 of file usb_commun_hid.h.

#define HID_COUNTRY_CANADIAN_BILINGUAL 3

Definition at line 90 of file usb_commun_hid.h.

#define HID_COUNTRY_CANADIAN_FRENCH 4

Definition at line 91 of file usb_commun_hid.h.

#define HID_COUNTRY_CZECH_REPUBLIC 5

Definition at line 92 of file usb_commun_hid.h.

#define HID_COUNTRY_DANISH 6

Definition at line 93 of file usb_commun_hid.h.

#define HID_COUNTRY_FINNISH 7

Definition at line 94 of file usb_commun_hid.h.

#define HID_COUNTRY_FRENCH 8

Definition at line 95 of file usb_commun_hid.h.

#define HID_COUNTRY_GERMAN 9

Definition at line 96 of file usb_commun_hid.h.

#define HID_COUNTRY_GREEK 10

Definition at line 97 of file usb_commun_hid.h.

#define HID_COUNTRY_HEBREW 11

Definition at line 98 of file usb_commun_hid.h.

#define HID_COUNTRY_HUNGARY 12

Definition at line 99 of file usb_commun_hid.h.

#define HID_COUNTRY_INTERNATIONAL_ISO 13

Definition at line 100 of file usb_commun_hid.h.

#define HID_COUNTRY_ITALIAN 14

Definition at line 101 of file usb_commun_hid.h.

#define HID_COUNTRY_JAPAN_KATAKANA 15

Definition at line 102 of file usb_commun_hid.h.

#define HID_COUNTRY_KOREAN 16

Definition at line 103 of file usb_commun_hid.h.

#define HID_COUNTRY_LATIN_AMERICAN 17

Definition at line 104 of file usb_commun_hid.h.

#define HID_COUNTRY_NETHERLANDS_DUTCH 18

Definition at line 105 of file usb_commun_hid.h.

#define HID_COUNTRY_NORWEGIAN 19

Definition at line 106 of file usb_commun_hid.h.

#define HID_COUNTRY_PERSIAN_FARSI 20

Definition at line 107 of file usb_commun_hid.h.

#define HID_COUNTRY_POLAND 21

Definition at line 108 of file usb_commun_hid.h.

#define HID_COUNTRY_PORTUGUESE 22

Definition at line 109 of file usb_commun_hid.h.

#define HID_COUNTRY_RUSSIA 23

Definition at line 110 of file usb_commun_hid.h.

#define HID_COUNTRY_SLOVAKIA 24

Definition at line 111 of file usb_commun_hid.h.

#define HID_COUNTRY_SPANISH 25

Definition at line 112 of file usb_commun_hid.h.

#define HID_COUNTRY_SWEDISH 26

Definition at line 113 of file usb_commun_hid.h.

#define HID_COUNTRY_SWISS_FRENCH 27

Definition at line 114 of file usb_commun_hid.h.

#define HID_COUNTRY_SWISS_GERMAN 28

Definition at line 115 of file usb_commun_hid.h.

#define HID_COUNTRY_SWITZERLAND 29

Definition at line 116 of file usb_commun_hid.h.

#define HID_COUNTRY_TAIWAN 30

Definition at line 117 of file usb_commun_hid.h.

#define HID_COUNTRY_TURKISH_Q 31

Definition at line 118 of file usb_commun_hid.h.

#define HID_COUNTRY_UK 32

Definition at line 119 of file usb_commun_hid.h.

#define HID_COUNTRY_US 33

Definition at line 120 of file usb_commun_hid.h.

#define HID_COUNTRY_YUGOSLAVIA 34

Definition at line 121 of file usb_commun_hid.h.

#define HID_COUNTRY_TURKISH_F 35

Definition at line 122 of file usb_commun_hid.h.

#define HID_A 4

Definition at line 130 of file usb_commun_hid.h.

#define HID_B 5

Definition at line 131 of file usb_commun_hid.h.

#define HID_C 6

Definition at line 132 of file usb_commun_hid.h.

#define HID_D 7

Definition at line 133 of file usb_commun_hid.h.

#define HID_E 8

Definition at line 134 of file usb_commun_hid.h.

#define HID_F 9

Definition at line 135 of file usb_commun_hid.h.

#define HID_G 10

Definition at line 136 of file usb_commun_hid.h.

#define HID_H 11

Definition at line 137 of file usb_commun_hid.h.

#define HID_I 12

Definition at line 138 of file usb_commun_hid.h.

#define HID_J 13

Definition at line 139 of file usb_commun_hid.h.

#define HID_K 14

Definition at line 140 of file usb_commun_hid.h.

#define HID_L 15

Definition at line 141 of file usb_commun_hid.h.

#define HID_M 16

Definition at line 142 of file usb_commun_hid.h.

#define HID_N 17

Definition at line 143 of file usb_commun_hid.h.

#define HID_O 18

Definition at line 144 of file usb_commun_hid.h.

#define HID_P 19

Definition at line 145 of file usb_commun_hid.h.

#define HID_Q 20

Definition at line 146 of file usb_commun_hid.h.

#define HID_R 21

Definition at line 147 of file usb_commun_hid.h.

#define HID_S 22

Definition at line 148 of file usb_commun_hid.h.

#define HID_T 23

Definition at line 149 of file usb_commun_hid.h.

#define HID_U 24

Definition at line 150 of file usb_commun_hid.h.

#define HID_V 25

Definition at line 151 of file usb_commun_hid.h.

#define HID_W 26

Definition at line 152 of file usb_commun_hid.h.

#define HID_X 27

Definition at line 153 of file usb_commun_hid.h.

#define HID_Y 28

Definition at line 154 of file usb_commun_hid.h.

#define HID_Z 29

Definition at line 155 of file usb_commun_hid.h.

#define HID_1 30

Definition at line 156 of file usb_commun_hid.h.

#define HID_2 31

Definition at line 157 of file usb_commun_hid.h.

#define HID_3 32

Definition at line 158 of file usb_commun_hid.h.

#define HID_4 33

Definition at line 159 of file usb_commun_hid.h.

#define HID_5 34

Definition at line 160 of file usb_commun_hid.h.

#define HID_6 35

Definition at line 161 of file usb_commun_hid.h.

#define HID_7 36

Definition at line 162 of file usb_commun_hid.h.

#define HID_8 37

Definition at line 163 of file usb_commun_hid.h.

#define HID_9 38

Definition at line 164 of file usb_commun_hid.h.

#define HID_0 39

Definition at line 165 of file usb_commun_hid.h.

#define HID_ENTER 40

Definition at line 166 of file usb_commun_hid.h.

#define HID_ESCAPE 41

Definition at line 167 of file usb_commun_hid.h.

#define HID_BACKSPACE 42

Definition at line 168 of file usb_commun_hid.h.

#define HID_TAB 43

Definition at line 169 of file usb_commun_hid.h.

#define HID_SPACEBAR 44

Definition at line 170 of file usb_commun_hid.h.

#define HID_UNDERSCORE 45

Definition at line 171 of file usb_commun_hid.h.

#define HID_PLUS 46

Definition at line 172 of file usb_commun_hid.h.

#define HID_BACKSLASH 49

Definition at line 177 of file usb_commun_hid.h.

#define HID_TILDE 53

Definition at line 183 of file usb_commun_hid.h.

#define HID_COMMA 54

Definition at line 184 of file usb_commun_hid.h.

#define HID_DOT 55

Definition at line 185 of file usb_commun_hid.h.

#define HID_SLASH 56

Definition at line 186 of file usb_commun_hid.h.

#define HID_CAPS LOCK 57

Definition at line 187 of file usb_commun_hid.h.

#define HID_F1 58

Definition at line 188 of file usb_commun_hid.h.

#define HID_F2 59

Definition at line 189 of file usb_commun_hid.h.

#define HID_F3 60

Definition at line 190 of file usb_commun_hid.h.

#define HID_F4 61

Definition at line 191 of file usb_commun_hid.h.

#define HID_F5 62

Definition at line 192 of file usb_commun_hid.h.

#define HID_F6 63

Definition at line 193 of file usb_commun_hid.h.

#define HID_F7 64

Definition at line 194 of file usb_commun_hid.h.

#define HID_F8 65

Definition at line 195 of file usb_commun_hid.h.

#define HID_F9 66

Definition at line 196 of file usb_commun_hid.h.

#define HID_F10 67

Definition at line 197 of file usb_commun_hid.h.

#define HID_F11 68

Definition at line 198 of file usb_commun_hid.h.

#define HID_F12 69

Definition at line 199 of file usb_commun_hid.h.

#define HID_PRINTSCREEN 70

Definition at line 200 of file usb_commun_hid.h.

#define HID_SCROLL LOCK 71

Definition at line 201 of file usb_commun_hid.h.

#define HID_PAUSE 72

Definition at line 202 of file usb_commun_hid.h.

#define HID_INSERT 73

Definition at line 203 of file usb_commun_hid.h.

#define HID_HOME 74

Definition at line 204 of file usb_commun_hid.h.

#define HID_PAGEUP 75

Definition at line 205 of file usb_commun_hid.h.

#define HID_DELETE 76

Definition at line 206 of file usb_commun_hid.h.

#define HID_END 77

Definition at line 207 of file usb_commun_hid.h.

#define HID_PAGEDOWN 78

Definition at line 208 of file usb_commun_hid.h.

#define HID_RIGHT 79

Definition at line 209 of file usb_commun_hid.h.

#define HID_LEFT 80

Definition at line 210 of file usb_commun_hid.h.

#define HID_DOWN 81

Definition at line 211 of file usb_commun_hid.h.

#define HID_UP 82

Definition at line 212 of file usb_commun_hid.h.

#define HID_KEYPAD_NUM_LOCK 83

Definition at line 213 of file usb_commun_hid.h.

#define HID_KEYPAD_DIVIDE 84

Definition at line 214 of file usb_commun_hid.h.

#define HID_KEYPAD_AT 85

Definition at line 215 of file usb_commun_hid.h.

#define HID_KEYPAD_MULTIPLY 85

Definition at line 216 of file usb_commun_hid.h.

#define HID_KEYPAD_MINUS 86

Definition at line 217 of file usb_commun_hid.h.

#define HID_KEYPAD_PLUS 87

Definition at line 218 of file usb_commun_hid.h.

#define HID_KEYPAD_ENTER 88

Definition at line 219 of file usb_commun_hid.h.

#define HID_KEYPAD_1 89

Definition at line 220 of file usb_commun_hid.h.

#define HID_KEYPAD_2 90

Definition at line 221 of file usb_commun_hid.h.

#define HID_KEYPAD_3 91

Definition at line 222 of file usb_commun_hid.h.

#define HID_KEYPAD_4 92

Definition at line 223 of file usb_commun_hid.h.

#define HID_KEYPAD_5 93

Definition at line 224 of file usb_commun_hid.h.

#define HID_KEYPAD_6 94

Definition at line 225 of file usb_commun_hid.h.

#define HID_KEYPAD_7 95

Definition at line 226 of file usb_commun_hid.h.

#define HID_KEYPAD_8 96

Definition at line 227 of file usb_commun_hid.h.

#define HID_KEYPAD_9 97

Definition at line 228 of file usb_commun_hid.h.

#define HID_KEYPAD_0 98

Definition at line 229 of file usb_commun_hid.h.

#define HID_MODIFIER_NONE 0x00

Definition at line 233 of file usb_commun_hid.h.

#define HID_MODIFIER_LEFT_CTRL 0x01

Definition at line 234 of file usb_commun_hid.h.

#define HID_MODIFIER_LEFT_SHIFT 0x02

Definition at line 235 of file usb_commun_hid.h.

#define HID_MODIFIER_LEFT_ALT 0x04

Definition at line 236 of file usb_commun_hid.h.

#define HID_MODIFIER_LEFT_GUI 0x08

Definition at line 237 of file usb_commun_hid.h.

#define HID_MODIFIER_RIGHT_CTRL 0x10

Definition at line 238 of file usb_commun_hid.h.

#define HID_MODIFIER_RIGHT_SHIFT 0x20

Definition at line 239 of file usb_commun_hid.h.

#define HID_MODIFIER_RIGHT_ALT 0x40

Definition at line 240 of file usb_commun_hid.h.

#define HID_MODIFIER_RIGHT_GUI 0x80

Definition at line 241 of file usb_commun_hid.h.