From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.31; helo=mga06.intel.com; envelope-from=star.zeng@intel.com; receiver=edk2-devel@lists.01.org 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 88CD320356263 for ; Tue, 5 Dec 2017 02:29:25 -0800 (PST) Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 05 Dec 2017 02:33:55 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.45,363,1508828400"; d="scan'208";a="213458" Received: from fmsmsx103.amr.corp.intel.com ([10.18.124.201]) by fmsmga007.fm.intel.com with ESMTP; 05 Dec 2017 02:33:55 -0800 Received: from fmsmsx114.amr.corp.intel.com (10.18.116.8) by FMSMSX103.amr.corp.intel.com (10.18.124.201) with Microsoft SMTP Server (TLS) id 14.3.319.2; Tue, 5 Dec 2017 02:33:55 -0800 Received: from shsmsx104.ccr.corp.intel.com (10.239.4.70) by FMSMSX114.amr.corp.intel.com (10.18.116.8) with Microsoft SMTP Server (TLS) id 14.3.319.2; Tue, 5 Dec 2017 02:33:54 -0800 Received: from shsmsx102.ccr.corp.intel.com ([169.254.2.175]) by SHSMSX104.ccr.corp.intel.com ([169.254.5.152]) with mapi id 14.03.0319.002; Tue, 5 Dec 2017 18:33:53 +0800 From: "Zeng, Star" To: Ard Biesheuvel , "Ni, Ruiyu" CC: "Wu, Hao A" , "edk2-devel@lists.01.org" , Leif Lindholm , "Tian, Feng" , "Zeng, Star" Thread-Topic: [edk2] [PATCH v2 1/2] MdeModulePkg: introduce SD/MMC override protocol Thread-Index: AQHTacOw4aXIawdLXUidB+SaSxsuxKM0CXgAgAADYoCAAIg6YA== Date: Tue, 5 Dec 2017 10:33:52 +0000 Message-ID: <0C09AFA07DD0434D9E2A0C6AEB0483103B9BFC6D@shsmsx102.ccr.corp.intel.com> References: <20171130101132.18317-1-ard.biesheuvel@linaro.org> <20171130101132.18317-2-ard.biesheuvel@linaro.org> In-Reply-To: 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 v2 1/2] MdeModulePkg: introduce SD/MMC override protocol 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: Tue, 05 Dec 2017 10:29:26 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable BTW, I prefer all the typedef and structure/field names have EDKII_ prefix,= for example MdeModulePkg\Include\Protocol\IoMmu.h and MdeModulePkg\Include= \Ppi\SdMmcHostController.h. Thanks, Star -----Original Message----- From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Ard = Biesheuvel Sent: Tuesday, December 5, 2017 6:25 PM To: Ni, Ruiyu Cc: Wu, Hao A ; edk2-devel@lists.01.org; Leif Lindholm = ; Tian, Feng ; Zeng, Star Subject: Re: [edk2] [PATCH v2 1/2] MdeModulePkg: introduce SD/MMC override = protocol On 5 December 2017 at 10:12, Ni, Ruiyu wrote: > Some comments re the detailed interfaces embedded in below. > > On 11/30/2017 6:11 PM, Ard Biesheuvel wrote: >> >> Many ARM based SoCs have integrated SDHCI controllers, and often,=20 >> these implementations deviate in subtle ways from the pertinent=20 >> specifications. On the one hand, these deviations are quite easy to=20 >> work around, but on the other hand, having a collection of SoC=20 >> specific workarounds in the generic driver stack is undesirable. >> >> So let's introduce an optional SD/MMC override protocol that we can=20 >> invoke at the appropriate moments in the device initialization. >> That way, the workaround itself remains platform specific, but we can=20 >> still use the generic driver stack on such platforms. >> >> Contributed-under: TianoCore Contribution Agreement 1.1 >> Signed-off-by: Ard Biesheuvel >> --- >> MdeModulePkg/Include/Protocol/SdMmcOverride.h | 103 ++++++++++++++++++= ++ >> MdeModulePkg/MdeModulePkg.dec | 3 + >> 2 files changed, 106 insertions(+) >> >> diff --git a/MdeModulePkg/Include/Protocol/SdMmcOverride.h >> b/MdeModulePkg/Include/Protocol/SdMmcOverride.h >> new file mode 100644 >> index 000000000000..5a5c393896f4 >> --- /dev/null >> +++ b/MdeModulePkg/Include/Protocol/SdMmcOverride.h >> @@ -0,0 +1,103 @@ >> +/** @file >> + Protocol to describe overrides required to support non-standard=20 >> +SDHCI >> + implementations >> + >> + Copyright (c) 2017, Linaro, Ltd. All rights reserved.
>> + >> + This program and the accompanying materials are licensed and made=20 >> + available under the terms and conditions of the >> BSD License >> + which accompanies this distribution. The full text of the license=20 >> + may >> be found at >> + http://opensource.org/licenses/bsd-license.php >> + >> + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"=20 >> + BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER=20 >> + EXPRESS OR >> IMPLIED. >> + >> +**/ >> + >> +#ifndef __SD_MMC_OVERRIDE_H__ >> +#define __SD_MMC_OVERRIDE_H__ >> + >> +#include >> + >> +#define EDKII_SD_MMC_OVERRIDE_PROTOCOL_GUID \ >> + { 0xeaf9e3c1, 0xc9cd, 0x46db, { 0xa5, 0xe5, 0x5a, 0x12, 0x4c,=20 >> +0x83, >> 0x23, 0x23 } } >> + >> +#define EDKII_SD_MMC_OVERRIDE_PROTOCOL_VERSION 0x1 >> + >> +typedef struct _SD_MMC_OVERRIDE SD_MMC_OVERRIDE; >> + >> +typedef enum { >> + SD_MMC_OVERRIDE_RESET_PRE_HOOK, >> + SD_MMC_OVERRIDE_RESET_POST_HOOK, >> + SD_MMC_OVERRIDE_INIT_HOST_PRE_HOOK, >> + SD_MMC_OVERRIDE_INIT_HOST_POST_HOOK, > > > How about using name like "SdMmcResetPre"? Sure > Do "ResetPre"/"ResetPost" / "InitHostPre" / "InitHostPost" cover all=20 > potential check points? > Perhaps not, but it is hard to predict the future :-) This is why I added t= he version field. (I should also update the second patch to reject the prot= ocol if its version is higher than EDKII_SD_MMC_OVERRIDE_PROTOCOL_VERSION) >> +} SD_MMC_OVERRIDE_HOOK; > > How about use "SD_MMC_PHASE_TYPE"? > Sure. > >> + >> +/** >> + >> + Override function for SDHCI capability bits >> + >> + @param[in] PassThru A pointer to the >> + =20 >> + EFI_SD_MMC_PASS_THRU_PROTOCOL >> instance. >> + @param[in] ControllerHandle The EFI_HANDLE of the controlle= r. >> + @param[in] Slot The 0 based slot index. >> + @param[in,out] SdMmcHcSlotCapability The SDHCI capability structure. >> + >> + @retval EFI_SUCCESS The override function completed >> successfully. >> + @retval EFI_NOT_FOUND The specified controller or slot does n= ot >> exist. >> + @retval EFI_INVALID_PARAMETER SdMmcHcSlotCapability is NULL >> + >> +**/ >> +typedef >> +EFI_STATUS >> +(EFIAPI * SD_MMC_OVERRIDE_CAPABILITY) ( > > > How about "SD_MMC_CAPABILITY"? > Sure. >> + IN EFI_SD_MMC_PASS_THRU_PROTOCOL *PassThru, >> + IN EFI_HANDLE ControllerHandle, >> + IN UINT8 Slot, >> + IN OUT UINT64 *SdMmcHcSlotCapability >> + ); > > > Is this API too specific? > Besides SlotCapability, is there any other attributes that may need=20 > override as well? > The capability structure is the root data structure that describes the SD/M= MC host controller. Which other data structures did you have in mind? >> + >> +/** >> + >> + Override function for SDHCI controller operations >> + >> + @param[in] PassThru A pointer to the >> + =20 >> + EFI_SD_MMC_PASS_THRU_PROTOCOL >> instance. >> + @param[in] ControllerHandle The EFI_HANDLE of the controlle= r. >> + @param[in] Slot The 0 based slot index. >> + @param[in,out] HookType The type of operation and wheth= er >> the >> + hook is invoked right before >> (pre) or >> + right after (post) >> + >> + @retval EFI_SUCCESS The override function completed >> successfully. >> + @retval EFI_NOT_FOUND The specified controller or slot does n= ot >> exist. >> + @retval EFI_INVALID_PARAMETER HookType is invalid >> + >> +**/ >> +typedef >> +EFI_STATUS >> +(EFIAPI * SD_MMC_OVERRIDE_INVOKE_HOOK) ( > > > How about "SD_MMC_NOTIFY_PHASE"? > Sure. >> + IN EFI_SD_MMC_PASS_THRU_PROTOCOL *PassThru, >> + IN EFI_HANDLE ControllerHandle, >> + IN UINT8 Slot, >> + IN SD_MMC_OVERRIDE_HOOK HookType >> + ); >> + >> +struct _SD_MMC_OVERRIDE { >> + // >> + // Protocol version of this implementation >> + // >> + UINTN Version; >> + // >> + // Callback to override SD/MMC host controller capability bits >> + // >> + SD_MMC_OVERRIDE_CAPABILITY OverrideCapability;How about >> "Capability"? So the caller writes code as > > "SdMmcOverride->Capability()". Sure. >> >> + // >> + // Callback to invoke SD/MMC override hooks // >> + SD_MMC_OVERRIDE_INVOKE_HOOK InvokeHook; > > How about "NotifyPhase"? Sure. >> >> +}; >> + >> +extern EFI_GUID gEdkiiSdMmcOverrideProtocolGuid; >> + >> +#endif >> diff --git a/MdeModulePkg/MdeModulePkg.dec=20 >> b/MdeModulePkg/MdeModulePkg.dec index 856d67aceb21..64ceea029f94=20 >> 100644 >> --- a/MdeModulePkg/MdeModulePkg.dec >> +++ b/MdeModulePkg/MdeModulePkg.dec >> @@ -562,6 +562,9 @@ [Protocols] >> ## Include/Protocol/SmmMemoryAttribute.h >> gEdkiiSmmMemoryAttributeProtocolGuid =3D { 0x69b792ea, 0x39ce,=20 >> 0x402d, { 0xa2, 0xa6, 0xf7, 0x21, 0xde, 0x35, 0x1d, 0xfe } } >> + ## Include/Protocol/SdMmcOverride.h >> + gEdkiiSdMmcOverrideProtocolGuid =3D { 0xeaf9e3c1, 0xc9cd, 0x46db, {=20 >> + 0xa5, >> 0xe5, 0x5a, 0x12, 0x4c, 0x83, 0x23, 0x23 } } >> + >> # >> # [Error.gEfiMdeModulePkgTokenSpaceGuid] >> # 0x80000001 | Invalid value provided. >> > > > -- > Thanks, > Ray _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel