IntelFsp2Pkg/SplitFspBin.py: Revert FSP 1.x support.

[mirror_edk2.git] / IntelFsp2Pkg / Tools / UserManuals / SplitFspBinUserManual.md

# SplitFspBin.py is a python script to support some operations on Intel FSP 2.0 image.\r
\r
It supports:\r
\r
- Split Intel FSP 2.0 image into individual FSP-T/M/S/O component\r
\r
- Rebase Intel FSP 2.0 components to different base addresses\r
\r
- Generate Intel FSP 2.0 C header file\r
\r
- Display Intel FSP 2.0 information header for each FSP component\r
\r
## Split Intel FSP 2.0 image\r
\r
To split individual FSP component in Intel FSP 2.0 image, the following\r
command can be used:\r
\r
   **python SplitFspBin.py split [-h] -f FSPBINARY [-o OUTPUTDIR] [-n NAMETEMPLATE]**\r
\r
For example:  \r
\r
   `python SplitFspBin.py split -f FSP.bin`\r
\r
   It will create FSP_T.bin, FSP_M.bin and FSP_S.bin in current directory.\r
\r
## Rebase Intel FSP 2.0 components\r
\r
To rebase one or multiple FSP components in Intel FSP 2.0 image, the following\r
command can be used:\r
\r
   **python SplitFspBin.py rebase [-h] -f FSPBINARY -c {t,m,s,o} [{t,m,s,o} ...] -b FSPBASE [FSPBASE ...] [-o OUTPUTDIR] [-n OUTPUTFILE]**\r
\r
For example:  \r
\r
   `python SplitFspBin.py rebase -f FSP.bin –c t –b 0xFFF00000 –n FSP_new.bin`\r
\r
   It will rebase FSP-T component inside FSP.bin to new base 0xFFF00000 and save the\r
   rebased Intel FSP 2.0 image into file FSP_new.bin.\r
\r
   `python SplitFspBin.py rebase -f FSP.bin –c t m –b 0xFFF00000 0xFEF80000 –n FSP_new.bin`\r
\r
   It will rebase FSP-T and FSP-M components inside FSP.bin to new base 0xFFF00000\r
   and 0xFEF80000 respectively, and save the rebased Intel FSP 2.0 image into file \r
   FSP_new.bin file.\r
\r
## Generate Intel FSP 2.0 C header file\r
\r
To generate Intel FSP 2.0 C header file, the following command can be used:\r
\r
   **Python SplitFspBin.py genhdr [-h] -f FSPBINARY [-o OUTPUTDIR] [-n HFILENAME]**\r
\r
For example:  \r
\r
   `python SplitFspBin.py genhdr -f FSP.bin –n FSP.h`\r
\r
   It will create the C header file FSP.h containing the image ID, revision, offset\r
   and size for each individual FSP component.\r
\r
## Display Intel FSP 2.0 information header\r
\r
To display Intel FSP 2.0 information headers, the following command can be used:\r
\r
   **Python SplitFspBin.py info [-h] -f FSPBINARY**\r
\r
For example:  \r
\r
   `python SplitFspBin.py info -f FSP.bin`\r
\r
   It will print out the FSP information header for each FSP component.\r