docs(linux): J7: adas/edgeai: Add How to guide to load and boot firmwares

sinha-shreyash · sinha-shreyash · commit afe6bdf2bd51 · 2025-05-20T16:30:37.000+05:30
Since we are not packaging all firmwares OOB in ADAS and EdgeAI SDK,
this guide add some basic instructions for customers to load and boot
their custom firmwares

Signed-off-by: Shreyash Sinha &lt;s-sinha@ti.com&gt;
diff --git a/configs/AM67A/AM67A_linux_toc.txt b/configs/AM67A/AM67A_linux_toc.txt
@@ -118,6 +118,7 @@ linux/How_to_Guides/Target/How_to_mmcsd_boot_emmc_uda
 linux/How_to_Guides/Target/How_to_visualize_statistics_data
 linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
 linux/How_to_Guides/Target/How_to_Tune_Real_Time_Linux
+linux/How_to_Guides/Target/Load_and_Boot_Firmwares
 linux/How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5
 linux/How_to_Guides/FAQ/How_to_Configure_MSMC_memory
 linux/How_to_Guides/FAQ/How_to_Check_Device_Tree_Info
diff --git a/configs/AM68A/AM68A_linux_toc.txt b/configs/AM68A/AM68A_linux_toc.txt
@@ -120,6 +120,7 @@ linux/How_to_Guides/Target/How_to_Change_dtb_File
 linux/How_to_Guides/Target/How_to_enable_DT_overlays_in_linux
 linux/How_to_Guides/Target/How_to_visualize_statistics_data
 linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
+linux/How_to_Guides/Target/Load_and_Boot_Firmwares
 linux/How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5
 linux/How_to_Guides/FAQ/How_to_Configure_MSMC_memory
 linux/How_to_Guides/FAQ/How_to_Check_Device_Tree_Info
diff --git a/configs/AM69A/AM69A_linux_toc.txt b/configs/AM69A/AM69A_linux_toc.txt
@@ -123,6 +123,7 @@ linux/How_to_Guides/Target/How_to_emmc_boot
 linux/How_to_Guides/Target/How_to_mmcsd_boot_emmc_uda
 linux/How_to_Guides/Target/How_to_visualize_statistics_data
 linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
+linux/How_to_Guides/Target/Load_and_Boot_Firmwares
 linux/How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5
 linux/How_to_Guides/FAQ/How_to_Configure_MSMC_memory
 linux/How_to_Guides/FAQ/How_to_Check_Device_Tree_Info
diff --git a/configs/J721E/J721E_linux_toc.txt b/configs/J721E/J721E_linux_toc.txt
@@ -125,6 +125,7 @@ linux/How_to_Guides/Target/How_to_emmc_boot
 linux/How_to_Guides/Target/How_to_mmcsd_boot_emmc_uda
 linux/How_to_Guides/Target/How_to_visualize_statistics_data
 linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
+linux/How_to_Guides/Target/Load_and_Boot_Firmwares.rst
 linux/How_to_Guides/Target/How_to_Tune_Real_Time_Linux
 linux/How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5
 linux/How_to_Guides/FAQ/How_to_Configure_MSMC_memory
diff --git a/configs/J721S2/J721S2_linux_toc.txt b/configs/J721S2/J721S2_linux_toc.txt
@@ -126,6 +126,7 @@ linux/How_to_Guides/Target/How_to_mmcsd_boot_emmc_uda
 linux/How_to_Guides/Target/How_to_visualize_statistics_data
 linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
 linux/How_to_Guides/Target/How_to_Tune_Real_Time_Linux
+linux/How_to_Guides/Target/Load_and_Boot_Firmwares
 linux/How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5
 linux/How_to_Guides/FAQ/How_to_Configure_MSMC_memory
 linux/How_to_Guides/FAQ/How_to_Check_Device_Tree_Info
diff --git a/configs/J722S/J722S_linux_toc.txt b/configs/J722S/J722S_linux_toc.txt
@@ -123,6 +123,7 @@ linux/How_to_Guides/Target/How_to_mmcsd_boot_emmc_uda
 linux/How_to_Guides/Target/How_to_visualize_statistics_data
 linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
 linux/How_to_Guides/Target/How_to_Tune_Real_Time_Linux
+linux/How_to_Guides/Target/Load_and_Boot_Firmwares
 linux/How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5
 linux/How_to_Guides/FAQ/How_to_Configure_MSMC_memory
 linux/How_to_Guides/FAQ/How_to_Check_Device_Tree_Info
diff --git a/configs/J742S2/J742S2_linux_toc.txt b/configs/J742S2/J742S2_linux_toc.txt
@@ -125,6 +125,7 @@ linux/How_to_Guides/Target/How_to_mmcsd_boot_emmc_uda
 linux/How_to_Guides/Target/How_to_visualize_statistics_data
 linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
 linux/How_to_Guides/Target/How_to_Tune_Real_Time_Linux
+linux/How_to_Guides/Target/Load_and_Boot_Firmwares
 linux/How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5
 linux/How_to_Guides/FAQ/How_to_Configure_MSMC_memory
 linux/How_to_Guides/FAQ/How_to_Check_Device_Tree_Info
diff --git a/configs/J784S4/J784S4_linux_toc.txt b/configs/J784S4/J784S4_linux_toc.txt
@@ -125,6 +125,7 @@ linux/How_to_Guides/Target/How_to_emmc_boot
 linux/How_to_Guides/Target/How_to_mmcsd_boot_emmc_uda
 linux/How_to_Guides/Target/How_to_visualize_statistics_data
 linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
+linux/How_to_Guides/Target/Load_and_Boot_Firmwares
 linux/How_to_Guides/Target/How_to_Tune_Real_Time_Linux
 linux/How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5
 linux/How_to_Guides/FAQ/How_to_Configure_MSMC_memory
diff --git a/configs/TDA4VM/TDA4VM_linux_toc.txt b/configs/TDA4VM/TDA4VM_linux_toc.txt
@@ -114,6 +114,7 @@ linux/How_to_Guides/Target/How_to_enable_DT_overlays_in_linux
 linux/How_to_Guides/Target/How_to_flash_emmc_device
 linux/How_to_Guides/Target/How_to_visualize_statistics_data
 linux/How_to_Guides/Target/How_to_Use_K3Conf_Tool
+linux/How_to_Guides/Target/Load_and_Boot_Firmwares
 linux/How_to_Guides/FAQ/How_to_Verify_Ipc_Linux_R5
 linux/How_to_Guides/FAQ/How_to_Configure_MSMC_memory
 linux/How_to_Guides/FAQ/How_to_Check_Device_Tree_Info
diff --git a/source/linux/How_to_Guides/Target/Load_and_Boot_Firmwares.rst b/source/linux/How_to_Guides/Target/Load_and_Boot_Firmwares.rst
@@ -0,0 +1,104 @@
+Load and Boot Firmwares
+==================================================================
+
+You might need to load Firmwares which are not packaged out of the box
+in the SDK. U-boot and Linux rproc drivers expect a particular name as 
+soft link pointing to the intended executable FW files in target filesystem
+for it to load and boot the firmware.
+
+Generally on a target file system below files are soft linked
+to the intended executable FW files
+
+.. ifconfig:: CONFIG_part_variant in ('J784S4')
+
+    .. code-block:: console
+
+        root@j784s4-evm:~# ls -l /lib/firmware/
+        lrwxrwxrwx 1 root root      66 Mar  9  2025 j784s4-c71_0-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_c7x_1_release_strip.xe71
+        lrwxrwxrwx 1 root root      66 Mar  9  2025 j784s4-c71_1-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_c7x_2_release_strip.xe71
+        lrwxrwxrwx 1 root root      66 Mar  9  2025 j784s4-c71_2-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_c7x_3_release_strip.xe71
+        lrwxrwxrwx 1 root root      66 Mar  9  2025 j784s4-c71_3-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_c7x_4_release_strip.xe71
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j784s4-main-r5f0_0-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_mcu2_0_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j784s4-main-r5f0_1-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_mcu2_1_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j784s4-main-r5f1_0-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_mcu3_0_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j784s4-main-r5f1_1-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_mcu3_1_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j784s4-main-r5f2_0-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_mcu4_0_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j784s4-main-r5f2_1-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_mcu4_1_release_strip.xer5f
+        lrwxrwxrwx 1 root root      66 Mar  9  2025 j784s4-mcu-r5f0_0-fw -> /lib/firmware/ti-eth/j784s4/app_remoteswitchcfg_server_strip.xer5f
+        lrwxrwxrwx 1 root root      73 Mar  9  2025 j784s4-mcu-r5f0_0-fw-sec -> /lib/firmware/ti-eth/j784s4/app_remoteswitchcfg_server_strip.xer5f.signed
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j784s4-mcu-r5f0_1-fw -> /lib/firmware/ti-ipc/j784s4/ipc_echo_test_mcu1_1_release_strip.xer5f
+
+.. ifconfig:: CONFIG_part_variant in ('J742S2')
+
+    .. code-block:: console
+
+        root@j742s2-evm:~# ls -l /lib/firmware/
+        lrwxrwxrwx 1 root root      66 Mar  9  2025 j742s2-c71_0-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_c7x_1_release_strip.xe71
+        lrwxrwxrwx 1 root root      66 Mar  9  2025 j742s2-c71_1-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_c7x_2_release_strip.xe71
+        lrwxrwxrwx 1 root root      66 Mar  9  2025 j742s2-c71_2-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_c7x_3_release_strip.xe71
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j742s2-main-r5f0_0-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_mcu2_0_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j742s2-main-r5f0_1-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_mcu2_1_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j742s2-main-r5f1_0-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_mcu3_0_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j742s2-main-r5f1_1-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_mcu3_1_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j742s2-main-r5f2_0-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_mcu4_0_release_strip.xer5f
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j742s2-main-r5f2_1-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_mcu4_1_release_strip.xer5f
+        lrwxrwxrwx 1 root root      66 Mar  9  2025 j742s2-mcu-r5f0_0-fw -> /lib/firmware/ti-eth/j742s2/app_remoteswitchcfg_server_strip.xer5f
+        lrwxrwxrwx 1 root root      73 Mar  9  2025 j742s2-mcu-r5f0_0-fw-sec -> /lib/firmware/ti-eth/j742s2/app_remoteswitchcfg_server_strip.xer5f.signed
+        lrwxrwxrwx 1 root root      68 Mar  9  2025 j742s2-mcu-r5f0_1-fw -> /lib/firmware/ti-ipc/j742s2/ipc_echo_test_mcu1_1_release_strip.xer5f
+
+.. ifconfig:: CONFIG_part_variant in ('J722S')
+
+    .. code-block:: console
+
+        root@j722s-evm::~# ls -l /lib/firmware/
+        lrwxrwxrwx  1 root root      72 Dec  7 15:36 j722s-main-r5f0_0-fw -> /lib/firmware/ti-ipc/j722s/ipc_echo_test_mcu3_0_release_strip.xer5f
+        lrwxrwxrwx  1 root root      67 Dec  7 15:37 j722s-mcu-r5f0_0-fw -> /lib/firmware/ti-ipc/j722s/ipc_echo_test_mcu2_0_release_strip.xer5f
+        lrwxrwxrwx  1 root root      65 Dec  7 15:39 j722s-c71_0-fw -> /lib/firmware/ti-ipc/j722s/ipc_echo_test_c7x_1_release_strip.xe71
+        lrwxrwxrwx  1 root root      65 Dec  7 15:40 j722s-c71_1-fw -> /lib/firmware/ti-ipc/j722s/ipc_echo_test_c7x_2_release_strip.xe71
+
+.. ifconfig:: CONFIG_part_variant in ('J721E')
+
+    .. code-block:: console
+
+        root@j721e-evm:~# ls -l /lib/firmware/
+        lrwxrwxrwx 1 root root      69 Mar  9  2025 j7-c66_0-fw -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_c66xdsp_1_release_strip.xe66
+        lrwxrwxrwx 1 root root      76 Mar  9  2025 j7-c66_0-fw-sec -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_c66xdsp_1_release_strip.xe66.signed
+        lrwxrwxrwx 1 root root      69 Mar  9  2025 j7-c66_1-fw -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_c66xdsp_2_release_strip.xe66
+        lrwxrwxrwx 1 root root      76 Mar  9  2025 j7-c66_1-fw-sec -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_c66xdsp_2_release_strip.xe66.signed
+        lrwxrwxrwx 1 root root      65 Mar  9  2025 j7-c71_0-fw -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_c7x_1_release_strip.xe71
+        lrwxrwxrwx 1 root root      72 Mar  9  2025 j7-c71_0-fw-sec -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_c7x_1_release_strip.xe71.signed
+        lrwxrwxrwx 1 root root      65 Mar  9  2025 j7-main-r5f0_0-fw -> /lib/firmware/ti-eth/j721e/app_remoteswitchcfg_server_strip.xer5f
+        lrwxrwxrwx 1 root root      72 Mar  9  2025 j7-main-r5f0_0-fw-sec -> /lib/firmware/ti-eth/j721e/app_remoteswitchcfg_server_strip.xer5f.signed
+        lrwxrwxrwx 1 root root      67 Mar  9  2025 j7-main-r5f0_1-fw -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_mcu2_1_release_strip.xer5f
+        lrwxrwxrwx 1 root root      74 Mar  9  2025 j7-main-r5f0_1-fw-sec -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_mcu2_1_release_strip.xer5f.signed
+        lrwxrwxrwx 1 root root      67 Mar  9  2025 j7-main-r5f1_0-fw -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_mcu3_0_release_strip.xer5f
+        lrwxrwxrwx 1 root root      74 Mar  9  2025 j7-main-r5f1_0-fw-sec -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_mcu3_0_release_strip.xer5f.signed
+        lrwxrwxrwx 1 root root      67 Mar  9  2025 j7-main-r5f1_1-fw -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_mcu3_1_release_strip.xer5f
+        lrwxrwxrwx 1 root root      74 Mar  9  2025 j7-main-r5f1_1-fw-sec -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_mcu3_1_release_strip.xer5f.signed
+        lrwxrwxrwx 1 root root      67 Mar  9  2025 j7-mcu-r5f0_0-fw -> /lib/firmware/ti-ipc/j721e/ipc_echo_testb_mcu1_0_release_strip.xer5f
+        lrwxrwxrwx 1 root root      67 Mar  9  2025 j7-mcu-r5f0_1-fw -> /lib/firmware/ti-ipc/j721e/ipc_echo_test_mcu1_1_release_strip.xer5f
+
+.. ifconfig:: CONFIG_part_variant in ('J721S2')
+
+    .. code-block:: console
+
+        root@j721s2-evm:~# ls -l /lib/firmware/
+        lrwxrwxrwx  1 root root      60 Feb 24  2025 j721s2-c71_0-fw -> /lib/firmware/ti-ipc/j721s2/ipc_echo_test_c7x_1_release_strip.xe71
+        lrwxrwxrwx  1 root root      60 Feb 24  2025 j721s2-c71_1-fw -> /lib/firmware/ti-ipc/j721s2/ipc_echo_test_c7x_2_release_strip.xe71
+        lrwxrwxrwx  1 root root      62 Feb 24  2025 j721s2-main-r5f0_0-fw -> /lib/firmware/ti-ipc/j721s2/ipc_echo_test_mcu2_0_release_strip.xer5f
+        lrwxrwxrwx  1 root root      62 Feb 24  2025 j721s2-main-r5f0_1-fw -> /lib/firmware/ti-ipc/j721s2/ipc_echo_test_mcu2_1_release_strip.xer5f
+        lrwxrwxrwx  1 root root      62 Feb 24  2025 j721s2-main-r5f1_0-fw -> /lib/firmware/ti-ipc/j721s2/ipc_echo_test_mcu3_0_release_strip.xer5f
+        lrwxrwxrwx  1 root root      62 Feb 24  2025 j721s2-main-r5f1_1-fw -> /lib/firmware/ti-ipc/j721s2/ipc_echo_test_mcu3_1_release_strip.xer5f
+        lrwxrwxrwx  1 root root      63 Feb 24  2025 j721s2-mcu-r5f0_0-fw -> /lib/firmware/ti-ipc/j721s2/ipc_echo_testb_mcu1_0_release_strip.xer5f
+        lrwxrwxrwx  1 root root      62 Feb 24  2025 j721s2-mcu-r5f0_1-fw -> /lib/firmware/ti-ipc/j721s2/ipc_echo_test_mcu1_1_release_strip.xer5f
+
+
+You should be creating a soft-link for the firmware you need to boot and
+reboot the EVM to see the changes in effect
+
+You can create a symbolic link to the Firmware using below command as a reference
+
+::
+
+    ln -sf /lib/firmware/ti-ipc/j721s2/ipc_echo_test_c7x_1_release_strip.xe71 j721s2-c71_0-fw
+
diff --git a/source/linux/How_to_Guides_Developer_Notes.rst b/source/linux/How_to_Guides_Developer_Notes.rst
@@ -51,3 +51,4 @@ Developer Notes
    How_to_Guides/FAQ/Tda4_Latest_FAQs
    How_to_Guides/FAQ/How_to_run_BIST_on_a_core
    How_to_Guides/Target/How_To_Carve_Out_CMA
+   How_to_Guides/Target/Load_and_Boot_Firmwares
