public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Leif Lindholm" <leif@nuviainc.com>
To: Ard Biesheuvel <ard.biesheuvel@arm.com>
Cc: devel@edk2.groups.io
Subject: Re: [PATCH] EmbeddedPkg: rename gEfiMmcHostProtocolGuid to gEdkiiMmcHostProtocolGuid
Date: Wed, 29 Apr 2020 21:06:48 +0100	[thread overview]
Message-ID: <20200429200648.GJ21486@vanye> (raw)
In-Reply-To: <20200429182704.8715-1-ard.biesheuvel@arm.com>

On Wed, Apr 29, 2020 at 20:27:04 +0200, Ard Biesheuvel wrote:
> In EDK2, identifiers carrying the EFI prefix are reserved for ones
> that are defined in the UEFI or PI specifications. For protocols that
> are part of the internal EDK2 implementation, we use EDKII instead.
> 
> Since the MMC host protocol defined in EmbeddedPkg is not the one that
> the UEFI spec defines, and given the confusion around this, let's rename
> it to gEdkiiMmcHostProtocolGuid.

1) Yes, please, let's change this.
2) But not s/Efi/Edkii/ please.

We want to get rid of this thing - and the "replacement" in
MdeModulePkg has things called gEdkiiPeiSdMmcHostControllerPpiGuid and
gEdkiiSdMmcOverrideProtocolGuid, so I think this would still be
confusing.

Could we call it plain gEmbeddedPkgMmcHostProtocolGuid or
gEmbeddedMmcHostProtocolGuid instead?

/
    Leif

> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@arm.com>
> ---
>  ArmPlatformPkg/Drivers/PL180MciDxe/PL180Mci.c      |  2 +-
>  ArmPlatformPkg/Drivers/PL180MciDxe/PL180MciDxe.inf |  2 +-
>  EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.c          |  2 +-
>  EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.inf        |  2 +-
>  EmbeddedPkg/EmbeddedPkg.dec                        |  2 +-
>  EmbeddedPkg/Include/Protocol/MmcHost.h             |  4 ++--
>  EmbeddedPkg/Universal/MmcDxe/Mmc.c                 | 10 +++++-----
>  EmbeddedPkg/Universal/MmcDxe/MmcDxe.inf            |  2 +-
>  8 files changed, 13 insertions(+), 13 deletions(-)
> 
> diff --git a/ArmPlatformPkg/Drivers/PL180MciDxe/PL180Mci.c b/ArmPlatformPkg/Drivers/PL180MciDxe/PL180Mci.c
> index 365f78b306fa..0c9e4b7ce15e 100644
> --- a/ArmPlatformPkg/Drivers/PL180MciDxe/PL180Mci.c
> +++ b/ArmPlatformPkg/Drivers/PL180MciDxe/PL180Mci.c
> @@ -554,7 +554,7 @@ PL180MciDxeInitialize (
>    //Publish Component Name, BlockIO protocol interfaces
>    Status = gBS->InstallMultipleProtocolInterfaces (
>                    &Handle,
> -                  &gEfiMmcHostProtocolGuid,         &gMciHost,
> +                  &gEdkiiMmcHostProtocolGuid,       &gMciHost,
>                    NULL
>                    );
>    ASSERT_EFI_ERROR (Status);
> diff --git a/ArmPlatformPkg/Drivers/PL180MciDxe/PL180MciDxe.inf b/ArmPlatformPkg/Drivers/PL180MciDxe/PL180MciDxe.inf
> index c70377bc7cfa..2c7272c87a59 100644
> --- a/ArmPlatformPkg/Drivers/PL180MciDxe/PL180MciDxe.inf
> +++ b/ArmPlatformPkg/Drivers/PL180MciDxe/PL180MciDxe.inf
> @@ -36,7 +36,7 @@ [LibraryClasses]
>  [Protocols]
>    gEfiCpuArchProtocolGuid
>    gEfiDevicePathProtocolGuid
> -  gEfiMmcHostProtocolGuid
> +  gEdkiiMmcHostProtocolGuid
>  
>  [Pcd]
>    gArmPlatformTokenSpaceGuid.PcdPL180SysMciRegAddress
> diff --git a/EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.c b/EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.c
> index 68c523a99f14..47b36e2e8656 100644
> --- a/EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.c
> +++ b/EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.c
> @@ -679,7 +679,7 @@ DwEmmcDxeInitialize (
>    //Publish Component Name, BlockIO protocol interfaces
>    Status = gBS->InstallMultipleProtocolInterfaces (
>                    &Handle,
> -                  &gEfiMmcHostProtocolGuid,         &gMciHost,
> +                  &gEdkiiMmcHostProtocolGuid,       &gMciHost,
>                    NULL
>                    );
>    ASSERT_EFI_ERROR (Status);
> diff --git a/EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.inf b/EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.inf
> index 21c372c5b200..f56e1beb0653 100644
> --- a/EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.inf
> +++ b/EmbeddedPkg/Drivers/DwEmmcDxe/DwEmmcDxe.inf
> @@ -37,7 +37,7 @@ [LibraryClasses]
>  [Protocols]
>    gEfiCpuArchProtocolGuid
>    gEfiDevicePathProtocolGuid
> -  gEfiMmcHostProtocolGuid
> +  gEdkiiMmcHostProtocolGuid
>  
>  [Pcd]
>    gEmbeddedTokenSpaceGuid.PcdDwEmmcDxeBaseAddress
> diff --git a/EmbeddedPkg/EmbeddedPkg.dec b/EmbeddedPkg/EmbeddedPkg.dec
> index 69922802f473..20fed5441684 100644
> --- a/EmbeddedPkg/EmbeddedPkg.dec
> +++ b/EmbeddedPkg/EmbeddedPkg.dec
> @@ -71,7 +71,7 @@ [Protocols.common]
>    gEmbeddedExternalDeviceProtocolGuid = { 0x735F8C64, 0xD696, 0x44D0, { 0xBD, 0xF2, 0x44, 0x7F, 0xD0, 0x5A, 0x54, 0x06 }}
>    gEmbeddedGpioProtocolGuid           = { 0x17a0a3d7, 0xc0a5, 0x4635, { 0xbb, 0xd5, 0x07, 0x21, 0x87, 0xdf, 0xe2, 0xee }}
>    gPeCoffLoaderProtocolGuid =  { 0xB323179B, 0x97FB, 0x477E, { 0xB0, 0xFE, 0xD8, 0x85, 0x91, 0xFA, 0x11, 0xAB } }
> -  gEfiMmcHostProtocolGuid              = { 0x3e591c00, 0x9e4a, 0x11df, {0x92, 0x44, 0x00, 0x02, 0xA5, 0xD5, 0xC5, 0x1B }}
> +  gEdkiiMmcHostProtocolGuid            = { 0x3e591c00, 0x9e4a, 0x11df, {0x92, 0x44, 0x00, 0x02, 0xA5, 0xD5, 0xC5, 0x1B }}
>    gAndroidFastbootTransportProtocolGuid = { 0x74bd9fe0, 0x8902, 0x11e3, {0xb9, 0xd3, 0xf7, 0x22, 0x38, 0xfc, 0x9a, 0x31}}
>    gAndroidFastbootPlatformProtocolGuid =  { 0x524685a0, 0x89a0, 0x11e3, {0x9d, 0x4d, 0xbf, 0xa9, 0xf6, 0xa4, 0x03, 0x08}}
>    gUsbDeviceProtocolGuid =  { 0x021bd2ca, 0x51d2, 0x11e3, {0x8e, 0x56, 0xb7, 0x54, 0x17, 0xc7,  0x0b, 0x44 }}
> diff --git a/EmbeddedPkg/Include/Protocol/MmcHost.h b/EmbeddedPkg/Include/Protocol/MmcHost.h
> index 9e070826805b..ef4aa2f65e75 100644
> --- a/EmbeddedPkg/Include/Protocol/MmcHost.h
> +++ b/EmbeddedPkg/Include/Protocol/MmcHost.h
> @@ -13,7 +13,7 @@
>  ///
>  /// Global ID for the MMC Host Protocol
>  ///
> -#define EFI_MMC_HOST_PROTOCOL_GUID \
> +#define EDKII_MMC_HOST_PROTOCOL_GUID \
>    { 0x3e591c00, 0x9e4a, 0x11df, {0x92, 0x44, 0x00, 0x02, 0xA5, 0xD5, 0xC5, 0x1B } }
>  
>  #define MMC_RESPONSE_TYPE_R1        0
> @@ -178,7 +178,7 @@ struct _EFI_MMC_HOST_PROTOCOL {
>  #define MMC_HOST_HAS_ISMULTIBLOCK(Host) (Host->Revision >= MMC_HOST_PROTOCOL_REVISION && \
>                                           Host->IsMultiBlock != NULL)
>  
> -extern EFI_GUID gEfiMmcHostProtocolGuid;
> +extern EFI_GUID gEdkiiMmcHostProtocolGuid;
>  
>  #endif
>  
> diff --git a/EmbeddedPkg/Universal/MmcDxe/Mmc.c b/EmbeddedPkg/Universal/MmcDxe/Mmc.c
> index c6170880debd..0088e27b9998 100644
> --- a/EmbeddedPkg/Universal/MmcDxe/Mmc.c
> +++ b/EmbeddedPkg/Universal/MmcDxe/Mmc.c
> @@ -216,7 +216,7 @@ MmcDriverBindingSupported (
>    //
>    Status = gBS->OpenProtocol (
>                  Controller,
> -                &gEfiMmcHostProtocolGuid,
> +                &gEdkiiMmcHostProtocolGuid,
>                  (VOID **) &MmcHost,
>                  This->DriverBindingHandle,
>                  Controller,
> @@ -234,7 +234,7 @@ MmcDriverBindingSupported (
>    //
>    gBS->CloseProtocol (
>        Controller,
> -      &gEfiMmcHostProtocolGuid,
> +      &gEdkiiMmcHostProtocolGuid,
>        This->DriverBindingHandle,
>        Controller
>        );
> @@ -275,7 +275,7 @@ MmcDriverBindingStart (
>    //
>    Status = gBS->OpenProtocol (
>                  Controller,
> -                &gEfiMmcHostProtocolGuid,
> +                &gEdkiiMmcHostProtocolGuid,
>                  (VOID **) &MmcHost,
>                  This->DriverBindingHandle,
>                  Controller,
> @@ -326,10 +326,10 @@ MmcDriverBindingStop (
>      MmcHostInstance = MMC_HOST_INSTANCE_FROM_LINK(CurrentLink);
>      ASSERT(MmcHostInstance != NULL);
>  
> -    // Close gEfiMmcHostProtocolGuid
> +    // Close gEdkiiMmcHostProtocolGuid
>      Status = gBS->CloseProtocol (
>                  Controller,
> -                &gEfiMmcHostProtocolGuid,
> +                &gEdkiiMmcHostProtocolGuid,
>                  This->DriverBindingHandle,
>                  Controller
>                  );
> diff --git a/EmbeddedPkg/Universal/MmcDxe/MmcDxe.inf b/EmbeddedPkg/Universal/MmcDxe/MmcDxe.inf
> index 67cdce6c5b4d..ea1410f839ee 100644
> --- a/EmbeddedPkg/Universal/MmcDxe/MmcDxe.inf
> +++ b/EmbeddedPkg/Universal/MmcDxe/MmcDxe.inf
> @@ -38,7 +38,7 @@ [Protocols]
>    gEfiDiskIoProtocolGuid
>    gEfiBlockIoProtocolGuid
>    gEfiDevicePathProtocolGuid
> -  gEfiMmcHostProtocolGuid
> +  gEdkiiMmcHostProtocolGuid
>    gEfiDriverDiagnostics2ProtocolGuid
>  
>  [Depex]
> -- 
> 2.17.1
> 

  reply	other threads:[~2020-04-29 20:06 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-29 18:27 [PATCH] EmbeddedPkg: rename gEfiMmcHostProtocolGuid to gEdkiiMmcHostProtocolGuid Ard Biesheuvel
2020-04-29 20:06 ` Leif Lindholm [this message]
2020-04-29 21:27   ` Ard Biesheuvel
2020-04-29 21:34     ` Leif Lindholm
2020-04-30  8:12       ` Ard Biesheuvel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200429200648.GJ21486@vanye \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox