Re: [edk2] [PATCH] InterFsp2Pkg:Tool: Add user manual for SplitFspBin tool.

2016-06-15 Thread Mudusuru, Giri P 
Thank you for adding the user manual for this new tool in .md format.

Reviewed-by: Giri P Mudusuru 


-Original Message-
From: Ma, Maurice 
Sent: Wednesday, June 15, 2016 8:18 AM
To: Yao, Jiewen 
Cc: Mudusuru, Giri P ; Yarlagadda, Satya P 
; edk2-devel@lists.01.org
Subject: RE: [PATCH] InterFsp2Pkg:Tool: Add user manual for SplitFspBin tool.

It looks good to me. 
Reviewed by: Maurice Ma 

Thanks
Maurice

-Original Message-
From: Yao, Jiewen
Sent: Tuesday, June 14, 2016 7:47 PM
To: edk2-devel@lists.01.org
Cc: Mudusuru, Giri P; Ma, Maurice; Yarlagadda, Satya P
Subject: [PATCH] InterFsp2Pkg:Tool: Add user manual for SplitFspBin tool.

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 
Cc: Maurice Ma 
Cc: Satya P Yarlagadda 
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao 
---
 .../Tools/UserManuals/SplitFspBinUserManual.md | 69 ++
 1 file changed, 69 insertions(+)
 create mode 100644 IntelFsp2Pkg/Tools/UserManuals/SplitFspBinUserManual.md

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

___
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Re: [edk2] [PATCH] InterFsp2Pkg:Tool: Add user manual for SplitFspBin tool.

2016-06-15 Thread Ma, Maurice 
It looks good to me. 
Reviewed by: Maurice Ma 

Thanks
Maurice

-Original Message-
From: Yao, Jiewen 
Sent: Tuesday, June 14, 2016 7:47 PM
To: edk2-devel@lists.01.org
Cc: Mudusuru, Giri P; Ma, Maurice; Yarlagadda, Satya P
Subject: [PATCH] InterFsp2Pkg:Tool: Add user manual for SplitFspBin tool.

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 
Cc: Maurice Ma 
Cc: Satya P Yarlagadda 
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao 
---
 .../Tools/UserManuals/SplitFspBinUserManual.md | 69 ++
 1 file changed, 69 insertions(+)
 create mode 100644 IntelFsp2Pkg/Tools/UserManuals/SplitFspBinUserManual.md

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

___
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

[edk2] [PATCH] InterFsp2Pkg:Tool: Add user manual for SplitFspBin tool.

2016-06-14 Thread Jiewen Yao 
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 
Cc: Maurice Ma 
Cc: Satya P Yarlagadda 
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jiewen Yao 
---
 .../Tools/UserManuals/SplitFspBinUserManual.md | 69 ++
 1 file changed, 69 insertions(+)
 create mode 100644 IntelFsp2Pkg/Tools/UserManuals/SplitFspBinUserManual.md

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

___
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel