]> 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
Update to support EFI_SIMPLE_INPUT_EX protocol
[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
f3d08ccf 93extern EFI_DRIVER_BINDING_PROTOCOL gKeyboardControllerDriver;\r
94extern EFI_COMPONENT_NAME_PROTOCOL gPs2KeyboardComponentName;\r
95extern EFI_COMPONENT_NAME2_PROTOCOL gPs2KeyboardComponentName2;\r
05fbd06d 96\r
97//\r
98// Driver entry point\r
99//\r
100EFI_STATUS\r
101InstallPs2KeyboardDriver (\r
102 IN EFI_HANDLE ImageHandle,\r
103 IN EFI_SYSTEM_TABLE *SystemTable\r
104 )\r
105/*++\r
106\r
107Routine Description:\r
108\r
109 GC_TODO: Add function description\r
110\r
111Arguments:\r
112\r
113 ImageHandle - GC_TODO: add argument description\r
114 SystemTable - GC_TODO: add argument description\r
115\r
116Returns:\r
117\r
118 GC_TODO: add return values\r
119\r
120--*/\r
121;\r
122\r
123#define KEYBOARD_8042_DATA_REGISTER 0x60\r
124#define KEYBOARD_8042_STATUS_REGISTER 0x64\r
125#define KEYBOARD_8042_COMMAND_REGISTER 0x64\r
126\r
127#define KEYBOARD_KBEN 0xF4\r
128#define KEYBOARD_CMDECHO_ACK 0xFA\r
129\r
130#define KEYBOARD_TIMEOUT 65536 // 0.07s\r
131#define KEYBOARD_WAITFORVALUE_TIMEOUT 1000000 // 1s\r
132#define KEYBOARD_BAT_TIMEOUT 4000000 // 4s\r
133#define KEYBOARD_TIMER_INTERVAL 200000 // 0.02s\r
134#define SCANCODE_EXTENDED 0xE0\r
135#define SCANCODE_EXTENDED1 0xE1\r
136#define SCANCODE_CTRL_MAKE 0x1D\r
137#define SCANCODE_CTRL_BREAK 0x9D\r
138#define SCANCODE_ALT_MAKE 0x38\r
139#define SCANCODE_ALT_BREAK 0xB8\r
140#define SCANCODE_LEFT_SHIFT_MAKE 0x2A\r
141#define SCANCODE_LEFT_SHIFT_BREAK 0xAA\r
142#define SCANCODE_RIGHT_SHIFT_MAKE 0x36\r
143#define SCANCODE_RIGHT_SHIFT_BREAK 0xB6\r
144#define SCANCODE_CAPS_LOCK_MAKE 0x3A\r
145#define SCANCODE_NUM_LOCK_MAKE 0x45\r
146#define SCANCODE_SCROLL_LOCK_MAKE 0x46\r
147#define SCANCODE_MAX_MAKE 0x59\r
148\r
149//\r
150// Other functions that are used among .c files\r
151//\r
152EFI_STATUS\r
153KeyboardRead (\r
154 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
155 OUT UINT8 *Data\r
156 )\r
157/*++\r
158\r
159Routine Description:\r
160\r
161 GC_TODO: Add function description\r
162\r
163Arguments:\r
164\r
165 ConsoleIn - GC_TODO: add argument description\r
166 Data - GC_TODO: add argument description\r
167\r
168Returns:\r
169\r
170 GC_TODO: add return values\r
171\r
172--*/\r
173;\r
174\r
175EFI_STATUS\r
176KeyGetchar (\r
177 IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
178 )\r
179/*++\r
180\r
181Routine Description:\r
182\r
183 GC_TODO: Add function description\r
184\r
185Arguments:\r
186\r
187 ConsoleIn - GC_TODO: add argument description\r
188\r
189Returns:\r
190\r
191 GC_TODO: add return values\r
192\r
193--*/\r
194;\r
195\r
196EFI_STATUS\r
197InitKeyboard (\r
198 IN OUT KEYBOARD_CONSOLE_IN_DEV *ConsoleIn,\r
199 IN BOOLEAN ExtendedVerification\r
200 )\r
201/*++\r
202\r
203Routine Description:\r
204\r
205 GC_TODO: Add function description\r
206\r
207Arguments:\r
208\r
209 ConsoleIn - GC_TODO: add argument description\r
210 ExtendedVerification - GC_TODO: add argument description\r
211\r
212Returns:\r
213\r
214 GC_TODO: add return values\r
215\r
216--*/\r
217;\r
218\r
219EFI_STATUS\r
220DisableKeyboard (\r
221 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
222 )\r
223/*++\r
224\r
225Routine Description:\r
226\r
227 GC_TODO: Add function description\r
228\r
229Arguments:\r
230\r
231 ConsoleIn - GC_TODO: add argument description\r
232\r
233Returns:\r
234\r
235 GC_TODO: add return values\r
236\r
237--*/\r
238;\r
239\r
240VOID\r
241EFIAPI\r
242KeyboardTimerHandler (\r
243 IN EFI_EVENT Event,\r
244 IN VOID *Context\r
245 )\r
246/*++\r
247\r
248Routine Description:\r
249\r
250 GC_TODO: Add function description\r
251\r
252Arguments:\r
253\r
254 Event - GC_TODO: add argument description\r
255 Context - GC_TODO: add argument description\r
256\r
257Returns:\r
258\r
259 GC_TODO: add return values\r
260\r
261--*/\r
262;\r
263\r
264EFI_STATUS\r
265EFIAPI\r
266KeyboardEfiReset (\r
267 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
268 IN BOOLEAN ExtendedVerification\r
269 )\r
270/*++\r
271\r
272Routine Description:\r
273\r
274 GC_TODO: Add function description\r
275\r
276Arguments:\r
277\r
278 This - GC_TODO: add argument description\r
279 ExtendedVerification - GC_TODO: add argument description\r
280\r
281Returns:\r
282\r
283 GC_TODO: add return values\r
284\r
285--*/\r
286;\r
287\r
288EFI_STATUS\r
289EFIAPI\r
290KeyboardReadKeyStroke (\r
291 IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
292 OUT EFI_INPUT_KEY *Key\r
293 )\r
294/*++\r
295\r
296Routine Description:\r
297\r
298 GC_TODO: Add function description\r
299\r
300Arguments:\r
301\r
302 This - GC_TODO: add argument description\r
303 Key - GC_TODO: add argument description\r
304\r
305Returns:\r
306\r
307 GC_TODO: add return values\r
308\r
309--*/\r
310;\r
311\r
312VOID\r
313EFIAPI\r
314KeyboardWaitForKey (\r
315 IN EFI_EVENT Event,\r
316 IN VOID *Context\r
317 )\r
318/*++\r
319\r
320Routine Description:\r
321\r
322 GC_TODO: Add function description\r
323\r
324Arguments:\r
325\r
326 Event - GC_TODO: add argument description\r
327 Context - GC_TODO: add argument description\r
328\r
329Returns:\r
330\r
331 GC_TODO: add return values\r
332\r
333--*/\r
334;\r
335\r
336UINT8\r
337KeyReadStatusRegister (\r
338 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
339 )\r
340/*++\r
341\r
342Routine Description:\r
343\r
344 GC_TODO: Add function description\r
345\r
346Arguments:\r
347\r
348 ConsoleIn - GC_TODO: add argument description\r
349\r
350Returns:\r
351\r
352 GC_TODO: add return values\r
353\r
354--*/\r
355;\r
356\r
357/**\r
358 Check whether there is Ps/2 Keyboard device in system by 0xF4 Keyboard Command\r
359 If Keyboard receives 0xF4, it will respond with 'ACK'. If it doesn't respond, the device\r
360 should not be in system.\r
361\r
362 @param[in] BiosKeyboardPrivate Keyboard Private Data Structure\r
363\r
364 @retval TRUE Keyboard in System.\r
365 @retval FALSE Keyboard not in System.\r
366**/\r
367BOOLEAN\r
368EFIAPI\r
369CheckKeyboardConnect (\r
370 IN KEYBOARD_CONSOLE_IN_DEV *ConsoleIn\r
371 )\r
372;\r
373#endif\r
EFI Development Kit II mirror for PVE