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
|
/** @file
FV block I/O protocol driver for RPMB eMMC accessed via OP-TEE
Copyright (c) 2020, Linaro Ltd. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Library/ArmSvcLib.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/MmServicesTableLib.h>
#include <Library/PcdLib.h>
#include <IndustryStandard/ArmFfaSvc.h>
#include <IndustryStandard/ArmMmSvc.h>
#include <Protocol/FirmwareVolumeBlock.h>
#include <Protocol/SmmFirmwareVolumeBlock.h>
#include <Guid/VariableFormat.h>
#include "OpTeeRpmbFvb.h"
static const UINT16 mem_mgr_id = 3U;
static const UINT16 storage_id = 4U;
STATIC MEM_INSTANCE mInstance;
/**
Sends an SVC call to OP-TEE for reading/writing an RPMB partition
@param SvcAct SVC ID for read/write
@param Addr Base address of the buffer. When reading contents will be
copied to that buffer after reading them from the device.
When writing, the buffer holds the contents we want to
write cwtoin the device
@param NumBytes Number of bytes to read/write
@param Offset Offset into the RPMB file
@retval OP-TEE return code
**/
STATIC
EFI_STATUS
ReadWriteRpmb (
UINTN SvcAct,
UINTN Addr,
UINTN NumBytes,
UINTN Offset
)
{
ARM_SVC_ARGS SvcArgs;
EFI_STATUS Status;
ZeroMem (&SvcArgs, sizeof (SvcArgs));
SvcArgs.Arg0 = ARM_SVC_ID_FFA_MSG_SEND_DIRECT_REQ_AARCH64;
SvcArgs.Arg1 = storage_id;
SvcArgs.Arg2 = 0;
SvcArgs.Arg3 = SvcAct;
SvcArgs.Arg4 = Addr;
SvcArgs.Arg5 = NumBytes;
SvcArgs.Arg6 = Offset;
ArmCallSvc (&SvcArgs);
if (SvcArgs.Arg3) {
DEBUG ((DEBUG_ERROR, "%a: Svc Call 0x%08x Addr: 0x%08x len: 0x%x Offset: 0x%x failed with 0x%x\n",
__func__, SvcAct, Addr, NumBytes, Offset, SvcArgs.Arg3));
}
switch (SvcArgs.Arg3) {
case ARM_SVC_SPM_RET_SUCCESS:
Status = EFI_SUCCESS;
break;
case ARM_SVC_SPM_RET_NOT_SUPPORTED:
Status = EFI_UNSUPPORTED;
break;
case ARM_SVC_SPM_RET_INVALID_PARAMS:
Status = EFI_INVALID_PARAMETER;
break;
case ARM_SVC_SPM_RET_DENIED:
Status = EFI_ACCESS_DENIED;
break;
case ARM_SVC_SPM_RET_NO_MEMORY:
Status = EFI_BAD_BUFFER_SIZE;
break;
default:
Status = EFI_ACCESS_DENIED;
}
return Status;
}
/**
The GetAttributes() function retrieves the attributes and
current settings of the block.
@param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.
@param Attributes Pointer to EFI_FVB_ATTRIBUTES_2 in which the
attributes and current settings are
returned. Type EFI_FVB_ATTRIBUTES_2 is defined
in EFI_FIRMWARE_VOLUME_HEADER.
@retval EFI_SUCCESS The firmware volume attributes were
returned.
**/
STATIC
EFI_STATUS
OpTeeRpmbFvbGetAttributes (
IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,
OUT EFI_FVB_ATTRIBUTES_2 *Attributes
)
{
*Attributes = EFI_FVB2_READ_ENABLED_CAP | // Reads may be enabled
EFI_FVB2_READ_STATUS | // Reads are currently enabled
EFI_FVB2_WRITE_STATUS | // Writes are currently enabled
EFI_FVB2_WRITE_ENABLED_CAP | // Writes may be enabled
EFI_FVB2_STICKY_WRITE | // A block erase is required to flip bits into EFI_FVB2_ERASE_POLARITY
EFI_FVB2_MEMORY_MAPPED | // It is memory mapped
EFI_FVB2_ERASE_POLARITY; // After erasure all bits take this value (i.e. '1')
return EFI_SUCCESS;
}
/**
The SetAttributes() function sets configurable firmware volume
attributes and returns the new settings of the firmware volume.
@param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.
@param Attributes On input, Attributes is a pointer to
EFI_FVB_ATTRIBUTES_2 that contains the
desired firmware volume settings. On
successful return, it contains the new
settings of the firmware volume. Type
EFI_FVB_ATTRIBUTES_2 is defined in
EFI_FIRMWARE_VOLUME_HEADER.
@retval EFI_SUCCESS The firmware volume attributes were returned.
@retval EFI_INVALID_PARAMETER The attributes requested are in
conflict with the capabilities
as declared in the firmware
volume header.
**/
STATIC
EFI_STATUS
OpTeeRpmbFvbSetAttributes (
IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,
IN OUT EFI_FVB_ATTRIBUTES_2 *Attributes
)
{
return EFI_SUCCESS; // ignore for now
}
/**
The GetPhysicalAddress() function retrieves the base address of
a memory-mapped firmware volume. This function should be called
only for memory-mapped firmware volumes.
@param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.
@param Address Pointer to a caller-allocated
EFI_PHYSICAL_ADDRESS that, on successful
return from GetPhysicalAddress(), contains the
base address of the firmware volume.
@retval EFI_SUCCESS The firmware volume base address was returned.
@retval EFI_UNSUPPORTED The firmware volume is not memory mapped.
**/
STATIC
EFI_STATUS
OpTeeRpmbFvbGetPhysicalAddress (
IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,
OUT EFI_PHYSICAL_ADDRESS *Address
)
{
MEM_INSTANCE *Instance;
Instance = INSTANCE_FROM_FVB_THIS(This);
*Address = Instance->MemBaseAddress;
return EFI_SUCCESS;
}
/**
The GetBlockSize() function retrieves the size of the requested
block. It also returns the number of additional blocks with
the identical size. The GetBlockSize() function is used to
retrieve the block map (see EFI_FIRMWARE_VOLUME_HEADER).
@param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.
@param Lba Indicates the block for which to return the size.
@param BlockSize Pointer to a caller-allocated UINTN in which
the size of the block is returned.
@param NumberOfBlocks Pointer to a caller-allocated UINTN in
which the number of consecutive blocks,
starting with Lba, is returned. All
blocks in this range have a size of
BlockSize.
@retval EFI_SUCCESS The firmware volume base address was returned.
@retval EFI_INVALID_PARAMETER The requested LBA is out of range.
**/
STATIC
EFI_STATUS
OpTeeRpmbFvbGetBlockSize (
IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,
IN EFI_LBA Lba,
OUT UINTN *BlockSize,
OUT UINTN *NumberOfBlocks
)
{
MEM_INSTANCE *Instance;
Instance = INSTANCE_FROM_FVB_THIS(This);
if (Lba > Instance->NBlocks) {
return EFI_INVALID_PARAMETER;
}
*NumberOfBlocks = Instance->NBlocks - (UINTN) Lba;
*BlockSize = Instance->BlockSize;
return EFI_SUCCESS;
}
/**
Reads the specified number of bytes into a buffer from the specified block.
The Read() function reads the requested number of bytes from the
requested block and stores them in the provided buffer.
Implementations should be mindful that the firmware volume
might be in the ReadDisabled state. If it is in this state,
the Read() function must return the status code
EFI_ACCESS_DENIED without modifying the contents of the
buffer. The Read() function must also prevent spanning block
boundaries. If a read is requested that would span a block
boundary, the read must read up to the boundary but not
beyond. The output parameter NumBytes must be set to correctly
indicate the number of bytes actually read. The caller must be
aware that a read may be partially completed.
@param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.
@param Lba The starting logical block index
from which to read.
@param Offset Offset into the block at which to begin reading.
@param NumBytes Pointer to a UINTN. At entry, *NumBytes
contains the total size of the buffer. At
exit, *NumBytes contains the total number of
bytes read.
@param Buffer Pointer to a caller-allocated buffer that will
be used to hold the data that is read.
@retval EFI_SUCCESS The firmware volume was read successfully,
and contents are in Buffer.
@retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA
boundary. On output, NumBytes
contains the total number of bytes
returned in Buffer.
@retval EFI_ACCESS_DENIED The firmware volume is in the
ReadDisabled state.
@retval EFI_DEVICE_ERROR The block device is not
functioning correctly and could
not be read.
**/
STATIC
EFI_STATUS
OpTeeRpmbFvbRead (
IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,
IN EFI_LBA Lba,
IN UINTN Offset,
IN OUT UINTN *NumBytes,
IN OUT UINT8 *Buffer
)
{
EFI_STATUS Status = EFI_SUCCESS;
MEM_INSTANCE *Instance;
VOID *Base;
Instance = INSTANCE_FROM_FVB_THIS(This);
if (Instance->Initialized == FALSE) {
Instance->Initialize (Instance);
}
Base = (VOID *)Instance->MemBaseAddress + Lba * Instance->BlockSize + Offset;
// We could read the data from the RPMB instead of memory
// The 2 copies should already be identical
// Copy from memory image
CopyMem (Buffer, Base, *NumBytes);
return Status;
}
/**
Writes the specified number of bytes from the input buffer to the block.
The Write() function writes the specified number of bytes from
the provided buffer to the specified block and offset. If the
firmware volume is sticky write, the caller must ensure that
all the bits of the specified range to write are in the
EFI_FVB_ERASE_POLARITY state before calling the Write()
function, or else the result will be unpredictable. This
unpredictability arises because, for a sticky-write firmware
volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY
state but cannot flip it back again. Before calling the
Write() function, it is recommended for the caller to first call
the EraseBlocks() function to erase the specified block to
write. A block erase cycle will transition bits from the
(NOT)EFI_FVB_ERASE_POLARITY state back to the
EFI_FVB_ERASE_POLARITY state. Implementations should be
mindful that the firmware volume might be in the WriteDisabled
state. If it is in this state, the Write() function must
return the status code EFI_ACCESS_DENIED without modifying the
contents of the firmware volume. The Write() function must
also prevent spanning block boundaries. If a write is
requested that spans a block boundary, the write must store up
to the boundary but not beyond. The output parameter NumBytes
must be set to correctly indicate the number of bytes actually
written. The caller must be aware that a write may be
partially completed. All writes, partial or otherwise, must be
fully flushed to the hardware before the Write() service
returns.
@param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL instance.
@param Lba The starting logical block index to write to.
@param Offset Offset into the block at which to begin writing.
@param NumBytes The pointer to a UINTN. At entry, *NumBytes
contains the total size of the buffer. At
exit, *NumBytes contains the total number of
bytes actually written.
@param Buffer The pointer to a caller-allocated buffer that
contains the source for the write.
@retval EFI_SUCCESS The firmware volume was written successfully.
@retval EFI_BAD_BUFFER_SIZE The write was attempted across an
LBA boundary. On output, NumBytes
contains the total number of bytes
actually written.
@retval EFI_ACCESS_DENIED The firmware volume is in the
WriteDisabled state.
@retval EFI_DEVICE_ERROR The block device is malfunctioning
and could not be written.
**/
STATIC
EFI_STATUS
OpTeeRpmbFvbWrite (
IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,
IN EFI_LBA Lba,
IN UINTN Offset,
IN OUT UINTN *NumBytes,
IN UINT8 *Buffer
)
{
MEM_INSTANCE *Instance;
EFI_STATUS Status = EFI_SUCCESS;
VOID *Base;
Instance = INSTANCE_FROM_FVB_THIS(This);
if (Instance->Initialized == FALSE) {
Instance->Initialize (Instance);
}
Base = (VOID *)Instance->MemBaseAddress + Lba * Instance->BlockSize + Offset;
Status = ReadWriteRpmb (SP_SVC_RPMB_WRITE, (UINTN) Buffer, *NumBytes,
Lba * Instance->BlockSize + Offset);
if (Status != EFI_SUCCESS) {
return Status;
}
// Update the memory copy
CopyMem (Base, Buffer, *NumBytes);
return EFI_SUCCESS;
}
/**
Erases and initializes a firmware volume block.
The EraseBlocks() function erases one or more blocks as denoted
by the variable argument list. The entire parameter list of
blocks must be verified before erasing any blocks. If a block is
requested that does not exist within the associated firmware
volume (it has a larger index than the last block of the
firmware volume), the EraseBlocks() function must return the
status code EFI_INVALID_PARAMETER without modifying the contents
of the firmware volume. Implementations should be mindful that
the firmware volume might be in the WriteDisabled state. If it
is in this state, the EraseBlocks() function must return the
status code EFI_ACCESS_DENIED without modifying the contents of
the firmware volume. All calls to EraseBlocks() must be fully
flushed to the hardware before the EraseBlocks() service
returns.
@param This Indicates the EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
instance.
@param ... The variable argument list is a list of tuples.
Each tuple describes a range of LBAs to erase
and consists of the following:
- An EFI_LBA that indicates the starting LBA
- A UINTN that indicates the number of blocks to
erase.
The list is terminated with an
EFI_LBA_LIST_TERMINATOR. For example, the
following indicates that two ranges of blocks
(5-7 and 10-11) are to be erased: EraseBlocks
(This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);
@retval EFI_SUCCESS The erase request successfully
completed.
@retval EFI_ACCESS_DENIED The firmware volume is in the
WriteDisabled state.
@retval EFI_DEVICE_ERROR The block device is not functioning
correctly and could not be written.
The firmware device may have been
partially erased.
@retval EFI_INVALID_PARAMETER One or more of the LBAs listed
in the variable argument list do
not exist in the firmware volume.
**/
STATIC
EFI_STATUS
OpTeeRpmbFvbErase (
IN CONST EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *This,
...
)
{
MEM_INSTANCE *Instance;
UINTN NumBytes;
UINTN NumLba;
EFI_LBA Start;
VOID *Base;
VOID *Buf;
VA_LIST Args;
EFI_STATUS Status;
Instance = INSTANCE_FROM_FVB_THIS(This);
VA_START (Args, This);
for (Start = VA_ARG (Args, EFI_LBA);
Start != EFI_LBA_LIST_TERMINATOR;
Start = VA_ARG (Args, EFI_LBA)) {
NumLba = VA_ARG (Args, UINTN);
if (NumLba == 0 || Start + NumLba > Instance->NBlocks) {
return EFI_INVALID_PARAMETER;
}
NumBytes = NumLba * Instance->BlockSize;
Base = (VOID *)Instance->MemBaseAddress + Start * Instance->BlockSize;
Buf = AllocatePool(NumLba * Instance->BlockSize);
if (!Buf) {
return EFI_DEVICE_ERROR;
}
SetMem64 (Buf, NumLba * Instance->BlockSize, ~0UL);
// Write the device
Status = ReadWriteRpmb (SP_SVC_RPMB_WRITE, (UINTN) Buf, NumBytes,
Start * Instance->BlockSize);
if (Status != EFI_SUCCESS) {
return Status;
}
// Update the in memory copy
SetMem64 (Base, NumLba * Instance->BlockSize, ~0UL);
FreePool (Buf);
}
VA_END (Args);
return EFI_SUCCESS;
}
/**
Since we use a memory backed storage we need to restore the RPMB contents
into memory before we register the Fvb protocol.
@param Instace Address to copy flash contents to
@retval 0 on success, OP-TEE error on failure
**/
STATIC
VOID
ReadEntireFlash (
MEM_INSTANCE *Instance
)
{
UINTN ReadAddr;
UINTN StorageFtwWorkingSize = PcdGet32(PcdFlashNvStorageFtwWorkingSize);
UINTN StorageVariableSize = PcdGet32(PcdFlashNvStorageVariableSize);
UINTN StorageFtwSpareSize = PcdGet32(PcdFlashNvStorageFtwSpareSize);
ReadAddr = Instance->MemBaseAddress;
// There's no need to check if the read failed here. The upper EDK2 layers
// will initialize the flash correctly if the in-memory copy is wrong
ReadWriteRpmb(SP_SVC_RPMB_READ, ReadAddr, StorageVariableSize +
StorageFtwWorkingSize + StorageFtwSpareSize , 0);
}
STATIC
EFI_STATUS
EFIAPI
ValidateFvHeader (
IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader
)
{
UINT16 Checksum;
VARIABLE_STORE_HEADER *VariableStoreHeader;
UINTN VariableStoreLength;
UINTN FvLength;
FvLength = PcdGet32(PcdFlashNvStorageVariableSize) +
PcdGet32(PcdFlashNvStorageFtwWorkingSize) +
PcdGet32(PcdFlashNvStorageFtwSpareSize);
// Verify the header revision, header signature, length
// Length of FvBlock cannot be 2**64-1
// HeaderLength cannot be an odd number
//
if ( (FwVolHeader->Revision != EFI_FVH_REVISION)
|| (FwVolHeader->Signature != EFI_FVH_SIGNATURE)
|| (FwVolHeader->FvLength != FvLength)
)
{
DEBUG ((DEBUG_INFO, "%a: No Firmware Volume header present\n",
__FUNCTION__));
return EFI_NOT_FOUND;
}
// Check the Firmware Volume Guid
if (!CompareGuid (&FwVolHeader->FileSystemGuid, &gEfiSystemNvDataFvGuid)) {
DEBUG ((DEBUG_INFO, "%a: Firmware Volume Guid non-compatible\n",
__FUNCTION__));
return EFI_NOT_FOUND;
}
// Verify the header checksum
Checksum = CalculateSum16((UINT16*)FwVolHeader, FwVolHeader->HeaderLength);
if (Checksum != 0) {
DEBUG ((DEBUG_INFO, "%a: FV checksum is invalid (Checksum:0x%X)\n",
__FUNCTION__, Checksum));
return EFI_NOT_FOUND;
}
VariableStoreHeader = (VOID *)((UINTN)FwVolHeader +
FwVolHeader->HeaderLength);
// Check the Variable Store Guid
if (!CompareGuid (&VariableStoreHeader->Signature, &gEfiVariableGuid) &&
!CompareGuid (&VariableStoreHeader->Signature,
&gEfiAuthenticatedVariableGuid)) {
DEBUG ((DEBUG_INFO, "%a: Variable Store Guid non-compatible\n",
__FUNCTION__));
return EFI_NOT_FOUND;
}
VariableStoreLength = PcdGet32 (PcdFlashNvStorageVariableSize) -
FwVolHeader->HeaderLength;
if (VariableStoreHeader->Size != VariableStoreLength) {
DEBUG ((DEBUG_INFO, "%a: Variable Store Length does not match\n",
__FUNCTION__));
return EFI_NOT_FOUND;
}
return EFI_SUCCESS;
}
STATIC
EFI_STATUS
InitializeFvAndVariableStoreHeaders (
MEM_INSTANCE *Instance
)
{
EFI_FIRMWARE_VOLUME_HEADER *FirmwareVolumeHeader;
VARIABLE_STORE_HEADER *VariableStoreHeader;
EFI_STATUS Status = EFI_SUCCESS;
UINTN HeadersLength;
VOID* Headers;
HeadersLength = sizeof(EFI_FIRMWARE_VOLUME_HEADER) +
sizeof(EFI_FV_BLOCK_MAP_ENTRY) +
sizeof(VARIABLE_STORE_HEADER);
Headers = AllocateZeroPool(HeadersLength);
//
// EFI_FIRMWARE_VOLUME_HEADER
//
FirmwareVolumeHeader = (EFI_FIRMWARE_VOLUME_HEADER*)Headers;
CopyGuid (&FirmwareVolumeHeader->FileSystemGuid, &gEfiSystemNvDataFvGuid);
FirmwareVolumeHeader->FvLength =
PcdGet32(PcdFlashNvStorageVariableSize) +
PcdGet32(PcdFlashNvStorageFtwWorkingSize) +
PcdGet32(PcdFlashNvStorageFtwSpareSize);
FirmwareVolumeHeader->Signature = EFI_FVH_SIGNATURE;
FirmwareVolumeHeader->Attributes = EFI_FVB2_READ_ENABLED_CAP |
EFI_FVB2_READ_STATUS |
EFI_FVB2_STICKY_WRITE |
EFI_FVB2_MEMORY_MAPPED |
EFI_FVB2_ERASE_POLARITY |
EFI_FVB2_WRITE_STATUS |
EFI_FVB2_WRITE_ENABLED_CAP;
FirmwareVolumeHeader->HeaderLength = sizeof(EFI_FIRMWARE_VOLUME_HEADER) +
sizeof(EFI_FV_BLOCK_MAP_ENTRY);
FirmwareVolumeHeader->Revision = EFI_FVH_REVISION;
FirmwareVolumeHeader->BlockMap[0].NumBlocks = Instance->NBlocks;
FirmwareVolumeHeader->BlockMap[0].Length = Instance->BlockSize;
FirmwareVolumeHeader->BlockMap[1].NumBlocks = 0;
FirmwareVolumeHeader->BlockMap[1].Length = 0;
FirmwareVolumeHeader->Checksum = CalculateCheckSum16 (
(UINT16*)FirmwareVolumeHeader,
FirmwareVolumeHeader->HeaderLength);
//
// VARIABLE_STORE_HEADER
//
VariableStoreHeader = (VOID *)((UINTN)Headers +
FirmwareVolumeHeader->HeaderLength);
CopyGuid (&VariableStoreHeader->Signature, &gEfiAuthenticatedVariableGuid);
VariableStoreHeader->Size = PcdGet32(PcdFlashNvStorageVariableSize) -
FirmwareVolumeHeader->HeaderLength;
VariableStoreHeader->Format = VARIABLE_STORE_FORMATTED;
VariableStoreHeader->State = VARIABLE_STORE_HEALTHY;
Status = ReadWriteRpmb(SP_SVC_RPMB_WRITE, (UINTN) Headers, HeadersLength, 0);
if (Status != EFI_SUCCESS) {
goto Exit;
}
// Install the combined header in memory
CopyMem ((VOID*) Instance->MemBaseAddress, Headers, HeadersLength);
Exit:
FreePool (Headers);
return Status;
}
STATIC
EFI_STATUS
EFIAPI
FvbInitialize (
MEM_INSTANCE *Instance
)
{
EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;
EFI_STATUS Status;
if (Instance->Initialized == TRUE) {
return EFI_SUCCESS;
}
// FirmwareVolumeHeader->FvLength is declared to have the Variable area
// AND the FTW working area AND the FTW Spare contiguous.
ASSERT (PcdGet32 (PcdFlashNvStorageVariableBase) +
PcdGet32 (PcdFlashNvStorageVariableSize) ==
PcdGet32 (PcdFlashNvStorageFtwWorkingBase));
ASSERT (PcdGet32 (PcdFlashNvStorageFtwWorkingBase) +
PcdGet32 (PcdFlashNvStorageFtwWorkingSize) ==
PcdGet32 (PcdFlashNvStorageFtwSpareBase));
// Check if the size of the area is at least one block size
ASSERT ((PcdGet32 (PcdFlashNvStorageVariableSize) > 0) &&
(PcdGet32 (PcdFlashNvStorageVariableSize) / Instance->BlockSize > 0));
ASSERT ((PcdGet32 (PcdFlashNvStorageFtwWorkingSize) > 0) &&
(PcdGet32 (PcdFlashNvStorageFtwWorkingSize) / Instance->BlockSize > 0));
ASSERT ((PcdGet32 (PcdFlashNvStorageFtwSpareSize) > 0) &&
(PcdGet32 (PcdFlashNvStorageFtwSpareSize) / Instance->BlockSize > 0));
// Ensure the Variable areas are aligned on block size boundaries
ASSERT ((PcdGet32 (PcdFlashNvStorageVariableBase) % Instance->BlockSize) == 0);
ASSERT ((PcdGet32 (PcdFlashNvStorageFtwWorkingBase) % Instance->BlockSize) == 0);
ASSERT ((PcdGet32 (PcdFlashNvStorageFtwSpareBase) % Instance->BlockSize) == 0);
// Read the file from disk and copy it to memory
ReadEntireFlash (Instance);
FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) Instance->MemBaseAddress;
Status = ValidateFvHeader(FwVolHeader);
if (EFI_ERROR (Status)) {
// There is no valid header, so time to install one.
DEBUG ((DEBUG_INFO, "%a: The FVB Header is not valid.\n", __FUNCTION__));
// Reset memory
SetMem64 ((VOID *)Instance->MemBaseAddress, Instance->NBlocks * Instance->BlockSize, ~0UL);
DEBUG ((DEBUG_INFO, "%a: Erasing Flash.\n", __FUNCTION__));
Status = ReadWriteRpmb(SP_SVC_RPMB_WRITE, Instance->MemBaseAddress,
PcdGet32(PcdFlashNvStorageVariableSize) +
PcdGet32(PcdFlashNvStorageFtwWorkingSize) +
PcdGet32(PcdFlashNvStorageFtwSpareSize), 0);
if (Status != EFI_SUCCESS) {
return Status;
}
// Install all appropriate headers
DEBUG ((DEBUG_INFO, "%a: Installing a correct one for this volume.\n",
__FUNCTION__));
Status = InitializeFvAndVariableStoreHeaders (Instance);
if (EFI_ERROR (Status)) {
return Status;
}
} else {
DEBUG ((DEBUG_INFO, "%a: Found valid FVB Header.\n", __FUNCTION__));
}
Instance->Initialized = TRUE;
return EFI_SUCCESS;
}
EFI_STATUS
EFIAPI
OpTeeRpmbFvbInit (
IN EFI_HANDLE ImageHandle,
IN EFI_MM_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
VOID *Addr;
UINTN FvLength;
UINTN NBlocks;
FvLength = PcdGet32(PcdFlashNvStorageVariableSize) +
PcdGet32(PcdFlashNvStorageFtwWorkingSize) +
PcdGet32(PcdFlashNvStorageFtwSpareSize);
NBlocks = EFI_SIZE_TO_PAGES(ALIGN_VARIABLE(FvLength));
Addr = AllocatePages(NBlocks);
ASSERT (Addr != NULL);
SetMem (&mInstance, sizeof (mInstance), 0);
mInstance.FvbProtocol.GetPhysicalAddress = OpTeeRpmbFvbGetPhysicalAddress;
mInstance.FvbProtocol.GetAttributes = OpTeeRpmbFvbGetAttributes;
mInstance.FvbProtocol.SetAttributes = OpTeeRpmbFvbSetAttributes;
mInstance.FvbProtocol.GetBlockSize = OpTeeRpmbFvbGetBlockSize;
mInstance.FvbProtocol.EraseBlocks = OpTeeRpmbFvbErase;
mInstance.FvbProtocol.Write = OpTeeRpmbFvbWrite;
mInstance.FvbProtocol.Read = OpTeeRpmbFvbRead;
mInstance.MemBaseAddress = (EFI_PHYSICAL_ADDRESS) Addr;
mInstance.Signature = FLASH_SIGNATURE;
mInstance.Initialize = FvbInitialize;
mInstance.BlockSize = EFI_PAGE_SIZE;
mInstance.NBlocks = NBlocks;
// Update the defined PCDs related to Variable Storage
PatchPcdSet32 (PcdFlashNvStorageVariableBase, mInstance.MemBaseAddress);
PatchPcdSet32 (PcdFlashNvStorageFtwWorkingBase, mInstance.MemBaseAddress +
PcdGet32 (PcdFlashNvStorageVariableSize));
PatchPcdSet32 (PcdFlashNvStorageFtwSpareBase, mInstance.MemBaseAddress +
PcdGet32 (PcdFlashNvStorageVariableSize) +
PcdGet32 (PcdFlashNvStorageFtwWorkingSize));
Status = gMmst->MmInstallProtocolInterface (
&mInstance.Handle,
&gEfiSmmFirmwareVolumeBlockProtocolGuid,
EFI_NATIVE_INTERFACE,
&mInstance.FvbProtocol
);
ASSERT_EFI_ERROR (Status);
DEBUG ((DEBUG_INFO, "%a: Register OP-TEE RPMB Fvb\n", __FUNCTION__));
DEBUG ((DEBUG_INFO, "%a: Using NV store FV in-memory copy at 0x%lx\n",
__FUNCTION__, PatchPcdGet32 (PcdFlashNvStorageVariableBase)));
return Status;
}
|