2 BDS Lib functions which relate with connect the device
4 Copyright (c) 2004 - 2013, 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
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.
15 #include "InternalBdsLib.h"
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
32 // Connect the platform console first
34 BdsLibConnectAllDefaultConsoles ();
37 // Generic way to connect all the drivers
39 BdsLibConnectAllDriversToAllControllers ();
42 // Here we have the assumption that we have already had
43 // platform default console
45 BdsLibConnectAllDefaultConsoles ();
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.
57 BdsLibGenericConnectAll (
62 // Most generic way to connect all the drivers
64 BdsLibConnectAllDriversToAllControllers ();
65 BdsLibConnectAllConsoles ();
69 This function will create all handles associate with every device
70 path node. If the handle associate with one device path node can not
71 be created successfully, then still give chance to do the dispatch,
72 which load the missing drivers if possible.
74 @param DevicePathToConnect The device path which will be connected, it can be
75 a multi-instance device path
77 @retval EFI_SUCCESS All handles associate with every device path node
79 @retval EFI_OUT_OF_RESOURCES There is no resource to create new handles
80 @retval EFI_NOT_FOUND Create the handle associate with one device path
86 BdsLibConnectDevicePath (
87 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathToConnect
91 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
92 EFI_DEVICE_PATH_PROTOCOL
*CopyOfDevicePath
;
93 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
94 EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
;
95 EFI_DEVICE_PATH_PROTOCOL
*Next
;
97 EFI_HANDLE PreviousHandle
;
101 if (DevicePathToConnect
== NULL
) {
105 CurrentTpl
= EfiGetCurrentTpl ();
107 DevicePath
= DuplicateDevicePath (DevicePathToConnect
);
108 if (DevicePath
== NULL
) {
109 return EFI_OUT_OF_RESOURCES
;
111 CopyOfDevicePath
= DevicePath
;
115 // The outer loop handles multi instance device paths.
116 // Only console variables contain multiple instance device paths.
118 // After this call DevicePath points to the next Instance
120 Instance
= GetNextDevicePathInstance (&DevicePath
, &Size
);
121 if (Instance
== NULL
) {
122 FreePool (CopyOfDevicePath
);
123 return EFI_OUT_OF_RESOURCES
;
127 while (!IsDevicePathEndType (Next
)) {
128 Next
= NextDevicePathNode (Next
);
131 SetDevicePathEndNode (Next
);
134 // Start the real work of connect with RemainingDevicePath
136 PreviousHandle
= NULL
;
139 // Find the handle that best matches the Device Path. If it is only a
140 // partial match the remaining part of the device path is returned in
141 // RemainingDevicePath.
143 RemainingDevicePath
= Instance
;
144 Status
= gBS
->LocateDevicePath (&gEfiDevicePathProtocolGuid
, &RemainingDevicePath
, &Handle
);
146 if (!EFI_ERROR (Status
)) {
147 if (Handle
== PreviousHandle
) {
149 // If no forward progress is made try invoking the Dispatcher.
150 // A new FV may have been added to the system an new drivers
152 // Status == EFI_SUCCESS means a driver was dispatched
153 // Status == EFI_NOT_FOUND means no new drivers were dispatched
155 if (CurrentTpl
== TPL_APPLICATION
) {
157 // Dispatch calls LoadImage/StartImage which cannot run at TPL > TPL_APPLICATION
159 Status
= gDS
->Dispatch ();
162 // Always return EFI_NOT_FOUND here
163 // to prevent dead loop when control handle is found but connection failded case
165 Status
= EFI_NOT_FOUND
;
169 if (!EFI_ERROR (Status
)) {
170 PreviousHandle
= Handle
;
172 // Connect all drivers that apply to Handle and RemainingDevicePath,
173 // the Recursive flag is FALSE so only one level will be expanded.
175 // Do not check the connect status here, if the connect controller fail,
176 // then still give the chance to do dispatch, because partial
177 // RemainingDevicepath may be in the new FV
179 // 1. If the connect fail, RemainingDevicepath and handle will not
180 // change, so next time will do the dispatch, then dispatch's status
182 // 2. If the connect success, the RemainingDevicepath and handle will
183 // change, then avoid the dispatch, we have chance to continue the
186 gBS
->ConnectController (Handle
, NULL
, RemainingDevicePath
, FALSE
);
190 // Loop until RemainingDevicePath is an empty device path
192 } while (!EFI_ERROR (Status
) && !IsDevicePathEnd (RemainingDevicePath
));
194 } while (DevicePath
!= NULL
);
196 if (CopyOfDevicePath
!= NULL
) {
197 FreePool (CopyOfDevicePath
);
200 // All handle with DevicePath exists in the handle database
206 This function will connect all current system handles recursively.
208 gBS->ConnectController() service is invoked for each handle exist in system handler buffer.
209 If the handle is bus type handler, all childrens also will be connected recursively
210 by gBS->ConnectController().
212 @retval EFI_SUCCESS All handles and it's child handle have been connected
213 @retval EFI_STATUS Error status returned by of gBS->LocateHandleBuffer().
218 BdsLibConnectAllEfi (
224 EFI_HANDLE
*HandleBuffer
;
227 Status
= gBS
->LocateHandleBuffer (
234 if (EFI_ERROR (Status
)) {
238 for (Index
= 0; Index
< HandleCount
; Index
++) {
239 Status
= gBS
->ConnectController (HandleBuffer
[Index
], NULL
, NULL
, TRUE
);
242 if (HandleBuffer
!= NULL
) {
243 FreePool (HandleBuffer
);
250 This function will disconnect all current system handles.
252 gBS->DisconnectController() is invoked for each handle exists in system handle buffer.
253 If handle is a bus type handle, all childrens also are disconnected recursively by
254 gBS->DisconnectController().
256 @retval EFI_SUCCESS All handles have been disconnected
257 @retval EFI_STATUS Error status returned by of gBS->LocateHandleBuffer().
262 BdsLibDisconnectAllEfi (
268 EFI_HANDLE
*HandleBuffer
;
274 Status
= gBS
->LocateHandleBuffer (
281 if (EFI_ERROR (Status
)) {
285 for (Index
= 0; Index
< HandleCount
; Index
++) {
286 Status
= gBS
->DisconnectController (HandleBuffer
[Index
], NULL
, NULL
);
289 if (HandleBuffer
!= NULL
) {
290 FreePool (HandleBuffer
);
298 Connects all drivers to all controllers.
299 This function make sure all the current system driver will manage
300 the correspoinding controllers if have. And at the same time, make
301 sure all the system controllers have driver to manage it if have.
306 BdsLibConnectAllDriversToAllControllers (
314 // Connect All EFI 1.10 drivers following EFI 1.10 algorithm
316 BdsLibConnectAllEfi ();
319 // Check to see if it's possible to dispatch an more DXE drivers.
320 // The BdsLibConnectAllEfi () may have made new DXE drivers show up.
321 // If anything is Dispatched Status == EFI_SUCCESS and we will try
322 // the connect again.
324 Status
= gDS
->Dispatch ();
326 } while (!EFI_ERROR (Status
));
332 Connect the specific Usb device which match the short form device path,
333 and whose bus is determined by Host Controller (Uhci or Ehci).
335 @param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
337 @param RemainingDevicePath a short-form device path that starts with the first
338 element being a USB WWID or a USB Class device
341 @return EFI_INVALID_PARAMETER RemainingDevicePath is NULL pointer.
342 RemainingDevicePath is not a USB device path.
343 Invalid HostControllerPI type.
344 @return EFI_SUCCESS Success to connect USB device
345 @return EFI_NOT_FOUND Fail to find handle for USB controller to connect.
350 BdsLibConnectUsbDevByShortFormDP(
351 IN UINT8 HostControllerPI
,
352 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
356 EFI_HANDLE
*HandleArray
;
357 UINTN HandleArrayCount
;
359 EFI_PCI_IO_PROTOCOL
*PciIo
;
361 BOOLEAN AtLeastOneConnected
;
364 // Check the passed in parameters
366 if (RemainingDevicePath
== NULL
) {
367 return EFI_INVALID_PARAMETER
;
370 if ((DevicePathType (RemainingDevicePath
) != MESSAGING_DEVICE_PATH
) ||
371 ((DevicePathSubType (RemainingDevicePath
) != MSG_USB_CLASS_DP
)
372 && (DevicePathSubType (RemainingDevicePath
) != MSG_USB_WWID_DP
)
374 return EFI_INVALID_PARAMETER
;
377 if (HostControllerPI
!= 0xFF &&
378 HostControllerPI
!= 0x00 &&
379 HostControllerPI
!= 0x20) {
380 return EFI_INVALID_PARAMETER
;
384 // Find the usb host controller firstly, then connect with the remaining device path
386 AtLeastOneConnected
= FALSE
;
387 Status
= gBS
->LocateHandleBuffer (
389 &gEfiPciIoProtocolGuid
,
394 if (!EFI_ERROR (Status
)) {
395 for (Index
= 0; Index
< HandleArrayCount
; Index
++) {
396 Status
= gBS
->HandleProtocol (
398 &gEfiPciIoProtocolGuid
,
401 if (!EFI_ERROR (Status
)) {
403 // Check whether the Pci device is the wanted usb host controller
405 Status
= PciIo
->Pci
.Read (PciIo
, EfiPciIoWidthUint8
, 0x09, 3, &Class
);
406 if (!EFI_ERROR (Status
)) {
407 if ((PCI_CLASS_SERIAL
== Class
[2]) &&
408 (PCI_CLASS_SERIAL_USB
== Class
[1])) {
409 if (HostControllerPI
== Class
[0] || HostControllerPI
== 0xFF) {
410 Status
= gBS
->ConnectController (
416 if (!EFI_ERROR(Status
)) {
417 AtLeastOneConnected
= TRUE
;
425 if (HandleArray
!= NULL
) {
426 FreePool (HandleArray
);
429 if (AtLeastOneConnected
) {
434 return EFI_NOT_FOUND
;