MdeModulePkg: Clean up source files

[mirror_edk2.git] / MdeModulePkg / Core / Pei / PciCfg2 / PciCfg2.c

/** @file\r
  The default version of EFI_PEI_PCI_CFG2_PPI support published by PeiServices in\r
  PeiCore initialization phase.\r
\r
  EFI_PEI_PCI_CFG2_PPI is installed by the PEIM which supports a PCI root bridge.\r
  When PeiCore is started, the default version of EFI_PEI_PCI_CFG2_PPI will be assigned\r
  to PeiServices table.\r
\r
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "PeiMain.h"\r
\r
///\r
/// This default instance of EFI_PEI_PCI_CFG2_PPI install assigned to EFI_PEI_SERVICE.PciCfg\r
/// when PeiCore's initialization.\r
///\r
EFI_PEI_PCI_CFG2_PPI gPeiDefaultPciCfg2Ppi = {\r
  PeiDefaultPciCfg2Read,\r
  PeiDefaultPciCfg2Write,\r
  PeiDefaultPciCfg2Modify\r
};\r
\r
/**\r
  Reads from a given location in the PCI configuration space.\r
\r
  If the EFI_PEI_PCI_CFG2_PPI is not installed by platform/chipset PEIM, then\r
  return EFI_NOT_YET_AVAILABLE.\r
\r
  @param  PeiServices     An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
  @param  This            Pointer to local data for the interface.\r
  @param  Width           The width of the access. Enumerated in bytes.\r
                          See EFI_PEI_PCI_CFG_PPI_WIDTH above.\r
  @param  Address         The physical address of the access. The format of\r
                          the address is described by EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS.\r
  @param  Buffer          A pointer to the buffer of data.\r
\r
  @retval EFI_SUCCESS           The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER The invalid access width.\r
  @retval EFI_NOT_YET_AVAILABLE If the EFI_PEI_PCI_CFG2_PPI is not installed by platform/chipset PEIM.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiDefaultPciCfg2Read (\r
  IN CONST  EFI_PEI_SERVICES          **PeiServices,\r
  IN CONST  EFI_PEI_PCI_CFG2_PPI      *This,\r
  IN        EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
  IN        UINT64                    Address,\r
  IN OUT    VOID                      *Buffer\r
  )\r
{\r
  return EFI_NOT_AVAILABLE_YET;\r
}\r
\r
/**\r
  Write to a given location in the PCI configuration space.\r
\r
  If the EFI_PEI_PCI_CFG2_PPI is not installed by platform/chipset PEIM, then\r
  return EFI_NOT_YET_AVAILABLE.\r
\r
  @param  PeiServices     An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
  @param  This            Pointer to local data for the interface.\r
  @param  Width           The width of the access. Enumerated in bytes.\r
                          See EFI_PEI_PCI_CFG_PPI_WIDTH above.\r
  @param  Address         The physical address of the access. The format of\r
                          the address is described by EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS.\r
  @param  Buffer          A pointer to the buffer of data.\r
\r
  @retval EFI_SUCCESS           The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER The invalid access width.\r
  @retval EFI_NOT_YET_AVAILABLE If the EFI_PEI_PCI_CFG2_PPI is not installed by platform/chipset PEIM.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiDefaultPciCfg2Write (\r
  IN CONST  EFI_PEI_SERVICES          **PeiServices,\r
  IN CONST  EFI_PEI_PCI_CFG2_PPI      *This,\r
  IN        EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
  IN        UINT64                    Address,\r
  IN OUT    VOID                      *Buffer\r
  )\r
{\r
  return EFI_NOT_AVAILABLE_YET;\r
}\r
\r
/**\r
  This function performs a read-modify-write operation on the contents from a given\r
  location in the PCI configuration space.\r
  If the EFI_PEI_PCI_CFG2_PPI is not installed by platform/chipset PEIM, then\r
  return EFI_NOT_YET_AVAILABLE.\r
\r
  @param  PeiServices     An indirect pointer to the PEI Services Table\r
                          published by the PEI Foundation.\r
  @param  This            Pointer to local data for the interface.\r
  @param  Width           The width of the access. Enumerated in bytes. Type\r
                          EFI_PEI_PCI_CFG_PPI_WIDTH is defined in Read().\r
  @param  Address         The physical address of the access.\r
  @param  SetBits         Points to value to bitwise-OR with the read configuration value.\r
                          The size of the value is determined by Width.\r
  @param  ClearBits       Points to the value to negate and bitwise-AND with the read configuration value.\r
                          The size of the value is determined by Width.\r
\r
  @retval EFI_SUCCESS           The function completed successfully.\r
  @retval EFI_INVALID_PARAMETER The invalid access width.\r
  @retval EFI_NOT_YET_AVAILABLE If the EFI_PEI_PCI_CFG2_PPI is not installed by platform/chipset PEIM.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiDefaultPciCfg2Modify (\r
  IN CONST  EFI_PEI_SERVICES          **PeiServices,\r
  IN CONST  EFI_PEI_PCI_CFG2_PPI      *This,\r
  IN        EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
  IN        UINT64                    Address,\r
  IN        VOID                      *SetBits,\r
  IN        VOID                      *ClearBits\r
  )\r
{\r
  return EFI_NOT_AVAILABLE_YET;\r
}\r