Re: [PATCH v2 01/12] MdeModulePkg: Add definitions for ATA AHCI host controller PPI

["Ni, Ray" <ray.ni@intel.com>]

Reviewed-by: Ray Ni <ray.ni@intel.com>

> -----Original Message-----
> From: Wu, Hao A <hao.a.wu@intel.com>
> Sent: Thursday, January 31, 2019 10:49 AM
> To: edk2-devel@lists.01.org
> Cc: Wu, Hao A <hao.a.wu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>;
> Ni, Ray <ray.ni@intel.com>; Dong, Eric <eric.dong@intel.com>
> Subject: [PATCH v2 01/12] MdeModulePkg: Add definitions for ATA AHCI
> host controller PPI
> 
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=1409
> 
> This commit will add the definitions for ATA AHCI host controller PPI. The
> purpose of the PPI in to provide:
> 
> * MMIO base address
> * Controller identification information (DevicePath)
> 
> for ATA host controllers working under AHCI mode.
> 
> Cc: Jian J Wang <jian.j.wang@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Eric Dong <eric.dong@intel.com>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Hao Wu <hao.a.wu@intel.com>
> ---
>  MdeModulePkg/MdeModulePkg.dec                |  3 +
>  MdeModulePkg/Include/Ppi/AtaAhciController.h | 89
> ++++++++++++++++++++
>  2 files changed, 92 insertions(+)
> 
> diff --git a/MdeModulePkg/MdeModulePkg.dec
> b/MdeModulePkg/MdeModulePkg.dec index e5c32d15ed..4411185073
> 100644
> --- a/MdeModulePkg/MdeModulePkg.dec
> +++ b/MdeModulePkg/MdeModulePkg.dec
> @@ -480,6 +480,9 @@
>    ## Include/Ppi/NvmExpressHostController.h
>    gEdkiiPeiNvmExpressHostControllerPpiGuid  = { 0xcae3aa63, 0x676f, 0x4da3,
> { 0xbd, 0x50, 0x6c, 0xc5, 0xed, 0xde, 0x9a, 0xad } }
> 
> +  ## Include/Ppi/AtaAhciController.h
> +  gEdkiiPeiAtaAhciHostControllerPpiGuid     = { 0x61dd33ea, 0x421f, 0x4cc0,
> { 0x89, 0x29, 0xff, 0xee, 0xa9, 0xa1, 0xa2, 0x61 } }
> +
>  [Protocols]
>    ## Load File protocol provides capability to load and unload EFI image into
> memory and execute it.
>    #  Include/Protocol/LoadPe32Image.h
> diff --git a/MdeModulePkg/Include/Ppi/AtaAhciController.h
> b/MdeModulePkg/Include/Ppi/AtaAhciController.h
> new file mode 100644
> index 0000000000..2bdd53ff36
> --- /dev/null
> +++ b/MdeModulePkg/Include/Ppi/AtaAhciController.h
> @@ -0,0 +1,89 @@
> +/** @file
> +
> +  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>  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_ATA_AHCI_HOST_CONTROLLER_PPI_H_
> +#define _EDKII_ATA_AHCI_HOST_CONTROLLER_PPI_H_
> +
> +#include <Protocol/DevicePath.h>
> +
> +///
> +/// Global ID for the EDKII_ATA_AHCI_HOST_CONTROLLER_PPI.
> +///
> +#define EDKII_ATA_AHCI_HOST_CONTROLLER_PPI_GUID \
> +  { \
> +    0x61dd33ea, 0x421f, 0x4cc0, { 0x89, 0x29, 0xff, 0xee, 0xa9, 0xa1,
> +0xa2, 0x61 } \
> +  }
> +
> +//
> +// Forward declaration for the EDKII_ATA_AHCI_HOST_CONTROLLER_PPI.
> +//
> +typedef struct _EDKII_ATA_AHCI_HOST_CONTROLLER_PPI
> +EDKII_ATA_AHCI_HOST_CONTROLLER_PPI;
> +
> +/**
> +  Get the MMIO base address of ATA AHCI host controller.
> +
> +  @param[in]  This                 The PPI instance pointer.
> +  @param[in]  ControllerId         The ID of the ATA AHCI host controller.
> +  @param[out] MmioBar              The MMIO base address of the controller.
> +
> +  @retval EFI_SUCCESS              The operation succeeds.
> +  @retval EFI_INVALID_PARAMETER    The parameters are invalid.
> +  @retval EFI_NOT_FOUND            The specified ATA AHCI host controller not
> found.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI *EDKII_ATA_AHCI_HC_GET_MMIO_BAR) (
> +  IN  EDKII_ATA_AHCI_HOST_CONTROLLER_PPI    *This,
> +  IN  UINT8                                 ControllerId,
> +  OUT UINTN                                 *MmioBar
> +  );
> +
> +/**
> +  Get the device path of ATA AHCI host controller.
> +
> +  @param[in]  This                 The PPI instance pointer.
> +  @param[in]  ControllerId         The ID of the ATA AHCI host controller.
> +  @param[out] DevicePathLength     The length of the device path in bytes
> specified
> +                                   by DevicePath.
> +  @param[out] DevicePath           The device path of ATA AHCI host controller.
> +                                   This field re-uses EFI Device Path Protocol as
> +                                   defined by Section 10.2 EFI Device Path 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 ATA AHCI host controller not
> found.
> +  @retval EFI_OUT_OF_RESOURCES     The operation fails due to lack of
> resources.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI *EDKII_ATA_AHCI_HC_GET_DEVICE_PATH) (
> +  IN  EDKII_ATA_AHCI_HOST_CONTROLLER_PPI    *This,
> +  IN  UINT8                                 ControllerId,
> +  OUT UINTN                                 *DevicePathLength,
> +  OUT EFI_DEVICE_PATH_PROTOCOL              **DevicePath
> +  );
> +
> +//
> +// This PPI contains a set of services to interact with the ATA AHCI host
> controller.
> +//
> +struct _EDKII_ATA_AHCI_HOST_CONTROLLER_PPI {
> +  EDKII_ATA_AHCI_HC_GET_MMIO_BAR       GetAhciHcMmioBar;
> +  EDKII_ATA_AHCI_HC_GET_DEVICE_PATH    GetAhciHcDevicePath;
> +};
> +
> +extern EFI_GUID gEdkiiPeiAtaAhciHostControllerPpiGuid;
> +
> +#endif
> --
> 2.12.0.windows.1