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
|
/** @file
This file include all platform action which can be customized by IBV/OEM.
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that 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 "BdsPlatform.h"
#include <Guid/EventGroup.h>
#include <Protocol/DxeSmmReadyToLock.h>
#include <Protocol/FirmwareVolume2.h>
#include <Protocol/PciRootBridgeIo.h>
#include <Protocol/BlockIo.h>
#include <Protocol/PciIo.h>
#include <Library/IoLib.h>
#include <Library/PciLib.h>
#include <Guid/EventGroup.h>
#include <Library/Tcg2PhysicalPresenceLib.h>
#include <Library/HobLib.h>
#include <Protocol/UsbIo.h>
extern EFI_STATUS EfiBootManagerDispatchDeferredImages(VOID);
GLOBAL_REMOVE_IF_UNREFERENCED EFI_BOOT_MODE gBootMode;
BOOLEAN gPPRequireUIConfirm;
GLOBAL_REMOVE_IF_UNREFERENCED USB_CLASS_FORMAT_DEVICE_PATH gUsbClassKeyboardDevicePath = {
{
{
MESSAGING_DEVICE_PATH,
MSG_USB_CLASS_DP,
{
(UINT8) (sizeof (USB_CLASS_DEVICE_PATH)),
(UINT8) ((sizeof (USB_CLASS_DEVICE_PATH)) >> 8)
}
},
0xffff, // VendorId
0xffff, // ProductId
CLASS_HID, // DeviceClass
SUBCLASS_BOOT, // DeviceSubClass
PROTOCOL_KEYBOARD // DeviceProtocol
},
gEndEntire
};
//
// Internal shell mode
//
GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mShellModeColumn;
GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mShellModeRow;
GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mShellHorizontalResolution;
GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mShellVerticalResolution;
//
// BDS Platform Functions
//
BOOLEAN
IsMorBitSet (
VOID
)
{
UINTN MorControl;
EFI_STATUS Status;
UINTN DataSize;
//
// Check if the MOR bit is set.
//
DataSize = sizeof (MorControl);
Status = gRT->GetVariable (
MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME,
&gEfiMemoryOverwriteControlDataGuid,
NULL,
&DataSize,
&MorControl
);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_INFO, " PlatformBootMangerLib: gEfiMemoryOverwriteControlDataGuid doesn't exist!!***\n"));
MorControl = 0;
} else {
DEBUG ((DEBUG_INFO, " PlatformBootMangerLib: Get the gEfiMemoryOverwriteControlDataGuid = %x!!***\n", MorControl));
}
return (BOOLEAN) (MorControl & 0x01);
}
VOID
DumpDevicePath (
IN CHAR16 *Name,
IN EFI_DEVICE_PATH *DevicePath
)
{
CHAR16 *Str;
Str = ConvertDevicePathToText(DevicePath, TRUE, TRUE);
DEBUG ((DEBUG_INFO, "%s: %s\n", Name, Str));
if (Str != NULL) {
FreePool (Str);
}
}
/**
An empty function to pass error checking of CreateEventEx ().
This empty function ensures that EVT_NOTIFY_SIGNAL_ALL is error
checked correctly since it is now mapped into CreateEventEx() in UEFI 2.0.
@param Event Event whose notification function is being invoked.
@param Context The pointer to the notification function's context,
which is implementation-dependent.
**/
VOID
EFIAPI
InternalBdsEmptyCallbackFuntion (
IN EFI_EVENT Event,
IN VOID *Context
)
{
return;
}
VOID
ExitPmAuth (
VOID
)
{
EFI_HANDLE Handle;
EFI_STATUS Status;
EFI_EVENT EndOfDxeEvent;
DEBUG((DEBUG_INFO,"ExitPmAuth ()- Start\n"));
//
// Prepare S3 information, this MUST be done before ExitPmAuth/EndOfDxe
//
//
// Since PI1.2.1, we need signal EndOfDxe as ExitPmAuth
//
Status = gBS->CreateEventEx (
EVT_NOTIFY_SIGNAL,
TPL_CALLBACK,
InternalBdsEmptyCallbackFuntion,
NULL,
&gEfiEndOfDxeEventGroupGuid,
&EndOfDxeEvent
);
ASSERT_EFI_ERROR (Status);
gBS->SignalEvent (EndOfDxeEvent);
gBS->CloseEvent (EndOfDxeEvent);
DEBUG((DEBUG_INFO,"All EndOfDxe callbacks have returned successfully\n"));
//
// NOTE: We need install DxeSmmReadyToLock directly here because many boot script is added via ExitPmAuth/EndOfDxe callback.
// If we install them at same callback, these boot script will be rejected because BootScript Driver runs first to lock them done.
// So we seperate them to be 2 different events, ExitPmAuth is last chance to let platform add boot script. DxeSmmReadyToLock will
// make boot script save driver lock down the interface.
//
Handle = NULL;
Status = gBS->InstallProtocolInterface (
&Handle,
&gEfiDxeSmmReadyToLockProtocolGuid,
EFI_NATIVE_INTERFACE,
NULL
);
ASSERT_EFI_ERROR (Status);
DEBUG((DEBUG_INFO,"ExitPmAuth ()- End\n"));
}
VOID
ConnectRootBridge (
BOOLEAN Recursive
)
{
UINTN RootBridgeHandleCount;
EFI_HANDLE *RootBridgeHandleBuffer;
UINTN RootBridgeIndex;
RootBridgeHandleCount = 0;
gBS->LocateHandleBuffer (
ByProtocol,
&gEfiPciRootBridgeIoProtocolGuid,
NULL,
&RootBridgeHandleCount,
&RootBridgeHandleBuffer
);
for (RootBridgeIndex = 0; RootBridgeIndex < RootBridgeHandleCount; RootBridgeIndex++) {
gBS->ConnectController (RootBridgeHandleBuffer[RootBridgeIndex], NULL, NULL, Recursive);
}
}
/**
Return whether the device is trusted console.
@param Device The device to be tested.
@retval TRUE The device can be trusted.
@retval FALSE The device cannot be trusted.
**/
BOOLEAN
IsTrustedConsole (
IN CONSOLE_TYPE ConsoleType,
IN EFI_DEVICE_PATH_PROTOCOL *Device
)
{
VOID *TrustedConsoleDevicepath;
EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;
EFI_DEVICE_PATH_PROTOCOL *Instance;
UINTN Size;
EFI_DEVICE_PATH_PROTOCOL *ConsoleDevice;
if (Device == NULL) {
return FALSE;
}
ConsoleDevice = DuplicateDevicePath(Device);
switch (ConsoleType) {
case ConIn:
TrustedConsoleDevicepath = PcdGetPtr (PcdTrustedConsoleInputDevicePath);
break;
case ConOut:
//
// Check GOP and remove last node
//
TempDevicePath = ConsoleDevice;
while (!IsDevicePathEndType (TempDevicePath)) {
if (DevicePathType (TempDevicePath) == ACPI_DEVICE_PATH &&
DevicePathSubType (TempDevicePath) == ACPI_ADR_DP) {
SetDevicePathEndNode (TempDevicePath);
break;
}
TempDevicePath = NextDevicePathNode (TempDevicePath);
}
TrustedConsoleDevicepath = PcdGetPtr (PcdTrustedConsoleOutputDevicePath);
break;
default:
ASSERT(FALSE);
break;
}
TempDevicePath = TrustedConsoleDevicepath;
do {
Instance = GetNextDevicePathInstance (&TempDevicePath, &Size);
if (Instance == NULL) {
break;
}
if (CompareMem (ConsoleDevice, Instance, Size - END_DEVICE_PATH_LENGTH) == 0) {
FreePool (Instance);
FreePool (ConsoleDevice);
return TRUE;
}
FreePool (Instance);
} while (TempDevicePath != NULL);
FreePool (ConsoleDevice);
return FALSE;
}
BOOLEAN
IsUsbShortForm (
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath
)
{
if ((DevicePathType (DevicePath) == MESSAGING_DEVICE_PATH) &&
((DevicePathSubType (DevicePath) == MSG_USB_CLASS_DP) || (DevicePathSubType (DevicePath) == MSG_USB_WWID_DP)) ) {
return TRUE;
}
return FALSE;
}
/**
Connect the USB short form device path.
@param DevicePath USB short form device path
@retval EFI_SUCCESS Successfully connected the USB device
@retval EFI_NOT_FOUND Cannot connect the USB device
@retval EFI_INVALID_PARAMETER The device path is invalid.
**/
EFI_STATUS
ConnectUsbShortFormDevicePath (
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath
)
{
EFI_STATUS Status;
EFI_HANDLE *Handles;
UINTN HandleCount;
UINTN Index;
EFI_PCI_IO_PROTOCOL *PciIo;
UINT8 Class[3];
BOOLEAN AtLeastOneConnected;
//
// Check the passed in parameters
//
if (DevicePath == NULL) {
return EFI_INVALID_PARAMETER;
}
if (!IsUsbShortForm (DevicePath)) {
return EFI_INVALID_PARAMETER;
}
//
// Find the usb host controller firstly, then connect with the remaining device path
//
AtLeastOneConnected = FALSE;
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiPciIoProtocolGuid,
NULL,
&HandleCount,
&Handles
);
for (Index = 0; Index < HandleCount; Index++) {
Status = gBS->HandleProtocol (
Handles[Index],
&gEfiPciIoProtocolGuid,
(VOID **) &PciIo
);
if (!EFI_ERROR (Status)) {
//
// Check whether the Pci device is the wanted usb host controller
//
Status = PciIo->Pci.Read (PciIo, EfiPciIoWidthUint8, 0x09, 3, &Class);
if (!EFI_ERROR (Status) &&
((PCI_CLASS_SERIAL == Class[2]) && (PCI_CLASS_SERIAL_USB == Class[1]))
) {
Status = gBS->ConnectController (
Handles[Index],
NULL,
DevicePath,
FALSE
);
if (!EFI_ERROR(Status)) {
AtLeastOneConnected = TRUE;
}
}
}
}
return AtLeastOneConnected ? EFI_SUCCESS : EFI_NOT_FOUND;
}
/**
Update the ConIn variable with USB Keyboard device path,if its not already exists in ConIn
**/
VOID
EnumUsbKeyboard (
VOID
)
{
DEBUG ((DEBUG_INFO, "[EnumUsbKeyboard]\n"));
EfiBootManagerUpdateConsoleVariable (ConIn, (EFI_DEVICE_PATH_PROTOCOL *) &gUsbClassKeyboardDevicePath, NULL);
//
// Append Usb Keyboard short form DevicePath into "ConInDev"
//
EfiBootManagerUpdateConsoleVariable (ConInDev, (EFI_DEVICE_PATH_PROTOCOL *) &gUsbClassKeyboardDevicePath, NULL);
}
BOOLEAN
IsVgaHandle (
IN EFI_HANDLE Handle
)
{
EFI_PCI_IO_PROTOCOL *PciIo;
PCI_TYPE00 Pci;
EFI_STATUS Status;
Status = gBS->HandleProtocol (
Handle,
&gEfiPciIoProtocolGuid,
(VOID **)&PciIo
);
if (!EFI_ERROR (Status)) {
Status = PciIo->Pci.Read (
PciIo,
EfiPciIoWidthUint32,
0,
sizeof (Pci) / sizeof (UINT32),
&Pci
);
if (!EFI_ERROR (Status)) {
if (IS_PCI_VGA (&Pci) || IS_PCI_OLD_VGA (&Pci)) {
return TRUE;
}
}
}
return FALSE;
}
EFI_HANDLE
IsVideoController (
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath
)
{
EFI_DEVICE_PATH_PROTOCOL *DupDevicePath;
EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;
EFI_STATUS Status;
EFI_HANDLE DeviceHandle;
DupDevicePath = DuplicateDevicePath (DevicePath);
ASSERT (DupDevicePath != NULL);
if (DupDevicePath == NULL) {
return NULL;
}
TempDevicePath = DupDevicePath;
Status = gBS->LocateDevicePath (
&gEfiDevicePathProtocolGuid,
&TempDevicePath,
&DeviceHandle
);
FreePool (DupDevicePath);
if (EFI_ERROR (Status)) {
return NULL;
}
if (IsVgaHandle (DeviceHandle)) {
return DeviceHandle;
} else {
return NULL;
}
}
BOOLEAN
IsGopDevicePath (
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath
)
{
while (!IsDevicePathEndType (DevicePath)) {
if (DevicePathType (DevicePath) == ACPI_DEVICE_PATH &&
DevicePathSubType (DevicePath) == ACPI_ADR_DP) {
return TRUE;
}
DevicePath = NextDevicePathNode (DevicePath);
}
return FALSE;
}
/**
Remove all GOP device path instance from DevicePath and add the Gop to the DevicePath.
**/
EFI_DEVICE_PATH_PROTOCOL *
UpdateGopDevicePath (
EFI_DEVICE_PATH_PROTOCOL *DevicePath,
EFI_DEVICE_PATH_PROTOCOL *Gop
)
{
UINTN Size;
UINTN GopSize;
EFI_DEVICE_PATH_PROTOCOL *Temp;
EFI_DEVICE_PATH_PROTOCOL *Return;
EFI_DEVICE_PATH_PROTOCOL *Instance;
BOOLEAN Exist;
Exist = FALSE;
Return = NULL;
GopSize = GetDevicePathSize (Gop);
do {
Instance = GetNextDevicePathInstance (&DevicePath, &Size);
if (Instance == NULL) {
break;
}
if (!IsGopDevicePath (Instance) ||
(Size == GopSize && CompareMem (Instance, Gop, GopSize) == 0)
) {
if (Size == GopSize && CompareMem (Instance, Gop, GopSize) == 0) {
Exist = TRUE;
}
Temp = Return;
Return = AppendDevicePathInstance (Return, Instance);
if (Temp != NULL) {
FreePool (Temp);
}
}
FreePool (Instance);
} while (DevicePath != NULL);
if (!Exist) {
Temp = Return;
Return = AppendDevicePathInstance (Return, Gop);
if (Temp != NULL) {
FreePool (Temp);
}
}
return Return;
}
/**
Get Graphics Controller Handle.
@retval GraphicsController Successfully located
@retval NULL Failed to locate
**/
EFI_HANDLE
EFIAPI
GetGraphicsController (
IN BOOLEAN NeedTrustedConsole
)
{
EFI_STATUS Status;
UINTN Index;
EFI_HANDLE *PciHandles;
UINTN PciHandlesSize;
EFI_DEVICE_PATH_PROTOCOL *DevicePath;
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiPciIoProtocolGuid,
NULL,
&PciHandlesSize,
&PciHandles
);
if (EFI_ERROR (Status)) {
return NULL;
}
for (Index = 0; Index < PciHandlesSize; Index++) {
Status = gBS->HandleProtocol (
PciHandles[Index],
&gEfiDevicePathProtocolGuid,
(VOID **) &DevicePath
);
if (EFI_ERROR(Status)) {
continue;
}
if (!IsVgaHandle (PciHandles[Index])) {
continue;
}
if ((NeedTrustedConsole && IsTrustedConsole (ConOut, DevicePath)) ||
((!NeedTrustedConsole) && (!IsTrustedConsole (ConOut, DevicePath)))) {
return PciHandles[Index];
}
}
return NULL;
}
VOID
UpdateGraphicConOut (
IN BOOLEAN NeedTrustedConsole
)
{
EFI_HANDLE GraphicsControllerHandle;
EFI_DEVICE_PATH_PROTOCOL *GopDevicePath;
EFI_DEVICE_PATH_PROTOCOL *ConOutDevicePath;
EFI_DEVICE_PATH_PROTOCOL *UpdatedConOutDevicePath;
//
// Update ConOut variable
//
GraphicsControllerHandle = GetGraphicsController (NeedTrustedConsole);
if (GraphicsControllerHandle != NULL) {
//
// Connect the GOP driver
//
gBS->ConnectController (GraphicsControllerHandle, NULL, NULL, TRUE);
//
// Get the GOP device path
// NOTE: We may get a device path that contains Controller node in it.
//
GopDevicePath = EfiBootManagerGetGopDevicePath (GraphicsControllerHandle);
if (GopDevicePath != NULL) {
GetEfiGlobalVariable2 (L"ConOut", &ConOutDevicePath, NULL);
UpdatedConOutDevicePath = UpdateGopDevicePath (ConOutDevicePath, GopDevicePath);
if (ConOutDevicePath != NULL) {
FreePool (ConOutDevicePath);
}
FreePool (GopDevicePath);
gRT->SetVariable (
L"ConOut",
&gEfiGlobalVariableGuid,
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS,
GetDevicePathSize (UpdatedConOutDevicePath),
UpdatedConOutDevicePath
);
}
}
}
VOID
AddConsoleVariable (
IN CONSOLE_TYPE ConsoleType,
IN EFI_DEVICE_PATH *ConsoleDevicePath
)
{
EFI_DEVICE_PATH *TempDevicePath;
EFI_DEVICE_PATH *Instance;
UINTN Size;
EFI_HANDLE GraphicsControllerHandle;
EFI_DEVICE_PATH *GopDevicePath;
TempDevicePath = ConsoleDevicePath;
do {
Instance = GetNextDevicePathInstance (&TempDevicePath, &Size);
if (Instance == NULL) {
break;
}
switch (ConsoleType) {
case ConIn:
if (IsUsbShortForm (Instance)) {
//
// Append Usb Keyboard short form DevicePath into "ConInDev"
//
EfiBootManagerUpdateConsoleVariable (ConInDev, Instance, NULL);
}
EfiBootManagerUpdateConsoleVariable (ConsoleType, Instance, NULL);
break;
case ConOut:
GraphicsControllerHandle = IsVideoController (Instance);
if (GraphicsControllerHandle == NULL) {
EfiBootManagerUpdateConsoleVariable (ConsoleType, Instance, NULL);
} else {
//
// Connect the GOP driver
//
gBS->ConnectController (GraphicsControllerHandle, NULL, NULL, TRUE);
//
// Get the GOP device path
// NOTE: We may get a device path that contains Controller node in it.
//
GopDevicePath = EfiBootManagerGetGopDevicePath (GraphicsControllerHandle);
if (GopDevicePath != NULL) {
EfiBootManagerUpdateConsoleVariable (ConsoleType, GopDevicePath, NULL);
}
}
break;
default:
ASSERT(FALSE);
break;
}
FreePool (Instance);
} while (TempDevicePath != NULL);
}
/**
The function connects the trusted consoles.
**/
VOID
ConnectTrustedConsole (
VOID
)
{
EFI_DEVICE_PATH_PROTOCOL *Consoles;
EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;
EFI_DEVICE_PATH_PROTOCOL *Instance;
EFI_DEVICE_PATH_PROTOCOL *Next;
UINTN Size;
UINTN Index;
EFI_HANDLE Handle;
EFI_STATUS Status;
CHAR16 *ConsoleVar[] = {L"ConIn", L"ConOut"};
VOID *TrustedConsoleDevicepath;
TrustedConsoleDevicepath = PcdGetPtr (PcdTrustedConsoleInputDevicePath);
DumpDevicePath (L"TrustedConsoleIn", TrustedConsoleDevicepath);
TrustedConsoleDevicepath = PcdGetPtr (PcdTrustedConsoleOutputDevicePath);
DumpDevicePath (L"TrustedConsoleOut", TrustedConsoleDevicepath);
for (Index = 0; Index < sizeof (ConsoleVar) / sizeof (ConsoleVar[0]); Index++) {
GetEfiGlobalVariable2 (ConsoleVar[Index], &Consoles, NULL);
TempDevicePath = Consoles;
do {
Instance = GetNextDevicePathInstance (&TempDevicePath, &Size);
if (Instance == NULL) {
break;
}
if (IsTrustedConsole (Index, Instance)) {
if (IsUsbShortForm (Instance)) {
ConnectUsbShortFormDevicePath (Instance);
} else {
for (Next = Instance; !IsDevicePathEnd (Next); Next = NextDevicePathNode (Next)) {
if (DevicePathType (Next) == ACPI_DEVICE_PATH && DevicePathSubType (Next) == ACPI_ADR_DP) {
break;
} else if (DevicePathType (Next) == HARDWARE_DEVICE_PATH &&
DevicePathSubType (Next) == HW_CONTROLLER_DP &&
DevicePathType (NextDevicePathNode (Next)) == ACPI_DEVICE_PATH &&
DevicePathSubType (NextDevicePathNode (Next)) == ACPI_ADR_DP
) {
break;
}
}
if (!IsDevicePathEnd (Next)) {
SetDevicePathEndNode (Next);
Status = EfiBootManagerConnectDevicePath (Instance, &Handle);
if (!EFI_ERROR (Status)) {
gBS->ConnectController (Handle, NULL, NULL, TRUE);
}
} else {
EfiBootManagerConnectDevicePath (Instance, NULL);
}
}
}
FreePool (Instance);
} while (TempDevicePath != NULL);
if (Consoles != NULL) {
FreePool (Consoles);
}
}
}
/**
The function connects the trusted Storages.
**/
VOID
ConnectTrustedStorage (
VOID
)
{
VOID *TrustedStorageDevicepath;
EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;
EFI_DEVICE_PATH_PROTOCOL *Instance;
UINTN Size;
EFI_DEVICE_PATH_PROTOCOL *TempStorageDevicePath;
EFI_STATUS Status;
EFI_HANDLE DeviceHandle;
TrustedStorageDevicepath = PcdGetPtr (PcdTrustedStorageDevicePath);
DumpDevicePath (L"TrustedStorage", TrustedStorageDevicepath);
TempDevicePath = TrustedStorageDevicepath;
do {
Instance = GetNextDevicePathInstance (&TempDevicePath, &Size);
if (Instance == NULL) {
break;
}
EfiBootManagerConnectDevicePath (Instance, NULL);
TempStorageDevicePath = Instance;
Status = gBS->LocateDevicePath (
&gEfiDevicePathProtocolGuid,
&TempStorageDevicePath,
&DeviceHandle
);
if (!EFI_ERROR (Status)) {
gBS->ConnectController (DeviceHandle, NULL, NULL, FALSE);
}
FreePool (Instance);
} while (TempDevicePath != NULL);
}
/**
The function connects the trusted consoles and then call the PP processing library interface.
**/
VOID
ProcessTcgPp (
VOID
)
{
gPPRequireUIConfirm |= Tcg2PhysicalPresenceLibNeedUserConfirm();
if (gPPRequireUIConfirm) {
ConnectTrustedConsole ();
}
Tcg2PhysicalPresenceLibProcessRequest (NULL);
}
/**
The function connects the trusted storage to perform TPerReset.
**/
VOID
ProcessTcgMor (
VOID
)
{
if (IsMorBitSet ()) {
ConnectTrustedConsole();
ConnectTrustedStorage();
}
}
/**
Check if current BootCurrent variable is internal shell boot option.
@retval TRUE BootCurrent is internal shell.
@retval FALSE BootCurrent is not internal shell.
**/
BOOLEAN
BootCurrentIsInternalShell (
VOID
)
{
UINTN VarSize;
UINT16 BootCurrent;
CHAR16 BootOptionName[16];
UINT8 *BootOption;
UINT8 *Ptr;
BOOLEAN Result;
EFI_STATUS Status;
EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;
EFI_DEVICE_PATH_PROTOCOL *LastDeviceNode;
EFI_GUID *GuidPoint;
BootOption = NULL;
Result = FALSE;
//
// Get BootCurrent variable
//
VarSize = sizeof (UINT16);
Status = gRT->GetVariable (
L"BootCurrent",
&gEfiGlobalVariableGuid,
NULL,
&VarSize,
&BootCurrent
);
if (EFI_ERROR (Status)) {
return FALSE;
}
//
// Create boot option Bootxxxx from BootCurrent
//
UnicodeSPrint (BootOptionName, sizeof(BootOptionName), L"Boot%04X", BootCurrent);
GetEfiGlobalVariable2 (BootOptionName, (VOID **) &BootOption, &VarSize);
if (BootOption == NULL || VarSize == 0) {
return FALSE;
}
Ptr = BootOption;
Ptr += sizeof (UINT32);
Ptr += sizeof (UINT16);
Ptr += StrSize ((CHAR16 *) Ptr);
TempDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) Ptr;
LastDeviceNode = TempDevicePath;
while (!IsDevicePathEnd (TempDevicePath)) {
LastDeviceNode = TempDevicePath;
TempDevicePath = NextDevicePathNode (TempDevicePath);
}
GuidPoint = EfiGetNameGuidFromFwVolDevicePathNode (
(MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) LastDeviceNode
);
if ((GuidPoint != NULL) &&
((CompareGuid (GuidPoint, &gUefiShellFileGuid)))
) {
//
// if this option is internal shell, return TRUE
//
Result = TRUE;
}
if (BootOption != NULL) {
FreePool (BootOption);
BootOption = NULL;
}
return Result;
}
/**
This function will change video resolution and text mode
for internl shell when internal shell is launched.
@param None.
@retval EFI_SUCCESS Mode is changed successfully.
@retval Others Mode failed to changed.
**/
EFI_STATUS
EFIAPI
ChangeModeForInternalShell (
VOID
)
{
EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *SimpleTextOut;
UINTN SizeOfInfo;
EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
UINT32 MaxGopMode;
UINT32 MaxTextMode;
UINT32 ModeNumber;
UINTN HandleCount;
EFI_HANDLE *HandleBuffer;
EFI_STATUS Status;
UINTN Index;
UINTN CurrentColumn;
UINTN CurrentRow;
Status = gBS->HandleProtocol (
gST->ConsoleOutHandle,
&gEfiGraphicsOutputProtocolGuid,
(VOID**)&GraphicsOutput
);
if (EFI_ERROR (Status)) {
GraphicsOutput = NULL;
}
Status = gBS->HandleProtocol (
gST->ConsoleOutHandle,
&gEfiSimpleTextOutProtocolGuid,
(VOID**)&SimpleTextOut
);
if (EFI_ERROR (Status)) {
SimpleTextOut = NULL;
}
if ((GraphicsOutput == NULL) || (SimpleTextOut == NULL)) {
return EFI_UNSUPPORTED;
}
MaxGopMode = GraphicsOutput->Mode->MaxMode;
MaxTextMode = SimpleTextOut->Mode->MaxMode;
//
// 1. If current video resolution is same with new video resolution,
// video resolution need not be changed.
// 1.1. If current text mode is same with new text mode, text mode need not be change.
// 1.2. If current text mode is different with new text mode, text mode need be change to new text mode.
// 2. If current video resolution is different with new video resolution, we need restart whole console drivers.
//
for (ModeNumber = 0; ModeNumber < MaxGopMode; ModeNumber++) {
Status = GraphicsOutput->QueryMode (
GraphicsOutput,
ModeNumber,
&SizeOfInfo,
&Info
);
if (!EFI_ERROR (Status)) {
if ((Info->HorizontalResolution == mShellHorizontalResolution) &&
(Info->VerticalResolution == mShellVerticalResolution)) {
if ((GraphicsOutput->Mode->Info->HorizontalResolution == mShellHorizontalResolution) &&
(GraphicsOutput->Mode->Info->VerticalResolution == mShellVerticalResolution)) {
//
// If current video resolution is same with new resolution,
// then check if current text mode is same with new text mode.
//
Status = SimpleTextOut->QueryMode (SimpleTextOut, SimpleTextOut->Mode->Mode, &CurrentColumn, &CurrentRow);
ASSERT_EFI_ERROR (Status);
if (CurrentColumn == mShellModeColumn && CurrentRow == mShellModeRow) {
//
// Current text mode is same with new text mode, text mode need not be change.
//
FreePool (Info);
return EFI_SUCCESS;
} else {
//
// Current text mode is different with new text mode, text mode need be change to new text mode.
//
for (Index = 0; Index < MaxTextMode; Index++) {
Status = SimpleTextOut->QueryMode (SimpleTextOut, Index, &CurrentColumn, &CurrentRow);
if (!EFI_ERROR(Status)) {
if ((CurrentColumn == mShellModeColumn) && (CurrentRow == mShellModeRow)) {
//
// New text mode is supported, set it.
//
Status = SimpleTextOut->SetMode (SimpleTextOut, Index);
ASSERT_EFI_ERROR (Status);
//
// Update text mode PCD.
//
PcdSet32S (PcdConOutColumn, mShellModeColumn);
PcdSet32S (PcdConOutRow, mShellModeRow);
FreePool (Info);
return EFI_SUCCESS;
}
}
}
if (Index == MaxTextMode) {
//
// If new text mode is not supported, return error.
//
FreePool (Info);
return EFI_UNSUPPORTED;
}
}
} else {
FreePool (Info);
//
// If current video resolution is not same with the new one, set new video resolution.
// In this case, the driver which produces simple text out need be restarted.
//
Status = GraphicsOutput->SetMode (GraphicsOutput, ModeNumber);
if (!EFI_ERROR (Status)) {
//
// Set PCD to restart GraphicsConsole and Consplitter to change video resolution
// and produce new text mode based on new resolution.
//
PcdSet32S (PcdVideoHorizontalResolution, mShellHorizontalResolution);
PcdSet32S (PcdVideoVerticalResolution, mShellVerticalResolution);
PcdSet32S (PcdConOutColumn, mShellModeColumn);
PcdSet32S (PcdConOutRow, mShellModeRow);
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiSimpleTextOutProtocolGuid,
NULL,
&HandleCount,
&HandleBuffer
);
if (!EFI_ERROR (Status)) {
for (Index = 0; Index < HandleCount; Index++) {
gBS->DisconnectController (HandleBuffer[Index], NULL, NULL);
}
for (Index = 0; Index < HandleCount; Index++) {
gBS->ConnectController (HandleBuffer[Index], NULL, NULL, TRUE);
}
if (HandleBuffer != NULL) {
FreePool (HandleBuffer);
}
break;
}
}
}
}
FreePool (Info);
}
}
if (ModeNumber == MaxGopMode) {
//
// If the new resolution is not supported, return error.
//
return EFI_UNSUPPORTED;
}
return EFI_SUCCESS;
}
/**
ReadyToBoot callback to set video and text mode for internal shell boot.
That will not connect USB controller while CSM and FastBoot are disabled, we need to connect them
before booting to Shell for showing USB devices in Shell.
When FastBoot is enabled and Windows Console is the chosen Console behavior, input devices will not be connected
by default. Hence, when booting to EFI shell, connecting input consoles are required.
@param Event Pointer to this event
@param Context Event hanlder private data
@retval None.
**/
VOID
EFIAPI
OnReadyToBootCallBack (
IN EFI_EVENT Event,
IN VOID *Context
)
{
DEBUG ((EFI_D_INFO, "OnReadyToBootCallBack\n"));
if (BootCurrentIsInternalShell ()) {
ChangeModeForInternalShell ();
EfiBootManagerConnectAllDefaultConsoles();
gDS->Dispatch ();
}
}
/**
Platform Bds init. Incude the platform firmware vendor, revision
and so crc check.
**/
VOID
EFIAPI
PlatformBootManagerBeforeConsole (
VOID
)
{
EFI_STATUS Status;
EFI_DEVICE_PATH_PROTOCOL *VarConOut;
EFI_DEVICE_PATH_PROTOCOL *VarConIn;
EFI_EVENT Event;
DEBUG ((EFI_D_INFO, "PlatformBootManagerBeforeConsole\n"));
Status = EFI_SUCCESS;
//
// Get user defined text mode for internal shell only once.
//
mShellHorizontalResolution = PcdGet32 (PcdSetupVideoHorizontalResolution);
mShellVerticalResolution = PcdGet32 (PcdSetupVideoVerticalResolution);
mShellModeColumn = PcdGet32 (PcdSetupConOutColumn);
mShellModeRow = PcdGet32 (PcdSetupConOutRow);
//
// Create event to set proper video resolution and text mode for internal shell.
//
Status = EfiCreateEventReadyToBootEx (
TPL_CALLBACK,
OnReadyToBootCallBack,
NULL,
&Event
);
ASSERT_EFI_ERROR (Status);
//
// Connect Root Bridge to make PCI BAR resource allocated and all PciIo created
//
ConnectRootBridge (FALSE);
//
// Fill ConIn/ConOut in Full Configuration boot mode
//
DEBUG ((DEBUG_INFO, "PlatformBootManagerInit - %x\n", gBootMode));
if (gBootMode == BOOT_WITH_FULL_CONFIGURATION ||
gBootMode == BOOT_WITH_DEFAULT_SETTINGS ||
gBootMode == BOOT_WITH_FULL_CONFIGURATION_PLUS_DIAGNOSTICS ||
gBootMode == BOOT_IN_RECOVERY_MODE) {
GetEfiGlobalVariable2 (L"ConOut", &VarConOut, NULL); if (VarConOut != NULL) { FreePool (VarConOut); }
GetEfiGlobalVariable2 (L"ConIn", &VarConIn, NULL); if (VarConIn != NULL) { FreePool (VarConIn); }
//
// Only fill ConIn/ConOut when ConIn/ConOut is empty because we may drop to Full Configuration boot mode in non-first boot
//
if (VarConOut == NULL || VarConIn == NULL) {
if (PcdGetSize (PcdTrustedConsoleOutputDevicePath) >= sizeof(EFI_DEVICE_PATH_PROTOCOL)) {
AddConsoleVariable (ConOut, PcdGetPtr (PcdTrustedConsoleOutputDevicePath));
}
if (PcdGetSize (PcdTrustedConsoleInputDevicePath) >= sizeof(EFI_DEVICE_PATH_PROTOCOL)) {
AddConsoleVariable (ConIn, PcdGetPtr (PcdTrustedConsoleInputDevicePath));
}
}
}
EnumUsbKeyboard ();
//
// For trusted console it must be handled here.
//
UpdateGraphicConOut (TRUE);
//
// Dynamically register hot key: F2/F7/Enter
//
RegisterDefaultBootOption ();
RegisterStaticHotkey ();
PERF_START_EX(NULL,"EventRec", NULL, AsmReadTsc(), 0x7010);
if (PcdGetBool (PcdTpm2Enable)) {
ProcessTcgPp ();
ProcessTcgMor ();
}
PERF_END_EX(NULL,"EventRec", NULL, AsmReadTsc(), 0x7011);
//
// We should make all UEFI memory and GCD information populated before ExitPmAuth.
// SMM may consume these information.
//
MemoryTest((EXTENDMEM_COVERAGE_LEVEL) PcdGet32 (PcdPlatformMemoryCheckLevel));
PERF_START_EX(NULL,"EventRec", NULL, AsmReadTsc(), 0x7020);
ExitPmAuth ();
PERF_END_EX(NULL,"EventRec", NULL, AsmReadTsc(), 0x7021);
//
// Dispatch the deferred 3rd party images.
//
EfiBootManagerDispatchDeferredImages ();
//
// For non-trusted console it must be handled here.
//
UpdateGraphicConOut (FALSE);
}
/**
Connect with predeined platform connect sequence,
the OEM/IBV can customize with their own connect sequence.
@param[in] BootMode Boot mode of this boot.
**/
VOID
ConnectSequence (
IN EFI_BOOT_MODE BootMode
)
{
EfiBootManagerConnectAll ();
}
/**
The function is to consider the boot order which is not in our expectation.
In the case that we need to re-sort the boot option.
@retval TRUE Need to sort Boot Option.
@retval FALSE Don't need to sort Boot Option.
**/
BOOLEAN
IsNeedSortBootOption (
VOID
)
{
EFI_BOOT_MANAGER_LOAD_OPTION *BootOptions;
UINTN BootOptionCount;
BootOptions = EfiBootManagerGetLoadOptions (&BootOptionCount, LoadOptionTypeBoot);
//
// If setup is the first priority in boot option, we need to sort boot option.
//
if ((BootOptionCount > 1) &&
(((StrnCmp (BootOptions->Description, L"Enter Setup", StrLen (L"Enter Setup"))) == 0) ||
((StrnCmp (BootOptions->Description, L"BootManagerMenuApp", StrLen (L"BootManagerMenuApp"))) == 0))) {
return TRUE;
}
return FALSE;
}
/**
The function will excute with as the platform policy, current policy
is driven by boot mode. IBV/OEM can customize this code for their specific
policy action.
@param DriverOptionList - The header of the driver option link list
@param BootOptionList - The header of the boot option link list
@param ProcessCapsules - A pointer to ProcessCapsules()
@param BaseMemoryTest - A pointer to BaseMemoryTest()
**/
VOID
EFIAPI
PlatformBootManagerAfterConsole (
VOID
)
{
EFI_BOOT_MODE LocalBootMode;
DEBUG ((EFI_D_INFO, "PlatformBootManagerAfterConsole\n"));
//
// Get current Boot Mode
//
LocalBootMode = gBootMode;
DEBUG ((DEBUG_INFO, "Current local bootmode - %x\n", LocalBootMode));
//
// Go the different platform policy with different boot mode
// Notes: this part code can be change with the table policy
//
switch (LocalBootMode) {
case BOOT_ASSUMING_NO_CONFIGURATION_CHANGES:
case BOOT_WITH_MINIMAL_CONFIGURATION:
case BOOT_ON_S4_RESUME:
//
// Perform some platform specific connect sequence
//
PERF_START_EX(NULL,"EventRec", NULL, AsmReadTsc(), 0x7050);
ConnectSequence (LocalBootMode);
PERF_END_EX(NULL,"EventRec", NULL, AsmReadTsc(), 0x7051);
break;
case BOOT_WITH_FULL_CONFIGURATION:
case BOOT_WITH_FULL_CONFIGURATION_PLUS_DIAGNOSTICS:
case BOOT_WITH_DEFAULT_SETTINGS:
default:
//
// Perform some platform specific connect sequence
//
ConnectSequence (LocalBootMode);
//
// Only in Full Configuration boot mode we do the enumeration of boot device
//
//
// Dispatch all but Storage Oprom explicitly, because we assume Int13Thunk driver is there.
//
EfiBootManagerRefreshAllBootOption ();
if (IsNeedSortBootOption()) {
EfiBootManagerSortLoadOptionVariable (LoadOptionTypeBoot, CompareBootOption);
}
//
// PXE boot option may appear after boot option enumeration
//
break;
}
Print (L"Press F7 for BootMenu!\n");
EfiBootManagerRefreshAllBootOption ();
EfiBootManagerSortLoadOptionVariable (LoadOptionTypeBoot, CompareBootOption);
}
|