doc: board: ti: k3 docs: Use ::prompt
Use prompt instead of code-block to have copy-paste friendly command documentation. Signed-off-by: Nishanth Menon <nm@ti.com>
This commit is contained in:
Nishanth Menon
Heinrich Schuchardt
parent
81cf99e723
commit
ca845d20e6
|
|
@ -55,15 +55,15 @@ Set the variables corresponding to this platform:
|
|||
.. include:: k3.rst
|
||||
:start-after: .. k3_rst_include_start_common_env_vars_defn
|
||||
:end-before: .. k3_rst_include_end_common_env_vars_defn
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
$ export UBOOT_CFG_CORTEXR="am62x_evm_r5_defconfig beagleplay_r5.config"
|
||||
$ export UBOOT_CFG_CORTEXA="am62x_evm_a53_defconfig beagleplay_a53.config"
|
||||
$ export TFA_BOARD=lite
|
||||
$ # we dont use any extra TFA parameters
|
||||
$ unset TFA_EXTRA_ARGS
|
||||
$ export OPTEE_PLATFORM=k3-am62x
|
||||
$ export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
|
||||
export UBOOT_CFG_CORTEXR="am62x_evm_r5_defconfig beagleplay_r5.config"
|
||||
export UBOOT_CFG_CORTEXA="am62x_evm_a53_defconfig beagleplay_a53.config"
|
||||
export TFA_BOARD=lite
|
||||
# we dont use any extra TFA parameters
|
||||
unset TFA_EXTRA_ARGS
|
||||
export OPTEE_PLATFORM=k3-am62x
|
||||
export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
|
||||
|
||||
.. include:: am62x_sk.rst
|
||||
:start-after: .. am62x_evm_rst_include_start_build_steps
|
||||
|
|
@ -174,24 +174,24 @@ boot1 partition depends on A/B update requirements.
|
|||
|
||||
The following are the steps from Linux shell to program eMMC:
|
||||
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash #
|
||||
|
||||
# # Enable Boot0 boot
|
||||
# mmc bootpart enable 1 2 /dev/mmcblk0
|
||||
# mmc bootbus set single_backward x1 x8 /dev/mmcblk0
|
||||
# mmc hwreset enable /dev/mmcblk0
|
||||
# Enable Boot0 boot
|
||||
mmc bootpart enable 1 2 /dev/mmcblk0
|
||||
mmc bootbus set single_backward x1 x8 /dev/mmcblk0
|
||||
mmc hwreset enable /dev/mmcblk0
|
||||
|
||||
# # Clear eMMC boot0
|
||||
# echo '0' >> /sys/class/block/mmcblk0boot0/force_ro
|
||||
# dd if=/dev/zero of=/dev/mmcblk0boot0 count=32 bs=128k
|
||||
# # Write tiboot3.bin
|
||||
# dd if=tiboot3.bin of=/dev/mmcblk0boot0 bs=128k
|
||||
# Clear eMMC boot0
|
||||
echo '0' >> /sys/class/block/mmcblk0boot0/force_ro
|
||||
dd if=/dev/zero of=/dev/mmcblk0boot0 count=32 bs=128k
|
||||
# Write tiboot3.bin
|
||||
dd if=tiboot3.bin of=/dev/mmcblk0boot0 bs=128k
|
||||
|
||||
# # Copy the rest of the boot binaries
|
||||
# mount /dev/mmcblk0p1 /boot/firmware
|
||||
# cp tispl.bin /boot/firmware
|
||||
# cp u-boot.img /boot/firmware
|
||||
# sync
|
||||
# Copy the rest of the boot binaries
|
||||
mount /dev/mmcblk0p1 /boot/firmware
|
||||
cp tispl.bin /boot/firmware
|
||||
cp u-boot.img /boot/firmware
|
||||
sync
|
||||
|
||||
.. warning ::
|
||||
|
||||
|
|
|
|||
|
|
@ -76,15 +76,15 @@ Set the variables corresponding to this platform:
|
|||
.. include:: ../ti/k3.rst
|
||||
:start-after: .. k3_rst_include_start_common_env_vars_defn
|
||||
:end-before: .. k3_rst_include_end_common_env_vars_defn
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
$ export UBOOT_CFG_CORTEXR=am62x_evm_r5_defconfig
|
||||
$ export UBOOT_CFG_CORTEXA=am62x_evm_a53_defconfig
|
||||
$ export TFA_BOARD=lite
|
||||
$ # we dont use any extra TFA parameters
|
||||
$ unset TFA_EXTRA_ARGS
|
||||
$ export OPTEE_PLATFORM=k3-am62x
|
||||
$ export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
|
||||
export UBOOT_CFG_CORTEXR=am62x_evm_r5_defconfig
|
||||
export UBOOT_CFG_CORTEXA=am62x_evm_a53_defconfig
|
||||
export TFA_BOARD=lite
|
||||
# we dont use any extra TFA parameters
|
||||
unset TFA_EXTRA_ARGS
|
||||
export OPTEE_PLATFORM=k3-am62x
|
||||
export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
|
||||
|
||||
.. am62x_evm_rst_include_start_build_steps
|
||||
|
||||
|
|
@ -271,6 +271,6 @@ detailed setup information.
|
|||
|
||||
To start OpenOCD and connect to the board
|
||||
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
openocd -f board/ti_am625evm.cfg
|
||||
|
|
|
|||
|
|
@ -65,16 +65,16 @@ Set the variables corresponding to this platform:
|
|||
.. include:: k3.rst
|
||||
:start-after: .. k3_rst_include_start_common_env_vars_defn
|
||||
:end-before: .. k3_rst_include_end_common_env_vars_defn
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
$ export UBOOT_CFG_CORTEXR=am64x_evm_r5_defconfig
|
||||
$ export UBOOT_CFG_CORTEXA=am64x_evm_a53_defconfig
|
||||
$ export TFA_BOARD=lite
|
||||
$ # we dont use any extra TFA parameters
|
||||
$ unset TFA_EXTRA_ARGS
|
||||
$ export OPTEE_PLATFORM=k3-am64x
|
||||
$ # we dont use any extra TFA parameters
|
||||
$ unset OPTEE_EXTRA_ARGS
|
||||
export UBOOT_CFG_CORTEXR=am64x_evm_r5_defconfig
|
||||
export UBOOT_CFG_CORTEXA=am64x_evm_a53_defconfig
|
||||
export TFA_BOARD=lite
|
||||
# we dont use any extra TFA parameters
|
||||
unset TFA_EXTRA_ARGS
|
||||
export OPTEE_PLATFORM=k3-am64x
|
||||
# we dont use any extra TFA parameters
|
||||
unset OPTEE_EXTRA_ARGS
|
||||
|
||||
.. am64x_evm_rst_include_start_build_steps
|
||||
|
||||
|
|
|
|||
|
|
@ -75,16 +75,16 @@ Set the variables corresponding to this platform:
|
|||
.. include:: k3.rst
|
||||
:start-after: .. k3_rst_include_start_common_env_vars_defn
|
||||
:end-before: .. k3_rst_include_end_common_env_vars_defn
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
$ export UBOOT_CFG_CORTEXR=am65x_evm_r5_defconfig
|
||||
$ export UBOOT_CFG_CORTEXA=am65x_evm_a53_defconfig
|
||||
$ export TFA_BOARD=generic
|
||||
$ # we dont use any extra TFA parameters
|
||||
$ unset TFA_EXTRA_ARGS
|
||||
$ export OPTEE_PLATFORM=k3-am65x
|
||||
$ # we dont use any extra OP-TEE parameters
|
||||
$ unset OPTEE_EXTRA_ARGS
|
||||
export UBOOT_CFG_CORTEXR=am65x_evm_r5_defconfig
|
||||
export UBOOT_CFG_CORTEXA=am65x_evm_a53_defconfig
|
||||
export TFA_BOARD=generic
|
||||
# we dont use any extra TFA parameters
|
||||
unset TFA_EXTRA_ARGS
|
||||
export OPTEE_PLATFORM=k3-am65x
|
||||
# we dont use any extra OP-TEE parameters
|
||||
unset OPTEE_EXTRA_ARGS
|
||||
|
||||
.. am65x_evm_rst_include_start_build_steps
|
||||
|
||||
|
|
@ -160,32 +160,32 @@ The following commands can be used to download tiboot3.bin, tispl.bin,
|
|||
u-boot.img, and sysfw.itb from an SD card and write them to the eMMC boot0
|
||||
partition at respective addresses.
|
||||
|
||||
.. code-block:: text
|
||||
.. prompt:: bash =>
|
||||
|
||||
=> mmc dev 0 1
|
||||
=> fatload mmc 1 ${loadaddr} tiboot3.bin
|
||||
=> mmc write ${loadaddr} 0x0 0x400
|
||||
=> fatload mmc 1 ${loadaddr} tispl.bin
|
||||
=> mmc write ${loadaddr} 0x400 0x1000
|
||||
=> fatload mmc 1 ${loadaddr} u-boot.img
|
||||
=> mmc write ${loadaddr} 0x1400 0x2000
|
||||
=> fatload mmc 1 ${loadaddr} sysfw.itb
|
||||
=> mmc write ${loadaddr} 0x3600 0x800
|
||||
mmc dev 0 1
|
||||
fatload mmc 1 ${loadaddr} tiboot3.bin
|
||||
mmc write ${loadaddr} 0x0 0x400
|
||||
fatload mmc 1 ${loadaddr} tispl.bin
|
||||
mmc write ${loadaddr} 0x400 0x1000
|
||||
fatload mmc 1 ${loadaddr} u-boot.img
|
||||
mmc write ${loadaddr} 0x1400 0x2000
|
||||
fatload mmc 1 ${loadaddr} sysfw.itb
|
||||
mmc write ${loadaddr} 0x3600 0x800
|
||||
|
||||
To give the ROM access to the boot partition, the following commands must be
|
||||
used for the first time:
|
||||
|
||||
.. code-block:: text
|
||||
.. prompt:: bash =>
|
||||
|
||||
=> mmc partconf 0 1 1 1
|
||||
=> mmc bootbus 0 1 0 0
|
||||
mmc partconf 0 1 1 1
|
||||
mmc bootbus 0 1 0 0
|
||||
|
||||
To create a software partition for the rootfs, the following command can be
|
||||
used:
|
||||
|
||||
.. code-block:: text
|
||||
.. prompt:: bash =>
|
||||
|
||||
=> gpt write mmc 0 ${partitions}
|
||||
gpt write mmc 0 ${partitions}
|
||||
|
||||
eMMC layout:
|
||||
|
||||
|
|
@ -195,11 +195,11 @@ eMMC layout:
|
|||
Kernel image and DT are expected to be present in the /boot folder of rootfs.
|
||||
To boot kernel from eMMC, use the following commands:
|
||||
|
||||
.. code-block:: text
|
||||
.. prompt:: bash =>
|
||||
|
||||
=> setenv mmcdev 0
|
||||
=> setenv bootpart 0
|
||||
=> boot
|
||||
setenv mmcdev 0
|
||||
setenv bootpart 0
|
||||
boot
|
||||
|
||||
OSPI:
|
||||
-----
|
||||
|
|
@ -211,17 +211,17 @@ Below commands can be used to download tiboot3.bin, tispl.bin, u-boot.img,
|
|||
and sysfw.itb over tftp and then flash those to OSPI at their respective
|
||||
addresses.
|
||||
|
||||
.. code-block:: text
|
||||
.. prompt:: bash =>
|
||||
|
||||
=> sf probe
|
||||
=> tftp ${loadaddr} tiboot3.bin
|
||||
=> sf update $loadaddr 0x0 $filesize
|
||||
=> tftp ${loadaddr} tispl.bin
|
||||
=> sf update $loadaddr 0x80000 $filesize
|
||||
=> tftp ${loadaddr} u-boot.img
|
||||
=> sf update $loadaddr 0x280000 $filesize
|
||||
=> tftp ${loadaddr} sysfw.itb
|
||||
=> sf update $loadaddr 0x6C0000 $filesize
|
||||
sf probe
|
||||
tftp ${loadaddr} tiboot3.bin
|
||||
sf update $loadaddr 0x0 $filesize
|
||||
tftp ${loadaddr} tispl.bin
|
||||
sf update $loadaddr 0x80000 $filesize
|
||||
tftp ${loadaddr} u-boot.img
|
||||
sf update $loadaddr 0x280000 $filesize
|
||||
tftp ${loadaddr} sysfw.itb
|
||||
sf update $loadaddr 0x6C0000 $filesize
|
||||
|
||||
Flash layout for OSPI:
|
||||
|
||||
|
|
@ -234,10 +234,10 @@ ospi.rootfs just like in SD card case. U-Boot looks for UBI volume named
|
|||
|
||||
To boot kernel from OSPI, at the U-Boot prompt:
|
||||
|
||||
.. code-block:: text
|
||||
.. prompt:: bash =>
|
||||
|
||||
=> setenv boot ubi
|
||||
=> boot
|
||||
setenv boot ubi
|
||||
boot
|
||||
|
||||
UART:
|
||||
-----
|
||||
|
|
@ -281,19 +281,19 @@ is fully loaded (from sysfw.itb) and started.
|
|||
Example bash script sequence for running on a Linux host PC feeding all boot
|
||||
artifacts needed to the device:
|
||||
|
||||
.. code-block:: text
|
||||
.. prompt:: bash $
|
||||
|
||||
MCU_DEV=/dev/ttyUSB1
|
||||
MAIN_DEV=/dev/ttyUSB0
|
||||
MCU_DEV=/dev/ttyUSB1
|
||||
MAIN_DEV=/dev/ttyUSB0
|
||||
|
||||
stty -F $MCU_DEV 115200 cs8 -cstopb -parenb
|
||||
stty -F $MAIN_DEV 115200 cs8 -cstopb -parenb
|
||||
stty -F $MCU_DEV 115200 cs8 -cstopb -parenb
|
||||
stty -F $MAIN_DEV 115200 cs8 -cstopb -parenb
|
||||
|
||||
sb --xmodem tiboot3.bin > $MCU_DEV < $MCU_DEV
|
||||
sb --ymodem sysfw.itb > $MCU_DEV < $MCU_DEV
|
||||
sb --ymodem tispl.bin > $MAIN_DEV < $MAIN_DEV
|
||||
sleep 1
|
||||
sb --xmodem u-boot.img > $MAIN_DEV < $MAIN_DEV
|
||||
sb --xmodem tiboot3.bin > $MCU_DEV < $MCU_DEV
|
||||
sb --ymodem sysfw.itb > $MCU_DEV < $MCU_DEV
|
||||
sb --ymodem tispl.bin > $MAIN_DEV < $MAIN_DEV
|
||||
sleep 1
|
||||
sb --xmodem u-boot.img > $MAIN_DEV < $MAIN_DEV
|
||||
|
||||
Debugging U-Boot
|
||||
----------------
|
||||
|
|
@ -315,6 +315,6 @@ detailed setup information.
|
|||
|
||||
To start OpenOCD and connect to the board
|
||||
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
openocd -f board/ti_am654evm.cfg
|
||||
|
|
|
|||
|
|
@ -64,16 +64,16 @@ Set the variables corresponding to this platform:
|
|||
.. include:: k3.rst
|
||||
:start-after: .. k3_rst_include_start_common_env_vars_defn
|
||||
:end-before: .. k3_rst_include_end_common_env_vars_defn
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
$ export UBOOT_CFG_CORTEXR=j7200_evm_r5_defconfig
|
||||
$ export UBOOT_CFG_CORTEXA=j7200_evm_a72_defconfig
|
||||
$ export TFA_BOARD=generic
|
||||
$ # we dont use any extra TFA parameters
|
||||
$ unset TFA_EXTRA_ARGS
|
||||
$ export OPTEE_PLATFORM=k3-j721e
|
||||
$ # we dont use any extra OP-TEE parameters
|
||||
$ unset OPTEE_EXTRA_ARGS
|
||||
export UBOOT_CFG_CORTEXR=j7200_evm_r5_defconfig
|
||||
export UBOOT_CFG_CORTEXA=j7200_evm_a72_defconfig
|
||||
export TFA_BOARD=generic
|
||||
# we dont use any extra TFA parameters
|
||||
unset TFA_EXTRA_ARGS
|
||||
export OPTEE_PLATFORM=k3-j7200
|
||||
# we dont use any extra OP-TEE parameters
|
||||
unset OPTEE_EXTRA_ARGS
|
||||
|
||||
.. j7200_evm_rst_include_start_build_steps
|
||||
|
||||
|
|
@ -226,6 +226,6 @@ detailed setup information.
|
|||
|
||||
To start OpenOCD and connect to the board
|
||||
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
openocd -f board/ti_j7200evm.cfg
|
||||
|
|
|
|||
|
|
@ -69,16 +69,16 @@ Set the variables corresponding to this platform:
|
|||
.. include:: k3.rst
|
||||
:start-after: .. k3_rst_include_start_common_env_vars_defn
|
||||
:end-before: .. k3_rst_include_end_common_env_vars_defn
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
$ export UBOOT_CFG_CORTEXR=j721e_evm_r5_defconfig
|
||||
$ export UBOOT_CFG_CORTEXA=j721e_evm_a72_defconfig
|
||||
$ export TFA_BOARD=generic
|
||||
$ # we dont use any extra TFA parameters
|
||||
$ unset TFA_EXTRA_ARGS
|
||||
$ export OPTEE_PLATFORM=k3-j721e
|
||||
$ # we dont use any extra OP-TEE parameters
|
||||
$ unset OPTEE_EXTRA_ARGS
|
||||
export UBOOT_CFG_CORTEXR=j721e_evm_r5_defconfig
|
||||
export UBOOT_CFG_CORTEXA=j721e_evm_a72_defconfig
|
||||
export TFA_BOARD=generic
|
||||
# we dont use any extra TFA parameters
|
||||
unset TFA_EXTRA_ARGS
|
||||
export OPTEE_PLATFORM=k3-j721e
|
||||
# we dont use any extra OP-TEE parameters
|
||||
unset OPTEE_EXTRA_ARGS
|
||||
|
||||
.. j721e_evm_rst_include_start_build_steps
|
||||
|
||||
|
|
@ -203,17 +203,17 @@ Below commands can be used to download tiboot3.bin, tispl.bin, u-boot.img,
|
|||
and sysfw.itb over tftp and then flash those to OSPI at their respective
|
||||
addresses.
|
||||
|
||||
.. code-block:: text
|
||||
.. prompt:: bash =>
|
||||
|
||||
=> sf probe
|
||||
=> tftp ${loadaddr} tiboot3.bin
|
||||
=> sf update $loadaddr 0x0 $filesize
|
||||
=> tftp ${loadaddr} tispl.bin
|
||||
=> sf update $loadaddr 0x80000 $filesize
|
||||
=> tftp ${loadaddr} u-boot.img
|
||||
=> sf update $loadaddr 0x280000 $filesize
|
||||
=> tftp ${loadaddr} sysfw.itb
|
||||
=> sf update $loadaddr 0x6C0000 $filesize
|
||||
sf probe
|
||||
tftp ${loadaddr} tiboot3.bin
|
||||
sf update $loadaddr 0x0 $filesize
|
||||
tftp ${loadaddr} tispl.bin
|
||||
sf update $loadaddr 0x80000 $filesize
|
||||
tftp ${loadaddr} u-boot.img
|
||||
sf update $loadaddr 0x280000 $filesize
|
||||
tftp ${loadaddr} sysfw.itb
|
||||
sf update $loadaddr 0x6C0000 $filesize
|
||||
|
||||
Flash layout for OSPI:
|
||||
|
||||
|
|
@ -255,6 +255,6 @@ detailed setup information.
|
|||
|
||||
To start OpenOCD and connect to the board
|
||||
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
openocd -f board/ti_j721eevm.cfg
|
||||
|
|
|
|||
|
|
@ -78,15 +78,15 @@ Set the variables corresponding to this platform:
|
|||
.. include:: k3.rst
|
||||
:start-after: .. k3_rst_include_start_common_env_vars_defn
|
||||
:end-before: .. k3_rst_include_end_common_env_vars_defn
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
$ export UBOOT_CFG_CORTEXR=j721s2_evm_r5_defconfig
|
||||
$ export UBOOT_CFG_CORTEXA=j721s2_evm_a72_defconfig
|
||||
$ export TFA_BOARD=generic
|
||||
$ export TFA_EXTRA_ARGS="K3_USART=0x8"
|
||||
$ # The following is not a typo, j784s4 is the OP-TEE platform for j721s2
|
||||
$ export OPTEE_PLATFORM=k3-j784s4
|
||||
$ export OPTEE_EXTRA_ARGS="CFG_CONSOLE_UART=0x8"
|
||||
export UBOOT_CFG_CORTEXR=j721s2_evm_r5_defconfig
|
||||
export UBOOT_CFG_CORTEXA=j721s2_evm_a72_defconfig
|
||||
export TFA_BOARD=generic
|
||||
export TFA_EXTRA_ARGS="K3_USART=0x8"
|
||||
# The following is not a typo, j784s4 is the OP-TEE platform for j721s2
|
||||
export OPTEE_PLATFORM=k3-j784s4
|
||||
export OPTEE_EXTRA_ARGS="CFG_CONSOLE_UART=0x8"
|
||||
|
||||
.. j721s2_evm_rst_include_start_build_steps
|
||||
|
||||
|
|
@ -300,7 +300,7 @@ Debugging U-Boot on J721S2-EVM
|
|||
|
||||
To start OpenOCD and connect to the board
|
||||
|
||||
.. code-block:: bash
|
||||
.. prompt:: bash $
|
||||
|
||||
openocd -f board/ti_j721s2evm.cfg
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user