MdeModulePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  Functions implementation for Bus Specific Driver Override protocol.\r
\r
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "PciBus.h"\r
\r
/**\r
  Initializes a PCI Driver Override Instance.\r
\r
  @param  PciIoDevice   PCI Device instance.\r
\r
**/\r
VOID\r
InitializePciDriverOverrideInstance (\r
  IN OUT PCI_IO_DEVICE          *PciIoDevice\r
  )\r
{\r
  PciIoDevice->PciDriverOverride.GetDriver = GetDriver;\r
}\r
\r
/**\r
  Find the image handle whose path equals to ImagePath.\r
\r
  @param ImagePath   Image path.\r
\r
  @return Image handle.\r
**/\r
EFI_HANDLE\r
LocateImageHandle (\r
  IN EFI_DEVICE_PATH_PROTOCOL   *ImagePath\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_HANDLE                    *Handles;\r
  UINTN                         Index;\r
  UINTN                         HandleNum;\r
  EFI_DEVICE_PATH_PROTOCOL      *DevicePath;\r
  UINTN                         ImagePathSize;\r
  EFI_HANDLE                    ImageHandle;\r
\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gEfiLoadedImageDevicePathProtocolGuid,\r
                  NULL,\r
                  &HandleNum,\r
                  &Handles\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
\r
  ImageHandle   = NULL;\r
  ImagePathSize = GetDevicePathSize (ImagePath);\r
\r
  for (Index = 0; Index < HandleNum; Index++) {\r
    Status = gBS->HandleProtocol (Handles[Index], &gEfiLoadedImageDevicePathProtocolGuid, (VOID **) &DevicePath);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
    if ((ImagePathSize == GetDevicePathSize (DevicePath)) &&\r
        (CompareMem (ImagePath, DevicePath, ImagePathSize) == 0)\r
        ) {\r
      ImageHandle = Handles[Index];\r
      break;\r
    }\r
  }\r
\r
  FreePool (Handles);\r
  return ImageHandle;\r
}\r
\r
/**\r
  Uses a bus specific algorithm to retrieve a driver image handle for a controller.\r
\r
  @param  This                  A pointer to the EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL instance.\r
  @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned\r
                                by GetDriver(). On output, a pointer to the next driver\r
                                image handle. Passing in a NULL, will return the first driver\r
                                image handle.\r
\r
  @retval EFI_SUCCESS           A bus specific override driver is returned in DriverImageHandle.\r
  @retval EFI_NOT_FOUND         The end of the list of override drivers was reached.\r
                                A bus specific override driver is not returned in DriverImageHandle.\r
  @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a\r
                                previous call to GetDriver().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetDriver (\r
  IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,\r
  IN OUT EFI_HANDLE                                         *DriverImageHandle\r
  )\r
{\r
  PCI_IO_DEVICE             *PciIoDevice;\r
  LIST_ENTRY                *Link;\r
  PCI_DRIVER_OVERRIDE_LIST  *Override;\r
  BOOLEAN                   ReturnNext;\r
\r
  Override    = NULL;\r
  PciIoDevice = PCI_IO_DEVICE_FROM_PCI_DRIVER_OVERRIDE_THIS (This);\r
  ReturnNext  = (BOOLEAN) (*DriverImageHandle == NULL);\r
  for ( Link = GetFirstNode (&PciIoDevice->OptionRomDriverList)\r
      ; !IsNull (&PciIoDevice->OptionRomDriverList, Link)\r
      ; Link = GetNextNode (&PciIoDevice->OptionRomDriverList, Link)\r
      ) {\r
\r
    Override = DRIVER_OVERRIDE_FROM_LINK (Link);\r
\r
    if (ReturnNext) {\r
      if (Override->DriverImageHandle == NULL) {\r
        Override->DriverImageHandle = LocateImageHandle (Override->DriverImagePath);\r
      }\r
\r
      if (Override->DriverImageHandle == NULL) {\r
        //\r
        // The Option ROM identified by Override->DriverImagePath is not loaded.\r
        //\r
        continue;\r
      } else {\r
        *DriverImageHandle = Override->DriverImageHandle;\r
        return EFI_SUCCESS;\r
      }\r
    }\r
\r
    if (*DriverImageHandle == Override->DriverImageHandle) {\r
      ReturnNext = TRUE;\r
    }\r
  }\r
\r
  ASSERT (IsNull (&PciIoDevice->OptionRomDriverList, Link));\r
  //\r
  // ReturnNext indicates a handle match happens.\r
  // If all nodes are checked without handle match happening,\r
  // the DriverImageHandle should be a invalid handle.\r
  //\r
  if (ReturnNext) {\r
    return EFI_NOT_FOUND;\r
  } else {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
}\r
\r
/**\r
  Add an overriding driver image.\r
\r
  @param PciIoDevice        Instance of PciIo device.\r
  @param DriverImageHandle  Image handle of newly added driver image.\r
  @param DriverImagePath    Device path of newly added driver image.\r
\r
  @retval EFI_SUCCESS          Successfully added driver.\r
  @retval EFI_OUT_OF_RESOURCES No memory resource for new driver instance.\r
  @retval other                Some error occurred when locating gEfiLoadedImageProtocolGuid.\r
\r
**/\r
EFI_STATUS\r
AddDriver (\r
  IN PCI_IO_DEVICE            *PciIoDevice,\r
  IN EFI_HANDLE               DriverImageHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL *DriverImagePath\r
  )\r
{\r
  PCI_DRIVER_OVERRIDE_LIST      *Node;\r
\r
  //\r
  // Caller should pass in either Image Handle or Image Path, but not both.\r
  //\r
  ASSERT ((DriverImageHandle == NULL) || (DriverImagePath == NULL));\r
\r
  Node = AllocateZeroPool (sizeof (PCI_DRIVER_OVERRIDE_LIST));\r
  if (Node == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Node->Signature         = DRIVER_OVERRIDE_SIGNATURE;\r
  Node->DriverImageHandle = DriverImageHandle;\r
  Node->DriverImagePath   = DuplicateDevicePath (DriverImagePath);\r
\r
  InsertTailList (&PciIoDevice->OptionRomDriverList, &Node->Link);\r
\r
  PciIoDevice->BusOverride  = TRUE;\r
  return EFI_SUCCESS;\r
}\r
\r