Abstraction of a very simple input device like a keyboard or serial\r
terminal.\r
\r
- Copyright (c) 2006, Intel Corporation \r
+ Copyright (c) 2006 - 2008, 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
0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
}\r
\r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID defined in EFI1.1.\r
+/// \r
#define SIMPLE_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID\r
\r
typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL;\r
\r
-//\r
-// Backward-compatible with EFI1.1.\r
-// \r
+///\r
+/// Backward-compatible with EFI1.1.\r
+/// \r
typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL SIMPLE_INPUT_INTERFACE;\r
//\r
// Data structures\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_INPUT_RESET) (\r
+(EFIAPI *EFI_INPUT_RESET)(\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
- )\r
-;\r
+ );\r
\r
/**\r
Reads the next keystroke from the input device. The WaitForKey Event can \r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_INPUT_READ_KEY) (\r
+(EFIAPI *EFI_INPUT_READ_KEY)(\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
OUT EFI_INPUT_KEY *Key\r
- )\r
-;\r
+ );\r
\r
+/** \r
+ @par Protocol Description:\r
+ The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device. \r
+ It is the minimum required protocol for ConsoleIn.\r
+**/\r
struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {\r
EFI_INPUT_RESET Reset;\r
EFI_INPUT_READ_KEY ReadKeyStroke;\r
+ ///\r
+ /// Event to use with WaitForEvent() to wait for a key to be available\r
+ ///\r
EFI_EVENT WaitForKey;\r
};\r
\r