1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
|
/** @file
The platform device manager reference implementation
Copyright (c) 2004 - 2010, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "DeviceManager.h"
DEVICE_MANAGER_CALLBACK_DATA gDeviceManagerPrivate = {
DEVICE_MANAGER_CALLBACK_DATA_SIGNATURE,
NULL,
NULL,
NULL,
NULL,
{
FakeExtractConfig,
FakeRouteConfig,
DeviceManagerCallback
},
{
FakeExtractConfig,
FakeRouteConfig,
DriverHealthCallback
}
};
EFI_GUID mDeviceManagerGuid = DEVICE_MANAGER_FORMSET_GUID;
EFI_GUID mDriverHealthGuid = DRIVER_HEALTH_FORMSET_GUID;
DEVICE_MANAGER_MENU_ITEM mDeviceManagerMenuItemTable[] = {
{ STRING_TOKEN (STR_DISK_DEVICE), EFI_DISK_DEVICE_CLASS },
{ STRING_TOKEN (STR_VIDEO_DEVICE), EFI_VIDEO_DEVICE_CLASS },
{ STRING_TOKEN (STR_NETWORK_DEVICE), EFI_NETWORK_DEVICE_CLASS },
{ STRING_TOKEN (STR_INPUT_DEVICE), EFI_INPUT_DEVICE_CLASS },
{ STRING_TOKEN (STR_ON_BOARD_DEVICE), EFI_ON_BOARD_DEVICE_CLASS },
{ STRING_TOKEN (STR_OTHER_DEVICE), EFI_OTHER_DEVICE_CLASS }
};
HII_VENDOR_DEVICE_PATH mDeviceManagerHiiVendorDevicePath = {
{
{
HARDWARE_DEVICE_PATH,
HW_VENDOR_DP,
{
(UINT8) (sizeof (VENDOR_DEVICE_PATH)),
(UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
}
},
//
// {102579A0-3686-466e-ACD8-80C087044F4A}
//
{ 0x102579a0, 0x3686, 0x466e, { 0xac, 0xd8, 0x80, 0xc0, 0x87, 0x4, 0x4f, 0x4a } }
},
{
END_DEVICE_PATH_TYPE,
END_ENTIRE_DEVICE_PATH_SUBTYPE,
{
(UINT8) (END_DEVICE_PATH_LENGTH),
(UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
}
}
};
HII_VENDOR_DEVICE_PATH mDriverHealthHiiVendorDevicePath = {
{
{
HARDWARE_DEVICE_PATH,
HW_VENDOR_DP,
{
(UINT8) (sizeof (VENDOR_DEVICE_PATH)),
(UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
}
},
//
// {D8F76651-1675-4986-BED4-3824B2F1F4C8}
//
{ 0xd8f76651, 0x1675, 0x4986, { 0xbe, 0xd4, 0x38, 0x24, 0xb2, 0xf1, 0xf4, 0xc8 } }
},
{
END_DEVICE_PATH_TYPE,
END_ENTIRE_DEVICE_PATH_SUBTYPE,
{
(UINT8) (END_DEVICE_PATH_LENGTH),
(UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
}
}
};
/**
This function is invoked if user selected a interactive opcode from Device Manager's
Formset. The decision by user is saved to gCallbackKey for later processing. If
user set VBIOS, the new value is saved to EFI variable.
@param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
@param Action Specifies the type of action taken by the browser.
@param QuestionId A unique value which is sent to the original exporting driver
so that it can identify the type of data to expect.
@param Type The type of value for the question.
@param Value A pointer to the data being sent to the original exporting driver.
@param ActionRequest On return, points to the action requested by the callback function.
@retval EFI_SUCCESS The callback successfully handled the action.
@retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.
**/
EFI_STATUS
EFIAPI
DeviceManagerCallback (
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
IN EFI_BROWSER_ACTION Action,
IN EFI_QUESTION_ID QuestionId,
IN UINT8 Type,
IN EFI_IFR_TYPE_VALUE *Value,
OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
)
{
if ((Value == NULL) || (ActionRequest == NULL)) {
return EFI_INVALID_PARAMETER;
}
gCallbackKey = QuestionId;
//
// Request to exit SendForm(), so as to switch to selected form
//
*ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
return EFI_SUCCESS;
}
/**
This function registers HII packages to HII database.
@retval EFI_SUCCESS HII packages for the Device Manager were registered successfully.
@retval EFI_OUT_OF_RESOURCES HII packages for the Device Manager failed to be registered.
**/
EFI_STATUS
InitializeDeviceManager (
VOID
)
{
EFI_STATUS Status;
//
// Install Device Path Protocol and Config Access protocol to driver handle
//
Status = gBS->InstallMultipleProtocolInterfaces (
&gDeviceManagerPrivate.DriverHandle,
&gEfiDevicePathProtocolGuid,
&mDeviceManagerHiiVendorDevicePath,
&gEfiHiiConfigAccessProtocolGuid,
&gDeviceManagerPrivate.ConfigAccess,
NULL
);
ASSERT_EFI_ERROR (Status);
Status = gBS->InstallMultipleProtocolInterfaces (
&gDeviceManagerPrivate.DriverHealthHandle,
&gEfiDevicePathProtocolGuid,
&mDriverHealthHiiVendorDevicePath,
&gEfiHiiConfigAccessProtocolGuid,
&gDeviceManagerPrivate.DriverHealthConfigAccess,
NULL
);
ASSERT_EFI_ERROR (Status);
//
// Publish our HII data
//
gDeviceManagerPrivate.HiiHandle = HiiAddPackages (
&mDeviceManagerGuid,
gDeviceManagerPrivate.DriverHandle,
DeviceManagerVfrBin,
BdsDxeStrings,
NULL
);
if (gDeviceManagerPrivate.HiiHandle == NULL) {
return EFI_OUT_OF_RESOURCES;
} else {
Status = EFI_SUCCESS;
}
//
// Publish Driver Health HII data
//
gDeviceManagerPrivate.DriverHealthHiiHandle = HiiAddPackages (
&mDeviceManagerGuid,
gDeviceManagerPrivate.DriverHealthHandle,
DriverHealthVfrBin,
BdsDxeStrings,
NULL
);
if (gDeviceManagerPrivate.DriverHealthHiiHandle == NULL) {
Status = EFI_OUT_OF_RESOURCES;
} else {
Status = EFI_SUCCESS;
}
return Status;
}
/**
Extract the displayed formset for given HII handle and class guid.
@param Handle The HII handle.
@param SetupClassGuid The class guid specifies which form set will be displayed.
@param FormSetTitle Formset title string.
@param FormSetHelp Formset help string.
@retval TRUE The formset for given HII handle will be displayed.
@return FALSE The formset for given HII handle will not be displayed.
**/
BOOLEAN
ExtractDisplayedHiiFormFromHiiHandle (
IN EFI_HII_HANDLE Handle,
IN EFI_GUID *SetupClassGuid,
OUT EFI_STRING_ID *FormSetTitle,
OUT EFI_STRING_ID *FormSetHelp
)
{
EFI_STATUS Status;
UINTN BufferSize;
EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;
UINT8 *Package;
UINT8 *OpCodeData;
UINT32 Offset;
UINT32 Offset2;
UINT32 PackageListLength;
EFI_HII_PACKAGE_HEADER PackageHeader;
EFI_GUID *ClassGuid;
UINT8 ClassGuidNum;
ASSERT (Handle != NULL);
ASSERT (SetupClassGuid != NULL);
ASSERT (FormSetTitle != NULL);
ASSERT (FormSetHelp != NULL);
*FormSetTitle = 0;
*FormSetHelp = 0;
ClassGuidNum = 0;
ClassGuid = NULL;
//
// Get HII PackageList
//
BufferSize = 0;
HiiPackageList = NULL;
Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, Handle, &BufferSize, HiiPackageList);
//
// Handle is a invalid handle. Check if Handle is corrupted.
//
ASSERT (Status != EFI_NOT_FOUND);
//
// The return status should always be EFI_BUFFER_TOO_SMALL as input buffer's size is 0.
//
ASSERT (Status == EFI_BUFFER_TOO_SMALL);
HiiPackageList = AllocatePool (BufferSize);
ASSERT (HiiPackageList != NULL);
Status = gHiiDatabase->ExportPackageLists (gHiiDatabase, Handle, &BufferSize, HiiPackageList);
if (EFI_ERROR (Status)) {
return FALSE;
}
//
// Get Form package from this HII package List
//
Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);
Offset2 = 0;
PackageListLength = ReadUnaligned32 (&HiiPackageList->PackageLength);
while (Offset < PackageListLength) {
Package = ((UINT8 *) HiiPackageList) + Offset;
CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));
if (PackageHeader.Type == EFI_HII_PACKAGE_FORMS) {
//
// Search FormSet Opcode in this Form Package
//
Offset2 = sizeof (EFI_HII_PACKAGE_HEADER);
while (Offset2 < PackageHeader.Length) {
OpCodeData = Package + Offset2;
if (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode == EFI_IFR_FORM_SET_OP) {
if (((EFI_IFR_OP_HEADER *) OpCodeData)->Length > OFFSET_OF (EFI_IFR_FORM_SET, Flags)) {
//
// Find FormSet OpCode
//
ClassGuidNum = ((EFI_IFR_FORM_SET *) OpCodeData)->Flags;
ClassGuid = (EFI_GUID *) (VOID *)(OpCodeData + sizeof (EFI_IFR_FORM_SET));
while (ClassGuidNum-- > 0) {
if (CompareGuid (SetupClassGuid, ClassGuid)) {
CopyMem (FormSetTitle, &((EFI_IFR_FORM_SET *) OpCodeData)->FormSetTitle, sizeof (EFI_STRING_ID));
CopyMem (FormSetHelp, &((EFI_IFR_FORM_SET *) OpCodeData)->Help, sizeof (EFI_STRING_ID));
FreePool (HiiPackageList);
return TRUE;
}
}
} else {
CopyMem (FormSetTitle, &((EFI_IFR_FORM_SET *) OpCodeData)->FormSetTitle, sizeof (EFI_STRING_ID));
CopyMem (FormSetHelp, &((EFI_IFR_FORM_SET *) OpCodeData)->Help, sizeof (EFI_STRING_ID));
FreePool (HiiPackageList);
return TRUE;
}
}
//
// Go to next opcode
//
Offset2 += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
}
}
//
// Go to next package
//
Offset += PackageHeader.Length;
}
FreePool (HiiPackageList);
return FALSE;
}
/**
Call the browser and display the device manager to allow user
to configure the platform.
This function create the dynamic content for device manager. It includes
section header for all class of devices, one-of opcode to set VBIOS.
@retval EFI_SUCCESS Operation is successful.
@return Other values if failed to clean up the dynamic content from HII
database.
**/
EFI_STATUS
CallDeviceManager (
VOID
)
{
EFI_STATUS Status;
UINTN Index;
EFI_STRING String;
EFI_STRING_ID Token;
EFI_STRING_ID TokenHelp;
EFI_HII_HANDLE *HiiHandles;
EFI_HII_HANDLE HiiHandle;
EFI_STRING_ID FormSetTitle;
EFI_STRING_ID FormSetHelp;
EFI_BROWSER_ACTION_REQUEST ActionRequest;
VOID *StartOpCodeHandle;
VOID *EndOpCodeHandle;
EFI_IFR_GUID_LABEL *StartLabel;
EFI_IFR_GUID_LABEL *EndLabel;
UINTN NumHandles;
EFI_HANDLE *DriverHealthHandles;
HiiHandles = NULL;
Status = EFI_SUCCESS;
gCallbackKey = 0;
NumHandles = 0;
DriverHealthHandles = NULL;
//
// Connect all prior to entering the platform setup menu.
//
if (!gConnectAllHappened) {
BdsLibConnectAllDriversToAllControllers ();
gConnectAllHappened = TRUE;
}
//
// Create Subtitle OpCodes
//
//
// Allocate space for creation of UpdateData Buffer
//
StartOpCodeHandle = HiiAllocateOpCodeHandle ();
ASSERT (StartOpCodeHandle != NULL);
EndOpCodeHandle = HiiAllocateOpCodeHandle ();
ASSERT (EndOpCodeHandle != NULL);
//
// Create Hii Extend Label OpCode as the start opcode
//
StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
StartLabel->Number = LABEL_DEVICES_LIST;
//
// Create Hii Extend Label OpCode as the end opcode
//
EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
EndLabel->Number = LABEL_END;
HiiCreateSubTitleOpCode (StartOpCodeHandle, STRING_TOKEN (STR_DEVICES_LIST), 0, 0, 1);
//
// Get all the Hii handles
//
HiiHandles = HiiGetHiiHandles (NULL);
ASSERT (HiiHandles != NULL);
HiiHandle = gDeviceManagerPrivate.HiiHandle;
//
// Search for formset of each class type
//
for (Index = 0; HiiHandles[Index] != NULL; Index++) {
if (!ExtractDisplayedHiiFormFromHiiHandle (HiiHandles[Index], &gEfiHiiPlatformSetupFormsetGuid, &FormSetTitle, &FormSetHelp)) {
continue;
}
String = HiiGetString (HiiHandles[Index], FormSetTitle, NULL);
if (String == NULL) {
String = HiiGetString (HiiHandle, STR_MISSING_STRING, NULL);
ASSERT (String != NULL);
}
Token = HiiSetString (HiiHandle, 0, String, NULL);
FreePool (String);
String = HiiGetString (HiiHandles[Index], FormSetHelp, NULL);
if (String == NULL) {
String = HiiGetString (HiiHandle, STR_MISSING_STRING, NULL);
ASSERT (String != NULL);
}
TokenHelp = HiiSetString (HiiHandle, 0, String, NULL);
FreePool (String);
HiiCreateActionOpCode (
StartOpCodeHandle,
(EFI_QUESTION_ID) (Index + DEVICE_KEY_OFFSET),
Token,
TokenHelp,
EFI_IFR_FLAG_CALLBACK,
0
);
}
//
// Add End Opcode for Subtitle
//
HiiCreateEndOpCode (StartOpCodeHandle);
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiDriverHealthProtocolGuid,
NULL,
&NumHandles,
&DriverHealthHandles
);
//
// If there are no drivers installed driver health protocol
//
if (NumHandles == 0) {
HiiSetString (HiiHandle, STRING_TOKEN (STR_DM_DRIVER_HEALTH_TITLE), GetStringById (STRING_TOKEN (STR_EMPTY_STRING)), NULL);
HiiSetString (HiiHandle, STRING_TOKEN (STR_DRIVER_HEALTH_ALL_HEALTHY), GetStringById (STRING_TOKEN (STR_EMPTY_STRING)), NULL);
} else {
//
// Check All Driver health status
//
if (!PlaformHealthStatusCheck ()) {
//
// At least one driver in the platform are not in healthy status
//
HiiSetString (HiiHandle, STRING_TOKEN (STR_DRIVER_HEALTH_ALL_HEALTHY), GetStringById (STRING_TOKEN (STR_DRIVER_NOT_HEALTH)), NULL);
} else {
//
// For the string of STR_DRIVER_HEALTH_ALL_HEALTHY previously has been updated and we need to update it while re-entry.
//
HiiSetString (HiiHandle, STRING_TOKEN (STR_DRIVER_HEALTH_ALL_HEALTHY), GetStringById (STRING_TOKEN (STR_DRIVER_HEALTH_ALL_HEALTHY)), NULL);
}
}
HiiUpdateForm (
HiiHandle,
&mDeviceManagerGuid,
DEVICE_MANAGER_FORM_ID,
StartOpCodeHandle,
EndOpCodeHandle
);
ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
Status = gFormBrowser2->SendForm (
gFormBrowser2,
&HiiHandle,
1,
&mDeviceManagerGuid,
0,
NULL,
&ActionRequest
);
if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
EnableResetRequired ();
}
//
// We will have returned from processing a callback - user either hit ESC to exit, or selected
// a target to display
//
if ((gCallbackKey != 0) && (gCallbackKey != DEVICE_MANAGER_KEY_DRIVER_HEALTH)) {
ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
Status = gFormBrowser2->SendForm (
gFormBrowser2,
&HiiHandles[gCallbackKey - DEVICE_KEY_OFFSET],
1,
NULL,
0,
NULL,
&ActionRequest
);
if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
EnableResetRequired ();
}
//
// Force return to Device Manager
//
gCallbackKey = FRONT_PAGE_KEY_DEVICE_MANAGER;
}
//
// Driver Health item chose.
//
if (gCallbackKey == DEVICE_MANAGER_KEY_DRIVER_HEALTH) {
CallDriverHealth ();
//
// Force return to Device Manager
//
gCallbackKey = FRONT_PAGE_KEY_DEVICE_MANAGER;
}
//
// Cleanup dynamic created strings in HII database by reinstall the packagelist
//
HiiRemovePackages (HiiHandle);
gDeviceManagerPrivate.HiiHandle = HiiAddPackages (
&mDeviceManagerGuid,
gDeviceManagerPrivate.DriverHandle,
DeviceManagerVfrBin,
BdsDxeStrings,
NULL
);
if (gDeviceManagerPrivate.HiiHandle == NULL) {
Status = EFI_OUT_OF_RESOURCES;
} else {
Status = EFI_SUCCESS;
}
HiiFreeOpCodeHandle (StartOpCodeHandle);
HiiFreeOpCodeHandle (EndOpCodeHandle);
FreePool (HiiHandles);
return Status;
}
/**
This function is invoked if user selected a interactive opcode from Driver Health's
Formset. The decision by user is saved to gCallbackKey for later processing.
@param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
@param Action Specifies the type of action taken by the browser.
@param QuestionId A unique value which is sent to the original exporting driver
so that it can identify the type of data to expect.
@param Type The type of value for the question.
@param Value A pointer to the data being sent to the original exporting driver.
@param ActionRequest On return, points to the action requested by the callback function.
@retval EFI_SUCCESS The callback successfully handled the action.
@retval EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.
**/
EFI_STATUS
EFIAPI
DriverHealthCallback (
IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
IN EFI_BROWSER_ACTION Action,
IN EFI_QUESTION_ID QuestionId,
IN UINT8 Type,
IN EFI_IFR_TYPE_VALUE *Value,
OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
)
{
if ((Value == NULL) || (ActionRequest == NULL)) {
return EFI_INVALID_PARAMETER;
}
gCallbackKey = QuestionId;
//
// Request to exit SendForm(), so as to switch to selected form
//
*ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
return EFI_SUCCESS;
}
/**
Collect and display the platform's driver health relative information, allow user to do interactive
operation while the platform is unhealthy.
This function display a form which divided into two parts. The one list all modules which has installed
driver health protocol. The list usually contain driver name, controller name, and it's health info.
While the driver name can't be retrieved, will use device path as backup. The other part of the form provide
a choice to the user to repair all platform.
**/
VOID
CallDriverHealth (
VOID
)
{
EFI_STATUS Status;
EFI_HII_HANDLE HiiHandle;
EFI_BROWSER_ACTION_REQUEST ActionRequest;
EFI_IFR_GUID_LABEL *StartLabel;
EFI_IFR_GUID_LABEL *StartLabelRepair;
EFI_IFR_GUID_LABEL *EndLabel;
EFI_IFR_GUID_LABEL *EndLabelRepair;
VOID *StartOpCodeHandle;
VOID *EndOpCodeHandle;
VOID *StartOpCodeHandleRepair;
VOID *EndOpCodeHandleRepair;
UINTN Index;
EFI_STRING_ID Token;
EFI_STRING_ID TokenHelp;
EFI_STRING String;
EFI_STRING TmpString;
EFI_STRING DriverName;
EFI_STRING ControllerName;
LIST_ENTRY DriverHealthList;
DRIVER_HEALTH_INFO *DriverHealthInfo;
LIST_ENTRY *Link;
EFI_DEVICE_PATH_PROTOCOL *DriverDevicePath;
UINTN Length;
HiiHandle = gDeviceManagerPrivate.DriverHealthHiiHandle;
Index = 0;
Length = 0;
DriverHealthInfo = NULL;
DriverDevicePath = NULL;
InitializeListHead (&DriverHealthList);
//
// Allocate space for creation of UpdateData Buffer
//
StartOpCodeHandle = HiiAllocateOpCodeHandle ();
ASSERT (StartOpCodeHandle != NULL);
EndOpCodeHandle = HiiAllocateOpCodeHandle ();
ASSERT (EndOpCodeHandle != NULL);
StartOpCodeHandleRepair = HiiAllocateOpCodeHandle ();
ASSERT (StartOpCodeHandleRepair != NULL);
EndOpCodeHandleRepair = HiiAllocateOpCodeHandle ();
ASSERT (EndOpCodeHandleRepair != NULL);
//
// Create Hii Extend Label OpCode as the start opcode
//
StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
StartLabel->Number = LABEL_DRIVER_HEALTH;
//
// Create Hii Extend Label OpCode as the start opcode
//
StartLabelRepair = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandleRepair, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
StartLabelRepair->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
StartLabelRepair->Number = LABEL_DRIVER_HEALTH_REAPIR_ALL;
//
// Create Hii Extend Label OpCode as the end opcode
//
EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
EndLabel->Number = LABEL_DRIVER_HEALTH_END;
//
// Create Hii Extend Label OpCode as the end opcode
//
EndLabelRepair = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandleRepair, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));
EndLabelRepair->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
EndLabelRepair->Number = LABEL_DRIVER_HEALTH_REAPIR_ALL_END;
HiiCreateSubTitleOpCode (StartOpCodeHandle, STRING_TOKEN (STR_DH_STATUS_LIST), 0, 0, 1);
Status = GetAllControllersHealthStatus (&DriverHealthList);
ASSERT (Status != EFI_OUT_OF_RESOURCES);
Link = GetFirstNode (&DriverHealthList);
while (!IsNull (&DriverHealthList, Link)) {
DriverHealthInfo = DEVICE_MANAGER_HEALTH_INFO_FROM_LINK (Link);
//
// Assume no line strings is longer than 512 bytes.
//
String = (EFI_STRING) AllocateZeroPool (0x200);
ASSERT (String != NULL);
Status = DriverHealthGetDriverName (DriverHealthInfo->DriverHandle, &DriverName);
if (EFI_ERROR (Status)) {
//
// Can not get the Driver name, so use the Device path
//
DriverDevicePath = DevicePathFromHandle (DriverHealthInfo->DriverHandle);
DriverName = DevicePathToStr (DriverDevicePath);
}
//
// Add the Driver name & Controller name into FormSetTitle string
//
StrnCat (String, DriverName, StrLen (DriverName));
Status = DriverHealthGetControllerName (
DriverHealthInfo->DriverHandle,
DriverHealthInfo->ControllerHandle,
DriverHealthInfo->ChildHandle,
&ControllerName
);
if (!EFI_ERROR (Status)) {
//
// Can not get the Controller name, just let it empty.
//
StrnCat (String, L" ", StrLen (L" "));
StrnCat (String, ControllerName, StrLen (ControllerName));
}
//
// Add the message of the Module itself provided after the string item.
//
if ((DriverHealthInfo->MessageList != NULL) && (DriverHealthInfo->MessageList->StringId != 0)) {
StrnCat (String, L" ", StrLen (L" "));
TmpString = HiiGetString (
DriverHealthInfo->MessageList->HiiHandle,
DriverHealthInfo->MessageList->StringId,
NULL
);
//
// Assert if can not retrieve the message string
//
ASSERT (TmpString != NULL);
StrnCat (String, TmpString, StrLen (TmpString));
FreePool (TmpString);
} else {
//
// Update the string will be displayed base on the driver's health status
//
switch(DriverHealthInfo->HealthStatus) {
case EfiDriverHealthStatusRepairRequired:
Length = StrLen (GetStringById (STRING_TOKEN (STR_REPAIR_REQUIRED)));
StrnCat (String, GetStringById (STRING_TOKEN (STR_REPAIR_REQUIRED)), Length);
break;
case EfiDriverHealthStatusConfigurationRequired:
Length = StrLen (GetStringById (STRING_TOKEN (STR_CONFIGURATION_REQUIRED)));
StrnCat (String, GetStringById (STRING_TOKEN (STR_CONFIGURATION_REQUIRED)), Length);
break;
case EfiDriverHealthStatusFailed:
Length = StrLen (GetStringById (STRING_TOKEN (STR_OPERATION_FAILED)));
StrnCat (String, GetStringById (STRING_TOKEN (STR_OPERATION_FAILED)), Length);
break;
case EfiDriverHealthStatusReconnectRequired:
Length = StrLen (GetStringById (STRING_TOKEN (STR_RECONNECT_REQUIRED)));
StrnCat (String, GetStringById (STRING_TOKEN (STR_RECONNECT_REQUIRED)), Length);
break;
case EfiDriverHealthStatusRebootRequired:
Length = StrLen (GetStringById (STRING_TOKEN (STR_REBOOT_REQUIRED)));
StrnCat (String, GetStringById (STRING_TOKEN (STR_REBOOT_REQUIRED)), Length);
break;
default:
Length = StrLen (GetStringById (STRING_TOKEN (STR_DRIVER_HEALTH_HEALTHY)));
StrnCat (String, GetStringById (STRING_TOKEN (STR_DRIVER_HEALTH_HEALTHY)), Length);
break;
}
}
Token = HiiSetString (HiiHandle, 0, String, NULL);
FreePool (String);
TokenHelp = HiiSetString (HiiHandle, 0, GetStringById( STRING_TOKEN (STR_DH_REPAIR_SINGLE_HELP)), NULL);
HiiCreateActionOpCode (
StartOpCodeHandle,
(EFI_QUESTION_ID) (Index + DRIVER_HEALTH_KEY_OFFSET),
Token,
TokenHelp,
EFI_IFR_FLAG_CALLBACK,
0
);
Index++;
Link = GetNextNode (&DriverHealthList, Link);
}
//
// Add End Opcode for Subtitle
//
HiiCreateEndOpCode (StartOpCodeHandle);
HiiCreateSubTitleOpCode (StartOpCodeHandleRepair, STRING_TOKEN (STR_DRIVER_HEALTH_REPAIR_ALL), 0, 0, 1);
TokenHelp = HiiSetString (HiiHandle, 0, GetStringById( STRING_TOKEN (STR_DH_REPAIR_ALL_HELP)), NULL);
if (PlaformHealthStatusCheck ()) {
//
// No action need to do for the platform
//
Token = HiiSetString (HiiHandle, 0, GetStringById( STRING_TOKEN (STR_DRIVER_HEALTH_ALL_HEALTHY)), NULL);
HiiCreateActionOpCode (
StartOpCodeHandleRepair,
0,
Token,
TokenHelp,
EFI_IFR_FLAG_READ_ONLY,
0
);
} else {
//
// Create ActionOpCode only while the platform need to do health related operation.
//
Token = HiiSetString (HiiHandle, 0, GetStringById( STRING_TOKEN (STR_DH_REPAIR_ALL_TITLE)), NULL);
HiiCreateActionOpCode (
StartOpCodeHandleRepair,
(EFI_QUESTION_ID) DRIVER_HEALTH_REPAIR_ALL_KEY,
Token,
TokenHelp,
EFI_IFR_FLAG_CALLBACK,
0
);
}
HiiCreateEndOpCode (StartOpCodeHandleRepair);
Status = HiiUpdateForm (
HiiHandle,
&mDriverHealthGuid,
DRIVER_HEALTH_FORM_ID,
StartOpCodeHandle,
EndOpCodeHandle
);
ASSERT (Status != EFI_NOT_FOUND);
ASSERT (Status != EFI_BUFFER_TOO_SMALL);
Status = HiiUpdateForm (
HiiHandle,
&mDriverHealthGuid,
DRIVER_HEALTH_FORM_ID,
StartOpCodeHandleRepair,
EndOpCodeHandleRepair
);
ASSERT (Status != EFI_NOT_FOUND);
ASSERT (Status != EFI_BUFFER_TOO_SMALL);
ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
Status = gFormBrowser2->SendForm (
gFormBrowser2,
&HiiHandle,
1,
&mDriverHealthGuid,
DRIVER_HEALTH_FORM_ID,
NULL,
&ActionRequest
);
if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
EnableResetRequired ();
}
//
// We will have returned from processing a callback - user either hit ESC to exit, or selected
// a target to display.
// Process the diver health status states here.
//
if (gCallbackKey >= DRIVER_HEALTH_KEY_OFFSET && gCallbackKey != DRIVER_HEALTH_REPAIR_ALL_KEY) {
ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
Link = GetFirstNode (&DriverHealthList);
Index = 0;
while (!IsNull (&DriverHealthList, Link)) {
//
// Got the item relative node in the List
//
if (Index == (gCallbackKey - DRIVER_HEALTH_KEY_OFFSET)) {
DriverHealthInfo = DEVICE_MANAGER_HEALTH_INFO_FROM_LINK (Link);
//
// Process the driver's healthy status for the specify module
//
ProcessSingleControllerHealth (
DriverHealthInfo->DriverHealth,
DriverHealthInfo->ControllerHandle,
DriverHealthInfo->ChildHandle,
DriverHealthInfo->HealthStatus,
&(DriverHealthInfo->MessageList),
DriverHealthInfo->HiiHandle
);
break;
}
Index++;
Link = GetNextNode (&DriverHealthList, Link);
}
if (ActionRequest == EFI_BROWSER_ACTION_REQUEST_RESET) {
EnableResetRequired ();
}
//
// Force return to the form of Driver Health in Device Manager
//
gCallbackKey = DRIVER_HEALTH_RETURN_KEY;
}
//
// Repair the whole platform
//
if (gCallbackKey == DRIVER_HEALTH_REPAIR_ALL_KEY) {
ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
PlatformRepairAll (&DriverHealthList);
gCallbackKey = DRIVER_HEALTH_RETURN_KEY;
}
//
// Cleanup dynamic created strings in HII database by reinstall the packagelist
//
HiiRemovePackages (HiiHandle);
gDeviceManagerPrivate.DriverHealthHiiHandle = HiiAddPackages (
&mDriverHealthGuid,
gDeviceManagerPrivate.DriverHealthHandle,
DriverHealthVfrBin,
BdsDxeStrings,
NULL
);
if (gDeviceManagerPrivate.DriverHealthHiiHandle == NULL) {
Status = EFI_OUT_OF_RESOURCES;
} else {
Status = EFI_SUCCESS;
}
//
// Free driver health info list
//
while (!IsListEmpty (&DriverHealthList)) {
Link = GetFirstNode(&DriverHealthList);
DriverHealthInfo = DEVICE_MANAGER_HEALTH_INFO_FROM_LINK (Link);
RemoveEntryList (Link);
if (DriverHealthInfo->MessageList != NULL) {
FreePool(DriverHealthInfo->MessageList);
FreePool (DriverHealthInfo);
}
}
HiiFreeOpCodeHandle (StartOpCodeHandle);
HiiFreeOpCodeHandle (EndOpCodeHandle);
HiiFreeOpCodeHandle (StartOpCodeHandleRepair);
HiiFreeOpCodeHandle (EndOpCodeHandleRepair);
if (gCallbackKey == DRIVER_HEALTH_RETURN_KEY) {
//
// Force return to Driver Health Form
//
gCallbackKey = DEVICE_MANAGER_KEY_DRIVER_HEALTH;
CallDriverHealth ();
}
}
/**
Check the Driver Health status of a single controller and try to process it if not healthy.
This function called by CheckAllControllersHealthStatus () function in order to process a specify
contoller's health state.
@param DriverHealthList A Pointer to the list contain all of the platform driver health information.
@param DriverHandle The handle of driver.
@param ControllerHandle The class guid specifies which form set will be displayed.
@param ChildHandle The handle of the child controller to retrieve the health
status on. This is an optional parameter that may be NULL.
@param DriverHealth A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.
@param HealthStatus The health status of the controller.
@retval EFI_INVALID_PARAMETER HealthStatus or DriverHealth is NULL.
@retval HealthStatus The Health status of specify controller.
@retval EFI_OUT_OF_RESOURCES The list of Driver Health Protocol handles can not be retrieved.
@retval EFI_NOT_FOUND No controller in the platform install Driver Health Protocol.
@retval EFI_SUCCESS The Health related operation has been taken successfully.
**/
EFI_STATUS
EFIAPI
GetSingleControllerHealthStatus (
IN OUT LIST_ENTRY *DriverHealthList,
IN EFI_HANDLE DriverHandle,
IN EFI_HANDLE ControllerHandle, OPTIONAL
IN EFI_HANDLE ChildHandle, OPTIONAL
IN EFI_DRIVER_HEALTH_PROTOCOL *DriverHealth,
IN EFI_DRIVER_HEALTH_STATUS *HealthStatus
)
{
EFI_STATUS Status;
EFI_DRIVER_HEALTH_HII_MESSAGE *MessageList;
EFI_HII_HANDLE FormHiiHandle;
DRIVER_HEALTH_INFO *DriverHealthInfo;
if (HealthStatus == NULL) {
//
// If HealthStatus is NULL, then return EFI_INVALID_PARAMETER
//
return EFI_INVALID_PARAMETER;
}
//
// Assume the HealthStatus is healthy
//
*HealthStatus = EfiDriverHealthStatusHealthy;
if (DriverHealth == NULL) {
//
// If DriverHealth is NULL, then return EFI_INVALID_PARAMETER
//
return EFI_INVALID_PARAMETER;
}
if (ControllerHandle == NULL) {
//
// If ControllerHandle is NULL, the return the cumulative health status of the driver
//
Status = DriverHealth->GetHealthStatus (DriverHealth, NULL, NULL, HealthStatus, NULL, NULL);
if (*HealthStatus == EfiDriverHealthStatusHealthy) {
//
// Add the driver health related information into the list
//
DriverHealthInfo = AllocateZeroPool (sizeof (DRIVER_HEALTH_INFO));
if (DriverHealthInfo == NULL) {
return EFI_OUT_OF_RESOURCES;
}
DriverHealthInfo->Signature = DEVICE_MANAGER_DRIVER_HEALTH_INFO_SIGNATURE;
DriverHealthInfo->DriverHandle = DriverHandle;
DriverHealthInfo->ControllerHandle = NULL;
DriverHealthInfo->ChildHandle = NULL;
DriverHealthInfo->HiiHandle = NULL;
DriverHealthInfo->DriverHealth = DriverHealth;
DriverHealthInfo->MessageList = NULL;
DriverHealthInfo->HealthStatus = *HealthStatus;
InsertTailList (DriverHealthList, &DriverHealthInfo->Link);
}
return Status;
}
MessageList = NULL;
FormHiiHandle = NULL;
//
// Collect the health status with the optional HII message list
//
Status = DriverHealth->GetHealthStatus (DriverHealth, ControllerHandle, ChildHandle, HealthStatus, &MessageList, &FormHiiHandle);
if (EFI_ERROR (Status)) {
//
// If the health status could not be retrieved, then return immediately
//
return Status;
}
//
// Add the driver health related information into the list
//
DriverHealthInfo = AllocateZeroPool (sizeof (DRIVER_HEALTH_INFO));
if (DriverHealthInfo == NULL) {
return EFI_OUT_OF_RESOURCES;
}
DriverHealthInfo->Signature = DEVICE_MANAGER_DRIVER_HEALTH_INFO_SIGNATURE;
DriverHealthInfo->DriverHandle = DriverHandle;
DriverHealthInfo->ControllerHandle = ControllerHandle;
DriverHealthInfo->ChildHandle = ChildHandle;
DriverHealthInfo->HiiHandle = FormHiiHandle;
DriverHealthInfo->DriverHealth = DriverHealth;
DriverHealthInfo->MessageList = MessageList;
DriverHealthInfo->HealthStatus = *HealthStatus;
InsertTailList (DriverHealthList, &DriverHealthInfo->Link);
return EFI_SUCCESS;
}
/**
Collects all the EFI Driver Health Protocols currently present in the EFI Handle Database,
and queries each EFI Driver Health Protocol to determine if one or more of the controllers
managed by each EFI Driver Health Protocol instance are not healthy.
@param DriverHealthList A Pointer to the list contain all of the platform driver health
information.
@retval EFI_NOT_FOUND No controller in the platform install Driver Health Protocol.
@retval EFI_SUCCESS All the controllers in the platform are healthy.
@retval EFI_OUT_OF_RESOURCES The list of Driver Health Protocol handles can not be retrieved.
**/
EFI_STATUS
GetAllControllersHealthStatus (
IN OUT LIST_ENTRY *DriverHealthList
)
{
EFI_STATUS Status;
UINTN NumHandles;
EFI_HANDLE *DriverHealthHandles;
EFI_DRIVER_HEALTH_PROTOCOL *DriverHealth;
EFI_DRIVER_HEALTH_STATUS HealthStatus;
UINTN DriverHealthIndex;
EFI_HANDLE *Handles;
UINTN HandleCount;
UINTN ControllerIndex;
UINTN ChildIndex;
//
// Initialize local variables
//
Handles = NULL;
DriverHealthHandles = NULL;
NumHandles = 0;
HandleCount = 0;
HealthStatus = EfiDriverHealthStatusHealthy;
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiDriverHealthProtocolGuid,
NULL,
&NumHandles,
&DriverHealthHandles
);
if (Status == EFI_NOT_FOUND || NumHandles == 0) {
//
// If there are no Driver Health Protocols handles, then return EFI_NOT_FOUND
//
return EFI_NOT_FOUND;
}
if (EFI_ERROR (Status) || DriverHealthHandles == NULL) {
//
// If the list of Driver Health Protocol handles can not be retrieved, then
// return EFI_OUT_OF_RESOURCES
//
return EFI_OUT_OF_RESOURCES;
}
//
// Check the health status of all controllers in the platform
// Start by looping through all the Driver Health Protocol handles in the handle database
//
for (DriverHealthIndex = 0; DriverHealthIndex < NumHandles; DriverHealthIndex++) {
//
// Skip NULL Driver Health Protocol handles
//
if (DriverHealthHandles[DriverHealthIndex] == NULL) {
continue;
}
//
// Retrieve the Driver Health Protocol from DriverHandle
//
Status = gBS->HandleProtocol (
DriverHealthHandles[DriverHealthIndex],
&gEfiDriverHealthProtocolGuid,
(VOID **)&DriverHealth
);
if (EFI_ERROR (Status)) {
//
// If the Driver Health Protocol can not be retrieved, then skip to the next
// Driver Health Protocol handle
//
continue;
}
//
// Check the health of all the controllers managed by a Driver Health Protocol handle
//
Status = GetSingleControllerHealthStatus (DriverHealthList, DriverHealthHandles[DriverHealthIndex], NULL, NULL, DriverHealth, &HealthStatus);
//
// If Status is an error code, then the health information could not be retrieved, so assume healthy
// and skip to the next Driver Health Protocol handle
//
if (EFI_ERROR (Status)) {
continue;
}
//
// If all the controllers managed by this Driver Health Protocol are healthy, then skip to the next
// Driver Health Protocol handle
//
if (HealthStatus == EfiDriverHealthStatusHealthy) {
continue;
}
//
// See if the list of all handles in the handle database has been retrieved
//
//
if (Handles == NULL) {
//
// Retrieve the list of all handles from the handle database
//
Status = gBS->LocateHandleBuffer (
AllHandles,
NULL,
NULL,
&HandleCount,
&Handles
);
if (EFI_ERROR (Status) || Handles == NULL) {
//
// If all the handles in the handle database can not be retrieved, then
// return EFI_OUT_OF_RESOURCES
//
Status = EFI_OUT_OF_RESOURCES;
goto Done;
}
}
//
// Loop through all the controller handles in the handle database
//
for (ControllerIndex = 0; ControllerIndex < HandleCount; ControllerIndex++) {
//
// Skip NULL controller handles
//
if (Handles[ControllerIndex] == NULL) {
continue;
}
Status = GetSingleControllerHealthStatus (DriverHealthList, DriverHealthHandles[DriverHealthIndex], Handles[ControllerIndex], NULL, DriverHealth, &HealthStatus);
if (EFI_ERROR (Status)) {
//
// If Status is an error code, then the health information could not be retrieved, so assume healthy
//
HealthStatus = EfiDriverHealthStatusHealthy;
}
//
// If CheckHealthSingleController() returned an error on a terminal state, then do not check the health of child controllers
//
if (EFI_ERROR (Status)) {
continue;
}
//
// Loop through all the child handles in the handle database
//
for (ChildIndex = 0; ChildIndex < HandleCount; ChildIndex++) {
//
// Skip NULL child handles
//
if (Handles[ChildIndex] == NULL) {
continue;
}
Status = GetSingleControllerHealthStatus (DriverHealthList, DriverHealthHandles[DriverHealthIndex], Handles[ControllerIndex], Handles[ChildIndex], DriverHealth, &HealthStatus);
if (EFI_ERROR (Status)) {
//
// If Status is an error code, then the health information could not be retrieved, so assume healthy
//
HealthStatus = EfiDriverHealthStatusHealthy;
}
//
// If CheckHealthSingleController() returned an error on a terminal state, then skip to the next child
//
if (EFI_ERROR (Status)) {
continue;
}
}
}
}
Status = EFI_SUCCESS;
Done:
if (Handles != NULL) {
gBS->FreePool (Handles);
}
if (DriverHealthHandles != NULL) {
gBS->FreePool (DriverHealthHandles);
}
return Status;
}
/**
Check the healthy status of the platform, this function will return immediately while found one driver
in the platform are not healthy.
@retval FALSE at least one driver in the platform are not healthy.
@retval TRUE No controller install Driver Health Protocol,
or all controllers in the platform are in healthy status.
**/
BOOLEAN
PlaformHealthStatusCheck (
VOID
)
{
EFI_DRIVER_HEALTH_STATUS HealthStatus;
EFI_STATUS Status;
UINTN Index;
UINTN NoHandles;
EFI_HANDLE *DriverHealthHandles;
EFI_DRIVER_HEALTH_PROTOCOL *DriverHealth;
BOOLEAN AllHealthy;
//
// Initialize local variables
//
DriverHealthHandles = NULL;
DriverHealth = NULL;
HealthStatus = EfiDriverHealthStatusHealthy;
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiDriverHealthProtocolGuid,
NULL,
&NoHandles,
&DriverHealthHandles
);
//
// There are no handles match the search for Driver Health Protocol has been installed.
//
if (Status == EFI_NOT_FOUND) {
return TRUE;
}
//
// Assume all modules are healthy.
//
AllHealthy = TRUE;
//
// Found one or more Handles.
//
if (!EFI_ERROR (Status)) {
for (Index = 0; Index < NoHandles; Index++) {
Status = gBS->HandleProtocol (
DriverHealthHandles[Index],
&gEfiDriverHealthProtocolGuid,
(VOID **) &DriverHealth
);
if (!EFI_ERROR (Status)) {
Status = DriverHealth->GetHealthStatus (
DriverHealth,
NULL,
NULL,
&HealthStatus,
NULL,
NULL
);
}
//
// Get the healthy status of the module
//
if (!EFI_ERROR (Status)) {
if (HealthStatus != EfiDriverHealthStatusHealthy) {
//
// Return immediately one driver's status not in healthy.
//
return FALSE;
}
}
}
}
return AllHealthy;
}
/**
Processes a single controller using the EFI Driver Health Protocol associated with
that controller. This algorithm continues to query the GetHealthStatus() service until
one of the legal terminal states of the EFI Driver Health Protocol is reached. This may
require the processing of HII Messages, HII Form, and invocation of repair operations.
@param DriverHealth A pointer to the EFI_DRIVER_HEALTH_PROTOCOL instance.
@param ControllerHandle The class guid specifies which form set will be displayed.
@param ChildHandle The handle of the child controller to retrieve the health
status on. This is an optional parameter that may be NULL.
@param HealthStatus The health status of the controller.
@param MessageList An array of warning or error messages associated
with the controller specified by ControllerHandle and
ChildHandle. This is an optional parameter that may be NULL.
@param FormHiiHandle The HII handle for an HII form associated with the
controller specified by ControllerHandle and ChildHandle.
**/
VOID
ProcessSingleControllerHealth (
IN EFI_DRIVER_HEALTH_PROTOCOL *DriverHealth,
IN EFI_HANDLE ControllerHandle, OPTIONAL
IN EFI_HANDLE ChildHandle, OPTIONAL
IN EFI_DRIVER_HEALTH_STATUS HealthStatus,
IN EFI_DRIVER_HEALTH_HII_MESSAGE **MessageList, OPTIONAL
IN EFI_HII_HANDLE FormHiiHandle
)
{
EFI_STATUS Status;
EFI_DRIVER_HEALTH_STATUS LocalHealthStatus;
LocalHealthStatus = HealthStatus;
//
// If the module need to be repaired or reconfiguration, will process it until
// reach a terminal status. The status from EfiDriverHealthStatusRepairRequired after repair
// will be in (Health, Failed, Configuration Required).
//
while( LocalHealthStatus == EfiDriverHealthStatusConfigurationRequired ||
LocalHealthStatus == EfiDriverHealthStatusRepairRequired) {
if (LocalHealthStatus == EfiDriverHealthStatusRepairRequired) {
Status = DriverHealth->Repair (
DriverHealth,
ControllerHandle,
ChildHandle,
(EFI_DRIVER_HEALTH_REPAIR_PROGRESS_NOTIFY) RepairNotify
);
}
//
// Via a form of the driver need to do configuration provided to process of status in
// EfiDriverHealthStatusConfigurationRequired. The status after configuration should be in
// (Healthy, Reboot Required, Failed, Reconnect Required, Repair Required).
//
if (LocalHealthStatus == EfiDriverHealthStatusConfigurationRequired) {
Status = gFormBrowser2->SendForm (
gFormBrowser2,
&FormHiiHandle,
1,
&gEfiHiiDriverHealthFormsetGuid,
0,
NULL,
NULL
);
ASSERT( !EFI_ERROR (Status));
}
Status = DriverHealth->GetHealthStatus (
DriverHealth,
ControllerHandle,
ChildHandle,
&LocalHealthStatus,
NULL,
&FormHiiHandle
);
ASSERT_EFI_ERROR (Status);
if (*MessageList != NULL) {
ProcessMessages (*MessageList);
}
}
//
// Health status in {Healthy, Failed} may also have Messages need to process
//
if (LocalHealthStatus == EfiDriverHealthStatusHealthy || LocalHealthStatus == EfiDriverHealthStatusFailed) {
if (*MessageList != NULL) {
ProcessMessages (*MessageList);
}
}
//
// Check for RebootRequired or ReconnectRequired
//
if (LocalHealthStatus == EfiDriverHealthStatusRebootRequired) {
gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);
}
//
// Do reconnect if need.
//
if (LocalHealthStatus == EfiDriverHealthStatusReconnectRequired) {
Status = gBS->DisconnectController (ControllerHandle, NULL, NULL);
if (EFI_ERROR (Status)) {
//
// Disconnect failed. Need to promote reconnect to a reboot.
//
gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);
}
gBS->ConnectController (ControllerHandle, NULL, NULL, TRUE);
}
}
/**
Platform specific notification function for controller repair operations.
If the driver for a controller support the Driver Health Protocol and the
current state of the controller is EfiDriverHealthStatusRepairRequired then
when the Repair() service of the Driver Health Protocol is called, this
platform specific notification function can display the progress of the repair
operation. Some platforms may choose to not display anything, other may choose
to show the percentage complete on text consoles, and other may choose to render
a progress bar on text and graphical consoles.
This function displays the percentage of the repair operation that has been
completed on text consoles. The percentage is Value / Limit * 100%.
@param Value Value in the range 0..Limit the the repair has completed..
@param Limit The maximum value of Value
**/
VOID
RepairNotify (
IN UINTN Value,
IN UINTN Limit
)
{
UINTN Percent;
if (Limit == 0) {
Print(L"Repair Progress Undefined\n\r");
} else {
Percent = Value * 100 / Limit;
Print(L"Repair Progress = %3d%%\n\r", Percent);
}
}
/**
Processes a set of messages returned by the GetHealthStatus ()
service of the EFI Driver Health Protocol
@param MessageList The MessageList point to messages need to processed.
**/
VOID
ProcessMessages (
IN EFI_DRIVER_HEALTH_HII_MESSAGE *MessageList
)
{
UINTN MessageIndex;
EFI_STRING MessageString;
for (MessageIndex = 0;
MessageList[MessageIndex].HiiHandle != NULL;
MessageIndex++) {
MessageString = HiiGetString (
MessageList[MessageIndex].HiiHandle,
MessageList[MessageIndex].StringId,
NULL
);
if (MessageString != NULL) {
//
// User can customize the output. Just simply print out the MessageString like below.
// Also can use the HiiHandle to display message on the front page.
//
// Print(L"%s\n",MessageString);
// gBS->Stall (100000);
}
}
}
/**
Repair the whole platform.
This function is the main entry for user choose "Repair All" in the front page.
It will try to do recovery job till all the driver health protocol installed modules
reach a terminal state.
@param DriverHealthList A Pointer to the list contain all of the platform driver health
information.
**/
VOID
PlatformRepairAll (
IN LIST_ENTRY *DriverHealthList
)
{
DRIVER_HEALTH_INFO *DriverHealthInfo;
LIST_ENTRY *Link;
ASSERT (DriverHealthList != NULL);
Link = GetFirstNode (DriverHealthList);
while (!IsNull (DriverHealthList, Link)) {
DriverHealthInfo = DEVICE_MANAGER_HEALTH_INFO_FROM_LINK (Link);
//
// Do driver health status operation by each link node
//
ASSERT (DriverHealthInfo != NULL);
ProcessSingleControllerHealth (
DriverHealthInfo->DriverHealth,
DriverHealthInfo->ControllerHandle,
DriverHealthInfo->ChildHandle,
DriverHealthInfo->HealthStatus,
&(DriverHealthInfo->MessageList),
DriverHealthInfo->HiiHandle
);
Link = GetNextNode (DriverHealthList, Link);
}
}
/**
Select the best matching language according to front page policy for best user experience.
This function supports both ISO 639-2 and RFC 4646 language codes, but language
code types may not be mixed in a single call to this function.
@param SupportedLanguages A pointer to a Null-terminated ASCII string that
contains a set of language codes in the format
specified by Iso639Language.
@param Iso639Language If TRUE, then all language codes are assumed to be
in ISO 639-2 format. If FALSE, then all language
codes are assumed to be in RFC 4646 language format.
@retval NULL The best matching language could not be found in SupportedLanguages.
@retval NULL There are not enough resources available to return the best matching
language.
@retval Other A pointer to a Null-terminated ASCII string that is the best matching
language in SupportedLanguages.
**/
CHAR8 *
DriverHealthSelectBestLanguage (
IN CHAR8 *SupportedLanguages,
IN BOOLEAN Iso639Language
)
{
CHAR8 *LanguageVariable;
CHAR8 *BestLanguage;
LanguageVariable = GetEfiGlobalVariable (Iso639Language ? L"Lang" : L"PlatformLang");
BestLanguage = GetBestLanguage(
SupportedLanguages,
Iso639Language,
(LanguageVariable != NULL) ? LanguageVariable : "",
Iso639Language ? "eng" : "en-US",
NULL
);
if (LanguageVariable != NULL) {
FreePool (LanguageVariable);
}
return BestLanguage;
}
/**
This is an internal worker function to get the Component Name (2) protocol interface
and the language it supports.
@param ProtocolGuid A pointer to an EFI_GUID. It points to Component Name (2) protocol GUID.
@param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
@param ComponentName A pointer to the Component Name (2) protocol interface.
@param SupportedLanguage The best suitable language that matches the SupportedLangues interface for the
located Component Name (2) instance.
@retval EFI_SUCCESS The Component Name (2) protocol instance is successfully located and we find
the best matching language it support.
@retval EFI_UNSUPPORTED The input Language is not supported by the Component Name (2) protocol.
@retval Other Some error occurs when locating Component Name (2) protocol instance or finding
the supported language.
**/
EFI_STATUS
GetComponentNameWorker (
IN EFI_GUID *ProtocolGuid,
IN EFI_HANDLE DriverBindingHandle,
OUT EFI_COMPONENT_NAME_PROTOCOL **ComponentName,
OUT CHAR8 **SupportedLanguage
)
{
EFI_STATUS Status;
//
// Locate Component Name (2) protocol on the driver binging handle.
//
Status = gBS->OpenProtocol (
DriverBindingHandle,
ProtocolGuid,
(VOID **) ComponentName,
NULL,
NULL,
EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Apply shell policy to select the best language.
//
*SupportedLanguage = DriverHealthSelectBestLanguage (
(*ComponentName)->SupportedLanguages,
(BOOLEAN) (ProtocolGuid == &gEfiComponentNameProtocolGuid)
);
if (*SupportedLanguage == NULL) {
Status = EFI_UNSUPPORTED;
}
return Status;
}
/**
This is an internal worker function to get driver name from Component Name (2) protocol interface.
@param ProtocolGuid A pointer to an EFI_GUID. It points to Component Name (2) protocol GUID.
@param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
@param DriverName A pointer to the Unicode string to return. This Unicode string is the name
of the driver specified by This.
@retval EFI_SUCCESS The driver name is successfully retrieved from Component Name (2) protocol
interface.
@retval Other The driver name cannot be retrieved from Component Name (2) protocol
interface.
**/
EFI_STATUS
GetDriverNameWorker (
IN EFI_GUID *ProtocolGuid,
IN EFI_HANDLE DriverBindingHandle,
OUT CHAR16 **DriverName
)
{
EFI_STATUS Status;
CHAR8 *BestLanguage;
EFI_COMPONENT_NAME_PROTOCOL *ComponentName;
//
// Retrieve Component Name (2) protocol instance on the driver binding handle and
// find the best language this instance supports.
//
Status = GetComponentNameWorker (
ProtocolGuid,
DriverBindingHandle,
&ComponentName,
&BestLanguage
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Get the driver name from Component Name (2) protocol instance on the driver binging handle.
//
Status = ComponentName->GetDriverName (
ComponentName,
BestLanguage,
DriverName
);
FreePool (BestLanguage);
return Status;
}
/**
This function gets driver name from Component Name 2 protocol interface and Component Name protocol interface
in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the driver name.
If the attempt fails, it then gets the driver name from EFI 1.1 Component Name protocol for backward
compatibility support.
@param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
@param DriverName A pointer to the Unicode string to return. This Unicode string is the name
of the driver specified by This.
@retval EFI_SUCCESS The driver name is successfully retrieved from Component Name (2) protocol
interface.
@retval Other The driver name cannot be retrieved from Component Name (2) protocol
interface.
**/
EFI_STATUS
DriverHealthGetDriverName (
IN EFI_HANDLE DriverBindingHandle,
OUT CHAR16 **DriverName
)
{
EFI_STATUS Status;
//
// Get driver name from UEFI 2.0 Component Name 2 protocol interface.
//
Status = GetDriverNameWorker (&gEfiComponentName2ProtocolGuid, DriverBindingHandle, DriverName);
if (EFI_ERROR (Status)) {
//
// If it fails to get the driver name from Component Name protocol interface, we should fall back on
// EFI 1.1 Component Name protocol interface.
//
Status = GetDriverNameWorker (&gEfiComponentNameProtocolGuid, DriverBindingHandle, DriverName);
}
return Status;
}
/**
This function gets controller name from Component Name 2 protocol interface and Component Name protocol interface
in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the controller name.
If the attempt fails, it then gets the controller name from EFI 1.1 Component Name protocol for backward
compatibility support.
@param ProtocolGuid A pointer to an EFI_GUID. It points to Component Name (2) protocol GUID.
@param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
@param ControllerHandle The handle of a controller that the driver specified by This is managing.
This handle specifies the controller whose name is to be returned.
@param ChildHandle The handle of the child controller to retrieve the name of. This is an
optional parameter that may be NULL. It will be NULL for device drivers.
It will also be NULL for bus drivers that attempt to retrieve the name
of the bus controller. It will not be NULL for a bus driver that attempts
to retrieve the name of a child controller.
@param ControllerName A pointer to the Unicode string to return. This Unicode string
is the name of the controller specified by ControllerHandle and ChildHandle.
@retval EFI_SUCCESS The controller name is successfully retrieved from Component Name (2) protocol
interface.
@retval Other The controller name cannot be retrieved from Component Name (2) protocol.
**/
EFI_STATUS
GetControllerNameWorker (
IN EFI_GUID *ProtocolGuid,
IN EFI_HANDLE DriverBindingHandle,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle,
OUT CHAR16 **ControllerName
)
{
EFI_STATUS Status;
CHAR8 *BestLanguage;
EFI_COMPONENT_NAME_PROTOCOL *ComponentName;
//
// Retrieve Component Name (2) protocol instance on the driver binding handle and
// find the best language this instance supports.
//
Status = GetComponentNameWorker (
ProtocolGuid,
DriverBindingHandle,
&ComponentName,
&BestLanguage
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Get the controller name from Component Name (2) protocol instance on the driver binging handle.
//
Status = ComponentName->GetControllerName (
ComponentName,
ControllerHandle,
ChildHandle,
BestLanguage,
ControllerName
);
FreePool (BestLanguage);
return Status;
}
/**
This function gets controller name from Component Name 2 protocol interface and Component Name protocol interface
in turn. It first tries UEFI 2.0 Component Name 2 protocol interface and try to get the controller name.
If the attempt fails, it then gets the controller name from EFI 1.1 Component Name protocol for backward
compatibility support.
@param DriverBindingHandle The handle on which the Component Name (2) protocol instance is retrieved.
@param ControllerHandle The handle of a controller that the driver specified by This is managing.
This handle specifies the controller whose name is to be returned.
@param ChildHandle The handle of the child controller to retrieve the name of. This is an
optional parameter that may be NULL. It will be NULL for device drivers.
It will also be NULL for bus drivers that attempt to retrieve the name
of the bus controller. It will not be NULL for a bus driver that attempts
to retrieve the name of a child controller.
@param ControllerName A pointer to the Unicode string to return. This Unicode string
is the name of the controller specified by ControllerHandle and ChildHandle.
@retval EFI_SUCCESS The controller name is successfully retrieved from Component Name (2) protocol
interface.
@retval Other The controller name cannot be retrieved from Component Name (2) protocol.
**/
EFI_STATUS
DriverHealthGetControllerName (
IN EFI_HANDLE DriverBindingHandle,
IN EFI_HANDLE ControllerHandle,
IN EFI_HANDLE ChildHandle,
OUT CHAR16 **ControllerName
)
{
EFI_STATUS Status;
//
// Get controller name from UEFI 2.0 Component Name 2 protocol interface.
//
Status = GetControllerNameWorker (
&gEfiComponentName2ProtocolGuid,
DriverBindingHandle,
ControllerHandle,
ChildHandle,
ControllerName
);
if (EFI_ERROR (Status)) {
//
// If it fails to get the controller name from Component Name protocol interface, we should fall back on
// EFI 1.1 Component Name protocol interface.
//
Status = GetControllerNameWorker (
&gEfiComponentNameProtocolGuid,
DriverBindingHandle,
ControllerHandle,
ChildHandle,
ControllerName
);
}
return Status;
}
|