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
|
/*++
Copyright (c) 2004 - 2008, 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
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.
Module Name:
Fvb.c
Abstract:
Firmware Volume Block Protocol Runtime Abstraction
mFvbEntry is an array of Handle Fvb pairs. The Fvb Lib Instance matches the
index in the mFvbEntry array. This should be the same sequence as the FVB's
were described in the HOB. We have to remember the handle so we can tell if
the protocol has been reinstalled and it needs updateing.
If you are using any of these lib functions.you must first call FvbInitialize ().
Key:
FVB - Firmware Volume Block
--*/
#include "Tiano.h"
#include "EfiRuntimeLib.h"
#include EFI_PROTOCOL_DEFINITION (FirmwareVolumeBlock)
#include EFI_PROTOCOL_DEFINITION (FvbExtension)
//
// Lib will ASSERT if more FVB devices than this are added to the system.
//
UINTN mFvbCount;
VOID *mFvbRegistration;
VOID *mFvbExtRegistration;
//static EFI_EVENT mEfiFvbVirtualNotifyEvent;
BOOLEAN gEfiFvbInitialized = FALSE;
EFI_EVENT mFvbEvent;
BOOLEAN
IsMemoryRuntime (
IN VOID *Address
)
/*++
Routine Description:
Check whether an address is runtime memory or not.
Arguments:
Address - The Address being checked.
Returns:
TRUE - The address is runtime memory.
FALSE - The address is not runtime memory.
--*/
{
EFI_STATUS Status;
UINT8 TmpMemoryMap[1];
UINTN MapKey;
UINTN DescriptorSize;
UINT32 DescriptorVersion;
UINTN MemoryMapSize;
EFI_MEMORY_DESCRIPTOR *MemoryMap;
EFI_MEMORY_DESCRIPTOR *MemoryMapPtr;
BOOLEAN IsRuntime;
UINTN Index;
IsRuntime = FALSE;
//
// Get System MemoryMapSize
//
MemoryMapSize = 1;
Status = gBS->GetMemoryMap (
&MemoryMapSize,
(EFI_MEMORY_DESCRIPTOR *)TmpMemoryMap,
&MapKey,
&DescriptorSize,
&DescriptorVersion
);
ASSERT (Status == EFI_BUFFER_TOO_SMALL);
//
// Enlarge space here, because we will allocate pool now.
//
MemoryMapSize += EFI_PAGE_SIZE;
Status = gBS->AllocatePool (
EfiBootServicesData,
MemoryMapSize,
(VOID**)&MemoryMap
);
ASSERT_EFI_ERROR (Status);
//
// Get System MemoryMap
//
Status = gBS->GetMemoryMap (
&MemoryMapSize,
MemoryMap,
&MapKey,
&DescriptorSize,
&DescriptorVersion
);
ASSERT_EFI_ERROR (Status);
MemoryMapPtr = MemoryMap;
//
// Search the request Address
//
for (Index = 0; Index < (MemoryMapSize / DescriptorSize); Index++) {
if (((EFI_PHYSICAL_ADDRESS)(UINTN)Address >= MemoryMap->PhysicalStart) &&
((EFI_PHYSICAL_ADDRESS)(UINTN)Address < MemoryMap->PhysicalStart
+ LShiftU64 (MemoryMap->NumberOfPages, EFI_PAGE_SHIFT))) {
//
// Found it
//
if (MemoryMap->Attribute & EFI_MEMORY_RUNTIME) {
IsRuntime = TRUE;
}
break;
}
//
// Get next item
//
MemoryMap = (EFI_MEMORY_DESCRIPTOR *)((UINTN)MemoryMap + DescriptorSize);
}
//
// Done
//
gBS->FreePool (MemoryMapPtr);
return IsRuntime;
}
VOID
EFIAPI
FvbNotificationFunction (
IN EFI_EVENT Event,
IN VOID *Context
)
/*++
Routine Description:
Update mFvbEntry. Add new entry, or update existing entry if Fvb protocol is
reinstalled.
Arguments:
Event - The Event that is being processed
Context - Event Context
Returns:
None
--*/
{
EFI_STATUS Status;
UINTN BufferSize;
EFI_HANDLE Handle;
UINTN Index;
UINTN UpdateIndex;
EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;
EFI_FVB_EXTENSION_PROTOCOL *FvbExtension;
while (TRUE) {
BufferSize = sizeof (Handle);
Status = gBS->LocateHandle (
ByRegisterNotify,
&gEfiFirmwareVolumeBlockProtocolGuid,
mFvbRegistration,
&BufferSize,
&Handle
);
if (EFI_ERROR (Status)) {
//
// Exit Path of While Loop....
//
break;
}
UpdateIndex = MAX_FVB_COUNT;
for (Index = 0; Index < mFvbCount; Index++) {
if (mFvbEntry[Index].Handle == Handle) {
//
// If the handle is already in the table just update the protocol
//
UpdateIndex = Index;
break;
}
}
if (UpdateIndex == MAX_FVB_COUNT) {
//
// Use the next free slot for a new entry
//
UpdateIndex = mFvbCount;
}
//
// The array does not have enough entries
//
ASSERT (UpdateIndex < MAX_FVB_COUNT);
//
// Get the interface pointer and if it's ours, skip it.
// We check Runtime here, because it has no reason to register
// a boot time FVB protocol.
//
Status = gBS->HandleProtocol (Handle, &gEfiFirmwareVolumeBlockProtocolGuid, (VOID **) &Fvb);
ASSERT_EFI_ERROR (Status);
if (IsMemoryRuntime (Fvb)) {
//
// Increase mFvbCount if we need to add a new entry
//
if (UpdateIndex == mFvbCount) {
mFvbCount++;
}
mFvbEntry[UpdateIndex].Handle = Handle;
mFvbEntry[UpdateIndex].Fvb = Fvb;
mFvbEntry[UpdateIndex].FvbExtension = NULL;
Status = gBS->HandleProtocol (Handle, &gEfiFvbExtensionProtocolGuid, (VOID **) &FvbExtension);
if ((Status == EFI_SUCCESS) && IsMemoryRuntime (FvbExtension)) {
mFvbEntry[UpdateIndex].FvbExtension = FvbExtension;
}
}
}
}
EFI_STATUS
EfiFvbInitialize (
VOID
)
/*++
Routine Description:
Initialize globals and register Fvb Protocol notification function.
Arguments:
None
Returns:
EFI_SUCCESS - Fvb is successfully initialized
others - Fail to initialize
--*/
{
UINTN Status;
mFvbCount = 0;
Status = gBS->AllocatePool (
EfiRuntimeServicesData,
(UINTN) sizeof (FVB_ENTRY) * MAX_FVB_COUNT,
(VOID *) &mFvbEntry
);
if (EFI_ERROR (Status)) {
return Status;
}
EfiZeroMem (mFvbEntry, sizeof (FVB_ENTRY) * MAX_FVB_COUNT);
mFvbEvent = RtEfiLibCreateProtocolNotifyEvent (
&gEfiFirmwareVolumeBlockProtocolGuid,
EFI_TPL_CALLBACK,
FvbNotificationFunction,
NULL,
&mFvbRegistration
);
//
// Register SetVirtualAddressMap () notify function
//
// Status = gBS->CreateEvent (
// EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,
// EFI_TPL_NOTIFY,
// EfiRuntimeLibFvbVirtualNotifyEvent,
// NULL,
// &mEfiFvbVirtualNotifyEvent
// );
// ASSERT_EFI_ERROR (Status);
//
gEfiFvbInitialized = TRUE;
return EFI_SUCCESS;
}
EFI_STATUS
EfiFvbShutdown (
VOID
)
/*++
Routine Description:
Release resources allocated in EfiFvbInitialize.
Arguments:
None
Returns:
EFI_SUCCESS
--*/
{
gBS->FreePool ((VOID *) mFvbEntry);
gBS->CloseEvent (mFvbEvent);
gEfiFvbInitialized = FALSE;
return EFI_SUCCESS;
}
//
// The following functions wrap Fvb protocol in the Runtime Lib functions.
// The Instance translates into Fvb instance. The Fvb order defined by HOBs and
// thus the sequence of FVB protocol addition define Instance.
//
// EfiFvbInitialize () must be called before any of the following functions
// must be called.
//
EFI_STATUS
EfiFvbReadBlock (
IN UINTN Instance,
IN EFI_LBA Lba,
IN UINTN Offset,
IN OUT UINTN *NumBytes,
IN UINT8 *Buffer
)
/*++
Routine Description:
Reads specified number of bytes into a buffer from the specified block
Arguments:
Instance - The FV instance to be read from
Lba - The logical block address to be read from
Offset - Offset into the block at which to begin reading
NumBytes - Pointer that on input contains the total size of
the buffer. On output, it contains the total number
of bytes read
Buffer - Pointer to a caller allocated buffer that will be
used to hold the data read
Returns:
Status code
EFI_INVALID_PARAMETER - invalid parameter
--*/
{
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
return mFvbEntry[Instance].Fvb->Read (mFvbEntry[Instance].Fvb, Lba, Offset, NumBytes, Buffer);
}
EFI_STATUS
EfiFvbWriteBlock (
IN UINTN Instance,
IN EFI_LBA Lba,
IN UINTN Offset,
IN OUT UINTN *NumBytes,
IN UINT8 *Buffer
)
/*++
Routine Description:
Writes specified number of bytes from the input buffer to the block
Arguments:
Instance - The FV instance to be written to
Lba - The starting logical block index to write to
Offset - Offset into the block at which to begin writing
NumBytes - Pointer that on input contains the total size of
the buffer. On output, it contains the total number
of bytes actually written
Buffer - Pointer to a caller allocated buffer that contains
the source for the write
Returns:
Status code
EFI_INVALID_PARAMETER - invalid parameter
--*/
{
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
return mFvbEntry[Instance].Fvb->Write (mFvbEntry[Instance].Fvb, Lba, Offset, NumBytes, Buffer);
}
EFI_STATUS
EfiFvbEraseBlock (
IN UINTN Instance,
IN EFI_LBA Lba
)
/*++
Routine Description:
Erases and initializes a firmware volume block
Arguments:
Instance - The FV instance to be erased
Lba - The logical block index to be erased
Returns:
Status code
EFI_INVALID_PARAMETER - invalid parameter
--*/
{
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
return mFvbEntry[Instance].Fvb->EraseBlocks (mFvbEntry[Instance].Fvb, Lba, -1);
}
EFI_STATUS
EfiFvbGetVolumeAttributes (
IN UINTN Instance,
OUT EFI_FVB_ATTRIBUTES *Attributes
)
/*++
Routine Description:
Retrieves attributes, insures positive polarity of attribute bits, returns
resulting attributes in output parameter
Arguments:
Instance - The FV instance whose attributes is going to be
returned
Attributes - Output buffer which contains attributes
Returns:
Status code
EFI_INVALID_PARAMETER - invalid parameter
--*/
{
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
return mFvbEntry[Instance].Fvb->GetVolumeAttributes (mFvbEntry[Instance].Fvb, Attributes);
}
EFI_STATUS
EfiFvbSetVolumeAttributes (
IN UINTN Instance,
IN EFI_FVB_ATTRIBUTES Attributes
)
/*++
Routine Description:
Modifies the current settings of the firmware volume according to the
input parameter.
Arguments:
Instance - The FV instance whose attributes is going to be
modified
Attributes - It is a pointer to EFI_FVB_ATTRIBUTES
containing the desired firmware volume settings.
Returns:
Status code
EFI_INVALID_PARAMETER - invalid parameter
--*/
{
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
return mFvbEntry[Instance].Fvb->SetVolumeAttributes (mFvbEntry[Instance].Fvb, &Attributes);
}
EFI_STATUS
EfiFvbGetPhysicalAddress (
IN UINTN Instance,
OUT EFI_PHYSICAL_ADDRESS *BaseAddress
)
/*++
Routine Description:
Retrieves the physical address of a memory mapped FV
Arguments:
Instance - The FV instance whose base address is going to be
returned
BaseAddress - Pointer to a caller allocated EFI_PHYSICAL_ADDRESS
that on successful return, contains the base address
of the firmware volume.
Returns:
Status code
EFI_INVALID_PARAMETER - invalid parameter
--*/
{
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
return mFvbEntry[Instance].Fvb->GetPhysicalAddress (mFvbEntry[Instance].Fvb, BaseAddress);
}
EFI_STATUS
EfiFvbGetBlockSize (
IN UINTN Instance,
IN EFI_LBA Lba,
OUT UINTN *BlockSize,
OUT UINTN *NumOfBlocks
)
/*++
Routine Description:
Retrieve the size of a logical block
Arguments:
Instance - The FV instance whose block size is going to be
returned
Lba - Indicates which block to return the size for.
BlockSize - A pointer to a caller allocated UINTN in which
the size of the block is returned
NumOfBlocks - a 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
Returns:
EFI_SUCCESS - The firmware volume was read successfully and
contents are in Buffer
EFI_INVALID_PARAMETER - invalid parameter
--*/
{
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
return mFvbEntry[Instance].Fvb->GetBlockSize (mFvbEntry[Instance].Fvb, Lba, BlockSize, NumOfBlocks);
}
EFI_STATUS
EfiFvbEraseCustomBlockRange (
IN UINTN Instance,
IN EFI_LBA StartLba,
IN UINTN OffsetStartLba,
IN EFI_LBA LastLba,
IN UINTN OffsetLastLba
)
/*++
Routine Description:
Erases and initializes a specified range of a firmware volume
Arguments:
Instance - The FV instance to be erased
StartLba - The starting logical block index to be erased
OffsetStartLba - Offset into the starting block at which to
begin erasing
LastLba - The last logical block index to be erased
OffsetLastLba - Offset into the last block at which to end erasing
Returns:
Status code
EFI_INVALID_PARAMETER - invalid parameter
EFI_UNSUPPORTED - not support
--*/
{
if (Instance >= mFvbCount) {
return EFI_INVALID_PARAMETER;
}
if (!(mFvbEntry[Instance].FvbExtension)) {
return EFI_UNSUPPORTED;
}
if (!(mFvbEntry[Instance].FvbExtension->EraseFvbCustomBlock)) {
return EFI_UNSUPPORTED;
}
return mFvbEntry[Instance].FvbExtension->EraseFvbCustomBlock (
mFvbEntry[Instance].FvbExtension,
StartLba,
OffsetStartLba,
LastLba,
OffsetLastLba
);
}
|