[edk2-devel] [PATCH 0/4] Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[edk2-devel] [PATCH 0/4] Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[Qingyu]

Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
EFI_UNSUPPORTED to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().

This patch series update ReadKeyStroke and ReadKeyStrokeEx implementation
in Edk2.

Qingyu (4):
  MdeModulePkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx
  ShellPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx
  EmbeddedPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx
  EmulatorPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx

 .../Drivers/VirtualKeyboardDxe/VirtualKeyboard.c       | 10 ++++++----
 .../Drivers/VirtualKeyboardDxe/VirtualKeyboard.h       | 10 ++++++----
 EmulatorPkg/EmuGopDxe/GopInput.c                       |  2 ++
 MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c     |  4 +++-
 MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h      |  3 +++
 MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c                 |  2 ++
 MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h                 |  2 ++
 .../Universal/Console/ConSplitterDxe/ConSplitter.c     |  6 ++++++
 .../Universal/Console/ConSplitterDxe/ConSplitter.h     |  6 ++++++
 MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h  |  4 ++++
 .../Universal/Console/TerminalDxe/TerminalConIn.c      |  4 ++++
 ShellPkg/Application/Shell/ConsoleWrappers.c           |  4 +++-
 12 files changed, 47 insertions(+), 10 deletions(-)

Cc: Ming Tan <ming.tan@intel.com>
Cc: Yi Li <yi1.li@intel.com>
Cc: Gahan <gahan.saraiya@intel.com>
Signed-off-by: Qingyu <qingyu.shang@intel.com>

-- 
2.39.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116680): https://edk2.groups.io/g/devel/message/116680
Mute This Topic: https://groups.io/mt/104886870/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

[edk2-devel] [PATCH 1/4] MdeModulePkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[Qingyu]

Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
EFI_UNSUPPORTED to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().

Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Qingyu <qingyu.shang@intel.com>
---
 MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c          | 4 +++-
 MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h           | 3 +++
 MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c                      | 2 ++
 MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h                      | 2 ++
 MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c | 6 ++++++
 MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h | 6 ++++++
 MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h       | 4 ++++
 MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c  | 4 ++++
 8 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
index b1ab17af3788..81d3c6eb70ab 100644
--- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
+++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c
@@ -258,7 +258,8 @@ KeyboardEfiReset (
   @param This    Pointer to instance of EFI_SIMPLE_TEXT_INPUT_PROTOCOL
   @param Key     The output buffer for key value
 
-  @retval EFI_SUCCESS success to read key stroke
+  @retval EFI_SUCCESS      success to read key stroke
+  @retval EFI_UNSUPPORTED  The device does not support the ability to read keystroke data.
 **/
 EFI_STATUS
 EFIAPI
@@ -433,6 +434,7 @@ KeyboardEfiResetEx (
     @retval EFI_DEVICE_ERROR      The keystroke information was not returned due to
                                   hardware errors.
     @retval EFI_INVALID_PARAMETER KeyData is NULL.
+    @retval EFI_UNSUPPORTED       The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
index ca1dd9b2c2c6..7b4db9c778de 100644
--- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
+++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h
@@ -338,6 +338,7 @@ KeyboardEfiReset (
   @param Key     The output buffer for key value
 
   @retval EFI_SUCCESS success to read key stroke
+  @retval EFI_UNSUPPORTED  The device does not support the ability to read keystroke data.
 **/
 EFI_STATUS
 EFIAPI
@@ -441,6 +442,8 @@ KeyboardEfiResetEx (
     @retval EFI_DEVICE_ERROR      - The keystroke information was not returned due to
                             hardware errors.
     @retval EFI_INVALID_PARAMETER - KeyData is NULL.
+    @retval EFI_UNSUPPORTED       - The device does not support the ability to read
+                            keystroke data.
 
 **/
 EFI_STATUS
diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
index e889f422bbf7..bcda0724ee76 100644
--- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
+++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c
@@ -692,6 +692,7 @@ USBKeyboardReset (
   @retval EFI_NOT_READY        There was no keystroke data available.
   @retval EFI_DEVICE_ERROR     The keystroke information was not returned due to
                                hardware errors.
+  @retval EFI_UNSUPPORTED      The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
@@ -975,6 +976,7 @@ USBKeyboardResetEx (
   @retval EFI_DEVICE_ERROR       The keystroke information was not returned due to
                                  hardware errors.
   @retval EFI_INVALID_PARAMETER  KeyData is NULL.
+  @retval EFI_UNSUPPORTED        The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h
index a9dfeafd6f10..b9e9a725ee33 100644
--- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h
+++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h
@@ -412,6 +412,7 @@ USBKeyboardReset (
   @retval EFI_NOT_READY        There was no keystroke data available.
   @retval EFI_DEVICE_ERROR     The keystroke information was not returned due to
                                hardware errors.
+  @retval EFI_UNSUPPORTED      The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
@@ -466,6 +467,7 @@ USBKeyboardResetEx (
   @retval EFI_DEVICE_ERROR       The keystroke information was not returned due to
                                  hardware errors.
   @retval EFI_INVALID_PARAMETER  KeyData is NULL.
+  @retval EFI_UNSUPPORTED        The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
index 8b5e62e3a883..0a776f369b9a 100644
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c
@@ -3551,6 +3551,8 @@ ConSplitterTextInExDequeueKey (
   @retval EFI_NOT_READY            There was no keystroke data availiable.
   @retval EFI_DEVICE_ERROR         The keydtroke information was not returned due
                                    to hardware errors.
+  @retval EFI_UNSUPPORTED          The device does not support the ability to read
+                                   keystroke data.
 
 **/
 EFI_STATUS
@@ -3623,6 +3625,8 @@ ConSplitterTextInPrivateReadKeyStroke (
   @retval EFI_NOT_READY            There was no keystroke data availiable.
   @retval EFI_DEVICE_ERROR         The keydtroke information was not returned due
                                    to hardware errors.
+  @retval EFI_UNSUPPORTED          The device does not support the ability to read
+                                   keystroke data.
 
 **/
 EFI_STATUS
@@ -3805,6 +3809,8 @@ ConSplitterTextInResetEx (
   @retval EFI_DEVICE_ERROR         The keystroke information was not returned due
                                    to hardware errors.
   @retval EFI_INVALID_PARAMETER    KeyData is NULL.
+  @retval EFI_UNSUPPORTED          The device does not support the ability to read
+                                   keystroke data.
 
 **/
 EFI_STATUS
diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
index a1fe74726058..1be3adb3b9be 100644
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h
@@ -1265,6 +1265,8 @@ ConSplitterTextInReset (
   @retval EFI_NOT_READY            There was no keystroke data availiable.
   @retval EFI_DEVICE_ERROR         The keydtroke information was not returned due
                                    to hardware errors.
+  @retval EFI_UNSUPPORTED          The device does not support the ability to read
+                                   keystroke data.
 
 **/
 EFI_STATUS
@@ -1342,6 +1344,8 @@ ConSplitterTextInResetEx (
   @retval EFI_DEVICE_ERROR         The keystroke information was not returned due
                                    to hardware errors.
   @retval EFI_INVALID_PARAMETER    KeyData is NULL.
+  @retval EFI_UNSUPPORTED          The device does not support the ability to read
+                                   keystroke data.
 
 **/
 EFI_STATUS
@@ -1453,6 +1457,8 @@ ConSplitterTextInWaitForKey (
   @retval EFI_NOT_READY            There was no keystroke data availiable.
   @retval EFI_DEVICE_ERROR         The keydtroke information was not returned due
                                    to hardware errors.
+  @retval EFI_UNSUPPORTED          The device does not support the ability to read 
+                                   keystroke data.
 
 **/
 EFI_STATUS
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
index 4238f8420ec1..7581cda18bab 100644
--- a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
@@ -223,6 +223,8 @@ TerminalConInReset (
   @retval EFI_SUCCESS         The keystroke information is returned successfully.
   @retval EFI_NOT_READY       There is no keystroke data available.
   @retval EFI_DEVICE_ERROR    The dependent serial device encounters error.
+  @retval EFI_UNSUPPORTED     The device does not support the ability to read
+                              keystroke data.
 
 **/
 EFI_STATUS
@@ -303,6 +305,8 @@ TerminalConInResetEx (
   @retval EFI_DEVICE_ERROR         The keystroke information was not returned due
                                    to hardware errors.
   @retval EFI_INVALID_PARAMETER    KeyData is NULL.
+  @retval EFI_UNSUPPORTED          The device does not support the ability to read
+                                   keystroke data.
 
 **/
 EFI_STATUS
diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
index 2286264b29e5..aafa65f44c6d 100644
--- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
@@ -109,6 +109,8 @@ TerminalConInReset (
   @retval EFI_SUCCESS         The keystroke information is returned successfully.
   @retval EFI_NOT_READY       There is no keystroke data available.
   @retval EFI_DEVICE_ERROR    The dependent serial device encounters error.
+  @retval EFI_UNSUPPORTED     The device does not support the ability to read
+                              keystroke data.
 
 **/
 EFI_STATUS
@@ -237,6 +239,8 @@ TerminalConInResetEx (
   @retval EFI_DEVICE_ERROR         The keystroke information was not returned due
                                    to hardware errors.
   @retval EFI_INVALID_PARAMETER    KeyData is NULL.
+  @retval EFI_UNSUPPORTED          The device does not support the ability to read
+                                   keystroke data.
 
 **/
 EFI_STATUS
-- 
2.39.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116681): https://edk2.groups.io/g/devel/message/116681
Mute This Topic: https://groups.io/mt/104886871/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

[edk2-devel] [PATCH 2/4] ShellPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[Qingyu]

Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
EFI_UNSUPPORTED to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().

Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhichao Gao <zhichao.gao@intel.com>
Cc: Chao Li <lichao@loongson.cn>
Signed-off-by: Qingyu <qingyu.shang@intel.com>
---
 ShellPkg/Application/Shell/ConsoleWrappers.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/ShellPkg/Application/Shell/ConsoleWrappers.c b/ShellPkg/Application/Shell/ConsoleWrappers.c
index eae11370e4e0..dbffae30cdf5 100644
--- a/ShellPkg/Application/Shell/ConsoleWrappers.c
+++ b/ShellPkg/Application/Shell/ConsoleWrappers.c
@@ -67,7 +67,9 @@ FileBasedSimpleTextInReset (
   @param[in] This      A pointer to the SimpleTextIn structure.
   @param[in, out] Key  A pointer to the Key structure to fill.
 
-  @retval   EFI_SUCCESS The read was successful.
+  @retval EFI_SUCCESS      The read was successful.
+  @retval EFI_UNSUPPORTED  The device does not support the ability to read
+                           keystroke data.
 **/
 EFI_STATUS
 EFIAPI
-- 
2.39.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116682): https://edk2.groups.io/g/devel/message/116682
Mute This Topic: https://groups.io/mt/104886872/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

[edk2-devel] [PATCH 3/4] EmbeddedPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[Qingyu]

Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
EFI_UNSUPPORTED to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().

Cc: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Abner Chang <abner.chang@amd.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Qingyu <qingyu.shang@intel.com>
---
 .../Drivers/VirtualKeyboardDxe/VirtualKeyboard.c       | 10 ++++++----
 .../Drivers/VirtualKeyboardDxe/VirtualKeyboard.h       | 10 ++++++----
 2 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
index 4bbc3ead2c87..48a99566df63 100644
--- a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
+++ b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
@@ -694,11 +694,12 @@ KeyboardReadKeyStrokeWorker (
 /**
   Read out the scan code of the key that has just been stroked.
 
-  @param  This        Pointer of simple text Protocol.
-  @param  Key         Pointer for store the key that read out.
+  @param  This              Pointer of simple text Protocol.
+  @param  Key               Pointer for store the key that read out.
 
-  @retval EFI_SUCCESS The key is read out successfully.
-  @retval other       The key reading failed.
+  @retval EFI_SUCCESS       The key is read out successfully.
+  @retval other             The key reading failed.
+  @retval EFI_UNSUPPORTED   The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
@@ -752,6 +753,7 @@ VirtualKeyboardReadKeyStroke (
   @retval  EFI_DEVICE_ERROR      The keystroke information was not returned
                                  due to hardware errors.
   @retval  EFI_INVALID_PARAMETER KeyData is NULL.
+  @retval  EFI_UNSUPPORTED       The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
diff --git a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
index f72bd6f9c6cc..25063c262721 100644
--- a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
+++ b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
@@ -496,11 +496,12 @@ KeyNotifyProcessHandler (
 /**
   Read out the scan code of the key that has just been stroked.
 
-  @param  This        Pointer of simple text Protocol.
-  @param  Key         Pointer for store the key that read out.
+  @param  This              Pointer of simple text Protocol.
+  @param  Key               Pointer for store the key that read out.
 
-  @retval EFI_SUCCESS The key is read out successfully.
-  @retval other       The key reading failed.
+  @retval EFI_SUCCESS       The key is read out successfully.
+  @retval other             The key reading failed.
+  @retval EFI_UNSUPPORTED   The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
@@ -523,6 +524,7 @@ VirtualKeyboardReadKeyStroke (
   @retval  EFI_DEVICE_ERROR      The keystroke information was not returned due to
                                  hardware errors.
   @retval  EFI_INVALID_PARAMETER KeyData is NULL.
+  @retval  EFI_UNSUPPORTED       The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
-- 
2.39.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116683): https://edk2.groups.io/g/devel/message/116683
Mute This Topic: https://groups.io/mt/104886873/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

[edk2-devel] [PATCH 4/4] EmulatorPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[Qingyu]

Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
EFI_UNSUPPORTED to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().

Cc: Andrew Fish <afish@apple.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Qingyu <qingyu.shang@intel.com>
---
 EmulatorPkg/EmuGopDxe/GopInput.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/EmulatorPkg/EmuGopDxe/GopInput.c b/EmulatorPkg/EmuGopDxe/GopInput.c
index a48293912d5a..94a4fcf26747 100644
--- a/EmulatorPkg/EmuGopDxe/GopInput.c
+++ b/EmulatorPkg/EmuGopDxe/GopInput.c
@@ -156,6 +156,7 @@ EmuGopSimpleTextInReset (
   @retval EFI_NOT_READY    There was no keystroke data available.
   @retval EFI_DEVICE_ERROR The keystroke information was not returned due to
                            hardware errors.
+  @retval EFI_UNSUPPORTED  The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
@@ -339,6 +340,7 @@ EmuGopSimpleTextInExResetEx (
                           EFI_DEVICE_ERROR The keystroke
                           information was not returned due to
                           hardware errors.
+  @retval EFI_UNSUPPORTED The device does not support the ability to read keystroke data.
 
 
 **/
-- 
2.39.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116684): https://edk2.groups.io/g/devel/message/116684
Mute This Topic: https://groups.io/mt/104886874/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 2/4] ShellPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[Chao Li]

[-- Attachment #1: Type: text/plain, Size: 1999 bytes --]

Hi Qingyu,

It may not be my domain, I think what you are trying to say is "Refer to 
UEFI spec 2.10 section 12.3.3",  not 13.3.3, because the 13.3.3 is 
"Number and Location of System Partitions", see me comment below. I 
recommend fixing all of the patch commit messages in this series.

The changes looks good to me and would recommend Liming and Zhichao to 
check again.


Thanks,
Chao
On 2024/3/11 16:41, Qingyu wrote:
> Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
It should be section 12.3.3, not 13.3.3.
> EFI_UNSUPPORTED to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
> and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().
>
> Cc: Liming Gao<gaoliming@byosoft.com.cn>
> Cc: Zhichao Gao<zhichao.gao@intel.com>
> Cc: Chao Li<lichao@loongson.cn>
> Signed-off-by: Qingyu<qingyu.shang@intel.com>
> ---
>   ShellPkg/Application/Shell/ConsoleWrappers.c | 4 +++-
>   1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/ShellPkg/Application/Shell/ConsoleWrappers.c b/ShellPkg/Application/Shell/ConsoleWrappers.c
> index eae11370e4e0..dbffae30cdf5 100644
> --- a/ShellPkg/Application/Shell/ConsoleWrappers.c
> +++ b/ShellPkg/Application/Shell/ConsoleWrappers.c
> @@ -67,7 +67,9 @@ FileBasedSimpleTextInReset (
>     @param[in] This      A pointer to the SimpleTextIn structure.
>     @param[in, out] Key  A pointer to the Key structure to fill.
>   
> -  @retval   EFI_SUCCESS The read was successful.
> +  @retval EFI_SUCCESS      The read was successful.
> +  @retval EFI_UNSUPPORTED  The device does not support the ability to read
> +                           keystroke data.
>   **/
>   EFI_STATUS
>   EFIAPI


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116703): https://edk2.groups.io/g/devel/message/116703
Mute This Topic: https://groups.io/mt/104886872/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



[-- Attachment #2: Type: text/html, Size: 3628 bytes --]

回复: [edk2-devel] [PATCH 0/4] Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[gaoliming via groups.io]

For this patch set, Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

Besides, please also update
Edk2Platforms\Features\Intel\UserInterface\VirtualKeyboardFeaturePkg\Virtual
KeyboardDxe

Thanks
Liming
> -----邮件原件-----
> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Qingyu
> 发送时间: 2024年3月11日 16:41
> 收件人: devel@edk2.groups.io
> 抄送: Ming Tan <ming.tan@intel.com>; Yi Li <yi1.li@intel.com>; Gahan
> <gahan.saraiya@intel.com>
> 主题: [edk2-devel] [PATCH 0/4] Update the comments of ReadKeyStroke and
> ReadKeyStrokeEx
> 
> Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
> EFI_UNSUPPORTED to
> EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
> and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().
> 
> This patch series update ReadKeyStroke and ReadKeyStrokeEx
> implementation
> in Edk2.
> 
> Qingyu (4):
>   MdeModulePkg: Update the comments of ReadKeyStroke and
> ReadKeyStrokeEx
>   ShellPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx
>   EmbeddedPkg: Update the comments of ReadKeyStroke and
> ReadKeyStrokeEx
>   EmulatorPkg: Update the comments of ReadKeyStroke and
> ReadKeyStrokeEx
> 
>  .../Drivers/VirtualKeyboardDxe/VirtualKeyboard.c       | 10 ++++++----
>  .../Drivers/VirtualKeyboardDxe/VirtualKeyboard.h       | 10 ++++++----
>  EmulatorPkg/EmuGopDxe/GopInput.c                       |  2 ++
>  MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c     |  4 +++-
>  MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h      |  3 +++
>  MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c                 |  2 ++
>  MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h                 |  2 ++
>  .../Universal/Console/ConSplitterDxe/ConSplitter.c     |  6 ++++++
>  .../Universal/Console/ConSplitterDxe/ConSplitter.h     |  6 ++++++
>  MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h  |  4 ++++
>  .../Universal/Console/TerminalDxe/TerminalConIn.c      |  4 ++++
>  ShellPkg/Application/Shell/ConsoleWrappers.c           |  4 +++-
>  12 files changed, 47 insertions(+), 10 deletions(-)
> 
> Cc: Ming Tan <ming.tan@intel.com>
> Cc: Yi Li <yi1.li@intel.com>
> Cc: Gahan <gahan.saraiya@intel.com>
> Signed-off-by: Qingyu <qingyu.shang@intel.com>
> 
> --
> 2.39.1.windows.1
> 
> 
> 
> 
> 





-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116705): https://edk2.groups.io/g/devel/message/116705
Mute This Topic: https://groups.io/mt/104900075/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 2/4] ShellPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[Gao, Zhichao]

Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>

Thanks,
Zhichao

> -----Original Message-----
> From: Shang, Qingyu <qingyu.shang@intel.com>
> Sent: Monday, March 11, 2024 4:41 PM
> To: devel@edk2.groups.io
> Cc: Liming Gao <gaoliming@byosoft.com.cn>; Gao, Zhichao
> <zhichao.gao@intel.com>; Chao Li <lichao@loongson.cn>
> Subject: [PATCH 2/4] ShellPkg: Update the comments of ReadKeyStroke and
> ReadKeyStrokeEx
> 
> Refer to Uefi spec 2.10 section 13.3.3, Add a new retval EFI_UNSUPPORTED
> to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
> and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().
> 
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Zhichao Gao <zhichao.gao@intel.com>
> Cc: Chao Li <lichao@loongson.cn>
> Signed-off-by: Qingyu <qingyu.shang@intel.com>
> ---
>  ShellPkg/Application/Shell/ConsoleWrappers.c | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/ShellPkg/Application/Shell/ConsoleWrappers.c
> b/ShellPkg/Application/Shell/ConsoleWrappers.c
> index eae11370e4e0..dbffae30cdf5 100644
> --- a/ShellPkg/Application/Shell/ConsoleWrappers.c
> +++ b/ShellPkg/Application/Shell/ConsoleWrappers.c
> @@ -67,7 +67,9 @@ FileBasedSimpleTextInReset (
>    @param[in] This      A pointer to the SimpleTextIn structure.
>    @param[in, out] Key  A pointer to the Key structure to fill.
> 
> -  @retval   EFI_SUCCESS The read was successful.
> +  @retval EFI_SUCCESS      The read was successful.
> +  @retval EFI_UNSUPPORTED  The device does not support the ability to
> read
> +                           keystroke data.
>  **/
>  EFI_STATUS
>  EFIAPI
> --
> 2.39.1.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#117081): https://edk2.groups.io/g/devel/message/117081
Mute This Topic: https://groups.io/mt/104886872/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH 2/4] ShellPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx

[Gao, Zhichao]

[-- Attachment #1: Type: text/plain, Size: 2578 bytes --]

Good catch. Please update the commit message. Then take my R-B.

Thanks,
Zhichao

From: Chao Li <lichao@loongson.cn>
Sent: Wednesday, March 13, 2024 10:13 AM
To: devel@edk2.groups.io; Shang, Qingyu <qingyu.shang@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>; Gao, Zhichao <zhichao.gao@intel.com>
Subject: Re: [edk2-devel] [PATCH 2/4] ShellPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx


Hi Qingyu,

It may not be my domain, I think what you are trying to say is "Refer to UEFI spec 2.10 section 12.3.3",  not 13.3.3, because the 13.3.3 is "Number and Location of System Partitions", see me comment below. I recommend fixing all of the patch commit messages in this series.

The changes looks good to me and would recommend Liming and Zhichao to check again.

Thanks,
Chao
On 2024/3/11 16:41, Qingyu wrote:

Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
It should be section 12.3.3, not 13.3.3.




EFI_UNSUPPORTED to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx

and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().



Cc: Liming Gao <gaoliming@byosoft.com.cn><mailto:gaoliming@byosoft.com.cn>

Cc: Zhichao Gao <zhichao.gao@intel.com><mailto:zhichao.gao@intel.com>

Cc: Chao Li <lichao@loongson.cn><mailto:lichao@loongson.cn>

Signed-off-by: Qingyu <qingyu.shang@intel.com><mailto:qingyu.shang@intel.com>

---

 ShellPkg/Application/Shell/ConsoleWrappers.c | 4 +++-

 1 file changed, 3 insertions(+), 1 deletion(-)



diff --git a/ShellPkg/Application/Shell/ConsoleWrappers.c b/ShellPkg/Application/Shell/ConsoleWrappers.c

index eae11370e4e0..dbffae30cdf5 100644

--- a/ShellPkg/Application/Shell/ConsoleWrappers.c

+++ b/ShellPkg/Application/Shell/ConsoleWrappers.c

@@ -67,7 +67,9 @@ FileBasedSimpleTextInReset (

   @param[in] This      A pointer to the SimpleTextIn structure.

   @param[in, out] Key  A pointer to the Key structure to fill.



-  @retval   EFI_SUCCESS The read was successful.

+  @retval EFI_SUCCESS      The read was successful.

+  @retval EFI_UNSUPPORTED  The device does not support the ability to read

+                           keystroke data.

 **/

 EFI_STATUS

 EFIAPI


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#117082): https://edk2.groups.io/g/devel/message/117082
Mute This Topic: https://groups.io/mt/104886872/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



[-- Attachment #2: Type: text/html, Size: 6989 bytes --]