IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDriverOverride.c

   1 /*++
   2
   3 Copyright (c) 2006 - 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   PciDriverOverride.c
  15
  16 Abstract:
  17
  18   PCI Bus Driver
  19
  20 Revision History
  21
  22 --*/
  23
  24 #include "pcibus.h"
  25
  26 EFI_STATUS
  27 InitializePciDriverOverrideInstance (
  28   PCI_IO_DEVICE  *PciIoDevice
  29   )
  30 /*++
  31
  32 Routine Description:
  33
  34   Initializes a PCI Driver Override Instance
  35
  36 Arguments:
  37
  38 Returns:
  39
  40   None
  41
  42 --*/
  43 // TODO:    PciIoDevice - add argument and description to function comment
  44 // TODO:    EFI_SUCCESS - add return value to function comment
  45 {
  46   PciIoDevice->PciDriverOverride.GetDriver = GetDriver;
  47   return EFI_SUCCESS;
  48 }
  49
  50 EFI_STATUS
  51 EFIAPI
  52 GetDriver (
  53   IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,
  54   IN OUT EFI_HANDLE                                         *DriverImageHandle
  55   )
  56 /*++
  57
  58 Routine Description:
  59
  60   Get a overriding driver image
  61
  62 Arguments:
  63
  64 Returns:
  65
  66   None
  67
  68 --*/
  69 // TODO:    This - add argument and description to function comment
  70 // TODO:    DriverImageHandle - add argument and description to function comment
  71 // TODO:    EFI_SUCCESS - add return value to function comment
  72 // TODO:    EFI_NOT_FOUND - add return value to function comment
  73 // TODO:    EFI_SUCCESS - add return value to function comment
  74 // TODO:    EFI_INVALID_PARAMETER - add return value to function comment
  75 {
  76   PCI_IO_DEVICE             *PciIoDevice;
  77   LIST_ENTRY                *CurrentLink;
  78   PCI_DRIVER_OVERRIDE_LIST  *Node;
  79
  80   PciIoDevice = PCI_IO_DEVICE_FROM_PCI_DRIVER_OVERRIDE_THIS (This);
  81
  82   CurrentLink = PciIoDevice->OptionRomDriverList.ForwardLink;
  83
  84   while (CurrentLink && CurrentLink != &PciIoDevice->OptionRomDriverList) {
  85
  86     Node = DRIVER_OVERRIDE_FROM_LINK (CurrentLink);
  87
  88     if (*DriverImageHandle == NULL) {
  89
  90       *DriverImageHandle = Node->DriverImageHandle;
  91       return EFI_SUCCESS;
  92     }
  93
  94     if (*DriverImageHandle == Node->DriverImageHandle) {
  95
  96       if (CurrentLink->ForwardLink == &PciIoDevice->OptionRomDriverList ||
  97           CurrentLink->ForwardLink == NULL) {
  98         return EFI_NOT_FOUND;
  99       }
 100
 101       //
 102       // Get next node
 103       //
 104       Node                = DRIVER_OVERRIDE_FROM_LINK (CurrentLink->ForwardLink);
 105       *DriverImageHandle  = Node->DriverImageHandle;
 106       return EFI_SUCCESS;
 107     }
 108
 109     CurrentLink = CurrentLink->ForwardLink;
 110   }
 111
 112   return EFI_INVALID_PARAMETER;
 113 }
 114
 115 EFI_STATUS
 116 AddDriver (
 117   IN PCI_IO_DEVICE     *PciIoDevice,
 118   IN EFI_HANDLE        DriverImageHandle
 119   )
 120 /*++
 121
 122 Routine Description:
 123
 124   Add a overriding driver image
 125
 126 Arguments:
 127
 128 Returns:
 129
 130   None
 131
 132 --*/
 133 // TODO:    PciIoDevice - add argument and description to function comment
 134 // TODO:    DriverImageHandle - add argument and description to function comment
 135 // TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment
 136 // TODO:    EFI_SUCCESS - add return value to function comment
 137 // TODO:    EFI_SUCCESS - add return value to function comment
 138 // TODO:    EFI_SUCCESS - add return value to function comment
 139 // TODO:    EFI_SUCCESS - add return value to function comment
 140 {
 141   EFI_STATUS                    Status;
 142   EFI_IMAGE_DOS_HEADER          *DosHdr;
 143   EFI_IMAGE_NT_HEADERS          *PeHdr;
 144   EFI_LOADED_IMAGE_PROTOCOL     *LoadedImage;
 145   PCI_DRIVER_OVERRIDE_LIST      *Node;
 146
 147   Status = gBS->HandleProtocol (DriverImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &LoadedImage);
 148   if (EFI_ERROR (Status)) {
 149     return Status;
 150   }
 151
 152   Node = AllocatePool (sizeof (PCI_DRIVER_OVERRIDE_LIST));
 153   if (Node == NULL) {
 154     return EFI_OUT_OF_RESOURCES;
 155   }
 156
 157   Node->Signature         = DRIVER_OVERRIDE_SIGNATURE;
 158   Node->DriverImageHandle = DriverImageHandle;
 159
 160   InsertTailList (&PciIoDevice->OptionRomDriverList, &(Node->Link));
 161
 162   PciIoDevice->BusOverride  = TRUE;
 163
 164   DosHdr                    = (EFI_IMAGE_DOS_HEADER *) LoadedImage->ImageBase;
 165   if (DosHdr->e_magic != EFI_IMAGE_DOS_SIGNATURE) {
 166     return EFI_SUCCESS;
 167   }
 168
 169   PeHdr = (EFI_IMAGE_NT_HEADERS *) ((UINTN) LoadedImage->ImageBase + DosHdr->e_lfanew);
 170
 171   if (PeHdr->FileHeader.Machine != EFI_IMAGE_MACHINE_EBC) {
 172     return EFI_SUCCESS;
 173   }
 174   return EFI_SUCCESS;
 175 }