xref: /openbmc/u-boot/board/ti/ks2_evm/README (revision 9c0e2f6e) 
1U-Boot port for Texas Instruments Keystone II EVM boards
2========================================================
3
4Author: Murali Karicheri <m-karicheri2@ti.com>
5
6This README has information on the U-Boot port for K2HK, K2E, and K2L EVM boards.
7Documentation for this board can be found at
8http://www.advantech.com/Support/TI-EVM/EVMK2HX_sd.aspx
9https://www.einfochips.com/index.php/partnerships/texas-instruments/k2e-evm.html
10https://www.einfochips.com/index.php/partnerships/texas-instruments/k2l-evm.html
11
12The K2HK board is based on Texas Instruments Keystone2 family of SoCs: K2H, K2K.
13More details on these SoCs are available at company websites
14 K2K: http://www.ti.com/product/tci6638k2k
15 K2H: http://www.ti.com/product/tci6638k2h
16
17The K2E SoC details are available at
18 http://www.ti.com/lit/ds/symlink/66ak2e05.pdf
19
20The K2L SoC details are available at
21 http://www.ti.com/lit/ds/symlink/tci6630k2l.pdf
22
23The K2G SoC details are available at
24 http://www.ti.com/lit/ds/symlink/66ak2g02.pdf
25
26Board configuration:
27====================
28
29Some of the peripherals that are configured by U-Boot
30+------+-------+-------+-----------+-----------+-------+-------+----+
31|      |DDR3   |NAND   |MSM SRAM   |ETH ports  |UART   |I2C    |SPI |
32+------+-------+-------+-----------+-----------+-------+-------+----+
33|K2HK  |2      |512MB  |6MB	   |4(2)       |2      |3      |3   |
34|K2E   |4      |512MB  |2MB	   |8(2)       |2      |3      |3   |
35|K2L   |2      |512MB  |2MB	   |4(2)       |4      |3      |3   |
36|K2G   |2      |256MB  |1MB	   |1          |1      |1      |1   |
37+------+-------+-------+-----------+-----------+-------+-------+----+
38
39There are only 2 eth port installed on the boards.
40
41There are separate PLLs to drive clocks to Tetris ARM and Peripherals.
42To bring up SMP Linux on this board, there is a boot monitor
43code that will be installed in MSMC SRAM. There is command available
44to install this image from U-Boot.
45
46The port related files can be found at following folders
47 keystone2 SoC related files: arch/arm/cpu/armv7/keystone/
48 EVMs board files: board/ti/k2s_evm/
49
50Board configuration files:
51include/configs/k2hk_evm.h
52include/configs/k2e_evm.h
53include/configs/k2l_evm.h
54include/configs/k2g_evm.h
55
56As U-Boot is migrating to Kconfig there is also board defconfig files
57configs/k2e_evm_defconfig
58configs/k2hk_evm_defconfig
59configs/k2l_evm_defconfig
60configs/k2g_evm_defconfig
61
62Supported boot modes:
63 - SPI NOR boot
64 - AEMIF NAND boot (K2E, K2L and K2HK)
65 - UART boot
66 - MMC boot (Only on K2G)
67
68Supported image formats:
69 - u-boot.bin: for loading and running u-boot.bin through
70		Texas Instruments code composure studio (CCS) and for UART boot.
71 - u-boot-spi.gph: gpimage for programming SPI NOR flash for SPI NOR boot
72 - MLO: gpimage for programming NAND flash for NAND boot, MMC boot.
73
74Build instructions:
75===================
76Examples for k2hk, for k2e, k2l and k2g just replace k2hk prefix accordingly.
77Don't forget to add ARCH=arm and CROSS_COMPILE.
78
79To build u-boot.bin, u-boot-spi.gph, MLO:
80  >make k2hk_evm_defconfig
81  >make
82
83Load and Run U-Boot on keystone EVMs using CCS
84=========================================
85
86Need Code Composer Studio (CCS) installed on a PC to load and run u-boot.bin
87on EVM. See instructions at below link for installing CCS on a Windows PC.
88http://processors.wiki.ti.com/index.php/MCSDK_UG_Chapter_Getting_Started#
89Installing_Code_Composer_Studio
90Use u-boot.bin from the build folder for loading and running U-Boot binary
91on EVM. Follow instructions at
92K2HK http://processors.wiki.ti.com/index.php/EVMK2H_Hardware_Setup
93K2E  http://processors.wiki.ti.com/index.php/EVMK2E_Hardware_Setup
94K2L  http://processors.wiki.ti.com/index.php/TCIEVMK2L_Hardware_Setup
95K2G  http://processors.wiki.ti.com/index.php/66AK2G02_GP_EVM_Hardware_Setup
96
97to configure SW1 dip switch to use "No Boot/JTAG DSP Little Endian Boot Mode"
98and Power ON the EVM.  Follow instructions to connect serial port of EVM to
99PC and start TeraTerm or Hyper Terminal.
100
101Start CCS on a Windows machine and Launch Target
102configuration as instructed at http://processors.wiki.ti.com/index.php/
103MCSDK_UG_Chapter_Exploring#Loading_and_Running_U-Boot_on_EVM_through_CCS.
104The instructions provided in the above link uses a script for
105loading the U-Boot binary on the target EVM. Instead do the following:-
106
1071. Right click to "Texas Instruments XDS2xx USB Emulator_0/CortexA15_1 core (D
108   is connected: Unknown)" at the debug window (This is created once Target
109   configuration is launched) and select "Connect Target".
1102. Once target connect is successful, choose Tools->Load Memory option from the
111   top level menu. At the Load Memory window, choose the file u-boot.bin
112   through "Browse" button and click "next >" button. In the next window, enter
113   Start address as 0xc000000, choose Type-size "32 bits" and click "Finish"
114   button.
1153. Click View -> Registers from the top level menu to view registers window.
1164. From Registers, window expand "Core Registers" to view PC. Edit PC value
117   to be 0xc000000. From the "Run" top level menu, select "Free Run"
1185. The U-Boot prompt is shown at the Tera Term/ Hyper terminal console as
119   below and type any key to stop autoboot as instructed :=
120
121U-Boot 2014.04-rc1-00201-gc215b5a (Mar 21 2014 - 12:47:59)
122
123I2C:   ready
124Detected SO-DIMM [SQR-SD3T-2G1333SED]
125DRAM:  1.1 GiB
126NAND:  512 MiB
127Net:   K2HK_EMAC
128Warning: K2HK_EMAC using MAC address from net device
129, K2HK_EMAC1, K2HK_EMAC2, K2HK_EMAC3
130Hit any key to stop autoboot:  0
131
132SPI NOR Flash programming instructions
133======================================
134U-Boot image can be flashed to first 512KB of the NOR flash using following
135instructions:
136
1371. Start CCS and run U-Boot as described above.
1382. Suspend Target. Select Run -> Suspend from top level menu
139   CortexA15_1 (Free Running)"
1403. Load u-boot-spi.gph binary from build folder on to DDR address 0x87000000
141   through CCS as described in step 2 of "Load and Run U-Boot on K2HK/K2E/K2L
142   EVM using CCS", but using address 0x87000000.
1434. Free Run the target as described earlier (step 4) to get U-Boot prompt
1445. At the U-Boot console type following to setup U-Boot environment variables.
145   setenv addr_uboot 0x87000000
146   setenv filesize <size in hex of u-boot-spi.gph rounded to hex 0x10000>
147   run burn_uboot_spi
148   Once U-Boot prompt is available, Power OFF the EVM. Set the SW1 dip switch
149   to "SPI Little Endian Boot mode" as per instruction at
150   http://processors.wiki.ti.com/index.php/*_Hardware_Setup.
1516. Power ON the EVM. The EVM now boots with U-Boot image on the NOR flash.
152
153AEMIF NAND Flash programming instructions
154======================================
155U-Boot image can be flashed to first 1024KB of the NAND flash using following
156instructions:
157
1581. Start CCS and run U-Boot as described above.
1592. Suspend Target. Select Run -> Suspend from top level menu
160   CortexA15_1 (Free Running)"
1613. Load MLO binary from build folder on to DDR address 0x87000000
162   through CCS as described in step 2 of "Load and Run U-Boot on K2HK EVM
163   using CCS", but using address 0x87000000.
1644. Free Run the target as described earlier (step 4) to get U-Boot prompt
1655. At the U-Boot console type following to setup U-Boot environment variables.
166   setenv filesize <size in hex of MLO rounded to hex 0x10000>
167   run burn_uboot_nand
168   Once U-Boot prompt is available, Power OFF the EVM. Set the SW1 dip switch
169   to "ARM NAND Boot mode" as per instruction at
170   http://processors.wiki.ti.com/index.php/*_Hardware_Setup.
1716. Power ON the EVM. The EVM now boots with U-Boot image on the NAND flash.
172
173Load and Run U-Boot on keystone EVMs using UART download
174========================================================
175
176Open BMC and regular UART terminals.
177
1781. On the regular UART port start xmodem transfer of the u-boot.bin
1792. Using BMC terminal set the ARM-UART bootmode and reboot the EVM
180   BMC> bootmode #4
181   MBC> reboot
1823. When xmodem is complete you should see the U-Boot starts on the UART port
183
184Load and Run U-Boot on K2G EVMs using MMC
185========================================================
186
187Open BMC and regular UART terminals.
188
1891. Set the SW3 dip switch to "ARM MMC Boot mode" as per instruction at
190   http://processors.wiki.ti.com/index.php/66AK2G02_GP_EVM_Hardware_Setup
1912. Create SD card partitions as per steps given in Hardware Setup Guide.
1923. Copy MLO to Boot Partition.
1934. Insert SD card and Power on the EVM.
194   The EVM now boots with U-Boot image from SD card.
195