doc: board; ti: Misc fixups
cover doc: board; ti: Misc fixups
A series of fixups based on next
7e6e40c57233 (origin/next) Merge tag 'v2023.10-rc3' into next
This consists of Henrich's patches that I have updated (details in the patches) + a few misc items seen in documentation.
Heinrich Schuchardt (3):
doc: board: ti: k3: image alt texts
doc: board: ti: am62x: provide image alt texts
doc: board: ti: am65x: provide image alt text
Nishanth Menon (10):
doc: board: ti: k3: Fixup alt text for openocd sequence
doc: board: ti: am64x: provide image alt text
doc: board: ti: j7200: provide image alt text
doc: board: ti: j721e: provide image alt text
doc: board: ti: am62x: Fix build step numbering
doc: board: ti: am64x: Fix build step numbering
doc: board: ti: am65x: Fix build step numbering
doc: board: ti: j7200: Fix build step numbering
doc: board: ti: j721e: Fix build step numbering
doc: board: ti: k3: Elaborate on various firmware
doc/board/ti/am62x_sk.rst | 7 +++++-- doc/board/ti/am64x_evm.rst | 7 +++++-- doc/board/ti/am65x_evm.rst | 18 ++++++++++++------ doc/board/ti/j7200_evm.rst | 23 +++++++++++++---------- doc/board/ti/j721e_evm.rst | 21 +++++++++++++-------- doc/board/ti/k3.rst | 25 ++++++++++++++++++++++++- 6 files changed, 72 insertions(+), 29 deletions(-)
Signature · 1 line
2.40.0
PATCH 1/13 doc: board: ti: k3: image alt texts
From: Heinrich Schuchardt <[email protected]>
Provide alternative texts for images.
---
Changes since v1:
* Minor expansion of WKUP domain, main domain.
V1: https://lore.kernel.org/r/[email protected]
doc/board/ti/k3.rst | 3 +++ 1 file changed, 3 insertions(+)
doc/board/ti/k3.rst +3 -0
@@ -48,6 +48,7 @@ including a 32bit U-Boot SPL, (called the wakup SPL) that ROM will jump to after it has finished loading everything into internal SRAM. .. image:: img/boot_flow_01.svg + :alt: Boot flow up to wakeup domain SPL The wakeup SPL, running on a wakeup domain core, will initialize DDR and any peripherals needed load the larger binaries inside the `tispl.bin`
@@ -57,6 +58,7 @@ starting with Trusted Firmware-A (TF-A), before moving on to start OP-TEE and the main domain's U-Boot SPL. .. image:: img/boot_flow_02.svg + :alt: Boot flow up to main domain SPL The main domain's SPL, running on a 64bit application core, has virtually unlimited space (billions of bytes now that DDR is working) to
@@ -65,6 +67,7 @@ which loads more firmware into the micro-controller & wakeup domains and finally prepare the main domain to run Linux. .. image:: img/boot_flow_03.svg + :alt: Complete boot flow up to Linux This is the typical boot flow for all K3 based SoCs, however this flow offers quite a lot in the terms of flexibility, especially on High
Signature · 1 line
2.40.0
PATCH 2/13 doc: board: ti: k3: Fixup alt text for openocd sequence
In reply to Nishanth MenonFix up OpenOCD setup sequence
---
New in the series.
doc/board/ti/k3.rst | 1 + 1 file changed, 1 insertion(+)
doc/board/ti/k3.rst +1 -0
@@ -489,6 +489,7 @@ generation device. The overall structure of this setup is in the following figure. .. image:: img/openocd-overview.svg + :alt: Overview of OpenOCD setup. .. note::
Signature · 1 line
2.40.0
PATCH 3/13 doc: board: ti: am62x: provide image alt texts
In reply to Nishanth MenonFrom: Heinrich Schuchardt <[email protected]>
Provide alternative texts for images.
---
No change.
V1: https://lore.kernel.org/r/[email protected]
doc/board/ti/am62x_sk.rst | 3 +++ 1 file changed, 3 insertions(+)
doc/board/ti/am62x_sk.rst +3 -0
@@ -47,6 +47,7 @@ Boot Flow: Below is the pictorial representation of boot flow: .. image:: img/boot_diagram_k3_current.svg + :alt: Boot flow diagram - Here TIFS acts as master and provides all the critical services. R5/A53 requests TIFS to get these services done as shown in the above diagram.
@@ -141,10 +142,12 @@ Image formats: - tiboot3.bin .. image:: img/multi_cert_tiboot3.bin.svg + :alt: tiboot3.bin image format - tispl.bin .. image:: img/dm_tispl.bin.svg + :alt: tispl.bin image format A53 SPL DDR Memory Layout -------------------------
Signature · 1 line
2.40.0
PATCH 4/13 doc: board: ti: am64x: provide image alt text
In reply to Nishanth MenonProvide alternative text for image.
---
new
doc/board/ti/am64x_evm.rst | 3 +++ 1 file changed, 3 insertions(+)
doc/board/ti/am64x_evm.rst +3 -0
@@ -36,6 +36,7 @@ Boot Flow: Below is the pictorial representation of boot flow: .. image:: img/boot_diagram_am64.svg + :alt: Boot flow diagram - Here TIFS acts as master and provides all the critical services. R5/A53 requests TIFS to get these services done as shown in the above diagram.
@@ -131,10 +132,12 @@ Image formats: - tiboot3.bin .. image:: img/multi_cert_tiboot3.bin.svg + :alt: tiboot3.bin image format - tispl.bin .. image:: img/nodm_tispl.bin.svg + :alt: tispl.bin image format Switch Setting for Boot Mode ----------------------------
Signature · 1 line
2.40.0
Re: [PATCH 04/13] doc: board: ti: am64x: provide image alt text
Quoted 5 lines · Nishanth Menon
Provide alternative text for image.
Fixes 4bf49bade124 ("doc: board: ti: am64: Add boot flow diagram")Reported-by Heinrich Schuchardt<[email protected]>Signed-off-by Nishanth Menon<[email protected]>
This patch is only applicable to the next branch (2024.01).
PATCH 5/13 doc: board: ti: am65x: provide image alt text
In reply to Nishanth MenonFrom: Heinrich Schuchardt <[email protected]>
Provide alternative text for image.
---
Changes:
* Added missing updates of alt tag
* Fixed up a few text info
* now based on next
V1: https://lore.kernel.org/r/[email protected]
doc/board/ti/am65x_evm.rst | 6 ++++++ 1 file changed, 6 insertions(+)
doc/board/ti/am65x_evm.rst +6 -0
@@ -46,6 +46,7 @@ applications. This should happen before running Linux. instead use Falcon boot flow to reduce boot time. .. image:: img/boot_diagram_am65.svg + :alt: Boot flow diagram - Here DMSC acts as master and provides all the critical services. R5/A53 requests DMSC to get these services done as shown in the above diagram.
@@ -136,14 +137,17 @@ Image formats: - tiboot3.bin .. image:: img/no_multi_cert_tiboot3.bin.svg + :alt: tiboot3.bin image format - tispl.bin .. image:: img/nodm_tispl.bin.svg + :alt: tispl.bin image format - sysfw.itb .. image:: img/sysfw.itb.svg + :alt: sysfw.itb image format eMMC: -----
@@ -185,6 +189,7 @@ used: eMMC layout: .. image:: img/emmc_am65x_evm_boot0.svg + :alt: emmc boot partition 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:
@@ -220,6 +225,7 @@ addresses. Flash layout for OSPI: .. image:: img/ospi_sysfw.svg + :alt: OSPI flash partition layout Kernel Image and DT are expected to be present in the /boot folder of UBIFS ospi.rootfs just like in SD card case. U-Boot looks for UBI volume named
Signature · 1 line
2.40.0
PATCH 6/13 doc: board: ti: j7200: provide image alt text
In reply to Nishanth MenonProvide alternative text for image.
---
new
doc/board/ti/j7200_evm.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
doc/board/ti/j7200_evm.rst +5 -2
@@ -35,6 +35,7 @@ Boot Flow: Below is the pictorial representation of boot flow: .. image:: img/boot_diagram_k3_current.svg + :alt: Boot flow diagram - Here DMSC acts as master and provides all the critical services. R5/A72 requests DMSC to get these services done as shown in the above diagram.
@@ -130,12 +131,12 @@ Image formats: - tiboot3.bin .. image:: img/j7200_tiboot3.bin.svg + :alt: tiboot3.bin image format - tispl.bin .. image:: img/dm_tispl.bin.svg - - + :alt: tispl.bin image format Switch Setting for Boot Mode ----------------------------
@@ -191,6 +192,7 @@ Size of u-boot.img is taken 4MB for refernece, But this is subject to change depending upon atf, optee size .. image:: img/emmc_j7200_evm_boot01.svg + :alt: Traditional eMMC boot partition layout In case of UDA FS mode booting, following is layout.
@@ -198,6 +200,7 @@ All boot images tiboot3.bin, tispl and u-boot should be written to fat formatted UDA FS as file. .. image:: img/emmc_j7200_evm_udafs.svg + :alt: eMMC UDA boot partition layout In case of booting from eMMC, write above images into raw or UDA FS. and set mmc partconf accordingly.
Signature · 1 line
2.40.0
PATCH 7/13 doc: board: ti: j721e: provide image alt text
In reply to Nishanth MenonProvide alternative text for image.
---
new
doc/board/ti/j721e_evm.rst | 5 +++++ 1 file changed, 5 insertions(+)
doc/board/ti/j721e_evm.rst +5 -0
@@ -40,6 +40,7 @@ Boot flow is similar to that of AM65x SoC and extending it with remoteproc support. Below is the pictorial representation of boot flow: .. image:: img/boot_diagram_j721e.svg + :alt: Boot flow diagram - Here DMSC acts as master and provides all the critical services. R5/A72 requests DMSC to get these services done as shown in the above diagram.
@@ -136,14 +137,17 @@ Image formats: - tiboot3.bin .. image:: img/no_multi_cert_tiboot3.bin.svg + :alt: tiboot3.bin image format - tispl.bin .. image:: img/dm_tispl.bin.svg + :alt: tispl.bin image format - sysfw.itb .. image:: img/sysfw.itb.svg + :alt: sysfw.itb image format R5 Memory Map: --------------
@@ -213,6 +217,7 @@ addresses. Flash layout for OSPI: .. image:: img/ospi_sysfw.svg + :alt: OSPI flash partition layout Firmwares: ----------
Signature · 1 line
2.40.0
PATCH 8/13 doc: board: ti: am62x: Fix build step numbering
In reply to Nishanth MenonFix up build step numbering.
--- doc/board/ti/am62x_sk.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
doc/board/ti/am62x_sk.rst +2 -2
@@ -103,13 +103,13 @@ Set the variables corresponding to this platform: 3. U-Boot: -* 4.1 R5: +* 3.1 R5: .. include:: ../ti/k3.rst :start-after: .. k3_rst_include_start_build_steps_spl_r5 :end-before: .. k3_rst_include_end_build_steps_spl_r5 -* 4.2 A53: +* 3.2 A53: .. include:: ../ti/k3.rst :start-after: .. k3_rst_include_start_build_steps_uboot
Signature · 1 line
2.40.0
PATCH 9/13 doc: board: ti: am64x: Fix build step numbering
In reply to Nishanth MenonFix up build step numbering.
--- doc/board/ti/am64x_evm.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
doc/board/ti/am64x_evm.rst +2 -2
@@ -93,13 +93,13 @@ Set the variables corresponding to this platform: 3. U-Boot: -* 4.1 R5: +* 3.1 R5: .. include:: k3.rst :start-after: .. k3_rst_include_start_build_steps_spl_r5 :end-before: .. k3_rst_include_end_build_steps_spl_r5 -* 4.2 A53: +* 3.2 A53: .. include:: k3.rst :start-after: .. k3_rst_include_start_build_steps_uboot
Signature · 1 line
2.40.0
Re: [PATCH 09/13] doc: board: ti: am64x: Fix build step numbering
Quoted 4 lines · Nishanth Menon
Fix up build step numbering.
Fixes 4bf49bade124 ("doc: board: ti: am64: Add boot flow diagram")Signed-off-by Nishanth Menon<[email protected]>
This patch is only applicable to the next branch (2024.01).
PATCH 10/13 doc: board: ti: am65x: Fix build step numbering
In reply to Nishanth MenonFix up build step numbering.
--- doc/board/ti/am65x_evm.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
doc/board/ti/am65x_evm.rst +6 -6
@@ -103,13 +103,13 @@ Set the variables corresponding to this platform: 3. U-Boot: -* 4.1 R5: +* 3.1 R5: .. include:: k3.rst :start-after: .. k3_rst_include_start_build_steps_spl_r5 :end-before: .. k3_rst_include_end_build_steps_spl_r5 -* 4.2 A53: +* 3.2 A53: .. include:: k3.rst :start-after: .. k3_rst_include_start_build_steps_uboot
@@ -123,13 +123,13 @@ Each SoC variant (GP and HS) requires a different source for these files. - GP - * tiboot3-am65x_sr2-gp-evm.bin, sysfw-am65x_sr2-gp-evm.itb from step 4.1 - * tispl.bin_unsigned, u-boot.img_unsigned from step 4.2 + * tiboot3-am65x_sr2-gp-evm.bin, sysfw-am65x_sr2-gp-evm.itb from step 3.1 + * tispl.bin_unsigned, u-boot.img_unsigned from step 3.2 - HS - * tiboot3-am65x_sr2-hs-evm.bin, sysfw-am65x_sr2-hs-evm.itb from step 4.1 - * tispl.bin, u-boot.img from step 4.2 + * tiboot3-am65x_sr2-hs-evm.bin, sysfw-am65x_sr2-hs-evm.itb from step 3.1 + * tispl.bin, u-boot.img from step 3.2 Image formats: --------------
Signature · 1 line
2.40.0
PATCH 11/13 doc: board: ti: j7200: Fix build step numbering
In reply to Nishanth MenonFix up build step numbering.
--- doc/board/ti/j7200_evm.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
doc/board/ti/j7200_evm.rst +8 -8
@@ -92,13 +92,13 @@ Set the variables corresponding to this platform: 3. U-Boot: -* 4.1 R5: +* 3.1 R5: .. include:: k3.rst :start-after: .. k3_rst_include_start_build_steps_spl_r5 :end-before: .. k3_rst_include_end_build_steps_spl_r5 -* 4.2 A72: +* 3.2 A72: .. include:: k3.rst :start-after: .. k3_rst_include_start_build_steps_uboot
@@ -112,18 +112,18 @@ variant (GP, HS-FS, HS-SE) requires a different source for these files. - GP - * tiboot3-j7200-gp-evm.bin from step 4.1 - * tispl.bin_unsigned, u-boot.img_unsigned from step 4.2 + * tiboot3-j7200-gp-evm.bin from step 3.1 + * tispl.bin_unsigned, u-boot.img_unsigned from step 3.2 - HS-FS - * tiboot3-j7200_sr2-hs-fs-evm.bin from step 4.1 - * tispl.bin, u-boot.img from step 4.2 + * tiboot3-j7200_sr2-hs-fs-evm.bin from step 3.1 + * tispl.bin, u-boot.img from step 3.2 - HS-SE - * tiboot3-j7200_sr2-hs-evm.bin from step 4.1 - * tispl.bin, u-boot.img from step 4.2 + * tiboot3-j7200_sr2-hs-evm.bin from step 3.1 + * tispl.bin, u-boot.img from step 3.2 Image formats: --------------
Signature · 1 line
2.40.0
PATCH 12/13 doc: board: ti: j721e: Fix build step numbering
In reply to Nishanth MenonFix up build step numbering.
--- doc/board/ti/j721e_evm.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
doc/board/ti/j721e_evm.rst +8 -8
@@ -97,13 +97,13 @@ Set the variables corresponding to this platform: 3. U-Boot: -* 4.1 R5: +* 3.1 R5: .. include:: k3.rst :start-after: .. k3_rst_include_start_build_steps_spl_r5 :end-before: .. k3_rst_include_end_build_steps_spl_r5 -* 4.2 A72: +* 3.2 A72: .. include:: k3.rst :start-after: .. k3_rst_include_start_build_steps_uboot
@@ -118,18 +118,18 @@ files. - GP - * tiboot3-j721e-gp-evm.bin, sysfw-j721e-gp-evm.itb from step 4.1 - * tispl.bin_unsigned, u-boot.img_unsigned from step 4.2 + * tiboot3-j721e-gp-evm.bin, sysfw-j721e-gp-evm.itb from step 3.1 + * tispl.bin_unsigned, u-boot.img_unsigned from step 3.2 - HS-FS - * tiboot3-j721e_sr2-hs-fs-evm.bin, sysfw-j721e_sr2-hs-fs-evm.itb from step 4.1 - * tispl.bin, u-boot.img from step 4.2 + * tiboot3-j721e_sr2-hs-fs-evm.bin, sysfw-j721e_sr2-hs-fs-evm.itb from step 3.1 + * tispl.bin, u-boot.img from step 3.2 - HS-SE - * tiboot3-j721e_sr2-hs-evm.bin, sysfw-j721e_sr2-hs-evm.itb from step 4.1 - * tispl.bin, u-boot.img from step 4.2 + * tiboot3-j721e_sr2-hs-evm.bin, sysfw-j721e_sr2-hs-evm.itb from step 3.1 + * tispl.bin, u-boot.img from step 3.2 Image formats: --------------
Signature · 1 line
2.40.0
PATCH 13/13 doc: board: ti: k3: Elaborate on various firmware
In reply to Nishanth MenonAdd elaboration text for the various firmware involved for system management.
--- doc/board/ti/k3.rst | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-)
doc/board/ti/k3.rst +20 -1
@@ -124,11 +124,30 @@ online | **source:** https://github.com/OP-TEE/optee_os.git | **branch:** master -* **TI Firmware (TIFS, DM, DSMC)** +* **TI Firmware (TIFS, DM, SYSFW)** | **source:** https://git.ti.com/git/processor-firmware/ti-linux-firmware.git | **branch:** ti-linux-firmware +.. note:: + + The TI Firmware required for functionality of the system can be + one of the following combination (see platform specific boot diagram for + further information as to which component runs on which processor): + + * **TIFS** - TI Foundational Security Firmware - Consists of purely firmware + meant to run on the security enclave. + * **DM** - Device Management firmware also called TI System Control Interface + server (TISCI Server) - This component purely plays the role of managing + device resources such as power, clock, interrupts, dma etc. This firmware + runs on a dedicated or multi-use microcontroller outside the security + enclave. + + OR + + * **SYSFW** - System firmware - consists of both TIFS and DM both running on + the security enclave. + .. k3_rst_include_end_boot_sources Build Procedure
Signature · 1 line
2.40.0