]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
c8c44377 | 2 | Simple Text Input Ex protocol from the UEFI 2.0 specification.\r |
3 | \r | |
4 | This protocol defines an extension to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r | |
5 | which exposes much more state and modifier information from the input device,\r | |
6 | also allows one to register a notification for a particular keystroke.\r | |
d1f95000 | 7 | \r |
d7dfd027 | 8 | Copyright (c) 2006 - 2009, Intel Corporation \r |
d1f95000 | 9 | All rights reserved. This program and the accompanying materials \r |
10 | are licensed and made available under the terms and conditions of the BSD License \r | |
11 | which accompanies this distribution. The full text of the license may be found at \r | |
12 | http://opensource.org/licenses/bsd-license.php \r | |
13 | \r | |
14 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
15 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
16 | \r | |
d1f95000 | 17 | **/\r |
18 | \r | |
19 | #ifndef __SIMPLE_TEXT_IN_EX_H__\r | |
20 | #define __SIMPLE_TEXT_IN_EX_H__\r | |
21 | \r | |
22 | #define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \\r | |
23 | {0xdd9e7534, 0x7762, 0x4698, { 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa } }\r | |
24 | \r | |
25 | \r | |
26 | typedef struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL;\r | |
27 | \r | |
28 | /**\r | |
29 | The Reset() function resets the input device hardware. As part\r | |
30 | of initialization process, the firmware/device will make a quick\r | |
31 | but reasonable attempt to verify that the device is functioning.\r | |
32 | If the ExtendedVerification flag is TRUE the firmware may take\r | |
33 | an extended amount of time to verify the device is operating on\r | |
34 | reset. Otherwise the reset operation is to occur as quickly as\r | |
35 | possible. The hardware verification process is not defined by\r | |
36 | this specification and is left up to the platform firmware or\r | |
37 | driver to implement.\r | |
38 | \r | |
4ca9b6c4 | 39 | @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r |
d1f95000 | 40 | \r |
41 | @param ExtendedVerification Indicates that the driver may\r | |
42 | perform a more exhaustive\r | |
43 | verification operation of the\r | |
44 | device during reset.\r | |
45 | \r | |
46 | \r | |
4ca9b6c4 | 47 | @retval EFI_SUCCESS The device was reset.\r |
d1f95000 | 48 | \r |
49 | @retval EFI_DEVICE_ERROR The device is not functioning\r | |
50 | correctly and could not be reset.\r | |
51 | \r | |
52 | **/\r | |
53 | typedef\r | |
54 | EFI_STATUS\r | |
8b13229b | 55 | (EFIAPI *EFI_INPUT_RESET_EX)(\r |
85f74a01 | 56 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r |
57 | IN BOOLEAN ExtendedVerification\r | |
d1f95000 | 58 | );\r |
59 | \r | |
60 | \r | |
992f22b9 | 61 | ///\r |
630b4187 | 62 | /// EFI_KEY_TOGGLE_STATE. The toggle states are defined.\r |
63 | /// They are: EFI_TOGGLE_STATE_VALID, EFI_SCROLL_LOCK_ACTIVE\r | |
992f22b9 LG |
64 | /// EFI_NUM_LOCK_ACTIVE, EFI_CAPS_LOCK_ACTIVE\r |
65 | ///\r | |
85f74a01 | 66 | typedef UINT8 EFI_KEY_TOGGLE_STATE;\r |
d1f95000 | 67 | \r |
d1f95000 | 68 | typedef struct _EFI_KEY_STATE {\r |
992f22b9 LG |
69 | ///\r |
70 | /// Reflects the currently pressed shift\r | |
71 | /// modifiers for the input device. The\r | |
72 | /// returned value is valid only if the high\r | |
73 | /// order bit has been set.\r | |
74 | ///\r | |
d1f95000 | 75 | UINT32 KeyShiftState;\r |
992f22b9 LG |
76 | ///\r |
77 | /// Reflects the current internal state of\r | |
78 | /// various toggled attributes. The returned\r | |
79 | /// value is valid only if the high order\r | |
80 | /// bit has been set.\r | |
81 | ///\r | |
d1f95000 | 82 | EFI_KEY_TOGGLE_STATE KeyToggleState;\r |
83 | } EFI_KEY_STATE;\r | |
84 | \r | |
d1f95000 | 85 | typedef struct {\r |
992f22b9 LG |
86 | ///\r |
87 | /// The EFI scan code and Unicode value returned from the input device.\r | |
88 | ///\r | |
d1f95000 | 89 | EFI_INPUT_KEY Key;\r |
992f22b9 LG |
90 | ///\r |
91 | /// The current state of various toggled attributes as well as input modifier values.\r | |
92 | ///\r | |
d1f95000 | 93 | EFI_KEY_STATE KeyState;\r |
94 | } EFI_KEY_DATA;\r | |
95 | \r | |
d1f95000 | 96 | //\r |
97 | // Any Shift or Toggle State that is valid should have\r | |
98 | // high order bit set.\r | |
99 | //\r | |
85f74a01 | 100 | // Shift state\r |
101 | //\r | |
102 | #define EFI_SHIFT_STATE_VALID 0x80000000\r | |
103 | #define EFI_RIGHT_SHIFT_PRESSED 0x00000001\r | |
104 | #define EFI_LEFT_SHIFT_PRESSED 0x00000002\r | |
105 | #define EFI_RIGHT_CONTROL_PRESSED 0x00000004\r | |
106 | #define EFI_LEFT_CONTROL_PRESSED 0x00000008\r | |
107 | #define EFI_RIGHT_ALT_PRESSED 0x00000010\r | |
108 | #define EFI_LEFT_ALT_PRESSED 0x00000020\r | |
109 | #define EFI_RIGHT_LOGO_PRESSED 0x00000040\r | |
110 | #define EFI_LEFT_LOGO_PRESSED 0x00000080\r | |
111 | #define EFI_MENU_KEY_PRESSED 0x00000100\r | |
112 | #define EFI_SYS_REQ_PRESSED 0x00000200\r | |
113 | \r | |
114 | // \r | |
115 | // Toggle state \r | |
116 | // \r | |
117 | #define EFI_TOGGLE_STATE_VALID 0x80\r | |
118 | #define EFI_SCROLL_LOCK_ACTIVE 0x01\r | |
119 | #define EFI_NUM_LOCK_ACTIVE 0x02\r | |
120 | #define EFI_CAPS_LOCK_ACTIVE 0x04\r | |
121 | \r | |
122 | // \r | |
123 | // EFI Scan codes \r | |
124 | // \r | |
125 | #define SCAN_F13 0x0068\r | |
126 | #define SCAN_F14 0x0069\r | |
127 | #define SCAN_F15 0x006A\r | |
128 | #define SCAN_F16 0x006B\r | |
129 | #define SCAN_F17 0x006C\r | |
130 | #define SCAN_F18 0x006D\r | |
131 | #define SCAN_F19 0x006E\r | |
132 | #define SCAN_F20 0x006F\r | |
133 | #define SCAN_F21 0x0070\r | |
134 | #define SCAN_F22 0x0071\r | |
135 | #define SCAN_F23 0x0072\r | |
136 | #define SCAN_F24 0x0073\r | |
137 | #define SCAN_MUTE 0x007F\r | |
138 | #define SCAN_VOLUME_UP 0x0080\r | |
139 | #define SCAN_VOLUME_DOWN 0x0081\r | |
140 | #define SCAN_BRIGHTNESS_UP 0x0100\r | |
141 | #define SCAN_BRIGHTNESS_DOWN 0x0101\r | |
142 | #define SCAN_SUSPEND 0x0102\r | |
143 | #define SCAN_HIBERNATE 0x0103\r | |
144 | #define SCAN_TOGGLE_DISPLAY 0x0104\r | |
145 | #define SCAN_RECOVERY 0x0105\r | |
146 | #define SCAN_EJECT 0x0106\r | |
d1f95000 | 147 | \r |
148 | /**\r | |
149 | The function reads the next keystroke from the input device. If\r | |
150 | there is no pending keystroke the function returns\r | |
151 | EFI_NOT_READY. If there is a pending keystroke, then\r | |
152 | KeyData.Key.ScanCode is the EFI scan code defined in Error!\r | |
630b4187 | 153 | Reference source not found. The KeyData.Key.UnicodeChar is the\r |
f754f721 | 154 | actual printable character or is zero if the key does not\r |
d1f95000 | 155 | represent a printable character (control key, function key,\r |
156 | etc.). The KeyData.KeyState is shift state for the character\r | |
157 | reflected in KeyData.Key.UnicodeChar or KeyData.Key.ScanCode .\r | |
f754f721 | 158 | When interpreting the data from this function, it should be\r |
159 | noted that if a class of printable characters that are\r | |
d1f95000 | 160 | normally adjusted by shift modifiers (e.g. Shift Key + "f"\r |
f754f721 | 161 | key) would be presented solely as a KeyData.Key.UnicodeChar\r |
162 | without the associated shift state. So in the previous example\r | |
163 | of a Shift Key + "f" key being pressed, the only pertinent\r | |
d1f95000 | 164 | data returned would be KeyData.Key.UnicodeChar with the value\r |
f754f721 | 165 | of "F". This of course would not typically be the case for\r |
166 | non-printable characters such as the pressing of the Right\r | |
167 | Shift Key + F10 key since the corresponding returned data\r | |
d1f95000 | 168 | would be reflected both in the KeyData.KeyState.KeyShiftState\r |
169 | and KeyData.Key.ScanCode values. UEFI drivers which implement\r | |
170 | the EFI_SIMPLE_TEXT_INPUT_EX protocol are required to return\r | |
171 | KeyData.Key and KeyData.KeyState values. These drivers must\r | |
172 | always return the most current state of\r | |
173 | KeyData.KeyState.KeyShiftState and\r | |
f754f721 | 174 | KeyData.KeyState.KeyToggleState. It should also be noted that\r |
175 | certain input devices may not be able to produce shift or toggle\r | |
d1f95000 | 176 | state information, and in those cases the high order bit in the\r |
177 | respective Toggle and Shift state fields should not be active.\r | |
178 | \r | |
179 | \r | |
4ca9b6c4 | 180 | @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r |
d1f95000 | 181 | \r |
182 | @param KeyData A pointer to a buffer that is filled in with\r | |
183 | the keystroke state data for the key that was\r | |
184 | pressed.\r | |
185 | \r | |
186 | \r | |
187 | @retval EFI_SUCCESS The keystroke information was\r | |
188 | returned.\r | |
189 | \r | |
190 | @retval EFI_NOT_READY There was no keystroke data available.\r | |
191 | EFI_DEVICE_ERROR The keystroke\r | |
192 | information was not returned due to\r | |
193 | hardware errors.\r | |
194 | \r | |
195 | \r | |
196 | **/\r | |
197 | typedef\r | |
198 | EFI_STATUS\r | |
8b13229b | 199 | (EFIAPI *EFI_INPUT_READ_KEY_EX)(\r |
85f74a01 | 200 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r |
201 | OUT EFI_KEY_DATA *KeyData\r | |
d1f95000 | 202 | );\r |
203 | \r | |
204 | /**\r | |
205 | The SetState() function allows the input device hardware to\r | |
206 | have state settings adjusted.\r | |
207 | \r | |
4ca9b6c4 | 208 | @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r |
d1f95000 | 209 | \r |
210 | @param KeyToggleState Pointer to the EFI_KEY_TOGGLE_STATE to\r | |
211 | set the state for the input device.\r | |
212 | \r | |
213 | \r | |
4ca9b6c4 | 214 | @retval EFI_SUCCESS The device state was set appropriately.\r |
d1f95000 | 215 | \r |
216 | @retval EFI_DEVICE_ERROR The device is not functioning\r | |
217 | correctly and could not have the\r | |
218 | setting adjusted.\r | |
219 | \r | |
220 | @retval EFI_UNSUPPORTED The device does not support the\r | |
221 | ability to have its state set.\r | |
222 | \r | |
223 | **/\r | |
224 | typedef\r | |
225 | EFI_STATUS\r | |
8b13229b | 226 | (EFIAPI *EFI_SET_STATE)(\r |
85f74a01 | 227 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r |
228 | IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r | |
d1f95000 | 229 | );\r |
230 | \r | |
992f22b9 LG |
231 | ///\r |
232 | /// The function will be called when the key sequence is typed specified by KeyData.\r | |
233 | ///\r | |
d1f95000 | 234 | typedef\r |
235 | EFI_STATUS\r | |
8b13229b | 236 | (EFIAPI *EFI_KEY_NOTIFY_FUNCTION)(\r |
85f74a01 | 237 | IN EFI_KEY_DATA *KeyData\r |
d1f95000 | 238 | );\r |
239 | \r | |
240 | /**\r | |
241 | The RegisterKeystrokeNotify() function registers a function\r | |
f754f721 | 242 | which will be called when a specified keystroke will occur.\r |
d1f95000 | 243 | \r |
4ca9b6c4 | 244 | @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r |
d1f95000 | 245 | \r |
4ca9b6c4 LG |
246 | @param KeyData A pointer to a buffer that is filled in with\r |
247 | the keystroke information for the key that was\r | |
248 | pressed.\r | |
d1f95000 | 249 | \r |
250 | @param KeyNotificationFunction Points to the function to be\r | |
251 | called when the key sequence\r | |
252 | is typed specified by KeyData.\r | |
253 | \r | |
254 | \r | |
4ca9b6c4 LG |
255 | @param NotifyHandle Points to the unique handle assigned to\r |
256 | the registered notification.\r | |
d1f95000 | 257 | \r |
258 | @retval EFI_SUCCESS The device state was set\r | |
259 | appropriately.\r | |
260 | \r | |
261 | @retval EFI_OUT_OF_RESOURCES Unable to allocate necessary\r | |
262 | data structures.\r | |
263 | \r | |
264 | **/\r | |
265 | typedef\r | |
266 | EFI_STATUS\r | |
8b13229b | 267 | (EFIAPI *EFI_REGISTER_KEYSTROKE_NOTIFY)(\r |
85f74a01 | 268 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r |
269 | IN EFI_KEY_DATA *KeyData,\r | |
270 | IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r | |
271 | OUT EFI_HANDLE *NotifyHandle\r | |
d1f95000 | 272 | );\r |
273 | \r | |
274 | /**\r | |
f754f721 | 275 | The UnregisterKeystrokeNotify() function removes the\r |
276 | notification which was previously registered.\r | |
d1f95000 | 277 | \r |
4ca9b6c4 | 278 | @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r |
d1f95000 | 279 | \r |
280 | @param NotificationHandle The handle of the notification\r | |
281 | function being unregistered.\r | |
282 | \r | |
283 | @retval EFI_SUCCESS The device state was set appropriately.\r | |
284 | \r | |
285 | @retval EFI_INVALID_PARAMETER The NotificationHandle is\r | |
286 | invalid.\r | |
287 | \r | |
288 | **/\r | |
289 | typedef\r | |
290 | EFI_STATUS\r | |
8b13229b | 291 | (EFIAPI *EFI_UNREGISTER_KEYSTROKE_NOTIFY)(\r |
85f74a01 | 292 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r |
293 | IN EFI_HANDLE NotificationHandle\r | |
d1f95000 | 294 | );\r |
295 | \r | |
296 | \r | |
44717a39 | 297 | ///\r |
298 | /// The EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is used on the ConsoleIn\r | |
299 | /// device. It is an extension to the Simple Text Input protocol\r | |
300 | /// which allows a variety of extended shift state information to be\r | |
301 | /// returned.\r | |
302 | ///\r | |
d1f95000 | 303 | struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL{\r |
304 | EFI_INPUT_RESET_EX Reset;\r | |
305 | EFI_INPUT_READ_KEY_EX ReadKeyStrokeEx;\r | |
1f08a159 | 306 | ///\r |
307 | /// Event to use with WaitForEvent() to wait for a key to be available.\r | |
308 | ///\r | |
d1f95000 | 309 | EFI_EVENT WaitForKeyEx;\r |
310 | EFI_SET_STATE SetState;\r | |
311 | EFI_REGISTER_KEYSTROKE_NOTIFY RegisterKeyNotify;\r | |
312 | EFI_UNREGISTER_KEYSTROKE_NOTIFY UnregisterKeyNotify;\r | |
313 | };\r | |
314 | \r | |
315 | \r | |
316 | extern EFI_GUID gEfiSimpleTextInputExProtocolGuid;\r | |
317 | \r | |
318 | #endif\r | |
319 | \r |