fix(references): Add Program EVM User Guide and update correct U-boot reference links

jeevantelukula · jeevantelukula · commit bf22050b50f4 · 2024-11-14T13:54:23.000+05:30
Add Program EVM User Guide in the Overview/Getting Started Here section
Update the correct references of u-boot building methods
Include the reference for UG-SATA in Foundational Components/U-Boot section
Add the UFS reference in Kernel/Kernel Drivers section

Signed-off-by: Telukula Jeevan Kumar Sahu &lt;j-sahu@ti.com&gt;
diff --git a/configs/AM335X/AM335X_linux_toc.txt b/configs/AM335X/AM335X_linux_toc.txt
@@ -12,6 +12,7 @@ linux/Overview/Download_and_Install_the_SDK
 linux/Overview/Run_Setup_Scripts
 linux/Overview/Top_Level_Makefile
 linux/Overview/GCC_ToolChain
+linux/Overview/Program_EVM
 devices/AM335X/linux/index
 devices/AM335X/linux/Release_Specific
 devices/AM335X/linux/Release_Specific_Release_Notes
@@ -28,6 +29,7 @@ linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-NAND
 linux/Foundational_Components/U-Boot/UG-Memory
+linux/Foundational_Components/U-Boot/UG-SATA
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-NOR
@@ -62,6 +64,7 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/SPI
 linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND
 linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD
 linux/Foundational_Components/Kernel/Kernel_Drivers/UART
+linux/Foundational_Components/Kernel/Kernel_Drivers/UFS
 linux/Foundational_Components/Kernel/Kernel_Drivers/USB/MUSB
 linux/Foundational_Components_Kernel_Users_Guide
 linux/Foundational_Components_Kernel_Release_Notes
diff --git a/configs/AM437X/AM437X_linux_toc.txt b/configs/AM437X/AM437X_linux_toc.txt
@@ -12,6 +12,7 @@ linux/Overview/Download_and_Install_the_SDK
 linux/Overview/Run_Setup_Scripts
 linux/Overview/Top_Level_Makefile
 linux/Overview/GCC_ToolChain
+linux/Overview/Program_EVM
 devices/AM437X/linux/index
 devices/AM437X/linux/Release_Specific
 devices/AM437X/linux/Release_Specific_Release_Notes
@@ -28,6 +29,7 @@ linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-NAND
 linux/Foundational_Components/U-Boot/UG-Memory
+linux/Foundational_Components/U-Boot/UG-SATA
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-NOR
@@ -64,6 +66,7 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/SPI
 linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND
 linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD
 linux/Foundational_Components/Kernel/Kernel_Drivers/UART
+linux/Foundational_Components/Kernel/Kernel_Drivers/UFS
 linux/Foundational_Components/Kernel/Kernel_Drivers/USB/DWC3
 linux/Foundational_Components_Kernel_Users_Guide
 linux/Foundational_Components_Kernel_Release_Notes
diff --git a/configs/AM65X/AM65X_linux_toc.txt b/configs/AM65X/AM65X_linux_toc.txt
@@ -63,6 +63,7 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/SPI
 linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND
 linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD
 linux/Foundational_Components/Kernel/Kernel_Drivers/UART
+linux/Foundational_Components/Kernel/Kernel_Drivers/UFS
 linux/Foundational_Components/Kernel/Kernel_Drivers/USB/DWC3
 linux/Foundational_Components/Kernel/Kernel_Drivers/VTM
 linux/Foundational_Components_Kernel_Users_Guide
diff --git a/source/linux/Foundational_Components/Kernel/Kernel_Drivers/UFS.rst b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/UFS.rst
@@ -1,3 +1,5 @@
+.. _ufs:
+
 UFS
 ---------------------------------
 
diff --git a/source/linux/Foundational_Components/U-Boot/Apps-Load-in-CCS.rst b/source/linux/Foundational_Components/U-Boot/Apps-Load-in-CCS.rst
@@ -6,7 +6,7 @@ The below lab is going to walk you through the process of using CCS to load SPL/
 Step 1: Software Downloads
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* A Linux host system configured in accordance with the `Processor SDK Linux Getting Started Guide <http://software-dl.ti.com/processor-sdk-linux/esd/docs/latest/linux/Overview_Getting_Started_Guide.html>`__, with the latest Processor Software Development Kit (PSDK) and Code Composer Studios (CCS) installed. Please refer to the release notes. This document was written using Ubuntu 18.04, Processor SDK Linux 06.03, and CCS 10.0.
+* A Linux host system configured in accordance with the :ref:`Processor SDK Linux Getting Started Guide <overview-getting-started>`, with the latest Processor Software Development Kit (PSDK) and Code Composer Studios (CCS) installed. Please refer to the release notes. This document was written using Ubuntu 18.04, Processor SDK Linux 06.03, and CCS 10.0.
 
 Step 2: Testing Hardware Connection
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -43,7 +43,7 @@ Step 3: Building the SPL/Uboot images
 
 * Before we compile the Uboot, please add the following flag "CONFIG_OF_EMBED=y" in the am43xx_evm_defconfig file. If you refer to the <u-boot_dir>/README file, it mentions "If this variable is defined, U-Boot will embed a device tree binary in its image." Please keep in mind that this is suitable for debugging and development only and is not recommended for production.
 
-* There are two methods of compiling Uboot: `method1 <Overview/Top_Level_Makefile.html#top-level-makefile>`__ and `method2 <Foundational_Components_U-Boot.html#build-and-boot-flow-on-32-bit-platforms>`__. Both methods will generate the necessary files required for Uboot debugging
+* There are two methods of compiling Uboot: :ref:`method1 <top-level-makefile>` and :ref:`method2 <Build-U-Boot-label>`. Both methods will generate the necessary files required for Uboot debugging
 
 * Upon successful compilation, there are a total of 3 images that we are interested:
 
diff --git a/source/linux/Foundational_Components/U-Boot/UG-SATA.rst b/source/linux/Foundational_Components/U-Boot/UG-SATA.rst
@@ -1,3 +1,5 @@
+.. _ug-sata:
+
 SATA
 ------------------------------------
 
diff --git a/source/linux/Foundational_Components/U-Boot/UG-UFS.rst b/source/linux/Foundational_Components/U-Boot/UG-UFS.rst
@@ -27,10 +27,10 @@ Then we can go ahead with 'scsi scan' to see the attached devices:
 |
 
 All the remaining scsi commands detailed in the
-`previous section <UG-SATA.html>`__ are
+:ref:`previous section <ug-sata>` are
 also applicable.
 
 For more information about UFS see
-`Kernel UFS Guide <../../Foundational_Components/Kernel/Kernel_Drivers/UFS.html>`__.
+:ref:`Kernel UFS Guide <ufs>`.
 
 
diff --git a/source/linux/Overview/Processor_SDK_Linux_Getting_Started_Guide.rst b/source/linux/Overview/Processor_SDK_Linux_Getting_Started_Guide.rst
@@ -254,7 +254,7 @@ which you can start development.
    .. ifconfig:: CONFIG_sdk in ('SITARA')
 
        Use the `Create SD Card <Processor_SDK_Linux_create_SD_card.html>`__,
-       or **One-time Program EVM for K2H/K2K, K2E, and K2L** - following directions for `Program EVM User Guide <Program_EVM.html>`__
+       or **One-time Program EVM for K2H/K2K, K2E, and K2L** - following directions for :ref:`Program EVM User Guide <program-evm-user-guide>`
 
    .. ifconfig:: CONFIG_sdk in ('JACINTO','j7_foundational')
 
diff --git a/source/linux/Overview/Program_EVM.rst b/source/linux/Overview/Program_EVM.rst
@@ -1,5 +1,7 @@
 .. http://processors.wiki.ti.com/index.php/Program_EVM_UG
 
+.. _program-evm-user-guide:
+
 Program EVM User Guide
 ======================
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _ufs:`
	`2`	`+`
`1`	`3`	`UFS`
`2`	`4`	`---------------------------------`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _ug-sata:`
	`2`	`+`
`1`	`3`	`SATA`
`2`	`4`	`------------------------------------`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,10 @@ Then we can go ahead with 'scsi scan' to see the attached devices:`
`27`	`27`	`\|`
`28`	`28`
`29`	`29`	`All the remaining scsi commands detailed in the`
`30`		-`previous section <UG-SATA.html>`__ are
	`30`	+:ref:`previous section <ug-sata>` are
`31`	`31`	`also applicable.`
`32`	`32`
`33`	`33`	`For more information about UFS see`
`34`		-`Kernel UFS Guide <../../Foundational_Components/Kernel/Kernel_Drivers/UFS.html>`__.
	`34`	+:ref:`Kernel UFS Guide <ufs>`.
`35`	`35`
`36`	`36`