[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 * Note that on am65xx-evm, there is an adapter board for PCIe / USB.
13   This should be used for connecting the USB cable.
14   DFU boot is only supported from this port.
15 * UART cable should be connected from the main_uart to Linux PC
16 * Default switch settings should be for DFU boot mode
17 * Power supply to the board should be connected via phidget USB relay
20 Switch settings for DFU boot mode
21 ---------------------------------
23 * j721e-evm settings  => SW8 = 1000 0000      SW9 = 0010 0000      SW3 = 0101 00 1010
24 * j7200-evm settings  => SW8 = 1000 0000      SW9 = 0010 0000      SW3 = 0101 00 1010
25 * am65xx-evm settings => SW2 = 0000 0000 00   SW3 = 0001 0000 00   SW4 = 11
27 Phidget setup
28 -------------
30 This script uses phidget to control power for restarting the boards.
31 Since everyone has different configuration, the script parses the data from a
32 config file. You can copy the template as follows and then customize as required.
34     cp k3bootswitch.conf ~/HOME/.config/
36 Usage
37 -----
39 * Install dfu-util package on the Linux PC with
40     ``sudo apt-get install dfu-util``
41 * To boot the j721e-evm board in MMC bootmode, run following
42     ``sudo ./dfu-boot.sh --j721e-evm --bootmode mmc``
44   Currently supported bootmodes are: **mmc, emmc, ospi, uart, noboot**
46 * To mount the emmc from j721e-evm board to the Linux PC, run following
47     ``sudo ./dfu-boot.sh --j721e-evm --mount 0``
48 * To mount the SD card from am65xx-evm board to the Linux PC, run following
49     ``sudo ./dfu-boot.sh --am65xx-evm --mount 1``
52 Advantages
53 ----------
55 * Allows to remotely control the board by eliminating need to physically
56   change the switch settings
57 * Can be used for regular development flow, where it removes the need
58   to physically plug out the SD card for updating images.
59 * Makes it very easy to partition, format and update contents of the
60   eMMC device.
61 * Can be used for factory flashing of the OSPI/eMMC images using
62   automated scripts
64 How it works
65 ------------
66 The DFU bootmode allows to pass any custom bootloader to the board. By keeping
67 the switch settings in DFU mode, board always waits for the Linux PC to send
68 a bootloader. In Keystone3 SoC, the BOOTMODE and MCU_BOOTMODE registers reflect the
69 values of the boot switches at the cold boot. This register can be modified and
70 the values written are retained through the warm reset. These two features
71 allows to set the bootmode from the command line PC tool.
73 In the **boot_select** directory of this tool, there are many files which act
74 as the custom bootloader every time the board boots with DFU-boot mode.
75 The custom bootloader does only two important things; First it overwrites the
76 BOOTMODE and MCU_BOOTMODE registers to change to the desired boot mode and then
77 it issues a soft reset to the SoC causing it to boot the second time with new
78 bootmode.
80 All of this happens very fast when run from a script that it does not add
81 considerable amount of time for developer bootflow.
83 The mount of SD card or eMMC is achieved using the u-boot's
84 UMS (USB Mass Storage) feature. In this case, the tool sends a real R5 u-boot as
85 bootloader, System firmware ITB, A72 u-boot images and then runs the ums command.
86 Note that all the binaries are being sent from the Linux PC, so there is
87 absolutely no dependency on the contents of SD card.
90 Customization
91 -------------
93 Default setup assumes most common setup for Keystone3 EVM. In case you are using
94 differnent mechanism, update the **dfu-boot.sh** script with following:
96 * Update the **uart_dev** variable to reflect the correct tty device
97   for main uart. (The one where all u-boot/SBL/kernel logs appear)
98 * Update the **switch** variable to reflect the correct switch number  which
99   controls the power via phidget
100 * If you have a different mechanism to power the board, write your own implementation
101   for **toggle_power** function instead of the default phidget commands
105 Limitatinos
106 -----------
108 * Do not use this mechanism to measure any boot time numbers
109 * The bootloader images are specific to TI EVMs. Different images are required
110   to be able to mount the SD/eMMC from custom boards
111 * The u-boot will try to import the environment from eMMC. If that is broken,
112   it will cause issues in mounting the devices using UMS