From nobody Sat Jul 12 22:20:58 2025 Delivered-To: importer@patchew.org Received-SPF: none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) client-ip=198.145.21.10; envelope-from=edk2-devel-bounces@lists.01.org; helo=ml01.01.org; Authentication-Results: mx.zoho.com; spf=none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) smtp.mailfrom=edk2-devel-bounces@lists.01.org; Return-Path: Received: from ml01.01.org (ml01.01.org [198.145.21.10]) by mx.zohomail.com with SMTPS id 1497847632147478.72544556329876; Sun, 18 Jun 2017 21:47:12 -0700 (PDT) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 4375821C8F635; Sun, 18 Jun 2017 21:45:49 -0700 (PDT) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 6B3B721C8F618 for ; Sun, 18 Jun 2017 21:45:47 -0700 (PDT) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Jun 2017 21:47:08 -0700 Received: from shwdeopenpsi114.ccr.corp.intel.com ([10.239.157.135]) by orsmga002.jf.intel.com with ESMTP; 18 Jun 2017 21:47:07 -0700 X-Original-To: edk2-devel@lists.01.org X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.39,359,1493708400"; d="scan'208";a="100987265" From: Dandan Bi To: edk2-devel@lists.01.org Date: Mon, 19 Jun 2017 12:46:21 +0800 Message-Id: <1497847586-18144-4-git-send-email-dandan.bi@intel.com> X-Mailer: git-send-email 1.9.5.msysgit.1 In-Reply-To: <1497847586-18144-1-git-send-email-dandan.bi@intel.com> References: <1497847586-18144-1-git-send-email-dandan.bi@intel.com> Subject: [edk2] [PATCH v2 3/8] MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7 X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Ruiyu Ni , Star Zeng MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" X-ZohoMail: RSF_4 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" v2: Add some missing changes Ps2KeyboardDxe. Cc: Star Zeng Cc: Ruiyu Ni Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Dandan Bi --- MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c | 9 ++++++--- MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h | 9 ++++++--- MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c | 12 ++++++++-= --- MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h | 12 ++++++++-= --- MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c | 11 +++++++--= -- MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h | 11 +++++++--= -- MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h | 7 +++++-- MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c | 11 +++++++--= -- 8 files changed, 54 insertions(+), 28 deletions(-) diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c b/MdeModule= Pkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c index bc58fe2..04e3365 100644 --- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c +++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c @@ -1,10 +1,10 @@ /** @file Routines implements SIMPLE_TEXT_IN protocol's interfaces based on 8042 i= nterfaces provided by Ps2KbdCtrller.c. =20 -Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD = License which accompanies this distribution. The full text of the license may be = found at http://opensource.org/licenses/bsd-license.php =20 @@ -531,13 +531,16 @@ Exit: /** Register a notification function for a particular keystroke for the in= put device. =20 @param This Protocol instance pointer. @param KeyData A pointer to a buffer that is filled= in with the keystroke - information data for the key that wa= s pressed. + information data for the key that wa= s pressed. If KeyData.Key, + KeyData.KeyState.KeyToggleState and = KeyData.KeyState.KeyShiftState are 0, + then any incomplete keystroke will t= rigger a notification of the KeyNotificationFunction. @param KeyNotificationFunction Points to the function to be called = when the key - sequence is typed specified by KeyDa= ta. + sequence is typed specified by KeyDa= ta. This notification function + should be called at <=3DTPL_CALLBACK. @param NotifyHandle Points to the unique handle assigned= to the registered notification. =20 @retval EFI_SUCCESS The notification function was regist= ered successfully. @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for nec= esssary data structures. @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle or KeyNotifi= cationFunction is NULL. diff --git a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h b/MdeModuleP= kg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h index e41c198..d772a97 100644 --- a/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h +++ b/MdeModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h @@ -1,9 +1,9 @@ /** @file PS/2 keyboard driver header file =20 -Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD = License which accompanies this distribution. The full text of the license may be = found at http://opensource.org/licenses/bsd-license.php =20 @@ -493,13 +493,16 @@ KeyboardSetState ( /** Register a notification function for a particular keystroke for the in= put device. =20 @param This - Protocol instance pointer. @param KeyData - A pointer to a buffer that is filled = in with the keystroke - information data for the key that was presse= d. + information data for the key that was= pressed. If KeyData.Key, + KeyData.KeyState.KeyToggleState and K= eyData.KeyState.KeyShiftState are 0, + then any incomplete keystroke will tr= igger a notification of the KeyNotificationFunction. @param KeyNotificationFunction - Points to the function to be called w= hen the key - sequence is typed specified by KeyData. + sequence is typed specified by KeyDat= a. This notification function + should be called at <=3DTPL_CALLBACK. @param NotifyHandle - Points to the unique handle assigned = to the registered notification. =20 @retval EFI_SUCCESS - The notification function was regist= ered successfully. @retval EFI_OUT_OF_RESOURCES - Unable to allocate resources for nec= esssary data structures. @retval EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL. diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c b/MdeModulePkg/Bus/Usb/= UsbKbDxe/EfiKey.c index cdd1684..fb2bf3f 100644 --- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c +++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c @@ -1,10 +1,10 @@ /** @file USB Keyboard Driver that manages USB keyboard and produces Simple Text I= nput Protocol and Simple Text Input Ex Protocol. =20 -Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.
+Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD = License which accompanies this distribution. The full text of the license may be = found at http://opensource.org/licenses/bsd-license.php =20 @@ -1053,14 +1053,18 @@ USBKeyboardSetState ( =20 /** Register a notification function for a particular keystroke for the inpu= t device. =20 @param This Protocol instance pointer. - @param KeyData A pointer to a buffer that is filled= in with the keystroke - information data for the key that wa= s pressed. + @param KeyData A pointer to a buffer that is filled= in with + the keystroke information for the ke= y that was + pressed. If KeyData.Key, KeyData.Key= State.KeyToggleState + and KeyData.KeyState.KeyShiftState a= re 0, then any incomplete + keystroke will trigger a notificatio= n of the KeyNotificationFunction. @param KeyNotificationFunction Points to the function to be called = when the key - sequence is typed specified by KeyDa= ta. + sequence is typed specified by KeyDa= ta. This notification function + should be called at <=3DTPL_CALLBACK. @param NotifyHandle Points to the unique handle assigned= to the registered notification. =20 @retval EFI_SUCCESS The notification function was regist= ered successfully. @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for nec= essary data structures. @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle or KeyNotifi= cationFunction is NULL. diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h b/MdeModulePkg/Bus/Usb/= UsbKbDxe/EfiKey.h index 089f113..6049678 100644 --- a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h +++ b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h @@ -1,9 +1,9 @@ /** @file Header file for USB Keyboard Driver's Data Structures. =20 -Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.
+Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD = License which accompanies this distribution. The full text of the license may be = found at http://opensource.org/licenses/bsd-license.php =20 @@ -500,14 +500,18 @@ USBKeyboardSetState ( =20 /** Register a notification function for a particular keystroke for the inpu= t device. =20 @param This Protocol instance pointer. - @param KeyData A pointer to a buffer that is filled= in with the keystroke - information data for the key that wa= s pressed. + @param KeyData A pointer to a buffer that is filled= in with + the keystroke information for the ke= y that was + pressed. If KeyData.Key, KeyData.Key= State.KeyToggleState + and KeyData.KeyState.KeyShiftState a= re 0, then any incomplete + keystroke will trigger a notificatio= n of the KeyNotificationFunction. @param KeyNotificationFunction Points to the function to be called = when the key - sequence is typed specified by KeyDa= ta. + sequence is typed specified by KeyDa= ta. This notification function + should be called at <=3DTPL_CALLBACK. @param NotifyHandle Points to the unique handle assigned= to the registered notification. =20 @retval EFI_SUCCESS The notification function was regist= ered successfully. @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for nec= esssary data structures. @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle or KeyNotifi= cationFunction is NULL. diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c b/= MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c index b230f5e..e70ff61 100644 --- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c +++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c @@ -3840,15 +3840,18 @@ ConSplitterTextInSetState ( =20 /** Register a notification function for a particular keystroke for the inpu= t device. =20 @param This Protocol instance pointer. - @param KeyData A pointer to a buffer that is filled in= with the - keystroke information data for the key = that was - pressed. + @param KeyData A pointer to a buffer that is filled in= with + the keystroke information for the key t= hat was + pressed. If KeyData.Key, KeyData.KeySta= te.KeyToggleState + and KeyData.KeyState.KeyShiftState are = 0, then any incomplete + keystroke will trigger a notification o= f the KeyNotificationFunction. @param KeyNotificationFunction Points to the function to be called whe= n the key - sequence is typed specified by KeyData. + sequence is typed specified by KeyData.= This notification function + should be called at <=3DTPL_CALLBACK. @param NotifyHandle Points to the unique handle assigned to= the registered notification. =20 @retval EFI_SUCCESS The notification function was registered successfully. diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h b/= MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h index eeea061..9469860 100644 --- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h +++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h @@ -1394,15 +1394,18 @@ ConSplitterTextInSetState ( =20 /** Register a notification function for a particular keystroke for the inpu= t device. =20 @param This Protocol instance pointer. - @param KeyData A pointer to a buffer that is filled in= with the - keystroke information data for the key = that was - pressed. + @param KeyData A pointer to a buffer that is filled in= with + the keystroke information for the key t= hat was + pressed. If KeyData.Key, KeyData.KeySta= te.KeyToggleState + and KeyData.KeyState.KeyShiftState are = 0, then any incomplete + keystroke will trigger a notification o= f the KeyNotificationFunction. @param KeyNotificationFunction Points to the function to be called whe= n the key - sequence is typed specified by KeyData. + sequence is typed specified by KeyData.= This notification function + should be called at <=3DTPL_CALLBACK. @param NotifyHandle Points to the unique handle assigned to= the registered notification. =20 @retval EFI_SUCCESS The notification function was registered successfully. diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h b/MdeMod= ulePkg/Universal/Console/TerminalDxe/Terminal.h index c15d17c..7dded00 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h +++ b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h @@ -341,13 +341,16 @@ TerminalConInSetState ( Register a notification function for a particular keystroke for the inpu= t device. =20 @param This Protocol instance pointer. @param KeyData A pointer to a buffer that is filled in= with the keystroke information data for the key = that was - pressed. + pressed. If KeyData.Key, KeyData.KeySta= te.KeyToggleState + and KeyData.KeyState.KeyShiftState are = 0, then any incomplete + keystroke will trigger a notification o= f the KeyNotificationFunction. @param KeyNotificationFunction Points to the function to be called whe= n the key - sequence is typed specified by KeyData. + sequence is typed specified by KeyData.= This notification function + should be called at <=3DTPL_CALLBACK. @param NotifyHandle Points to the unique handle assigned to= the registered notification. =20 @retval EFI_SUCCESS The notification function was registered successfully. diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c b/M= deModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c index 1392f16..3c1102d 100644 --- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c +++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c @@ -308,15 +308,18 @@ TerminalConInSetState ( =20 /** Register a notification function for a particular keystroke for the inpu= t device. =20 @param This Protocol instance pointer. - @param KeyData A pointer to a buffer that is filled in= with the - keystroke information data for the key = that was - pressed. + @param KeyData A pointer to a buffer that is filled in= with + the keystroke information for the key t= hat was + pressed. If KeyData.Key, KeyData.KeySta= te.KeyToggleState + and KeyData.KeyState.KeyShiftState are = 0, then any incomplete + keystroke will trigger a notification o= f the KeyNotificationFunction. @param KeyNotificationFunction Points to the function to be called whe= n the key - sequence is typed specified by KeyData. + sequence is typed specified by KeyData.= This notification function + should be called at <=3DTPL_CALLBACK. @param NotifyHandle Points to the unique handle assigned to= the registered notification. =20 @retval EFI_SUCCESS The notification function was registered successfully. --=20 1.9.5.msysgit.1 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel