IntelFrameworkModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / GenericBdsLib / BdsConnect.c

/** @file\r
  BDS Lib functions which relate with connect the device\r
\r
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "InternalBdsLib.h"\r
\r
\r
/**\r
  This function will connect all the system driver to controller\r
  first, and then special connect the default console, this make\r
  sure all the system controller available and the platform default\r
  console connected.\r
\r
**/\r
VOID\r
EFIAPI\r
BdsLibConnectAll (\r
  VOID\r
  )\r
{\r
  //\r
  // Connect the platform console first\r
  //\r
  BdsLibConnectAllDefaultConsoles ();\r
\r
  //\r
  // Generic way to connect all the drivers\r
  //\r
  BdsLibConnectAllDriversToAllControllers ();\r
\r
  //\r
  // Here we have the assumption that we have already had\r
  // platform default console\r
  //\r
  BdsLibConnectAllDefaultConsoles ();\r
}\r
\r
\r
/**\r
  This function will connect all the system drivers to all controllers\r
  first, and then connect all the console devices the system current\r
  have. After this we should get all the device work and console available\r
  if the system have console device.\r
\r
**/\r
VOID\r
BdsLibGenericConnectAll (\r
  VOID\r
  )\r
{\r
  //\r
  // Most generic way to connect all the drivers\r
  //\r
  BdsLibConnectAllDriversToAllControllers ();\r
  BdsLibConnectAllConsoles ();\r
}\r
\r
/**\r
  This function will create all handles associate with every device\r
  path node. If the handle associate with one device path node can not\r
  be created successfully, then still give chance to do the dispatch,\r
  which load the missing drivers if possible.\r
\r
  @param  DevicePathToConnect   The device path which will be connected, it can be\r
                                a multi-instance device path\r
\r
  @retval EFI_SUCCESS           All handles associate with every device path  node\r
                                have been created\r
  @retval EFI_OUT_OF_RESOURCES  There is no resource to create new handles\r
  @retval EFI_NOT_FOUND         Create the handle associate with one device  path\r
                                node failed\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BdsLibConnectDevicePath (\r
  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePathToConnect\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL  *CopyOfDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL  *Instance;\r
  EFI_DEVICE_PATH_PROTOCOL  *RemainingDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL  *Next;\r
  EFI_HANDLE                Handle;\r
  EFI_HANDLE                PreviousHandle;\r
  UINTN                     Size;\r
  EFI_TPL                   CurrentTpl;\r
\r
  if (DevicePathToConnect == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  CurrentTpl  = EfiGetCurrentTpl ();\r
\r
  DevicePath        = DuplicateDevicePath (DevicePathToConnect);\r
  if (DevicePath == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  CopyOfDevicePath  = DevicePath;\r
\r
  do {\r
    //\r
    // The outer loop handles multi instance device paths.\r
    // Only console variables contain multiple instance device paths.\r
    //\r
    // After this call DevicePath points to the next Instance\r
    //\r
    Instance  = GetNextDevicePathInstance (&DevicePath, &Size);\r
    if (Instance == NULL) {\r
      FreePool (CopyOfDevicePath);\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    Next      = Instance;\r
    while (!IsDevicePathEndType (Next)) {\r
      Next = NextDevicePathNode (Next);\r
    }\r
\r
    SetDevicePathEndNode (Next);\r
\r
    //\r
    // Start the real work of connect with RemainingDevicePath\r
    //\r
    PreviousHandle = NULL;\r
    do {\r
      //\r
      // Find the handle that best matches the Device Path. If it is only a\r
      // partial match the remaining part of the device path is returned in\r
      // RemainingDevicePath.\r
      //\r
      RemainingDevicePath = Instance;\r
      Status              = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &RemainingDevicePath, &Handle);\r
\r
      if (!EFI_ERROR (Status)) {\r
        if (Handle == PreviousHandle) {\r
          //\r
          // If no forward progress is made try invoking the Dispatcher.\r
          // A new FV may have been added to the system an new drivers\r
          // may now be found.\r
          // Status == EFI_SUCCESS means a driver was dispatched\r
          // Status == EFI_NOT_FOUND means no new drivers were dispatched\r
          //\r
          if (CurrentTpl == TPL_APPLICATION) {\r
            //\r
            // Dispatch calls LoadImage/StartImage which cannot run at TPL > TPL_APPLICATION\r
            //\r
            Status = gDS->Dispatch ();\r
          } else {\r
            //\r
            // Always return EFI_NOT_FOUND here\r
            // to prevent dead loop when control handle is found but connection failded case\r
            //\r
            Status = EFI_NOT_FOUND;\r
          }\r
        }\r
\r
        if (!EFI_ERROR (Status)) {\r
          PreviousHandle = Handle;\r
          //\r
          // Connect all drivers that apply to Handle and RemainingDevicePath,\r
          // the Recursive flag is FALSE so only one level will be expanded.\r
          //\r
          // Do not check the connect status here, if the connect controller fail,\r
          // then still give the chance to do dispatch, because partial\r
          // RemainingDevicepath may be in the new FV\r
          //\r
          // 1. If the connect fail, RemainingDevicepath and handle will not\r
          //    change, so next time will do the dispatch, then dispatch's status\r
          //    will take effect\r
          // 2. If the connect success, the RemainingDevicepath and handle will\r
          //    change, then avoid the dispatch, we have chance to continue the\r
          //    next connection\r
          //\r
          gBS->ConnectController (Handle, NULL, RemainingDevicePath, FALSE);\r
        }\r
      }\r
      //\r
      // Loop until RemainingDevicePath is an empty device path\r
      //\r
    } while (!EFI_ERROR (Status) && !IsDevicePathEnd (RemainingDevicePath));\r
\r
  } while (DevicePath != NULL);\r
\r
  if (CopyOfDevicePath != NULL) {\r
    FreePool (CopyOfDevicePath);\r
  }\r
  //\r
  // All handle with DevicePath exists in the handle database\r
  //\r
  return Status;\r
}\r
\r
/**\r
  This function will connect all current system handles recursively.\r
\r
  gBS->ConnectController() service is invoked for each handle exist in system handler buffer.\r
  If the handle is bus type handler, all childrens also will be connected recursively\r
  by gBS->ConnectController().\r
\r
  @retval EFI_SUCCESS           All handles and it's child handle have been connected\r
  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BdsLibConnectAllEfi (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       HandleCount;\r
  EFI_HANDLE  *HandleBuffer;\r
  UINTN       Index;\r
\r
  Status = gBS->LocateHandleBuffer (\r
                  AllHandles,\r
                  NULL,\r
                  NULL,\r
                  &HandleCount,\r
                  &HandleBuffer\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  for (Index = 0; Index < HandleCount; Index++) {\r
    Status = gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);\r
  }\r
\r
  if (HandleBuffer != NULL) {\r
    FreePool (HandleBuffer);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This function will disconnect all current system handles.\r
\r
  gBS->DisconnectController() is invoked for each handle exists in system handle buffer.\r
  If handle is a bus type handle, all childrens also are disconnected recursively by\r
  gBS->DisconnectController().\r
\r
  @retval EFI_SUCCESS           All handles have been disconnected\r
  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BdsLibDisconnectAllEfi (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       HandleCount;\r
  EFI_HANDLE  *HandleBuffer;\r
  UINTN       Index;\r
\r
  //\r
  // Disconnect all\r
  //\r
  Status = gBS->LocateHandleBuffer (\r
                  AllHandles,\r
                  NULL,\r
                  NULL,\r
                  &HandleCount,\r
                  &HandleBuffer\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  for (Index = 0; Index < HandleCount; Index++) {\r
    Status = gBS->DisconnectController (HandleBuffer[Index], NULL, NULL);\r
  }\r
\r
  if (HandleBuffer != NULL) {\r
    FreePool (HandleBuffer);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Connects all drivers to all controllers.\r
  This function make sure all the current system driver will manage\r
  the correspoinding controllers if have. And at the same time, make\r
  sure all the system controllers have driver to manage it if have.\r
\r
**/\r
VOID\r
EFIAPI\r
BdsLibConnectAllDriversToAllControllers (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  do {\r
    //\r
    // Connect All EFI 1.10 drivers following EFI 1.10 algorithm\r
    //\r
    BdsLibConnectAllEfi ();\r
\r
    //\r
    // Check to see if it's possible to dispatch an more DXE drivers.\r
    // The BdsLibConnectAllEfi () may have made new DXE drivers show up.\r
    // If anything is Dispatched Status == EFI_SUCCESS and we will try\r
    // the connect again.\r
    //\r
    Status = gDS->Dispatch ();\r
\r
  } while (!EFI_ERROR (Status));\r
\r
}\r
\r
\r
/**\r
  Connect the specific Usb device which match the short form device path,\r
  and whose bus is determined by Host Controller (Uhci or Ehci).\r
\r
  @param  HostControllerPI      Uhci (0x00) or Ehci (0x20) or Both uhci and ehci\r
                                (0xFF)\r
  @param  RemainingDevicePath   a short-form device path that starts with the first\r
                                element  being a USB WWID or a USB Class device\r
                                path\r
\r
  @return EFI_INVALID_PARAMETER  RemainingDevicePath is NULL pointer.\r
                                 RemainingDevicePath is not a USB device path.\r
                                 Invalid HostControllerPI type.\r
  @return EFI_SUCCESS            Success to connect USB device\r
  @return EFI_NOT_FOUND          Fail to find handle for USB controller to connect.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BdsLibConnectUsbDevByShortFormDP(\r
  IN UINT8                      HostControllerPI,\r
  IN EFI_DEVICE_PATH_PROTOCOL   *RemainingDevicePath\r
  )\r
{\r
  EFI_STATUS                            Status;\r
  EFI_HANDLE                            *HandleArray;\r
  UINTN                                 HandleArrayCount;\r
  UINTN                                 Index;\r
  EFI_PCI_IO_PROTOCOL                   *PciIo;\r
  UINT8                                 Class[3];\r
  BOOLEAN                               AtLeastOneConnected;\r
\r
  //\r
  // Check the passed in parameters\r
  //\r
  if (RemainingDevicePath == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((DevicePathType (RemainingDevicePath) != MESSAGING_DEVICE_PATH) ||\r
      ((DevicePathSubType (RemainingDevicePath) != MSG_USB_CLASS_DP)\r
      && (DevicePathSubType (RemainingDevicePath) != MSG_USB_WWID_DP)\r
      )) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (HostControllerPI != 0xFF &&\r
      HostControllerPI != 0x00 &&\r
      HostControllerPI != 0x20) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Find the usb host controller firstly, then connect with the remaining device path\r
  //\r
  AtLeastOneConnected = FALSE;\r
  Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gEfiPciIoProtocolGuid,\r
                  NULL,\r
                  &HandleArrayCount,\r
                  &HandleArray\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    for (Index = 0; Index < HandleArrayCount; Index++) {\r
      Status = gBS->HandleProtocol (\r
                      HandleArray[Index],\r
                      &gEfiPciIoProtocolGuid,\r
                      (VOID **)&PciIo\r
                      );\r
      if (!EFI_ERROR (Status)) {\r
        //\r
        // Check whether the Pci device is the wanted usb host controller\r
        //\r
        Status = PciIo->Pci.Read (PciIo, EfiPciIoWidthUint8, 0x09, 3, &Class);\r
        if (!EFI_ERROR (Status)) {\r
          if ((PCI_CLASS_SERIAL == Class[2]) &&\r
              (PCI_CLASS_SERIAL_USB == Class[1])) {\r
            if (HostControllerPI == Class[0] || HostControllerPI == 0xFF) {\r
              Status = gBS->ConnectController (\r
                              HandleArray[Index],\r
                              NULL,\r
                              RemainingDevicePath,\r
                              FALSE\r
                              );\r
              if (!EFI_ERROR(Status)) {\r
                AtLeastOneConnected = TRUE;\r
              }\r
            }\r
          }\r
        }\r
      }\r
    }\r
\r
    if (HandleArray != NULL) {\r
      FreePool (HandleArray);\r
    }\r
\r
    if (AtLeastOneConnected) {\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r