update to Platform Library 00.06: header file updates
[keystone-rtos/mcsdk-tools.git] / writer / qspi_flash / docs / README.txt
1 QSPI flash Writer Utility\r
2 \r
3 QSPI flash Writer is a simple utility to program a CCS format image/data file to the QSPI flash.\r
4 \r
5 Steps to program the QSPI flash:\r
6 \r
7 1. Be sure to set the boot mode dip switch to no boot/EMIF16 boot mode on the EVM.\r
8 \r
9 2. Copy the binary file to writer\qspi_flash\evmxxxx\bin directory, and rename it to app.bin.\r
10 \r
11 3. Change the file_name and start_addr in writer\qspi_flash\evmxxxx\bin\qspi_flash_writer_input.txt if necessary. \r
12    By default the QSPI flash writer will load app.bin to DSP memory and write the data to QSPI flash device start byte address 0, \r
13    the start_addr should always be set to the start byte addess of a sector.\r
14 \r
15 4. Open CCS and launch the evmxxxx emulator target configuration and connect to core 0.\r
16 \r
17 5. Load the program writer\qspi_flash\evmxxxx\bin\qspiflashwriter_evmxxxx.out to CCS, be sure evmxxxx.gel is used in CCS \r
18    and DDR is intialized.\r
19 \r
20 6. Open the Memory view (in CCS, view->Memory Browser), and view the memory address 0x80000000.\r
21 \r
22 7. Load app.bin to 0x80000000:\r
23      * In CCS, right click mouse in memory window, select "load memory".\r
24      * Browse and select writer\qspi_flash\evmxxxx\bin\app.bin (raw data format), click "next"\r
25      * Set the Start Address to "0x80000000", Type-size to 32-bits, leave swap unchecked, click "finish"\r
26 \r
27 \r
28 8. After the binary file is loaded into the memory, run the program (in CCS, press F8), it will start to program the \r
29    QSPI flash.\r
30 \r
31 9. When programming is completed, the console will print "QSPI Flash programming completed successfully", if there\r
32    is any error, the console will show the error message.\r
33 \r
34 \r
35 Steps to re-build qspiflashwriter:\r
36 \r
37 Uses CCS to build qspiflashwriter:\r
38    * Import the qspiflashwriter CCS project from writer\qspi_flash\evmxxxx directory (in CCS, Project->Import Existing CCS/\r
39    CCE Eclipse Projects).\r
40    * Clean and build the qspiflashwriter project.\r
41    * After the project build is completed, qspiflashwriter_evmxxxx.out and qspiflashwriter_evmxxxx.map will be generated under \r
42      writer\qspi_flash\evmxxxx\bin directory.\r
43 \r
44 Please refer to MCSDK User's Guide (http://processors.wiki.ti.com/index.php/MCSDK_User_Guide_for_KeyStone_II) for more details.