]>
Commit | Line | Data |
---|---|---|
f713c4fe | 1 | /** @file\r |
f3d1e940 | 2 | PS/2 keyboard driver header file\r |
05fbd06d | 3 | \r |
c220787b | 4 | Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r |
180a5a35 | 5 | This program and the accompanying materials\r |
df0dcb5e | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
05fbd06d | 12 | \r |
13 | **/\r | |
14 | \r | |
f713c4fe | 15 | #ifndef _PS2KEYBOARD_H_\r |
16 | #define _PS2KEYBOARD_H_\r | |
05fbd06d | 17 | \r |
79bc7a89 | 18 | #include <FrameworkDxe.h>\r |
752f2e26 | 19 | \r |
20 | #include <Protocol/SimpleTextIn.h>\r | |
f3d1e940 | 21 | #include <Protocol/SimpleTextInEx.h>\r |
752f2e26 | 22 | #include <Protocol/IsaIo.h>\r |
23 | #include <Protocol/DevicePath.h>\r | |
24 | #include <Protocol/Ps2Policy.h>\r | |
25 | \r | |
26 | #include <Library/UefiDriverEntryPoint.h>\r | |
27 | #include <Library/UefiLib.h>\r | |
28 | #include <Library/UefiBootServicesTableLib.h>\r | |
29 | #include <Library/ReportStatusCodeLib.h>\r | |
30 | #include <Library/DebugLib.h>\r | |
31 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
32 | #include <Library/MemoryAllocationLib.h>\r | |
f3d1e940 | 33 | #include <Library/BaseLib.h>\r |
34 | #include <Library/BaseMemoryLib.h>\r | |
b6763e03 | 35 | #include <Library/TimerLib.h>\r |
05fbd06d | 36 | \r |
9f6531d1 | 37 | //\r |
38 | // Global Variables\r | |
39 | //\r | |
40 | extern EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver;\r | |
41 | extern EFI_COMPONENT_NAME_PROTOCOL gPs2KeyboardComponentName;\r | |
42 | extern EFI_COMPONENT_NAME2_PROTOCOL gPs2KeyboardComponentName2;\r | |
43 | \r | |
05fbd06d | 44 | //\r |
45 | // Driver Private Data\r | |
46 | //\r | |
c220787b | 47 | #define KEYBOARD_CONSOLE_IN_DEV_SIGNATURE SIGNATURE_32 ('k', 'k', 'e', 'y')\r |
f02bd376 | 48 | #define KEYBOARD_CONSOLE_IN_EX_NOTIFY_SIGNATURE SIGNATURE_32 ('k', 'c', 'e', 'n')\r |
f3d1e940 | 49 | \r |
50 | typedef struct _KEYBOARD_CONSOLE_IN_EX_NOTIFY {\r | |
c220787b RN |
51 | UINTN Signature;\r |
52 | EFI_HANDLE NotifyHandle;\r | |
53 | EFI_KEY_DATA KeyData;\r | |
54 | EFI_KEY_NOTIFY_FUNCTION KeyNotificationFn;\r | |
55 | LIST_ENTRY NotifyEntry;\r | |
f3d1e940 | 56 | } KEYBOARD_CONSOLE_IN_EX_NOTIFY;\r |
57 | \r | |
c220787b RN |
58 | #define KEYBOARD_SCAN_CODE_MAX_COUNT 32\r |
59 | typedef struct {\r | |
60 | UINT8 Buffer[KEYBOARD_SCAN_CODE_MAX_COUNT];\r | |
61 | UINTN Head;\r | |
62 | UINTN Tail;\r | |
63 | } SCAN_CODE_QUEUE;\r | |
64 | \r | |
65 | #define KEYBOARD_EFI_KEY_MAX_COUNT 256\r | |
66 | typedef struct {\r | |
67 | EFI_KEY_DATA Buffer[KEYBOARD_EFI_KEY_MAX_COUNT];\r | |
68 | UINTN Head;\r | |
69 | UINTN Tail;\r | |
70 | } EFI_KEY_QUEUE;\r | |
05fbd06d | 71 | \r |
72 | typedef struct {\r | |
73 | UINTN Signature;\r | |
74 | \r | |
75 | EFI_HANDLE Handle;\r | |
76 | EFI_SIMPLE_TEXT_INPUT_PROTOCOL ConIn;\r | |
f3d1e940 | 77 | EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL ConInEx;\r |
05fbd06d | 78 | EFI_ISA_IO_PROTOCOL *IsaIo;\r |
79 | \r | |
80 | EFI_EVENT TimerEvent;\r | |
81 | \r | |
82 | UINT32 DataRegisterAddress;\r | |
83 | UINT32 StatusRegisterAddress;\r | |
84 | UINT32 CommandRegisterAddress;\r | |
85 | \r | |
f3d1e940 | 86 | BOOLEAN LeftShift;\r |
87 | BOOLEAN RightShift; \r | |
88 | BOOLEAN LeftLogo;\r | |
89 | BOOLEAN RightLogo;\r | |
90 | BOOLEAN Menu;\r | |
91 | BOOLEAN SysReq;\r | |
05fbd06d | 92 | \r |
93 | BOOLEAN Ctrl;\r | |
94 | BOOLEAN Alt;\r | |
95 | BOOLEAN Shift;\r | |
96 | BOOLEAN CapsLock;\r | |
97 | BOOLEAN NumLock;\r | |
98 | BOOLEAN ScrollLock;\r | |
99 | \r | |
100 | //\r | |
c220787b | 101 | // Queue storing key scancodes\r |
05fbd06d | 102 | //\r |
c220787b RN |
103 | SCAN_CODE_QUEUE ScancodeQueue;\r |
104 | EFI_KEY_QUEUE EfiKeyQueue;\r | |
05fbd06d | 105 | \r |
106 | //\r | |
107 | // Error state\r | |
108 | //\r | |
109 | BOOLEAN KeyboardErr;\r | |
110 | \r | |
111 | EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r | |
112 | \r | |
113 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
f3d1e940 | 114 | //\r |
115 | // Notification Function List\r | |
116 | //\r | |
117 | LIST_ENTRY NotifyList;\r | |
05fbd06d | 118 | } KEYBOARD_CONSOLE_IN_DEV;\r |
119 | \r | |
120 | #define KEYBOARD_CONSOLE_IN_DEV_FROM_THIS(a) CR (a, KEYBOARD_CONSOLE_IN_DEV, ConIn, KEYBOARD_CONSOLE_IN_DEV_SIGNATURE)\r | |
f3d1e940 | 121 | #define TEXT_INPUT_EX_KEYBOARD_CONSOLE_IN_DEV_FROM_THIS(a) \\r |
122 | CR (a, \\r | |
123 | KEYBOARD_CONSOLE_IN_DEV, \\r | |
124 | ConInEx, \\r | |
125 | KEYBOARD_CONSOLE_IN_DEV_SIGNATURE \\r | |
126 | )\r | |
05fbd06d | 127 | \r |
128 | #define TABLE_END 0x0\r | |
129 | \r | |
05fbd06d | 130 | //\r |
131 | // Driver entry point\r | |
132 | //\r | |
bcd70414 | 133 | /**\r |
134 | The user Entry Point for module Ps2Keyboard. The user code starts with this function.\r | |
135 | \r | |
136 | @param[in] ImageHandle The firmware allocated handle for the EFI image. \r | |
137 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
138 | \r | |
139 | @retval EFI_SUCCESS The entry point is executed successfully.\r | |
140 | @retval other Some error occurs when executing this entry point.\r | |
141 | \r | |
142 | **/\r | |
05fbd06d | 143 | EFI_STATUS\r |
f3d1e940 | 144 | EFIAPI\r |
05fbd06d | 145 | InstallPs2KeyboardDriver (\r |
146 | IN EFI_HANDLE ImageHandle,\r | |
147 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
ed66e1bc | 148 | );\r |
05fbd06d | 149 | \r |
150 | #define KEYBOARD_8042_DATA_REGISTER 0x60\r | |
151 | #define KEYBOARD_8042_STATUS_REGISTER 0x64\r | |
152 | #define KEYBOARD_8042_COMMAND_REGISTER 0x64\r | |
153 | \r | |
154 | #define KEYBOARD_KBEN 0xF4\r | |
155 | #define KEYBOARD_CMDECHO_ACK 0xFA\r | |
156 | \r | |
05f89b17 | 157 | #define KEYBOARD_MAX_TRY 256 // 256\r |
05fbd06d | 158 | #define KEYBOARD_TIMEOUT 65536 // 0.07s\r |
159 | #define KEYBOARD_WAITFORVALUE_TIMEOUT 1000000 // 1s\r | |
160 | #define KEYBOARD_BAT_TIMEOUT 4000000 // 4s\r | |
161 | #define KEYBOARD_TIMER_INTERVAL 200000 // 0.02s\r | |
162 | #define SCANCODE_EXTENDED 0xE0\r | |
163 | #define SCANCODE_EXTENDED1 0xE1\r | |
164 | #define SCANCODE_CTRL_MAKE 0x1D\r | |
165 | #define SCANCODE_CTRL_BREAK 0x9D\r | |
166 | #define SCANCODE_ALT_MAKE 0x38\r | |
167 | #define SCANCODE_ALT_BREAK 0xB8\r | |
168 | #define SCANCODE_LEFT_SHIFT_MAKE 0x2A\r | |
169 | #define SCANCODE_LEFT_SHIFT_BREAK 0xAA\r | |
170 | #define SCANCODE_RIGHT_SHIFT_MAKE 0x36\r | |
171 | #define SCANCODE_RIGHT_SHIFT_BREAK 0xB6\r | |
172 | #define SCANCODE_CAPS_LOCK_MAKE 0x3A\r | |
173 | #define SCANCODE_NUM_LOCK_MAKE 0x45\r | |
174 | #define SCANCODE_SCROLL_LOCK_MAKE 0x46\r | |
c220787b | 175 | #define SCANCODE_DELETE_MAKE 0x53\r |
f3d1e940 | 176 | #define SCANCODE_LEFT_LOGO_MAKE 0x5B //GUI key defined in Keyboard scan code\r |
177 | #define SCANCODE_LEFT_LOGO_BREAK 0xDB\r | |
178 | #define SCANCODE_RIGHT_LOGO_MAKE 0x5C\r | |
179 | #define SCANCODE_RIGHT_LOGO_BREAK 0xDC\r | |
180 | #define SCANCODE_MENU_MAKE 0x5D //APPS key defined in Keyboard scan code \r | |
181 | #define SCANCODE_MENU_BREAK 0xDD\r | |
182 | #define SCANCODE_SYS_REQ_MAKE 0x37\r | |
183 | #define SCANCODE_MAX_MAKE 0x60\r | |
05fbd06d | 184 | \r |
b6763e03 | 185 | #define KEYBOARD_STATUS_REGISTER_HAS_OUTPUT_DATA BIT0 ///< 0 - Output register has no data; 1 - Output register has data\r |
186 | #define KEYBOARD_STATUS_REGISTER_HAS_INPUT_DATA BIT1 ///< 0 - Input register has no data; 1 - Input register has data\r | |
187 | #define KEYBOARD_STATUS_REGISTER_SYSTEM_FLAG BIT2 ///< Set to 0 after power on reset\r | |
188 | #define KEYBOARD_STATUS_REGISTER_INPUT_DATA_TYPE BIT3 ///< 0 - Data in input register is data; 1 - Data in input register is command\r | |
189 | #define KEYBOARD_STATUS_REGISTER_ENABLE_FLAG BIT4 ///< 0 - Keyboard is disable; 1 - Keyboard is enable\r | |
190 | #define KEYBOARD_STATUS_REGISTER_TRANSMIT_TIMEOUT BIT5 ///< 0 - Transmit is complete without timeout; 1 - Transmit is timeout without complete\r | |
191 | #define KEYBOARD_STATUS_REGISTER_RECEIVE_TIMEOUT BIT6 ///< 0 - Receive is complete without timeout; 1 - Receive is timeout without complete\r | |
192 | #define KEYBOARD_STATUS_REGISTER_PARITY BIT7 ///< 0 - Odd parity; 1 - Even parity\r | |
193 | \r | |
194 | #define KEYBOARD_8042_COMMAND_READ 0x20\r | |
195 | #define KEYBOARD_8042_COMMAND_WRITE 0x60\r | |
196 | #define KEYBOARD_8042_COMMAND_DISABLE_MOUSE_INTERFACE 0xA7\r | |
197 | #define KEYBOARD_8042_COMMAND_ENABLE_MOUSE_INTERFACE 0xA8\r | |
198 | #define KEYBOARD_8042_COMMAND_CONTROLLER_SELF_TEST 0xAA\r | |
199 | #define KEYBOARD_8042_COMMAND_KEYBOARD_INTERFACE_SELF_TEST 0xAB\r | |
200 | #define KEYBOARD_8042_COMMAND_DISABLE_KEYBOARD_INTERFACE 0xAD\r | |
201 | \r | |
202 | #define KEYBOARD_8048_COMMAND_CLEAR_OUTPUT_DATA 0xF4\r | |
203 | #define KEYBOARD_8048_COMMAND_RESET 0xFF\r | |
204 | #define KEYBOARD_8048_COMMAND_SELECT_SCAN_CODE_SET 0xF0\r | |
205 | \r | |
206 | #define KEYBOARD_8048_RETURN_8042_BAT_SUCCESS 0xAA\r | |
207 | #define KEYBOARD_8048_RETURN_8042_BAT_ERROR 0xFC\r | |
208 | #define KEYBOARD_8048_RETURN_8042_ACK 0xFA\r | |
209 | \r | |
210 | \r | |
007c18f5 | 211 | //\r |
212 | // Keyboard Controller Status\r | |
213 | //\r | |
214 | #define KBC_PARE 0x80 // Parity Error\r | |
215 | #define KBC_TIM 0x40 // General Time Out\r | |
216 | \r | |
05fbd06d | 217 | //\r |
218 | // Other functions that are used among .c files\r | |
219 | //\r | |
bcd70414 | 220 | /**\r |
221 | Show keyboard status lights according to\r | |
222 | indicators in ConsoleIn.\r | |
223 | \r | |
224 | @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r | |
225 | \r | |
226 | @return status\r | |
f3d1e940 | 227 | \r |
bcd70414 | 228 | **/\r |
f3d1e940 | 229 | EFI_STATUS\r |
230 | UpdateStatusLights (\r | |
231 | IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r | |
ed66e1bc | 232 | );\r |
f3d1e940 | 233 | \r |
bcd70414 | 234 | /**\r |
f713c4fe | 235 | write key to keyboard.\r |
f3d1e940 | 236 | \r |
bcd70414 | 237 | @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r |
238 | @param Data value wanted to be written\r | |
f3d1e940 | 239 | \r |
bcd70414 | 240 | @retval EFI_TIMEOUT - GC_TODO: Add description for return value\r |
241 | @retval EFI_SUCCESS - GC_TODO: Add description for return value\r | |
f3d1e940 | 242 | \r |
bcd70414 | 243 | **/\r |
05fbd06d | 244 | EFI_STATUS\r |
245 | KeyboardRead (\r | |
246 | IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r | |
247 | OUT UINT8 *Data\r | |
ed66e1bc | 248 | );\r |
05fbd06d | 249 | \r |
bcd70414 | 250 | /**\r |
c220787b | 251 | Get scancode from scancode buffer and translate into EFI-scancode and unicode defined by EFI spec.\r |
05fbd06d | 252 | \r |
c220787b | 253 | The function is always called in TPL_NOTIFY.\r |
05fbd06d | 254 | \r |
c220787b | 255 | @param ConsoleIn KEYBOARD_CONSOLE_IN_DEV instance pointer\r |
05fbd06d | 256 | \r |
bcd70414 | 257 | **/\r |
c220787b | 258 | VOID\r |
05fbd06d | 259 | KeyGetchar (\r |
260 | IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r | |
ed66e1bc | 261 | );\r |
05fbd06d | 262 | \r |
bcd70414 | 263 | /**\r |
f713c4fe | 264 | Perform 8042 controller and keyboard Initialization.\r |
bcd70414 | 265 | If ExtendedVerification is TRUE, do additional test for\r |
266 | the keyboard interface\r | |
05fbd06d | 267 | \r |
bcd70414 | 268 | @param ConsoleIn - KEYBOARD_CONSOLE_IN_DEV instance pointer\r |
269 | @param ExtendedVerification - indicates a thorough initialization\r | |
05fbd06d | 270 | \r |
bcd70414 | 271 | @retval EFI_DEVICE_ERROR Fail to init keyboard\r |
272 | @retval EFI_SUCCESS Success to init keyboard\r | |
273 | **/\r | |
05fbd06d | 274 | EFI_STATUS\r |
275 | InitKeyboard (\r | |
276 | IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r | |
277 | IN BOOLEAN ExtendedVerification\r | |
ed66e1bc | 278 | );\r |
05fbd06d | 279 | \r |
bcd70414 | 280 | /**\r |
f713c4fe | 281 | Disable the keyboard interface of the 8042 controller.\r |
05fbd06d | 282 | \r |
bcd70414 | 283 | @param ConsoleIn - the device instance\r |
05fbd06d | 284 | \r |
bcd70414 | 285 | @return status of issuing disable command\r |
05fbd06d | 286 | \r |
bcd70414 | 287 | **/\r |
05fbd06d | 288 | EFI_STATUS\r |
289 | DisableKeyboard (\r | |
290 | IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r | |
ed66e1bc | 291 | );\r |
05fbd06d | 292 | \r |
bcd70414 | 293 | /**\r |
294 | Timer event handler: read a series of scancodes from 8042\r | |
295 | and put them into memory scancode buffer.\r | |
296 | it read as much scancodes to either fill\r | |
297 | the memory buffer or empty the keyboard buffer.\r | |
298 | It is registered as running under TPL_NOTIFY\r | |
05fbd06d | 299 | \r |
bcd70414 | 300 | @param Event - The timer event\r |
301 | @param Context - A KEYBOARD_CONSOLE_IN_DEV pointer\r | |
05fbd06d | 302 | \r |
bcd70414 | 303 | **/\r |
05fbd06d | 304 | VOID\r |
305 | EFIAPI\r | |
306 | KeyboardTimerHandler (\r | |
307 | IN EFI_EVENT Event,\r | |
308 | IN VOID *Context\r | |
ed66e1bc | 309 | );\r |
05fbd06d | 310 | \r |
bcd70414 | 311 | /**\r |
312 | logic reset keyboard\r | |
313 | Implement SIMPLE_TEXT_IN.Reset()\r | |
314 | Perform 8042 controller and keyboard initialization\r | |
05fbd06d | 315 | \r |
bcd70414 | 316 | @param This Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r |
317 | @param ExtendedVerification Indicate that the driver may perform a more \r | |
318 | exhaustive verification operation of the device during \r | |
319 | reset, now this par is ignored in this driver \r | |
05fbd06d | 320 | \r |
bcd70414 | 321 | **/\r |
05fbd06d | 322 | EFI_STATUS\r |
323 | EFIAPI\r | |
324 | KeyboardEfiReset (\r | |
325 | IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r | |
326 | IN BOOLEAN ExtendedVerification\r | |
ed66e1bc | 327 | );\r |
05fbd06d | 328 | \r |
bcd70414 | 329 | /**\r |
330 | Implement SIMPLE_TEXT_IN.ReadKeyStroke().\r | |
331 | Retrieve key values for driver user.\r | |
05fbd06d | 332 | \r |
bcd70414 | 333 | @param This Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r |
334 | @param Key The output buffer for key value \r | |
05fbd06d | 335 | \r |
bcd70414 | 336 | @retval EFI_SUCCESS success to read key stroke\r |
337 | **/\r | |
05fbd06d | 338 | EFI_STATUS\r |
339 | EFIAPI\r | |
340 | KeyboardReadKeyStroke (\r | |
341 | IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r | |
342 | OUT EFI_INPUT_KEY *Key\r | |
ed66e1bc | 343 | );\r |
05fbd06d | 344 | \r |
bcd70414 | 345 | /**\r |
346 | Event notification function for SIMPLE_TEXT_IN.WaitForKey event\r | |
347 | Signal the event if there is key available\r | |
05fbd06d | 348 | \r |
bcd70414 | 349 | @param Event the event object\r |
350 | @param Context waitting context\r | |
05fbd06d | 351 | \r |
bcd70414 | 352 | **/\r |
05fbd06d | 353 | VOID\r |
354 | EFIAPI\r | |
355 | KeyboardWaitForKey (\r | |
356 | IN EFI_EVENT Event,\r | |
357 | IN VOID *Context\r | |
ed66e1bc | 358 | );\r |
05fbd06d | 359 | \r |
bcd70414 | 360 | /**\r |
f713c4fe | 361 | Read status register.\r |
05fbd06d | 362 | \r |
bcd70414 | 363 | @param ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r |
05fbd06d | 364 | \r |
bcd70414 | 365 | @return value in status register\r |
05fbd06d | 366 | \r |
bcd70414 | 367 | **/\r |
05fbd06d | 368 | UINT8\r |
369 | KeyReadStatusRegister (\r | |
370 | IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r | |
ed66e1bc | 371 | );\r |
05fbd06d | 372 | \r |
373 | /**\r | |
374 | Check whether there is Ps/2 Keyboard device in system by 0xF4 Keyboard Command\r | |
375 | If Keyboard receives 0xF4, it will respond with 'ACK'. If it doesn't respond, the device\r | |
376 | should not be in system.\r | |
377 | \r | |
f713c4fe | 378 | @param[in] ConsoleIn Pointer to instance of KEYBOARD_CONSOLE_IN_DEV\r |
05fbd06d | 379 | \r |
f3d1e940 | 380 | @retval TRUE Keyboard in System.\r |
381 | @retval FALSE Keyboard not in System.\r | |
05fbd06d | 382 | **/\r |
383 | BOOLEAN\r | |
384 | EFIAPI\r | |
385 | CheckKeyboardConnect (\r | |
386 | IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r | |
ed66e1bc | 387 | );\r |
f3d1e940 | 388 | \r |
bcd70414 | 389 | /**\r |
390 | Event notification function for SIMPLE_TEXT_INPUT_EX_PROTOCOL.WaitForKeyEx event\r | |
391 | Signal the event if there is key available\r | |
392 | \r | |
393 | @param Event event object\r | |
394 | @param Context waiting context\r | |
395 | \r | |
396 | **/\r | |
f3d1e940 | 397 | VOID\r |
398 | EFIAPI\r | |
399 | KeyboardWaitForKeyEx (\r | |
400 | IN EFI_EVENT Event,\r | |
401 | IN VOID *Context\r | |
ed66e1bc | 402 | ); \r |
f3d1e940 | 403 | \r |
404 | //\r | |
405 | // Simple Text Input Ex protocol function prototypes\r | |
406 | //\r | |
407 | \r | |
bcd70414 | 408 | /**\r |
409 | Reset the input device and optionaly run diagnostics\r | |
410 | \r | |
411 | @param This - Protocol instance pointer.\r | |
412 | @param ExtendedVerification - Driver may perform diagnostics on reset.\r | |
413 | \r | |
414 | @retval EFI_SUCCESS - The device was reset.\r | |
415 | @retval EFI_DEVICE_ERROR - The device is not functioning properly and could \r | |
416 | not be reset.\r | |
417 | \r | |
418 | **/\r | |
f3d1e940 | 419 | EFI_STATUS\r |
420 | EFIAPI\r | |
421 | KeyboardEfiResetEx (\r | |
422 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r | |
423 | IN BOOLEAN ExtendedVerification\r | |
ed66e1bc | 424 | );\r |
f3d1e940 | 425 | \r |
bcd70414 | 426 | /**\r |
427 | Reads the next keystroke from the input device. The WaitForKey Event can \r | |
428 | be used to test for existance of a keystroke via WaitForEvent () call.\r | |
f3d1e940 | 429 | \r |
f3d1e940 | 430 | \r |
bcd70414 | 431 | @param This - Protocol instance pointer.\r |
432 | @param KeyData - A pointer to a buffer that is filled in with the keystroke \r | |
433 | state data for the key that was pressed.\r | |
f3d1e940 | 434 | \r |
bcd70414 | 435 | @retval EFI_SUCCESS - The keystroke information was returned.\r |
436 | @retval EFI_NOT_READY - There was no keystroke data availiable.\r | |
437 | @retval EFI_DEVICE_ERROR - The keystroke information was not returned due to \r | |
438 | hardware errors.\r | |
439 | @retval EFI_INVALID_PARAMETER - KeyData is NULL. \r | |
f3d1e940 | 440 | \r |
bcd70414 | 441 | **/\r |
f3d1e940 | 442 | EFI_STATUS\r |
443 | EFIAPI\r | |
444 | KeyboardReadKeyStrokeEx (\r | |
445 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r | |
446 | OUT EFI_KEY_DATA *KeyData\r | |
ed66e1bc | 447 | );\r |
f3d1e940 | 448 | \r |
bcd70414 | 449 | /**\r |
450 | Set certain state for the input device.\r | |
f3d1e940 | 451 | \r |
bcd70414 | 452 | @param This - Protocol instance pointer.\r |
453 | @param KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the \r | |
454 | state for the input device.\r | |
f3d1e940 | 455 | \r |
bcd70414 | 456 | @retval EFI_SUCCESS - The device state was set successfully.\r |
457 | @retval EFI_DEVICE_ERROR - The device is not functioning correctly and could \r | |
458 | not have the setting adjusted.\r | |
459 | @retval EFI_UNSUPPORTED - The device does not have the ability to set its state.\r | |
460 | @retval EFI_INVALID_PARAMETER - KeyToggleState is NULL. \r | |
f3d1e940 | 461 | \r |
bcd70414 | 462 | **/\r |
f3d1e940 | 463 | EFI_STATUS\r |
464 | EFIAPI\r | |
465 | KeyboardSetState (\r | |
466 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r | |
467 | IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r | |
ed66e1bc | 468 | );\r |
f3d1e940 | 469 | \r |
bcd70414 | 470 | /**\r |
471 | Register a notification function for a particular keystroke for the input device.\r | |
472 | \r | |
473 | @param This - Protocol instance pointer.\r | |
474 | @param KeyData - A pointer to a buffer that is filled in with the keystroke \r | |
475 | information data for the key that was pressed.\r | |
476 | @param KeyNotificationFunction - Points to the function to be called when the key \r | |
477 | sequence is typed specified by KeyData. \r | |
478 | @param NotifyHandle - Points to the unique handle assigned to the registered notification. \r | |
479 | \r | |
480 | @retval EFI_SUCCESS - The notification function was registered successfully.\r | |
481 | @retval EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r | |
482 | @retval EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. \r | |
483 | \r | |
484 | **/ \r | |
f3d1e940 | 485 | EFI_STATUS\r |
486 | EFIAPI\r | |
487 | KeyboardRegisterKeyNotify (\r | |
488 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r | |
489 | IN EFI_KEY_DATA *KeyData,\r | |
490 | IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r | |
491 | OUT EFI_HANDLE *NotifyHandle\r | |
ed66e1bc | 492 | );\r |
f3d1e940 | 493 | \r |
bcd70414 | 494 | /**\r |
495 | Remove a registered notification function from a particular keystroke.\r | |
f3d1e940 | 496 | \r |
bcd70414 | 497 | @param This - Protocol instance pointer. \r |
498 | @param NotificationHandle - The handle of the notification function being unregistered.\r | |
f3d1e940 | 499 | \r |
bcd70414 | 500 | \r |
501 | @retval EFI_SUCCESS - The notification function was unregistered successfully.\r | |
502 | @retval EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r | |
503 | @retval EFI_NOT_FOUND - Can not find the matching entry in database. \r | |
f3d1e940 | 504 | \r |
bcd70414 | 505 | **/ \r |
f3d1e940 | 506 | EFI_STATUS\r |
507 | EFIAPI\r | |
508 | KeyboardUnregisterKeyNotify (\r | |
509 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r | |
510 | IN EFI_HANDLE NotificationHandle\r | |
ed66e1bc | 511 | );\r |
f3d1e940 | 512 | \r |
c220787b RN |
513 | /**\r |
514 | Push one key data to the EFI key buffer.\r | |
515 | \r | |
516 | @param Queue Pointer to instance of EFI_KEY_QUEUE.\r | |
517 | @param KeyData The key data to push.\r | |
518 | **/\r | |
519 | VOID\r | |
520 | PushEfikeyBufTail (\r | |
521 | IN EFI_KEY_QUEUE *Queue,\r | |
522 | IN EFI_KEY_DATA *KeyData\r | |
523 | );\r | |
524 | \r | |
525 | /**\r | |
526 | Judge whether is a registed key\r | |
527 | \r | |
528 | @param RegsiteredData A pointer to a buffer that is filled in with the keystroke \r | |
529 | state data for the key that was registered.\r | |
530 | @param InputData A pointer to a buffer that is filled in with the keystroke \r | |
531 | state data for the key that was pressed.\r | |
532 | \r | |
533 | @retval TRUE Key be pressed matches a registered key.\r | |
534 | @retval FLASE Match failed. \r | |
535 | \r | |
536 | **/\r | |
537 | BOOLEAN\r | |
538 | IsKeyRegistered (\r | |
539 | IN EFI_KEY_DATA *RegsiteredData,\r | |
540 | IN EFI_KEY_DATA *InputData\r | |
541 | );\r | |
05fbd06d | 542 | #endif\r |