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>
This commit is contained in:
Qingyu 2024-03-11 16:18:41 +08:00 committed by Liming Gao
parent 8f698f0a64
commit e043e3e3bf
8 changed files with 30 additions and 1 deletions

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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