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 C2B01941AB0 for ; Tue, 12 Mar 2024 15:40:08 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=v5XsFYivSilcPtFZJHWfdhCgpE6k4u4Nk2LSnIGZpcw=; 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:Resent-Date:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Transfer-Encoding; s=20240206; t=1710258007; v=1; b=XBXgC5hqZA8P7Y5WL5th6q9VAz5Ee2NiC9tCyjXpVTrG9NVptvkYeQUtibN6n1KJGoLObuqS LSSr4ZPWPEEyNdqxTW5EP50JFNAu4CXfIbulrzrpL0y4AVoWVT4ylgr12WSVdJ4mXdKqBa7b4D6 +CweCZZtex+JJd/1/j8Ri2MsIkBWd4qg7FBoxnoiAFaS27XXEHlhTtViwrpDrsUPcS60E5zo0ph D9PhGfK5XAFWNYNeaUv6MmJrIPZfP4bR8l5xUEVDogCh06SZJm3nD4ZjTVp5f2cVTvGQ+1rmtmS ki6LuRmL4DNwkmc9ZhemXA8D8BKMcyFnE4CxcmOVfgqvw== X-Received: by 127.0.0.2 with SMTP id JXS6YY7687511xah6CUNDQNH; Tue, 12 Mar 2024 08:40:07 -0700 X-Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.18]) by mx.groups.io with SMTP id smtpd.web10.57768.1710146508064491423 for ; Mon, 11 Mar 2024 01:41:49 -0700 X-IronPort-AV: E=McAfee;i="6600,9927,11009"; a="4640559" X-IronPort-AV: E=Sophos;i="6.07,116,1708416000"; d="scan'208";a="4640559" X-Received: from fmviesa007.fm.intel.com ([10.60.135.147]) by fmvoesa112.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 Mar 2024 01:41:49 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.07,116,1708416000"; d="scan'208";a="10984404" X-Received: from qingyush-mobl.ccr.corp.intel.com ([10.238.9.87]) by fmviesa007.fm.intel.com with ESMTP; 11 Mar 2024 01:41:49 -0700 From: "Qingyu" To: devel@edk2.groups.io Cc: Liming Gao , Michael D Kinney Subject: [edk2-devel] [PATCH 1/4] MdeModulePkg: Update the comments of ReadKeyStroke and ReadKeyStrokeEx Date: Mon, 11 Mar 2024 16:41:13 +0800 Message-Id: <0d4fcf8dfe8914e1a9cb7775472d4832401161cf.1710145917.git.qingyu.shang@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 Resent-Date: Tue, 12 Mar 2024 08:40:04 -0700 Reply-To: devel@edk2.groups.io,qingyu.shang@intel.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: LRrfIJYFpx3hNEoFXxACLSyex7686176AA= Content-Transfer-Encoding: 8bit X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20240206 header.b=XBXgC5hq; 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 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(). Cc: Liming Gao Cc: Michael D Kinney Signed-off-by: Qingyu --- MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c | 4 +++- MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h | 3 +++ MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c | 2 ++ MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h | 2 ++ MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c | 6 ++++++ MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h | 6 ++++++ MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h | 4 ++++ MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c | 4 ++++ 8 files changed, 30 insertions(+), 1 deletion(-) diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c index b1ab17af3788..81d3c6eb70ab 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 ca1dd9b2c2c6..7b4db9c778de 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 e889f422bbf7..bcda0724ee76 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 a9dfeafd6f10..b9e9a725ee33 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 diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c index 8b5e62e3a883..0a776f369b9a 100644 --- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c +++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c @@ -3551,6 +3551,8 @@ ConSplitterTextInExDequeueKey ( @retval EFI_NOT_READY There was no keystroke data availiable. @retval EFI_DEVICE_ERROR The keydtroke information was not returned due to hardware errors. + @retval EFI_UNSUPPORTED The device does not support the ability to read + keystroke data. **/ EFI_STATUS @@ -3623,6 +3625,8 @@ ConSplitterTextInPrivateReadKeyStroke ( @retval EFI_NOT_READY There was no keystroke data availiable. @retval EFI_DEVICE_ERROR The keydtroke information was not returned due to hardware errors. + @retval EFI_UNSUPPORTED The device does not support the ability to read + keystroke data. **/ EFI_STATUS @@ -3805,6 +3809,8 @@ ConSplitterTextInResetEx ( @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/Universal/Console/ConSplitterDxe/ConSplitter.h b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h index a1fe74726058..1be3adb3b9be 100644 --- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h +++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h @@ -1265,6 +1265,8 @@ ConSplitterTextInReset ( @retval EFI_NOT_READY There was no keystroke data availiable. @retval EFI_DEVICE_ERROR The keydtroke information was not returned due to hardware errors. + @retval EFI_UNSUPPORTED The device does not support the ability to read + keystroke data. **/ EFI_STATUS @@ -1342,6 +1344,8 @@ ConSplitterTextInResetEx ( @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 @@ -1453,6 +1457,8 @@ ConSplitterTextInWaitForKey ( @retval EFI_NOT_READY There was no keystroke data availiable. @retval EFI_DEVICE_ERROR The keydtroke information was not returned due to hardware errors. + @retval EFI_UNSUPPORTED The device does not support the ability to read + keystroke data. **/ EFI_STATUS diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h index 4238f8420ec1..7581cda18bab 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h +++ b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h @@ -223,6 +223,8 @@ TerminalConInReset ( @retval EFI_SUCCESS The keystroke information is returned successfully. @retval EFI_NOT_READY There is no keystroke data available. @retval EFI_DEVICE_ERROR The dependent serial device encounters error. + @retval EFI_UNSUPPORTED The device does not support the ability to read + keystroke data. **/ EFI_STATUS @@ -303,6 +305,8 @@ TerminalConInResetEx ( @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/Universal/Console/TerminalDxe/TerminalConIn.c b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c index 2286264b29e5..aafa65f44c6d 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c +++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c @@ -109,6 +109,8 @@ TerminalConInReset ( @retval EFI_SUCCESS The keystroke information is returned successfully. @retval EFI_NOT_READY There is no keystroke data available. @retval EFI_DEVICE_ERROR The dependent serial device encounters error. + @retval EFI_UNSUPPORTED The device does not support the ability to read + keystroke data. **/ EFI_STATUS @@ -237,6 +239,8 @@ TerminalConInResetEx ( @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 -- 2.39.1.windows.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#116681): https://edk2.groups.io/g/devel/message/116681 Mute This Topic: https://groups.io/mt/104886871/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=-=-=-=-=-=-=-=-=-=-=-