Added makefile support for writer utilities
[keystone-rtos/mcsdk-tools.git] / writer / nor / docs / README.txt
1 NOR Writer Utility
3 NOR Writer is a simple utility to program a CCS format image/data file to the NOR flash.
5 Steps to program the NOR:
7 1. Be sure to set the boot mode dip switch to no boot/EMIF16 boot mode on the EVM.
9 2. Copy the binary file to writer\nor\evmc66xxl\bin directory, and rename it to app.bin.
11 3. Change the file_name and start_addr in writer\nor\evmc66xxl\bin\norwriter_input.txt if necessary. 
12    By default the NOR writer will load app.bin to DSP memory and write the data to NOR device start byte address 0, 
13    the start_addr should always be set to the start byte addess of a sector.
15 4. Open CCSv5 and launch the evmc66xx emulator target configuration and connect to core 0.
17 5. Load the program writer\nor\evmc66xxl\bin\norwriter_evm66xxl.out to CCS, be sure evmc66xxl.gel is used in CCS 
18    and DDR is intialized.
20 6. Open the Memory view (in CCSv5, view->Memory Browser), and view the memory address 0x80000000.
22 7. Load app.bin to 0x80000000:
23      * In CCSv5, right click mouse in memory window, select "load memory".
24      * Browse and select writer\nor\evmc66xxl\bin\app.bin (raw data format), click "next"
25      * Set the Start Address to "0x80000000", Type-size to 32-bits, leave swap unchecked, click "finish"
28 8. After the binary file is loaded into the memory, run the program (in CCSv5, press F8), it will start to program the 
29    NOR.
31 9. When programming is completed, the console will print "NOR programming completed successfully", if there
32    is any error, the console will show the error message.
35 Steps to re-build norwriter:
37 1. Uses CCS to build norwriter:
38    * Import the norwriter CCS project from writer\nor\evmc66xxl directory (in CCSv5, Project->Import Existing CCS/
39    CCE Eclipse Projects).
40    * Clean and build the norwriter project.
41    * After the project build is completed, norwriter_evm66xxl.out and norwriter_evm66xxl.map will be generated under 
42      writer\nor\evmc66xxl\bin directory.
44 2. Uses Makefile to build norwriter:
45    NOTE FOR BUILDING ON WINDOWS ENVIRONMENT: For building on windows environment GNU utilities like
46    "make" would be required. The following build procedure should also work on MINGW-MSYS Bourne shell.
48     Before starting the build following environment setup has to be done 
49     1) variable C_DIR should be set to the top directory of the Code Generation tools e.g.
50        Linux bash shell: 
51           export C_DIR=/opt/TI/TI_CGT_C6000_7.2.0A10232/
52        MSYS bash shell: 
53           export C_DIR='"C:/Program Files/Texas Instruments/ccsv5/tools/compiler/c6000"'
54     2) Code Generation tool binaries should be in the path e.g.
55        Linux bash shell: 
56           export PATH=/opt/TI/TI_CGT_C6000_7.2.0A10232/bin:$PATH
57        MSYS bash shell: 
58           export PATH=$PATH:/c/Program\ Files/Texas\ Instruments/ccsv5/tools/compiler/c6000/bin/
59     3) variable PFORM_LIB_DIR should be set the directory of the Platform Library root, e.g.
60        Linux bash shell: 
61           export PFORM_LIB_DIR=pdk_C6670_1_0_0_10-rc1/packages/ti/platform
62        MSYS bash shell: 
63           export PFORM_LIB_DIR='"C:/Program Files/Texas Instruments/pdk_C667x_1_0_0_10-rc1/packages/ti/platform"'
65     The makefile for building the norwriter is in the directory "tools/writer/nor/evmc66xxl"
66     Following are the steps to build norwriter, e.g.:
67     cd tools/writer/nor/evmc66xxl
68     make DEVICE=<device number>
69         supported device numbers are 
70             C6678
71             C6670
73 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.