Commit a79c911f350f481f3cb64c65f1b71aa32515275e

Authored by Khoronzhuk, Ivan
Committed by Tom Rini
1 parent f6c7c75482

ks2_evm: readme: align according to actual sources

Update readme file for Keystone II EVM boards to actual sources.
Also correct some typos. For now the Edison evaluation board is
added, README for K2E is mostly the same, so update README to
contain information also for K2E evm. Rename file to README as
it contains information for all keystone evm boards.

Signed-off-by: Ivan Khoronzhuk <ivan.khoronzhuk@ti.com>

Showing 2 changed files with 161 additions and 148 deletions Side-by-side Diff

board/ti/ks2_evm/README
  1 +U-Boot port for Texas Instruments Keystone II EVM boards
  2 +========================================================
  3 +
  4 +Author: Murali Karicheri <m-karicheri2@ti.com>
  5 +
  6 +This README has information on the u-boot port for K2HK, K2E boards.
  7 +Documentation for this board can be found at
  8 +http://www.advantech.com/Support/TI-EVM/EVMK2HX_sd.aspx
  9 +https://www.einfochips.com/index.php/partnerships/texas-instruments/k2e-evm.html
  10 +
  11 +The K2HK board is based on Texas Instruments Keystone2 family of SoCs: K2H, K2K.
  12 +More details on these SoCs are available at company websites
  13 + K2K: http://www.ti.com/product/tci6638k2k
  14 + K2H: http://www.ti.com/product/tci6638k2h
  15 +
  16 +The K2E SoC details are available at
  17 + K2E http://www.ti.com/lit/ds/symlink/66ak2e05.pdf
  18 +
  19 +Board configuration:
  20 +====================
  21 +
  22 +Some of the peripherals that are configured by u-boot
  23 ++------+-------+-------+-----------+-----------+-------+-------+----+
  24 +| |DDR3 |NAND |MSM SRAM |ETH ports |UART |I2C |SPI |
  25 ++------+-------+-------+-----------+-----------+-------+-------+----+
  26 +|K2HK |2 |512MB |6MB |4(2) |2 |3 |3 |
  27 +|K2E |4 |512MB |2MB |8(2) |2 |3 |3 |
  28 ++------+-------+-------+-----------+-----------+-------+-------+----+
  29 +
  30 +There are only 2 eth port installed on the boards.
  31 +
  32 +There are separate PLLs to drive clocks to Tetris ARM and Peripherals.
  33 +To bring up SMP Linux on this board, there is a boot monitor
  34 +code that will be installed in MSMC SRAM. There is command available
  35 +to install this image from u-boot.
  36 +
  37 +The port related files can be found at following folders
  38 + keystone2 SoC related files: arch/arm/cpu/armv7/keystone/
  39 + EVMs board files: board/ti/k2s_evm/
  40 +
  41 +Board configuration files:
  42 +include/configs/k2hk_evm.h
  43 +include/configs/k2e_evm.h
  44 +
  45 +As u-boot is migrating to Kconfig there is also board defconfig files
  46 +configs/k2e_evm_defconfig
  47 +configs/k2hk_evm_defconfig
  48 +
  49 +Supported boot modes:
  50 + - SPI NOR boot
  51 + - AEMIF NAND boot
  52 +
  53 +Supported image formats:
  54 + - u-boot.bin: for loading and running u-boot.bin through Texas instruments
  55 + code composure studio (CCS)
  56 + - u-boot-spi.gph: gpimage for programming SPI NOR flash for SPI NOR boot
  57 + - u-boot-nand.gph: gpimage for programming AEMIF NAND flash for NAND boot
  58 +
  59 +Build instructions:
  60 +===================
  61 +Examples for k2hk, for k2e just replace k2hk prefix accordingly.
  62 +Don't forget to add ARCH=arm and CROSS_COMPILE.
  63 +
  64 +To build u-boot.bin
  65 + >make k2hk_evm_defconfig
  66 + >make u-boot-spi.gph
  67 +
  68 +To build u-boot-spi.gph
  69 + >make k2hk_evm_defconfig
  70 + >make u-boot-spi.gph
  71 +
  72 +To build u-boot-nand.gph
  73 + >make k2hk_evm_defconfig
  74 + >make u-boot-nand.gph
  75 +
  76 +Load and Run U-Boot on keystone EVMs using CCS
  77 +=========================================
  78 +
  79 +Need Code Composer Studio (CCS) installed on a PC to load and run u-boot.bin
  80 +on EVM. See instructions at below link for installing CCS on a Windows PC.
  81 +http://processors.wiki.ti.com/index.php/MCSDK_UG_Chapter_Getting_Started#
  82 +Installing_Code_Composer_Studio
  83 +Use u-boot.bin from the build folder for loading and running u-boot binary
  84 +on EVM. Follow instructions at
  85 +K2HK http://processors.wiki.ti.com/index.php/EVMK2H_Hardware_Setup
  86 +K2E http://processors.wiki.ti.com/index.php/EVMK2E_Hardware_Setup
  87 +to configure SW1 dip switch to use "No Boot/JTAG DSP Little Endian Boot Mode"
  88 +and Power ON the EVM. Follow instructions to connect serial port of EVM to
  89 +PC and start TeraTerm or Hyper Terminal.
  90 +
  91 +Start CCS on a Windows machine and Launch Target
  92 +configuration as instructed at http://processors.wiki.ti.com/index.php/
  93 +MCSDK_UG_Chapter_Exploring#Loading_and_Running_U-Boot_on_EVM_through_CCS.
  94 +The instructions provided in the above link uses a script for
  95 +loading the u-boot binary on the target EVM. Instead do the following:-
  96 +
  97 +1. Right click to "Texas Instruments XDS2xx USB Emulator_0/CortexA15_1 core (D
  98 + is connected: Unknown)" at the debug window (This is created once Target
  99 + configuration is launched) and select "Connect Target".
  100 +2. Once target connect is successful, choose Tools->Load Memory option from the
  101 + top level menu. At the Load Memory window, choose the file u-boot.bin
  102 + through "Browse" button and click "next >" button. In the next window, enter
  103 + Start address as 0xc001000, choose Type-size "32 bits" and click "Finish"
  104 + button.
  105 +3. Click View -> Registers from the top level menu to view registers window.
  106 +4. From Registers, window expand "Core Registers" to view PC. Edit PC value
  107 + to be 0xc001000. From the "Run" top level menu, select "Free Run"
  108 +5. The U-Boot prompt is shown at the Tera Term/ Hyper terminal console as
  109 + below and type any key to stop autoboot as instructed :=
  110 +
  111 +U-Boot 2014.04-rc1-00201-gc215b5a (Mar 21 2014 - 12:47:59)
  112 +
  113 +I2C: ready
  114 +Detected SO-DIMM [SQR-SD3T-2G1333SED]
  115 +DRAM: 1.1 GiB
  116 +NAND: 512 MiB
  117 +Net: K2HK_EMAC
  118 +Warning: K2HK_EMAC using MAC address from net device
  119 +, K2HK_EMAC1, K2HK_EMAC2, K2HK_EMAC3
  120 +Hit any key to stop autoboot: 0
  121 +
  122 +SPI NOR Flash programming instructions
  123 +======================================
  124 +U-Boot image can be flashed to first 512KB of the NOR flash using following
  125 +instructions:
  126 +
  127 +1. Start CCS and run U-boot as described above.
  128 +2. Suspend Target. Select Run -> Suspend from top level menu
  129 + CortexA15_1 (Free Running)"
  130 +3. Load u-boot-spi.gph binary from build folder on to DDR address 0x87000000
  131 + through CCS as described in step 2 of "Load and Run U-Boot on K2HK/K2E EVM
  132 + using CCS", but using address 0x87000000.
  133 +4. Free Run the target as described earlier (step 4) to get u-boot prompt
  134 +5. At the U-Boot console type following to setup u-boot environment variables.
  135 + setenv addr_uboot 0x87000000
  136 + setenv filesize <size in hex of u-boot-spi.gph rounded to hex 0x10000>
  137 + run burn_uboot_spi
  138 + Once u-boot prompt is available, Power OFF the EVM. Set the SW1 dip switch
  139 + to "SPI Little Endian Boot mode" as per instruction at
  140 + http://processors.wiki.ti.com/index.php/*_Hardware_Setup.
  141 +6. Power ON the EVM. The EVM now boots with u-boot image on the NOR flash.
  142 +
  143 +AEMIF NAND Flash programming instructions
  144 +======================================
  145 +U-Boot image can be flashed to first 1024KB of the NAND flash using following
  146 +instructions:
  147 +
  148 +1. Start CCS and run U-boot as described above.
  149 +2. Suspend Target. Select Run -> Suspend from top level menu
  150 + CortexA15_1 (Free Running)"
  151 +3. Load u-boot-nand.gph binary from build folder on to DDR address 0x87000000
  152 + through CCS as described in step 2 of "Load and Run U-Boot on K2HK EVM
  153 + using CCS", but using address 0x87000000.
  154 +4. Free Run the target as described earlier (step 4) to get u-boot prompt
  155 +5. At the U-Boot console type following to setup u-boot environment variables.
  156 + setenv filesize <size in hex of u-boot-nand.gph rounded to hex 0x10000>
  157 + run burn_uboot_nand
  158 + Once u-boot prompt is available, Power OFF the EVM. Set the SW1 dip switch
  159 + to "ARM NAND Boot mode" as per instruction at
  160 + http://processors.wiki.ti.com/index.php/*_Hardware_Setup.
  161 +6. Power ON the EVM. The EVM now boots with u-boot image on the NAND flash.
board/ti/ks2_evm/README_K2HK
1   -U-Boot port for Texas Instruments XTCIEVMK2X
2   -============================================
3   -
4   -Author: Murali Karicheri <m-karicheri2@ti.com>
5   -
6   -This README has information on the u-boot port for XTCIEVMK2X EVM board.
7   -Documentation for this board can be found at
8   - http://www.advantech.com/Support/TI-EVM/EVMK2HX_sd.aspx
9   -
10   -The board is based on Texas Instruments Keystone2 family of SoCs : K2H, K2K.
11   -More details on these SoCs are available at company websites
12   - K2K: http://www.ti.com/product/tci6638k2k
13   - K2H: http://www.ti.com/product/tci6638k2h
14   -
15   -Board configuration:
16   -====================
17   -
18   -Some of the peripherals that are configured by u-boot are:-
19   -
20   -1. 2GB DDR3 (can support 8GB SO DIMM as well)
21   -2. 512M NAND (over ti emif16 bus)
22   -3. 6MB MSM SRAM (part of the SoC)
23   -4. two 1GBit Ethernet ports (SoC supports upto 4)
24   -5. two UART ports
25   -6. three i2c interfaces
26   -7. three spi interfaces (only 1 interface supported in driver)
27   -
28   -There are seperate PLLs to drive clocks to Tetris ARM and Peripherals.
29   -To bring up SMP Linux on this board, there is a boot monitor
30   -code that will be installed in MSMC SRAM. There is command available
31   -to install this image from u-boot.
32   -
33   -The port related files can be found at following folders
34   - keystone2 SoC related files: arch/arm/cpu/armv7/keystone/
35   - K2HK evm board files: board/ti/k2hk_evm/
36   -
37   -board configuration file: include/configs/k2hk_evm.h
38   -
39   -Supported boot modes:
40   - - SPI NOR boot
41   - - AEMIF NAND boot
42   -
43   -Supported image formats:-
44   - - u-boot.bin: for loading and running u-boot.bin through Texas instruments
45   - code composure studio (CCS)
46   - - u-boot-spi.gph: gpimage for programming SPI NOR flash for SPI NOR boot
47   - - u-boot-nand.gph: gpimage for programming AEMIF NAND flash for NAND boot
48   -
49   -Build instructions:
50   -===================
51   -
52   -To build u-boot.bin
53   - >make k2hk_evm_config
54   - >make u-boot-spi.gph
55   -
56   -To build u-boot-spi.gph
57   - >make k2hk_evm_config
58   - >make u-boot-spi.gph
59   -
60   -To build u-boot-nand.gph
61   - >make k2hk_evm_config
62   - >make u-boot-nand.gph
63   -
64   -Load and Run U-Boot on K2HK EVM using CCS
65   -=========================================
66   -
67   -Need Code Composer Studio (CCS) installed on a PC to load and run u-boot.bin
68   -on EVM. See instructions at below link for installing CCS on a Windows PC.
69   -http://processors.wiki.ti.com/index.php/MCSDK_UG_Chapter_Getting_Started#
70   -Installing_Code_Composer_Studio
71   -Use u-boot.bin from the build folder for loading annd running u-boot binary
72   -on EVM. Follow instructions at
73   -http://processors.wiki.ti.com/index.php/EVMK2H_Hardware_Setup
74   -to configure SW1 dip switch to use "No Boot/JTAG DSP Little Endian Boot Mode"
75   -and Power ON the EVM. Follow instructions to connect serial port of EVM to
76   -PC and start TeraTerm or Hyper Terminal.
77   -
78   -Start CCS on a Windows machine and Launch Target
79   -configuration as instructed at http://processors.wiki.ti.com/index.php/
80   -MCSDK_UG_Chapter_Exploring#Loading_and_Running_U-Boot_on_EVM_through_CCS.
81   -The instructions provided in the above link uses a script for
82   -loading the u-boot binary on the target EVM. Instead do the following:-
83   -
84   -1. Right click to "Texas Instruments XDS2xx USB Emulator_0/CortexA15_1 core (D
85   - isconnected: Unknown)" at the debug window (This is created once Target
86   - configuration is launched) and select "Connect Target".
87   -2. Once target connect is successful, choose Tools->Load Memory option from the
88   - top level menu. At the Load Memory window, choose the file u-boot.bin
89   - through "Browse" button and click "next >" button. In the next window, enter
90   - Start address as 0xc001000, choose Type-size "32 bits" and click "Finish"
91   - button.
92   -3. Click View -> Registers from the top level menu to view registers window.
93   -4. From Registers, window expand "Core Registers" to view PC. Edit PC value
94   - to be 0xc001000. From the "Run" top level menu, select "Free Run"
95   -5. The U-Boot prompt is shown at the Tera Term/ Hyper terminal console as
96   - below and type any key to stop autoboot as instructed :=
97   -
98   -U-Boot 2014.04-rc1-00201-gc215b5a (Mar 21 2014 - 12:47:59)
99   -
100   -I2C: ready
101   -Detected SO-DIMM [SQR-SD3T-2G1333SED]
102   -DRAM: 1.1 GiB
103   -NAND: 512 MiB
104   -Net: K2HK_EMAC
105   -Warning: K2HK_EMAC using MAC address from net device
106   -, K2HK_EMAC1, K2HK_EMAC2, K2HK_EMAC3
107   -Hit any key to stop autoboot: 0
108   -
109   -SPI NOR Flash programming instructions
110   -======================================
111   -U-Boot image can be flashed to first 512KB of the NOR flash using following
112   -instructions:-
113   -
114   -1. Start CCS and run U-boot as described above.
115   -2. Suspend Target. Select Run -> Suspend from top level menu
116   - CortexA15_1 (Free Running)"
117   -3. Load u-boot-spi.gph binary from build folder on to DDR address 0x87000000
118   - through CCS as described in step 2 of "Load and Run U-Boot on K2HK EVM
119   - using CCS", but using address 0x87000000.
120   -4. Free Run the target as desribed earlier (step 4) to get u-boot prompt
121   -5. At the U-Boot console type following to setup u-boot environment variables.
122   - setenv addr_uboot 0x87000000
123   - setenv filesize <size in hex of u-boot-spi.gph rounded to hex 0x10000>
124   - run burn_uboot_spi
125   - Once u-boot prompt is available, Power OFF the EVM. Set the SW1 dip switch
126   - to "SPI Little Endian Boot mode" as per instruction at
127   - http://processors.wiki.ti.com/index.php/EVMK2H_Hardware_Setup.
128   -6. Power ON the EVM. The EVM now boots with u-boot image on the NOR flash.
129   -
130   -AEMIF NAND Flash programming instructions
131   -======================================
132   -U-Boot image can be flashed to first 1024KB of the NAND flash using following
133   -instructions:-
134   -
135   -1. Start CCS and run U-boot as described above.
136   -2. Suspend Target. Select Run -> Suspend from top level menu
137   - CortexA15_1 (Free Running)"
138   -3. Load u-boot-nand.gph binary from build folder on to DDR address 0x87000000
139   - through CCS as described in step 2 of "Load and Run U-Boot on K2HK EVM
140   - using CCS", but using address 0x87000000.
141   -4. Free Run the target as desribed earlier (step 4) to get u-boot prompt
142   -5. At the U-Boot console type following to setup u-boot environment variables.
143   - setenv filesize <size in hex of u-boot-nand.gph rounded to hex 0x10000>
144   - run burn_uboot_nand
145   - Once u-boot prompt is available, Power OFF the EVM. Set the SW1 dip switch
146   - to "ARM NAND Boot mode" as per instruction at
147   - http://processors.wiki.ti.com/index.php/EVMK2H_Hardware_Setup.
148   -6. Power ON the EVM. The EVM now boots with u-boot image on the NAND flash.