[edk2-devel] [edk2-platforms][PATCH] VirtualKeyboardFeaturePkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx - mantis #2131

["Qingyu" <qingyu.shang@intel.com>]

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

Cc: Dandan Bi <dandan.bi@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Signed-off-by: Qingyu <qingyu.shang@intel.com>
---
 .../VirtualKeyboardFeaturePkg/VirtualKeyboardDxe/Keyboard.c     | 2 ++
 .../VirtualKeyboardDxe/VirtualKeyboard.h                        | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/Features/Intel/UserInterface/VirtualKeyboardFeaturePkg/VirtualKeyboardDxe/Keyboard.c b/Features/Intel/UserInterface/VirtualKeyboardFeaturePkg/VirtualKeyboardDxe/Keyboard.c
index 82aeac31bc..9c9b585ae2 100644
--- a/Features/Intel/UserInterface/VirtualKeyboardFeaturePkg/VirtualKeyboardDxe/Keyboard.c
+++ b/Features/Intel/UserInterface/VirtualKeyboardFeaturePkg/VirtualKeyboardDxe/Keyboard.c
@@ -1101,6 +1101,7 @@ End:
   @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
@@ -1154,6 +1155,7 @@ End:
   @retval EFI_SUCCESS            The keystroke information was returned.
   @retval EFI_NOT_READY          There was no keystroke data available.
   @retval EFI_INVALID_PARAMETER  This or KeyData is NULL.
+  @retval EFI_UNSUPPORTED        The device does not support the ability to read keystroke data.
 
 **/
 EFI_STATUS
diff --git a/Features/Intel/UserInterface/VirtualKeyboardFeaturePkg/VirtualKeyboardDxe/VirtualKeyboard.h b/Features/Intel/UserInterface/VirtualKeyboardFeaturePkg/VirtualKeyboardDxe/VirtualKeyboard.h
index 7090730861..d7b7340574 100644
--- a/Features/Intel/UserInterface/VirtualKeyboardFeaturePkg/VirtualKeyboardDxe/VirtualKeyboard.h
+++ b/Features/Intel/UserInterface/VirtualKeyboardFeaturePkg/VirtualKeyboardDxe/VirtualKeyboard.h
@@ -464,6 +464,7 @@ VkKeyboardReset (
   @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
@@ -512,6 +513,7 @@ VkKeyboardResetEx (
   @retval EFI_SUCCESS            The keystroke information was returned.
   @retval EFI_NOT_READY          There was no keystroke data available.
   @retval EFI_INVALID_PARAMETER  This or 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 (#117315): https://edk2.groups.io/g/devel/message/117315
Mute This Topic: https://groups.io/mt/105281909/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-