Merge commit 'origin/master' into single-bi
[keystone-rtos/ibl.git] / doc / evmc6670-instructions.txt
1 Steps to use IBL on the c6670 EVM
3 1. Programing "IBL" on the EEPROM at bus address 0x51
4    (a) Use the I2C EEPROM writer for c6670 EVM from the MCSDK distribution.
5    (b) Program i2crom_0x51_c6670_le.dat (IBL image) to the EEPROM at I2C BUS 
6        address 0x51 following the EEPROM writer's procedure.
8 2. Programing "IBL Configuration"
9    NOTE: For an understanding of the IBL configuration parameters used in this step, 
10          please refer to the IBL-Configuration documentation. The configuration 
11          data structure is ibl_s.                
12    (a) Make sure that the boot mode dip switch is set to no boot/EMIF16 
13        boot mode on the EVM (please refer to the EVM technical reference manual
14            on how to set the boot mode dip switches.
15    (b) Open CCSv5 and launch the evmc66xx emulator target configuration and connect to core 0.
16    (c) Load the program i2cparam_0x51_c6670_le_0x500.out to CCS.
17    (d) Run the program and a message "Run the GEL for the device to be configured, 
18        press return to program the I2C" will be printed on the CCS console.
19    (e) Load i2cConfig.gel (in CCSv5 Tools->GEL Files, right click mouse in GEL Files
20        window and select "Load GEL"
21    (f) Run the GEL script "EVM c6670 IBL"->setConfig_c6670_main, this will set the 
22        default boot parameters for booting application images from NOR, NAND and 
23        Ethernet.
24    (g) Now press "Enter" in the CCS console window, and the program will write the 
25        boot parameter table to the EEPROM. On success the message "I2c table write complete" 
26            will be printed on the CCS console.
28 3. Programming the application on NAND or NOR flash
29    NOTE: This step is not needed if the application is booted from Ethernet.
30    (a) Use the NAND or NOR writer c6670 EVM from the tools directory.
31    (a) Flash the Application to NAND or NOR. For instructions please follow 
32        the instructions given along with the NAND/NOR writer.
34 4. Booting the Application using IBL
35    Supported boot modes:
36    IBL supports three I2C boot modes: NOR boot, NAND boot and EMAC boot. 
37    Both NOR boot and NAND boot support maximum 2 images, EMAC boot supports only 1 image. 
38    For all the I2C boot modes, user needs to set the boot dip switches to I2C master, bus address 0x51.
40    NOR Boot:
41    Set the dip switches (pin1, pin2, pin3, pin4) to: 
42     SW3(off, off, on, off), 
43     SW4(on, on, on, on), 
44     SW5(on, on, on, off),
45     SW6(on, on, on, on)
46    This will set the boot param index to 0 to boot the NOR image, by default
47    the boot configuration table sets the NOR offset address to be 0 and 
48    image format to be ELF for image 0.
49    
50    NAND Boot:
51    Set the dip switches (pin1, pin2, pin3, pin4) to: 
52     SW3(off, off, on, off), 
53     SW4(on, off, on, on), 
54     SW5(on, on, on, off),
55     SW6(on, on, on, on)
56    This will set the boot param index to 2 to boot the NAND image, by default
57    the boot configuration table sets the NAND offset address to be 16384 
58    (start of block 1) and image format to be BBLOB for image 0.
60    EMAC Boot:
61    Set the dip switches (pin1, pin2, pin3, pin4) to: 
62     SW3(off, off, on, off), 
63     SW4(on, on, off, on), 
64     SW5(on, on, on, off),
65     SW6(on, on, on, on)
66    This will set the boot param index to 4 to boot an image from a remote TFTP
67    server, by default the boot configuration table sets the server IP to be 
68    192.168.2.101, board IP to be 192.168.2.100 and image format to be BBLOB.