]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
change TokenSpaceGuid to the package Token Space Guid
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / Ps2KeyboardDxe / Ps2Keyboard.h
CommitLineData
05fbd06d 1/**@file\r
2 PS/2 keyboard driver header file\r
3\r
df0dcb5e 4Copyright (c) 2006 - 2007, Intel Corporation\r
5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
05fbd06d 12\r
13**/\r
14\r
15#ifndef _PS2KEYBOARD_H\r
16#define _PS2KEYBOARD_H\r
17\r
752f2e26 18#include <PiDxe.h>\r
19#include <Framework/StatusCode.h>\r
20\r
21#include <Protocol/SimpleTextIn.h>\r
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
05fbd06d 33\r
34//\r
35// Driver Private Data\r
36//\r
37#define KEYBOARD_BUFFER_MAX_COUNT 32\r
38#define KEYBOARD_CONSOLE_IN_DEV_SIGNATURE EFI_SIGNATURE_32 ('k', 'k', 'e', 'y')\r
39\r
40typedef struct {\r
41 UINTN Signature;\r
42\r
43 EFI_HANDLE Handle;\r
44 EFI_SIMPLE_TEXT_INPUT_PROTOCOL ConIn;\r
45 EFI_ISA_IO_PROTOCOL *IsaIo;\r
46\r
47 EFI_EVENT TimerEvent;\r
48\r
49 UINT32 DataRegisterAddress;\r
50 UINT32 StatusRegisterAddress;\r
51 UINT32 CommandRegisterAddress;\r
52\r
53 EFI_INPUT_KEY Key;\r
54\r
55 BOOLEAN Ctrl;\r
56 BOOLEAN Alt;\r
57 BOOLEAN Shift;\r
58 BOOLEAN CapsLock;\r
59 BOOLEAN NumLock;\r
60 BOOLEAN ScrollLock;\r
61\r
62 //\r
63 // Buffer storing key scancodes\r
64 //\r
65 UINT8 ScancodeBuf[KEYBOARD_BUFFER_MAX_COUNT];\r
66 UINT32 ScancodeBufStartPos;\r
67 UINT32 ScancodeBufEndPos;\r
68 UINT32 ScancodeBufCount;\r
69\r
70 //\r
71 // Indicators of the key pressing state, used in detecting Alt+Ctrl+Del\r
72 //\r
73 BOOLEAN Ctrled;\r
74 BOOLEAN Alted;\r
75\r
76 //\r
77 // Error state\r
78 //\r
79 BOOLEAN KeyboardErr;\r
80\r
81 EFI_UNICODE_STRING_TABLE *ControllerNameTable;\r
82\r
83 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
84} KEYBOARD_CONSOLE_IN_DEV;\r
85\r
86#define KEYBOARD_CONSOLE_IN_DEV_FROM_THIS(a) CR (a, KEYBOARD_CONSOLE_IN_DEV, ConIn, KEYBOARD_CONSOLE_IN_DEV_SIGNATURE)\r
87\r
88#define TABLE_END 0x0\r
89\r
90//\r
91// Global Variables\r
92//\r
93extern EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver;\r
94extern EFI_COMPONENT_NAME_PROTOCOL gPs2KeyboardComponentName;\r
95\r
96//\r
97// Driver entry point\r
98//\r
99EFI_STATUS\r
100InstallPs2KeyboardDriver (\r
101 IN EFI_HANDLE ImageHandle,\r
102 IN EFI_SYSTEM_TABLE *SystemTable\r
103 )\r
104/*++\r
105\r
106Routine Description:\r
107\r
108 GC_TODO: Add function description\r
109\r
110Arguments:\r
111\r
112 ImageHandle - GC_TODO: add argument description\r
113 SystemTable - GC_TODO: add argument description\r
114\r
115Returns:\r
116\r
117 GC_TODO: add return values\r
118\r
119--*/\r
120;\r
121\r
122#define KEYBOARD_8042_DATA_REGISTER 0x60\r
123#define KEYBOARD_8042_STATUS_REGISTER 0x64\r
124#define KEYBOARD_8042_COMMAND_REGISTER 0x64\r
125\r
126#define KEYBOARD_KBEN 0xF4\r
127#define KEYBOARD_CMDECHO_ACK 0xFA\r
128\r
129#define KEYBOARD_TIMEOUT 65536 // 0.07s\r
130#define KEYBOARD_WAITFORVALUE_TIMEOUT 1000000 // 1s\r
131#define KEYBOARD_BAT_TIMEOUT 4000000 // 4s\r
132#define KEYBOARD_TIMER_INTERVAL 200000 // 0.02s\r
133#define SCANCODE_EXTENDED 0xE0\r
134#define SCANCODE_EXTENDED1 0xE1\r
135#define SCANCODE_CTRL_MAKE 0x1D\r
136#define SCANCODE_CTRL_BREAK 0x9D\r
137#define SCANCODE_ALT_MAKE 0x38\r
138#define SCANCODE_ALT_BREAK 0xB8\r
139#define SCANCODE_LEFT_SHIFT_MAKE 0x2A\r
140#define SCANCODE_LEFT_SHIFT_BREAK 0xAA\r
141#define SCANCODE_RIGHT_SHIFT_MAKE 0x36\r
142#define SCANCODE_RIGHT_SHIFT_BREAK 0xB6\r
143#define SCANCODE_CAPS_LOCK_MAKE 0x3A\r
144#define SCANCODE_NUM_LOCK_MAKE 0x45\r
145#define SCANCODE_SCROLL_LOCK_MAKE 0x46\r
146#define SCANCODE_MAX_MAKE 0x59\r
147\r
148//\r
149// Other functions that are used among .c files\r
150//\r
151EFI_STATUS\r
152KeyboardRead (\r
153 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
154 OUT UINT8 *Data\r
155 )\r
156/*++\r
157\r
158Routine Description:\r
159\r
160 GC_TODO: Add function description\r
161\r
162Arguments:\r
163\r
164 ConsoleIn - GC_TODO: add argument description\r
165 Data - GC_TODO: add argument description\r
166\r
167Returns:\r
168\r
169 GC_TODO: add return values\r
170\r
171--*/\r
172;\r
173\r
174EFI_STATUS\r
175KeyGetchar (\r
176 IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
177 )\r
178/*++\r
179\r
180Routine Description:\r
181\r
182 GC_TODO: Add function description\r
183\r
184Arguments:\r
185\r
186 ConsoleIn - GC_TODO: add argument description\r
187\r
188Returns:\r
189\r
190 GC_TODO: add return values\r
191\r
192--*/\r
193;\r
194\r
195EFI_STATUS\r
196InitKeyboard (\r
197 IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
198 IN BOOLEAN ExtendedVerification\r
199 )\r
200/*++\r
201\r
202Routine Description:\r
203\r
204 GC_TODO: Add function description\r
205\r
206Arguments:\r
207\r
208 ConsoleIn - GC_TODO: add argument description\r
209 ExtendedVerification - GC_TODO: add argument description\r
210\r
211Returns:\r
212\r
213 GC_TODO: add return values\r
214\r
215--*/\r
216;\r
217\r
218EFI_STATUS\r
219DisableKeyboard (\r
220 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
221 )\r
222/*++\r
223\r
224Routine Description:\r
225\r
226 GC_TODO: Add function description\r
227\r
228Arguments:\r
229\r
230 ConsoleIn - GC_TODO: add argument description\r
231\r
232Returns:\r
233\r
234 GC_TODO: add return values\r
235\r
236--*/\r
237;\r
238\r
239VOID\r
240EFIAPI\r
241KeyboardTimerHandler (\r
242 IN EFI_EVENT Event,\r
243 IN VOID *Context\r
244 )\r
245/*++\r
246\r
247Routine Description:\r
248\r
249 GC_TODO: Add function description\r
250\r
251Arguments:\r
252\r
253 Event - GC_TODO: add argument description\r
254 Context - GC_TODO: add argument description\r
255\r
256Returns:\r
257\r
258 GC_TODO: add return values\r
259\r
260--*/\r
261;\r
262\r
263EFI_STATUS\r
264EFIAPI\r
265KeyboardEfiReset (\r
266 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
267 IN BOOLEAN ExtendedVerification\r
268 )\r
269/*++\r
270\r
271Routine Description:\r
272\r
273 GC_TODO: Add function description\r
274\r
275Arguments:\r
276\r
277 This - GC_TODO: add argument description\r
278 ExtendedVerification - GC_TODO: add argument description\r
279\r
280Returns:\r
281\r
282 GC_TODO: add return values\r
283\r
284--*/\r
285;\r
286\r
287EFI_STATUS\r
288EFIAPI\r
289KeyboardReadKeyStroke (\r
290 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
291 OUT EFI_INPUT_KEY *Key\r
292 )\r
293/*++\r
294\r
295Routine Description:\r
296\r
297 GC_TODO: Add function description\r
298\r
299Arguments:\r
300\r
301 This - GC_TODO: add argument description\r
302 Key - GC_TODO: add argument description\r
303\r
304Returns:\r
305\r
306 GC_TODO: add return values\r
307\r
308--*/\r
309;\r
310\r
311VOID\r
312EFIAPI\r
313KeyboardWaitForKey (\r
314 IN EFI_EVENT Event,\r
315 IN VOID *Context\r
316 )\r
317/*++\r
318\r
319Routine Description:\r
320\r
321 GC_TODO: Add function description\r
322\r
323Arguments:\r
324\r
325 Event - GC_TODO: add argument description\r
326 Context - GC_TODO: add argument description\r
327\r
328Returns:\r
329\r
330 GC_TODO: add return values\r
331\r
332--*/\r
333;\r
334\r
335UINT8\r
336KeyReadStatusRegister (\r
337 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
338 )\r
339/*++\r
340\r
341Routine Description:\r
342\r
343 GC_TODO: Add function description\r
344\r
345Arguments:\r
346\r
347 ConsoleIn - GC_TODO: add argument description\r
348\r
349Returns:\r
350\r
351 GC_TODO: add return values\r
352\r
353--*/\r
354;\r
355\r
356/**\r
357 Check whether there is Ps/2 Keyboard device in system by 0xF4 Keyboard Command\r
358 If Keyboard receives 0xF4, it will respond with 'ACK'. If it doesn't respond, the device\r
359 should not be in system.\r
360\r
361 @param[in] BiosKeyboardPrivate Keyboard Private Data Structure\r
362\r
363 @retval TRUE Keyboard in System.\r
364 @retval FALSE Keyboard not in System.\r
365**/\r
366BOOLEAN\r
367EFIAPI\r
368CheckKeyboardConnect (\r
369 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
370 )\r
371;\r
372#endif\r
EFI Development Kit II mirror for PVE