diff options
author | Qingyu <qingyu.shang@intel.com> | 2024-03-11 16:18:41 +0800 |
---|---|---|
committer | Liming Gao <gaoliming@byosoft.com.cn> | 2024-04-03 10:25:06 +0800 |
commit | e043e3e3bfec98de90386235c8d4c62b34e06665 (patch) | |
tree | 9cb0ce211539d155bd07863cdb1911a46c7971c2 /MdeModulePkg/Universal/Console | |
parent | 8f698f0a646124ede518d3e255ef725de1239639 (diff) | |
download | edk2-e043e3e3bfec98de90386235c8d4c62b34e06665.zip edk2-e043e3e3bfec98de90386235c8d4c62b34e06665.tar.gz edk2-e043e3e3bfec98de90386235c8d4c62b34e06665.tar.bz2 |
MdeModulePkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx
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: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Qingyu <qingyu.shang@intel.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
Diffstat (limited to 'MdeModulePkg/Universal/Console')
4 files changed, 20 insertions, 0 deletions
diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c index 8b5e62e..0a776f3 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 a1fe747..354107c 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 4238f84..7581cda 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 2286264..aafa65f 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
|