/** @file\r
- The file defines the protocol to obtain input from the\r
- ConsoleIn device. The EFI specification requires that the\r
- EFI_SIMPLE_TEXT_INPUT_PROTOCOL supports the same languages as\r
- the corresponding\r
+ Simple Text Input Ex protocol from the UEFI 2.0 specification.\r
+ \r
+ This protocol defines an extension to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
+ which exposes much more state and modifier information from the input device,\r
+ also allows one to register a notification for a particular keystroke.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation\r
+ Copyright (c) 2006 - 2009, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
are licensed and made available under the terms and conditions of the BSD License \r
which accompanies this distribution. The full text of the license may be found at \r
this specification and is left up to the platform firmware or\r
driver to implement.\r
\r
- @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL_EX\r
- instance. Type EFI_SIMPLE_TEXT_INPUT_PROTOCOL_EX\r
- is defined in this section.\r
+ @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
@param ExtendedVerification Indicates that the driver may\r
perform a more exhaustive\r
device during reset.\r
\r
\r
- @retval EFI_SUCCESS The device was reset.\r
+ @retval EFI_SUCCESS The device was reset.\r
\r
@retval EFI_DEVICE_ERROR The device is not functioning\r
correctly and could not be reset.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_INPUT_RESET_EX) (\r
+(EFIAPI *EFI_INPUT_RESET_EX)(\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
);\r
\r
\r
-//\r
-// EFI_KEY_TOGGLE_STATE\r
-//\r
+///\r
+/// EFI_KEY_TOGGLE_STATE. The toggle states are defined.\r
+/// They are: EFI_TOGGLE_STATE_VALID, EFI_SCROLL_LOCK_ACTIVE\r
+/// EFI_NUM_LOCK_ACTIVE, EFI_CAPS_LOCK_ACTIVE\r
+///\r
typedef UINT8 EFI_KEY_TOGGLE_STATE;\r
\r
-/**\r
- Definition of EFI_KEY_STATE\r
-\r
- @param KeyShiftState Reflects the currently pressed shift\r
- modifiers for the input device. The\r
- returned value is valid only if the high\r
- order bit has been set.\r
-\r
- @param KeyToggleState Reflects the current internal state of\r
- various toggled attributes. The returned\r
- value is valid only if the high order\r
- bit has been set.\r
-\r
-**/\r
typedef struct _EFI_KEY_STATE {\r
+ ///\r
+ /// Reflects the currently pressed shift\r
+ /// modifiers for the input device. The\r
+ /// returned value is valid only if the high\r
+ /// order bit has been set.\r
+ ///\r
UINT32 KeyShiftState;\r
+ ///\r
+ /// Reflects the current internal state of\r
+ /// various toggled attributes. The returned\r
+ /// value is valid only if the high order\r
+ /// bit has been set.\r
+ ///\r
EFI_KEY_TOGGLE_STATE KeyToggleState;\r
} EFI_KEY_STATE;\r
\r
-/**\r
- Definition of EFI_KEY_DATA.\r
-\r
- @param Key The EFI scan code and Unicode value returned from\r
- the input device.\r
-\r
- @param KeyState The current state of various toggled\r
- attributes as well as input modifier values.\r
-\r
-**/\r
typedef struct {\r
+ ///\r
+ /// The EFI scan code and Unicode value returned from the input device.\r
+ ///\r
EFI_INPUT_KEY Key;\r
+ ///\r
+ /// The current state of various toggled attributes as well as input modifier values.\r
+ ///\r
EFI_KEY_STATE KeyState;\r
} EFI_KEY_DATA;\r
\r
there is no pending keystroke the function returns\r
EFI_NOT_READY. If there is a pending keystroke, then\r
KeyData.Key.ScanCode is the EFI scan code defined in Error!\r
- Reference source not found.. The KeyData.Key.UnicodeChar is the\r
+ Reference source not found. The KeyData.Key.UnicodeChar is the\r
actual printable character or is zero if the key does not\r
represent a printable character (control key, function key,\r
etc.). The KeyData.KeyState is shift state for the character\r
respective Toggle and Shift state fields should not be active.\r
\r
\r
- @param This A pointer to the\r
- EFI_SIMPLE_TEXT_INPUT_PROTOCOL_EX instance.\r
+ @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
@param KeyData A pointer to a buffer that is filled in with\r
the keystroke state data for the key that was\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_INPUT_READ_KEY_EX) (\r
+(EFIAPI *EFI_INPUT_READ_KEY_EX)(\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
OUT EFI_KEY_DATA *KeyData\r
);\r
The SetState() function allows the input device hardware to\r
have state settings adjusted.\r
\r
- @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL_EX\r
- instance. Type EFI_SIMPLE_TEXT_INPUT_PROTOCOL_EX\r
- is defined in this section.\r
+ @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
@param KeyToggleState Pointer to the EFI_KEY_TOGGLE_STATE to\r
set the state for the input device.\r
\r
\r
- @retval EFI_SUCCESS The device state was set appropriately.\r
+ @retval EFI_SUCCESS The device state was set appropriately.\r
\r
@retval EFI_DEVICE_ERROR The device is not functioning\r
correctly and could not have the\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SET_STATE) (\r
+(EFIAPI *EFI_SET_STATE)(\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
);\r
\r
-//\r
-// EFI_KEY_NOTIFY\r
-//\r
+///\r
+/// The function will be called when the key sequence is typed specified by KeyData.\r
+///\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_KEY_NOTIFY_FUNCTION) (\r
+(EFIAPI *EFI_KEY_NOTIFY_FUNCTION)(\r
IN EFI_KEY_DATA *KeyData\r
);\r
\r
The RegisterKeystrokeNotify() function registers a function\r
which will be called when a specified keystroke will occur.\r
\r
- @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL_EX\r
- instance. Type EFI_SIMPLE_TEXT_INPUT_PROTOCOL_EX\r
- is defined in this section.\r
+ @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
- @param KeyData A pointer to a buffer that is filled in with\r
- the keystroke information for the key that was\r
- pressed.\r
+ @param KeyData A pointer to a buffer that is filled in with\r
+ the keystroke information for the key that was\r
+ pressed.\r
\r
@param KeyNotificationFunction Points to the function to be\r
called when the key sequence\r
is typed specified by KeyData.\r
\r
\r
- @param NotifyHandle Points to the unique handle assigned to\r
- the registered notification.\r
+ @param NotifyHandle Points to the unique handle assigned to\r
+ the registered notification.\r
\r
@retval EFI_SUCCESS The device state was set\r
appropriately.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_REGISTER_KEYSTROKE_NOTIFY) (\r
+(EFIAPI *EFI_REGISTER_KEYSTROKE_NOTIFY)(\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_KEY_DATA *KeyData,\r
IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
The UnregisterKeystrokeNotify() function removes the\r
notification which was previously registered.\r
\r
- @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL_EX\r
- instance.\r
+ @param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
@param NotificationHandle The handle of the notification\r
function being unregistered.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_UNREGISTER_KEYSTROKE_NOTIFY) (\r
+(EFIAPI *EFI_UNREGISTER_KEYSTROKE_NOTIFY)(\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_HANDLE NotificationHandle\r
);\r
\r
\r
-/**\r
- The EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is used on the ConsoleIn\r
- device. It is an extension to the Simple Text Input protocol\r
- which allows a variety of extended shift state information to be\r
- returned.\r
-\r
- @param Reset Reset the ConsoleIn device. See Reset().\r
-\r
- @param ReadKeyStrokeEx Returns the next input character. See\r
- ReadKeyStrokeEx().\r
-\r
- @param WaitForKeyEx Event to use with WaitForEvent() to wait\r
- for a key to be available.\r
-\r
- @param SetState Set the EFI_KEY_TOGGLE_STATE state settings\r
- for the input device.\r
-\r
- @param RegisterKeyNotify Register a notification function to\r
- be called when a given key sequence\r
- is hit.\r
-\r
- @param UnregisterKeyNotifyRemoves A specific notification\r
- function.\r
-\r
-**/\r
+///\r
+/// The EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is used on the ConsoleIn\r
+/// device. It is an extension to the Simple Text Input protocol\r
+/// which allows a variety of extended shift state information to be\r
+/// returned.\r
+///\r
struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL{\r
EFI_INPUT_RESET_EX Reset;\r
EFI_INPUT_READ_KEY_EX ReadKeyStrokeEx;\r
+ ///\r
+ /// Event to use with WaitForEvent() to wait for a key to be available.\r
+ ///\r
EFI_EVENT WaitForKeyEx;\r
EFI_SET_STATE SetState;\r
EFI_REGISTER_KEYSTROKE_NOTIFY RegisterKeyNotify;\r
projects / mirror_edk2.git / blobdiff