README: Update readme for instructions on am65xx-evm
[glsdk/host-tools.git] / k3-bootswitch / README.rst
1 K3-bootswitch tool
2 ==================
4 This tool allows to boot the board in any boot mode from command line.
5 This is useful for controlling the board remotely for individual developers
6 as well as test farm.
8 Hardware setup
9 --------------
11 * USB cable should be connected from the board to the Linux PC
12 * UART cable should be connected from the main_uart to Linux PC
13 * Default switch settings should be for DFU boot mode
14 * Power supply to the board should be connected via phidget USB relay
17 Switch settings for DFU boot mode
18 ---------------------------------
20 * j721e-evm settings  => SW8 = 1000 0000      SW9 = 0010 0000      SW3 = 0101 00 1010
21 * am65xx-evm settings => SW2 = 0001 0000 00   SW3 = 0000 0000 00   SW4 = 11
23 Usage
24 -----
26 * Install dfu-util package on the Linux PC with
27     ``sudo apt-get install dfu-util``
28 * To boot the j721e-evm board in MMC bootmode, run following
29     ``sudo ./ --j721e-evm --bootmode mmc``
31   Currently supported bootmodes are: **mmc, emmc, ospi, uart, noboot**
33 * To mount the emmc from j721e-evm board to the Linux PC, run following
34     ``sudo ./ --j721e-evm --mount 0``
35 * To mount the SD card from am65xx-evm board to the Linux PC, run following
36     ``sudo ./ --am65xx-evm --mount 1``
39 Advantages
40 ----------
42 * Allows to remotely control the board by eliminating need to physically
43   change the switch settings
44 * Can be used for regular development flow, where it removes the need
45   to physically plug out the SD card for updating images.
46 * Makes it very easy to partition, format and update contents of the
47   eMMC device.
48 * Can be used for factory flashing of the OSPI/eMMC images using
49   automated scripts
51 How it works
52 ------------
53 The DFU bootmode allows to pass any custom bootloader to the board. By keeping
54 the switch settings in DFU mode, board always waits for the Linux PC to send
55 a bootloader. In Keystone3 SoC, the BOOTMODE and MCU_BOOTMODE registers reflect the
56 values of the boot switches at the cold boot. This register can be modified and
57 the values written are retained through the warm reset. These two features
58 allows to set the bootmode from the command line PC tool.
60 In the **boot_select** directory of this tool, there are many files which act
61 as the custom bootloader every time the board boots with DFU-boot mode.
62 The custom bootloader does only two important things; First it overwrites the
63 BOOTMODE and MCU_BOOTMODE registers to change to the desired boot mode and then
64 it issues a soft reset to the SoC causing it to boot the second time with new
65 bootmode.
67 All of this happens very fast when run from a script that it does not add
68 considerable amount of time for developer bootflow.
70 The mount of SD card or eMMC is achieved using the u-boot's
71 UMS (USB Mass Storage) feature. In this case, the tool sends a real R5 u-boot as
72 bootloader, System firmware ITB, A72 u-boot images and then runs the ums command.
73 Note that all the binaries are being sent from the Linux PC, so there is
74 absolutely no dependency on the contents of SD card.
77 Customization
78 -------------
80 Default setup assumes most common setup for Keystone3 EVM. In case you are using
81 differnent mechanism, update the **** script with following:
83 * Update the **uart_dev** variable to reflect the correct tty device
84   for main uart. (The one where all u-boot/SBL/kernel logs appear)
85 * Update the **switch** variable to reflect the correct switch number  which
86   controls the power via phidget
87 * If you have a differen mechanism to power the board, write your own implementation
88   for **toggle_power** function instead of the default phidget commands
92 Limitatinos
93 -----------
95 * Do not use this mechanism to measure any boot time numbers
96 * The bootloader images are specific to TI EVMs. Different images are required
97   to be able to mount the SD/eMMC from custom boards
98 * The u-boot will try to import the environment from eMMC. If that is broken,
99   it will cause issues in mounting the devices using UMS