xref: /openbmc/u-boot/board/ti/ks2_evm/README (revision 7c0e5d86) 
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
23Board configuration:
24====================
25
26Some of the peripherals that are configured by u-boot
27+------+-------+-------+-----------+-----------+-------+-------+----+
28|      |DDR3   |NAND   |MSM SRAM   |ETH ports  |UART   |I2C    |SPI |
29+------+-------+-------+-----------+-----------+-------+-------+----+
30|K2HK  |2      |512MB  |6MB	   |4(2)       |2      |3      |3   |
31|K2E   |4      |512MB  |2MB	   |8(2)       |2      |3      |3   |
32|K2L   |2      |512MB  |2MB	   |4(2)       |4      |3      |3   |
33+------+-------+-------+-----------+-----------+-------+-------+----+
34
35There are only 2 eth port installed on the boards.
36
37There are separate PLLs to drive clocks to Tetris ARM and Peripherals.
38To bring up SMP Linux on this board, there is a boot monitor
39code that will be installed in MSMC SRAM. There is command available
40to install this image from u-boot.
41
42The port related files can be found at following folders
43 keystone2 SoC related files: arch/arm/cpu/armv7/keystone/
44 EVMs board files: board/ti/k2s_evm/
45
46Board configuration files:
47include/configs/k2hk_evm.h
48include/configs/k2e_evm.h
49include/configs/k2l_evm.h
50
51As u-boot is migrating to Kconfig there is also board defconfig files
52configs/k2e_evm_defconfig
53configs/k2hk_evm_defconfig
54configs/k2l_evm_defconfig
55
56Supported boot modes:
57 - SPI NOR boot
58 - AEMIF NAND boot
59 - UART boot
60
61Supported image formats:
62 - u-boot.bin: for loading and running u-boot.bin through Texas instruments
63               code composure studio (CCS) and for UART boot.
64 - u-boot-spi.gph: gpimage for programming SPI NOR flash for SPI NOR boot
65 - MLO: gpimage for programming AEMIF NAND flash for NAND boot
66
67Build instructions:
68===================
69Examples for k2hk, for k2e and k2l just replace k2hk prefix accordingly.
70Don't forget to add ARCH=arm and CROSS_COMPILE.
71
72To build u-boot.bin, u-boot-spi.gph, MLO:
73  >make k2hk_evm_defconfig
74  >make
75
76Load and Run U-Boot on keystone EVMs using CCS
77=========================================
78
79Need Code Composer Studio (CCS) installed on a PC to load and run u-boot.bin
80on EVM. See instructions at below link for installing CCS on a Windows PC.
81http://processors.wiki.ti.com/index.php/MCSDK_UG_Chapter_Getting_Started#
82Installing_Code_Composer_Studio
83Use u-boot.bin from the build folder for loading and running u-boot binary
84on EVM. Follow instructions at
85K2HK http://processors.wiki.ti.com/index.php/EVMK2H_Hardware_Setup
86K2E  http://processors.wiki.ti.com/index.php/EVMK2E_Hardware_Setup
87K2L  http://processors.wiki.ti.com/index.php/TCIEVMK2L_Hardware_Setup
88
89to configure SW1 dip switch to use "No Boot/JTAG DSP Little Endian Boot Mode"
90and Power ON the EVM.  Follow instructions to connect serial port of EVM to
91PC and start TeraTerm or Hyper Terminal.
92
93Start CCS on a Windows machine and Launch Target
94configuration as instructed at http://processors.wiki.ti.com/index.php/
95MCSDK_UG_Chapter_Exploring#Loading_and_Running_U-Boot_on_EVM_through_CCS.
96The instructions provided in the above link uses a script for
97loading the u-boot binary on the target EVM. Instead do the following:-
98
991. Right click to "Texas Instruments XDS2xx USB Emulator_0/CortexA15_1 core (D
100   is connected: Unknown)" at the debug window (This is created once Target
101   configuration is launched) and select "Connect Target".
1022. Once target connect is successful, choose Tools->Load Memory option from the
103   top level menu. At the Load Memory window, choose the file u-boot.bin
104   through "Browse" button and click "next >" button. In the next window, enter
105   Start address as 0xc001000, choose Type-size "32 bits" and click "Finish"
106   button.
1073. Click View -> Registers from the top level menu to view registers window.
1084. From Registers, window expand "Core Registers" to view PC. Edit PC value
109   to be 0xc001000. From the "Run" top level menu, select "Free Run"
1105. The U-Boot prompt is shown at the Tera Term/ Hyper terminal console as
111   below and type any key to stop autoboot as instructed :=
112
113U-Boot 2014.04-rc1-00201-gc215b5a (Mar 21 2014 - 12:47:59)
114
115I2C:   ready
116Detected SO-DIMM [SQR-SD3T-2G1333SED]
117DRAM:  1.1 GiB
118NAND:  512 MiB
119Net:   K2HK_EMAC
120Warning: K2HK_EMAC using MAC address from net device
121, K2HK_EMAC1, K2HK_EMAC2, K2HK_EMAC3
122Hit any key to stop autoboot:  0
123
124SPI NOR Flash programming instructions
125======================================
126U-Boot image can be flashed to first 512KB of the NOR flash using following
127instructions:
128
1291. Start CCS and run U-boot as described above.
1302. Suspend Target. Select Run -> Suspend from top level menu
131   CortexA15_1 (Free Running)"
1323. Load u-boot-spi.gph binary from build folder on to DDR address 0x87000000
133   through CCS as described in step 2 of "Load and Run U-Boot on K2HK/K2E/K2L
134   EVM using CCS", but using address 0x87000000.
1354. Free Run the target as described earlier (step 4) to get u-boot prompt
1365. At the U-Boot console type following to setup u-boot environment variables.
137   setenv addr_uboot 0x87000000
138   setenv filesize <size in hex of u-boot-spi.gph rounded to hex 0x10000>
139   run burn_uboot_spi
140   Once u-boot prompt is available, Power OFF the EVM. Set the SW1 dip switch
141   to "SPI Little Endian Boot mode" as per instruction at
142   http://processors.wiki.ti.com/index.php/*_Hardware_Setup.
1436. Power ON the EVM. The EVM now boots with u-boot image on the NOR flash.
144
145AEMIF NAND Flash programming instructions
146======================================
147U-Boot image can be flashed to first 1024KB of the NAND flash using following
148instructions:
149
1501. Start CCS and run U-boot as described above.
1512. Suspend Target. Select Run -> Suspend from top level menu
152   CortexA15_1 (Free Running)"
1533. Load MLO binary from build folder on to DDR address 0x87000000
154   through CCS as described in step 2 of "Load and Run U-Boot on K2HK EVM
155   using CCS", but using address 0x87000000.
1564. Free Run the target as described earlier (step 4) to get u-boot prompt
1575. At the U-Boot console type following to setup u-boot environment variables.
158   setenv filesize <size in hex of MLO rounded to hex 0x10000>
159   run burn_uboot_nand
160   Once u-boot prompt is available, Power OFF the EVM. Set the SW1 dip switch
161   to "ARM NAND Boot mode" as per instruction at
162   http://processors.wiki.ti.com/index.php/*_Hardware_Setup.
1636. Power ON the EVM. The EVM now boots with u-boot image on the NAND flash.
164
165Load and Run U-Boot on keystone EVMs using UART download
166========================================================
167
168Open BMC and regular UART terminals.
169
1701. On the regular UART port start xmodem transfer of the u-boot.bin
1712. Using BMC terminal set the ARM-UART bootmode and reboot the EVM
172   BMC> bootmode #4
173   MBC> reboot
1743. When xmodem is complete you should see the u-boot starts on the UART port
175