From 7cc2010f46b87c9c1a7baefb060868e4ee17a753 Mon Sep 17 00:00:00 2001 From: Qingyu Date: Mon, 11 Mar 2024 16:23:11 +0800 Subject: EmbeddedPkg: 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: Leif Lindholm Cc: Ard Biesheuvel Cc: Abner Chang Cc: Liming Gao Signed-off-by: Qingyu Reviewed-by: Liming Gao --- EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c | 10 ++++++---- EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c index 4bbc3ead2c..48a99566df 100644 --- a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c +++ b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c @@ -694,11 +694,12 @@ KeyboardReadKeyStrokeWorker ( /** Read out the scan code of the key that has just been stroked. - @param This Pointer of simple text Protocol. - @param Key Pointer for store the key that read out. + @param This Pointer of simple text Protocol. + @param Key Pointer for store the key that read out. - @retval EFI_SUCCESS The key is read out successfully. - @retval other The key reading failed. + @retval EFI_SUCCESS The key is read out successfully. + @retval other The key reading failed. + @retval EFI_UNSUPPORTED The device does not support the ability to read keystroke data. **/ EFI_STATUS @@ -752,6 +753,7 @@ VirtualKeyboardReadKeyStroke ( @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/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h index f72bd6f9c6..25063c2627 100644 --- a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h +++ b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h @@ -496,11 +496,12 @@ KeyNotifyProcessHandler ( /** Read out the scan code of the key that has just been stroked. - @param This Pointer of simple text Protocol. - @param Key Pointer for store the key that read out. + @param This Pointer of simple text Protocol. + @param Key Pointer for store the key that read out. - @retval EFI_SUCCESS The key is read out successfully. - @retval other The key reading failed. + @retval EFI_SUCCESS The key is read out successfully. + @retval other The key reading failed. + @retval EFI_UNSUPPORTED The device does not support the ability to read keystroke data. **/ EFI_STATUS @@ -523,6 +524,7 @@ VirtualKeyboardReadKeyStroke ( @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 -- cgit v1.2.3