Correct all header files for doxygen format and correct the license issue for VgaClas...

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

/**@file\r
  Option Rom Support for PCI Bus Driver\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. 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 "pcibus.h"\r
#include "PciRomTable.h"\r
\r
typedef struct {\r
  EFI_HANDLE  ImageHandle;\r
  UINTN       Seg;\r
  UINT8       Bus;\r
  UINT8       Dev;\r
  UINT8       Func;\r
  UINT64      RomAddress;\r
  UINT64      RomLength;\r
} EFI_PCI_ROM_IMAGE_MAPPING;\r
\r
static UINTN                      mNumberOfPciRomImages     = 0;\r
static UINTN                      mMaxNumberOfPciRomImages  = 0;\r
static EFI_PCI_ROM_IMAGE_MAPPING  *mRomImageTable           = NULL;\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 UINT64      RomAddress,\r
  IN UINT64      RomLength\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  TODO: Add function description\r
\r
Arguments:\r
\r
  ImageHandle - TODO: add argument description\r
  Seg         - TODO: add argument description\r
  Bus         - TODO: add argument description\r
  Dev         - TODO: add argument description\r
  Func        - TODO: add argument description\r
  RomAddress  - TODO: add argument description\r
  RomLength   - TODO: add argument description\r
\r
Returns:\r
\r
  TODO: add return values\r
\r
--*/\r
{\r
  EFI_PCI_ROM_IMAGE_MAPPING *TempMapping;\r
\r
  if (mNumberOfPciRomImages >= mMaxNumberOfPciRomImages) {\r
\r
    mMaxNumberOfPciRomImages += 0x20;\r
\r
    TempMapping = NULL;\r
    TempMapping = AllocatePool (mMaxNumberOfPciRomImages * sizeof (EFI_PCI_ROM_IMAGE_MAPPING));\r
    if (TempMapping == NULL) {\r
      return ;\r
    }\r
\r
    CopyMem (TempMapping, mRomImageTable, mNumberOfPciRomImages * sizeof (EFI_PCI_ROM_IMAGE_MAPPING));\r
\r
    if (mRomImageTable != NULL) {\r
      gBS->FreePool (mRomImageTable);\r
    }\r
\r
    mRomImageTable = TempMapping;\r
  }\r
\r
  mRomImageTable[mNumberOfPciRomImages].ImageHandle = ImageHandle;\r
  mRomImageTable[mNumberOfPciRomImages].Seg         = Seg;\r
  mRomImageTable[mNumberOfPciRomImages].Bus         = Bus;\r
  mRomImageTable[mNumberOfPciRomImages].Dev         = Dev;\r
  mRomImageTable[mNumberOfPciRomImages].Func        = Func;\r
  mRomImageTable[mNumberOfPciRomImages].RomAddress  = RomAddress;\r
  mRomImageTable[mNumberOfPciRomImages].RomLength   = RomLength;\r
  mNumberOfPciRomImages++;\r
}\r
\r
EFI_STATUS\r
PciRomGetRomResourceFromPciOptionRomTable (\r
  IN EFI_DRIVER_BINDING_PROTOCOL      *This,\r
  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,\r
  PCI_IO_DEVICE                       *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
// TODO:    This - add argument and description to function comment\r
// TODO:    PciRootBridgeIo - add argument and description to function comment\r
// TODO:    PciIoDevice - add argument and description to function comment\r
// TODO:    EFI_NOT_FOUND - add return value to function comment\r
// TODO:    EFI_SUCCESS - add return value to function comment\r
{\r
  EFI_STATUS                    Status;\r
  EFI_PCI_OPTION_ROM_TABLE      *PciOptionRomTable;\r
  EFI_PCI_OPTION_ROM_DESCRIPTOR *PciOptionRomDescriptor;\r
  UINTN                         Index;\r
\r
  Status = EfiGetSystemConfigurationTable (&gEfiPciOptionRomTableGuid, (VOID **) &PciOptionRomTable);\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  for (Index = 0; Index < PciOptionRomTable->PciOptionRomCount; Index++) {\r
    PciOptionRomDescriptor = &PciOptionRomTable->PciOptionRomDescriptors[Index];\r
    if (PciOptionRomDescriptor->Seg == PciRootBridgeIo->SegmentNumber &&\r
        PciOptionRomDescriptor->Bus == PciIoDevice->BusNumber         &&\r
        PciOptionRomDescriptor->Dev == PciIoDevice->DeviceNumber      &&\r
        PciOptionRomDescriptor->Func == PciIoDevice->FunctionNumber ) {\r
\r
      PciIoDevice->PciIo.RomImage = (VOID *) (UINTN) PciOptionRomDescriptor->RomAddress;\r
      PciIoDevice->PciIo.RomSize  = (UINTN) PciOptionRomDescriptor->RomLength;\r
    }\r
  }\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
      AddDriver (PciIoDevice, mRomImageTable[Index].ImageHandle);\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
PciRomGetImageMapping (\r
  PCI_IO_DEVICE                       *PciIoDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
Arguments:\r
\r
Returns:\r
\r
--*/\r
// TODO:    PciIoDevice - add argument and description to function comment\r
// TODO:    EFI_SUCCESS - add return value to function comment\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);\r
      } else {\r
        PciIoDevice->PciIo.RomImage = (VOID *) (UINTN) mRomImageTable[Index].RomAddress;\r
        PciIoDevice->PciIo.RomSize  = (UINTN) mRomImageTable[Index].RomLength;\r
      }\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r