MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7

v2: Add some missing changes Ps2KeyboardDxe.

Cc: Star Zeng <star.zeng@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@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>

8 files changed, 54 insertions, 28 deletions

diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
index bc58fe2f8c..04e3365f9e 100644
--- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
+++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
@@ -2,7 +2,7 @@
   Routines implements SIMPLE_TEXT_IN protocol's interfaces based on 8042 interfaces

   provided by Ps2KbdCtrller.c.

 

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

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

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -533,9 +533,12 @@ Exit:
 

     @param This                       Protocol instance pointer.

     @param KeyData                    A pointer to a buffer that is filled in with the keystroke

-                                      information data for the key that was pressed.

+                                      information data for the key that was pressed. If KeyData.Key,

+                                      KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState are 0,

+                                      then any incomplete keystroke will trigger a notification of the KeyNotificationFunction.

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

-                                      sequence is typed specified by KeyData.

+                                      sequence is typed specified by KeyData. This notification function

+                                      should be called at <=TPL_CALLBACK.

     @param NotifyHandle               Points to the unique handle assigned to the registered notification.

 

     @retval EFI_SUCCESS               The notification function was registered successfully.

diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
index e41c1980fc..d772a979bf 100644
--- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
+++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
@@ -1,7 +1,7 @@
 /** @file

   PS/2 keyboard driver header file

 

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

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

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -495,9 +495,12 @@ KeyboardSetState (
 

     @param This                    - Protocol instance pointer.

     @param KeyData                 - A pointer to a buffer that is filled in with the keystroke

-                              information data for the key that was pressed.

+                                     information data for the key that was pressed. If KeyData.Key,

+                                     KeyData.KeyState.KeyToggleState and KeyData.KeyState.KeyShiftState are 0,

+                                     then any incomplete keystroke will trigger a notification of the KeyNotificationFunction.

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

-                              sequence is typed specified by KeyData.

+                                     sequence is typed specified by KeyData. This notification function

+                                     should be called at <=TPL_CALLBACK.

     @param NotifyHandle            - Points to the unique handle assigned to the registered notification.

 

     @retval EFI_SUCCESS             - The notification function was registered successfully.

diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
index cdd1684277..fb2bf3fd81 100644
--- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
+++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
@@ -2,7 +2,7 @@
   USB Keyboard Driver that manages USB keyboard and produces Simple Text Input

   Protocol and Simple Text Input Ex Protocol.

 

-Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -1055,10 +1055,14 @@ USBKeyboardSetState (
   Register a notification function for a particular keystroke for the input device.

 

   @param  This                        Protocol instance pointer.

-  @param  KeyData                     A pointer to a buffer that is filled in with the keystroke

-                                      information data for the key that was pressed.

+  @param  KeyData                     A pointer to a buffer that is filled in with

+                                      the keystroke information for the key that was

+                                      pressed. If KeyData.Key, KeyData.KeyState.KeyToggleState

+                                      and KeyData.KeyState.KeyShiftState are 0, then any incomplete

+                                      keystroke will trigger a notification of the KeyNotificationFunction.

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

-                                      sequence is typed specified by KeyData.

+                                      sequence is typed specified by KeyData. This notification function

+                                      should be called at <=TPL_CALLBACK.

   @param  NotifyHandle                Points to the unique handle assigned to the registered notification.

 

   @retval EFI_SUCCESS                 The notification function was registered successfully.

diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h
index 089f113d5f..60496789a2 100644
--- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h
+++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h
@@ -1,7 +1,7 @@
 /** @file

   Header file for USB Keyboard Driver's Data Structures.

 

-Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -502,10 +502,14 @@ USBKeyboardSetState (
   Register a notification function for a particular keystroke for the input device.

 

   @param  This                        Protocol instance pointer.

-  @param  KeyData                     A pointer to a buffer that is filled in with the keystroke

-                                      information data for the key that was pressed.

+  @param  KeyData                     A pointer to a buffer that is filled in with

+                                      the keystroke information for the key that was

+                                      pressed. If KeyData.Key, KeyData.KeyState.KeyToggleState

+                                      and KeyData.KeyState.KeyShiftState are 0, then any incomplete

+                                      keystroke will trigger a notification of the KeyNotificationFunction.

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

-                                      sequence is typed specified by KeyData.

+                                      sequence is typed specified by KeyData. This notification function

+                                      should be called at <=TPL_CALLBACK.

   @param  NotifyHandle                Points to the unique handle assigned to the registered notification.

 

   @retval EFI_SUCCESS                 The notification function was registered successfully.

diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
index b230f5e261..e70ff6114a 100644
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
@@ -3842,11 +3842,14 @@ ConSplitterTextInSetState (
   Register a notification function for a particular keystroke for the input device.

 

   @param  This                     Protocol instance pointer.

-  @param  KeyData                  A pointer to a buffer that is filled in with the

-                                   keystroke information data for the key that was

-                                   pressed.

+  @param  KeyData                  A pointer to a buffer that is filled in with

+                                   the keystroke information for the key that was

+                                   pressed. If KeyData.Key, KeyData.KeyState.KeyToggleState

+                                   and KeyData.KeyState.KeyShiftState are 0, then any incomplete

+                                   keystroke will trigger a notification of the KeyNotificationFunction.

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

-                                   sequence is typed specified by KeyData.

+                                   sequence is typed specified by KeyData. This notification function

+                                   should be called at <=TPL_CALLBACK.

   @param  NotifyHandle             Points to the unique handle assigned to the

                                    registered notification.

 

diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
index eeea06186f..9469860bf0 100644
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
@@ -1396,11 +1396,14 @@ ConSplitterTextInSetState (
   Register a notification function for a particular keystroke for the input device.

 

   @param  This                     Protocol instance pointer.

-  @param  KeyData                  A pointer to a buffer that is filled in with the

-                                   keystroke information data for the key that was

-                                   pressed.

+  @param  KeyData                  A pointer to a buffer that is filled in with

+                                   the keystroke information for the key that was

+                                   pressed. If KeyData.Key, KeyData.KeyState.KeyToggleState

+                                   and KeyData.KeyState.KeyShiftState are 0, then any incomplete

+                                   keystroke will trigger a notification of the KeyNotificationFunction.

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

-                                   sequence is typed specified by KeyData.

+                                   sequence is typed specified by KeyData. This notification function

+                                   should be called at <=TPL_CALLBACK.

   @param  NotifyHandle             Points to the unique handle assigned to the

                                    registered notification.

 

diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
index c15d17cd0b..7dded00cad 100644
--- a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
@@ -343,9 +343,12 @@ TerminalConInSetState (
   @param  This                     Protocol instance pointer.

   @param  KeyData                  A pointer to a buffer that is filled in with the

                                    keystroke information data for the key that was

-                                   pressed.

+                                   pressed. If KeyData.Key, KeyData.KeyState.KeyToggleState

+                                   and KeyData.KeyState.KeyShiftState are 0, then any incomplete

+                                   keystroke will trigger a notification of the KeyNotificationFunction.

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

-                                   sequence is typed specified by KeyData.

+                                   sequence is typed specified by KeyData. This notification function

+                                   should be called at <=TPL_CALLBACK.

   @param  NotifyHandle             Points to the unique handle assigned to the

                                    registered notification.

 

diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
index 1392f16670..3c1102dac4 100644
--- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
@@ -310,11 +310,14 @@ TerminalConInSetState (
   Register a notification function for a particular keystroke for the input device.

 

   @param  This                     Protocol instance pointer.

-  @param  KeyData                  A pointer to a buffer that is filled in with the

-                                   keystroke information data for the key that was

-                                   pressed.

+  @param  KeyData                  A pointer to a buffer that is filled in with

+                                   the keystroke information for the key that was

+                                   pressed. If KeyData.Key, KeyData.KeyState.KeyToggleState

+                                   and KeyData.KeyState.KeyShiftState are 0, then any incomplete

+                                   keystroke will trigger a notification of the KeyNotificationFunction.

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

-                                   sequence is typed specified by KeyData.

+                                   sequence is typed specified by KeyData. This notification function

+                                   should be called at <=TPL_CALLBACK.

   @param  NotifyHandle             Points to the unique handle assigned to the

                                    registered notification.