]> git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkModulePkg/Universal/BdsDxe/DeviceMngr/DeviceManager.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Update code logic to let BDS UI can shows more than one formsets in one HiiHandle.
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / DeviceMngr / DeviceManager.c
1 /** @file
2 The platform device manager reference implementation
3
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
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 "DeviceManager.h"
16
17 DEVICE_MANAGER_CALLBACK_DATA gDeviceManagerPrivate = {
18 DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE,
19 NULL,
20 NULL,
21 NULL,
22 NULL,
23 {
24 FakeExtractConfig,
25 FakeRouteConfig,
26 DeviceManagerCallback
27 },
28 {
29 FakeExtractConfig,
30 FakeRouteConfig,
31 DriverHealthCallback
32 }
33 };
34
35 #define MAX_MAC_ADDRESS_NODE_LIST_LEN 10
36
37 //
38 // Which Mac Address string is select
39 // it will decide what menu need to show in the NETWORK_DEVICE_FORM_ID form.
40 //
41 EFI_STRING mSelectedMacAddrString;
42
43 //
44 // Which form Id need to be show.
45 //
46 EFI_FORM_ID mNextShowFormId = DEVICE_MANAGER_FORM_ID;
47
48 //
49 // The Mac Address show in the NETWORK_DEVICE_LIST_FORM_ID
50 //
51 MAC_ADDRESS_NODE_LIST mMacDeviceList;
52
53 DEVICE_MANAGER_MENU_ITEM mDeviceManagerMenuItemTable[] = {
54 { STRING_TOKEN (STR_DISK_DEVICE), EFI_DISK_DEVICE_CLASS },
55 { STRING_TOKEN (STR_VIDEO_DEVICE), EFI_VIDEO_DEVICE_CLASS },
56 { STRING_TOKEN (STR_NETWORK_DEVICE), EFI_NETWORK_DEVICE_CLASS },
57 { STRING_TOKEN (STR_INPUT_DEVICE), EFI_INPUT_DEVICE_CLASS },
58 { STRING_TOKEN (STR_ON_BOARD_DEVICE), EFI_ON_BOARD_DEVICE_CLASS },
59 { STRING_TOKEN (STR_OTHER_DEVICE), EFI_OTHER_DEVICE_CLASS }
60 };
61
62 HII_VENDOR_DEVICE_PATH mDeviceManagerHiiVendorDevicePath = {
63 {
64 {
65 HARDWARE_DEVICE_PATH,
66 HW_VENDOR_DP,
67 {
68 (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
69 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
70 }
71 },
72 DEVICE_MANAGER_FORMSET_GUID
73 },
74 {
75 END_DEVICE_PATH_TYPE,
76 END_ENTIRE_DEVICE_PATH_SUBTYPE,
77 {
78 (UINT8) (END_DEVICE_PATH_LENGTH),
79 (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
80 }
81 }
82 };
83
84 HII_VENDOR_DEVICE_PATH mDriverHealthHiiVendorDevicePath = {
85 {
86 {
87 HARDWARE_DEVICE_PATH,
88 HW_VENDOR_DP,
89 {
90 (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
91 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
92 }
93 },
94 DRIVER_HEALTH_FORMSET_GUID
95 },
96 {
97 END_DEVICE_PATH_TYPE,
98 END_ENTIRE_DEVICE_PATH_SUBTYPE,
99 {
100 (UINT8) (END_DEVICE_PATH_LENGTH),
101 (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
102 }
103 }
104 };
105
106 /**
107 This function is invoked if user selected a interactive opcode from Device Manager's
108 Formset. The decision by user is saved to gCallbackKey for later processing. If
109 user set VBIOS, the new value is saved to EFI variable.
110
111 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
112 @param Action Specifies the type of action taken by the browser.
113 @param QuestionId A unique value which is sent to the original exporting driver
114 so that it can identify the type of data to expect.
115 @param Type The type of value for the question.
116 @param Value A pointer to the data being sent to the original exporting driver.
117 @param ActionRequest On return, points to the action requested by the callback function.
118
119 @retval EFI_SUCCESS The callback successfully handled the action.
120 @retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.
121
122 **/
123 EFI_STATUS
124 EFIAPI
125 DeviceManagerCallback (
126 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
127 IN EFI_BROWSER_ACTION Action,
128 IN EFI_QUESTION_ID QuestionId,
129 IN UINT8 Type,
130 IN EFI_IFR_TYPE_VALUE *Value,
131 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
132 )
133 {
134 UINTN CurIndex;
135
136 if (Action != EFI_BROWSER_ACTION_CHANGING) {
137 //
138 // All other action return unsupported.
139 //
140 return EFI_UNSUPPORTED;
141 }
142
143 if (Value == NULL) {
144 return EFI_INVALID_PARAMETER;
145 }
146
147 gCallbackKey = QuestionId;
148 if ((QuestionId < MAX_KEY_SECTION_LEN + NETWORK_DEVICE_LIST_KEY_OFFSET) && (QuestionId >= NETWORK_DEVICE_LIST_KEY_OFFSET)) {
149 //
150 // If user select the mac address, need to record mac address string to support next form show.
151 //
152 for (CurIndex = 0; CurIndex < mMacDeviceList.CurListLen; CurIndex ++) {
153 if (mMacDeviceList.NodeList[CurIndex].QuestionId == QuestionId) {
154 mSelectedMacAddrString = HiiGetString (gDeviceManagerPrivate.HiiHandle, mMacDeviceList.NodeList[CurIndex].PromptId, NULL);
155 }
156 }
157 }
158
159 return EFI_SUCCESS;
160 }
161
162 /**
163
164 This function registers HII packages to HII database.
165
166 @retval EFI_SUCCESS HII packages for the Device Manager were registered successfully.
167 @retval EFI_OUT_OF_RESOURCES HII packages for the Device Manager failed to be registered.
168
169 **/
170 EFI_STATUS
171 InitializeDeviceManager (
172 VOID
173 )
174 {
175 EFI_STATUS Status;
176
177 //
178 // Install Device Path Protocol and Config Access protocol to driver handle
179 //
180 Status = gBS->InstallMultipleProtocolInterfaces (
181 &gDeviceManagerPrivate.DriverHandle,
182 &gEfiDevicePathProtocolGuid,
183 &mDeviceManagerHiiVendorDevicePath,
184 &gEfiHiiConfigAccessProtocolGuid,
185 &gDeviceManagerPrivate.ConfigAccess,
186 NULL
187 );
188 ASSERT_EFI_ERROR (Status);
189
190 Status = gBS->InstallMultipleProtocolInterfaces (
191 &gDeviceManagerPrivate.DriverHealthHandle,
192 &gEfiDevicePathProtocolGuid,
193 &mDriverHealthHiiVendorDevicePath,
194 &gEfiHiiConfigAccessProtocolGuid,
195 &gDeviceManagerPrivate.DriverHealthConfigAccess,
196 NULL
197 );
198 ASSERT_EFI_ERROR (Status);
199
200 mMacDeviceList.CurListLen = 0;
201 mMacDeviceList.MaxListLen = 0;
202
203 return Status;
204 }
205
206 /**
207 Extract the displayed formset for given HII handle and class guid.
208
209 @param Handle The HII handle.
210 @param SetupClassGuid The class guid specifies which form set will be displayed.
211 @param SkipCount Skip some formsets which has processed before.
212 @param FormSetTitle Formset title string.
213 @param FormSetHelp Formset help string.
214 @param FormSetGuid Return the formset guid for this formset.
215
216 @retval TRUE The formset for given HII handle will be displayed.
217 @return FALSE The formset for given HII handle will not be displayed.
218
219 **/
220 BOOLEAN
221 ExtractDisplayedHiiFormFromHiiHandle (
222 IN EFI_HII_HANDLE Handle,
223 IN EFI_GUID *SetupClassGuid,
224 IN UINTN SkipCount,
225 OUT EFI_STRING_ID *FormSetTitle,
226 OUT EFI_STRING_ID *FormSetHelp,
227 OUT EFI_GUID **FormSetGuid
228 )
229 {
230 EFI_STATUS Status;
231 UINTN BufferSize;
232 EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;
233 UINT8 *Package;
234 UINT8 *OpCodeData;
235 UINT32 Offset;
236 UINT32 Offset2;
237 UINT32 PackageListLength;
238 EFI_HII_PACKAGE_HEADER PackageHeader;
239 EFI_GUID *ClassGuid;
240 UINT8 ClassGuidNum;
241
242 ASSERT (Handle != NULL);
243 ASSERT (SetupClassGuid != NULL);
244 ASSERT (FormSetTitle != NULL);
245 ASSERT (FormSetHelp != NULL);
246
247 *FormSetTitle = 0;
248 *FormSetHelp = 0;
249 ClassGuidNum = 0;
250 ClassGuid = NULL;
251
252 //
253 // Get HII PackageList
254 //
255 BufferSize = 0;
256 HiiPackageList = NULL;
257 Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, Handle, &BufferSize, HiiPackageList);
258 //
259 // Handle is a invalid handle. Check if Handle is corrupted.
260 //
261 ASSERT (Status != EFI_NOT_FOUND);
262 //
263 // The return status should always be EFI_BUFFER_TOO_SMALL as input buffer's size is 0.
264 //
265 ASSERT (Status == EFI_BUFFER_TOO_SMALL);
266
267 HiiPackageList = AllocatePool (BufferSize);
268 ASSERT (HiiPackageList != NULL);
269
270 Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, Handle, &BufferSize, HiiPackageList);
271 if (EFI_ERROR (Status)) {
272 return FALSE;
273 }
274
275 //
276 // Get Form package from this HII package List
277 //
278 Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);
279 Offset2 = 0;
280 PackageListLength = ReadUnaligned32 (&HiiPackageList->PackageLength);
281
282 while (Offset < PackageListLength) {
283 Package = ((UINT8 *) HiiPackageList) + Offset;
284 CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));
285
286 if (PackageHeader.Type == EFI_HII_PACKAGE_FORMS) {
287 //
288 // Search FormSet Opcode in this Form Package
289 //
290 Offset2 = sizeof (EFI_HII_PACKAGE_HEADER);
291 while (Offset2 < PackageHeader.Length) {
292 OpCodeData = Package + Offset2;
293 Offset2 += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
294
295 if (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode == EFI_IFR_FORM_SET_OP) {
296 if (SkipCount != 0) {
297 SkipCount --;
298 continue;
299 }
300
301 if (((EFI_IFR_OP_HEADER *) OpCodeData)->Length > OFFSET_OF (EFI_IFR_FORM_SET, Flags)) {
302 //
303 // Find FormSet OpCode
304 //
305 ClassGuidNum = (UINT8) (((EFI_IFR_FORM_SET *) OpCodeData)->Flags & 0x3);
306 ClassGuid = (EFI_GUID *) (VOID *)(OpCodeData + sizeof (EFI_IFR_FORM_SET));
307 while (ClassGuidNum-- > 0) {
308 if (CompareGuid (SetupClassGuid, ClassGuid)) {
309 CopyMem (FormSetTitle, &((EFI_IFR_FORM_SET *) OpCodeData)->FormSetTitle, sizeof (EFI_STRING_ID));
310 CopyMem (FormSetHelp, &((EFI_IFR_FORM_SET *) OpCodeData)->Help, sizeof (EFI_STRING_ID));
311 *FormSetGuid = AllocateCopyPool (sizeof (EFI_GUID), &((EFI_IFR_FORM_SET *) OpCodeData)->Guid);
312 ASSERT (*FormSetGuid != NULL);
313 FreePool (HiiPackageList);
314 return TRUE;
315 }
316 ClassGuid ++;
317 }
318 } else {
319 CopyMem (FormSetTitle, &((EFI_IFR_FORM_SET *) OpCodeData)->FormSetTitle, sizeof (EFI_STRING_ID));
320 CopyMem (FormSetHelp, &((EFI_IFR_FORM_SET *) OpCodeData)->Help, sizeof (EFI_STRING_ID));
321 *FormSetGuid = AllocateCopyPool (sizeof (EFI_GUID), &((EFI_IFR_FORM_SET *) OpCodeData)->Guid);
322 ASSERT (*FormSetGuid != NULL);
323 FreePool (HiiPackageList);
324 return TRUE;
325 }
326 }
327 }
328 }
329
330 //
331 // Go to next package
332 //
333 Offset += PackageHeader.Length;
334 }
335
336 FreePool (HiiPackageList);
337
338 return FALSE;
339 }
340
341 /**
342 Get the mac address string from the device path.
343 if the device path has the vlan, get the vanid also.
344
345 @param MacAddressNode Device path begin with mac address
346 @param PBuffer Output string buffer contain mac address.
347
348 **/
349 BOOLEAN
350 GetMacAddressString(
351 IN MAC_ADDR_DEVICE_PATH *MacAddressNode,
352 OUT CHAR16 **PBuffer
353 )
354 {
355 UINTN HwAddressSize;
356 UINTN Index;
357 UINT8 *HwAddress;
358 EFI_DEVICE_PATH_PROTOCOL *Node;
359 UINT16 VlanId;
360 CHAR16 *String;
361 UINTN BufferLen;
362
363 VlanId = 0;
364 String = NULL;
365 ASSERT(MacAddressNode != NULL);
366
367 HwAddressSize = sizeof (EFI_MAC_ADDRESS);
368 if (MacAddressNode->IfType == 0x01 || MacAddressNode->IfType == 0x00) {
369 HwAddressSize = 6;
370 }
371
372 //
373 // The output format is MAC:XX:XX:XX:...\XXXX
374 // The size is the Number size + ":" size + Vlan size(\XXXX) + End
375 //
376 BufferLen = (4 + 2 * HwAddressSize + (HwAddressSize - 1) + 5 + 1) * sizeof (CHAR16);
377 String = AllocateZeroPool (BufferLen);
378 if (String == NULL) {
379 return FALSE;
380 }
381
382 *PBuffer = String;
383 StrCpy(String, L"MAC:");
384 String += 4;
385
386 //
387 // Convert the MAC address into a unicode string.
388 //
389 HwAddress = &MacAddressNode->MacAddress.Addr[0];
390 for (Index = 0; Index < HwAddressSize; Index++) {
391 String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, *(HwAddress++), 2);
392 if (Index < HwAddressSize - 1) {
393 *String++ = L':';
394 }
395 }
396
397 //
398 // If VLAN is configured, it will need extra 5 characters like "\0005".
399 // Plus one unicode character for the null-terminator.
400 //
401 Node = (EFI_DEVICE_PATH_PROTOCOL *)MacAddressNode;
402 while (!IsDevicePathEnd (Node)) {
403 if (Node->Type == MESSAGING_DEVICE_PATH && Node->SubType == MSG_VLAN_DP) {
404 VlanId = ((VLAN_DEVICE_PATH *) Node)->VlanId;
405 }
406 Node = NextDevicePathNode (Node);
407 }
408
409 if (VlanId != 0) {
410 *String++ = L'\\';
411 String += UnicodeValueToString (String, PREFIX_ZERO | RADIX_HEX, VlanId, 4);
412 }
413
414 //
415 // Null terminate the Unicode string
416 //
417 *String = L'\0';
418
419 return TRUE;
420 }
421
422 /**
423 Save question id and prompt id to the mac device list.
424 If the same mac address has saved yet, no need to add more.
425
426 @param MacAddrString Mac address string.
427
428 @retval EFI_SUCCESS Add the item is successful.
429 @return Other values if failed to Add the item.
430 **/
431 BOOLEAN
432 AddIdToMacDeviceList (
433 IN EFI_STRING MacAddrString
434 )
435 {
436 MENU_INFO_ITEM *TempDeviceList;
437 UINTN Index;
438 EFI_STRING StoredString;
439 EFI_STRING_ID PromptId;
440 EFI_HII_HANDLE HiiHandle;
441
442 HiiHandle = gDeviceManagerPrivate.HiiHandle;
443 TempDeviceList = NULL;
444
445 for (Index = 0; Index < mMacDeviceList.CurListLen; Index ++) {
446 StoredString = HiiGetString (HiiHandle, mMacDeviceList.NodeList[Index].PromptId, NULL);
447 if (StoredString == NULL) {
448 return FALSE;
449 }
450
451 //
452 // Already has save the same mac address to the list.
453 //
454 if (StrCmp (MacAddrString, StoredString) == 0) {
455 return FALSE;
456 }
457 }
458
459 PromptId = HiiSetString(HiiHandle, 0, MacAddrString, NULL);
460 //
461 // If not in the list, save it.
462 //
463 if (mMacDeviceList.MaxListLen > mMacDeviceList.CurListLen + 1) {
464 mMacDeviceList.NodeList[mMacDeviceList.CurListLen].PromptId = PromptId;
465 mMacDeviceList.NodeList[mMacDeviceList.CurListLen].QuestionId = (EFI_QUESTION_ID) (mMacDeviceList.CurListLen + NETWORK_DEVICE_LIST_KEY_OFFSET);
466 } else {
467 mMacDeviceList.MaxListLen += MAX_MAC_ADDRESS_NODE_LIST_LEN;
468 if (mMacDeviceList.CurListLen != 0) {
469 TempDeviceList = (MENU_INFO_ITEM *)AllocateCopyPool (sizeof (MENU_INFO_ITEM) * mMacDeviceList.MaxListLen, (VOID *)mMacDeviceList.NodeList);
470 } else {
471 TempDeviceList = (MENU_INFO_ITEM *)AllocatePool (sizeof (MENU_INFO_ITEM) * mMacDeviceList.MaxListLen);
472 }
473
474 if (TempDeviceList == NULL) {
475 return FALSE;
476 }
477 TempDeviceList[mMacDeviceList.CurListLen].PromptId = PromptId;
478 TempDeviceList[mMacDeviceList.CurListLen].QuestionId = (EFI_QUESTION_ID) (mMacDeviceList.CurListLen + NETWORK_DEVICE_LIST_KEY_OFFSET);
479
480 if (mMacDeviceList.CurListLen > 0) {
481 FreePool(mMacDeviceList.NodeList);
482 }
483
484 mMacDeviceList.NodeList = TempDeviceList;
485 }
486 mMacDeviceList.CurListLen ++;
487
488 return TRUE;
489 }
490
491 /**
492 Check the devcie path, try to find whether it has mac address path.
493
494 In this function, first need to check whether this path has mac address path.
495 second, when the mac address device path has find, also need to deicide whether
496 need to add this mac address relate info to the menu.
497
498 @param *Node Input device which need to be check.
499 @param *NeedAddItem Whether need to add the menu in the network device list.
500
501 @retval TRUE Has mac address device path.
502 @retval FALSE NOT Has mac address device path.
503
504 **/
505 BOOLEAN
506 IsMacAddressDevicePath (
507 IN VOID *Node,
508 OUT BOOLEAN *NeedAddItem
509 )
510 {
511 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
512 CHAR16 *Buffer;
513 BOOLEAN ReturnVal;
514
515 ASSERT (Node != NULL);
516 *NeedAddItem = FALSE;
517 ReturnVal = FALSE;
518 Buffer = NULL;
519
520 DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) Node;
521
522 //
523 // find the partition device path node
524 //
525 while (!IsDevicePathEnd (DevicePath)) {
526 if ((DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) &&
527 (DevicePathSubType (DevicePath) == MSG_MAC_ADDR_DP)) {
528 ReturnVal = TRUE;
529
530 if (DEVICE_MANAGER_FORM_ID == mNextShowFormId) {
531 *NeedAddItem = TRUE;
532 break;
533 }
534
535 if (!GetMacAddressString((MAC_ADDR_DEVICE_PATH*)DevicePath, &Buffer)) {
536 break;
537 }
538
539 if (NETWORK_DEVICE_FORM_ID == mNextShowFormId) {
540 if (StrCmp (Buffer, mSelectedMacAddrString) == 0) {
541 *NeedAddItem = TRUE;
542 }
543 break;
544 }
545
546 if (NETWORK_DEVICE_LIST_FORM_ID == mNextShowFormId) {
547 //
548 // Same handle may has two network child handle, so the questionid
549 // has the offset of SAME_HANDLE_KEY_OFFSET.
550 //
551 if (AddIdToMacDeviceList (Buffer)) {
552 *NeedAddItem = TRUE;
553 }
554 break;
555 }
556 }
557 DevicePath = NextDevicePathNode (DevicePath);
558 }
559
560 if (Buffer != NULL) {
561 FreePool (Buffer);
562 }
563
564 return ReturnVal;
565 }
566
567 /**
568 Check to see if the device path is for the network device.
569
570 @param Handle The HII handle which include the mac address device path.
571 @param ItemCount The new add Mac address item count.
572
573 @retval TRUE Need to add new item in the menu.
574 @return FALSE Do not need to add the menu about the network.
575
576 **/
577 BOOLEAN
578 IsNeedAddNetworkMenu (
579 IN EFI_HII_HANDLE Handle,
580 OUT UINTN *ItemCount
581 )
582 {
583 EFI_STATUS Status;
584 UINTN EntryCount;
585 UINTN Index;
586 EFI_HANDLE DriverHandle;
587 EFI_HANDLE ControllerHandle;
588 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
589 EFI_DEVICE_PATH_PROTOCOL *TmpDevicePath;
590 EFI_DEVICE_PATH_PROTOCOL *ChildDevicePath;
591 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfoBuffer;
592 BOOLEAN IsNeedAdd;
593
594 IsNeedAdd = FALSE;
595 OpenInfoBuffer = NULL;
596 if ((Handle == NULL) || (ItemCount == NULL)) {
597 return FALSE;
598 }
599 *ItemCount = 0;
600
601 Status = gHiiDatabase->GetPackageListHandle (gHiiDatabase, Handle, &DriverHandle);
602 if (EFI_ERROR (Status)) {
603 return FALSE;
604 }
605 //
606 // Get the device path by the got Driver handle .
607 //
608 Status = gBS->HandleProtocol (DriverHandle, &gEfiDevicePathProtocolGuid, (VOID **) &DevicePath);
609 if (EFI_ERROR (Status)) {
610 return FALSE;
611 }
612 TmpDevicePath = DevicePath;
613
614 //
615 // Check whether this device path include mac address device path.
616 // If this path has mac address path, get the value whether need
617 // add this info to the menu and return.
618 // Else check more about the child handle devcie path.
619 //
620 if (IsMacAddressDevicePath(TmpDevicePath, &IsNeedAdd)) {
621 if ((NETWORK_DEVICE_LIST_FORM_ID == mNextShowFormId) && IsNeedAdd) {
622 (*ItemCount) = 1;
623 }
624 return IsNeedAdd;
625 }
626
627 //
628 // Search whether this path is the controller path, not he child handle path.
629 // And the child handle has the network devcie connected.
630 //
631 TmpDevicePath = DevicePath;
632 Status = gBS->LocateDevicePath(&gEfiDevicePathProtocolGuid, &TmpDevicePath, &ControllerHandle);
633 if (EFI_ERROR (Status)) {
634 return FALSE;
635 }
636
637 if (!IsDevicePathEnd (TmpDevicePath)) {
638 return FALSE;
639 }
640
641 //
642 // Retrieve the list of agents that are consuming the specific protocol
643 // on ControllerHandle.
644 // The buffer point by OpenInfoBuffer need be free at this function.
645 //
646 Status = gBS->OpenProtocolInformation (
647 ControllerHandle,
648 &gEfiPciIoProtocolGuid,
649 &OpenInfoBuffer,
650 &EntryCount
651 );
652 if (EFI_ERROR (Status)) {
653 return FALSE;
654 }
655
656 //
657 // Inspect if ChildHandle is one of the agents.
658 //
659 Status = EFI_UNSUPPORTED;
660 for (Index = 0; Index < EntryCount; Index++) {
661 //
662 // Query all the children created by the controller handle's driver
663 //
664 if ((OpenInfoBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {
665 Status = gBS->OpenProtocol (
666 OpenInfoBuffer[Index].ControllerHandle,
667 &gEfiDevicePathProtocolGuid,
668 (VOID **) &ChildDevicePath,
669 NULL,
670 NULL,
671 EFI_OPEN_PROTOCOL_GET_PROTOCOL
672 );
673 if (EFI_ERROR (Status)) {
674 continue;
675 }
676
677 //
678 // Check whether this device path include mac address device path.
679 //
680 if (!IsMacAddressDevicePath(ChildDevicePath, &IsNeedAdd)) {
681 //
682 // If this path not has mac address path, check the other.
683 //
684 continue;
685 } else {
686 //
687 // If need to update the NETWORK_DEVICE_LIST_FORM, try to get more.
688 //
689 if ((NETWORK_DEVICE_LIST_FORM_ID == mNextShowFormId)) {
690 if (IsNeedAdd) {
691 (*ItemCount) += 1;
692 }
693 continue;
694 } else {
695 //
696 // If need to update other form, return whether need to add to the menu.
697 //
698 goto Done;
699 }
700 }
701 }
702 }
703
704 Done:
705 if (OpenInfoBuffer != NULL) {
706 FreePool (OpenInfoBuffer);
707 }
708 return IsNeedAdd;
709 }
710
711 /**
712 Get HiiHandle total number.
713
714 @param HiiHandles The input HiiHandle array.
715
716 @retval the Hiihandle count.
717
718 **/
719 UINTN
720 GetHiiHandleCount (
721 IN EFI_HII_HANDLE *HiiHandles
722 )
723 {
724 UINTN Index;
725
726 for (Index = 0; HiiHandles[Index] != NULL; Index++) {
727 }
728
729 return Index;
730 }
731
732 /**
733 Insert the new HiiHandle + FormsetGuid at the NewPair[InsertOffset].
734
735 @param HiiHandles The input HiiHandle array.
736 @param GuidLists The input form set guid lists.
737 @param ArrayCount The input array count, new array will be arraycount + 1 size.
738 @param Offset The current used HiiHandle's Offset.
739 @param FormSetGuid The new found formset guid.
740
741 **/
742 VOID
743 AdjustArrayData (
744 IN OUT EFI_HII_HANDLE **HiiHandles,
745 IN OUT EFI_GUID ***GuidLists,
746 IN UINTN ArrayCount,
747 IN UINTN Offset,
748 IN EFI_GUID *FormSetGuid
749 )
750 {
751 EFI_HII_HANDLE *NewHiiHandles;
752 EFI_GUID **NewGuidLists;
753
754 //
755 // +2 means include the new HiiHandle and the last empty NULL pointer.
756 //
757 NewHiiHandles = AllocateZeroPool ((ArrayCount + 2) * sizeof (EFI_HII_HANDLE));
758 ASSERT (NewHiiHandles != NULL);
759
760 CopyMem (NewHiiHandles, *HiiHandles, Offset * sizeof (EFI_HII_HANDLE));
761 NewHiiHandles[Offset] = NewHiiHandles[Offset - 1];
762 CopyMem (NewHiiHandles + Offset + 1, *HiiHandles + Offset, (ArrayCount - Offset) * sizeof (EFI_HII_HANDLE));
763
764 NewGuidLists = AllocateZeroPool ((ArrayCount + 2) * sizeof (EFI_GUID *));
765 ASSERT (NewGuidLists != NULL);
766
767 CopyMem (NewGuidLists, *GuidLists, Offset * sizeof (EFI_GUID *));
768 NewGuidLists[Offset] = FormSetGuid;
769
770 FreePool (*HiiHandles);
771 *HiiHandles = NewHiiHandles;
772 FreePool (*GuidLists);
773 *GuidLists = NewGuidLists;
774 }
775
776 /**
777 Call the browser and display the device manager to allow user
778 to configure the platform.
779
780 This function create the dynamic content for device manager. It includes
781 section header for all class of devices, one-of opcode to set VBIOS.
782
783 @retval EFI_SUCCESS Operation is successful.
784 @return Other values if failed to clean up the dynamic content from HII
785 database.
786
787 **/
788 EFI_STATUS
789 CallDeviceManager (
790 VOID
791 )
792 {
793 EFI_STATUS Status;
794 UINTN Index;
795 EFI_STRING String;
796 EFI_STRING_ID Token;
797 EFI_STRING_ID TokenHelp;
798 EFI_HII_HANDLE *HiiHandles;
799 EFI_HII_HANDLE HiiHandle;
800 EFI_STRING_ID FormSetTitle;
801 EFI_STRING_ID FormSetHelp;
802 EFI_BROWSER_ACTION_REQUEST ActionRequest;
803 VOID *StartOpCodeHandle;
804 VOID *EndOpCodeHandle;
805 EFI_IFR_GUID_LABEL *StartLabel;
806 EFI_IFR_GUID_LABEL *EndLabel;
807 UINTN NumHandles;
808 EFI_HANDLE *DriverHealthHandles;
809 BOOLEAN AddNetworkMenu;
810 UINTN AddItemCount;
811 UINTN NewStringLen;
812 EFI_STRING NewStringTitle;
813 EFI_GUID **GuidLists;
814 UINTN HandleNum;
815 UINTN SkipCount;
816 EFI_GUID *FormSetGuid;
817
818 GuidLists = NULL;
819 HiiHandles = NULL;
820 Status = EFI_SUCCESS;
821 gCallbackKey = 0;
822 NumHandles = 0;
823 DriverHealthHandles = NULL;
824 AddNetworkMenu = FALSE;
825 AddItemCount = 0;
826 SkipCount = 0;
827 FormSetGuid = NULL;
828
829 //
830 // Connect all prior to entering the platform setup menu.
831 //
832 if (!gConnectAllHappened) {
833 BdsLibConnectAllDriversToAllControllers ();
834 gConnectAllHappened = TRUE;
835 }
836
837 HiiHandle = gDeviceManagerPrivate.HiiHandle;
838 if (HiiHandle == NULL) {
839 //
840 // Publish our HII data.
841 //
842 HiiHandle = HiiAddPackages (
843 &gDeviceManagerFormSetGuid,
844 gDeviceManagerPrivate.DriverHandle,
845 DeviceManagerVfrBin,
846 BdsDxeStrings,
847 NULL
848 );
849 if (HiiHandle == NULL) {
850 return EFI_OUT_OF_RESOURCES;
851 }
852
853 gDeviceManagerPrivate.HiiHandle = HiiHandle;
854 }
855
856 //
857 // If need show the Network device list form, clear the old save list first.
858 //
859 if ((mNextShowFormId == NETWORK_DEVICE_LIST_FORM_ID) && (mMacDeviceList.CurListLen > 0)) {
860 mMacDeviceList.CurListLen = 0;
861 }
862
863 //
864 // Update the network device form titile.
865 //
866 if (mNextShowFormId == NETWORK_DEVICE_FORM_ID) {
867 String = HiiGetString (HiiHandle, STRING_TOKEN (STR_FORM_NETWORK_DEVICE_TITLE), NULL);
868 NewStringLen = StrLen(mSelectedMacAddrString) * 2;
869 NewStringLen += (StrLen(String) + 2) * 2;
870 NewStringTitle = AllocatePool (NewStringLen);
871 UnicodeSPrint (NewStringTitle, NewStringLen, L"%s %s", String, mSelectedMacAddrString);
872 HiiSetString (HiiHandle, STRING_TOKEN (STR_FORM_NETWORK_DEVICE_TITLE), NewStringTitle, NULL);
873 FreePool (String);
874 FreePool (NewStringTitle);
875 }
876
877 //
878 // Allocate space for creation of UpdateData Buffer
879 //
880 StartOpCodeHandle = HiiAllocateOpCodeHandle ();
881 ASSERT (StartOpCodeHandle != NULL);
882
883 EndOpCodeHandle = HiiAllocateOpCodeHandle ();
884 ASSERT (EndOpCodeHandle != NULL);
885
886 //
887 // Create Hii Extend Label OpCode as the start opcode
888 //
889 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
890 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
891 //
892 // According to the next show Form id(mNextShowFormId) to decide which form need to update.
893 //
894 StartLabel->Number = (UINT16) (LABEL_FORM_ID_OFFSET + mNextShowFormId);
895
896 //
897 // Create Hii Extend Label OpCode as the end opcode
898 //
899 EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
900 EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
901 EndLabel->Number = LABEL_END;
902
903 //
904 // Get all the Hii handles
905 //
906 HiiHandles = HiiGetHiiHandles (NULL);
907 ASSERT (HiiHandles != NULL);
908
909 HandleNum = GetHiiHandleCount (HiiHandles);
910 GuidLists = AllocateZeroPool ((HandleNum + 1) * sizeof (EFI_GUID *));
911 ASSERT (GuidLists != NULL);
912
913 //
914 // Search for formset of each class type
915 //
916 for (Index = 0; HiiHandles[Index] != NULL; Index++) {
917 //
918 // The QuestionId in the form which will call the driver form has this asssumption.
919 // QuestionId = Handle Index + NETWORK_DEVICE_LIST_KEY_OFFSET;
920 // Different QuestionId at least has the section of NETWORK_DEVICE_LIST_KEY_OFFSET.
921 //
922 ASSERT(Index < MAX_KEY_SECTION_LEN);
923
924 if (!ExtractDisplayedHiiFormFromHiiHandle (HiiHandles[Index], &gEfiHiiPlatformSetupFormsetGuid, SkipCount, &FormSetTitle, &FormSetHelp, &FormSetGuid)) {
925 SkipCount = 0;
926 continue;
927 }
928
929 //
930 // One HiiHandle has more than one formset can be shown,
931 // Insert a new pair of HiiHandle + Guid to the HiiHandles and GuidLists list.
932 //
933 if (SkipCount > 0) {
934 AdjustArrayData (&HiiHandles, &GuidLists, HandleNum, Index + 1, FormSetGuid);
935 HandleNum ++;
936 Index ++;
937 }
938
939 String = HiiGetString (HiiHandles[Index], FormSetTitle, NULL);
940 if (String == NULL) {
941 String = HiiGetString (HiiHandle, STR_MISSING_STRING, NULL);
942 ASSERT (String != NULL);
943 }
944 Token = HiiSetString (HiiHandle, 0, String, NULL);
945 FreePool (String);
946
947 String = HiiGetString (HiiHandles[Index], FormSetHelp, NULL);
948 if (String == NULL) {
949 String = HiiGetString (HiiHandle, STR_MISSING_STRING, NULL);
950 ASSERT (String != NULL);
951 }
952 TokenHelp = HiiSetString (HiiHandle, 0, String, NULL);
953 FreePool (String);
954
955 //
956 // Network device process
957 //
958 if (IsNeedAddNetworkMenu (HiiHandles[Index], &AddItemCount)) {
959 if (mNextShowFormId == DEVICE_MANAGER_FORM_ID) {
960 //
961 // Only show one menu item "Network Config" in the device manger form.
962 //
963 if (!AddNetworkMenu) {
964 AddNetworkMenu = TRUE;
965 HiiCreateGotoOpCode (
966 StartOpCodeHandle,
967 INVALID_FORM_ID,
968 STRING_TOKEN (STR_FORM_NETWORK_DEVICE_LIST_TITLE),
969 STRING_TOKEN (STR_FORM_NETWORK_DEVICE_LIST_HELP),
970 EFI_IFR_FLAG_CALLBACK,
971 (EFI_QUESTION_ID) QUESTION_NETWORK_DEVICE_ID
972 );
973 }
974 } else if (mNextShowFormId == NETWORK_DEVICE_LIST_FORM_ID) {
975 //
976 // In network device list form, same mac address device only show one menu.
977 //
978 while (AddItemCount > 0) {
979 HiiCreateGotoOpCode (
980 StartOpCodeHandle,
981 INVALID_FORM_ID,
982 mMacDeviceList.NodeList[mMacDeviceList.CurListLen - AddItemCount].PromptId,
983 STRING_TOKEN (STR_NETWORK_DEVICE_HELP),
984 EFI_IFR_FLAG_CALLBACK,
985 mMacDeviceList.NodeList[mMacDeviceList.CurListLen - AddItemCount].QuestionId
986 );
987 AddItemCount -= 1;
988 }
989 } else if (mNextShowFormId == NETWORK_DEVICE_FORM_ID) {
990 //
991 // In network device form, only the selected mac address device need to be show.
992 //
993 HiiCreateGotoOpCode (
994 StartOpCodeHandle,
995 INVALID_FORM_ID,
996 Token,
997 TokenHelp,
998 EFI_IFR_FLAG_CALLBACK,
999 (EFI_QUESTION_ID) (Index + DEVICE_KEY_OFFSET)
1000 );
1001 }
1002 } else {
1003 //
1004 //
1005 // Not network device process, only need to show at device manger form.
1006 //
1007 if (mNextShowFormId == DEVICE_MANAGER_FORM_ID) {
1008 HiiCreateGotoOpCode (
1009 StartOpCodeHandle,
1010 INVALID_FORM_ID,
1011 Token,
1012 TokenHelp,
1013 EFI_IFR_FLAG_CALLBACK,
1014 (EFI_QUESTION_ID) (Index + DEVICE_KEY_OFFSET)
1015 );
1016 }
1017 }
1018
1019 //
1020 // Try to find more formset in this HiiHandle.
1021 //
1022 SkipCount++;
1023 Index--;
1024 }
1025
1026 Status = gBS->LocateHandleBuffer (
1027 ByProtocol,
1028 &gEfiDriverHealthProtocolGuid,
1029 NULL,
1030 &NumHandles,
1031 &DriverHealthHandles
1032 );
1033
1034 //
1035 // If there are no drivers installed driver health protocol, do not create driver health entry in UI
1036 //
1037 if (NumHandles != 0) {
1038 //
1039 // If driver health protocol is installed, create Driver Health subtitle and entry
1040 //
1041 HiiCreateSubTitleOpCode (StartOpCodeHandle, STRING_TOKEN (STR_DM_DRIVER_HEALTH_TITLE), 0, 0, 0);
1042 HiiCreateGotoOpCode (
1043 StartOpCodeHandle,
1044 DRIVER_HEALTH_FORM_ID,
1045 STRING_TOKEN(STR_DRIVER_HEALTH_ALL_HEALTHY), // Prompt text
1046 STRING_TOKEN(STR_DRIVER_HEALTH_STATUS_HELP), // Help text
1047 EFI_IFR_FLAG_CALLBACK,
1048 DEVICE_MANAGER_KEY_DRIVER_HEALTH // Question ID
1049 );
1050
1051 //
1052 // Check All Driver health status
1053 //
1054 if (!PlaformHealthStatusCheck ()) {
1055 //
1056 // At least one driver in the platform are not in healthy status
1057 //
1058 HiiSetString (HiiHandle, STRING_TOKEN (STR_DRIVER_HEALTH_ALL_HEALTHY), GetStringById (STRING_TOKEN (STR_DRIVER_NOT_HEALTH)), NULL);
1059 } else {
1060 //
1061 // For the string of STR_DRIVER_HEALTH_ALL_HEALTHY previously has been updated and we need to update it while re-entry.
1062 //
1063 HiiSetString (HiiHandle, STRING_TOKEN (STR_DRIVER_HEALTH_ALL_HEALTHY), GetStringById (STRING_TOKEN (STR_DRIVER_HEALTH_ALL_HEALTHY)), NULL);
1064 }
1065 }
1066
1067 HiiUpdateForm (
1068 HiiHandle,
1069 &gDeviceManagerFormSetGuid,
1070 mNextShowFormId,
1071 StartOpCodeHandle,
1072 EndOpCodeHandle
1073 );
1074
1075 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
1076 Status = gFormBrowser2->SendForm (
1077 gFormBrowser2,
1078 &HiiHandle,
1079 1,
1080 &gDeviceManagerFormSetGuid,
1081 mNextShowFormId,
1082 NULL,
1083 &ActionRequest
1084 );
1085 if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
1086 EnableResetRequired ();
1087 }
1088
1089 //
1090 // We will have returned from processing a callback, selected
1091 // a target to display
1092 //
1093 if ((gCallbackKey >= DEVICE_KEY_OFFSET)) {
1094 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
1095 Status = gFormBrowser2->SendForm (
1096 gFormBrowser2,
1097 &HiiHandles[gCallbackKey - DEVICE_KEY_OFFSET],
1098 1,
1099 GuidLists[gCallbackKey - DEVICE_KEY_OFFSET],
1100 0,
1101 NULL,
1102 &ActionRequest
1103 );
1104
1105 if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
1106 EnableResetRequired ();
1107 }
1108
1109 //
1110 // Force return to Device Manager
1111 //
1112 gCallbackKey = FRONT_PAGE_KEY_DEVICE_MANAGER;
1113 goto Done;
1114 }
1115
1116 //
1117 // Driver Health item chose.
1118 //
1119 if (gCallbackKey == DEVICE_MANAGER_KEY_DRIVER_HEALTH) {
1120 CallDriverHealth ();
1121 //
1122 // Force return to Device Manager
1123 //
1124 gCallbackKey = FRONT_PAGE_KEY_DEVICE_MANAGER;
1125 goto Done;
1126 }
1127
1128 //
1129 // Enter from device manager and into the network device list.
1130 //
1131 if (gCallbackKey == QUESTION_NETWORK_DEVICE_ID) {
1132 mNextShowFormId = NETWORK_DEVICE_LIST_FORM_ID;
1133 gCallbackKey = FRONT_PAGE_KEY_DEVICE_MANAGER;
1134 goto Done;
1135 }
1136
1137 //
1138 // In this case, go from the network device list to the specify device.
1139 //
1140 if ((gCallbackKey < MAX_KEY_SECTION_LEN + NETWORK_DEVICE_LIST_KEY_OFFSET ) && (gCallbackKey >= NETWORK_DEVICE_LIST_KEY_OFFSET)) {
1141 mNextShowFormId = NETWORK_DEVICE_FORM_ID;
1142 gCallbackKey = FRONT_PAGE_KEY_DEVICE_MANAGER;
1143 goto Done;
1144 }
1145
1146 //
1147 // Select the ESC, the gCallbackKey == 0.
1148 //
1149 if(mNextShowFormId - 1 < DEVICE_MANAGER_FORM_ID) {
1150 mNextShowFormId = DEVICE_MANAGER_FORM_ID;
1151 } else {
1152 mNextShowFormId = (UINT16) (mNextShowFormId - 1);
1153 gCallbackKey = FRONT_PAGE_KEY_DEVICE_MANAGER;
1154 }
1155
1156 Done:
1157 //
1158 // Remove our packagelist from HII database.
1159 //
1160 HiiRemovePackages (HiiHandle);
1161 gDeviceManagerPrivate.HiiHandle = NULL;
1162
1163 HiiFreeOpCodeHandle (StartOpCodeHandle);
1164 HiiFreeOpCodeHandle (EndOpCodeHandle);
1165 FreePool (HiiHandles);
1166
1167 for (Index = 0; Index < HandleNum; Index++) {
1168 if (GuidLists[Index] != NULL) {
1169 FreePool (GuidLists[Index]);
1170 }
1171 }
1172 FreePool (GuidLists);
1173
1174 return Status;
1175 }
1176
1177 /**
1178 This function is invoked if user selected a interactive opcode from Driver Health's
1179 Formset. The decision by user is saved to gCallbackKey for later processing.
1180
1181 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
1182 @param Action Specifies the type of action taken by the browser.
1183 @param QuestionId A unique value which is sent to the original exporting driver
1184 so that it can identify the type of data to expect.
1185 @param Type The type of value for the question.
1186 @param Value A pointer to the data being sent to the original exporting driver.
1187 @param ActionRequest On return, points to the action requested by the callback function.
1188
1189 @retval EFI_SUCCESS The callback successfully handled the action.
1190 @retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.
1191
1192 **/
1193 EFI_STATUS
1194 EFIAPI
1195 DriverHealthCallback (
1196 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
1197 IN EFI_BROWSER_ACTION Action,
1198 IN EFI_QUESTION_ID QuestionId,
1199 IN UINT8 Type,
1200 IN EFI_IFR_TYPE_VALUE *Value,
1201 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
1202 )
1203 {
1204 if (Action == EFI_BROWSER_ACTION_CHANGED) {
1205 if ((Value == NULL) || (ActionRequest == NULL)) {
1206 return EFI_INVALID_PARAMETER;
1207 }
1208
1209 gCallbackKey = QuestionId;
1210
1211 //
1212 // Request to exit SendForm(), so as to switch to selected form
1213 //
1214 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
1215
1216 return EFI_SUCCESS;
1217 }
1218
1219 //
1220 // All other action return unsupported.
1221 //
1222 return EFI_UNSUPPORTED;
1223 }
1224
1225 /**
1226 Collect and display the platform's driver health relative information, allow user to do interactive
1227 operation while the platform is unhealthy.
1228
1229 This function display a form which divided into two parts. The one list all modules which has installed
1230 driver health protocol. The list usually contain driver name, controller name, and it's health info.
1231 While the driver name can't be retrieved, will use device path as backup. The other part of the form provide
1232 a choice to the user to repair all platform.
1233
1234 **/
1235 VOID
1236 CallDriverHealth (
1237 VOID
1238 )
1239 {
1240 EFI_STATUS Status;
1241 EFI_HII_HANDLE HiiHandle;
1242 EFI_BROWSER_ACTION_REQUEST ActionRequest;
1243 EFI_IFR_GUID_LABEL *StartLabel;
1244 EFI_IFR_GUID_LABEL *StartLabelRepair;
1245 EFI_IFR_GUID_LABEL *EndLabel;
1246 EFI_IFR_GUID_LABEL *EndLabelRepair;
1247 VOID *StartOpCodeHandle;
1248 VOID *EndOpCodeHandle;
1249 VOID *StartOpCodeHandleRepair;
1250 VOID *EndOpCodeHandleRepair;
1251 UINTN Index;
1252 EFI_STRING_ID Token;
1253 EFI_STRING_ID TokenHelp;
1254 EFI_STRING String;
1255 EFI_STRING TmpString;
1256 EFI_STRING DriverName;
1257 EFI_STRING ControllerName;
1258 LIST_ENTRY DriverHealthList;
1259 DRIVER_HEALTH_INFO *DriverHealthInfo;
1260 LIST_ENTRY *Link;
1261 EFI_DEVICE_PATH_PROTOCOL *DriverDevicePath;
1262 BOOLEAN RebootRequired;
1263
1264 Index = 0;
1265 DriverHealthInfo = NULL;
1266 DriverDevicePath = NULL;
1267 InitializeListHead (&DriverHealthList);
1268
1269 HiiHandle = gDeviceManagerPrivate.DriverHealthHiiHandle;
1270 if (HiiHandle == NULL) {
1271 //
1272 // Publish Driver Health HII data.
1273 //
1274 HiiHandle = HiiAddPackages (
1275 &gDeviceManagerFormSetGuid,
1276 gDeviceManagerPrivate.DriverHealthHandle,
1277 DriverHealthVfrBin,
1278 BdsDxeStrings,
1279 NULL
1280 );
1281 if (HiiHandle == NULL) {
1282 return;
1283 }
1284
1285 gDeviceManagerPrivate.DriverHealthHiiHandle = HiiHandle;
1286 }
1287
1288 //
1289 // Allocate space for creation of UpdateData Buffer
1290 //
1291 StartOpCodeHandle = HiiAllocateOpCodeHandle ();
1292 ASSERT (StartOpCodeHandle != NULL);
1293
1294 EndOpCodeHandle = HiiAllocateOpCodeHandle ();
1295 ASSERT (EndOpCodeHandle != NULL);
1296
1297 StartOpCodeHandleRepair = HiiAllocateOpCodeHandle ();
1298 ASSERT (StartOpCodeHandleRepair != NULL);
1299
1300 EndOpCodeHandleRepair = HiiAllocateOpCodeHandle ();
1301 ASSERT (EndOpCodeHandleRepair != NULL);
1302
1303 //
1304 // Create Hii Extend Label OpCode as the start opcode
1305 //
1306 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
1307 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
1308 StartLabel->Number = LABEL_DRIVER_HEALTH;
1309
1310 //
1311 // Create Hii Extend Label OpCode as the start opcode
1312 //
1313 StartLabelRepair = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandleRepair, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
1314 StartLabelRepair->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
1315 StartLabelRepair->Number = LABEL_DRIVER_HEALTH_REAPIR_ALL;
1316
1317 //
1318 // Create Hii Extend Label OpCode as the end opcode
1319 //
1320 EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
1321 EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
1322 EndLabel->Number = LABEL_DRIVER_HEALTH_END;
1323
1324 //
1325 // Create Hii Extend Label OpCode as the end opcode
1326 //
1327 EndLabelRepair = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandleRepair, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
1328 EndLabelRepair->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
1329 EndLabelRepair->Number = LABEL_DRIVER_HEALTH_REAPIR_ALL_END;
1330
1331 HiiCreateSubTitleOpCode (StartOpCodeHandle, STRING_TOKEN (STR_DH_STATUS_LIST), 0, 0, 1);
1332
1333 Status = GetAllControllersHealthStatus (&DriverHealthList);
1334 ASSERT (Status != EFI_OUT_OF_RESOURCES);
1335
1336 Link = GetFirstNode (&DriverHealthList);
1337
1338 while (!IsNull (&DriverHealthList, Link)) {
1339 DriverHealthInfo = DEVICE_MANAGER_HEALTH_INFO_FROM_LINK (Link);
1340
1341 //
1342 // Assume no line strings is longer than 512 bytes.
1343 //
1344 String = (EFI_STRING) AllocateZeroPool (0x200);
1345 ASSERT (String != NULL);
1346
1347 Status = DriverHealthGetDriverName (DriverHealthInfo->DriverHandle, &DriverName);
1348 if (EFI_ERROR (Status)) {
1349 //
1350 // Can not get the Driver name, so use the Device path
1351 //
1352 DriverDevicePath = DevicePathFromHandle (DriverHealthInfo->DriverHandle);
1353 DriverName = DevicePathToStr (DriverDevicePath);
1354 }
1355 //
1356 // Add the Driver name & Controller name into FormSetTitle string
1357 //
1358 StrnCat (String, DriverName, StrLen (DriverName));
1359
1360
1361 Status = DriverHealthGetControllerName (
1362 DriverHealthInfo->DriverHandle,
1363 DriverHealthInfo->ControllerHandle,
1364 DriverHealthInfo->ChildHandle,
1365 &ControllerName
1366 );
1367
1368 if (!EFI_ERROR (Status)) {
1369 //
1370 // Can not get the Controller name, just let it empty.
1371 //
1372 StrnCat (String, L" ", StrLen (L" "));
1373 StrnCat (String, ControllerName, StrLen (ControllerName));
1374 }
1375
1376 //
1377 // Add the message of the Module itself provided after the string item.
1378 //
1379 if ((DriverHealthInfo->MessageList != NULL) && (DriverHealthInfo->MessageList->StringId != 0)) {
1380 StrnCat (String, L" ", StrLen (L" "));
1381 TmpString = HiiGetString (
1382 DriverHealthInfo->MessageList->HiiHandle,
1383 DriverHealthInfo->MessageList->StringId,
1384 NULL
1385 );
1386 } else {
1387 //
1388 // Update the string will be displayed base on the driver's health status
1389 //
1390 switch(DriverHealthInfo->HealthStatus) {
1391 case EfiDriverHealthStatusRepairRequired:
1392 TmpString = GetStringById (STRING_TOKEN (STR_REPAIR_REQUIRED));
1393 break;
1394 case EfiDriverHealthStatusConfigurationRequired:
1395 TmpString = GetStringById (STRING_TOKEN (STR_CONFIGURATION_REQUIRED));
1396 break;
1397 case EfiDriverHealthStatusFailed:
1398 TmpString = GetStringById (STRING_TOKEN (STR_OPERATION_FAILED));
1399 break;
1400 case EfiDriverHealthStatusReconnectRequired:
1401 TmpString = GetStringById (STRING_TOKEN (STR_RECONNECT_REQUIRED));
1402 break;
1403 case EfiDriverHealthStatusRebootRequired:
1404 TmpString = GetStringById (STRING_TOKEN (STR_REBOOT_REQUIRED));
1405 break;
1406 default:
1407 TmpString = GetStringById (STRING_TOKEN (STR_DRIVER_HEALTH_HEALTHY));
1408 break;
1409 }
1410 }
1411
1412 ASSERT (TmpString != NULL);
1413 StrCat (String, TmpString);
1414 FreePool (TmpString);
1415
1416 Token = HiiSetString (HiiHandle, 0, String, NULL);
1417 FreePool (String);
1418
1419 TokenHelp = HiiSetString (HiiHandle, 0, GetStringById( STRING_TOKEN (STR_DH_REPAIR_SINGLE_HELP)), NULL);
1420
1421 HiiCreateActionOpCode (
1422 StartOpCodeHandle,
1423 (EFI_QUESTION_ID) (Index + DRIVER_HEALTH_KEY_OFFSET),
1424 Token,
1425 TokenHelp,
1426 EFI_IFR_FLAG_CALLBACK,
1427 0
1428 );
1429 Index++;
1430 Link = GetNextNode (&DriverHealthList, Link);
1431 }
1432
1433 //
1434 // Add End Opcode for Subtitle
1435 //
1436 HiiCreateEndOpCode (StartOpCodeHandle);
1437
1438 HiiCreateSubTitleOpCode (StartOpCodeHandleRepair, STRING_TOKEN (STR_DRIVER_HEALTH_REPAIR_ALL), 0, 0, 1);
1439 TokenHelp = HiiSetString (HiiHandle, 0, GetStringById( STRING_TOKEN (STR_DH_REPAIR_ALL_HELP)), NULL);
1440
1441 if (PlaformHealthStatusCheck ()) {
1442 //
1443 // No action need to do for the platform
1444 //
1445 Token = HiiSetString (HiiHandle, 0, GetStringById( STRING_TOKEN (STR_DRIVER_HEALTH_ALL_HEALTHY)), NULL);
1446 HiiCreateActionOpCode (
1447 StartOpCodeHandleRepair,
1448 0,
1449 Token,
1450 TokenHelp,
1451 EFI_IFR_FLAG_READ_ONLY,
1452 0
1453 );
1454 } else {
1455 //
1456 // Create ActionOpCode only while the platform need to do health related operation.
1457 //
1458 Token = HiiSetString (HiiHandle, 0, GetStringById( STRING_TOKEN (STR_DH_REPAIR_ALL_TITLE)), NULL);
1459 HiiCreateActionOpCode (
1460 StartOpCodeHandleRepair,
1461 (EFI_QUESTION_ID) DRIVER_HEALTH_REPAIR_ALL_KEY,
1462 Token,
1463 TokenHelp,
1464 EFI_IFR_FLAG_CALLBACK,
1465 0
1466 );
1467 }
1468
1469 HiiCreateEndOpCode (StartOpCodeHandleRepair);
1470
1471 Status = HiiUpdateForm (
1472 HiiHandle,
1473 &gDriverHealthFormSetGuid,
1474 DRIVER_HEALTH_FORM_ID,
1475 StartOpCodeHandle,
1476 EndOpCodeHandle
1477 );
1478 ASSERT (Status != EFI_NOT_FOUND);
1479 ASSERT (Status != EFI_BUFFER_TOO_SMALL);
1480
1481 Status = HiiUpdateForm (
1482 HiiHandle,
1483 &gDriverHealthFormSetGuid,
1484 DRIVER_HEALTH_FORM_ID,
1485 StartOpCodeHandleRepair,
1486 EndOpCodeHandleRepair
1487 );
1488 ASSERT (Status != EFI_NOT_FOUND);
1489 ASSERT (Status != EFI_BUFFER_TOO_SMALL);
1490
1491 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
1492 Status = gFormBrowser2->SendForm (
1493 gFormBrowser2,
1494 &HiiHandle,
1495 1,
1496 &gDriverHealthFormSetGuid,
1497 DRIVER_HEALTH_FORM_ID,
1498 NULL,
1499 &ActionRequest
1500 );
1501 if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
1502 EnableResetRequired ();
1503 }
1504
1505 //
1506 // We will have returned from processing a callback - user either hit ESC to exit, or selected
1507 // a target to display.
1508 // Process the diver health status states here.
1509 //
1510 if (gCallbackKey >= DRIVER_HEALTH_KEY_OFFSET && gCallbackKey != DRIVER_HEALTH_REPAIR_ALL_KEY) {
1511 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
1512
1513 Link = GetFirstNode (&DriverHealthList);
1514 Index = 0;
1515
1516 while (!IsNull (&DriverHealthList, Link)) {
1517 //
1518 // Got the item relative node in the List
1519 //
1520 if (Index == (gCallbackKey - DRIVER_HEALTH_KEY_OFFSET)) {
1521 DriverHealthInfo = DEVICE_MANAGER_HEALTH_INFO_FROM_LINK (Link);
1522 //
1523 // Process the driver's healthy status for the specify module
1524 //
1525 RebootRequired = FALSE;
1526 ProcessSingleControllerHealth (
1527 DriverHealthInfo->DriverHealth,
1528 DriverHealthInfo->ControllerHandle,
1529 DriverHealthInfo->ChildHandle,
1530 DriverHealthInfo->HealthStatus,
1531 &(DriverHealthInfo->MessageList),
1532 DriverHealthInfo->HiiHandle,
1533 &RebootRequired
1534 );
1535 if (RebootRequired) {
1536 gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);
1537 }
1538 break;
1539 }
1540 Index++;
1541 Link = GetNextNode (&DriverHealthList, Link);
1542 }
1543
1544 if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
1545 EnableResetRequired ();
1546 }
1547
1548 //
1549 // Force return to the form of Driver Health in Device Manager
1550 //
1551 gCallbackKey = DRIVER_HEALTH_RETURN_KEY;
1552 }
1553
1554 //
1555 // Repair the whole platform
1556 //
1557 if (gCallbackKey == DRIVER_HEALTH_REPAIR_ALL_KEY) {
1558 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
1559
1560 PlatformRepairAll (&DriverHealthList);
1561
1562 gCallbackKey = DRIVER_HEALTH_RETURN_KEY;
1563 }
1564
1565 //
1566 // Remove driver health packagelist from HII database.
1567 //
1568 HiiRemovePackages (HiiHandle);
1569 gDeviceManagerPrivate.DriverHealthHiiHandle = NULL;
1570
1571 //
1572 // Free driver health info list
1573 //
1574 while (!IsListEmpty (&DriverHealthList)) {
1575
1576 Link = GetFirstNode(&DriverHealthList);
1577 DriverHealthInfo = DEVICE_MANAGER_HEALTH_INFO_FROM_LINK (Link);
1578 RemoveEntryList (Link);
1579
1580 if (DriverHealthInfo->MessageList != NULL) {
1581 FreePool(DriverHealthInfo->MessageList);
1582 FreePool (DriverHealthInfo);
1583 }
1584 }
1585
1586 HiiFreeOpCodeHandle (StartOpCodeHandle);
1587 HiiFreeOpCodeHandle (EndOpCodeHandle);
1588 HiiFreeOpCodeHandle (StartOpCodeHandleRepair);
1589 HiiFreeOpCodeHandle (EndOpCodeHandleRepair);
1590
1591 if (gCallbackKey == DRIVER_HEALTH_RETURN_KEY) {
1592 //
1593 // Force return to Driver Health Form
1594 //
1595 gCallbackKey = DEVICE_MANAGER_KEY_DRIVER_HEALTH;
1596 CallDriverHealth ();
1597 }
1598 }
1599
1600
1601 /**
1602 Check the Driver Health status of a single controller and try to process it if not healthy.
1603
1604 This function called by CheckAllControllersHealthStatus () function in order to process a specify
1605 contoller's health state.
1606
1607 @param DriverHealthList A Pointer to the list contain all of the platform driver health information.
1608 @param DriverHandle The handle of driver.
1609 @param ControllerHandle The class guid specifies which form set will be displayed.
1610 @param ChildHandle The handle of the child controller to retrieve the health
1611 status on. This is an optional parameter that may be NULL.
1612 @param DriverHealth A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.
1613 @param HealthStatus The health status of the controller.
1614
1615 @retval EFI_INVALID_PARAMETER HealthStatus or DriverHealth is NULL.
1616 @retval HealthStatus The Health status of specify controller.
1617 @retval EFI_OUT_OF_RESOURCES The list of Driver Health Protocol handles can not be retrieved.
1618 @retval EFI_NOT_FOUND No controller in the platform install Driver Health Protocol.
1619 @retval EFI_SUCCESS The Health related operation has been taken successfully.
1620
1621 **/
1622 EFI_STATUS
1623 EFIAPI
1624 GetSingleControllerHealthStatus (
1625 IN OUT LIST_ENTRY *DriverHealthList,
1626 IN EFI_HANDLE DriverHandle,
1627 IN EFI_HANDLE ControllerHandle, OPTIONAL
1628 IN EFI_HANDLE ChildHandle, OPTIONAL
1629 IN EFI_DRIVER_HEALTH_PROTOCOL *DriverHealth,
1630 IN EFI_DRIVER_HEALTH_STATUS *HealthStatus
1631 )
1632 {
1633 EFI_STATUS Status;
1634 EFI_DRIVER_HEALTH_HII_MESSAGE *MessageList;
1635 EFI_HII_HANDLE FormHiiHandle;
1636 DRIVER_HEALTH_INFO *DriverHealthInfo;
1637
1638 if (HealthStatus == NULL) {
1639 //
1640 // If HealthStatus is NULL, then return EFI_INVALID_PARAMETER
1641 //
1642 return EFI_INVALID_PARAMETER;
1643 }
1644
1645 //
1646 // Assume the HealthStatus is healthy
1647 //
1648 *HealthStatus = EfiDriverHealthStatusHealthy;
1649
1650 if (DriverHealth == NULL) {
1651 //
1652 // If DriverHealth is NULL, then return EFI_INVALID_PARAMETER
1653 //
1654 return EFI_INVALID_PARAMETER;
1655 }
1656
1657 if (ControllerHandle == NULL) {
1658 //
1659 // If ControllerHandle is NULL, the return the cumulative health status of the driver
1660 //
1661 Status = DriverHealth->GetHealthStatus (DriverHealth, NULL, NULL, HealthStatus, NULL, NULL);
1662 if (*HealthStatus == EfiDriverHealthStatusHealthy) {
1663 //
1664 // Add the driver health related information into the list
1665 //
1666 DriverHealthInfo = AllocateZeroPool (sizeof (DRIVER_HEALTH_INFO));
1667 if (DriverHealthInfo == NULL) {
1668 return EFI_OUT_OF_RESOURCES;
1669 }
1670
1671 DriverHealthInfo->Signature = DEVICE_MANAGER_DRIVER_HEALTH_INFO_SIGNATURE;
1672 DriverHealthInfo->DriverHandle = DriverHandle;
1673 DriverHealthInfo->ControllerHandle = NULL;
1674 DriverHealthInfo->ChildHandle = NULL;
1675 DriverHealthInfo->HiiHandle = NULL;
1676 DriverHealthInfo->DriverHealth = DriverHealth;
1677 DriverHealthInfo->MessageList = NULL;
1678 DriverHealthInfo->HealthStatus = *HealthStatus;
1679
1680 InsertTailList (DriverHealthList, &DriverHealthInfo->Link);
1681 }
1682 return Status;
1683 }
1684
1685 MessageList = NULL;
1686 FormHiiHandle = NULL;
1687
1688 //
1689 // Collect the health status with the optional HII message list
1690 //
1691 Status = DriverHealth->GetHealthStatus (DriverHealth, ControllerHandle, ChildHandle, HealthStatus, &MessageList, &FormHiiHandle);
1692
1693 if (EFI_ERROR (Status)) {
1694 //
1695 // If the health status could not be retrieved, then return immediately
1696 //
1697 return Status;
1698 }
1699
1700 //
1701 // Add the driver health related information into the list
1702 //
1703 DriverHealthInfo = AllocateZeroPool (sizeof (DRIVER_HEALTH_INFO));
1704 if (DriverHealthInfo == NULL) {
1705 return EFI_OUT_OF_RESOURCES;
1706 }
1707
1708 DriverHealthInfo->Signature = DEVICE_MANAGER_DRIVER_HEALTH_INFO_SIGNATURE;
1709 DriverHealthInfo->DriverHandle = DriverHandle;
1710 DriverHealthInfo->ControllerHandle = ControllerHandle;
1711 DriverHealthInfo->ChildHandle = ChildHandle;
1712 DriverHealthInfo->HiiHandle = FormHiiHandle;
1713 DriverHealthInfo->DriverHealth = DriverHealth;
1714 DriverHealthInfo->MessageList = MessageList;
1715 DriverHealthInfo->HealthStatus = *HealthStatus;
1716
1717 InsertTailList (DriverHealthList, &DriverHealthInfo->Link);
1718
1719 return EFI_SUCCESS;
1720 }
1721
1722 /**
1723 Collects all the EFI Driver Health Protocols currently present in the EFI Handle Database,
1724 and queries each EFI Driver Health Protocol to determine if one or more of the controllers
1725 managed by each EFI Driver Health Protocol instance are not healthy.
1726
1727 @param DriverHealthList A Pointer to the list contain all of the platform driver health
1728 information.
1729
1730 @retval EFI_NOT_FOUND No controller in the platform install Driver Health Protocol.
1731 @retval EFI_SUCCESS All the controllers in the platform are healthy.
1732 @retval EFI_OUT_OF_RESOURCES The list of Driver Health Protocol handles can not be retrieved.
1733
1734 **/
1735 EFI_STATUS
1736 GetAllControllersHealthStatus (
1737 IN OUT LIST_ENTRY *DriverHealthList
1738 )
1739 {
1740 EFI_STATUS Status;
1741 UINTN NumHandles;
1742 EFI_HANDLE *DriverHealthHandles;
1743 EFI_DRIVER_HEALTH_PROTOCOL *DriverHealth;
1744 EFI_DRIVER_HEALTH_STATUS HealthStatus;
1745 UINTN DriverHealthIndex;
1746 EFI_HANDLE *Handles;
1747 UINTN HandleCount;
1748 UINTN ControllerIndex;
1749 UINTN ChildIndex;
1750
1751 //
1752 // Initialize local variables
1753 //
1754 Handles = NULL;
1755 DriverHealthHandles = NULL;
1756 NumHandles = 0;
1757 HandleCount = 0;
1758
1759 HealthStatus = EfiDriverHealthStatusHealthy;
1760
1761 Status = gBS->LocateHandleBuffer (
1762 ByProtocol,
1763 &gEfiDriverHealthProtocolGuid,
1764 NULL,
1765 &NumHandles,
1766 &DriverHealthHandles
1767 );
1768
1769 if (Status == EFI_NOT_FOUND || NumHandles == 0) {
1770 //
1771 // If there are no Driver Health Protocols handles, then return EFI_NOT_FOUND
1772 //
1773 return EFI_NOT_FOUND;
1774 }
1775
1776 if (EFI_ERROR (Status) || DriverHealthHandles == NULL) {
1777 //
1778 // If the list of Driver Health Protocol handles can not be retrieved, then
1779 // return EFI_OUT_OF_RESOURCES
1780 //
1781 return EFI_OUT_OF_RESOURCES;
1782 }
1783
1784 //
1785 // Check the health status of all controllers in the platform
1786 // Start by looping through all the Driver Health Protocol handles in the handle database
1787 //
1788 for (DriverHealthIndex = 0; DriverHealthIndex < NumHandles; DriverHealthIndex++) {
1789 //
1790 // Skip NULL Driver Health Protocol handles
1791 //
1792 if (DriverHealthHandles[DriverHealthIndex] == NULL) {
1793 continue;
1794 }
1795
1796 //
1797 // Retrieve the Driver Health Protocol from DriverHandle
1798 //
1799 Status = gBS->HandleProtocol (
1800 DriverHealthHandles[DriverHealthIndex],
1801 &gEfiDriverHealthProtocolGuid,
1802 (VOID **)&DriverHealth
1803 );
1804 if (EFI_ERROR (Status)) {
1805 //
1806 // If the Driver Health Protocol can not be retrieved, then skip to the next
1807 // Driver Health Protocol handle
1808 //
1809 continue;
1810 }
1811
1812 //
1813 // Check the health of all the controllers managed by a Driver Health Protocol handle
1814 //
1815 Status = GetSingleControllerHealthStatus (DriverHealthList, DriverHealthHandles[DriverHealthIndex], NULL, NULL, DriverHealth, &HealthStatus);
1816
1817 //
1818 // If Status is an error code, then the health information could not be retrieved, so assume healthy
1819 // and skip to the next Driver Health Protocol handle
1820 //
1821 if (EFI_ERROR (Status)) {
1822 continue;
1823 }
1824
1825 //
1826 // If all the controllers managed by this Driver Health Protocol are healthy, then skip to the next
1827 // Driver Health Protocol handle
1828 //
1829 if (HealthStatus == EfiDriverHealthStatusHealthy) {
1830 continue;
1831 }
1832
1833 //
1834 // See if the list of all handles in the handle database has been retrieved
1835 //
1836 //
1837 if (Handles == NULL) {
1838 //
1839 // Retrieve the list of all handles from the handle database
1840 //
1841 Status = gBS->LocateHandleBuffer (
1842 AllHandles,
1843 NULL,
1844 NULL,
1845 &HandleCount,
1846 &Handles
1847 );
1848 if (EFI_ERROR (Status) || Handles == NULL) {
1849 //
1850 // If all the handles in the handle database can not be retrieved, then
1851 // return EFI_OUT_OF_RESOURCES
1852 //
1853 Status = EFI_OUT_OF_RESOURCES;
1854 goto Done;
1855 }
1856 }
1857 //
1858 // Loop through all the controller handles in the handle database
1859 //
1860 for (ControllerIndex = 0; ControllerIndex < HandleCount; ControllerIndex++) {
1861 //
1862 // Skip NULL controller handles
1863 //
1864 if (Handles[ControllerIndex] == NULL) {
1865 continue;
1866 }
1867
1868 Status = GetSingleControllerHealthStatus (DriverHealthList, DriverHealthHandles[DriverHealthIndex], Handles[ControllerIndex], NULL, DriverHealth, &HealthStatus);
1869 if (EFI_ERROR (Status)) {
1870 //
1871 // If Status is an error code, then the health information could not be retrieved, so assume healthy
1872 //
1873 HealthStatus = EfiDriverHealthStatusHealthy;
1874 }
1875
1876 //
1877 // If CheckHealthSingleController() returned an error on a terminal state, then do not check the health of child controllers
1878 //
1879 if (EFI_ERROR (Status)) {
1880 continue;
1881 }
1882
1883 //
1884 // Loop through all the child handles in the handle database
1885 //
1886 for (ChildIndex = 0; ChildIndex < HandleCount; ChildIndex++) {
1887 //
1888 // Skip NULL child handles
1889 //
1890 if (Handles[ChildIndex] == NULL) {
1891 continue;
1892 }
1893
1894 Status = GetSingleControllerHealthStatus (DriverHealthList, DriverHealthHandles[DriverHealthIndex], Handles[ControllerIndex], Handles[ChildIndex], DriverHealth, &HealthStatus);
1895 if (EFI_ERROR (Status)) {
1896 //
1897 // If Status is an error code, then the health information could not be retrieved, so assume healthy
1898 //
1899 HealthStatus = EfiDriverHealthStatusHealthy;
1900 }
1901
1902 //
1903 // If CheckHealthSingleController() returned an error on a terminal state, then skip to the next child
1904 //
1905 if (EFI_ERROR (Status)) {
1906 continue;
1907 }
1908 }
1909 }
1910 }
1911
1912 Status = EFI_SUCCESS;
1913
1914 Done:
1915 if (Handles != NULL) {
1916 gBS->FreePool (Handles);
1917 }
1918 if (DriverHealthHandles != NULL) {
1919 gBS->FreePool (DriverHealthHandles);
1920 }
1921
1922 return Status;
1923 }
1924
1925
1926 /**
1927 Check the healthy status of the platform, this function will return immediately while found one driver
1928 in the platform are not healthy.
1929
1930 @retval FALSE at least one driver in the platform are not healthy.
1931 @retval TRUE No controller install Driver Health Protocol,
1932 or all controllers in the platform are in healthy status.
1933 **/
1934 BOOLEAN
1935 PlaformHealthStatusCheck (
1936 VOID
1937 )
1938 {
1939 EFI_DRIVER_HEALTH_STATUS HealthStatus;
1940 EFI_STATUS Status;
1941 UINTN Index;
1942 UINTN NoHandles;
1943 EFI_HANDLE *DriverHealthHandles;
1944 EFI_DRIVER_HEALTH_PROTOCOL *DriverHealth;
1945 BOOLEAN AllHealthy;
1946
1947 //
1948 // Initialize local variables
1949 //
1950 DriverHealthHandles = NULL;
1951 DriverHealth = NULL;
1952
1953 HealthStatus = EfiDriverHealthStatusHealthy;
1954
1955 Status = gBS->LocateHandleBuffer (
1956 ByProtocol,
1957 &gEfiDriverHealthProtocolGuid,
1958 NULL,
1959 &NoHandles,
1960 &DriverHealthHandles
1961 );
1962 //
1963 // There are no handles match the search for Driver Health Protocol has been installed.
1964 //
1965 if (Status == EFI_NOT_FOUND) {
1966 return TRUE;
1967 }
1968 //
1969 // Assume all modules are healthy.
1970 //
1971 AllHealthy = TRUE;
1972
1973 //
1974 // Found one or more Handles.
1975 //
1976 if (!EFI_ERROR (Status)) {
1977 for (Index = 0; Index < NoHandles; Index++) {
1978 Status = gBS->HandleProtocol (
1979 DriverHealthHandles[Index],
1980 &gEfiDriverHealthProtocolGuid,
1981 (VOID **) &DriverHealth
1982 );
1983 if (!EFI_ERROR (Status)) {
1984 Status = DriverHealth->GetHealthStatus (
1985 DriverHealth,
1986 NULL,
1987 NULL,
1988 &HealthStatus,
1989 NULL,
1990 NULL
1991 );
1992 }
1993 //
1994 // Get the healthy status of the module
1995 //
1996 if (!EFI_ERROR (Status)) {
1997 if (HealthStatus != EfiDriverHealthStatusHealthy) {
1998 //
1999 // Return immediately one driver's status not in healthy.
2000 //
2001 return FALSE;
2002 }
2003 }
2004 }
2005 }
2006 return AllHealthy;
2007 }
2008
2009 /**
2010 Processes a single controller using the EFI Driver Health Protocol associated with
2011 that controller. This algorithm continues to query the GetHealthStatus() service until
2012 one of the legal terminal states of the EFI Driver Health Protocol is reached. This may
2013 require the processing of HII Messages, HII Form, and invocation of repair operations.
2014
2015 @param DriverHealth A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.
2016 @param ControllerHandle The class guid specifies which form set will be displayed.
2017 @param ChildHandle The handle of the child controller to retrieve the health
2018 status on. This is an optional parameter that may be NULL.
2019 @param HealthStatus The health status of the controller.
2020 @param MessageList An array of warning or error messages associated
2021 with the controller specified by ControllerHandle and
2022 ChildHandle. This is an optional parameter that may be NULL.
2023 @param FormHiiHandle The HII handle for an HII form associated with the
2024 controller specified by ControllerHandle and ChildHandle.
2025 @param RebootRequired Indicate whether a reboot is required to repair the controller.
2026 **/
2027 VOID
2028 ProcessSingleControllerHealth (
2029 IN EFI_DRIVER_HEALTH_PROTOCOL *DriverHealth,
2030 IN EFI_HANDLE ControllerHandle, OPTIONAL
2031 IN EFI_HANDLE ChildHandle, OPTIONAL
2032 IN EFI_DRIVER_HEALTH_STATUS HealthStatus,
2033 IN EFI_DRIVER_HEALTH_HII_MESSAGE **MessageList, OPTIONAL
2034 IN EFI_HII_HANDLE FormHiiHandle,
2035 IN OUT BOOLEAN *RebootRequired
2036 )
2037 {
2038 EFI_STATUS Status;
2039 EFI_DRIVER_HEALTH_STATUS LocalHealthStatus;
2040
2041 LocalHealthStatus = HealthStatus;
2042 //
2043 // If the module need to be repaired or reconfiguration, will process it until
2044 // reach a terminal status. The status from EfiDriverHealthStatusRepairRequired after repair
2045 // will be in (Health, Failed, Configuration Required).
2046 //
2047 while(LocalHealthStatus == EfiDriverHealthStatusConfigurationRequired ||
2048 LocalHealthStatus == EfiDriverHealthStatusRepairRequired) {
2049
2050 if (LocalHealthStatus == EfiDriverHealthStatusRepairRequired) {
2051 Status = DriverHealth->Repair (
2052 DriverHealth,
2053 ControllerHandle,
2054 ChildHandle,
2055 RepairNotify
2056 );
2057 }
2058 //
2059 // Via a form of the driver need to do configuration provided to process of status in
2060 // EfiDriverHealthStatusConfigurationRequired. The status after configuration should be in
2061 // (Healthy, Reboot Required, Failed, Reconnect Required, Repair Required).
2062 //
2063 if (LocalHealthStatus == EfiDriverHealthStatusConfigurationRequired) {
2064 if (FormHiiHandle != NULL) {
2065 Status = gFormBrowser2->SendForm (
2066 gFormBrowser2,
2067 &FormHiiHandle,
2068 1,
2069 &gEfiHiiDriverHealthFormsetGuid,
2070 0,
2071 NULL,
2072 NULL
2073 );
2074 ASSERT( !EFI_ERROR (Status));
2075 } else {
2076 //
2077 // Exit the loop in case no FormHiiHandle is supplied to prevent dead-loop
2078 //
2079 break;
2080 }
2081 }
2082
2083 Status = DriverHealth->GetHealthStatus (
2084 DriverHealth,
2085 ControllerHandle,
2086 ChildHandle,
2087 &LocalHealthStatus,
2088 NULL,
2089 &FormHiiHandle
2090 );
2091 ASSERT_EFI_ERROR (Status);
2092
2093 if (*MessageList != NULL) {
2094 ProcessMessages (*MessageList);
2095 }
2096 }
2097
2098 //
2099 // Health status in {Healthy, Failed} may also have Messages need to process
2100 //
2101 if (LocalHealthStatus == EfiDriverHealthStatusHealthy || LocalHealthStatus == EfiDriverHealthStatusFailed) {
2102 if (*MessageList != NULL) {
2103 ProcessMessages (*MessageList);
2104 }
2105 }
2106 //
2107 // Check for RebootRequired or ReconnectRequired
2108 //
2109 if (LocalHealthStatus == EfiDriverHealthStatusRebootRequired) {
2110 *RebootRequired = TRUE;
2111 }
2112
2113 //
2114 // Do reconnect if need.
2115 //
2116 if (LocalHealthStatus == EfiDriverHealthStatusReconnectRequired) {
2117 Status = gBS->DisconnectController (ControllerHandle, NULL, NULL);
2118 if (EFI_ERROR (Status)) {
2119 //
2120 // Disconnect failed. Need to promote reconnect to a reboot.
2121 //
2122 *RebootRequired = TRUE;
2123 } else {
2124 gBS->ConnectController (ControllerHandle, NULL, NULL, TRUE);
2125 }
2126 }
2127 }
2128
2129
2130 /**
2131 Reports the progress of a repair operation.
2132
2133 @param[in] Value A value between 0 and Limit that identifies the current
2134 progress of the repair operation.
2135
2136 @param[in] Limit The maximum value of Value for the current repair operation.
2137 For example, a driver that wants to specify progress in
2138 percent would use a Limit value of 100.
2139
2140 @retval EFI_SUCCESS The progress of a repair operation is reported successfully.
2141
2142 **/
2143 EFI_STATUS
2144 EFIAPI
2145 RepairNotify (
2146 IN UINTN Value,
2147 IN UINTN Limit
2148 )
2149 {
2150 UINTN Percent;
2151
2152 if (Limit == 0) {
2153 Print(L"Repair Progress Undefined\n\r");
2154 } else {
2155 Percent = Value * 100 / Limit;
2156 Print(L"Repair Progress = %3d%%\n\r", Percent);
2157 }
2158 return EFI_SUCCESS;
2159 }
2160
2161 /**
2162 Processes a set of messages returned by the GetHealthStatus ()
2163 service of the EFI Driver Health Protocol
2164
2165 @param MessageList The MessageList point to messages need to processed.
2166
2167 **/
2168 VOID
2169 ProcessMessages (
2170 IN EFI_DRIVER_HEALTH_HII_MESSAGE *MessageList
2171 )
2172 {
2173 UINTN MessageIndex;
2174 EFI_STRING MessageString;
2175
2176 for (MessageIndex = 0;
2177 MessageList[MessageIndex].HiiHandle != NULL;
2178 MessageIndex++) {
2179
2180 MessageString = HiiGetString (
2181 MessageList[MessageIndex].HiiHandle,
2182 MessageList[MessageIndex].StringId,
2183 NULL
2184 );
2185 if (MessageString != NULL) {
2186 //
2187 // User can customize the output. Just simply print out the MessageString like below.
2188 // Also can use the HiiHandle to display message on the front page.
2189 //
2190 // Print(L"%s\n",MessageString);
2191 // gBS->Stall (100000);
2192 }
2193 }
2194
2195 }
2196
2197 /**
2198 Repair the whole platform.
2199
2200 This function is the main entry for user choose "Repair All" in the front page.
2201 It will try to do recovery job till all the driver health protocol installed modules
2202 reach a terminal state.
2203
2204 @param DriverHealthList A Pointer to the list contain all of the platform driver health
2205 information.
2206
2207 **/
2208 VOID
2209 PlatformRepairAll (
2210 IN LIST_ENTRY *DriverHealthList
2211 )
2212 {
2213 DRIVER_HEALTH_INFO *DriverHealthInfo;
2214 LIST_ENTRY *Link;
2215 BOOLEAN RebootRequired;
2216
2217 ASSERT (DriverHealthList != NULL);
2218
2219 RebootRequired = FALSE;
2220
2221 for ( Link = GetFirstNode (DriverHealthList)
2222 ; !IsNull (DriverHealthList, Link)
2223 ; Link = GetNextNode (DriverHealthList, Link)
2224 ) {
2225 DriverHealthInfo = DEVICE_MANAGER_HEALTH_INFO_FROM_LINK (Link);
2226 //
2227 // Do driver health status operation by each link node
2228 //
2229 ASSERT (DriverHealthInfo != NULL);
2230
2231 ProcessSingleControllerHealth (
2232 DriverHealthInfo->DriverHealth,
2233 DriverHealthInfo->ControllerHandle,
2234 DriverHealthInfo->ChildHandle,
2235 DriverHealthInfo->HealthStatus,
2236 &(DriverHealthInfo->MessageList),
2237 DriverHealthInfo->HiiHandle,
2238 &RebootRequired
2239 );
2240 }
2241
2242 if (RebootRequired) {
2243 gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);
2244 }
2245 }
2246
2247 /**
2248
2249 Select the best matching language according to front page policy for best user experience.
2250
2251 This function supports both ISO 639-2 and RFC 4646 language codes, but language
2252 code types may not be mixed in a single call to this function.
2253
2254 @param SupportedLanguages A pointer to a Null-terminated ASCII string that
2255 contains a set of language codes in the format
2256 specified by Iso639Language.
2257 @param Iso639Language If TRUE, then all language codes are assumed to be
2258 in ISO 639-2 format. If FALSE, then all language
2259 codes are assumed to be in RFC 4646 language format.
2260
2261 @retval NULL The best matching language could not be found in SupportedLanguages.
2262 @retval NULL There are not enough resources available to return the best matching
2263 language.
2264 @retval Other A pointer to a Null-terminated ASCII string that is the best matching
2265 language in SupportedLanguages.
2266 **/
2267 CHAR8 *
2268 DriverHealthSelectBestLanguage (
2269 IN CHAR8 *SupportedLanguages,
2270 IN BOOLEAN Iso639Language
2271 )
2272 {
2273 CHAR8 *LanguageVariable;
2274 CHAR8 *BestLanguage;
2275
2276 GetEfiGlobalVariable2 (Iso639Language ? L"Lang" : L"PlatformLang", (VOID**)&LanguageVariable, NULL);
2277
2278 BestLanguage = GetBestLanguage(
2279 SupportedLanguages,
2280 Iso639Language,
2281 (LanguageVariable != NULL) ? LanguageVariable : "",
2282 Iso639Language ? "eng" : "en-US",
2283 NULL
2284 );
2285 if (LanguageVariable != NULL) {
2286 FreePool (LanguageVariable);
2287 }
2288
2289 return BestLanguage;
2290 }
2291
2292
2293
2294 /**
2295
2296 This is an internal worker function to get the Component Name (2) protocol interface
2297 and the language it supports.
2298
2299 @param ProtocolGuid A pointer to an EFI_GUID. It points to Component Name (2) protocol GUID.
2300 @param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
2301 @param ComponentName A pointer to the Component Name (2) protocol interface.
2302 @param SupportedLanguage The best suitable language that matches the SupportedLangues interface for the
2303 located Component Name (2) instance.
2304
2305 @retval EFI_SUCCESS The Component Name (2) protocol instance is successfully located and we find
2306 the best matching language it support.
2307 @retval EFI_UNSUPPORTED The input Language is not supported by the Component Name (2) protocol.
2308 @retval Other Some error occurs when locating Component Name (2) protocol instance or finding
2309 the supported language.
2310
2311 **/
2312 EFI_STATUS
2313 GetComponentNameWorker (
2314 IN EFI_GUID *ProtocolGuid,
2315 IN EFI_HANDLE DriverBindingHandle,
2316 OUT EFI_COMPONENT_NAME_PROTOCOL **ComponentName,
2317 OUT CHAR8 **SupportedLanguage
2318 )
2319 {
2320 EFI_STATUS Status;
2321
2322 //
2323 // Locate Component Name (2) protocol on the driver binging handle.
2324 //
2325 Status = gBS->OpenProtocol (
2326 DriverBindingHandle,
2327 ProtocolGuid,
2328 (VOID **) ComponentName,
2329 NULL,
2330 NULL,
2331 EFI_OPEN_PROTOCOL_GET_PROTOCOL
2332 );
2333 if (EFI_ERROR (Status)) {
2334 return Status;
2335 }
2336
2337 //
2338 // Apply shell policy to select the best language.
2339 //
2340 *SupportedLanguage = DriverHealthSelectBestLanguage (
2341 (*ComponentName)->SupportedLanguages,
2342 (BOOLEAN) (ProtocolGuid == &gEfiComponentNameProtocolGuid)
2343 );
2344 if (*SupportedLanguage == NULL) {
2345 Status = EFI_UNSUPPORTED;
2346 }
2347
2348 return Status;
2349 }
2350
2351 /**
2352
2353 This is an internal worker function to get driver name from Component Name (2) protocol interface.
2354
2355
2356 @param ProtocolGuid A pointer to an EFI_GUID. It points to Component Name (2) protocol GUID.
2357 @param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
2358 @param DriverName A pointer to the Unicode string to return. This Unicode string is the name
2359 of the driver specified by This.
2360
2361 @retval EFI_SUCCESS The driver name is successfully retrieved from Component Name (2) protocol
2362 interface.
2363 @retval Other The driver name cannot be retrieved from Component Name (2) protocol
2364 interface.
2365
2366 **/
2367 EFI_STATUS
2368 GetDriverNameWorker (
2369 IN EFI_GUID *ProtocolGuid,
2370 IN EFI_HANDLE DriverBindingHandle,
2371 OUT CHAR16 **DriverName
2372 )
2373 {
2374 EFI_STATUS Status;
2375 CHAR8 *BestLanguage;
2376 EFI_COMPONENT_NAME_PROTOCOL *ComponentName;
2377
2378 //
2379 // Retrieve Component Name (2) protocol instance on the driver binding handle and
2380 // find the best language this instance supports.
2381 //
2382 Status = GetComponentNameWorker (
2383 ProtocolGuid,
2384 DriverBindingHandle,
2385 &ComponentName,
2386 &BestLanguage
2387 );
2388 if (EFI_ERROR (Status)) {
2389 return Status;
2390 }
2391
2392 //
2393 // Get the driver name from Component Name (2) protocol instance on the driver binging handle.
2394 //
2395 Status = ComponentName->GetDriverName (
2396 ComponentName,
2397 BestLanguage,
2398 DriverName
2399 );
2400 FreePool (BestLanguage);
2401
2402 return Status;
2403 }
2404
2405 /**
2406
2407 This function gets driver name from Component Name 2 protocol interface and Component Name protocol interface
2408 in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the driver name.
2409 If the attempt fails, it then gets the driver name from EFI 1.1 Component Name protocol for backward
2410 compatibility support.
2411
2412 @param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
2413 @param DriverName A pointer to the Unicode string to return. This Unicode string is the name
2414 of the driver specified by This.
2415
2416 @retval EFI_SUCCESS The driver name is successfully retrieved from Component Name (2) protocol
2417 interface.
2418 @retval Other The driver name cannot be retrieved from Component Name (2) protocol
2419 interface.
2420
2421 **/
2422 EFI_STATUS
2423 DriverHealthGetDriverName (
2424 IN EFI_HANDLE DriverBindingHandle,
2425 OUT CHAR16 **DriverName
2426 )
2427 {
2428 EFI_STATUS Status;
2429
2430 //
2431 // Get driver name from UEFI 2.0 Component Name 2 protocol interface.
2432 //
2433 Status = GetDriverNameWorker (&gEfiComponentName2ProtocolGuid, DriverBindingHandle, DriverName);
2434 if (EFI_ERROR (Status)) {
2435 //
2436 // If it fails to get the driver name from Component Name protocol interface, we should fall back on
2437 // EFI 1.1 Component Name protocol interface.
2438 //
2439 Status = GetDriverNameWorker (&gEfiComponentNameProtocolGuid, DriverBindingHandle, DriverName);
2440 }
2441
2442 return Status;
2443 }
2444
2445
2446
2447 /**
2448 This function gets controller name from Component Name 2 protocol interface and Component Name protocol interface
2449 in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the controller name.
2450 If the attempt fails, it then gets the controller name from EFI 1.1 Component Name protocol for backward
2451 compatibility support.
2452
2453 @param ProtocolGuid A pointer to an EFI_GUID. It points to Component Name (2) protocol GUID.
2454 @param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
2455 @param ControllerHandle The handle of a controller that the driver specified by This is managing.
2456 This handle specifies the controller whose name is to be returned.
2457 @param ChildHandle The handle of the child controller to retrieve the name of. This is an
2458 optional parameter that may be NULL. It will be NULL for device drivers.
2459 It will also be NULL for bus drivers that attempt to retrieve the name
2460 of the bus controller. It will not be NULL for a bus driver that attempts
2461 to retrieve the name of a child controller.
2462 @param ControllerName A pointer to the Unicode string to return. This Unicode string
2463 is the name of the controller specified by ControllerHandle and ChildHandle.
2464
2465 @retval EFI_SUCCESS The controller name is successfully retrieved from Component Name (2) protocol
2466 interface.
2467 @retval Other The controller name cannot be retrieved from Component Name (2) protocol.
2468
2469 **/
2470 EFI_STATUS
2471 GetControllerNameWorker (
2472 IN EFI_GUID *ProtocolGuid,
2473 IN EFI_HANDLE DriverBindingHandle,
2474 IN EFI_HANDLE ControllerHandle,
2475 IN EFI_HANDLE ChildHandle,
2476 OUT CHAR16 **ControllerName
2477 )
2478 {
2479 EFI_STATUS Status;
2480 CHAR8 *BestLanguage;
2481 EFI_COMPONENT_NAME_PROTOCOL *ComponentName;
2482
2483 //
2484 // Retrieve Component Name (2) protocol instance on the driver binding handle and
2485 // find the best language this instance supports.
2486 //
2487 Status = GetComponentNameWorker (
2488 ProtocolGuid,
2489 DriverBindingHandle,
2490 &ComponentName,
2491 &BestLanguage
2492 );
2493 if (EFI_ERROR (Status)) {
2494 return Status;
2495 }
2496
2497 //
2498 // Get the controller name from Component Name (2) protocol instance on the driver binging handle.
2499 //
2500 Status = ComponentName->GetControllerName (
2501 ComponentName,
2502 ControllerHandle,
2503 ChildHandle,
2504 BestLanguage,
2505 ControllerName
2506 );
2507 FreePool (BestLanguage);
2508
2509 return Status;
2510 }
2511
2512 /**
2513
2514 This function gets controller name from Component Name 2 protocol interface and Component Name protocol interface
2515 in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the controller name.
2516 If the attempt fails, it then gets the controller name from EFI 1.1 Component Name protocol for backward
2517 compatibility support.
2518
2519 @param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
2520 @param ControllerHandle The handle of a controller that the driver specified by This is managing.
2521 This handle specifies the controller whose name is to be returned.
2522 @param ChildHandle The handle of the child controller to retrieve the name of. This is an
2523 optional parameter that may be NULL. It will be NULL for device drivers.
2524 It will also be NULL for bus drivers that attempt to retrieve the name
2525 of the bus controller. It will not be NULL for a bus driver that attempts
2526 to retrieve the name of a child controller.
2527 @param ControllerName A pointer to the Unicode string to return. This Unicode string
2528 is the name of the controller specified by ControllerHandle and ChildHandle.
2529
2530 @retval EFI_SUCCESS The controller name is successfully retrieved from Component Name (2) protocol
2531 interface.
2532 @retval Other The controller name cannot be retrieved from Component Name (2) protocol.
2533
2534 **/
2535 EFI_STATUS
2536 DriverHealthGetControllerName (
2537 IN EFI_HANDLE DriverBindingHandle,
2538 IN EFI_HANDLE ControllerHandle,
2539 IN EFI_HANDLE ChildHandle,
2540 OUT CHAR16 **ControllerName
2541 )
2542 {
2543 EFI_STATUS Status;
2544
2545 //
2546 // Get controller name from UEFI 2.0 Component Name 2 protocol interface.
2547 //
2548 Status = GetControllerNameWorker (
2549 &gEfiComponentName2ProtocolGuid,
2550 DriverBindingHandle,
2551 ControllerHandle,
2552 ChildHandle,
2553 ControllerName
2554 );
2555 if (EFI_ERROR (Status)) {
2556 //
2557 // If it fails to get the controller name from Component Name protocol interface, we should fall back on
2558 // EFI 1.1 Component Name protocol interface.
2559 //
2560 Status = GetControllerNameWorker (
2561 &gEfiComponentNameProtocolGuid,
2562 DriverBindingHandle,
2563 ControllerHandle,
2564 ChildHandle,
2565 ControllerName
2566 );
2567 }
2568
2569 return Status;
2570 }
EFI Development Kit II mirror for PVE