);\r
\r
\r
-//\r
-// EFI_KEY_TOGGLE_STATE\r
-//\r
+///\r
+/// EFI_KEY_TOGGLE_STATE. The toggle state 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
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