MdeModulePkg/Include/Ppi/SdMmcHostController.h

   1 /** @file
   2
   3 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
   4
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions
   7 of the BSD License which accompanies this distribution.  The
   8 full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _EDKII_PEI_SD_MMC_HOST_CONTROLLER_PPI_H_
  17 #define _EDKII_PEI_SD_MMC_HOST_CONTROLLER_PPI_H_
  18
  19 ///
  20 /// Global ID for the EDKII_SD_MMC_HOST_CONTROLLER_PPI.
  21 ///
  22 #define EDKII_SD_MMC_HOST_CONTROLLER_PPI_GUID \
  23   { \
  24     0xb30dfeed, 0x947f, 0x4396, { 0xb1, 0x5a, 0xdf, 0xbd, 0xb9, 0x16, 0xdc, 0x24 } \
  25   }
  26
  27 ///
  28 /// Forward declaration for the SD_MMC_HOST_CONTROLLER_PPI.
  29 ///
  30 typedef struct _EDKII_SD_MMC_HOST_CONTROLLER_PPI  EDKII_SD_MMC_HOST_CONTROLLER_PPI;
  31
  32 /**
  33   Get the MMIO base address of SD/MMC host controller.
  34
  35   @param[in]     This            The protocol instance pointer.
  36   @param[in]     ControllerId    The ID of the SD/MMC host controller.
  37   @param[in,out] MmioBar         The pointer to store the array of available
  38                                  SD/MMC host controller slot MMIO base addresses.
  39                                  The entry number of the array is specified by BarNum.
  40   @param[out]    BarNum          The pointer to store the supported bar number.
  41
  42   @retval EFI_SUCCESS            The operation succeeds.
  43   @retval EFI_INVALID_PARAMETER  The parameters are invalid.
  44
  45 **/
  46 typedef
  47 EFI_STATUS
  48 (EFIAPI *EDKII_SD_MMC_HC_GET_MMIO_BAR)(
  49   IN     EDKII_SD_MMC_HOST_CONTROLLER_PPI *This,
  50   IN     UINT8                            ControllerId,
  51   IN OUT UINTN                            **MmioBar,
  52      OUT UINT8                            *BarNum
  53   );
  54
  55 ///
  56 /// This PPI contains a set of services to interact with the SD_MMC host controller.
  57 ///
  58 struct _EDKII_SD_MMC_HOST_CONTROLLER_PPI {
  59   EDKII_SD_MMC_HC_GET_MMIO_BAR               GetSdMmcHcMmioBar;
  60 };
  61
  62 extern EFI_GUID gEdkiiPeiSdMmcHostControllerPpiGuid;
  63
  64 #endif