README: Remove un-necessary details
[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``
51 Customization
52 -------------
54 Default setup assumes most common setup for Keystone3 EVM. In case you are using
55 differnent mechanism, update the **dfu-boot.sh** script with following:
57 * Update the **uart_dev** variable to reflect the correct tty device
58   for main uart. (The one where all u-boot/SBL/kernel logs appear)
59 * Update the **switch** variable to reflect the correct switch number  which
60   controls the power via phidget
61 * If you have a different mechanism to power the board, write your own implementation
62   for **toggle_power** function instead of the default phidget commands
64 Limitatinos
65 -----------
67 * Do not use this mechanism to measure any boot time numbers
68 * The bootloader images are specific to TI EVMs. Different images are required
69   to be able to mount the SD/eMMC from custom boards
70 * The u-boot will try to import the environment from eMMC. If that is broken,
71   it will cause issues in mounting the devices using UMS