From: "Qingyu" <qingyu.shang@intel.com>
To: devel@edk2.groups.io
Cc: Liming Gao <gaoliming@byosoft.com.cn>,
Michael D Kinney <michael.d.kinney@intel.com>
Subject: [edk2-devel] [PATCH 1/4] MdeModulePkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx
Date: Mon, 11 Mar 2024 16:41:13 +0800 [thread overview]
Message-ID: <0d4fcf8dfe8914e1a9cb7775472d4832401161cf.1710145917.git.qingyu.shang@intel.com> (raw)
In-Reply-To: <cover.1710145917.git.qingyu.shang@intel.com>
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]
-=-=-=-=-=-=-=-=-=-=-=-
next prev parent reply other threads:[~2024-03-12 15:40 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-11 8:41 [edk2-devel] [PATCH 0/4] Update the comments of ReadKeyStroke and ReadKeyStrokeEx Qingyu
2024-03-11 8:41 ` Qingyu [this message]
2024-03-11 8:41 ` [edk2-devel] [PATCH 2/4] ShellPkg: " Qingyu
2024-03-13 2:12 ` Chao Li
2024-03-25 6:15 ` Gao, Zhichao
2024-03-25 6:12 ` Gao, Zhichao
2024-03-11 8:41 ` [edk2-devel] [PATCH 3/4] EmbeddedPkg: " Qingyu
2024-03-11 8:41 ` [edk2-devel] [PATCH 4/4] EmulatorPkg: " Qingyu
2024-03-13 4:54 ` 回复: [edk2-devel] [PATCH 0/4] " gaoliming via groups.io
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=0d4fcf8dfe8914e1a9cb7775472d4832401161cf.1710145917.git.qingyu.shang@intel.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox