README: Update readme for instructions on am65xx-evm
[glsdk/host-tools.git] / k3-bootswitch / README.rst
index 1ae35cbef10eab826bcbb6ddbb9ce45dd1fc3d7c..21a76b6c3d4f5b03de5c86402de16ab6a84e7a4f 100644 (file)
@@ -1,33 +1,39 @@
 K3-bootswitch tool
 ==================
 
-This tool allows to boot the J7-EVM in any boot mode from command line.
+This tool allows to boot the board in any boot mode from command line.
 This is useful for controlling the board remotely for individual developers
 as well as test farm.
 
 Hardware setup
 --------------
 
-* Type-C cable should be connected from the board to the Linux PC
+* USB cable should be connected from the board to the Linux PC
 * UART cable should be connected from the main_uart to Linux PC
 * Default switch settings should be for DFU boot mode
-* SW8 = 1000 0000    SW9 = 0010 0000    SW3 = 0101 00 1010
 * Power supply to the board should be connected via phidget USB relay
 
+
+Switch settings for DFU boot mode
+---------------------------------
+
+* j721e-evm settings  => SW8 = 1000 0000      SW9 = 0010 0000      SW3 = 0101 00 1010
+* am65xx-evm settings => SW2 = 0001 0000 00   SW3 = 0000 0000 00   SW4 = 11
+
 Usage
 -----
 
 * Install dfu-util package on the Linux PC with
     ``sudo apt-get install dfu-util``
-* To boot the board in MMC bootmode, run following
-    ``sudo ./dfu-util.sh --bootmode mmc``
+* To boot the j721e-evm board in MMC bootmode, run following
+    ``sudo ./dfu-util.sh --j721e-evm --bootmode mmc``
 
   Currently supported bootmodes are: **mmc, emmc, ospi, uart, noboot**
 
-* To mount the emmc from the board to the Linux PC, run following
-    ``sudo ./dfu-util.sh --mount 0``
-* To mount the SD card from the board to the Linux PC, run following
-    ``sudo ./dfu-util.sh --mount 1``
+* To mount the emmc from j721e-evm board to the Linux PC, run following
+    ``sudo ./dfu-util.sh --j721e-evm --mount 0``
+* To mount the SD card from am65xx-evm board to the Linux PC, run following
+    ``sudo ./dfu-util.sh --am65xx-evm --mount 1``
 
 
 Advantages
@@ -46,7 +52,7 @@ How it works
 ------------
 The DFU bootmode allows to pass any custom bootloader to the board. By keeping
 the switch settings in DFU mode, board always waits for the Linux PC to send
-a bootloader. In J721E SoC, the BOOTMODE and MCU_BOOTMODE registers reflect the
+a bootloader. In Keystone3 SoC, the BOOTMODE and MCU_BOOTMODE registers reflect the
 values of the boot switches at the cold boot. This register can be modified and
 the values written are retained through the warm reset. These two features
 allows to set the bootmode from the command line PC tool.
@@ -71,13 +77,15 @@ absolutely no dependency on the contents of SD card.
 Customization
 -------------
 
-Default setup assumes most common setup for J7EVM. In case you are using
+Default setup assumes most common setup for Keystone3 EVM. In case you are using
 differnent mechanism, update the **dfu-boot.sh** script with following:
 
 * Update the **uart_dev** variable to reflect the correct tty device
   for main uart. (The one where all u-boot/SBL/kernel logs appear)
-* Update the function **toggle_power** to use your custom method to toggle_power
-  remote power switch instead of the default phidget commands
+* Update the **switch** variable to reflect the correct switch number  which
+  controls the power via phidget
+* If you have a differen mechanism to power the board, write your own implementation
+  for **toggle_power** function instead of the default phidget commands
 
 
 
@@ -85,6 +93,7 @@ Limitatinos
 -----------
 
 * Do not use this mechanism to measure any boot time numbers
-* The bootloader images are specific to TI J7 EVM. Different images are required
+* The bootloader images are specific to TI EVMs. Different images are required
   to be able to mount the SD/eMMC from custom boards
-
+* The u-boot will try to import the environment from eMMC. If that is broken,
+  it will cause issues in mounting the devices using UMS