MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / UfsPciHcPei / UfsPciHcPei.h

/** @file\r
  Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _UFS_PCI_HOST_CONTROLLER_PEI_H_\r
#define _UFS_PCI_HOST_CONTROLLER_PEI_H_\r
\r
#include <PiPei.h>\r
\r
#include <Ppi/MasterBootMode.h>\r
#include <Ppi/UfsHostController.h>\r
\r
#include <IndustryStandard/Pci.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/PciLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
\r
#define UFS_HC_PEI_SIGNATURE    SIGNATURE_32 ('U', 'F', 'S', 'P')\r
#define MAX_UFS_HCS             8\r
\r
typedef struct {\r
  UINTN                         Signature;\r
  EDKII_UFS_HOST_CONTROLLER_PPI UfsHostControllerPpi;\r
  EFI_PEI_PPI_DESCRIPTOR        PpiList;\r
  UINTN                         TotalUfsHcs;\r
  UINTN                         UfsHcPciAddr[MAX_UFS_HCS];\r
} UFS_HC_PEI_PRIVATE_DATA;\r
\r
#define UFS_HC_PEI_PRIVATE_DATA_FROM_THIS(a)  CR (a, UFS_HC_PEI_PRIVATE_DATA, UfsHostControllerPpi, UFS_HC_PEI_SIGNATURE)\r
\r
/**\r
  Get the MMIO base address of UFS host controller.\r
\r
  @param[in]  This               The protocol instance pointer.\r
  @param[in]  ControllerId       The ID of the UFS host controller.\r
  @param[out] MmioBar            Pointer to the UFS host controller MMIO base address.\r
\r
  @retval EFI_SUCCESS            The operation succeeds.\r
  @retval EFI_INVALID_PARAMETER  The parameters are invalid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetUfsHcMmioBar (\r
  IN     EDKII_UFS_HOST_CONTROLLER_PPI *This,\r
  IN     UINT8                         ControllerId,\r
     OUT UINTN                         *MmioBar\r
  );\r
\r
#endif\r