From patchwork Tue Dec 5 18:01:51 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ard Biesheuvel X-Patchwork-Id: 120732 Delivered-To: patch@linaro.org Received: by 10.140.22.227 with SMTP id 90csp6059086qgn; Tue, 5 Dec 2017 10:02:12 -0800 (PST) X-Google-Smtp-Source: AGs4zMamfP1qO5d8Xul704ZNuWSevULv864snR3mH4t9o0Ey1VCglXlE77P/ewKvV6YWh+N1a1CF X-Received: by 10.159.240.138 with SMTP id p10mr19027748plr.360.1512496932555; Tue, 05 Dec 2017 10:02:12 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1512496932; cv=none; d=google.com; s=arc-20160816; b=cL/FsClpUn/fZzk05DYwb+erS7CMHZCcUs+Hd7jFgFsx2blIC0tC9ZT4tRhgxCzW05 Ode3opc6820vwLKvrzf06SW4lD17rgC5q/NuXdq3Z63sJCrMlTC5pudEDD/1ZQI48/ay 0pZKTr5EWB7lJsKd0uHQnudT4Zy0xnAvF1GkUlkSmwLg0Ak38nWsbVHKar9eiVlRInhK nji/vf3Wj+Tu22gx17iOkaP8P1t3a0aKy5O+eOZ1DGR/NrfBrdljlxvkbVRsNaTHSl/F vnMk5CulFZfsaaNJbNdouyFKOT17py8D3KyIyRtNk0d1EvcEL1jdKmNMf6ijo9NkCSAw eUNA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:mime-version:cc :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:references:in-reply-to:message-id:date :to:from:dkim-signature:delivered-to:arc-authentication-results; bh=7xhYX+Tnt1hfZnHPirOIFQRdo2+KijTvnv6Ky3YcDSQ=; b=qLrUvHwySaLgc1Px/z81NvfDJlR4teQ8FrxjF7Njwh+VOHTE+tBzAkQQUTPaAf04ty 67mNwdDGqn/GiMadn8BhgkuvyxxPZE3vl2nmLHBZ0kq1pJtP9AVASymX1Inhc2Vq1+ff xVNMnQv9HucKUodFh3Bc3RI8k33LGuWal+RAJkonHIC3s9xZ/dydNAMaZLOFB5ejcKev exXkyDsuHyD6nRKMYyHCNlfV7bs0TZKuozXGMPdUtNK/s0lmRW946Kot8lA9va70BRYI dE3QwnLDnt3wqOQjxCNBfjBuCpRCKu9dV0228ThuLtVp/IfL1abAHJDXy1KdAYSRoDbi 6MgQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=JqXERkg6; spf=pass (google.com: best guess record for domain of edk2-devel-bounces@lists.01.org designates 198.145.21.10 as permitted sender) smtp.mailfrom=edk2-devel-bounces@lists.01.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from ml01.01.org (ml01.01.org. [198.145.21.10]) by mx.google.com with ESMTPS id e17si423275pfi.388.2017.12.05.10.02.12 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Dec 2017 10:02:12 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of edk2-devel-bounces@lists.01.org designates 198.145.21.10 as permitted sender) client-ip=198.145.21.10; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@linaro.org header.s=google header.b=JqXERkg6; spf=pass (google.com: best guess record for domain of edk2-devel-bounces@lists.01.org designates 198.145.21.10 as permitted sender) smtp.mailfrom=edk2-devel-bounces@lists.01.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id D13D12218E929; Tue, 5 Dec 2017 09:57:40 -0800 (PST) X-Original-To: edk2-devel@lists.01.org Delivered-To: edk2-devel@lists.01.org Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=2a00:1450:400c:c09::242; helo=mail-wm0-x242.google.com; envelope-from=ard.biesheuvel@linaro.org; receiver=edk2-devel@lists.01.org Received: from mail-wm0-x242.google.com (mail-wm0-x242.google.com [IPv6:2a00:1450:400c:c09::242]) (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 C0DD52218E927 for ; Tue, 5 Dec 2017 09:57:39 -0800 (PST) Received: by mail-wm0-x242.google.com with SMTP id b76so2899768wmg.1 for ; Tue, 05 Dec 2017 10:02:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=dWGL6+QS1pmmbfqcFbLU7Soc1msmLD34XikGSk7VznE=; b=JqXERkg6za9OK+igwviyridXbZVrCvfNAH9ctQrvNkm+O9kzK+7sYWDjAv6hnsAM1v 9uUCYHidwWIPe+dCoTgC51IBziVTDM6uPkK2863P197o0Wg8G2T5zHJZh0WENd/2egZ2 87UzeWiVa2Kgz5XRulvUq+/96GSptQDOJMsfs= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=dWGL6+QS1pmmbfqcFbLU7Soc1msmLD34XikGSk7VznE=; b=r+9maB3WiIJZbV28hqfhqaV6GRA0tSWMRJ2jZG0ftx3C67uyTeadvWSZMJSMleAAef kYSQI0B2XxG7DE2k3x3S3tUAlz6YDlPr/DgZIjAifPIHKKmBoD6b14+7/3A1wlkaeqmn ilGr+71RgsqdMjgWaUpYKgmBDqOj8631WfAowIFUzYwUqY3+9x9l5gK/pUMrCOIWxKt0 9HsunztdreqtvGMjT2Q0t9f6J5RiSqp9qbHDnil29/gexfgE+iAImFJpSr7XDnbHj+aC mRNPEjK2tzTHtlWYkXkwX750DyEyf4GFLJK1K7cce9fy8BGpx4KOu1SVMPa1Du9jU98u iT5w== X-Gm-Message-State: AKGB3mKuS26J/RZ1opYKlV2+jiYL7rWSiapRUGxE+oG8T5LToSQ8vcBi tZb8HDp3WIImubQs4jrXxoqnwbTyZYY= X-Received: by 10.28.18.145 with SMTP id 139mr6619904wms.43.1512496929242; Tue, 05 Dec 2017 10:02:09 -0800 (PST) Received: from localhost.localdomain ([105.150.171.234]) by smtp.gmail.com with ESMTPSA id 43sm735403wru.81.2017.12.05.10.02.06 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Dec 2017 10:02:08 -0800 (PST) From: Ard Biesheuvel To: edk2-devel@lists.01.org Date: Tue, 5 Dec 2017 18:01:51 +0000 Message-Id: <20171205180152.15758-2-ard.biesheuvel@linaro.org> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20171205180152.15758-1-ard.biesheuvel@linaro.org> References: <20171205180152.15758-1-ard.biesheuvel@linaro.org> Subject: [edk2] [PATCH v3 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: , Cc: ruiyu.ni@intel.com, feng.tian@intel.com, Ard Biesheuvel , hao.a.wu@intel.com, leif.lindholm@linaro.org, michael.d.kinney@intel.com, star.zeng@intel.com MIME-Version: 1.0 Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" 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(+) -- 2.11.0 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel diff --git a/MdeModulePkg/Include/Protocol/SdMmcOverride.h b/MdeModulePkg/Include/Protocol/SdMmcOverride.h new file mode 100644 index 000000000000..af57988f5625 --- /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 _EDKII_SD_MMC_OVERRIDE EDKII_SD_MMC_OVERRIDE; + +typedef enum { + EdkiiSdMmcResetPre, + EdkiiSdMmcResetPost, + EdkiiSdMmcInitHostPre, + EdkiiSdMmcInitHostPost, +} EDKII_SD_MMC_PHASE_TYPE; + +/** + + 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 * EDKII_SD_MMC_CAPABILITY) ( + IN EFI_SD_MMC_PASS_THRU_PROTOCOL *PassThru, + IN EFI_HANDLE ControllerHandle, + IN UINT8 Slot, + IN OUT UINT64 *SdMmcHcSlotCapability + ); + +/** + + 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] PhaseType 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 * EDKII_SD_MMC_NOTIFY_PHASE) ( + IN EFI_SD_MMC_PASS_THRU_PROTOCOL *PassThru, + IN EFI_HANDLE ControllerHandle, + IN UINT8 Slot, + IN EDKII_SD_MMC_PHASE_TYPE PhaseType + ); + +struct _EDKII_SD_MMC_OVERRIDE { + // + // Protocol version of this implementation + // + UINTN Version; + // + // Callback to override SD/MMC host controller capability bits + // + EDKII_SD_MMC_CAPABILITY Capability; + // + // Callback to invoke SD/MMC override hooks + // + EDKII_SD_MMC_NOTIFY_PHASE NotifyPhase; +}; + +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.