2 BDS Lib functions which relate with connect the device
4 Copyright (c) 2004 - 2012, 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 ();
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 successfully, Dispatch service which load the missing drivers
73 is called according to input parameter, since in some cases no driver
74 dependency is assumed exist, so may need not to call this service.
76 @param DevicePathToConnect The device path which will be connected, it can be
77 a multi-instance device path
78 @param NeedDispatch Whether requires dispatch service during connection
80 @retval EFI_SUCCESS All handles associate with every device path node
82 @retval EFI_OUT_OF_RESOURCES There is no resource to create new handles
83 @retval EFI_NOT_FOUND Create the handle associate with one device path
88 ConnectDevicePathInternal (
89 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathToConnect
,
90 IN BOOLEAN NeedDispatch
94 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
95 EFI_DEVICE_PATH_PROTOCOL
*CopyOfDevicePath
;
96 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
97 EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
;
98 EFI_DEVICE_PATH_PROTOCOL
*Next
;
100 EFI_HANDLE PreviousHandle
;
103 if (DevicePathToConnect
== NULL
) {
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
156 Status
= gDS
->Dispatch ();
159 // Always return EFI_NOT_FOUND here
160 // to prevent dead loop when control handle is found but connection failded case
162 Status
= EFI_NOT_FOUND
;
166 if (!EFI_ERROR (Status
)) {
167 PreviousHandle
= Handle
;
169 // Connect all drivers that apply to Handle and RemainingDevicePath,
170 // the Recursive flag is FALSE so only one level will be expanded.
172 // Do not check the connect status here, if the connect controller fail,
173 // then still give the chance to do dispatch, because partial
174 // RemainingDevicepath may be in the new FV
176 // 1. If the connect fail, RemainingDevicepath and handle will not
177 // change, so next time will do the dispatch, then dispatch's status
179 // 2. If the connect success, the RemainingDevicepath and handle will
180 // change, then avoid the dispatch, we have chance to continue the
183 gBS
->ConnectController (Handle
, NULL
, RemainingDevicePath
, FALSE
);
187 // Loop until RemainingDevicePath is an empty device path
189 } while (!EFI_ERROR (Status
) && !IsDevicePathEnd (RemainingDevicePath
));
191 } while (DevicePath
!= NULL
);
193 if (CopyOfDevicePath
!= NULL
) {
194 FreePool (CopyOfDevicePath
);
197 // All handle with DevicePath exists in the handle database
204 This function will create all handles associate with every device
205 path node. If the handle associate with one device path node can not
206 be created successfully, then still give chance to do the dispatch,
207 which load the missing drivers if possible.
209 @param DevicePathToConnect The device path which will be connected, it can be
210 a multi-instance device path
212 @retval EFI_SUCCESS All handles associate with every device path node
214 @retval EFI_OUT_OF_RESOURCES There is no resource to create new handles
215 @retval EFI_NOT_FOUND Create the handle associate with one device path
221 BdsLibConnectDevicePath (
222 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePathToConnect
225 return ConnectDevicePathInternal(DevicePathToConnect
, TRUE
);
229 This function will connect all current system handles recursively.
231 gBS->ConnectController() service is invoked for each handle exist in system handler buffer.
232 If the handle is bus type handler, all childrens also will be connected recursively
233 by gBS->ConnectController().
235 @retval EFI_SUCCESS All handles and it's child handle have been connected
236 @retval EFI_STATUS Error status returned by of gBS->LocateHandleBuffer().
241 BdsLibConnectAllEfi (
247 EFI_HANDLE
*HandleBuffer
;
250 Status
= gBS
->LocateHandleBuffer (
257 if (EFI_ERROR (Status
)) {
261 for (Index
= 0; Index
< HandleCount
; Index
++) {
262 Status
= gBS
->ConnectController (HandleBuffer
[Index
], NULL
, NULL
, TRUE
);
265 if (HandleBuffer
!= NULL
) {
266 FreePool (HandleBuffer
);
273 This function will disconnect all current system handles.
275 gBS->DisconnectController() is invoked for each handle exists in system handle buffer.
276 If handle is a bus type handle, all childrens also are disconnected recursively by
277 gBS->DisconnectController().
279 @retval EFI_SUCCESS All handles have been disconnected
280 @retval EFI_STATUS Error status returned by of gBS->LocateHandleBuffer().
285 BdsLibDisconnectAllEfi (
291 EFI_HANDLE
*HandleBuffer
;
297 Status
= gBS
->LocateHandleBuffer (
304 if (EFI_ERROR (Status
)) {
308 for (Index
= 0; Index
< HandleCount
; Index
++) {
309 Status
= gBS
->DisconnectController (HandleBuffer
[Index
], NULL
, NULL
);
312 if (HandleBuffer
!= NULL
) {
313 FreePool (HandleBuffer
);
321 Connects all drivers to all controllers.
322 This function make sure all the current system driver will manage
323 the correspoinding controllers if have. And at the same time, make
324 sure all the system controllers have driver to manage it if have.
329 BdsLibConnectAllDriversToAllControllers (
337 // Connect All EFI 1.10 drivers following EFI 1.10 algorithm
339 BdsLibConnectAllEfi ();
342 // Check to see if it's possible to dispatch an more DXE drivers.
343 // The BdsLibConnectAllEfi () may have made new DXE drivers show up.
344 // If anything is Dispatched Status == EFI_SUCCESS and we will try
345 // the connect again.
347 Status
= gDS
->Dispatch ();
349 } while (!EFI_ERROR (Status
));
355 Connect the specific Usb device which match the short form device path,
356 and whose bus is determined by Host Controller (Uhci or Ehci).
358 @param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci
360 @param RemainingDevicePath a short-form device path that starts with the first
361 element being a USB WWID or a USB Class device
364 @return EFI_INVALID_PARAMETER RemainingDevicePath is NULL pointer.
365 RemainingDevicePath is not a USB device path.
366 Invalid HostControllerPI type.
367 @return EFI_SUCCESS Success to connect USB device
368 @return EFI_NOT_FOUND Fail to find handle for USB controller to connect.
373 BdsLibConnectUsbDevByShortFormDP(
374 IN UINT8 HostControllerPI
,
375 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
379 EFI_HANDLE
*HandleArray
;
380 UINTN HandleArrayCount
;
382 EFI_PCI_IO_PROTOCOL
*PciIo
;
384 BOOLEAN AtLeastOneConnected
;
387 // Check the passed in parameters
389 if (RemainingDevicePath
== NULL
) {
390 return EFI_INVALID_PARAMETER
;
393 if ((DevicePathType (RemainingDevicePath
) != MESSAGING_DEVICE_PATH
) ||
394 ((DevicePathSubType (RemainingDevicePath
) != MSG_USB_CLASS_DP
)
395 && (DevicePathSubType (RemainingDevicePath
) != MSG_USB_WWID_DP
)
397 return EFI_INVALID_PARAMETER
;
400 if (HostControllerPI
!= 0xFF &&
401 HostControllerPI
!= 0x00 &&
402 HostControllerPI
!= 0x20) {
403 return EFI_INVALID_PARAMETER
;
407 // Find the usb host controller firstly, then connect with the remaining device path
409 AtLeastOneConnected
= FALSE
;
410 Status
= gBS
->LocateHandleBuffer (
412 &gEfiPciIoProtocolGuid
,
417 if (!EFI_ERROR (Status
)) {
418 for (Index
= 0; Index
< HandleArrayCount
; Index
++) {
419 Status
= gBS
->HandleProtocol (
421 &gEfiPciIoProtocolGuid
,
424 if (!EFI_ERROR (Status
)) {
426 // Check whether the Pci device is the wanted usb host controller
428 Status
= PciIo
->Pci
.Read (PciIo
, EfiPciIoWidthUint8
, 0x09, 3, &Class
);
429 if (!EFI_ERROR (Status
)) {
430 if ((PCI_CLASS_SERIAL
== Class
[2]) &&
431 (PCI_CLASS_SERIAL_USB
== Class
[1])) {
432 if (HostControllerPI
== Class
[0] || HostControllerPI
== 0xFF) {
433 Status
= gBS
->ConnectController (
439 if (!EFI_ERROR(Status
)) {
440 AtLeastOneConnected
= TRUE
;
448 if (HandleArray
!= NULL
) {
449 FreePool (HandleArray
);
452 if (AtLeastOneConnected
) {
457 return EFI_NOT_FOUND
;