2 BDS Lib functions which contain all the code to connect console device
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
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"
18 Check if we need to save the EFI variable with "ConVarName" as name
21 @param ConVarName The name of the EFI variable.
23 @retval TRUE Set the EFI variabel as NV type.
24 @retval FALSE EFI variabel as NV type can be set NonNV.
36 // If the variable includes "Dev" at last, we consider
37 // it does not support NV attribute.
39 while (*Ptr
!= L
'\0') {
43 if ((*(Ptr
- 3) == 'D') && (*(Ptr
- 2) == 'e') && (*(Ptr
- 1) == 'v')) {
52 This function update console variable based on ConVarName, it can
53 add or remove one specific console device path from the variable
55 @param ConVarName Console related variable name, ConIn, ConOut,
57 @param CustomizedConDevicePath The console device path which will be added to
58 the console variable ConVarName, this parameter
59 can not be multi-instance.
60 @param ExclusiveDevicePath The console device path which will be removed
61 from the console variable ConVarName, this
62 parameter can not be multi-instance.
64 @retval EFI_UNSUPPORTED Add or remove the same device path.
65 @retval EFI_SUCCESS Success add or remove the device path from the
71 BdsLibUpdateConsoleVariable (
72 IN CHAR16
*ConVarName
,
73 IN EFI_DEVICE_PATH_PROTOCOL
*CustomizedConDevicePath
,
74 IN EFI_DEVICE_PATH_PROTOCOL
*ExclusiveDevicePath
77 EFI_DEVICE_PATH_PROTOCOL
*VarConsole
;
79 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
80 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
87 // Notes: check the device path point, here should check
88 // with compare memory
90 if (CustomizedConDevicePath
== ExclusiveDevicePath
) {
91 return EFI_UNSUPPORTED
;
94 // Delete the ExclusiveDevicePath from current default console
96 VarConsole
= BdsLibGetVariableAndSize (
98 &gEfiGlobalVariableGuid
,
103 // Initialize NewDevicePath
105 NewDevicePath
= VarConsole
;
108 // If ExclusiveDevicePath is even the part of the instance in VarConsole, delete it.
109 // In the end, NewDevicePath is the final device path.
111 if (ExclusiveDevicePath
!= NULL
&& VarConsole
!= NULL
) {
112 NewDevicePath
= BdsLibDelPartMatchInstance (VarConsole
, ExclusiveDevicePath
);
115 // Try to append customized device path to NewDevicePath.
117 if (CustomizedConDevicePath
!= NULL
) {
118 if (!BdsLibMatchDevicePaths (NewDevicePath
, CustomizedConDevicePath
)) {
120 // Check if there is part of CustomizedConDevicePath in NewDevicePath, delete it.
122 NewDevicePath
= BdsLibDelPartMatchInstance (NewDevicePath
, CustomizedConDevicePath
);
124 // In the first check, the default console variable will be _ModuleEntryPoint,
125 // just append current customized device path
127 TempNewDevicePath
= NewDevicePath
;
128 NewDevicePath
= AppendDevicePathInstance (NewDevicePath
, CustomizedConDevicePath
);
129 SafeFreePool(TempNewDevicePath
);
134 // The attribute for ConInDev, ConOutDev and ErrOutDev does not include NV.
136 if (IsNvNeed(ConVarName
)) {
138 // ConVarName has NV attribute.
140 Attributes
= EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
;
143 // ConVarName does not have NV attribute.
145 Attributes
= EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
;
149 // Finally, Update the variable of the default console by NewDevicePath
153 &gEfiGlobalVariableGuid
,
155 GetDevicePathSize (NewDevicePath
),
159 if (VarConsole
== NewDevicePath
) {
160 SafeFreePool(VarConsole
);
162 SafeFreePool(VarConsole
);
163 SafeFreePool(NewDevicePath
);
172 Connect the console device base on the variable ConVarName, if
173 device path of the ConVarName is multi-instance device path, if
174 anyone of the instances is connected success, then this function
177 @param ConVarName Console related variable name, ConIn, ConOut,
180 @retval EFI_NOT_FOUND There is not any console devices connected
182 @retval EFI_SUCCESS Success connect any one instance of the console
183 device path base on the variable ConVarName.
188 BdsLibConnectConsoleVariable (
189 IN CHAR16
*ConVarName
193 EFI_DEVICE_PATH_PROTOCOL
*StartDevicePath
;
195 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
196 EFI_DEVICE_PATH_PROTOCOL
*Next
;
197 EFI_DEVICE_PATH_PROTOCOL
*CopyOfDevicePath
;
201 Status
= EFI_SUCCESS
;
205 // Check if the console variable exist
207 StartDevicePath
= BdsLibGetVariableAndSize (
209 &gEfiGlobalVariableGuid
,
212 if (StartDevicePath
== NULL
) {
213 return EFI_UNSUPPORTED
;
216 CopyOfDevicePath
= StartDevicePath
;
219 // Check every instance of the console variable
221 Instance
= GetNextDevicePathInstance (&CopyOfDevicePath
, &Size
);
223 while (!IsDevicePathEndType (Next
)) {
224 Next
= NextDevicePathNode (Next
);
227 SetDevicePathEndNode (Next
);
229 // Check USB1.1 console
231 if ((DevicePathType (Instance
) == MESSAGING_DEVICE_PATH
) &&
232 ((DevicePathSubType (Instance
) == MSG_USB_CLASS_DP
)
233 || (DevicePathSubType (Instance
) == MSG_USB_WWID_DP
)
236 // Check the Usb console in Usb2.0 bus firstly, then Usb1.1 bus
238 Status
= BdsLibConnectUsbDevByShortFormDP (PCI_CLASSC_PI_EHCI
, Instance
);
239 if (!EFI_ERROR (Status
)) {
243 Status
= BdsLibConnectUsbDevByShortFormDP (PCI_CLASSC_PI_UHCI
, Instance
);
244 if (!EFI_ERROR (Status
)) {
249 // Connect the instance device path
251 Status
= BdsLibConnectDevicePath (Instance
);
252 if (EFI_ERROR (Status
)) {
254 // Delete the instance from the console varialbe
256 BdsLibUpdateConsoleVariable (ConVarName
, NULL
, Instance
);
261 SafeFreePool(Instance
);
262 } while (CopyOfDevicePath
!= NULL
);
264 SafeFreePool (StartDevicePath
);
267 return EFI_NOT_FOUND
;
275 This function will search every simpletxt devive in current system,
276 and make every simpletxt device as pertantial console device.
281 BdsLibConnectAllConsoles (
286 EFI_DEVICE_PATH_PROTOCOL
*ConDevicePath
;
288 EFI_HANDLE
*HandleBuffer
;
293 ConDevicePath
= NULL
;
296 // Update all the console varables
298 gBS
->LocateHandleBuffer (
300 &gEfiSimpleTextInProtocolGuid
,
306 for (Index
= 0; Index
< HandleCount
; Index
++) {
307 gBS
->HandleProtocol (
309 &gEfiDevicePathProtocolGuid
,
310 (VOID
**) &ConDevicePath
312 BdsLibUpdateConsoleVariable (L
"ConIn", ConDevicePath
, NULL
);
315 SafeFreePool(HandleBuffer
);
317 gBS
->LocateHandleBuffer (
319 &gEfiSimpleTextOutProtocolGuid
,
324 for (Index
= 0; Index
< HandleCount
; Index
++) {
325 gBS
->HandleProtocol (
327 &gEfiDevicePathProtocolGuid
,
328 (VOID
**) &ConDevicePath
330 BdsLibUpdateConsoleVariable (L
"ConOut", ConDevicePath
, NULL
);
331 BdsLibUpdateConsoleVariable (L
"ErrOut", ConDevicePath
, NULL
);
334 SafeFreePool(HandleBuffer
);
337 // Connect all console variables
339 BdsLibConnectAllDefaultConsoles ();
344 This function will connect console device base on the console
345 device variable ConIn, ConOut and ErrOut.
347 @retval EFI_SUCCESS At least one of the ConIn and ConOut device have
348 been connected success.
349 @retval EFI_STATUS Return the status of
350 BdsLibConnectConsoleVariable ().
355 BdsLibConnectAllDefaultConsoles (
362 // Connect all default console variables
366 // It seems impossible not to have any ConOut device on platform,
367 // so we check the status here.
369 Status
= BdsLibConnectConsoleVariable (L
"ConOut");
370 if (EFI_ERROR (Status
)) {
375 // Insert the performance probe for Console Out
377 PERF_START (NULL
, "ConOut", "BDS", 1);
378 PERF_END (NULL
, "ConOut", "BDS", 0);
381 // Because possibly the platform is legacy free, in such case,
382 // ConIn devices (Serial Port and PS2 Keyboard ) does not exist,
383 // so we need not check the status.
385 BdsLibConnectConsoleVariable (L
"ConIn");
388 // The _ModuleEntryPoint err out var is legal.
390 BdsLibConnectConsoleVariable (L
"ErrOut");