Added makefile support for writer utilities

[keystone-rtos/mcsdk-tools.git] / writer / eeprom / docs / README.txt

diff --git a/writer/eeprom/docs/README.txt b/writer/eeprom/docs/README.txt
index ba45959da5de79f8fdb818267ce04217977fac11..bdcc488b56016d9c4ddfd55730421bfbf95b7227 100644 (file)
--- a/writer/eeprom/docs/README.txt
+++ b/writer/eeprom/docs/README.txt
@@ -35,12 +35,40 @@ Steps to program the EEPROM:
 
 Steps to re-build eepromwriter:
 
-1. Import the eepromwriter CCS project from writer\eeprom\evmc66xxl directory (in CCSv5, Project->Import Existing CCS/
+1. Uses CCS to build eepromwriter:
+   * Import the eepromwriter CCS project from writer\eeprom\evmc66xxl directory (in CCSv5, Project->Import Existing CCS/
    CCE Eclipse Projects).
-
-2. Clean and build the eepromwriter project.
-
-3. After the project build is completed, eepromwriter_evm66xxl.out and eepromwriter_evm66xxl.map will be generated under 
-   writer\eeprom\evmc66xxl\bin directory.
+   * Clean and build the eepromwriter project.
+   * After the project build is completed, eepromwriter_evm66xxl.out and eepromwriter_evm66xxl.map will be generated under 
+     writer\eeprom\evmc66xxl\bin directory.
+
+2. Uses Makefile to build eepromwriter:
+   NOTE FOR BUILDING ON WINDOWS ENVIRONMENT: For building on windows environment GNU utilities like
+   "make" would be required. The following build procedure should also work on MINGW-MSYS Bourne shell.
+
+    Before starting the build following environment setup has to be done 
+    1) variable C_DIR should be set to the top directory of the Code Generation tools e.g.
+       Linux bash shell: 
+          export C_DIR=/opt/TI/TI_CGT_C6000_7.2.0A10232/
+       MSYS bash shell: 
+          export C_DIR='"C:/Program Files/Texas Instruments/ccsv5/tools/compiler/c6000"'
+    2) Code Generation tool binaries should be in the path e.g.
+       Linux bash shell: 
+          export PATH=/opt/TI/TI_CGT_C6000_7.2.0A10232/bin:$PATH
+       MSYS bash shell: 
+          export PATH=$PATH:/c/Program\ Files/Texas\ Instruments/ccsv5/tools/compiler/c6000/bin/
+    3) variable PFORM_LIB_DIR should be set the directory of the Platform Library root, e.g.
+       Linux bash shell: 
+          export PFORM_LIB_DIR=pdk_C6670_1_0_0_10-rc1/packages/ti/platform
+       MSYS bash shell: 
+          export PFORM_LIB_DIR='"C:/Program Files/Texas Instruments/pdk_C6670_1_0_0_10-rc1/packages/ti/platform"'
+
+    The makefile for building the eepromwriter is in the directory "tools/writer/eeprom/evmc66xxl"
+    Following are the steps to build eepromwriter, e.g.:
+    cd tools/writer/eeprom/evmc66xxl
+    make DEVICE=<device number>
+        supported device numbers are 
+            C6678
+            C6670
 
 Please refer to BIOS MCSDK 2.0 User's Guide (http://processors.wiki.ti.com/index.php/BIOS_MCSDK_2.0_User_Guide) for more details.
\ No newline at end of file