[edk2-devel] [PATCH 1/1] MdePkg: Updated the comments of EFI_SYSTEM_TABLE and ReadKeyStroke

[edk2-devel] [PATCH 1/1] MdePkg: Updated the comments of EFI_SYSTEM_TABLE and ReadKeyStroke

[Junfeng Guan]

1. Refer to Uefi spec 2.10 section 4.3.1, Updated the comments of
EFI_SYSTEM_TABLE to satisfy ConIn/ConOut/StdErr requirements.
2. Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
EFI_UNSUPPORTED to EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().

Signed-off-by: Junfeng Guan <junfengx.guan@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Cc: Yi Li <yi1.li@intel.com>
---
 MdePkg/Include/Protocol/SimpleTextIn.h   |  1 +
 MdePkg/Include/Protocol/SimpleTextInEx.h |  1 +
 MdePkg/Include/Uefi/UefiSpec.h           | 10 +++++++---
 3 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/MdePkg/Include/Protocol/SimpleTextIn.h b/MdePkg/Include/Protocol/SimpleTextIn.h
index 838fae279e71..b9d48472dd7f 100644
--- a/MdePkg/Include/Protocol/SimpleTextIn.h
+++ b/MdePkg/Include/Protocol/SimpleTextIn.h
@@ -100,6 +100,7 @@ EFI_STATUS
   @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.
 
 **/
 typedef
diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h b/MdePkg/Include/Protocol/SimpleTextInEx.h
index 8317325d9b82..f33893768efb 100644
--- a/MdePkg/Include/Protocol/SimpleTextInEx.h
+++ b/MdePkg/Include/Protocol/SimpleTextInEx.h
@@ -186,6 +186,7 @@ typedef struct {
   @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.
 
 
 **/
diff --git a/MdePkg/Include/Uefi/UefiSpec.h b/MdePkg/Include/Uefi/UefiSpec.h
index 5de00e8ea2af..c4952bd5f0d3 100644
--- a/MdePkg/Include/Uefi/UefiSpec.h
+++ b/MdePkg/Include/Uefi/UefiSpec.h
@@ -2006,7 +2006,8 @@ typedef struct {
   UINT32                             FirmwareRevision;
   ///
   /// The handle for the active console input device. This handle must support
-  /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
+  /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL. If
+  /// there is no active console, these protocols must still be present.
   ///
   EFI_HANDLE                         ConsoleInHandle;
   ///
@@ -2015,7 +2016,9 @@ typedef struct {
   ///
   EFI_SIMPLE_TEXT_INPUT_PROTOCOL     *ConIn;
   ///
-  /// The handle for the active console output device.
+  /// The handle for the active console output device. This handle must support the
+  /// EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL. If there is no active console, these protocols
+  /// must still be present.
   ///
   EFI_HANDLE                         ConsoleOutHandle;
   ///
@@ -2025,7 +2028,8 @@ typedef struct {
   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *ConOut;
   ///
   /// The handle for the active standard error console device.
-  /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
+  /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL. If there
+  /// is no active console, this protocol must still be present.
   ///
   EFI_HANDLE                         StandardErrorHandle;
   ///
-- 
2.26.2.windows.1



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#112917): https://edk2.groups.io/g/devel/message/112917
Mute This Topic: https://groups.io/mt/103369615/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

回复: [edk2-devel] [PATCH 1/1] MdePkg: Updated the comments of EFI_SYSTEM_TABLE and ReadKeyStroke

[gaoliming via groups.io]

Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

> -----邮件原件-----
> 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Junfeng Guan
> 发送时间: 2023年12月21日 10:02
> 收件人: devel@edk2.groups.io
> 抄送: Michael D Kinney <michael.d.kinney@intel.com>; Liming Gao
> <gaoliming@byosoft.com.cn>; Zhiguang Liu <zhiguang.liu@intel.com>; Yi Li
> <yi1.li@intel.com>
> 主题: [edk2-devel] [PATCH 1/1] MdePkg: Updated the comments of
> EFI_SYSTEM_TABLE and ReadKeyStroke
> 
> 1. Refer to Uefi spec 2.10 section 4.3.1, Updated the comments of
> EFI_SYSTEM_TABLE to satisfy ConIn/ConOut/StdErr requirements.
> 2. Refer to Uefi spec 2.10 section 13.3.3, Add a new retval
> EFI_UNSUPPORTED to
> EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.ReadKeyStrokeEx
> and EFI_SIMPLE_TEXT_INPUT_PROTOCOL.ReadKeyStroke().
> 
> Signed-off-by: Junfeng Guan <junfengx.guan@intel.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Liming Gao <gaoliming@byosoft.com.cn>
> Cc: Zhiguang Liu <zhiguang.liu@intel.com>
> Cc: Yi Li <yi1.li@intel.com>
> ---
>  MdePkg/Include/Protocol/SimpleTextIn.h   |  1 +
>  MdePkg/Include/Protocol/SimpleTextInEx.h |  1 +
>  MdePkg/Include/Uefi/UefiSpec.h           | 10 +++++++---
>  3 files changed, 9 insertions(+), 3 deletions(-)
> 
> diff --git a/MdePkg/Include/Protocol/SimpleTextIn.h
> b/MdePkg/Include/Protocol/SimpleTextIn.h
> index 838fae279e71..b9d48472dd7f 100644
> --- a/MdePkg/Include/Protocol/SimpleTextIn.h
> +++ b/MdePkg/Include/Protocol/SimpleTextIn.h
> @@ -100,6 +100,7 @@ EFI_STATUS
>    @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.
> 
>  **/
>  typedef
> diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h
> b/MdePkg/Include/Protocol/SimpleTextInEx.h
> index 8317325d9b82..f33893768efb 100644
> --- a/MdePkg/Include/Protocol/SimpleTextInEx.h
> +++ b/MdePkg/Include/Protocol/SimpleTextInEx.h
> @@ -186,6 +186,7 @@ typedef struct {
>    @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.
> 
> 
>  **/
> diff --git a/MdePkg/Include/Uefi/UefiSpec.h
> b/MdePkg/Include/Uefi/UefiSpec.h
> index 5de00e8ea2af..c4952bd5f0d3 100644
> --- a/MdePkg/Include/Uefi/UefiSpec.h
> +++ b/MdePkg/Include/Uefi/UefiSpec.h
> @@ -2006,7 +2006,8 @@ typedef struct {
>    UINT32                             FirmwareRevision;
>    ///
>    /// The handle for the active console input device. This handle must
> support
> -  /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and
> EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
> +  /// EFI_SIMPLE_TEXT_INPUT_PROTOCOL and
> EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL. If
> +  /// there is no active console, these protocols must still be present.
>    ///
>    EFI_HANDLE                         ConsoleInHandle;
>    ///
> @@ -2015,7 +2016,9 @@ typedef struct {
>    ///
>    EFI_SIMPLE_TEXT_INPUT_PROTOCOL     *ConIn;
>    ///
> -  /// The handle for the active console output device.
> +  /// The handle for the active console output device. This handle must
> support the
> +  /// EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL. If there is no active console,
> these protocols
> +  /// must still be present.
>    ///
>    EFI_HANDLE                         ConsoleOutHandle;
>    ///
> @@ -2025,7 +2028,8 @@ typedef struct {
>    EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *ConOut;
>    ///
>    /// The handle for the active standard error console device.
> -  /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
> +  /// This handle must support the EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL.
> If there
> +  /// is no active console, this protocol must still be present.
>    ///
>    EFI_HANDLE                         StandardErrorHandle;
>    ///
> --
> 2.26.2.windows.1
> 
> 
> 
> 
> 





-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#113571): https://edk2.groups.io/g/devel/message/113571
Mute This Topic: https://groups.io/mt/103655475/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-