2 **_PatchFv.py_** - The python script that patches the firmware volumes (**FV**)
3 with in the flash device (**FD**) file post FSP build.
8 PatchFv FvBuildDir [FvFileBaseNames:]FdFileBaseNameToPatch ["Offset, Value"]+
9 | ["Offset, Value, @Comment"]+
10 | ["Offset, Value, $Command"]+
11 | ["Offset, Value, $Command, @Comment"]+
15 The **_PatchFv.py_** tool allows the developer to fix up FD images to follow the
16 Intel FSP Architecture specification. It also makes the FD image relocatable.
17 The tool is written in Python and uses Python 2.7 or later to run.
18 Consider using the tool in a build script.
20 #FvBuildDir (Argument 1)
21 This is the first argument that **_PatchFv.py_** requires. It is the build
22 directory for all firmware volumes created during the FSP build. The path must
23 be either an absolute path or a relevant path, relevant to the top level of the
28 Build\YouPlatformFspPkg\%BD_TARGET%_%VS_VERSION%%VS_X86%\FV
31 The example used contains Windows batch script %VARIABLES%.
33 #FvFileBaseNames (Argument 2: 0ptional Part 1)
34 The firmware volume file base names (**_FvFileBaseNames_**) are the independent
35 Fv?s that are to be patched within the FD. (0 or more in the form
36 **FVFILEBASENAME:**) The colon **:** is used for delimiting the single
37 argument and must be appended to the end of each (**_FvFileBaseNames_**).
41 STAGE1:STAGE2:MANIFEST:YOURPLATFORM
44 In the example **STAGE1** is **STAGE1.Fv** in **YOURPLATFORM.fd**.
46 # FdFileNameToPatch (Argument 2: Mandatory Part 2)
48 Firmware device file name to patch (**_FdFileNameToPatch_**) is the base name of
49 the FD file that is to be patched. (1 only, in the form **YOURPLATFORM**)
53 STAGE1:STAGE2:MANIFEST:YOURPLATFORM
56 In the example **YOURPLATFORM** is from **_YOURPLATFORM.fd_**
58 #"Offset, Value[, Command][, Comment]" (Argument 3)
59 The **_Offset_** can be a positive or negative number and represents where the
60 **_Value_** to be patched is located within the FD. The **_Value_** is what
61 will be written at the given **_Offset_** in the FD. Constants may be used for
62 both offsets and values. Also, this argument handles expressions for both
63 offsets and values using these operators:
66 = - * & | ~ ( ) [ ] { } < >
69 The entire argument includes the quote marks like in the example argument below:
72 0xFFFFFFC0, SomeCore:__EntryPoint - [0x000000F0],@SomeCore Entry
76 Hexadecimal (use **0x** as prefix) | Decimal
80 | **Positive Hex** | **Negative Hex** | **Positive Decimal** | **Negative Decimal** |
81 | ---------------: | ---------------: | -------------------: | -------------------: |
82 | 0x000000BC | 0xFFFFFFA2 | 188 | -94 |
85 ModuleName:FunctionName | ModuleName:GlobalVariableName
99 ( ) Evaluation control
100 [ ] Get a DWord value at the specified offset expression from [expr]
101 { } Convert an offset {expr} into an absolute address (FSP_BASE + expr)
102 < > Convert absolute address <expr> into an image offset (expr & FSP_SIZE)
107 Special commands must use the **$** symbol as a prefix to the command itself.
108 There is only one command available at this time.
111 $COPY ? Copy a binary block from source to destination.
117 0x94, [PlatformInit:__gPcd_BinPatch_FvRecOffset] + 0x94, [0x98], $COPY, @Sync up 2nd FSP Header
121 Comments are allowed in the **Offset, Value [, Comment]** argument. Comments
122 must use the **@** symbol as a prefix. The comment will output to the build
123 window upon successful completion of patching along with the offset and value data.