From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2607:f8b0:4001:c0b::244; helo=mail-it0-x244.google.com; envelope-from=ard.biesheuvel@linaro.org; receiver=edk2-devel@lists.01.org Received: from mail-it0-x244.google.com (mail-it0-x244.google.com [IPv6:2607:f8b0:4001:c0b::244]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id C863720356257 for ; Tue, 5 Dec 2017 02:20:05 -0800 (PST) Received: by mail-it0-x244.google.com with SMTP id r6so314382itr.3 for ; Tue, 05 Dec 2017 02:24:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc; bh=4ph4eg23ofskzgr9x+zgl4f2u60MF+pzGCrNsqOZ0i4=; b=bu+qtfqhEUDHi5G3oiKg0UZuH6NlzXCvGQrGa2+O21Rs1bon3yvk7Cd1XvA2drOqAb cAIocl8PBStbB7jBk4nHXF7yGlmsCBoJn8UETnjmGARI0ICWtP3XbPqEuz0brYo8lsWr Gsg45kSX0qf8Lxt4IW6+TyCz1dXzIU914mBMg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc; bh=4ph4eg23ofskzgr9x+zgl4f2u60MF+pzGCrNsqOZ0i4=; b=uLGG9nJ3aDb2gZyFlY7qJuHeGLPomE/XEs5BDV592V9dLYx1YeJF5jY81BkV0c/18X tNEXdeOPKWsAC9i/4jPKYgTBn84tlANjBMeAJW19t2Tr6uMykot5xQwFSnBaFXfcUrqx DK29NSwXbb20EpFlG9ROQCPK5qKUNYgdf1cCDCR+6SolD8A8lHkFH/5O+90HxNStF//8 /nDW5ShJIgjLPL/18MUdfrR+AC+5GQuRHgkQ59tVDyQANpDULgffMfRMTqF1fqknaYKD xEEDlpjR9hsRtdnBvOU9JABmJJl5ypBaWYrT99KKjoZGR5LjJi7Sp3uHK1TPPv/lJGLE MWLQ== X-Gm-Message-State: AKGB3mJ3aN35RqNRmoH/cp986JATfiApWijoyYKLAQFnFhra8k9lpvuB 1SuQHAxGk2zXLt9oRaETA9HdDyvuczZw/6acu2kKpA== X-Google-Smtp-Source: AGs4zMYuuFFE+5DOieTTctzD7gmUDlmA2+X75bH9mvrzDWzZEXjNOwdYyEJpNGntttFVkfZRWx4m3OerRiQ4vA7x3+g= X-Received: by 10.36.78.212 with SMTP id r203mr8738067ita.58.1512469475622; Tue, 05 Dec 2017 02:24:35 -0800 (PST) MIME-Version: 1.0 Received: by 10.107.104.16 with HTTP; Tue, 5 Dec 2017 02:24:35 -0800 (PST) In-Reply-To: References: <20171130101132.18317-1-ard.biesheuvel@linaro.org> <20171130101132.18317-2-ard.biesheuvel@linaro.org> From: Ard Biesheuvel Date: Tue, 5 Dec 2017 10:24:35 +0000 Message-ID: To: "Ni, Ruiyu" Cc: "edk2-devel@lists.01.org" , "Wu, Hao A" , "Tian, Feng" , "Zeng, Star" , Leif Lindholm 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:20:06 -0000 Content-Type: text/plain; charset="UTF-8" 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, >> these implementations deviate in subtle ways from the pertinent >> specifications. On the one hand, these deviations are quite easy >> to work around, but on the other hand, having a collection of SoC >> specific workarounds in the generic driver stack is undesirable. >> >> So let's introduce an optional SD/MMC override protocol that we >> can invoke at the appropriate moments in the device initialization. >> That way, the workaround itself remains platform specific, but we >> can 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 SDHCI >> + implementations >> + >> + Copyright (c) 2017, Linaro, Ltd. 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 __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, 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 potential check points? > Perhaps not, but it is hard to predict the future :-) This is why I added the version field. (I should also update the second patch to reject the protocol 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 >> + EFI_SD_MMC_PASS_THRU_PROTOCOL >> instance. >> + @param[in] ControllerHandle The EFI_HANDLE of the controller. >> + @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 not >> 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 > override as well? > The capability structure is the root data structure that describes the SD/MMC host controller. Which other data structures did you have in mind? >> + >> +/** >> + >> + Override function for SDHCI controller operations >> + >> + @param[in] PassThru A pointer to the >> + EFI_SD_MMC_PASS_THRU_PROTOCOL >> instance. >> + @param[in] ControllerHandle The EFI_HANDLE of the controller. >> + @param[in] Slot The 0 based slot index. >> + @param[in,out] HookType The type of operation and whether >> 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 not >> 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 b/MdeModulePkg/MdeModulePkg.dec >> index 856d67aceb21..64ceea029f94 100644 >> --- a/MdeModulePkg/MdeModulePkg.dec >> +++ b/MdeModulePkg/MdeModulePkg.dec >> @@ -562,6 +562,9 @@ [Protocols] >> ## Include/Protocol/SmmMemoryAttribute.h >> gEdkiiSmmMemoryAttributeProtocolGuid = { 0x69b792ea, 0x39ce, 0x402d, { >> 0xa2, 0xa6, 0xf7, 0x21, 0xde, 0x35, 0x1d, 0xfe } } >> + ## Include/Protocol/SdMmcOverride.h >> + gEdkiiSdMmcOverrideProtocolGuid = { 0xeaf9e3c1, 0xc9cd, 0x46db, { 0xa5, >> 0xe5, 0x5a, 0x12, 0x4c, 0x83, 0x23, 0x23 } } >> + >> # >> # [Error.gEfiMdeModulePkgTokenSpaceGuid] >> # 0x80000001 | Invalid value provided. >> > > > -- > Thanks, > Ray