IntelFrameworkModulePkg: Update comments in SimpleTextInEx

Update comments in SimpleTextInEx according to UEFI 2.7.

Cc: Star Zeng <star.zeng@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Jeff Fan <jeff.fan@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>

diff --git a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
index 5825a04c3e0255d911059adc9ced6b0cf972f6a0..76779553cd38a0a762bf4c530fb27c392899089c 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
+++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
@@ -2,7 +2,7 @@
   Routines implements SIMPLE_TEXT_IN protocol's interfaces based on 8042 interfaces\r
   provided by Ps2KbdCtrller.c.\r
 \r
   Routines implements SIMPLE_TEXT_IN protocol's interfaces based on 8042 interfaces\r
   provided by Ps2KbdCtrller.c.\r
 \r

-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, 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
 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


@@ -533,9 +533,13 @@ Exit:
 \r
     @param This                       Protocol instance pointer.\r
     @param KeyData                    A pointer to a buffer that is filled in with the keystroke\r
 \r
     @param This                       Protocol instance pointer.\r
     @param KeyData                    A pointer to a buffer that is filled in with the keystroke\r

-                                      information data for the key that was pressed.\r
+                                      information data for the key that was pressed. If KeyData.Key,\r
+                                      KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState\r
+                                      are 0, then any incomplete keystroke will trigger a notification of\r
+                                      the KeyNotificationFunction.\r

     @param KeyNotificationFunction    Points to the function to be called when the key\r
     @param KeyNotificationFunction    Points to the function to be called when the key\r

-                                      sequence is typed specified by KeyData.\r
+                                      sequence is typed specified by KeyData. This notification function\r
+                                      should be called at <=TPL_CALLBACK.\r

     @param NotifyHandle               Points to the unique handle assigned to the registered notification.\r
 \r
     @retval EFI_SUCCESS               The notification function was registered successfully.\r
     @param NotifyHandle               Points to the unique handle assigned to the registered notification.\r
 \r
     @retval EFI_SUCCESS               The notification function was registered successfully.\r

diff --git a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
index 82aa5a64faeafe05569deba8cc8703e4de5badce..76fb49886872eb0b1b0b16f08c6bcaa0de2f2919 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
+++ b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
@@ -1,7 +1,7 @@
 /** @file\r
   PS/2 keyboard driver header file\r
 \r
 /** @file\r
   PS/2 keyboard driver header file\r
 \r

-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, 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
 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


@@ -494,9 +494,13 @@ KeyboardSetState (
 \r
     @param This                    - Protocol instance pointer.\r
     @param KeyData                 - A pointer to a buffer that is filled in with the keystroke\r
 \r
     @param This                    - Protocol instance pointer.\r
     @param KeyData                 - A pointer to a buffer that is filled in with the keystroke\r

-                              information data for the key that was pressed.\r
+                                     information data for the key that was pressed. If KeyData.Key,\r
+                                     KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState\r
+                                     are 0, then any incomplete keystroke will trigger a notification of\r
+                                     the KeyNotificationFunction.\r

     @param KeyNotificationFunction - Points to the function to be called when the key\r
     @param KeyNotificationFunction - Points to the function to be called when the key\r

-                              sequence is typed specified by KeyData.\r
+                                     sequence is typed specified by KeyData. This notification function\r
+                                     should be called at <=TPL_CALLBACK.\r

     @param NotifyHandle            - Points to the unique handle assigned to the registered notification.\r
 \r
     @retval EFI_SUCCESS             - The notification function was registered successfully.\r
     @param NotifyHandle            - Points to the unique handle assigned to the registered notification.\r
 \r
     @retval EFI_SUCCESS             - The notification function was registered successfully.\r

diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
index 742d00982f5cc3fe1f435282c7ca8bc15d3722f5..7308523ad8bd079ff45ad9560926d97001bd0816 100644 (file)
--- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
+++ b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c
@@ -2313,17 +2313,20 @@ Exit:
 \r
   @param  This                    Protocol instance pointer.\r
   @param  KeyData                 A pointer to a buffer that is filled in with the keystroke \r
 \r
   @param  This                    Protocol instance pointer.\r
   @param  KeyData                 A pointer to a buffer that is filled in with the keystroke \r

-                                  information data for the key that was pressed.\r
+                                  information data for the key that was pressed. If KeyData.Key,\r
+                                  KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState\r
+                                  are 0, then any incomplete keystroke will trigger a notification of\r
+                                  the KeyNotificationFunction.\r

   @param  KeyNotificationFunction Points to the function to be called when the key \r
   @param  KeyNotificationFunction Points to the function to be called when the key \r

-                                  sequence is typed specified by KeyData.                        \r
-  @param  NotifyHandle            Points to the unique handle assigned to the registered notification.                          \r
+                                  sequence is typed specified by KeyData. This notification function\r
+                                  should be called at <=TPL_CALLBACK.\r
+  @param  NotifyHandle            Points to the unique handle assigned to the registered notification.\r

 \r
 \r

-  \r

   @retval EFI_SUCCESS             The notification function was registered successfully.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necesssary data structures.\r
   @retval EFI_INVALID_PARAMETER   KeyData or NotifyHandle is NULL.\r
   @retval EFI_SUCCESS             The notification function was registered successfully.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necesssary data structures.\r
   @retval EFI_INVALID_PARAMETER   KeyData or NotifyHandle is NULL.\r

-                                                  \r
-**/   \r
+\r
+**/\r

 EFI_STATUS\r
 EFIAPI\r
 BiosKeyboardRegisterKeyNotify (\r
 EFI_STATUS\r
 EFIAPI\r
 BiosKeyboardRegisterKeyNotify (\r

diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h
index f38411aaa645c18d0610dce5489081d63dfc9dd7..0bf28ea140211517ce35362ae230c1522ff62c72 100644 (file)
--- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h
+++ b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h
@@ -1,6 +1,6 @@
 /** @file\r
 \r
 /** @file\r
 \r

-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r

 \r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions\r
 \r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions\r


@@ -635,17 +635,21 @@ BiosKeyboardSetState (
 \r
   @param  This                    Protocol instance pointer.\r
   @param  KeyData                 A pointer to a buffer that is filled in with the keystroke \r
 \r
   @param  This                    Protocol instance pointer.\r
   @param  KeyData                 A pointer to a buffer that is filled in with the keystroke \r

-                                  information data for the key that was pressed.\r
+                                  information data for the key that was pressed. If KeyData.Key,\r
+                                  KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState\r
+                                  are 0, then any incomplete keystroke will trigger a notification of\r
+                                  the KeyNotificationFunction.\r

   @param  KeyNotificationFunction Points to the function to be called when the key \r
   @param  KeyNotificationFunction Points to the function to be called when the key \r

-                                  sequence is typed specified by KeyData.                        \r
-  @param  NotifyHandle            Points to the unique handle assigned to the registered notification.                          \r
+                                  sequence is typed specified by KeyData. This notification function\r
+                                  should be called at <=TPL_CALLBACK.\r
+  @param  NotifyHandle            Points to the unique handle assigned to the registered notification.\r

 \r
   \r
   @retval EFI_SUCCESS             The notification function was registered successfully.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necesssary data structures.\r
   @retval EFI_INVALID_PARAMETER   KeyData or NotifyHandle is NULL.\r
 \r
   \r
   @retval EFI_SUCCESS             The notification function was registered successfully.\r
   @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necesssary data structures.\r
   @retval EFI_INVALID_PARAMETER   KeyData or NotifyHandle is NULL.\r

-                                                  \r
-**/   \r
+\r
+**/\r

 EFI_STATUS\r
 EFIAPI\r
 BiosKeyboardRegisterKeyNotify (\r
 EFI_STATUS\r
 EFIAPI\r
 BiosKeyboardRegisterKeyNotify (\r