From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) (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 7955921962333 for ; Sun, 18 Jun 2017 19:30:14 -0700 (PDT) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga104.jf.intel.com with ESMTP; 18 Jun 2017 19:31:35 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.39,359,1493708400"; d="scan'208";a="982417040" Received: from fmsmsx106.amr.corp.intel.com ([10.18.124.204]) by orsmga003.jf.intel.com with ESMTP; 18 Jun 2017 19:31:35 -0700 Received: from FMSMSX110.amr.corp.intel.com (10.18.116.10) by FMSMSX106.amr.corp.intel.com (10.18.124.204) with Microsoft SMTP Server (TLS) id 14.3.319.2; Sun, 18 Jun 2017 19:31:35 -0700 Received: from shsmsx102.ccr.corp.intel.com (10.239.4.154) by fmsmsx110.amr.corp.intel.com (10.18.116.10) with Microsoft SMTP Server (TLS) id 14.3.319.2; Sun, 18 Jun 2017 19:31:34 -0700 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.151]) by shsmsx102.ccr.corp.intel.com ([169.254.2.146]) with mapi id 14.03.0319.002; Mon, 19 Jun 2017 10:31:31 +0800 From: "Ni, Ruiyu" To: "Bi, Dandan" , "edk2-devel@lists.01.org" CC: "Zeng, Star" Thread-Topic: [patch 3/8] MdeModulePkg: Update comments in SimpleTextInEx according to UEFI 2.7 Thread-Index: AQHS6JpyR5lSK2nMOUm6LRYSgsQIbaIrdt2g Date: Mon, 19 Jun 2017 02:31:30 +0000 Deferred-Delivery: Mon, 19 Jun 2017 02:31:00 +0000 Message-ID: <734D49CCEBEEF84792F5B80ED585239D5B99BD26@SHSMSX104.ccr.corp.intel.com> References: <1497835292-34476-1-git-send-email-dandan.bi@intel.com> <1497835292-34476-4-git-send-email-dandan.bi@intel.com> In-Reply-To: <1497835292-34476-4-git-send-email-dandan.bi@intel.com> Accept-Language: en-US, zh-CN X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [patch 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: , X-List-Received-Date: Mon, 19 Jun 2017 02:30:14 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Ruiyu Ni Thanks/Ray > -----Original Message----- > From: Bi, Dandan > Sent: Monday, June 19, 2017 9:21 AM > To: edk2-devel@lists.01.org > Cc: Zeng, Star ; Ni, Ruiyu > Subject: [patch 3/8] MdeModulePkg: Update comments in SimpleTextInEx > according to UEFI 2.7 >=20 > Cc: Star Zeng > Cc: Ruiyu Ni > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Dandan Bi > --- > 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 > +++++++---- > 6 files changed, 42 insertions(+), 22 deletions(-) >=20 > diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c > b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.c > index cdd1684..da61ef2 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 Input > 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 in= put > device. >=20 > @param This Protocol instance pointer. > - @param KeyData A pointer to a buffer that is fill= ed in with the > keystroke > - information data for the key that = was pressed. > + @param KeyData A pointer to a buffer that is fill= ed in with > + the keystroke information for the = key that was > + pressed.If KeyData.Key, > KeyData.KeyState.KeyToggleState > + and KeyData.KeyState.KeyShiftState= are 0, then any > incomplete > + keystroke will trigger a notificat= ion of the > KeyNotificationFunction. > @param KeyNotificationFunction Points to the function to be calle= d > when the key > - sequence is typed specified by Key= Data. > + sequence is typed specified by Key= Data.This notification > function > + should be called at <=3DTPL_CALLBA= CK. > @param NotifyHandle Points to the unique handle assign= ed to the > registered notification. >=20 > @retval EFI_SUCCESS The notification function was regi= stered > successfully. > @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for > necessary data structures. > @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle or > KeyNotificationFunction is NULL. > diff --git a/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h > b/MdeModulePkg/Bus/Usb/UsbKbDxe/EfiKey.h > index 089f113..c727c73 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 in= put > device. >=20 > @param This Protocol instance pointer. > - @param KeyData A pointer to a buffer that is fill= ed in with the > keystroke > - information data for the key that = was pressed. > + @param KeyData A pointer to a buffer that is fill= ed in with > + the keystroke information for the = key that was > + pressed.If KeyData.Key, > KeyData.KeyState.KeyToggleState > + and KeyData.KeyState.KeyShiftState= are 0, then any > incomplete > + keystroke will trigger a notificat= ion of the > KeyNotificationFunction. > @param KeyNotificationFunction Points to the function to be calle= d > when the key > - sequence is typed specified by Key= Data. > + sequence is typed specified by Key= Data.This notification > function > + should be called at <=3DTPL_CALLBA= CK. > @param NotifyHandle Points to the unique handle assign= ed to the > registered notification. >=20 > @retval EFI_SUCCESS The notification function was regi= stered > successfully. > @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for > necesssary data structures. > @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle or > KeyNotificationFunction is NULL. > diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c > b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c > index b230f5e..0ebef09 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 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 ke= y that was > - pressed. > + @param KeyData A pointer to a buffer that is filled = in with > + the keystroke information for the key= that was > + pressed.If KeyData.Key, > KeyData.KeyState.KeyToggleState > + and KeyData.KeyState.KeyShiftState ar= e 0, then any > incomplete > + keystroke will trigger a notification= of the > KeyNotificationFunction. > @param KeyNotificationFunction Points to the function to be called w= hen > the key > - sequence is typed specified by KeyDat= a. > + 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 registe= red > successfully. > diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h > b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h > index eeea061..2b79b4b 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 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 ke= y that was > - pressed. > + @param KeyData A pointer to a buffer that is filled = in with > + the keystroke information for the key= that was > + pressed.If KeyData.Key, > KeyData.KeyState.KeyToggleState > + and KeyData.KeyState.KeyShiftState ar= e 0, then any > incomplete > + keystroke will trigger a notification= of the > KeyNotificationFunction. > @param KeyNotificationFunction Points to the function to be called w= hen > the key > - sequence is typed specified by KeyDat= a. > + 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 registe= red > successfully. > diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h > b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h > index c15d17c..8c805ea 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 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 ke= y that was > - pressed. > + pressed.If KeyData.Key, > KeyData.KeyState.KeyToggleState > + and KeyData.KeyState.KeyShiftState ar= e 0, then any > incomplete > + keystroke will trigger a notification= of the > KeyNotificationFunction. > @param KeyNotificationFunction Points to the function to be called w= hen > the key > - sequence is typed specified by KeyDat= a. > + 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 registe= red > successfully. > diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c > b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c > index 1392f16..6508f26 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 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 ke= y that was > - pressed. > + @param KeyData A pointer to a buffer that is filled = in with > + the keystroke information for the key= that was > + pressed.If KeyData.Key, > KeyData.KeyState.KeyToggleState > + and KeyData.KeyState.KeyShiftState ar= e 0, then any > incomplete > + keystroke will trigger a notification= of the > KeyNotificationFunction. > @param KeyNotificationFunction Points to the function to be called w= hen > the key > - sequence is typed specified by KeyDat= a. > + 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 registe= red > successfully. > -- > 1.9.5.msysgit.1