]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.c
MdeModulePkg/PciBus: Correct typos
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / PciBusDxe / PciOptionRomSupport.c
index 0fd5a3298d5b5957667480d388c88338256e1e72..c75ef1a82505c003c663cee2147fd3fa82015d4c 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   PCI Rom supporting funtions implementation for PCI Bus module.\r
 \r
-Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2019, 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
@@ -53,6 +53,7 @@ LocalLoadFile2 (
   UINT32                                    ScratchSize;\r
   VOID                                      *Scratch;\r
   EFI_DECOMPRESS_PROTOCOL                   *Decompress;\r
+  UINT32                                    InitializationSize;\r
 \r
   EfiOpRomImageNode = (MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH *) FilePath;\r
   if ((EfiOpRomImageNode == NULL) ||\r
@@ -76,7 +77,7 @@ LocalLoadFile2 (
 \r
 \r
   Pcir = (PCI_DATA_STRUCTURE *) ((UINT8 *) EfiRomHeader + EfiRomHeader->PcirOffset);\r
-\r
+  ASSERT (Pcir->Signature == PCI_DATA_STRUCTURE_SIGNATURE);\r
 \r
   if ((Pcir->CodeType == PCI_CODE_TYPE_EFI_IMAGE) &&\r
       (EfiRomHeader->EfiSignature == EFI_PCI_EXPANSION_ROM_HEADER_EFISIGNATURE) &&\r
@@ -85,9 +86,14 @@ LocalLoadFile2 (
       (EfiRomHeader->CompressionType <= EFI_PCI_EXPANSION_ROM_HEADER_COMPRESSED)\r
        ) {\r
 \r
-    ImageSize               = (UINT32) EfiRomHeader->InitializationSize * 512;\r
+    ImageSize = Pcir->ImageLength * 512;\r
+    InitializationSize = (UINT32) EfiRomHeader->InitializationSize * 512;\r
+    if (InitializationSize > ImageSize || EfiRomHeader->EfiImageHeaderOffset >=  InitializationSize) {\r
+      return EFI_NOT_FOUND;\r
+    }\r
+\r
     ImageBuffer             = (UINT8 *) EfiRomHeader + EfiRomHeader->EfiImageHeaderOffset;\r
-    ImageLength             = ImageSize - EfiRomHeader->EfiImageHeaderOffset;\r
+    ImageLength             = InitializationSize - EfiRomHeader->EfiImageHeaderOffset;\r
 \r
     if (EfiRomHeader->CompressionType != EFI_PCI_EXPANSION_ROM_HEADER_COMPRESSED) {\r
       //\r
@@ -299,7 +305,7 @@ GetOpRomInfo (
     return EFI_NOT_FOUND;\r
   }\r
 \r
-  PciIoDevice->RomSize = (UINT64) ((~AllOnes) + 1);\r
+  PciIoDevice->RomSize = (~AllOnes) + 1;\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -321,35 +327,45 @@ ContainEfiImage (
 {\r
   PCI_EXPANSION_ROM_HEADER  *RomHeader;\r
   PCI_DATA_STRUCTURE        *RomPcir;\r
-  BOOLEAN                   FirstCheck;\r
+  UINT8                     Indicator;\r
 \r
-  FirstCheck = TRUE;\r
-  RomHeader  = RomImage;\r
+  Indicator = 0;\r
+  RomHeader = RomImage;\r
+  if (RomHeader == NULL) {\r
+    return FALSE;\r
+  }\r
 \r
-  while ((UINT8 *) RomHeader < (UINT8 *) RomImage + RomSize) {\r
+  do {\r
     if (RomHeader->Signature != PCI_EXPANSION_ROM_HEADER_SIGNATURE) {\r
-      if (FirstCheck) {\r
-        return FALSE;\r
-      } else {\r
-        RomHeader = (PCI_EXPANSION_ROM_HEADER *) ((UINT8 *) RomHeader + 512);\r
-        continue;\r
-      }\r
+      RomHeader = (PCI_EXPANSION_ROM_HEADER *) ((UINT8 *) RomHeader + 512);\r
+      continue;\r
     }\r
 \r
-    FirstCheck = FALSE;\r
-    RomPcir    = (PCI_DATA_STRUCTURE *) ((UINT8 *) RomHeader + RomHeader->PcirOffset);\r
+    //\r
+    // The PCI Data Structure must be DWORD aligned.\r
+    //\r
+    if (RomHeader->PcirOffset == 0 ||\r
+        (RomHeader->PcirOffset & 3) != 0 ||\r
+        (UINT8 *) RomHeader + RomHeader->PcirOffset + sizeof (PCI_DATA_STRUCTURE) > (UINT8 *) RomImage + RomSize) {\r
+      break;\r
+    }\r
+\r
+    RomPcir = (PCI_DATA_STRUCTURE *) ((UINT8 *) RomHeader + RomHeader->PcirOffset);\r
+    if (RomPcir->Signature != PCI_DATA_STRUCTURE_SIGNATURE) {\r
+      break;\r
+    }\r
 \r
     if (RomPcir->CodeType == PCI_CODE_TYPE_EFI_IMAGE) {\r
       return TRUE;\r
     }\r
 \r
-    RomHeader = (PCI_EXPANSION_ROM_HEADER *) ((UINT8 *) RomHeader + RomPcir->Length * 512);\r
-  }\r
+    Indicator = RomPcir->Indicator;\r
+    RomHeader = (PCI_EXPANSION_ROM_HEADER *) ((UINT8 *) RomHeader + RomPcir->ImageLength * 512);\r
+  } while (((UINT8 *) RomHeader < (UINT8 *) RomImage + RomSize) && ((Indicator & 0x80) == 0x00));\r
 \r
   return FALSE;\r
 }\r
 \r
-\r
 /**\r
   Load Option Rom image for specified PCI device.\r
 \r
@@ -378,6 +394,7 @@ LoadOpRomImage (
   PCI_DATA_STRUCTURE        *RomPcir;\r
   UINT64                    RomSize;\r
   UINT64                    RomImageSize;\r
+  UINT32                    LegacyImageLength;\r
   UINT8                     *RomInMemory;\r
   UINT8                     CodeType;\r
 \r
@@ -430,6 +447,7 @@ LoadOpRomImage (
   RomBarOffset  = RomBar;\r
   RetStatus     = EFI_NOT_FOUND;\r
   FirstCheck    = TRUE;\r
+  LegacyImageLength = 0;\r
 \r
   do {\r
     PciDevice->PciRootBridgeIo->Mem.Read (\r
@@ -452,6 +470,15 @@ LoadOpRomImage (
 \r
     FirstCheck  = FALSE;\r
     OffsetPcir  = RomHeader->PcirOffset;\r
+    //\r
+    // If the pointer to the PCI Data Structure is invalid, no further images can be located.\r
+    // The PCI Data Structure must be DWORD aligned.\r
+    //\r
+    if (OffsetPcir == 0 ||\r
+        (OffsetPcir & 3) != 0 ||\r
+        RomImageSize + OffsetPcir + sizeof (PCI_DATA_STRUCTURE) > RomSize) {\r
+      break;\r
+    }\r
     PciDevice->PciRootBridgeIo->Mem.Read (\r
                                       PciDevice->PciRootBridgeIo,\r
                                       EfiPciWidthUint8,\r
@@ -459,8 +486,18 @@ LoadOpRomImage (
                                       sizeof (PCI_DATA_STRUCTURE),\r
                                       (UINT8 *) RomPcir\r
                                       );\r
+    //\r
+    // If a valid signature is not present in the PCI Data Structure, no further images can be located.\r
+    //\r
+    if (RomPcir->Signature != PCI_DATA_STRUCTURE_SIGNATURE) {\r
+      break;\r
+    }\r
+    if (RomImageSize + RomPcir->ImageLength * 512 > RomSize) {\r
+      break;\r
+    }\r
     if (RomPcir->CodeType == PCI_CODE_TYPE_PCAT_IMAGE) {\r
       CodeType = PCI_CODE_TYPE_PCAT_IMAGE;\r
+      LegacyImageLength = ((UINT32)((EFI_LEGACY_EXPANSION_ROM_HEADER *)RomHeader)->Size512) * 512;\r
     }\r
     Indicator     = RomPcir->Indicator;\r
     RomImageSize  = RomImageSize + RomPcir->ImageLength * 512;\r
@@ -472,7 +509,7 @@ LoadOpRomImage (
   // of the legacy length and the PCIR Image Length\r
   //\r
   if (CodeType == PCI_CODE_TYPE_PCAT_IMAGE) {\r
-    RomImageSize = MAX(RomImageSize, (((EFI_LEGACY_EXPANSION_ROM_HEADER *)RomHeader)->Size512 * 512));\r
+    RomImageSize = MAX (RomImageSize, LegacyImageLength);\r
   }\r
 \r
   if (RomImageSize > 0) {\r
@@ -514,7 +551,7 @@ LoadOpRomImage (
     PciDevice->BusNumber,\r
     PciDevice->DeviceNumber,\r
     PciDevice->FunctionNumber,\r
-    (UINT64) (UINTN) PciDevice->PciIo.RomImage,\r
+    PciDevice->PciIo.RomImage,\r
     PciDevice->PciIo.RomSize\r
     );\r
 \r
@@ -546,23 +583,10 @@ RomDecode (
   )\r
 {\r
   UINT32              Value32;\r
-  UINT32              Offset;\r
-  UINT32              OffsetMax;\r
   EFI_PCI_IO_PROTOCOL *PciIo;\r
 \r
   PciIo = &PciDevice->PciIo;\r
   if (Enable) {\r
-    //\r
-    // Clear all bars\r
-    //\r
-    OffsetMax = 0x24;\r
-    if (IS_PCI_BRIDGE(&PciDevice->Pci)) {\r
-      OffsetMax = 0x14;\r
-    }\r
-\r
-    for (Offset = 0x10; Offset <= OffsetMax; Offset += sizeof (UINT32)) {\r
-      PciIo->Pci.Write (PciIo, EfiPciIoWidthUint32, Offset, 1, &gAllZero);\r
-    }\r
 \r
     //\r
     // set the Rom base address: now is hardcode\r
@@ -580,7 +604,7 @@ RomDecode (
     //\r
     // Programe all upstream bridge\r
     //\r
-    ProgrameUpstreamBridgeForRom(PciDevice, RomBar, TRUE);\r
+    ProgramUpstreamBridgeForRom (PciDevice, RomBar, TRUE);\r
 \r
     //\r
     // Setting the memory space bit in the function's command register\r
@@ -597,7 +621,7 @@ RomDecode (
     //\r
     // Destroy the programmed bar in all the upstream bridge.\r
     //\r
-    ProgrameUpstreamBridgeForRom(PciDevice, RomBar, FALSE);\r
+    ProgramUpstreamBridgeForRom (PciDevice, RomBar, FALSE);\r
 \r
     //\r
     // disable rom decode\r
@@ -635,7 +659,6 @@ ProcessOpRomImage (
   EFI_HANDLE                               ImageHandle;\r
   EFI_STATUS                               Status;\r
   EFI_STATUS                               RetStatus;\r
-  BOOLEAN                                  FirstCheck;\r
   EFI_PCI_EXPANSION_ROM_HEADER             *EfiRomHeader;\r
   PCI_DATA_STRUCTURE                       *Pcir;\r
   EFI_DEVICE_PATH_PROTOCOL                 *PciOptionRomImageDevicePath;\r
@@ -651,24 +674,45 @@ ProcessOpRomImage (
   RomBar        = PciDevice->PciIo.RomImage;\r
   RomBarOffset  = (UINT8 *) RomBar;\r
   RetStatus     = EFI_NOT_FOUND;\r
-  FirstCheck    = TRUE;\r
+\r
+  if (RomBar == NULL) {\r
+    return RetStatus;\r
+  }\r
+  ASSERT (((EFI_PCI_EXPANSION_ROM_HEADER *) RomBarOffset)->Signature == PCI_EXPANSION_ROM_HEADER_SIGNATURE);\r
 \r
   do {\r
     EfiRomHeader = (EFI_PCI_EXPANSION_ROM_HEADER *) RomBarOffset;\r
     if (EfiRomHeader->Signature != PCI_EXPANSION_ROM_HEADER_SIGNATURE) {\r
       RomBarOffset += 512;\r
-      if (FirstCheck) {\r
-        break;\r
-      } else {\r
-        continue;\r
-      }\r
+      continue;\r
     }\r
 \r
-    FirstCheck  = FALSE;\r
     Pcir        = (PCI_DATA_STRUCTURE *) (RomBarOffset + EfiRomHeader->PcirOffset);\r
+    ASSERT (Pcir->Signature == PCI_DATA_STRUCTURE_SIGNATURE);\r
     ImageSize   = (UINT32) (Pcir->ImageLength * 512);\r
     Indicator   = Pcir->Indicator;\r
 \r
+    //\r
+    // Skip the image if it is not an EFI PCI Option ROM image\r
+    //\r
+    if (Pcir->CodeType != PCI_CODE_TYPE_EFI_IMAGE) {\r
+      goto NextImage;\r
+    }\r
+\r
+    //\r
+    // Skip the EFI PCI Option ROM image if its machine type is not supported\r
+    //\r
+    if (!EFI_IMAGE_MACHINE_TYPE_SUPPORTED (EfiRomHeader->EfiMachineType)) {\r
+      goto NextImage;\r
+    }\r
+\r
+    //\r
+    // Ignore the EFI PCI Option ROM image if it is an EFI application\r
+    //\r
+    if (EfiRomHeader->EfiSubsystem == EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION) {\r
+      goto NextImage;\r
+    }\r
+\r
     //\r
     // Create Pci Option Rom Image device path header\r
     //\r
@@ -686,42 +730,47 @@ ProcessOpRomImage (
     //\r
     BufferSize  = 0;\r
     Buffer      = NULL;\r
-    Status      = EFI_SUCCESS;\r
     ImageHandle = NULL;\r
 \r
-     if (!EFI_ERROR (Status)) {\r
-      Status = gBS->LoadImage (\r
-                      FALSE,\r
-                      gPciBusDriverBinding.DriverBindingHandle,\r
-                      PciOptionRomImageDevicePath,\r
-                      Buffer,\r
-                      BufferSize,\r
-                      &ImageHandle\r
-                      );\r
-    }\r
-\r
-    FreePool (PciOptionRomImageDevicePath);\r
-\r
-    if (!EFI_ERROR (Status)) {\r
+    Status = gBS->LoadImage (\r
+                    FALSE,\r
+                    gPciBusDriverBinding.DriverBindingHandle,\r
+                    PciOptionRomImageDevicePath,\r
+                    Buffer,\r
+                    BufferSize,\r
+                    &ImageHandle\r
+                    );\r
+    if (EFI_ERROR (Status)) {\r
+      //\r
+      // Record the Option ROM Image device path when LoadImage fails.\r
+      // PciOverride.GetDriver() will try to look for the Image Handle using the device path later.\r
+      //\r
+      AddDriver (PciDevice, NULL, PciOptionRomImageDevicePath);\r
+    } else {\r
       Status = gBS->StartImage (ImageHandle, NULL, NULL);\r
       if (!EFI_ERROR (Status)) {\r
-        AddDriver (PciDevice, ImageHandle);\r
+        //\r
+        // Record the Option ROM Image Handle\r
+        //\r
+        AddDriver (PciDevice, ImageHandle, NULL);\r
         PciRomAddImageMapping (\r
           ImageHandle,\r
           PciDevice->PciRootBridgeIo->SegmentNumber,\r
           PciDevice->BusNumber,\r
           PciDevice->DeviceNumber,\r
           PciDevice->FunctionNumber,\r
-          (UINT64) (UINTN) PciDevice->PciIo.RomImage,\r
+          PciDevice->PciIo.RomImage,\r
           PciDevice->PciIo.RomSize\r
           );\r
         RetStatus = EFI_SUCCESS;\r
       }\r
     }\r
+    FreePool (PciOptionRomImageDevicePath);\r
 \r
+NextImage:\r
     RomBarOffset += ImageSize;\r
 \r
-  } while (((Indicator & 0x80) == 0x00) && ((UINTN) (RomBarOffset - (UINT8 *) RomBar) < PciDevice->RomSize));\r
+  } while (((Indicator & 0x80) == 0x00) && (((UINTN) RomBarOffset - (UINTN) RomBar) < PciDevice->RomSize));\r
 \r
   return RetStatus;\r
 }\r