]> git.proxmox.com Git - mirror_edk2.git/commitdiff
1. Add Partial Keystroke Support definition in SimpleTextInputEx.h See the Uefi2...
authorqianouyang <qianouyang@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 30 Sep 2011 07:26:07 +0000 (07:26 +0000)
committerqianouyang <qianouyang@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 30 Sep 2011 07:26:07 +0000 (07:26 +0000)
Signed-off-by: qianouyang
Reviewed-by: niruiyu vanjeff
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12493 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Protocol/SimpleTextInEx.h

index dc176a11411afe4f2d84427c0c3da7650624e243..6920eead83d65cb7664307f15df560f5bee00603 100644 (file)
@@ -1,18 +1,18 @@
 /** @file\r
   Simple Text Input Ex protocol from the UEFI 2.0 specification.\r
-  \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 - 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
+  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
@@ -47,7 +47,7 @@ typedef struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL EFI_SIMPLE_TEXT_INPUT_EX_PROTO
 \r
 \r
   @retval EFI_SUCCESS       The device was reset.\r
-  \r
+\r
   @retval EFI_DEVICE_ERROR  The device is not functioning\r
                             correctly and could not be reset.\r
 \r
@@ -113,16 +113,17 @@ typedef struct {
 #define EFI_MENU_KEY_PRESSED      0x00000100\r
 #define EFI_SYS_REQ_PRESSED       0x00000200\r
 \r
-//                            \r
-// Toggle state               \r
-//                            \r
+//\r
+// Toggle state\r
+//\r
 #define EFI_TOGGLE_STATE_VALID    0x80\r
+#define EFI_KEY_STATE_EXPOSED     0x40\r
 #define EFI_SCROLL_LOCK_ACTIVE    0x01\r
 #define EFI_NUM_LOCK_ACTIVE       0x02\r
 #define EFI_CAPS_LOCK_ACTIVE      0x04\r
-                              \r
-//                            \r
-// EFI Scan codes             \r
+\r
+//\r
+// EFI Scan codes\r
 //\r
 #define SCAN_F11                  0x0015\r
 #define SCAN_F12                  0x0016\r
@@ -181,17 +182,17 @@ typedef struct {
   state information, and in those cases the high order bit in the\r
   respective Toggle and Shift state fields should not be active.\r
 \r
-  \r
+\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
                   pressed.\r
 \r
-  \r
+\r
   @retval EFI_SUCCESS     The keystroke information was\r
                           returned.\r
-  \r
+\r
   @retval EFI_NOT_READY   There was no keystroke data available.\r
                           EFI_DEVICE_ERROR The keystroke\r
                           information was not returned due to\r
@@ -209,13 +210,13 @@ EFI_STATUS
 /**\r
   The SetState() function allows the input device hardware to\r
   have state settings adjusted.\r
-  \r
+\r
   @param This           A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
-  \r
+\r
   @param KeyToggleState Pointer to the EFI_KEY_TOGGLE_STATE to\r
                         set the state for the input device.\r
-  \r
-  \r
+\r
+\r
   @retval EFI_SUCCESS       The device state was set appropriately.\r
 \r
   @retval EFI_DEVICE_ERROR  The device is not functioning\r
@@ -245,21 +246,21 @@ EFI_STATUS
 /**\r
   The RegisterKeystrokeNotify() function registers a function\r
   which will be called when a specified keystroke will occur.\r
-  \r
+\r
   @param This                     A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
-  \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
-  \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
+\r
+\r
   @param NotifyHandle             Points to the unique handle assigned to\r
                                   the registered notification.\r
-  \r
+\r
   @retval EFI_SUCCESS           The device state was set\r
                                 appropriately.\r
 \r
@@ -279,14 +280,14 @@ EFI_STATUS
 /**\r
   The UnregisterKeystrokeNotify() function removes the\r
   notification which was previously registered.\r
-  \r
+\r
   @param This               A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
-  \r
+\r
   @param NotificationHandle The handle of the notification\r
                             function being unregistered.\r
-  \r
+\r
   @retval EFI_SUCCESS The device state was set appropriately.\r
-  \r
+\r
   @retval EFI_INVALID_PARAMETER The NotificationHandle is\r
                                 invalid.\r
 \r