]>
Commit | Line | Data |
---|---|---|
ed838d0c | 1 | /** @file\r |
2 | Copyright (c) 2004 - 2007, Intel Corporation\r | |
3 | All rights reserved. This program and the accompanying materials\r | |
4 | are licensed and made available under the terms and conditions of the BSD License\r | |
5 | which accompanies this distribution. The full text of the license may be found at\r | |
6 | http://opensource.org/licenses/bsd-license.php\r | |
7 | \r | |
8 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
9 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
10 | \r | |
11 | Module Name:\r | |
12 | \r | |
13 | EfiKey.h\r | |
14 | \r | |
15 | Abstract:\r | |
16 | \r | |
17 | Header file for USB Keyboard Driver's Data Structures\r | |
18 | \r | |
19 | Revision History\r | |
20 | \r | |
21 | **/\r | |
22 | #ifndef _USB_KB_H\r | |
23 | #define _USB_KB_H\r | |
24 | \r | |
25 | //\r | |
26 | // The package level header files this module uses\r | |
27 | //\r | |
28 | #include <PiDxe.h>\r | |
29 | //\r | |
30 | // The protocols, PPI and GUID defintions for this module\r | |
31 | //\r | |
32 | #include <Protocol/SimpleTextIn.h>\r | |
33 | #include <Guid/HotPlugDevice.h>\r | |
34 | #include <Protocol/UsbIo.h>\r | |
35 | #include <Protocol/DevicePath.h>\r | |
36 | //\r | |
37 | // The Library classes this module consumes\r | |
38 | //\r | |
39 | #include <Library/DebugLib.h>\r | |
40 | #include <Library/ReportStatusCodeLib.h>\r | |
41 | #include <Library/BaseMemoryLib.h>\r | |
42 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
43 | #include <Library/UefiDriverEntryPoint.h>\r | |
44 | #include <Library/UefiBootServicesTableLib.h>\r | |
45 | #include <Library/UefiLib.h>\r | |
46 | #include <Library/MemoryAllocationLib.h>\r | |
47 | #include <Library/PcdLib.h>\r | |
48 | #include <Library/UsbLib.h>\r | |
49 | \r | |
50 | \r | |
51 | #include <IndustryStandard/Usb.h>\r | |
52 | \r | |
53 | #define MAX_KEY_ALLOWED 32\r | |
54 | \r | |
55 | #define HZ 1000 * 1000 * 10\r | |
56 | #define USBKBD_REPEAT_DELAY ((HZ) / 2)\r | |
57 | #define USBKBD_REPEAT_RATE ((HZ) / 50)\r | |
58 | \r | |
59 | #define CLASS_HID 3\r | |
60 | #define SUBCLASS_BOOT 1\r | |
61 | #define PROTOCOL_KEYBOARD 1\r | |
62 | \r | |
63 | #define BOOT_PROTOCOL 0\r | |
64 | #define REPORT_PROTOCOL 1\r | |
65 | \r | |
66 | typedef struct {\r | |
67 | UINT8 Down;\r | |
68 | UINT8 KeyCode;\r | |
69 | } USB_KEY;\r | |
70 | \r | |
71 | typedef struct {\r | |
72 | USB_KEY buffer[MAX_KEY_ALLOWED + 1];\r | |
73 | UINT8 bHead;\r | |
74 | UINT8 bTail;\r | |
75 | } USB_KB_BUFFER;\r | |
76 | \r | |
77 | #define USB_KB_DEV_SIGNATURE EFI_SIGNATURE_32 ('u', 'k', 'b', 'd')\r | |
78 | typedef struct {\r | |
79 | UINTN Signature;\r | |
80 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
81 | EFI_EVENT DelayedRecoveryEvent;\r | |
82 | EFI_SIMPLE_TEXT_INPUT_PROTOCOL SimpleInput;\r | |
83 | EFI_USB_IO_PROTOCOL *UsbIo;\r | |
84 | \r | |
85 | EFI_USB_INTERFACE_DESCRIPTOR InterfaceDescriptor;\r | |
86 | EFI_USB_ENDPOINT_DESCRIPTOR IntEndpointDescriptor;\r | |
87 | \r | |
88 | USB_KB_BUFFER KeyboardBuffer;\r | |
89 | UINT8 CtrlOn;\r | |
90 | UINT8 AltOn;\r | |
91 | UINT8 ShiftOn;\r | |
92 | UINT8 NumLockOn;\r | |
93 | UINT8 CapsOn;\r | |
94 | UINT8 ScrollOn;\r | |
95 | UINT8 LastKeyCodeArray[8];\r | |
96 | UINT8 CurKeyChar;\r | |
97 | \r | |
98 | UINT8 RepeatKey;\r | |
99 | EFI_EVENT RepeatTimer;\r | |
100 | \r | |
101 | EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r | |
102 | \r | |
103 | } USB_KB_DEV;\r | |
104 | \r | |
105 | //\r | |
106 | // Global Variables\r | |
107 | //\r | |
108 | extern EFI_DRIVER_BINDING_PROTOCOL gUsbKeyboardDriverBinding;\r | |
109 | extern EFI_COMPONENT_NAME_PROTOCOL gUsbKeyboardComponentName;\r | |
110 | extern EFI_GUID gEfiUsbKeyboardDriverGuid;\r | |
111 | \r | |
112 | VOID\r | |
113 | KbdReportStatusCode (\r | |
114 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
115 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
116 | IN EFI_STATUS_CODE_VALUE Value\r | |
117 | );\r | |
118 | \r | |
119 | #define USB_KB_DEV_FROM_THIS(a) \\r | |
120 | CR(a, USB_KB_DEV, SimpleInput, USB_KB_DEV_SIGNATURE)\r | |
121 | \r | |
122 | #define MOD_CONTROL_L 0x01\r | |
123 | #define MOD_CONTROL_R 0x10\r | |
124 | #define MOD_SHIFT_L 0x02\r | |
125 | #define MOD_SHIFT_R 0x20\r | |
126 | #define MOD_ALT_L 0x04\r | |
127 | #define MOD_ALT_R 0x40\r | |
128 | #define MOD_WIN_L 0x08\r | |
129 | #define MOD_WIN_R 0x80\r | |
130 | \r | |
131 | typedef struct {\r | |
132 | UINT8 Mask;\r | |
133 | UINT8 Key;\r | |
134 | } KB_MODIFIER;\r | |
135 | \r | |
136 | #define USB_KEYCODE_MAX_MAKE 0x64\r | |
137 | \r | |
138 | #define USBKBD_VALID_KEYCODE(key) ((UINT8) (key) > 3)\r | |
139 | \r | |
140 | typedef struct {\r | |
141 | UINT8 NumLock : 1;\r | |
142 | UINT8 CapsLock : 1;\r | |
143 | UINT8 ScrollLock : 1;\r | |
144 | UINT8 Resrvd : 5;\r | |
145 | } LED_MAP;\r | |
146 | #endif\r |