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/Bus | |
| parent | 8f698f0a646124ede518d3e255ef725de1239639 (diff) | |
| download | edk2-e043e3e3bfec98de90386235c8d4c62b34e06665.tar.gz edk2-e043e3e3bfec98de90386235c8d4c62b34e06665.tar.bz2 edk2-e043e3e3bfec98de90386235c8d4c62b34e06665.zip | |
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/Bus')
| -rw-r--r-- | MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c | 4 | ||||
| -rw-r--r-- | MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h | 3 | ||||
| -rw-r--r-- | MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c | 2 | ||||
| -rw-r--r-- | MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h | 2 |
4 files changed, 10 insertions, 1 deletions
diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c index b1ab17af37..81d3c6eb70 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 ca1dd9b2c2..7b4db9c778 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 e889f422bb..bcda0724ee 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 a9dfeafd6f..b9e9a725ee 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
|