]> git.proxmox.com Git - mirror_edk2.git/commitdiff
InterFsp2Pkg:Tool: Add user manual for SplitFspBin tool.
authorJiewen Yao <jiewen.yao@intel.com>
Wed, 15 Jun 2016 02:44:43 +0000 (10:44 +0800)
committerJiewen Yao <jiewen.yao@intel.com>
Thu, 16 Jun 2016 07:29:25 +0000 (15:29 +0800)
Besides Split FSP binary, we added some more feature to SplitFspBin tool.
Here we add user manual for it to describe all usage.

Cc: Giri P Mudusuru <giri.p.mudusuru@intel.com>
Cc: Maurice Ma <maurice.ma@intel.com>
Cc: Satya P Yarlagadda <satya.p.yarlagadda@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao <jiewen.yao@intel.com>
Reviewed-by: Giri P Mudusuru <giri.p.mudusuru@intel.com>
Reviewed-by: Maurice Ma <maurice.ma@intel.com>
IntelFsp2Pkg/Tools/UserManuals/SplitFspBinUserManual.md [new file with mode: 0644]

diff --git a/IntelFsp2Pkg/Tools/UserManuals/SplitFspBinUserManual.md b/IntelFsp2Pkg/Tools/UserManuals/SplitFspBinUserManual.md
new file mode 100644 (file)
index 0000000..064e0ac
--- /dev/null
@@ -0,0 +1,69 @@
+# 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