]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SimpleTextIn.h
MdePkg/BaseLib: Move CHAR_NULL definition to Base.h in BaseLib
[mirror_edk2.git] / MdePkg / Include / Protocol / SimpleTextIn.h
index b093592da2747430a6fc7a7f5c67c19b03fa8755..ebe1c7e0cd9f420391ee7176118964754d954041 100644 (file)
@@ -4,14 +4,14 @@
   Abstraction of a very simple input device like a keyboard or serial\r
   terminal.\r
 \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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  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
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
@@ -27,12 +27,12 @@ typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  EFI_SIMPLE_TEXT_INPUT_PROTOCOL;
 \r
 ///\r
 /// Protocol GUID name defined in EFI1.1.\r
-/// \r
+///\r
 #define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID\r
 \r
 ///\r
 /// Protocol name in EFI1.1 for backward-compatible.\r
-/// \r
+///\r
 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  SIMPLE_INPUT_INTERFACE;\r
 \r
 ///\r
@@ -46,7 +46,6 @@ typedef struct {
 //\r
 // Required unicode control chars\r
 //\r
-#define CHAR_NULL             0x0000\r
 #define CHAR_BACKSPACE        0x0008\r
 #define CHAR_TAB              0x0009\r
 #define CHAR_LINEFEED         0x000A\r
@@ -76,8 +75,6 @@ typedef struct {
 #define SCAN_F8         0x0012\r
 #define SCAN_F9         0x0013\r
 #define SCAN_F10        0x0014\r
-#define SCAN_F11        0x0015\r
-#define SCAN_F12        0x0016\r
 #define SCAN_ESC        0x0017\r
 \r
 /**\r
@@ -98,11 +95,12 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Reads the next keystroke from the input device. The WaitForKey Event can \r
+  Reads the next keystroke from the input device. The WaitForKey Event can\r
   be used to test for existence of a keystroke via WaitForEvent () call.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Key  Driver may perform diagnostics on reset.\r
+  @param  This  Protocol instance pointer.\r
+  @param  Key   A pointer to a buffer that is filled in with the keystroke\r
+                information for the key that was pressed.\r
 \r
   @retval EFI_SUCCESS      The keystroke information was returned.\r
   @retval EFI_NOT_READY    There was no keystroke data available.\r
@@ -118,7 +116,7 @@ EFI_STATUS
   );\r
 \r
 ///\r
-/// The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device. \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