Added makefile support for writer utilities
[keystone-rtos/mcsdk-tools.git] / writer / eeprom / docs / README.txt
1 EEPROM Writer Utility
3 EEPROM Writer is a simple utility to program a CCS format image/data file to I2C EEPROM.
5 Steps to program the EEPROM:
7 1. Be sure to set the boot mode dip switch to no boot/EMIF16 boot mode on the EVM. 
9 2. Copy the CCS format data file to writer\eeprom\evmc66xxl\bin directory, and rename it to app.dat.
11 3. Change the file_name, bus_addr, start_addr and swap_data in writer\eeprom\evmc66xxl\bin\eepromwriter_input.txt if necessary. 
12    By default the EEPROM writer will load app.dat to DSP memory and write the data to I2C slave
13    bus address 81 (0x51) at EEPROM device start byte address 0 with data swap disabled (0).
15 4. Open CCSv5 and launch the evmc66xx emulator target configuration and connect to core 0.
17 5. Load the program writer\eeprom\evmc66xxl\bin\eepromwriter_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.dat to 0x80000000:
23      * In CCSv5, right click mouse in memory window, select "load memory".
24      * Browse and select writer\eeprom\evmc66xxl\bin\app.dat.
25      * Select the option "Use the file header information to set the start address and size of the memory block to be 
26        loaded" and click "next".
27      * Change the Start Address to "0x80000000" if it is not 0x80000000, and click "finish".
29 8.After the data file is loaded into the memory, run the program (in CCSv5, press F8), it will start to program the 
30    EEPROM.
32 9.When programming is completed, the console will print "EEPROM programming completed successfully", if there
33    is any error, the console will show the error message.
36 Steps to re-build eepromwriter:
38 1. Import the eepromwriter CCS project from writer\eeprom\evmc66xxl directory (in CCSv5, Project->Import Existing CCS/
39    CCE Eclipse Projects).
41 2. Clean and build the eepromwriter project.
43 3. After the project build is completed, eepromwriter_evm66xxl.out and eepromwriter_evm66xxl.map will be generated under 
44    writer\eeprom\evmc66xxl\bin directory.
46 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.