MdeModulePkg/Library/GenericBdsLib/BdsConnect.c

   1 /** @file
   2   BDS Lib functions which relate with connect the device
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "InternalBdsLib.h"
  16
  17
  18 /**
  19   This function will connect all the system driver to controller
  20   first, and then special connect the default console, this make
  21   sure all the system controller avialbe and the platform default
  22   console connected.
  23
  24 **/
  25 VOID
  26 EFIAPI
  27 BdsLibConnectAll (
  28   VOID
  29   )
  30 {
  31   //
  32   // Connect the platform console first
  33   //
  34   BdsLibConnectAllDefaultConsoles ();
  35
  36   //
  37   // Generic way to connect all the drivers
  38   //
  39   BdsLibConnectAllDriversToAllControllers ();
  40
  41   //
  42   // Here we have the assumption that we have already had
  43   // platform default console
  44   //
  45   BdsLibConnectAllDefaultConsoles ();
  46 }
  47
  48
  49 /**
  50   This function will connect all the system drivers to all controllers
  51   first, and then connect all the console devices the system current
  52   have. After this we should get all the device work and console avariable
  53   if the system have console device.
  54
  55 **/
  56 VOID
  57 BdsLibGenericConnectAll (
  58   VOID
  59   )
  60 {
  61   //
  62   // Most generic way to connect all the drivers
  63   //
  64   BdsLibConnectAllDriversToAllControllers ();
  65   BdsLibConnectAllConsoles ();
  66 }
  67
  68
  69 /**
  70   This function will create all handles associate with every device
  71   path node. If the handle associate with one device path node can not
  72   be created success, then still give one chance to do the dispatch,
  73   which load the missing drivers if possible.
  74
  75   @param  DevicePathToConnect   The device path which will be connected, it can be
  76                                 a multi-instance device path
  77
  78   @retval EFI_SUCCESS           All handles associate with every device path  node
  79                                 have been created
  80   @retval EFI_OUT_OF_RESOURCES  There is no resource to create new handles
  81   @retval EFI_NOT_FOUND         Create the handle associate with one device  path
  82                                 node failed
  83
  84 **/
  85 EFI_STATUS
  86 EFIAPI
  87 BdsLibConnectDevicePath (
  88   IN EFI_DEVICE_PATH_PROTOCOL  *DevicePathToConnect
  89   )
  90 {
  91   EFI_STATUS                Status;
  92   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
  93   EFI_DEVICE_PATH_PROTOCOL  *CopyOfDevicePath;
  94   EFI_DEVICE_PATH_PROTOCOL  *Instance;
  95   EFI_DEVICE_PATH_PROTOCOL  *RemainingDevicePath;
  96   EFI_DEVICE_PATH_PROTOCOL  *Next;
  97   EFI_HANDLE                Handle;
  98   EFI_HANDLE                PreviousHandle;
  99   UINTN                     Size;
 100
 101   if (DevicePathToConnect == NULL) {
 102     return EFI_SUCCESS;
 103   }
 104
 105   DevicePath        = DuplicateDevicePath (DevicePathToConnect);
 106   CopyOfDevicePath  = DevicePath;
 107   if (DevicePath == NULL) {
 108     return EFI_OUT_OF_RESOURCES;
 109   }
 110
 111   do {
 112     //
 113     // The outer loop handles multi instance device paths.
 114     // Only console variables contain multiple instance device paths.
 115     //
 116     // After this call DevicePath points to the next Instance
 117     //
 118     Instance  = GetNextDevicePathInstance (&DevicePath, &Size);
 119     Next      = Instance;
 120     while (!IsDevicePathEndType (Next)) {
 121       Next = NextDevicePathNode (Next);
 122     }
 123
 124     SetDevicePathEndNode (Next);
 125
 126     //
 127     // Start the real work of connect with RemainingDevicePath
 128     //
 129     PreviousHandle = NULL;
 130     do {
 131       //
 132       // Find the handle that best matches the Device Path. If it is only a
 133       // partial match the remaining part of the device path is returned in
 134       // RemainingDevicePath.
 135       //
 136       RemainingDevicePath = Instance;
 137       Status              = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &RemainingDevicePath, &Handle);
 138
 139       if (!EFI_ERROR (Status)) {
 140         if (Handle == PreviousHandle) {
 141           //
 142           // If no forward progress is made try invoking the Dispatcher.
 143           // A new FV may have been added to the system an new drivers
 144           // may now be found.
 145           // Status == EFI_SUCCESS means a driver was dispatched
 146           // Status == EFI_NOT_FOUND means no new drivers were dispatched
 147           //
 148           Status = gDS->Dispatch ();
 149         }
 150
 151         if (!EFI_ERROR (Status)) {
 152           PreviousHandle = Handle;
 153           //
 154           // Connect all drivers that apply to Handle and RemainingDevicePath,
 155           // the Recursive flag is FALSE so only one level will be expanded.
 156           //
 157           // Do not check the connect status here, if the connect controller fail,
 158           // then still give the chance to do dispatch, because partial
 159           // RemainingDevicepath may be in the new FV
 160           //
 161           // 1. If the connect fail, RemainingDevicepath and handle will not
 162           //    change, so next time will do the dispatch, then dispatch's status
 163           //    will take effect
 164           // 2. If the connect success, the RemainingDevicepath and handle will
 165           //    change, then avoid the dispatch, we have chance to continue the
 166           //    next connection
 167           //
 168           gBS->ConnectController (Handle, NULL, RemainingDevicePath, FALSE);
 169         }
 170       }
 171       //
 172       // Loop until RemainingDevicePath is an empty device path
 173       //
 174     } while (!EFI_ERROR (Status) && !IsDevicePathEnd (RemainingDevicePath));
 175
 176   } while (DevicePath != NULL);
 177
 178   if (CopyOfDevicePath != NULL) {
 179     SafeFreePool (CopyOfDevicePath);
 180   }
 181   //
 182   // All handle with DevicePath exists in the handle database
 183   //
 184   return Status;
 185 }
 186
 187
 188 /**
 189   This function will connect all current system handles recursively. The
 190   connection will finish until every handle's child handle created if it have.
 191
 192   @retval EFI_SUCCESS           All handles and it's child handle have been
 193                                 connected
 194   @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().
 195
 196 **/
 197 EFI_STATUS
 198 EFIAPI
 199 BdsLibConnectAllEfi (
 200   VOID
 201   )
 202 {
 203   EFI_STATUS  Status;
 204   UINTN       HandleCount;
 205   EFI_HANDLE  *HandleBuffer;
 206   UINTN       Index;
 207
 208   Status = gBS->LocateHandleBuffer (
 209                   AllHandles,
 210                   NULL,
 211                   NULL,
 212                   &HandleCount,
 213                   &HandleBuffer
 214                   );
 215   if (EFI_ERROR (Status)) {
 216     return Status;
 217   }
 218
 219   for (Index = 0; Index < HandleCount; Index++) {
 220     Status = gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);
 221   }
 222
 223   SafeFreePool (HandleBuffer);
 224
 225   return EFI_SUCCESS;
 226 }
 227
 228
 229 /**
 230   This function will disconnect all current system handles. The disconnection
 231   will finish until every handle have been disconnected.
 232
 233   @retval EFI_SUCCESS           All handles have been disconnected
 234   @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().
 235
 236 **/
 237 EFI_STATUS
 238 EFIAPI
 239 BdsLibDisconnectAllEfi (
 240   VOID
 241   )
 242 {
 243   EFI_STATUS  Status;
 244   UINTN       HandleCount;
 245   EFI_HANDLE  *HandleBuffer;
 246   UINTN       Index;
 247
 248   //
 249   // Disconnect all
 250   //
 251   Status = gBS->LocateHandleBuffer (
 252                   AllHandles,
 253                   NULL,
 254                   NULL,
 255                   &HandleCount,
 256                   &HandleBuffer
 257                   );
 258   if (EFI_ERROR (Status)) {
 259     return Status;
 260   }
 261
 262   for (Index = 0; Index < HandleCount; Index++) {
 263     Status = gBS->DisconnectController (HandleBuffer[Index], NULL, NULL);
 264   }
 265
 266   SafeFreePool (HandleBuffer);
 267
 268   return EFI_SUCCESS;
 269 }
 270
 271
 272 /**
 273   Connects all drivers to all controllers.
 274   This function make sure all the current system driver will manage
 275   the correspoinding controllers if have. And at the same time, make
 276   sure all the system controllers have driver to manage it if have.
 277
 278 **/
 279 VOID
 280 EFIAPI
 281 BdsLibConnectAllDriversToAllControllers (
 282   VOID
 283   )
 284 {
 285   EFI_STATUS  Status;
 286
 287   do {
 288     //
 289     // Connect All EFI 1.10 drivers following EFI 1.10 algorithm
 290     //
 291     BdsLibConnectAllEfi ();
 292
 293     //
 294     // Check to see if it's possible to dispatch an more DXE drivers.
 295     // The BdsLibConnectAllEfi () may have made new DXE drivers show up.
 296     // If anything is Dispatched Status == EFI_SUCCESS and we will try
 297     // the connect again.
 298     //
 299     Status = gDS->Dispatch ();
 300
 301   } while (!EFI_ERROR (Status));
 302
 303 }
 304
 305
 306 /**
 307   Connect the specific Usb device which match the short form device path,
 308   and whose bus is determined by Host Controller (Uhci or Ehci).
 309
 310   @param  HostControllerPI      Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
 311                                 (0xFF)
 312   @param  RemainingDevicePath   a short-form device path that starts with the first
 313                                 element  being a USB WWID or a USB Class device
 314                                 path
 315
 316   @return EFI_INVALID_PARAMETER
 317   @return EFI_SUCCESS
 318   @return EFI_NOT_FOUND
 319
 320 **/
 321 EFI_STATUS
 322 EFIAPI
 323 BdsLibConnectUsbDevByShortFormDP(
 324   IN UINT8                      HostControllerPI,
 325   IN EFI_DEVICE_PATH_PROTOCOL   *RemainingDevicePath
 326   )
 327 {
 328   EFI_STATUS                            Status;
 329   EFI_HANDLE                            *HandleArray;
 330   UINTN                                 HandleArrayCount;
 331   UINTN                                 Index;
 332   EFI_PCI_IO_PROTOCOL                   *PciIo;
 333   UINT8                                 Class[3];
 334   BOOLEAN                               AtLeastOneConnected;
 335
 336   //
 337   // Check the passed in parameters
 338   //
 339   if (RemainingDevicePath == NULL) {
 340     return EFI_INVALID_PARAMETER;
 341   }
 342
 343   if ((DevicePathType (RemainingDevicePath) != MESSAGING_DEVICE_PATH) ||
 344       ((DevicePathSubType (RemainingDevicePath) != MSG_USB_CLASS_DP)
 345       && (DevicePathSubType (RemainingDevicePath) != MSG_USB_WWID_DP)
 346       )) {
 347     return EFI_INVALID_PARAMETER;
 348   }
 349
 350   if (HostControllerPI != 0xFF &&
 351       HostControllerPI != 0x00 &&
 352       HostControllerPI != 0x20) {
 353     return EFI_INVALID_PARAMETER;
 354   }
 355
 356   //
 357   // Find the usb host controller firstly, then connect with the remaining device path
 358   //
 359   AtLeastOneConnected = FALSE;
 360   Status = gBS->LocateHandleBuffer (
 361                   ByProtocol,
 362                   &gEfiPciIoProtocolGuid,
 363                   NULL,
 364                   &HandleArrayCount,
 365                   &HandleArray
 366                   );
 367   if (!EFI_ERROR (Status)) {
 368     for (Index = 0; Index < HandleArrayCount; Index++) {
 369       Status = gBS->HandleProtocol (
 370                       HandleArray[Index],
 371                       &gEfiPciIoProtocolGuid,
 372                       (VOID **)&PciIo
 373                       );
 374       if (!EFI_ERROR (Status)) {
 375         //
 376         // Check whether the Pci device is the wanted usb host controller
 377         //
 378         Status = PciIo->Pci.Read (PciIo, EfiPciIoWidthUint8, 0x09, 3, &Class);
 379         if (!EFI_ERROR (Status)) {
 380           if ((PCI_CLASS_SERIAL == Class[2]) &&
 381               (PCI_CLASS_SERIAL_USB == Class[1])) {
 382             if (HostControllerPI == Class[0] || HostControllerPI == 0xFF) {
 383               Status = gBS->ConnectController (
 384                               HandleArray[Index],
 385                               NULL,
 386                               RemainingDevicePath,
 387                               FALSE
 388                               );
 389               if (!EFI_ERROR(Status)) {
 390                 AtLeastOneConnected = TRUE;
 391               }
 392             }
 393           }
 394         }
 395       }
 396     }
 397
 398     if (AtLeastOneConnected) {
 399       return EFI_SUCCESS;
 400     }
 401   }
 402
 403   return EFI_NOT_FOUND;
 404 }