1 files changed, 66 insertions, 0 deletions
diff --git a/src/build/tools/README b/src/build/tools/README
new file mode 100644
index 00000000..3f27a6b0
--- /dev/null
+++ b/src/build/tools/README
@@ -0,0 +1,66 @@
+--------------------
+CONTENT OF THIS FILE
+--------------------
+1. Tools:
+   * Automate SBE Image integration into FIPS driver
+   * Developer SBE fips tool for copy and compile
+
+
+-------------------------------------------------
+* Automate SBE Image integration into FIPS driver
+-------------------------------------------------
+  [ Files ]   : CommitSbeImageToCMVC.py (Main)  
+                sbeCmvcConstants.py 
+                sbeCmvcUtility.py
+
+  [ Brief ]   : This tool will check in the SBE FW fips files to CMVC, Fix Complete the track and trigger Jenkin Job.
+
+  [ Feature ] :
+              - By default, the tool will check in the files from a default list pre-defined for sbe 
+                Refer: sbeCmvcConstants.py
+
+              - User can selectively choose which file/files it wants to upload to CMVC from the default list
+
+              - The tool roll backs all the checkout/checkin in case of CMVC Operation failure
+
+              - The tool will auto complete fix record on completion of successful code check in 
+
+              - The internal of the work flow validates the Hash of the files on the SBE repo vs files to be
+                check in to be sure that the files are correctly uploaded
+
+              - The pre-req checks CMVC bash env and CMVC access session availability and provides verbose 
+                help to follow on failures
+
+              - Jenkin job trigger at the end after fix completing record.
+
+
+------------------------------------------------------------------
+* Developer SBE fips tool for copy,compile & simics action patches
+------------------------------------------------------------------
+
+  [ Files ]   : sbeDistribute.py (Main)
+                sbePatchUtility.py
+                sbeCmvcConstants.py
+                sbeCmvcUtility.py
+
+  [ Brief ]   : This tool will copy the SBFW files from PPE repo to fips sandbox and compile.
+                Additionaly it would patch the simics action files at the end of compilation.
+
+  [ Feature ] :
+              - By default, the tool doesn't need any input as an argument
+
+              - Refers the Sandbox and Repo ENV and identifies which fips sandbox and PPE Repo needed.
+
+              - Find the list of pre-define file list in the PPE repo and copies to fips sandbox
+                Refer: sbeCmvcConstants.py
+
+              - Loads the ENV and compiles the fips sandbox code.
+
+              - User can create a fips sandbox manually and still use this tool by passing -s <sandbox name >
+                as an argument
+
+              - User can specify file as an input but -ONLY- those pre-define files selectively using option
+                -i <file1,file2>
+
+              - Sets up simics directory and patches the action files needed.
+