IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConnect.c

   1 /** @file
   2   BDS Lib functions which relate with connect the device
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>
   5 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 available 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 available
  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   if (DevicePath == NULL) {
 107     return EFI_OUT_OF_RESOURCES;
 108   }
 109   CopyOfDevicePath  = DevicePath;
 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     if (Instance == NULL) {
 120       FreePool (CopyOfDevicePath);
 121       return EFI_OUT_OF_RESOURCES;
 122     }
 123
 124     Next      = Instance;
 125     while (!IsDevicePathEndType (Next)) {
 126       Next = NextDevicePathNode (Next);
 127     }
 128
 129     SetDevicePathEndNode (Next);
 130
 131     //
 132     // Start the real work of connect with RemainingDevicePath
 133     //
 134     PreviousHandle = NULL;
 135     do {
 136       //
 137       // Find the handle that best matches the Device Path. If it is only a
 138       // partial match the remaining part of the device path is returned in
 139       // RemainingDevicePath.
 140       //
 141       RemainingDevicePath = Instance;
 142       Status              = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &RemainingDevicePath, &Handle);
 143
 144       if (!EFI_ERROR (Status)) {
 145         if (Handle == PreviousHandle) {
 146           //
 147           // If no forward progress is made try invoking the Dispatcher.
 148           // A new FV may have been added to the system an new drivers
 149           // may now be found.
 150           // Status == EFI_SUCCESS means a driver was dispatched
 151           // Status == EFI_NOT_FOUND means no new drivers were dispatched
 152           //
 153           Status = gDS->Dispatch ();
 154         }
 155
 156         if (!EFI_ERROR (Status)) {
 157           PreviousHandle = Handle;
 158           //
 159           // Connect all drivers that apply to Handle and RemainingDevicePath,
 160           // the Recursive flag is FALSE so only one level will be expanded.
 161           //
 162           // Do not check the connect status here, if the connect controller fail,
 163           // then still give the chance to do dispatch, because partial
 164           // RemainingDevicepath may be in the new FV
 165           //
 166           // 1. If the connect fail, RemainingDevicepath and handle will not
 167           //    change, so next time will do the dispatch, then dispatch's status
 168           //    will take effect
 169           // 2. If the connect success, the RemainingDevicepath and handle will
 170           //    change, then avoid the dispatch, we have chance to continue the
 171           //    next connection
 172           //
 173           gBS->ConnectController (Handle, NULL, RemainingDevicePath, FALSE);
 174         }
 175       }
 176       //
 177       // Loop until RemainingDevicePath is an empty device path
 178       //
 179     } while (!EFI_ERROR (Status) && !IsDevicePathEnd (RemainingDevicePath));
 180
 181   } while (DevicePath != NULL);
 182
 183   if (CopyOfDevicePath != NULL) {
 184     FreePool (CopyOfDevicePath);
 185   }
 186   //
 187   // All handle with DevicePath exists in the handle database
 188   //
 189   return Status;
 190 }
 191
 192
 193 /**
 194   This function will connect all current system handles recursively.
 195
 196   gBS->ConnectController() service is invoked for each handle exist in system handler buffer.
 197   If the handle is bus type handler, all childrens also will be connected recursively
 198   by gBS->ConnectController().
 199
 200   @retval EFI_SUCCESS           All handles and it's child handle have been connected
 201   @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().
 202
 203 **/
 204 EFI_STATUS
 205 EFIAPI
 206 BdsLibConnectAllEfi (
 207   VOID
 208   )
 209 {
 210   EFI_STATUS  Status;
 211   UINTN       HandleCount;
 212   EFI_HANDLE  *HandleBuffer;
 213   UINTN       Index;
 214
 215   Status = gBS->LocateHandleBuffer (
 216                   AllHandles,
 217                   NULL,
 218                   NULL,
 219                   &HandleCount,
 220                   &HandleBuffer
 221                   );
 222   if (EFI_ERROR (Status)) {
 223     return Status;
 224   }
 225
 226   for (Index = 0; Index < HandleCount; Index++) {
 227     Status = gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);
 228   }
 229
 230   if (HandleBuffer != NULL) {
 231     FreePool (HandleBuffer);
 232   }
 233
 234   return EFI_SUCCESS;
 235 }
 236
 237 /**
 238   This function will disconnect all current system handles.
 239
 240   gBS->DisconnectController() is invoked for each handle exists in system handle buffer.
 241   If handle is a bus type handle, all childrens also are disconnected recursively by
 242   gBS->DisconnectController().
 243
 244   @retval EFI_SUCCESS           All handles have been disconnected
 245   @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().
 246
 247 **/
 248 EFI_STATUS
 249 EFIAPI
 250 BdsLibDisconnectAllEfi (
 251   VOID
 252   )
 253 {
 254   EFI_STATUS  Status;
 255   UINTN       HandleCount;
 256   EFI_HANDLE  *HandleBuffer;
 257   UINTN       Index;
 258
 259   //
 260   // Disconnect all
 261   //
 262   Status = gBS->LocateHandleBuffer (
 263                   AllHandles,
 264                   NULL,
 265                   NULL,
 266                   &HandleCount,
 267                   &HandleBuffer
 268                   );
 269   if (EFI_ERROR (Status)) {
 270     return Status;
 271   }
 272
 273   for (Index = 0; Index < HandleCount; Index++) {
 274     Status = gBS->DisconnectController (HandleBuffer[Index], NULL, NULL);
 275   }
 276
 277   if (HandleBuffer != NULL) {
 278     FreePool (HandleBuffer);
 279   }
 280
 281   return EFI_SUCCESS;
 282 }
 283
 284
 285 /**
 286   Connects all drivers to all controllers.
 287   This function make sure all the current system driver will manage
 288   the correspoinding controllers if have. And at the same time, make
 289   sure all the system controllers have driver to manage it if have.
 290
 291 **/
 292 VOID
 293 EFIAPI
 294 BdsLibConnectAllDriversToAllControllers (
 295   VOID
 296   )
 297 {
 298   EFI_STATUS  Status;
 299
 300   do {
 301     //
 302     // Connect All EFI 1.10 drivers following EFI 1.10 algorithm
 303     //
 304     BdsLibConnectAllEfi ();
 305
 306     //
 307     // Check to see if it's possible to dispatch an more DXE drivers.
 308     // The BdsLibConnectAllEfi () may have made new DXE drivers show up.
 309     // If anything is Dispatched Status == EFI_SUCCESS and we will try
 310     // the connect again.
 311     //
 312     Status = gDS->Dispatch ();
 313
 314   } while (!EFI_ERROR (Status));
 315
 316 }
 317
 318
 319 /**
 320   Connect the specific Usb device which match the short form device path,
 321   and whose bus is determined by Host Controller (Uhci or Ehci).
 322
 323   @param  HostControllerPI      Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
 324                                 (0xFF)
 325   @param  RemainingDevicePath   a short-form device path that starts with the first
 326                                 element  being a USB WWID or a USB Class device
 327                                 path
 328
 329   @return EFI_INVALID_PARAMETER  RemainingDevicePath is NULL pointer.
 330                                  RemainingDevicePath is not a USB device path.
 331                                  Invalid HostControllerPI type.
 332   @return EFI_SUCCESS            Success to connect USB device
 333   @return EFI_NOT_FOUND          Fail to find handle for USB controller to connect.
 334
 335 **/
 336 EFI_STATUS
 337 EFIAPI
 338 BdsLibConnectUsbDevByShortFormDP(
 339   IN UINT8                      HostControllerPI,
 340   IN EFI_DEVICE_PATH_PROTOCOL   *RemainingDevicePath
 341   )
 342 {
 343   EFI_STATUS                            Status;
 344   EFI_HANDLE                            *HandleArray;
 345   UINTN                                 HandleArrayCount;
 346   UINTN                                 Index;
 347   EFI_PCI_IO_PROTOCOL                   *PciIo;
 348   UINT8                                 Class[3];
 349   BOOLEAN                               AtLeastOneConnected;
 350
 351   //
 352   // Check the passed in parameters
 353   //
 354   if (RemainingDevicePath == NULL) {
 355     return EFI_INVALID_PARAMETER;
 356   }
 357
 358   if ((DevicePathType (RemainingDevicePath) != MESSAGING_DEVICE_PATH) ||
 359       ((DevicePathSubType (RemainingDevicePath) != MSG_USB_CLASS_DP)
 360       && (DevicePathSubType (RemainingDevicePath) != MSG_USB_WWID_DP)
 361       )) {
 362     return EFI_INVALID_PARAMETER;
 363   }
 364
 365   if (HostControllerPI != 0xFF &&
 366       HostControllerPI != 0x00 &&
 367       HostControllerPI != 0x20) {
 368     return EFI_INVALID_PARAMETER;
 369   }
 370
 371   //
 372   // Find the usb host controller firstly, then connect with the remaining device path
 373   //
 374   AtLeastOneConnected = FALSE;
 375   Status = gBS->LocateHandleBuffer (
 376                   ByProtocol,
 377                   &gEfiPciIoProtocolGuid,
 378                   NULL,
 379                   &HandleArrayCount,
 380                   &HandleArray
 381                   );
 382   if (!EFI_ERROR (Status)) {
 383     for (Index = 0; Index < HandleArrayCount; Index++) {
 384       Status = gBS->HandleProtocol (
 385                       HandleArray[Index],
 386                       &gEfiPciIoProtocolGuid,
 387                       (VOID **)&PciIo
 388                       );
 389       if (!EFI_ERROR (Status)) {
 390         //
 391         // Check whether the Pci device is the wanted usb host controller
 392         //
 393         Status = PciIo->Pci.Read (PciIo, EfiPciIoWidthUint8, 0x09, 3, &Class);
 394         if (!EFI_ERROR (Status)) {
 395           if ((PCI_CLASS_SERIAL == Class[2]) &&
 396               (PCI_CLASS_SERIAL_USB == Class[1])) {
 397             if (HostControllerPI == Class[0] || HostControllerPI == 0xFF) {
 398               Status = gBS->ConnectController (
 399                               HandleArray[Index],
 400                               NULL,
 401                               RemainingDevicePath,
 402                               FALSE
 403                               );
 404               if (!EFI_ERROR(Status)) {
 405                 AtLeastOneConnected = TRUE;
 406               }
 407             }
 408           }
 409         }
 410       }
 411     }
 412
 413     if (AtLeastOneConnected) {
 414       return EFI_SUCCESS;
 415     }
 416   }
 417
 418   return EFI_NOT_FOUND;
 419 }