From nobody Sat Jul 12 21:52:17 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 1497847624503961.2026549699001; Sun, 18 Jun 2017 21:47:04 -0700 (PDT) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id EED2521C8F631; Sun, 18 Jun 2017 21:45:39 -0700 (PDT) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) (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 5D0D221962337 for ; Sun, 18 Jun 2017 21:45:39 -0700 (PDT) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Jun 2017 21:47:00 -0700 Received: from shwdeopenpsi114.ccr.corp.intel.com ([10.239.157.135]) by orsmga002.jf.intel.com with ESMTP; 18 Jun 2017 21:46:59 -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="100987139" From: Dandan Bi To: edk2-devel@lists.01.org Date: Mon, 19 Jun 2017 12:46:20 +0800 Message-Id: <1497847586-18144-3-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 2/8] IntelFrameworkModulePkg: Update comments in SimpleTextInEx 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 , Jeff Fan , 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" Update comments in SimpleTextInEx according to UEFI 2.7. Cc: Star Zeng Cc: Ruiyu Ni Cc: Jeff Fan Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Dandan Bi --- .../Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c | 10 +++++++--- .../Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h | 10 +++++++--- .../Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c | 15 +++++++++---= --- .../Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h | 16 ++++++++++--= ---- 4 files changed, 33 insertions(+), 18 deletions(-) diff --git a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c = b/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c index 5825a04..7677955 100644 --- a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2KbdTextIn.c +++ b/IntelFrameworkModulePkg/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,17 @@ 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 trigger 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/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h b= /IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h index 82aa5a6..76fb498 100644 --- a/IntelFrameworkModulePkg/Bus/Isa/Ps2KeyboardDxe/Ps2Keyboard.h +++ b/IntelFrameworkModulePkg/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 @@ -492,13 +492,17 @@ 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 trigger 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/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard= .c b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c index 742d009..7308523 100644 --- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c +++ b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.c @@ -2311,21 +2311,24 @@ Exit: /** 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=20 - information data for the key that was pr= essed. + information data for the key that was pr= essed. If KeyData.Key, + KeyData.KeyState.KeyToggleState and KeyD= ata.KeyState.KeyShiftState + are 0, then any incomplete keystroke wil= l trigger a notification of + the KeyNotificationFunction. @param KeyNotificationFunction Points to the function to be called when= the key=20 - sequence is typed specified by KeyData. = =20 - @param NotifyHandle Points to the unique handle assigned to = the registered notification. =20 + 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 - =20 @retval EFI_SUCCESS The notification function was registered= successfully. @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesss= ary data structures. @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL. - =20 -**/ =20 + +**/ EFI_STATUS EFIAPI BiosKeyboardRegisterKeyNotify ( IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This, IN EFI_KEY_DATA *KeyData, diff --git a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard= .h b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h index f38411a..0bf28ea 100644 --- a/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h +++ b/IntelFrameworkModulePkg/Csm/BiosThunk/KeyboardDxe/BiosKeyboard.h @@ -1,8 +1,8 @@ /** @file =20 -Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
=20 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 @@ -633,21 +633,25 @@ BiosKeyboardSetState ( /** 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=20 - information data for the key that was pr= essed. + information data for the key that was pr= essed. If KeyData.Key, + KeyData.KeyState.KeyToggleState and KeyD= ata.KeyState.KeyShiftState + are 0, then any incomplete keystroke wil= l trigger a notification of + the KeyNotificationFunction. @param KeyNotificationFunction Points to the function to be called when= the key=20 - sequence is typed specified by KeyData. = =20 - @param NotifyHandle Points to the unique handle assigned to = the registered notification. =20 + 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 =20 @retval EFI_SUCCESS The notification function was registered= successfully. @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesss= ary data structures. @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL. - =20 -**/ =20 + +**/ EFI_STATUS EFIAPI BiosKeyboardRegisterKeyNotify ( IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This, IN EFI_KEY_DATA *KeyData, --=20 1.9.5.msysgit.1 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel