MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / PciBusDxe / PciRomTable.c

/** @file\r
  Set up ROM Table for PCI Bus module.\r
\r
Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "PciBus.h"\r
\r
//\r
// PCI ROM image information\r
//\r
typedef struct {\r
  EFI_HANDLE  ImageHandle;\r
  UINTN       Seg;\r
  UINT8       Bus;\r
  UINT8       Dev;\r
  UINT8       Func;\r
  VOID        *RomImage;\r
  UINT64      RomSize;\r
} PCI_ROM_IMAGE;\r
\r
UINTN          mNumberOfPciRomImages     = 0;\r
UINTN          mMaxNumberOfPciRomImages  = 0;\r
PCI_ROM_IMAGE  *mRomImageTable           = NULL;\r
\r
/**\r
  Add the Rom Image to internal database for later PCI light enumeration.\r
\r
  @param ImageHandle    Option Rom image handle.\r
  @param Seg            Segment of PCI space.\r
  @param Bus            Bus NO of PCI space.\r
  @param Dev            Dev NO of PCI space.\r
  @param Func           Func NO of PCI space.\r
  @param RomImage       Option Rom buffer.\r
  @param RomSize        Size of Option Rom buffer.\r
**/\r
VOID\r
PciRomAddImageMapping (\r
  IN  EFI_HANDLE  ImageHandle,\r
  IN  UINTN       Seg,\r
  IN  UINT8       Bus,\r
  IN  UINT8       Dev,\r
  IN  UINT8       Func,\r
  IN  VOID        *RomImage,\r
  IN  UINT64      RomSize\r
  )\r
{\r
  UINTN           Index;\r
  PCI_ROM_IMAGE   *NewTable;\r
\r
  for (Index = 0; Index < mNumberOfPciRomImages; Index++) {\r
    if (mRomImageTable[Index].Seg  == Seg &&\r
        mRomImageTable[Index].Bus  == Bus &&\r
        mRomImageTable[Index].Dev  == Dev &&\r
        mRomImageTable[Index].Func == Func) {\r
      //\r
      // Expect once RomImage and RomSize are recorded, they will be passed in\r
      // later when updating ImageHandle\r
      //\r
      ASSERT ((mRomImageTable[Index].RomImage == NULL) || (RomImage == mRomImageTable[Index].RomImage));\r
      ASSERT ((mRomImageTable[Index].RomSize  == 0   ) || (RomSize  == mRomImageTable[Index].RomSize ));\r
      break;\r
    }\r
  }\r
\r
  if (Index == mNumberOfPciRomImages) {\r
    //\r
    // Rom Image Table buffer needs to grow.\r
    //\r
    if (mNumberOfPciRomImages == mMaxNumberOfPciRomImages) {\r
      NewTable = ReallocatePool (\r
                   mMaxNumberOfPciRomImages * sizeof (PCI_ROM_IMAGE),\r
                   (mMaxNumberOfPciRomImages + 0x20) * sizeof (PCI_ROM_IMAGE),\r
                   mRomImageTable\r
                   );\r
      if (NewTable == NULL) {\r
        return ;\r
      }\r
\r
      mRomImageTable            = NewTable;\r
      mMaxNumberOfPciRomImages += 0x20;\r
    }\r
    //\r
    // Record the new PCI device\r
    //\r
    mRomImageTable[Index].Seg  = Seg;\r
    mRomImageTable[Index].Bus  = Bus;\r
    mRomImageTable[Index].Dev  = Dev;\r
    mRomImageTable[Index].Func = Func;\r
    mNumberOfPciRomImages++;\r
  }\r
\r
  mRomImageTable[Index].ImageHandle = ImageHandle;\r
  mRomImageTable[Index].RomImage    = RomImage;\r
  mRomImageTable[Index].RomSize     = RomSize;\r
}\r
\r
/**\r
  Get Option rom driver's mapping for PCI device.\r
\r
  @param PciIoDevice Device instance.\r
\r
  @retval TRUE   Found Image mapping.\r
  @retval FALSE  Cannot found image mapping.\r
\r
**/\r
BOOLEAN\r
PciRomGetImageMapping (\r
  IN  PCI_IO_DEVICE                       *PciIoDevice\r
  )\r
{\r
  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;\r
  UINTN                           Index;\r
\r
  PciRootBridgeIo = PciIoDevice->PciRootBridgeIo;\r
\r
  for (Index = 0; Index < mNumberOfPciRomImages; Index++) {\r
    if (mRomImageTable[Index].Seg  == PciRootBridgeIo->SegmentNumber &&\r
        mRomImageTable[Index].Bus  == PciIoDevice->BusNumber         &&\r
        mRomImageTable[Index].Dev  == PciIoDevice->DeviceNumber      &&\r
        mRomImageTable[Index].Func == PciIoDevice->FunctionNumber    ) {\r
\r
      if (mRomImageTable[Index].ImageHandle != NULL) {\r
        AddDriver (PciIoDevice, mRomImageTable[Index].ImageHandle, NULL);\r
      }\r
      PciIoDevice->PciIo.RomImage = mRomImageTable[Index].RomImage;\r
      PciIoDevice->PciIo.RomSize  = mRomImageTable[Index].RomSize;\r
      return TRUE;\r
    }\r
  }\r
\r
  return FALSE;\r
}\r