sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

EmbeddedPkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx

Browse Source 
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: 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>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
This commit is contained in:
Qingyu
2024-03-11 16:23:11 +08:00
committed by Liming Gao
parent b79a64d26e
commit 7cc2010f46
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
View File

@ -694,11 +694,12 @@ KeyboardReadKeyStrokeWorker (
/** /**
Read out the scan code of the key that has just been stroked. Read out the scan code of the key that has just been stroked.
@param This Pointer of simple text Protocol. @param This Pointer of simple text Protocol.
@param Key Pointer for store the key that read out. @param Key Pointer for store the key that read out.
@retval EFI_SUCCESS The key is read out successfully. @retval EFI_SUCCESS The key is read out successfully.
@retval other The key reading failed. @retval other The key reading failed.
@retval EFI_UNSUPPORTED The device does not support the ability to read keystroke data.
**/ **/
EFI_STATUS EFI_STATUS
@ -752,6 +753,7 @@ VirtualKeyboardReadKeyStroke (
@retval EFI_DEVICE_ERROR The keystroke information was not returned @retval EFI_DEVICE_ERROR The keystroke information was not returned
due to hardware errors. due to hardware errors.
@retval EFI_INVALID_PARAMETER KeyData is NULL. @retval EFI_INVALID_PARAMETER KeyData is NULL.
@retval EFI_UNSUPPORTED The device does not support the ability to read keystroke data.
**/ **/
EFI_STATUS EFI_STATUS

10
EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
View File

@ -496,11 +496,12 @@ KeyNotifyProcessHandler (
/** /**
Read out the scan code of the key that has just been stroked. Read out the scan code of the key that has just been stroked.
@param This Pointer of simple text Protocol. @param This Pointer of simple text Protocol.
@param Key Pointer for store the key that read out. @param Key Pointer for store the key that read out.
@retval EFI_SUCCESS The key is read out successfully. @retval EFI_SUCCESS The key is read out successfully.
@retval other The key reading failed. @retval other The key reading failed.
@retval EFI_UNSUPPORTED The device does not support the ability to read keystroke data.
**/ **/
EFI_STATUS EFI_STATUS
@ -523,6 +524,7 @@ VirtualKeyboardReadKeyStroke (
@retval EFI_DEVICE_ERROR The keystroke information was not returned due to @retval EFI_DEVICE_ERROR The keystroke information was not returned due to
hardware errors. hardware errors.
@retval EFI_INVALID_PARAMETER KeyData is NULL. @retval EFI_INVALID_PARAMETER KeyData is NULL.
@retval EFI_UNSUPPORTED The device does not support the ability to read keystroke data.
**/ **/
EFI_STATUS EFI_STATUS