MdeModulePkg/Bus/Pci/PciBusDxe/PciBus.c

   1 /** @file
   2   Driver Binding functions for PCI Bus module.
   3
   4   Single PCI bus driver instance will manager all PCI Root Bridges in one EFI based firmware,
   5   since all PCI Root Bridges' resources need to be managed together.
   6   Supported() function will try to get PCI Root Bridge IO Protocol.
   7   Start() function will get PCI Host Bridge Resource Allocation Protocol to manage all
   8   PCI Root Bridges. So it means platform needs install PCI Root Bridge IO protocol for each
   9   PCI Root Bus and install PCI Host Bridge Resource Allocation Protocol.
  10
  11 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
  12 SPDX-License-Identifier: BSD-2-Clause-Patent
  13
  14 **/
  15
  16 #include "PciBus.h"
  17
  18 //
  19 // PCI Bus Driver Global Variables
  20 //
  21 EFI_DRIVER_BINDING_PROTOCOL  gPciBusDriverBinding = {
  22   PciBusDriverBindingSupported,
  23   PciBusDriverBindingStart,
  24   PciBusDriverBindingStop,
  25   0xa,
  26   NULL,
  27   NULL
  28 };
  29
  30 EFI_HANDLE                                    gPciHostBrigeHandles[PCI_MAX_HOST_BRIDGE_NUM];
  31 EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL  *gIncompatiblePciDeviceSupport = NULL;
  32 UINTN                                         gPciHostBridgeNumber           = 0;
  33 BOOLEAN                                       gFullEnumeration               = TRUE;
  34 UINT64                                        gAllOne                        = 0xFFFFFFFFFFFFFFFFULL;
  35 UINT64                                        gAllZero                       = 0;
  36
  37 EFI_PCI_PLATFORM_PROTOCOL       *gPciPlatformProtocol;
  38 EFI_PCI_OVERRIDE_PROTOCOL       *gPciOverrideProtocol;
  39 EDKII_IOMMU_PROTOCOL            *mIoMmuProtocol;
  40 EDKII_DEVICE_SECURITY_PROTOCOL  *mDeviceSecurityProtocol;
  41
  42 GLOBAL_REMOVE_IF_UNREFERENCED EFI_PCI_HOTPLUG_REQUEST_PROTOCOL  mPciHotPlugRequest = {
  43   PciHotPlugRequestNotify
  44 };
  45
  46 /**
  47   The Entry Point for PCI Bus module. The user code starts with this function.
  48
  49   Installs driver module protocols and. Creates virtual device handles for ConIn,
  50   ConOut, and StdErr. Installs Simple Text In protocol, Simple Text In Ex protocol,
  51   Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers.
  52   Installs Graphics Output protocol and/or UGA Draw protocol if needed.
  53
  54   @param[in] ImageHandle    The firmware allocated handle for the EFI image.
  55   @param[in] SystemTable    A pointer to the EFI System Table.
  56
  57   @retval EFI_SUCCESS       The entry point is executed successfully.
  58   @retval other             Some error occurred when executing this entry point.
  59
  60 **/
  61 EFI_STATUS
  62 EFIAPI
  63 PciBusEntryPoint (
  64   IN EFI_HANDLE        ImageHandle,
  65   IN EFI_SYSTEM_TABLE  *SystemTable
  66   )
  67 {
  68   EFI_STATUS  Status;
  69   EFI_HANDLE  Handle;
  70
  71   //
  72   // Initializes PCI devices pool
  73   //
  74   InitializePciDevicePool ();
  75
  76   //
  77   // Install driver model protocol(s).
  78   //
  79   Status = EfiLibInstallDriverBindingComponentName2 (
  80              ImageHandle,
  81              SystemTable,
  82              &gPciBusDriverBinding,
  83              ImageHandle,
  84              &gPciBusComponentName,
  85              &gPciBusComponentName2
  86              );
  87   ASSERT_EFI_ERROR (Status);
  88
  89   if (FeaturePcdGet (PcdPciBusHotplugDeviceSupport)) {
  90     //
  91     // If Hot Plug is supported, install EFI PCI Hot Plug Request protocol.
  92     //
  93     Handle = NULL;
  94     Status = gBS->InstallProtocolInterface (
  95                     &Handle,
  96                     &gEfiPciHotPlugRequestProtocolGuid,
  97                     EFI_NATIVE_INTERFACE,
  98                     &mPciHotPlugRequest
  99                     );
 100   }
 101
 102   return Status;
 103 }
 104
 105 /**
 106   Test to see if this driver supports ControllerHandle. Any ControllerHandle
 107   than contains a gEfiPciRootBridgeIoProtocolGuid protocol can be supported.
 108
 109   @param  This                Protocol instance pointer.
 110   @param  Controller          Handle of device to test.
 111   @param  RemainingDevicePath Optional parameter use to pick a specific child
 112                               device to start.
 113
 114   @retval EFI_SUCCESS         This driver supports this device.
 115   @retval EFI_ALREADY_STARTED This driver is already running on this device.
 116   @retval other               This driver does not support this device.
 117
 118 **/
 119 EFI_STATUS
 120 EFIAPI
 121 PciBusDriverBindingSupported (
 122   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
 123   IN EFI_HANDLE                   Controller,
 124   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
 125   )
 126 {
 127   EFI_STATUS                       Status;
 128   EFI_DEVICE_PATH_PROTOCOL         *ParentDevicePath;
 129   EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo;
 130   EFI_DEV_PATH_PTR                 Node;
 131
 132   //
 133   // Check RemainingDevicePath validation
 134   //
 135   if (RemainingDevicePath != NULL) {
 136     //
 137     // Check if RemainingDevicePath is the End of Device Path Node,
 138     // if yes, go on checking other conditions
 139     //
 140     if (!IsDevicePathEnd (RemainingDevicePath)) {
 141       //
 142       // If RemainingDevicePath isn't the End of Device Path Node,
 143       // check its validation
 144       //
 145       Node.DevPath = RemainingDevicePath;
 146       if ((Node.DevPath->Type != HARDWARE_DEVICE_PATH) ||
 147           (Node.DevPath->SubType != HW_PCI_DP) ||
 148           (DevicePathNodeLength (Node.DevPath) != sizeof (PCI_DEVICE_PATH)))
 149       {
 150         return EFI_UNSUPPORTED;
 151       }
 152     }
 153   }
 154
 155   //
 156   // Check if Pci Root Bridge IO protocol is installed by platform
 157   //
 158   Status = gBS->OpenProtocol (
 159                   Controller,
 160                   &gEfiPciRootBridgeIoProtocolGuid,
 161                   (VOID **)&PciRootBridgeIo,
 162                   This->DriverBindingHandle,
 163                   Controller,
 164                   EFI_OPEN_PROTOCOL_BY_DRIVER
 165                   );
 166   if (Status == EFI_ALREADY_STARTED) {
 167     return EFI_SUCCESS;
 168   }
 169
 170   if (EFI_ERROR (Status)) {
 171     return Status;
 172   }
 173
 174   //
 175   // Close the I/O Abstraction(s) used to perform the supported test
 176   //
 177   gBS->CloseProtocol (
 178          Controller,
 179          &gEfiPciRootBridgeIoProtocolGuid,
 180          This->DriverBindingHandle,
 181          Controller
 182          );
 183
 184   //
 185   // Open the EFI Device Path protocol needed to perform the supported test
 186   //
 187   Status = gBS->OpenProtocol (
 188                   Controller,
 189                   &gEfiDevicePathProtocolGuid,
 190                   (VOID **)&ParentDevicePath,
 191                   This->DriverBindingHandle,
 192                   Controller,
 193                   EFI_OPEN_PROTOCOL_BY_DRIVER
 194                   );
 195   if (Status == EFI_ALREADY_STARTED) {
 196     return EFI_SUCCESS;
 197   }
 198
 199   if (EFI_ERROR (Status)) {
 200     return Status;
 201   }
 202
 203   //
 204   // Close protocol, don't use device path protocol in the Support() function
 205   //
 206   gBS->CloseProtocol (
 207          Controller,
 208          &gEfiDevicePathProtocolGuid,
 209          This->DriverBindingHandle,
 210          Controller
 211          );
 212
 213   return EFI_SUCCESS;
 214 }
 215
 216 /**
 217   Start this driver on ControllerHandle and enumerate Pci bus and start
 218   all device under PCI bus.
 219
 220   @param  This                 Protocol instance pointer.
 221   @param  Controller           Handle of device to bind driver to.
 222   @param  RemainingDevicePath  Optional parameter use to pick a specific child
 223                                device to start.
 224
 225   @retval EFI_SUCCESS          This driver is added to ControllerHandle.
 226   @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle.
 227   @retval other                This driver does not support this device.
 228
 229 **/
 230 EFI_STATUS
 231 EFIAPI
 232 PciBusDriverBindingStart (
 233   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
 234   IN EFI_HANDLE                   Controller,
 235   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
 236   )
 237 {
 238   EFI_STATUS                       Status;
 239   EFI_DEVICE_PATH_PROTOCOL         *ParentDevicePath;
 240   EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo;
 241
 242   //
 243   // Initialize PciRootBridgeIo to suppress incorrect compiler warning.
 244   //
 245   PciRootBridgeIo = NULL;
 246
 247   //
 248   // Check RemainingDevicePath validation
 249   //
 250   if (RemainingDevicePath != NULL) {
 251     //
 252     // Check if RemainingDevicePath is the End of Device Path Node,
 253     // if yes, return EFI_SUCCESS
 254     //
 255     if (IsDevicePathEnd (RemainingDevicePath)) {
 256       return EFI_SUCCESS;
 257     }
 258   }
 259
 260   gBS->LocateProtocol (
 261          &gEfiIncompatiblePciDeviceSupportProtocolGuid,
 262          NULL,
 263          (VOID **)&gIncompatiblePciDeviceSupport
 264          );
 265
 266   //
 267   // If PCI Platform protocol is available, get it now.
 268   // If the platform implements this, it must be installed before BDS phase
 269   //
 270   gPciPlatformProtocol = NULL;
 271   gBS->LocateProtocol (
 272          &gEfiPciPlatformProtocolGuid,
 273          NULL,
 274          (VOID **)&gPciPlatformProtocol
 275          );
 276
 277   //
 278   // If PCI Platform protocol doesn't exist, try to Pci Override Protocol.
 279   //
 280   if (gPciPlatformProtocol == NULL) {
 281     gPciOverrideProtocol = NULL;
 282     gBS->LocateProtocol (
 283            &gEfiPciOverrideProtocolGuid,
 284            NULL,
 285            (VOID **)&gPciOverrideProtocol
 286            );
 287   }
 288
 289   if (mIoMmuProtocol == NULL) {
 290     gBS->LocateProtocol (
 291            &gEdkiiIoMmuProtocolGuid,
 292            NULL,
 293            (VOID **)&mIoMmuProtocol
 294            );
 295   }
 296
 297   if (mDeviceSecurityProtocol == NULL) {
 298     gBS->LocateProtocol (
 299            &gEdkiiDeviceSecurityProtocolGuid,
 300            NULL,
 301            (VOID **)&mDeviceSecurityProtocol
 302            );
 303   }
 304
 305   if (PcdGetBool (PcdPciDisableBusEnumeration)) {
 306     gFullEnumeration = FALSE;
 307   } else {
 308     gFullEnumeration = (BOOLEAN)((SearchHostBridgeHandle (Controller) ? FALSE : TRUE));
 309   }
 310
 311   //
 312   // Open Device Path Protocol for PCI root bridge
 313   //
 314   Status = gBS->OpenProtocol (
 315                   Controller,
 316                   &gEfiDevicePathProtocolGuid,
 317                   (VOID **)&ParentDevicePath,
 318                   This->DriverBindingHandle,
 319                   Controller,
 320                   EFI_OPEN_PROTOCOL_GET_PROTOCOL
 321                   );
 322   ASSERT_EFI_ERROR (Status);
 323
 324   //
 325   // Report Status Code to indicate PCI bus starts
 326   //
 327   REPORT_STATUS_CODE_WITH_DEVICE_PATH (
 328     EFI_PROGRESS_CODE,
 329     (EFI_IO_BUS_PCI | EFI_IOB_PC_INIT),
 330     ParentDevicePath
 331     );
 332
 333   Status = EFI_SUCCESS;
 334   //
 335   // Enumerate the entire host bridge
 336   // After enumeration, a database that records all the device information will be created
 337   //
 338   //
 339   if (gFullEnumeration) {
 340     //
 341     // Get the rootbridge Io protocol to find the host bridge handle
 342     //
 343     Status = gBS->OpenProtocol (
 344                     Controller,
 345                     &gEfiPciRootBridgeIoProtocolGuid,
 346                     (VOID **)&PciRootBridgeIo,
 347                     gPciBusDriverBinding.DriverBindingHandle,
 348                     Controller,
 349                     EFI_OPEN_PROTOCOL_GET_PROTOCOL
 350                     );
 351
 352     if (!EFI_ERROR (Status)) {
 353       Status = PciEnumerator (Controller, PciRootBridgeIo->ParentHandle);
 354     }
 355   } else {
 356     //
 357     // If PCI bus has already done the full enumeration, never do it again
 358     //
 359     Status = PciEnumeratorLight (Controller);
 360   }
 361
 362   if (EFI_ERROR (Status)) {
 363     return Status;
 364   }
 365
 366   //
 367   // Start all the devices under the entire host bridge.
 368   //
 369   StartPciDevices (Controller);
 370
 371   if (gFullEnumeration) {
 372     gFullEnumeration = FALSE;
 373
 374     Status = gBS->InstallProtocolInterface (
 375                     &PciRootBridgeIo->ParentHandle,
 376                     &gEfiPciEnumerationCompleteProtocolGuid,
 377                     EFI_NATIVE_INTERFACE,
 378                     NULL
 379                     );
 380     ASSERT_EFI_ERROR (Status);
 381   }
 382
 383   return Status;
 384 }
 385
 386 /**
 387   Stop this driver on ControllerHandle. Support stopping any child handles
 388   created by this driver.
 389
 390   @param  This              Protocol instance pointer.
 391   @param  Controller        Handle of device to stop driver on.
 392   @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
 393                             children is zero stop the entire bus driver.
 394   @param  ChildHandleBuffer List of Child Handles to Stop.
 395
 396   @retval EFI_SUCCESS       This driver is removed ControllerHandle.
 397   @retval other             This driver was not removed from this device.
 398
 399 **/
 400 EFI_STATUS
 401 EFIAPI
 402 PciBusDriverBindingStop (
 403   IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
 404   IN  EFI_HANDLE                   Controller,
 405   IN  UINTN                        NumberOfChildren,
 406   IN  EFI_HANDLE                   *ChildHandleBuffer
 407   )
 408 {
 409   EFI_STATUS  Status;
 410   UINTN       Index;
 411   BOOLEAN     AllChildrenStopped;
 412
 413   if (NumberOfChildren == 0) {
 414     //
 415     // Close the bus driver
 416     //
 417     gBS->CloseProtocol (
 418            Controller,
 419            &gEfiDevicePathProtocolGuid,
 420            This->DriverBindingHandle,
 421            Controller
 422            );
 423     gBS->CloseProtocol (
 424            Controller,
 425            &gEfiPciRootBridgeIoProtocolGuid,
 426            This->DriverBindingHandle,
 427            Controller
 428            );
 429
 430     DestroyRootBridgeByHandle (
 431       Controller
 432       );
 433
 434     return EFI_SUCCESS;
 435   }
 436
 437   //
 438   // Stop all the children
 439   //
 440
 441   AllChildrenStopped = TRUE;
 442
 443   for (Index = 0; Index < NumberOfChildren; Index++) {
 444     //
 445     // De register all the pci device
 446     //
 447     Status = DeRegisterPciDevice (Controller, ChildHandleBuffer[Index]);
 448
 449     if (EFI_ERROR (Status)) {
 450       AllChildrenStopped = FALSE;
 451     }
 452   }
 453
 454   if (!AllChildrenStopped) {
 455     return EFI_DEVICE_ERROR;
 456   }
 457
 458   return EFI_SUCCESS;
 459 }