Pci/PciBusDxe/PciDriverOverride.c

	PciDriverOverride.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter/** @file
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  Functions implementation for Bus Specific Driver Override protoocl.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
940d71d237794874e18a0eb72f6564821a823517eschrockCopyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterThis program and the accompanying materials
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterare licensed and made available under the terms and conditions of the BSD License
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterwhich accompanies this distribution.  The full text of the license may be found at
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterhttp://opensource.org/licenses/bsd-license.php
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter**/
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter#include "PciBus.h"
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter/**
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  Initializes a PCI Driver Override Instance.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  @param  PciIoDevice   PCI Device instance.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter**/
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterVOID
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterInitializePciDriverOverrideInstance (
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  IN OUT PCI_IO_DEVICE          *PciIoDevice
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  )
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter{
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  PciIoDevice->PciDriverOverride.GetDriver = GetDriver;
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter}
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter/**
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  Uses a bus specific algorithm to retrieve a driver image handle for a controller.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  @param  This                  A pointer to the EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL instance.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  @param  DriverImageHandle     On input, a pointer to the previous driver image handle returned
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter                                by GetDriver(). On output, a pointer to the next driver
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter                                image handle. Passing in a NULL, will return the first driver
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter                                image handle.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  @retval EFI_SUCCESS           A bus specific override driver is returned in DriverImageHandle.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  @retval EFI_NOT_FOUND         The end of the list of override drivers was reached.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter                                A bus specific override driver is not returned in DriverImageHandle.
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  @retval EFI_INVALID_PARAMETER DriverImageHandle is not a handle that was returned on a
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter                                previous call to GetDriver().
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter**/
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterEFI_STATUS
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterEFIAPI
51b564aca190d2a430104dded1983d3a1fff66e2mcwalterGetDriver (
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  IN OUT EFI_HANDLE                                         *DriverImageHandle
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter  )
940d71d237794874e18a0eb72f6564821a823517eschrock{
940d71d237794874e18a0eb72f6564821a823517eschrock  PCI_IO_DEVICE             *PciIoDevice;
940d71d237794874e18a0eb72f6564821a823517eschrock  LIST_ENTRY                *CurrentLink;
940d71d237794874e18a0eb72f6564821a823517eschrock  PCI_DRIVER_OVERRIDE_LIST  *Node;
51b564aca190d2a430104dded1983d3a1fff66e2mcwalter
  PciIoDevice = PCI_IO_DEVICE_FROM_PCI_DRIVER_OVERRIDE_THIS (This);

  CurrentLink = PciIoDevice->OptionRomDriverList.ForwardLink;

  while (CurrentLink != NULL && CurrentLink != &PciIoDevice->OptionRomDriverList) {

    Node = DRIVER_OVERRIDE_FROM_LINK (CurrentLink);

    if (*DriverImageHandle == NULL) {

      *DriverImageHandle = Node->DriverImageHandle;
      return EFI_SUCCESS;
    }

    if (*DriverImageHandle == Node->DriverImageHandle) {

      if (CurrentLink->ForwardLink == &PciIoDevice->OptionRomDriverList ||
          CurrentLink->ForwardLink == NULL) {
        return EFI_NOT_FOUND;
      }

      //
      // Get next node
      //
      Node                = DRIVER_OVERRIDE_FROM_LINK (CurrentLink->ForwardLink);
      *DriverImageHandle  = Node->DriverImageHandle;
      return EFI_SUCCESS;
    }

    CurrentLink = CurrentLink->ForwardLink;
  }

  return EFI_INVALID_PARAMETER;
}

/**
  Add an overriding driver image.

  @param PciIoDevice        Instance of PciIo device.
  @param DriverImageHandle  new added driver image.

  @retval EFI_SUCCESS          Successfully added driver.
  @retval EFI_OUT_OF_RESOURCES No memory resource for new driver instance.
  @retval other                Some error occurred when locating gEfiLoadedImageProtocolGuid.

**/
EFI_STATUS
AddDriver (
  IN PCI_IO_DEVICE     *PciIoDevice,
  IN EFI_HANDLE        DriverImageHandle
  )
{
  EFI_STATUS                    Status;
  EFI_LOADED_IMAGE_PROTOCOL     *LoadedImage;
  PE_COFF_LOADER_IMAGE_CONTEXT  ImageContext;
  PCI_DRIVER_OVERRIDE_LIST      *Node;

  Status = gBS->HandleProtocol (DriverImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &LoadedImage);
  if (EFI_ERROR (Status)) {
    return Status;
  }

  Node = AllocatePool (sizeof (PCI_DRIVER_OVERRIDE_LIST));
  if (Node == NULL) {
    return EFI_OUT_OF_RESOURCES;
  }

  Node->Signature         = DRIVER_OVERRIDE_SIGNATURE;
  Node->DriverImageHandle = DriverImageHandle;

  InsertTailList (&PciIoDevice->OptionRomDriverList, &(Node->Link));

  PciIoDevice->BusOverride  = TRUE;

  ImageContext.Handle    = LoadedImage->ImageBase;
  ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;

  //
  // Get information about the image
  //
  PeCoffLoaderGetImageInfo (&ImageContext);

  return EFI_SUCCESS;
}