From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.88; helo=mga01.intel.com; envelope-from=star.zeng@intel.com; receiver=edk2-devel@lists.01.org Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) (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 C11C22239364E for ; Wed, 31 Jan 2018 17:26:10 -0800 (PST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 31 Jan 2018 17:31:46 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,442,1511856000"; d="scan'208";a="14118172" Received: from fmsmsx107.amr.corp.intel.com ([10.18.124.205]) by orsmga007.jf.intel.com with ESMTP; 31 Jan 2018 17:31:46 -0800 Received: from shsmsx151.ccr.corp.intel.com (10.239.6.50) by fmsmsx107.amr.corp.intel.com (10.18.124.205) with Microsoft SMTP Server (TLS) id 14.3.319.2; Wed, 31 Jan 2018 17:31:45 -0800 Received: from shsmsx102.ccr.corp.intel.com ([169.254.2.124]) by SHSMSX151.ccr.corp.intel.com ([169.254.3.116]) with mapi id 14.03.0319.002; Thu, 1 Feb 2018 09:31:43 +0800 From: "Zeng, Star" To: "Kinney, Michael D" , "edk2-devel@lists.01.org" CC: "Kinney, Michael D" , "Yao, Jiewen" , "Gao, Liming" , "Zeng, Star" Thread-Topic: [edk2] [Patch 1/1] MdePkg/UefiLib: Add EfiLocateProtocolBuffer() Thread-Index: AQHTmuvtB7Z0+ubmC0a1IKcu/CjdbaOOwfEw Date: Thu, 1 Feb 2018 01:31:43 +0000 Message-ID: <0C09AFA07DD0434D9E2A0C6AEB0483103BA1DD67@shsmsx102.ccr.corp.intel.com> References: <20180131233324.7492-1-michael.d.kinney@intel.com> <20180131233324.7492-2-michael.d.kinney@intel.com> In-Reply-To: <20180131233324.7492-2-michael.d.kinney@intel.com> Accept-Language: zh-CN, en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [Patch 1/1] MdePkg/UefiLib: Add EfiLocateProtocolBuffer() X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 01 Feb 2018 01:26:11 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Hi Mike, UefiLib is capable to be used by SMM Core or SMM driver before SmmReadyToLo= ck. And the new interface has the comment below. + The returned buffer is allocated using + EFI_BOOT_SERVICES.AllocatePool(). The caller = is + responsible for freeing this buffer with + EFI_BOOT_SERVICES.FreePool(). But the implementation is using AllocateZeroPool() like below, that will di= rect to gSmst->AllocatePool for SMM Core or SMM driver. + // + // Allocate array of protocol instances + // + *Buffer =3D AllocateZeroPool (NoHandles * sizeof (VOID *)); + if (*Buffer =3D=3D NULL) { + return EFI_OUT_OF_RESOURCES; + } Should the implementation use gBS->AllocatePool() + ZeroMem() instead of Al= locateZeroPool()? Thanks, Star -----Original Message----- From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Kinn= ey, Michael D Sent: Thursday, February 1, 2018 7:33 AM To: edk2-devel@lists.01.org Cc: Kinney, Michael D ; Yao, Jiewen ; Gao, Liming Subject: [edk2] [Patch 1/1] MdePkg/UefiLib: Add EfiLocateProtocolBuffer() From: Michael D Kinney https://bugzilla.tianocore.org/show_bug.cgi?id=3D838 Add new API to the UefiLib that locates and returns an array of protocols instances that match a given protocol. Cc: Sean Brogan Cc: Jiewen Yao Cc: Liming Gao Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney --- MdePkg/Include/Library/UefiLib.h | 32 +++++++++++- MdePkg/Library/UefiLib/UefiLib.c | 107 +++++++++++++++++++++++++++++++++++= +++- 2 files changed, 137 insertions(+), 2 deletions(-) diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/Uefi= Lib.h index 0b14792a0a..54bc2cc5a3 100644 --- a/MdePkg/Include/Library/UefiLib.h +++ b/MdePkg/Include/Library/UefiLib.h @@ -12,7 +12,7 @@ of size reduction when compiler optimization is disabled. If MDEPKG_NDEB= UG is defined, then debug and assert related macros wrapped by it are the NULL= implementations. =20 -Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made availabl= e under=20 the terms and conditions of the BSD License that accompanies this distribu= tion. =20 The full text of the license may be found at @@ -1490,4 +1490,34 @@ CatSPrint ( ... ); =20 +/** + Returns an array of protocol instance that matches the given protocol. + + @param[in] Protocol Provides the protocol to search for. + @param[out] NoProtocols The number of protocols returned in Buffer. + @param[out] Buffer A pointer to the buffer to return the requeste= d + array of protocol instances that match Protoco= l. + The returned buffer is allocated using + EFI_BOOT_SERVICES.AllocatePool(). The caller = is + responsible for freeing this buffer with + EFI_BOOT_SERVICES.FreePool(). + + @retval EFI_SUCCESS The array of protocols was returned in Bu= ffer, + and the number of protocols in Buffer was + returned in NoProtocols. + @retval EFI_NOT_FOUND No protocols found. + @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store = the + matching results. + @retval EFI_INVALID_PARAMETER Protocol is NULL. + @retval EFI_INVALID_PARAMETER NoProtocols is NULL. + @retval EFI_INVALID_PARAMETER Buffer is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiLocateProtocolBuffer ( + IN EFI_GUID *Protocol, + OUT UINTN *NoProtocols, + OUT VOID ***Buffer + ); #endif diff --git a/MdePkg/Library/UefiLib/UefiLib.c b/MdePkg/Library/UefiLib/Uefi= Lib.c index a7eee01240..d86db4bd67 100644 --- a/MdePkg/Library/UefiLib/UefiLib.c +++ b/MdePkg/Library/UefiLib/UefiLib.c @@ -5,7 +5,7 @@ EFI Driver Model related protocols, manage Unicode string tables for UEF= I Drivers,=20 and print messages on the console output and standard error devices. =20 - Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BS= D License which accompanies this distribution. The full text of the license may b= e found at @@ -1605,3 +1605,108 @@ GetBestLanguage ( // return NULL; } + +/** + Returns an array of protocol instance that matches the given protocol. + + @param[in] Protocol Provides the protocol to search for. + @param[out] NoProtocols The number of protocols returned in Buffer. + @param[out] Buffer A pointer to the buffer to return the requeste= d + array of protocol instances that match Protoco= l. + The returned buffer is allocated using + EFI_BOOT_SERVICES.AllocatePool(). The caller = is + responsible for freeing this buffer with + EFI_BOOT_SERVICES.FreePool(). + + @retval EFI_SUCCESS The array of protocols was returned in Bu= ffer, + and the number of protocols in Buffer was + returned in NoProtocols. + @retval EFI_NOT_FOUND No protocols found. + @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store = the + matching results. + @retval EFI_INVALID_PARAMETER Protocol is NULL. + @retval EFI_INVALID_PARAMETER NoProtocols is NULL. + @retval EFI_INVALID_PARAMETER Buffer is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiLocateProtocolBuffer ( + IN EFI_GUID *Protocol, + OUT UINTN *NoProtocols, + OUT VOID ***Buffer + ) +{ + EFI_STATUS Status; + UINTN NoHandles; + EFI_HANDLE *HandleBuffer; + UINTN Index; + + // + // Check input parameters + // + if (Protocol =3D=3D NULL || NoProtocols =3D=3D NULL || Buffer =3D=3D NUL= L) { + return EFI_INVALID_PARAMETER; + } + + // + // Initialze output parameters + // + *NoProtocols =3D 0; + *Buffer =3D NULL; + + // + // Retrieve the array of handles that support Protocol + // + Status =3D gBS->LocateHandleBuffer ( + ByProtocol, + Protocol, + NULL, + &NoHandles, + &HandleBuffer + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Allocate array of protocol instances + // + *Buffer =3D AllocateZeroPool (NoHandles * sizeof (VOID *)); + if (*Buffer =3D=3D NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Lookup Protocol on each handle in HandleBuffer to fill in the array o= f + // protocol instances. Handle case where protocol instance was present = when + // LocateHandleBuffer() was called, but is not present when HandleProtoc= ol() + // is called. + // + for (Index =3D 0, *NoProtocols =3D 0; Index < NoHandles; Index++) { + Status =3D gBS->HandleProtocol ( + HandleBuffer[Index], + Protocol, + &((*Buffer)[*NoProtocols]) + ); + if (!EFI_ERROR (Status)) { + (*NoProtocols)++; + } + } + + // + // Free the handle buffer + // + FreePool (HandleBuffer); + + // + // Make sure at least one protocol instance was found + // + if (*NoProtocols =3D=3D 0) { + FreePool (*Buffer); + *Buffer =3D NULL; + return EFI_NOT_FOUND; + } + + return EFI_SUCCESS; +} --=20 2.14.2.windows.3 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel