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
|
/** @file
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "LightMemoryTest.h"
//
// Global:
// Since this driver will only ever produce one instance of the memory test
// protocol, so we do not need to dynamically allocate the PrivateData.
//
EFI_PHYSICAL_ADDRESS mCurrentAddress;
LIST_ENTRY *mCurrentLink;
NONTESTED_MEMORY_RANGE *mCurrentRange;
UINT64 mTestedSystemMemory;
UINT64 mNonTestedSystemMemory;
UINT32 GenericMemoryTestMonoPattern[GENERIC_CACHELINE_SIZE / 4] = {
0x5a5a5a5a,
0xa5a5a5a5,
0x5a5a5a5a,
0xa5a5a5a5,
0x5a5a5a5a,
0xa5a5a5a5,
0x5a5a5a5a,
0xa5a5a5a5,
0x5a5a5a5a,
0xa5a5a5a5,
0x5a5a5a5a,
0xa5a5a5a5,
0x5a5a5a5a,
0xa5a5a5a5,
0x5a5a5a5a,
0xa5a5a5a5
};
/**
Compares the contents of two buffers.
This function compares Length bytes of SourceBuffer to Length bytes of DestinationBuffer.
If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
value returned is the first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
If Length = 0, then ASSERT().
@param[in] DestinationBuffer The pointer to the destination buffer to compare.
@param[in] SourceBuffer The pointer to the source buffer to compare.
@param[in] Length The number of bytes to compare.
@return 0 All Length bytes of the two buffers are identical.
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
mismatched byte in DestinationBuffer.
**/
INTN
EFIAPI
CompareMemWithoutCheckArgument (
IN CONST VOID *DestinationBuffer,
IN CONST VOID *SourceBuffer,
IN UINTN Length
)
{
ASSERT (Length > 0);
while ((--Length != 0) &&
(*(INT8*)DestinationBuffer == *(INT8*)SourceBuffer)) {
DestinationBuffer = (INT8*)DestinationBuffer + 1;
SourceBuffer = (INT8*)SourceBuffer + 1;
}
return (INTN)*(UINT8*)DestinationBuffer - (INTN)*(UINT8*)SourceBuffer;
}
/**
Construct the system base memory range through GCD service.
@param[in] Private Point to generic memory test driver's private data.
@retval EFI_SUCCESS Successful construct the base memory range through GCD service.
@retval EFI_OUT_OF_RESOURCE Could not allocate needed resource from base memory.
@retval Others Failed to construct base memory range through GCD service.
**/
EFI_STATUS
ConstructBaseMemoryRange (
IN GENERIC_MEMORY_TEST_PRIVATE *Private
)
{
UINTN NumberOfDescriptors;
EFI_GCD_MEMORY_SPACE_DESCRIPTOR *MemorySpaceMap;
UINTN Index;
//
// Base memory will always below 4G
//
gDS->GetMemorySpaceMap (&NumberOfDescriptors, &MemorySpaceMap);
for (Index = 0; Index < NumberOfDescriptors; Index++) {
if ((MemorySpaceMap[Index].GcdMemoryType == EfiGcdMemoryTypeSystemMemory) ||
(MemorySpaceMap[Index].GcdMemoryType == EfiGcdMemoryTypeMoreReliable)) {
Private->BaseMemorySize += MemorySpaceMap[Index].Length;
}
}
return EFI_SUCCESS;
}
/**
Destroy the link list base on the correspond link list type.
@param[in] Private Point to generic memory test driver's private data.
**/
VOID
DestroyLinkList (
IN GENERIC_MEMORY_TEST_PRIVATE *Private
)
{
LIST_ENTRY *Link;
NONTESTED_MEMORY_RANGE *NontestedRange;
Link = Private->NonTestedMemRanList.BackLink;
while (Link != &Private->NonTestedMemRanList) {
RemoveEntryList (Link);
NontestedRange = NONTESTED_MEMORY_RANGE_FROM_LINK (Link);
gBS->FreePool (NontestedRange);
Link = Private->NonTestedMemRanList.BackLink;;
}
}
/**
Convert the memory range to tested.
@param BaseAddress Base address of the memory range.
@param Length Length of the memory range.
@param Capabilities Capabilities of the memory range.
@retval EFI_SUCCESS The memory range is converted to tested.
@retval others Error happens.
**/
EFI_STATUS
ConvertToTestedMemory (
IN UINT64 BaseAddress,
IN UINT64 Length,
IN UINT64 Capabilities
)
{
EFI_STATUS Status;
Status = gDS->RemoveMemorySpace (
BaseAddress,
Length
);
if (!EFI_ERROR (Status)) {
Status = gDS->AddMemorySpace (
((Capabilities & EFI_MEMORY_MORE_RELIABLE) == EFI_MEMORY_MORE_RELIABLE) ?
EfiGcdMemoryTypeMoreReliable : EfiGcdMemoryTypeSystemMemory,
BaseAddress,
Length,
Capabilities &~
(EFI_MEMORY_PRESENT | EFI_MEMORY_INITIALIZED | EFI_MEMORY_TESTED | EFI_MEMORY_RUNTIME)
);
}
return Status;
}
/**
Add the extened memory to whole system memory map.
@param[in] Private Point to generic memory test driver's private data.
@retval EFI_SUCCESS Successful add all the extended memory to system memory map.
@retval Others Failed to add the tested extended memory.
**/
EFI_STATUS
UpdateMemoryMap (
IN GENERIC_MEMORY_TEST_PRIVATE *Private
)
{
LIST_ENTRY *Link;
NONTESTED_MEMORY_RANGE *Range;
Link = Private->NonTestedMemRanList.ForwardLink;
while (Link != &Private->NonTestedMemRanList) {
Range = NONTESTED_MEMORY_RANGE_FROM_LINK (Link);
ConvertToTestedMemory (
Range->StartAddress,
Range->Length,
Range->Capabilities &~
(EFI_MEMORY_PRESENT | EFI_MEMORY_INITIALIZED | EFI_MEMORY_TESTED | EFI_MEMORY_RUNTIME)
);
Link = Link->ForwardLink;
}
return EFI_SUCCESS;
}
/**
Test a range of the memory directly .
@param[in] Private Point to generic memory test driver's private data.
@param[in] StartAddress Starting address of the memory range to be tested.
@param[in] Length Length in bytes of the memory range to be tested.
@param[in] Capabilities The bit mask of attributes that the memory range supports.
@retval EFI_SUCCESS Successful test the range of memory.
@retval Others Failed to test the range of memory.
**/
EFI_STATUS
DirectRangeTest (
IN GENERIC_MEMORY_TEST_PRIVATE *Private,
IN EFI_PHYSICAL_ADDRESS StartAddress,
IN UINT64 Length,
IN UINT64 Capabilities
)
{
EFI_STATUS Status;
//
// Perform a dummy memory test, so directly write the pattern to all range
//
WriteMemory (Private, StartAddress, Length);
//
// Verify the memory range
//
Status = VerifyMemory (Private, StartAddress, Length);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Add the tested compatible memory to system memory using GCD service
//
ConvertToTestedMemory (
StartAddress,
Length,
Capabilities &~
(EFI_MEMORY_PRESENT | EFI_MEMORY_INITIALIZED | EFI_MEMORY_TESTED | EFI_MEMORY_RUNTIME)
);
return EFI_SUCCESS;
}
/**
Construct the system non-tested memory range through GCD service.
@param[in] Private Point to generic memory test driver's private data.
@retval EFI_SUCCESS Successful construct the non-tested memory range through GCD service.
@retval EFI_OUT_OF_RESOURCE Could not allocate needed resource from base memory.
@retval Others Failed to construct non-tested memory range through GCD service.
**/
EFI_STATUS
ConstructNonTestedMemoryRange (
IN GENERIC_MEMORY_TEST_PRIVATE *Private
)
{
NONTESTED_MEMORY_RANGE *Range;
BOOLEAN NoFound;
UINTN NumberOfDescriptors;
EFI_GCD_MEMORY_SPACE_DESCRIPTOR *MemorySpaceMap;
UINTN Index;
//
// Non tested memory range may be span 4G here
//
NoFound = TRUE;
gDS->GetMemorySpaceMap (&NumberOfDescriptors, &MemorySpaceMap);
for (Index = 0; Index < NumberOfDescriptors; Index++) {
if (MemorySpaceMap[Index].GcdMemoryType == EfiGcdMemoryTypeReserved &&
(MemorySpaceMap[Index].Capabilities & (EFI_MEMORY_PRESENT | EFI_MEMORY_INITIALIZED | EFI_MEMORY_TESTED)) ==
(EFI_MEMORY_PRESENT | EFI_MEMORY_INITIALIZED)
) {
NoFound = FALSE;
//
// Light version do not need to process >4G memory range
//
gBS->AllocatePool (
EfiBootServicesData,
sizeof (NONTESTED_MEMORY_RANGE),
(VOID **) &Range
);
Range->Signature = EFI_NONTESTED_MEMORY_RANGE_SIGNATURE;
Range->StartAddress = MemorySpaceMap[Index].BaseAddress;
Range->Length = MemorySpaceMap[Index].Length;
Range->Capabilities = MemorySpaceMap[Index].Capabilities;
mNonTestedSystemMemory += MemorySpaceMap[Index].Length;
InsertTailList (&Private->NonTestedMemRanList, &Range->Link);
}
}
if (NoFound) {
return EFI_NOT_FOUND;
}
return EFI_SUCCESS;
}
/**
Write the memory test pattern into a range of physical memory.
@param[in] Private Point to generic memory test driver's private data.
@param[in] Start The memory range's start address.
@param[in] Size The memory range's size.
@retval EFI_SUCCESS Successful write the test pattern into the non-tested memory.
@retval Others The test pattern may not really write into the physical memory.
**/
EFI_STATUS
WriteMemory (
IN GENERIC_MEMORY_TEST_PRIVATE *Private,
IN EFI_PHYSICAL_ADDRESS Start,
IN UINT64 Size
)
{
EFI_PHYSICAL_ADDRESS Address;
Address = Start;
//
// Add 4G memory address check for IA32 platform
// NOTE: Without page table, there is no way to use memory above 4G.
//
if (Start + Size > MAX_ADDRESS) {
return EFI_SUCCESS;
}
while (Address < (Start + Size)) {
CopyMem ((VOID *) (UINTN) Address, Private->MonoPattern, Private->MonoTestSize);
Address += Private->CoverageSpan;
}
//
// bug bug: we may need GCD service to make the code cache and data uncache,
// if GCD do not support it or return fail, then just flush the whole cache.
//
if (Private->Cpu != NULL) {
Private->Cpu->FlushDataCache (Private->Cpu, Start, Size, EfiCpuFlushTypeWriteBackInvalidate);
}
return EFI_SUCCESS;
}
/**
Verify the range of physical memory which covered by memory test pattern.
This function will also do not return any informatin just cause system reset,
because the handle error encount fatal error and disable the bad DIMMs.
@param[in] Private Point to generic memory test driver's private data.
@param[in] Start The memory range's start address.
@param[in] Size The memory range's size.
@retval EFI_SUCCESS Successful verify the range of memory, no errors' location found.
@retval Others The range of memory have errors contained.
**/
EFI_STATUS
VerifyMemory (
IN GENERIC_MEMORY_TEST_PRIVATE *Private,
IN EFI_PHYSICAL_ADDRESS Start,
IN UINT64 Size
)
{
EFI_PHYSICAL_ADDRESS Address;
INTN ErrorFound;
EFI_MEMORY_EXTENDED_ERROR_DATA *ExtendedErrorData;
Address = Start;
ExtendedErrorData = NULL;
//
// Add 4G memory address check for IA32 platform
// NOTE: Without page table, there is no way to use memory above 4G.
//
if (Start + Size > MAX_ADDRESS) {
return EFI_SUCCESS;
}
//
// Use the software memory test to check whether have detected miscompare
// error here. If there is miscompare error here then check if generic
// memory test driver can disable the bad DIMM.
//
while (Address < (Start + Size)) {
ErrorFound = CompareMemWithoutCheckArgument (
(VOID *) (UINTN) (Address),
Private->MonoPattern,
Private->MonoTestSize
);
if (ErrorFound != 0) {
//
// Report uncorrectable errors
//
ExtendedErrorData = AllocateZeroPool (sizeof (EFI_MEMORY_EXTENDED_ERROR_DATA));
if (ExtendedErrorData == NULL) {
return EFI_OUT_OF_RESOURCES;
}
ExtendedErrorData->DataHeader.HeaderSize = (UINT16) sizeof (EFI_STATUS_CODE_DATA);
ExtendedErrorData->DataHeader.Size = (UINT16) (sizeof (EFI_MEMORY_EXTENDED_ERROR_DATA) - sizeof (EFI_STATUS_CODE_DATA));
ExtendedErrorData->Granularity = EFI_MEMORY_ERROR_DEVICE;
ExtendedErrorData->Operation = EFI_MEMORY_OPERATION_READ;
ExtendedErrorData->Syndrome = 0x0;
ExtendedErrorData->Address = Address;
ExtendedErrorData->Resolution = 0x40;
REPORT_STATUS_CODE_EX (
EFI_ERROR_CODE,
EFI_COMPUTING_UNIT_MEMORY | EFI_CU_MEMORY_EC_UNCORRECTABLE,
0,
&gEfiGenericMemTestProtocolGuid,
NULL,
(UINT8 *) ExtendedErrorData + sizeof (EFI_STATUS_CODE_DATA),
ExtendedErrorData->DataHeader.Size
);
return EFI_DEVICE_ERROR;
}
Address += Private->CoverageSpan;
}
return EFI_SUCCESS;
}
/**
Initialize the generic memory test.
@param[in] This The protocol instance pointer.
@param[in] Level The coverage level of the memory test.
@param[out] RequireSoftECCInit Indicate if the memory need software ECC init.
@retval EFI_SUCCESS The generic memory test is initialized correctly.
@retval EFI_NO_MEDIA The system had no memory to be tested.
**/
EFI_STATUS
EFIAPI
InitializeMemoryTest (
IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
IN EXTENDMEM_COVERAGE_LEVEL Level,
OUT BOOLEAN *RequireSoftECCInit
)
{
EFI_STATUS Status;
GENERIC_MEMORY_TEST_PRIVATE *Private;
EFI_CPU_ARCH_PROTOCOL *Cpu;
Private = GENERIC_MEMORY_TEST_PRIVATE_FROM_THIS (This);
*RequireSoftECCInit = FALSE;
//
// This is initialize for default value, but some value may be reset base on
// platform memory test driver.
//
Private->CoverLevel = Level;
Private->BdsBlockSize = TEST_BLOCK_SIZE;
Private->MonoPattern = GenericMemoryTestMonoPattern;
Private->MonoTestSize = GENERIC_CACHELINE_SIZE;
//
// Initialize several internal link list
//
InitializeListHead (&Private->NonTestedMemRanList);
//
// Construct base memory range
//
ConstructBaseMemoryRange (Private);
//
// get the cpu arch protocol to support flash cache
//
Status = gBS->LocateProtocol (
&gEfiCpuArchProtocolGuid,
NULL,
(VOID **) &Cpu
);
if (!EFI_ERROR (Status)) {
Private->Cpu = Cpu;
}
//
// Create the CoverageSpan of the memory test base on the coverage level
//
switch (Private->CoverLevel) {
case EXTENSIVE:
Private->CoverageSpan = GENERIC_CACHELINE_SIZE;
break;
case SPARSE:
Private->CoverageSpan = SPARSE_SPAN_SIZE;
break;
//
// Even the BDS do not need to test any memory, but in some case it
// still need to init ECC memory.
//
default:
Private->CoverageSpan = QUICK_SPAN_SIZE;
break;
}
//
// This is the first time we construct the non-tested memory range, if no
// extended memory found, we know the system have not any extended memory
// need to be test
//
Status = ConstructNonTestedMemoryRange (Private);
if (Status == EFI_NOT_FOUND) {
return EFI_NO_MEDIA;
}
//
// ready to perform the R/W/V memory test
//
mTestedSystemMemory = Private->BaseMemorySize;
mCurrentLink = Private->NonTestedMemRanList.ForwardLink;
mCurrentRange = NONTESTED_MEMORY_RANGE_FROM_LINK (mCurrentLink);
mCurrentAddress = mCurrentRange->StartAddress;
return EFI_SUCCESS;
}
/**
Perform the memory test.
@param[in] This The protocol instance pointer.
@param[out] TestedMemorySize Return the tested extended memory size.
@param[out] TotalMemorySize Return the whole system physical memory size.
The total memory size does not include memory in a slot with a disabled DIMM.
@param[out] ErrorOut TRUE if the memory error occured.
@param[in] IfTestAbort Indicates that the user pressed "ESC" to skip the memory test.
@retval EFI_SUCCESS One block of memory passed the test.
@retval EFI_NOT_FOUND All memory blocks have already been tested.
@retval EFI_DEVICE_ERROR Memory device error occured, and no agent can handle it.
**/
EFI_STATUS
EFIAPI
GenPerformMemoryTest (
IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
OUT UINT64 *TestedMemorySize,
OUT UINT64 *TotalMemorySize,
OUT BOOLEAN *ErrorOut,
IN BOOLEAN TestAbort
)
{
EFI_STATUS Status;
GENERIC_MEMORY_TEST_PRIVATE *Private;
EFI_MEMORY_RANGE_EXTENDED_DATA *RangeData;
UINT64 BlockBoundary;
Private = GENERIC_MEMORY_TEST_PRIVATE_FROM_THIS (This);
*ErrorOut = FALSE;
RangeData = NULL;
BlockBoundary = 0;
//
// In extensive mode the boundary of "mCurrentRange->Length" may will lost
// some range that is not Private->BdsBlockSize size boundary, so need
// the software mechanism to confirm all memory location be covered.
//
if (mCurrentAddress < (mCurrentRange->StartAddress + mCurrentRange->Length)) {
if ((mCurrentAddress + Private->BdsBlockSize) <= (mCurrentRange->StartAddress + mCurrentRange->Length)) {
BlockBoundary = Private->BdsBlockSize;
} else {
BlockBoundary = mCurrentRange->StartAddress + mCurrentRange->Length - mCurrentAddress;
}
//
// If TestAbort is true, means user cancel the memory test
//
if (!TestAbort && Private->CoverLevel != IGNORE) {
//
// Report status code of every memory range
//
RangeData = AllocateZeroPool (sizeof (EFI_MEMORY_RANGE_EXTENDED_DATA));
if (RangeData == NULL) {
return EFI_OUT_OF_RESOURCES;
}
RangeData->DataHeader.HeaderSize = (UINT16) sizeof (EFI_STATUS_CODE_DATA);
RangeData->DataHeader.Size = (UINT16) (sizeof (EFI_MEMORY_RANGE_EXTENDED_DATA) - sizeof (EFI_STATUS_CODE_DATA));
RangeData->Start = mCurrentAddress;
RangeData->Length = BlockBoundary;
REPORT_STATUS_CODE_EX (
EFI_PROGRESS_CODE,
EFI_COMPUTING_UNIT_MEMORY | EFI_CU_MEMORY_PC_TEST,
0,
&gEfiGenericMemTestProtocolGuid,
NULL,
(UINT8 *) RangeData + sizeof (EFI_STATUS_CODE_DATA),
RangeData->DataHeader.Size
);
//
// The software memory test (R/W/V) perform here. It will detect the
// memory mis-compare error.
//
WriteMemory (Private, mCurrentAddress, BlockBoundary);
Status = VerifyMemory (Private, mCurrentAddress, BlockBoundary);
if (EFI_ERROR (Status)) {
//
// If perform here, means there is mis-compare error, and no agent can
// handle it, so we return to BDS EFI_DEVICE_ERROR.
//
*ErrorOut = TRUE;
return EFI_DEVICE_ERROR;
}
}
mTestedSystemMemory += BlockBoundary;
*TestedMemorySize = mTestedSystemMemory;
//
// If the memory test restart after the platform driver disable dimms,
// the NonTestSystemMemory may be changed, but the base memory size will
// not changed, so we can get the current total memory size.
//
*TotalMemorySize = Private->BaseMemorySize + mNonTestedSystemMemory;
//
// Update the current test address pointing to next BDS BLOCK
//
mCurrentAddress += Private->BdsBlockSize;
return EFI_SUCCESS;
}
//
// Change to next non tested memory range
//
mCurrentLink = mCurrentLink->ForwardLink;
if (mCurrentLink != &Private->NonTestedMemRanList) {
mCurrentRange = NONTESTED_MEMORY_RANGE_FROM_LINK (mCurrentLink);
mCurrentAddress = mCurrentRange->StartAddress;
return EFI_SUCCESS;
} else {
//
// Here means all the memory test have finished
//
*TestedMemorySize = mTestedSystemMemory;
*TotalMemorySize = Private->BaseMemorySize + mNonTestedSystemMemory;
return EFI_NOT_FOUND;
}
}
/**
Finish the memory test.
@param[in] This The protocol instance pointer.
@retval EFI_SUCCESS Success. All resources used in the memory test are freed.
**/
EFI_STATUS
EFIAPI
GenMemoryTestFinished (
IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This
)
{
EFI_STATUS Status;
GENERIC_MEMORY_TEST_PRIVATE *Private;
Private = GENERIC_MEMORY_TEST_PRIVATE_FROM_THIS (This);
//
// Perform Data and Address line test
//
Status = PerformAddressDataLineTest (Private);
ASSERT_EFI_ERROR (Status);
//
// Add the non tested memory range to system memory map through GCD service
//
UpdateMemoryMap (Private);
//
// we need to free all the memory allocate
//
DestroyLinkList (Private);
return EFI_SUCCESS;
}
/**
Provides the capability to test the compatible range used by some special drivers.
@param[in] This The protocol instance pointer.
@param[in] StartAddress The start address of the compatible memory range that
must be below 16M.
@param[in] Length The compatible memory range's length.
@retval EFI_SUCCESS The compatible memory range pass the memory test.
@retval EFI_INVALID_PARAMETER The compatible memory range are not below Low 16M.
**/
EFI_STATUS
EFIAPI
GenCompatibleRangeTest (
IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,
IN EFI_PHYSICAL_ADDRESS StartAddress,
IN UINT64 Length
)
{
EFI_STATUS Status;
GENERIC_MEMORY_TEST_PRIVATE *Private;
EFI_GCD_MEMORY_SPACE_DESCRIPTOR Descriptor;
EFI_PHYSICAL_ADDRESS CurrentBase;
UINT64 CurrentLength;
Private = GENERIC_MEMORY_TEST_PRIVATE_FROM_THIS (This);
//
// Check if the parameter is below 16MB
//
if (StartAddress + Length > 0x1000000) {
return EFI_INVALID_PARAMETER;
}
CurrentBase = StartAddress;
do {
//
// Check the required memory range status; if the required memory range span
// the different GCD memory descriptor, it may be cause different action.
//
Status = gDS->GetMemorySpaceDescriptor (
CurrentBase,
&Descriptor
);
if (EFI_ERROR (Status)) {
return Status;
}
if (Descriptor.GcdMemoryType == EfiGcdMemoryTypeReserved &&
(Descriptor.Capabilities & (EFI_MEMORY_PRESENT | EFI_MEMORY_INITIALIZED | EFI_MEMORY_TESTED)) ==
(EFI_MEMORY_PRESENT | EFI_MEMORY_INITIALIZED)
) {
CurrentLength = Descriptor.BaseAddress + Descriptor.Length - CurrentBase;
if (CurrentBase + CurrentLength > StartAddress + Length) {
CurrentLength = StartAddress + Length - CurrentBase;
}
Status = DirectRangeTest (
Private,
CurrentBase,
CurrentLength,
Descriptor.Capabilities
);
if (EFI_ERROR (Status)) {
return Status;
}
}
CurrentBase = Descriptor.BaseAddress + Descriptor.Length;
} while (CurrentBase < StartAddress + Length);
//
// Here means the required range already be tested, so just return success.
//
return EFI_SUCCESS;
}
/**
Perform the address line walking ones test.
@param[in] Private Point to generic memory test driver's private data.
@retval EFI_SUCCESS Successful finished walking ones test.
@retval EFI_OUT_OF_RESOURCE Could not get resource in base memory.
@retval EFI_ACCESS_DENIED Code may can not run here because if walking one test
failed, system may be already halt.
**/
EFI_STATUS
PerformAddressDataLineTest (
IN GENERIC_MEMORY_TEST_PRIVATE *Private
)
{
LIST_ENTRY *ExtendedLink;
NONTESTED_MEMORY_RANGE *ExtendedRange;
BOOLEAN InExtendedRange;
EFI_PHYSICAL_ADDRESS TestAddress;
//
// Light version no data line test, only perform the address line test
//
TestAddress = (EFI_PHYSICAL_ADDRESS) 0x1;
while (TestAddress < MAX_ADDRESS && TestAddress > 0) {
//
// only test if the address falls in the enabled range
//
InExtendedRange = FALSE;
ExtendedLink = Private->NonTestedMemRanList.BackLink;
while (ExtendedLink != &Private->NonTestedMemRanList) {
ExtendedRange = NONTESTED_MEMORY_RANGE_FROM_LINK (ExtendedLink);
if ((TestAddress >= ExtendedRange->StartAddress) &&
(TestAddress < (ExtendedRange->StartAddress + ExtendedRange->Length))
) {
InExtendedRange = TRUE;
}
ExtendedLink = ExtendedLink->BackLink;
}
if (InExtendedRange) {
*(EFI_PHYSICAL_ADDRESS *) (UINTN) TestAddress = TestAddress;
Private->Cpu->FlushDataCache (Private->Cpu, TestAddress, 1, EfiCpuFlushTypeWriteBackInvalidate);
if (*(EFI_PHYSICAL_ADDRESS *) (UINTN) TestAddress != TestAddress) {
return EFI_ACCESS_DENIED;
}
}
TestAddress = LShiftU64 (TestAddress, 1);
}
return EFI_SUCCESS;
}
//
// Driver entry here
//
GENERIC_MEMORY_TEST_PRIVATE mGenericMemoryTestPrivate = {
EFI_GENERIC_MEMORY_TEST_PRIVATE_SIGNATURE,
NULL,
NULL,
{
InitializeMemoryTest,
GenPerformMemoryTest,
GenMemoryTestFinished,
GenCompatibleRangeTest
},
(EXTENDMEM_COVERAGE_LEVEL) 0,
0,
0,
NULL,
0,
0,
{
NULL,
NULL
}
};
/**
The generic memory test driver's entry point.
It initializes private data to default value.
@param[in] ImageHandle The firmware allocated handle for the EFI image.
@param[in] SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The entry point is executed successfully.
@retval EFI_NOT_FOUND Can't find HandOff Hob in HobList.
@retval other Some error occurs when executing this entry point.
**/
EFI_STATUS
EFIAPI
GenericMemoryTestEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
VOID *HobList;
EFI_BOOT_MODE BootMode;
EFI_PEI_HOB_POINTERS Hob;
//
// Use the generic pattern to test compatible memory range
//
mGenericMemoryTestPrivate.MonoPattern = GenericMemoryTestMonoPattern;
mGenericMemoryTestPrivate.MonoTestSize = GENERIC_CACHELINE_SIZE;
//
// Get the platform boot mode
//
HobList = GetHobList ();
Hob.Raw = HobList;
if (Hob.Header->HobType != EFI_HOB_TYPE_HANDOFF) {
return EFI_NOT_FOUND;
}
BootMode = Hob.HandoffInformationTable->BootMode;
//
// Get the platform boot mode and create the default memory test coverage
// level and span size for compatible memory test using
//
switch (BootMode) {
case BOOT_WITH_FULL_CONFIGURATION:
case BOOT_WITH_DEFAULT_SETTINGS:
mGenericMemoryTestPrivate.CoverageSpan = SPARSE_SPAN_SIZE;
break;
case BOOT_WITH_FULL_CONFIGURATION_PLUS_DIAGNOSTICS:
mGenericMemoryTestPrivate.CoverageSpan = GENERIC_CACHELINE_SIZE;
break;
default:
mGenericMemoryTestPrivate.CoverageSpan = QUICK_SPAN_SIZE;
break;
}
//
// Install the protocol
//
Status = gBS->InstallProtocolInterface (
&mGenericMemoryTestPrivate.Handle,
&gEfiGenericMemTestProtocolGuid,
EFI_NATIVE_INTERFACE,
&mGenericMemoryTestPrivate.GenericMemoryTest
);
return Status;
}
|