[mirror_edk2.git] / MdeModulePkg / Library / UefiBootManagerLib / BmConnect.c

/** @file\r
  Library functions which relate with connecting the device.\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "InternalBm.h"\r
\r
/**\r
  Connect all the drivers to all the controllers.\r
\r
  This function makes sure all the current system drivers manage the correspoinding\r
  controllers if have. And at the same time, makes sure all the system controllers\r
  have driver to manage it if have.\r
**/\r
VOID\r
BmConnectAllDriversToAllControllers (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       HandleCount;\r
  EFI_HANDLE  *HandleBuffer;\r
  UINTN       Index;\r
\r
  do {\r
    //\r
    // Connect All EFI 1.10 drivers following EFI 1.10 algorithm\r
    //\r
    gBS->LocateHandleBuffer (\r
           AllHandles,\r
           NULL,\r
           NULL,\r
           &HandleCount,\r
           &HandleBuffer\r
           );\r
\r
    for (Index = 0; Index < HandleCount; Index++) {\r
      gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);\r
    }\r
\r
    if (HandleBuffer != NULL) {\r
      FreePool (HandleBuffer);\r
    }\r
\r
    //\r
    // Check to see if it's possible to dispatch an more DXE drivers.\r
    // The above code may have made new DXE drivers show up.\r
    // If any new driver 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
  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
EfiBootManagerConnectAll (\r
  VOID\r
  )\r
{\r
  //\r
  // Connect the platform console first\r
  //\r
  EfiBootManagerConnectAllDefaultConsoles ();\r
\r
  //\r
  // Generic way to connect all the drivers\r
  //\r
  BmConnectAllDriversToAllControllers ();\r
\r
  //\r
  // Here we have the assumption that we have already had\r
  // platform default console\r
  //\r
  EfiBootManagerConnectAllDefaultConsoles ();\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
  @param  MatchingHandle        Return the controller handle closest to the DevicePathToConnect\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
  @retval EFI_SECURITY_VIOLATION The user has no permission to start UEFI device\r
                                 drivers on the DevicePath.\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiBootManagerConnectDevicePath (\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *DevicePathToConnect,\r
  OUT EFI_HANDLE                *MatchingHandle          OPTIONAL\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_DEVICE_PATH_PROTOCOL  *RemainingDevicePath;\r
  EFI_HANDLE                Handle;\r
  EFI_HANDLE                PreviousHandle;\r
  EFI_TPL                   CurrentTpl;\r
\r
  if (DevicePathToConnect == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  CurrentTpl = EfiGetCurrentTpl ();\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 = DevicePathToConnect;\r
    Status              = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &RemainingDevicePath, &Handle);\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
          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
\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
        // If ConnectController fails to find a driver, then still give the chance to\r
        // do dispatch, because partial 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
        Status = gBS->ConnectController (Handle, NULL, RemainingDevicePath, FALSE);\r
        if (Status == EFI_NOT_FOUND) {\r
          Status = EFI_SUCCESS;\r
        }\r
        if (MatchingHandle != NULL) {\r
          *MatchingHandle = Handle;\r
        }\r
      }\r
    }\r
    //\r
    // Loop until RemainingDevicePath is an empty device path\r
    //\r
  } while (!EFI_ERROR (Status) && !IsDevicePathEnd (RemainingDevicePath));\r
\r
  ASSERT (EFI_ERROR (Status) || IsDevicePathEnd (RemainingDevicePath));\r
\r
  return Status;\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
VOID\r
EFIAPI\r
EfiBootManagerDisconnectAll (\r
  VOID\r
  )\r
{\r
  UINTN       HandleCount;\r
  EFI_HANDLE  *HandleBuffer;\r
  UINTN       Index;\r
\r
  //\r
  // Disconnect all\r
  //\r
  gBS->LocateHandleBuffer (\r
         AllHandles,\r
         NULL,\r
         NULL,\r
         &HandleCount,\r
         &HandleBuffer\r
         );\r
  for (Index = 0; Index < HandleCount; Index++) {\r
    gBS->DisconnectController (HandleBuffer[Index], NULL, NULL);\r
  }\r
\r
  if (HandleBuffer != NULL) {\r
    FreePool (HandleBuffer);\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  DevicePath             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  DevicePath is NULL pointer.\r
                                 DevicePath is not a USB device path.\r
\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
BmConnectUsbShortFormDevicePath (\r
  IN EFI_DEVICE_PATH_PROTOCOL   *DevicePath\r
  )\r
{\r
  EFI_STATUS                            Status;\r
  EFI_HANDLE                            *Handles;\r
  UINTN                                 HandleCount;\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 (DevicePath == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((DevicePathType (DevicePath) != MESSAGING_DEVICE_PATH) ||\r
      ((DevicePathSubType (DevicePath) != MSG_USB_CLASS_DP) && (DevicePathSubType (DevicePath) != MSG_USB_WWID_DP))\r
     ) {\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
                  &HandleCount,\r
                  &Handles\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    for (Index = 0; Index < HandleCount; Index++) {\r
      Status = gBS->HandleProtocol (\r
                      Handles[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
            ((PCI_CLASS_SERIAL == Class[2]) && (PCI_CLASS_SERIAL_USB == Class[1]))\r
           ) {\r
          Status = gBS->ConnectController (\r
                          Handles[Index],\r
                          NULL,\r
                          DevicePath,\r
                          FALSE\r
                          );\r
          if (!EFI_ERROR(Status)) {\r
            AtLeastOneConnected = TRUE;\r
          }\r
        }\r
      }\r
    }\r
\r
    if (Handles != NULL) {\r
      FreePool (Handles);\r
    }\r
  }\r
\r
  return AtLeastOneConnected ? EFI_SUCCESS : EFI_NOT_FOUND;\r
}\r
Commit	Line	Data
067ed98a RN	1	/** @file\r
	2	Library functions which relate with connecting the device.\r
	3	\r
d1102dba	4	Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
9d510e61	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
067ed98a RN	6	\r
	7	**/\r
	8	\r
	9	#include "InternalBm.h"\r
	10	\r
	11	/**\r
	12	Connect all the drivers to all the controllers.\r
	13	\r
	14	This function makes sure all the current system drivers manage the correspoinding\r
	15	controllers if have. And at the same time, makes sure all the system controllers\r
	16	have driver to manage it if have.\r
	17	**/\r
	18	VOID\r
	19	BmConnectAllDriversToAllControllers (\r
	20	VOID\r
	21	)\r
	22	{\r
	23	EFI_STATUS Status;\r
	24	UINTN HandleCount;\r
	25	EFI_HANDLE *HandleBuffer;\r
	26	UINTN Index;\r
	27	\r
	28	do {\r
	29	//\r
	30	// Connect All EFI 1.10 drivers following EFI 1.10 algorithm\r
	31	//\r
	32	gBS->LocateHandleBuffer (\r
	33	AllHandles,\r
	34	NULL,\r
	35	NULL,\r
	36	&HandleCount,\r
	37	&HandleBuffer\r
	38	);\r
	39	\r
	40	for (Index = 0; Index < HandleCount; Index++) {\r
	41	gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);\r
	42	}\r
	43	\r
	44	if (HandleBuffer != NULL) {\r
	45	FreePool (HandleBuffer);\r
	46	}\r
	47	\r
	48	//\r
	49	// Check to see if it's possible to dispatch an more DXE drivers.\r
	50	// The above code may have made new DXE drivers show up.\r
	51	// If any new driver is dispatched (Status == EFI_SUCCESS) and we will try\r
	52	// the connect again.\r
	53	//\r
	54	Status = gDS->Dispatch ();\r
	55	\r
	56	} while (!EFI_ERROR (Status));\r
	57	}\r
	58	\r
	59	/**\r
	60	This function will connect all the system driver to controller\r
	61	first, and then special connect the default console, this make\r
	62	sure all the system controller available and the platform default\r
	63	console connected.\r
	64	\r
	65	**/\r
	66	VOID\r
	67	EFIAPI\r
	68	EfiBootManagerConnectAll (\r
	69	VOID\r
70	)\r
71	{\r
72	//\r
73	// Connect the platform console first\r
74	//\r
75	EfiBootManagerConnectAllDefaultConsoles ();\r
76	\r
77	//\r
78	// Generic way to connect all the drivers\r
79	//\r
80	BmConnectAllDriversToAllControllers ();\r
81	\r
82	//\r
83	// Here we have the assumption that we have already had\r
84	// platform default console\r
85	//\r
86	EfiBootManagerConnectAllDefaultConsoles ();\r
87	}\r
88	\r
89	/**\r
90	This function will create all handles associate with every device\r
91	path node. If the handle associate with one device path node can not\r
92	be created successfully, then still give chance to do the dispatch,\r
93	which load the missing drivers if possible.\r
94	\r
95	@param DevicePathToConnect The device path which will be connected, it can be\r
96	a multi-instance device path\r
97	@param MatchingHandle Return the controller handle closest to the DevicePathToConnect\r
98	\r
99	@retval EFI_SUCCESS All handles associate with every device path node\r
100	have been created.\r
101	@retval EFI_OUT_OF_RESOURCES There is no resource to create new handles.\r
102	@retval EFI_NOT_FOUND Create the handle associate with one device path\r
103	node failed.\r
d1102dba	104	@retval EFI_SECURITY_VIOLATION The user has no permission to start UEFI device\r
067ed98a RN	105	drivers on the DevicePath.\r
	106	**/\r
	107	EFI_STATUS\r
	108	EFIAPI\r
	109	EfiBootManagerConnectDevicePath (\r
	110	IN EFI_DEVICE_PATH_PROTOCOL *DevicePathToConnect,\r
	111	OUT EFI_HANDLE *MatchingHandle OPTIONAL\r
	112	)\r
	113	{\r
	114	EFI_STATUS Status;\r
	115	EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath;\r
	116	EFI_HANDLE Handle;\r
	117	EFI_HANDLE PreviousHandle;\r
	118	EFI_TPL CurrentTpl;\r
	119	\r
	120	if (DevicePathToConnect == NULL) {\r
	121	return EFI_INVALID_PARAMETER;\r
	122	}\r
	123	\r
	124	CurrentTpl = EfiGetCurrentTpl ();\r
	125	//\r
	126	// Start the real work of connect with RemainingDevicePath\r
	127	//\r
	128	PreviousHandle = NULL;\r
	129	do {\r
	130	//\r
	131	// Find the handle that best matches the Device Path. If it is only a\r
	132	// partial match the remaining part of the device path is returned in\r
	133	// RemainingDevicePath.\r
	134	//\r
	135	RemainingDevicePath = DevicePathToConnect;\r
	136	Status = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &RemainingDevicePath, &Handle);\r
	137	if (!EFI_ERROR (Status)) {\r
	138	if (Handle == PreviousHandle) {\r
	139	//\r
	140	// If no forward progress is made try invoking the Dispatcher.\r
	141	// A new FV may have been added to the system an new drivers\r
	142	// may now be found.\r
	143	// Status == EFI_SUCCESS means a driver was dispatched\r
	144	// Status == EFI_NOT_FOUND means no new drivers were dispatched\r
	145	//\r
	146	if (CurrentTpl == TPL_APPLICATION) {\r
	147	Status = gDS->Dispatch ();\r
	148	} else {\r
	149	//\r
	150	// Always return EFI_NOT_FOUND here\r
	151	// to prevent dead loop when control handle is found but connection failded case\r
	152	//\r
	153	Status = EFI_NOT_FOUND;\r
	154	}\r
	155	}\r
	156	\r
	157	\r
	158	if (!EFI_ERROR (Status)) {\r
	159	PreviousHandle = Handle;\r
	160	//\r
	161	// Connect all drivers that apply to Handle and RemainingDevicePath,\r
	162	// the Recursive flag is FALSE so only one level will be expanded.\r
	163	//\r
d1102dba	164	// If ConnectController fails to find a driver, then still give the chance to\r
067ed98a RN	165	// do dispatch, because partial RemainingDevicePath may be in the new FV\r
	166	//\r
	167	// 1. If the connect fail, RemainingDevicepath and handle will not\r
	168	// change, so next time will do the dispatch, then dispatch's status\r
	169	// will take effect\r
	170	// 2. If the connect success, the RemainingDevicepath and handle will\r
	171	// change, then avoid the dispatch, we have chance to continue the\r
	172	// next connection\r
	173	//\r
	174	Status = gBS->ConnectController (Handle, NULL, RemainingDevicePath, FALSE);\r
	175	if (Status == EFI_NOT_FOUND) {\r
	176	Status = EFI_SUCCESS;\r
	177	}\r
	178	if (MatchingHandle != NULL) {\r
	179	*MatchingHandle = Handle;\r
	180	}\r
	181	}\r
	182	}\r
	183	//\r
	184	// Loop until RemainingDevicePath is an empty device path\r
	185	//\r
	186	} while (!EFI_ERROR (Status) && !IsDevicePathEnd (RemainingDevicePath));\r
	187	\r
	188	ASSERT (EFI_ERROR (Status) \|\| IsDevicePathEnd (RemainingDevicePath));\r
	189	\r
	190	return Status;\r
	191	}\r
	192	\r
	193	/**\r
d1102dba LG	194	This function will disconnect all current system handles.\r
d1102dba LG	195	\r
067ed98a RN	196	gBS->DisconnectController() is invoked for each handle exists in system handle buffer.\r
	197	If handle is a bus type handle, all childrens also are disconnected recursively by\r
	198	gBS->DisconnectController().\r
	199	**/\r
	200	VOID\r
	201	EFIAPI\r
	202	EfiBootManagerDisconnectAll (\r
	203	VOID\r
	204	)\r
	205	{\r
	206	UINTN HandleCount;\r
	207	EFI_HANDLE *HandleBuffer;\r
	208	UINTN Index;\r
	209	\r
	210	//\r
	211	// Disconnect all\r
	212	//\r
	213	gBS->LocateHandleBuffer (\r
	214	AllHandles,\r
	215	NULL,\r
	216	NULL,\r
	217	&HandleCount,\r
	218	&HandleBuffer\r
	219	);\r
	220	for (Index = 0; Index < HandleCount; Index++) {\r
	221	gBS->DisconnectController (HandleBuffer[Index], NULL, NULL);\r
	222	}\r
	223	\r
	224	if (HandleBuffer != NULL) {\r
	225	FreePool (HandleBuffer);\r
	226	}\r
	227	}\r
	228	\r
	229	/**\r
	230	Connect the specific Usb device which match the short form device path,\r
	231	and whose bus is determined by Host Controller (Uhci or Ehci).\r
	232	\r
	233	@param DevicePath A short-form device path that starts with the first\r
	234	element being a USB WWID or a USB Class device\r
	235	path\r
	236	\r
	237	@return EFI_INVALID_PARAMETER DevicePath is NULL pointer.\r
	238	DevicePath is not a USB device path.\r
	239	\r
	240	@return EFI_SUCCESS Success to connect USB device\r
	241	@return EFI_NOT_FOUND Fail to find handle for USB controller to connect.\r
	242	\r
	243	**/\r
	244	EFI_STATUS\r
	245	BmConnectUsbShortFormDevicePath (\r
	246	IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
	247	)\r
	248	{\r
	249	EFI_STATUS Status;\r
	250	EFI_HANDLE *Handles;\r
	251	UINTN HandleCount;\r
	252	UINTN Index;\r
	253	EFI_PCI_IO_PROTOCOL *PciIo;\r
	254	UINT8 Class[3];\r
	255	BOOLEAN AtLeastOneConnected;\r
	256	\r
	257	//\r
	258	// Check the passed in parameters\r
	259	//\r
260	if (DevicePath == NULL) {\r
261	return EFI_INVALID_PARAMETER;\r
262	}\r
263	\r
264	if ((DevicePathType (DevicePath) != MESSAGING_DEVICE_PATH) \|\|\r
265	((DevicePathSubType (DevicePath) != MSG_USB_CLASS_DP) && (DevicePathSubType (DevicePath) != MSG_USB_WWID_DP))\r
266	) {\r
267	return EFI_INVALID_PARAMETER;\r
268	}\r
269	\r
270	//\r
271	// Find the usb host controller firstly, then connect with the remaining device path\r
272	//\r
273	AtLeastOneConnected = FALSE;\r
274	Status = gBS->LocateHandleBuffer (\r
275	ByProtocol,\r
276	&gEfiPciIoProtocolGuid,\r
277	NULL,\r
278	&HandleCount,\r
279	&Handles\r
280	);\r
281	if (!EFI_ERROR (Status)) {\r
282	for (Index = 0; Index < HandleCount; Index++) {\r
283	Status = gBS->HandleProtocol (\r
284	Handles[Index],\r
285	&gEfiPciIoProtocolGuid,\r
286	(VOID **) &PciIo\r
287	);\r
288	if (!EFI_ERROR (Status)) {\r
289	//\r
290	// Check whether the Pci device is the wanted usb host controller\r
291	//\r
292	Status = PciIo->Pci.Read (PciIo, EfiPciIoWidthUint8, 0x09, 3, &Class);\r
293	if (!EFI_ERROR (Status) &&\r
294	((PCI_CLASS_SERIAL == Class[2]) && (PCI_CLASS_SERIAL_USB == Class[1]))\r
295	) {\r
296	Status = gBS->ConnectController (\r
297	Handles[Index],\r
298	NULL,\r
299	DevicePath,\r
300	FALSE\r
301	);\r
302	if (!EFI_ERROR(Status)) {\r
303	AtLeastOneConnected = TRUE;\r
304	}\r
305	}\r
306	}\r
307	}\r
308	\r
309	if (Handles != NULL) {\r
310	FreePool (Handles);\r
311	}\r
312	}\r
313	\r
314	return AtLeastOneConnected ? EFI_SUCCESS : EFI_NOT_FOUND;\r
315	}\r