From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by spool.mail.gandi.net (Postfix) with ESMTPS id 63110941723 for ; Tue, 26 Dec 2023 14:14:28 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=ejxkNeSrTINgGWH6bbcsB8e029KTcAfI/FhFUT/2tdo=; c=relaxed/simple; d=groups.io; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References:MIME-Version:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Transfer-Encoding; s=20140610; t=1703600067; v=1; b=w5KnUYkwzqxyptUtqwyOueecTSM9YJNw8+kwkEhHjEUBMMTEtbjp9os599JmfTrlrMjZsrPi lb9NDOEz3eZANdqKvd9/IoPZBSWac3XOCpehwzaOYgAPVEEtjpo0HVIsB49HvO/1K8WcjRJ6rfR E/Av+Ompop13BfNS4eCoMyF8= X-Received: by 127.0.0.2 with SMTP id 2tdZYY7687511xQwcGzwxS4q; Tue, 26 Dec 2023 06:14:27 -0800 X-Received: from mgamail.intel.com (mgamail.intel.com [192.55.52.120]) by mx.groups.io with SMTP id smtpd.web11.42548.1703124106109894385 for ; Wed, 20 Dec 2023 18:01:46 -0800 X-IronPort-AV: E=McAfee;i="6600,9927,10930"; a="394794888" X-IronPort-AV: E=Sophos;i="6.04,292,1695711600"; d="scan'208";a="394794888" X-Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Dec 2023 18:01:45 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10930"; a="894919237" X-IronPort-AV: E=Sophos;i="6.04,292,1695711600"; d="scan'208";a="894919237" X-Received: from shclienthost01.ccr.corp.intel.com ([10.239.216.139]) by fmsmga002.fm.intel.com with ESMTP; 20 Dec 2023 18:01:44 -0800 From: Junfeng Guan To: devel@edk2.groups.io Cc: Michael D Kinney , Liming Gao , Zhiguang Liu , Yi Li Subject: [edk2-devel] [PATCH 1/1] MdePkg: Updated the comments of EFI_SYSTEM_TABLE and ReadKeyStroke Date: Thu, 21 Dec 2023 10:01:41 +0800 Message-Id: <0426635097cf9f7cc4e8ff6a3ec7fb75cd50fdbf.1703123261.git.junfengx.guan@intel.com> In-Reply-To: References: MIME-Version: 1.0 Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,junfengx.guan@intel.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: 9ZfwSK4iiYmgJCWwCRdJGtR2x7686176AA= Content-Transfer-Encoding: 8bit X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20140610 header.b=w5KnUYkw; dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=intel.com (policy=none); spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce@groups.io 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 Cc: Michael D Kinney Cc: Liming Gao Cc: Zhiguang Liu Cc: Yi Li --- 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] -=-=-=-=-=-=-=-=-=-=-=-