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.120; helo=mga04.intel.com; envelope-from=ruiyu.ni@intel.com; receiver=edk2-devel@lists.01.org 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 7B0842111FE73 for ; Thu, 21 Jun 2018 00:35:43 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 21 Jun 2018 00:35:42 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,250,1526367600"; d="scan'208";a="61015922" Received: from fmsmsx108.amr.corp.intel.com ([10.18.124.206]) by orsmga003.jf.intel.com with ESMTP; 21 Jun 2018 00:35:42 -0700 Received: from fmsmsx125.amr.corp.intel.com (10.18.125.40) by FMSMSX108.amr.corp.intel.com (10.18.124.206) with Microsoft SMTP Server (TLS) id 14.3.319.2; Thu, 21 Jun 2018 00:35:42 -0700 Received: from shsmsx102.ccr.corp.intel.com (10.239.4.154) by FMSMSX125.amr.corp.intel.com (10.18.125.40) with Microsoft SMTP Server (TLS) id 14.3.319.2; Thu, 21 Jun 2018 00:35:41 -0700 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.87]) by shsmsx102.ccr.corp.intel.com ([169.254.2.223]) with mapi id 14.03.0319.002; Thu, 21 Jun 2018 15:35:39 +0800 From: "Ni, Ruiyu" To: "Wu, Hao A" , "edk2-devel@lists.01.org" CC: "Zeng, Star" , "Dong, Eric" , "Yao, Jiewen" Thread-Topic: [PATCH 1/4] MdeModulePkg: Add definitions for EDKII PEI NVME host controller PPI Thread-Index: AQHUBHcBjSuiPKrhPE61sdlMDMsz46RqWncA Date: Thu, 21 Jun 2018 07:35:39 +0000 Message-ID: <734D49CCEBEEF84792F5B80ED585239D5BD40BEC@SHSMSX104.ccr.corp.intel.com> References: <20180615070342.13388-1-hao.a.wu@intel.com> <20180615070342.13388-2-hao.a.wu@intel.com> In-Reply-To: <20180615070342.13388-2-hao.a.wu@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 1/4] MdeModulePkg: Add definitions for EDKII PEI NVME host controller PPI X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.26 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 21 Jun 2018 07:35:43 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Thanks/Ray > -----Original Message----- > From: Wu, Hao A > Sent: Friday, June 15, 2018 3:04 PM > To: edk2-devel@lists.01.org > Cc: Wu, Hao A ; Zeng, Star ; > Dong, Eric ; Ni, Ruiyu ; Yao, > Jiewen > Subject: [PATCH 1/4] MdeModulePkg: Add definitions for EDKII PEI NVME > host controller PPI >=20 > Introduces the below PPI: >=20 > struct EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI { > EDKII_NVM_EXPRESS_HC_GET_MMIO_BAR GetNvmeHcMmioBar; > EDKII_NVM_EXPRESS_HC_GET_DEVICE_PATH GetNvmeHcDevicePath; > }; >=20 > The GetNvmeHcMmioBar service will provide the caller with the MMIO BAR > address of each NVMe HC within the system; >=20 > The GetNvmeHcDevicePath service will provide the caller with the device > path information of each NVMe HC. >=20 > Cc: Star Zeng > Cc: Eric Dong > Cc: Ruiyu Ni > Cc: Jiewen Yao > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Hao Wu > --- > MdeModulePkg/Include/Ppi/NvmExpressHostController.h | 97 > ++++++++++++++++++++ > MdeModulePkg/MdeModulePkg.dec | 3 + > 2 files changed, 100 insertions(+) >=20 > diff --git a/MdeModulePkg/Include/Ppi/NvmExpressHostController.h > b/MdeModulePkg/Include/Ppi/NvmExpressHostController.h > new file mode 100644 > index 0000000000..de9ae4a59c > --- /dev/null > +++ b/MdeModulePkg/Include/Ppi/NvmExpressHostController.h > @@ -0,0 +1,97 @@ > +/** @file > + > + Copyright (c) 2018, 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 > + > + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" > BASIS, > + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER > EXPRESS OR IMPLIED. > + > +**/ > + > +#ifndef _EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI_H_ > +#define _EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI_H_ > + > +#include > + > +/// > +/// Global ID for the EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI. > +/// > +#define EDKII_NVME_EXPRESS_HOST_CONTROLLER_PPI_GUID \ > + { \ > + 0xcae3aa63, 0x676f, 0x4da3, { 0xbd, 0x50, 0x6c, 0xc5, 0xed, 0xde, > +0x9a, 0xad } \ > + } > + > +// > +// Forward declaration for the > EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI. > +// > +typedef struct _EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI > +EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI; > + > +/** > + Get the MMIO base address of NVM Express host controller. > + > + @param[in] PeiServices Describes the list of possible PEI Se= rvices. > + @param[in] This The PPI instance pointer. > + @param[in] ControllerId The ID of the NVM Express host contro= ller. > + @param[out] MmioBar The MMIO base address of the controll= er. > + > + @retval EFI_SUCCESS The operation succeeds. > + @retval EFI_INVALID_PARAMETER The parameters are invalid. > + @retval EFI_NOT_FOUND The specified NVM Express host contro= ller > not > + found. > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EDKII_NVM_EXPRESS_HC_GET_MMIO_BAR) ( > + IN EFI_PEI_SERVICES **PeiServices, 1. PeiServices is not needed. > + IN EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI *This, > + IN UINT8 ControllerId, > + OUT UINTN *MmioBar > + ); > + > +/** > + Get the device path of NVM Express host controller. > + > + @param[in] PeiServices Describes the list of possible PEI Se= rvices. > + @param[in] This The PPI instance pointer. > + @param[in] ControllerId The ID of the NVM Express host contro= ller. > + @param[out] DevicePathLenth The length of the device path in byte= s > specified > + by DevicePath. > + @param[out] DevicePath The device path of NVM Express host > controller. > + The caller is responsible for freeing= it. > + This field re-uses EFI Device Path Pr= otocol as > + defined by Section 10.2 EFI Device Pa= th Protocol > + of UEFI 2.7 Specification. > + > + @retval EFI_SUCCESS The operation succeeds. > + @retval EFI_INVALID_PARAMETER The parameters are invalid. > + @retval EFI_NOT_FOUND The specified NVM Express host contro= ller > not > + found. > + @retval EFI_OUT_OF_RESOURCES The operation fails due to lack of > resources. > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EDKII_NVM_EXPRESS_HC_GET_DEVICE_PATH) ( > + IN EFI_PEI_SERVICES **PeiServices, > + IN EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI *This, > + IN UINT8 ControllerId, > + OUT UINTN *DevicePathLenth, > + OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath 2. Firstly, FreePool() is not supported in PEI phase so requiring caller to= free is confusing. Secondly, can the device path be determined at build time? If yes, then a pointer to global variable can be returned so no need for caller to free. > + ); > + > +// > +// This PPI contains a set of services to interact with the NVM Express > +host // controller. > +// > +struct _EDKII_NVM_EXPRESS_HOST_CONTROLLER_PPI { > + EDKII_NVM_EXPRESS_HC_GET_MMIO_BAR GetNvmeHcMmioBar; > + EDKII_NVM_EXPRESS_HC_GET_DEVICE_PATH GetNvmeHcDevicePath; > +}; > + > +extern EFI_GUID gEdkiiPeiNvmExpressHostControllerPpiGuid; > + > +#endif > diff --git a/MdeModulePkg/MdeModulePkg.dec > b/MdeModulePkg/MdeModulePkg.dec index 3802b6e0b8..8d7c97ee91 > 100644 > --- a/MdeModulePkg/MdeModulePkg.dec > +++ b/MdeModulePkg/MdeModulePkg.dec > @@ -471,6 +471,9 @@ > ## Include/Ppi/PlatformSpecificResetHandler.h > gEdkiiPlatformSpecificResetHandlerPpiGuid =3D { 0x75cf14ae, 0x3441, 0x= 49dc, > { 0xaa, 0x10, 0xbb, 0x35, 0xa7, 0xba, 0x8b, 0xab } } >=20 > + ## Include/Ppi/NvmExpressHostController.h > + gEdkiiPeiNvmExpressHostControllerPpiGuid =3D { 0xcae3aa63, 0x676f, > + 0x4da3, { 0xbd, 0x50, 0x6c, 0xc5, 0xed, 0xde, 0x9a, 0xad } } > + > [Protocols] > ## Load File protocol provides capability to load and unload EFI image= into > memory and execute it. > # Include/Protocol/LoadPe32Image.h > -- > 2.12.0.windows.1