IntelFsp2Pkg/SplitFspBin.py: Support rebasing 1.x binary.
[mirror_edk2.git] / IntelFsp2Pkg / Tools / UserManuals / SplitFspBinUserManual.md
1 # SplitFspBin.py is a python script to support some operations on Intel FSP 1.x/2.x image.\r
2 \r
3 It supports:\r
4 \r
5 - Split Intel FSP 2.x image into individual FSP-T/M/S/O component\r
6 \r
7 - Rebase Intel FSP 1.x/2.x components to different base addresses\r
8 \r
9 - Generate Intel FSP 1.x/2.x C header file\r
10 \r
11 - Display Intel FSP 1.x/2.x information header for each FSP component\r
12 \r
13 ## Split Intel FSP 2.x image\r
14 \r
15 FSP 1.x image is not supported by split command.\r
16 To split individual FSP component in Intel FSP 2.x image, the following\r
17 command can be used:\r
18 \r
19    **python SplitFspBin.py split [-h] -f FSPBINARY [-o OUTPUTDIR] [-n NAMETEMPLATE]**\r
20 \r
21 For example:\r
22 \r
23    `python SplitFspBin.py split -f FSP.bin`\r
24 \r
25    It will create FSP_T.bin, FSP_M.bin and FSP_S.bin in current directory.\r
26 \r
27 ## Rebase Intel FSP 1.x/2.x components\r
28 \r
29 To rebase one or multiple FSP components in Intel FSP 1.x/2.x image, the following\r
30 command can be used:\r
31 \r
32    **python SplitFspBin.py rebase [-h] -f FSPBINARY -c {t,m,s,o} [{t,m,s,o} ...] -b FSPBASE [FSPBASE ...] [-o OUTPUTDIR] [-n OUTPUTFILE]**\r
33 \r
34 For example:\r
35 \r
36    `python SplitFspBin.py rebase -f FSP.bin -c t -b 0xFFF00000 -n FSP_new.bin`\r
37 \r
38    It will rebase FSP-T component inside FSP.bin to new base 0xFFF00000 and save the\r
39    rebased Intel FSP 2.x image into file FSP_new.bin.\r
40    For FSP 1.x image there is only one component in binary so above command also\r
41    works for FSP 1.x image.\r
42 \r
43    `python SplitFspBin.py rebase -f FSP.bin -c t m -b 0xFFF00000 0xFEF80000 -n FSP_new.bin`\r
44 \r
45    It will rebase FSP-T and FSP-M components inside FSP.bin to new base 0xFFF00000\r
46    and 0xFEF80000 respectively, and save the rebased Intel FSP 2.x image into file\r
47    FSP_new.bin file.\r
48 \r
49 ## Generate Intel FSP 1.x/2.x C header file\r
50 \r
51 To generate Intel FSP 1.x/2.x C header file, the following command can be used:\r
52 \r
53    **Python SplitFspBin.py genhdr [-h] -f FSPBINARY [-o OUTPUTDIR] [-n HFILENAME]**\r
54 \r
55 For example:\r
56 \r
57    `python SplitFspBin.py genhdr -f FSP.bin -n FSP.h`\r
58 \r
59    It will create the C header file FSP.h containing the image ID, revision, offset\r
60    and size for each individual FSP component.\r
61 \r
62 ## Display Intel FSP 1.x/2.x information header\r
63 \r
64 To display Intel FSP 1.x/2.x information headers, the following command can be used:\r
65 \r
66    **Python SplitFspBin.py info [-h] -f FSPBINARY**\r
67 \r
68 For example:\r
69 \r
70    `python SplitFspBin.py info -f FSP.bin`\r
71 \r
72    It will print out the FSP information header for each FSP component.\r