Skip to content

Commit

Permalink
feat: Update mcu-plus-sdk versions in hyperlinks
Browse files Browse the repository at this point in the history 
To make MCU+ SDK links work with 10.1 docs:

    * update AM64X links to 10_01_00_32
    * update AM62X, AM62AX, AM62PX links to 10_01_00_33

Signed-off-by: Suhaas Joshi <[email protected]>
  • Loading branch information
@jsuhaas22
jsuhaas22 committed Dec 19, 2024
1 parent 377ee55 commit a83ebc0
Show file tree
Hide file tree
Showing 15 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion source/common/PRU-ICSS/PRU-Getting-Started-Labs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The PRU Getting Started Labs demonstrate:

#. Select "Download options" -> "Documentation". Click the link to the
latest SDK documentation. (AM64x example for MCU+ SDK 8.2:
https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/08_05_00_24/exports/docs/api_guide_am64x/index.html)
https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/10_01_00_32/exports/docs/api_guide_am64x/index.html)

#. If using an SDK that is not the latest SDK, it is suggested to use that
release's SDK documentation instead of the latest SDK documentation.
Expand Down
2 changes: 1 addition & 1 deletion source/devices/AM62AX/index_RTOS.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ RTOS/NO-RTOS [MCU+ SDK]

**For MCU+ SDK RTOS/NO-RTOS documentation, refer below links**

- `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/08_06_00_18/exports/docs/api_guide_am62ax/index.html>`__
- `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_01_00_33/exports/docs/api_guide_am62ax/index.html>`__

2 changes: 1 addition & 1 deletion source/devices/AM62AX/linux/Overview/Build_and_Run_the_Demos.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ Processor SDK AM62A support GNU make based build system.
Refer the respective user guides to build Linux and other RTOS/NO-RTOS packages

- For Linux Kernel, u-boot & DTB `[Use Link] <../../../linux/Foundational_Components.html>`__
- For RTOS/NO-RTOS source (MCU+ SDK) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/08_06_00_18/exports/docs/api_guide_am62ax/index.html>`__
- For RTOS/NO-RTOS source (MCU+ SDK) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_01_00_33/exports/docs/api_guide_am62ax/index.html>`__


2 changes: 1 addition & 1 deletion source/devices/AM62PX/index_RTOS.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ RTOS/NO-RTOS [MCU+ SDK]

**For MCU+ SDK RTOS/NO-RTOS documentation, refer below links**

- `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/09_02_00_38/exports/docs/api_guide_am62px/index.html>`__
- `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/index.html>`__
2 changes: 1 addition & 1 deletion source/devices/AM62PX/linux/Overview/Build_and_Run_the_Demos.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Processor SDK AM62Px support GNU make based build system.
Refer the respective user guides to build Linux and other RTOS/NO-RTOS packages

- For Linux Kernel, u-boot & DTB - `[Use Link] <foundational-components-linux>`
- For RTOS/NO-RTOS source (MCU+ SDK) - `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/09_02_00_38/exports/docs/api_guide_am62px/index.html>`__
- For RTOS/NO-RTOS source (MCU+ SDK) - `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/index.html>`__
4 changes: 2 additions & 2 deletions source/devices/AM62PX/linux/Overview/Download_and_Install_the_SDK.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ by double clicking on it within your Linux host PC.
.. note::
Processor SDK Linux AM62Px contains only the Linux specific source and application intended
to runs on A53/Linux core. For R5F and RTOS/NO-RTOS side source and applications, refer **MCU+ SDK**
package `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/09_02_00_38/exports/docs/api_guide_am62px/index.html>`__.
package `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/index.html>`__.

**Instructions to set-up CCS**

- Refer `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/09_02_00_38/exports/docs/api_guide_am62px/CCS_SETUP_PAGE.html>`__
- Refer `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/CCS_SETUP_PAGE.html>`__
2 changes: 1 addition & 1 deletion source/devices/AM62X/index_RTOS.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ RTOS/NO-RTOS [MCU+ SDK]

**For MCU+ SDK RTOS/NO-RTOS documentation, refer below links**

- `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/09_02_00_38/exports/docs/api_guide_am62x/index.html>`__
- `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_01_00_33/exports/docs/api_guide_am62x/index.html>`__

2 changes: 1 addition & 1 deletion source/devices/AM62X/linux/Overview/Build_and_Run_the_Demos.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Processor SDK AM62x support GNU make based build system.
Refer the respective user guides to build Linux and other RTOS/NO-RTOS packages

- For Linux Kernel, u-boot & DTB - :ref:`[Use Link] <foundational-components-linux>`
- For RTOS/NO-RTOS source (MCU+ SDK) - `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/09_02_00_38/exports/docs/api_guide_am62x/index.html>`__
- For RTOS/NO-RTOS source (MCU+ SDK) - `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_01_00_33/exports/docs/api_guide_am62x/index.html>`__



4 changes: 2 additions & 2 deletions source/devices/AM62X/linux/Overview/Download_and_Install_the_SDK.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ by double clicking on it within your Linux host PC.
.. note::
Processor SDK Linux AM62x contains only the Linux specific source and application intended
to runs on A53/Linux core. For R5F and RTOS/NO-RTOS side source and applications, refer **MCU+ SDK**
package `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/09_02_00_38/exports/docs/api_guide_am62x/index.html>`__.
package `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_01_00_33/exports/docs/api_guide_am62x/index.html>`__.

**Instructions to set-up CCS**

- Refer `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/09_02_00_38/exports/docs/api_guide_am62x/CCS_SETUP_PAGE.html>`__
- Refer `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_01_00_33/exports/docs/api_guide_am62x/CCS_SETUP_PAGE.html>`__
2 changes: 1 addition & 1 deletion source/devices/AM64X/index_RTOS.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ RTOS/NO-RTOS [MCU+ SDK]

**For MCU+ SDK RTOS/NO-RTOS documentation, refer below links**

- `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/08_05_00_24/exports/docs/api_guide_am64x/index.html>`__
- `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/10_01_00_32/exports/docs/api_guide_am64x/index.html>`__

6 changes: 3 additions & 3 deletions source/devices/AM64X/linux/Overview/Build_and_Run_the_Demos.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ Below is a list of build targets supported by processor SDK AM64x:
Refer the respective user guides to build Linux and other RTOS/NO-RTOS packages

- For Linux Kernel, u-boot & DTB `[Use Link] <../../../linux/Foundational_Components.html>`__
- For RTOS/NO-RTOS source (MCU+ SDK) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/08_05_00_24/exports/docs/api_guide_am64x/index.html>`__
- For Industrial Protocols (ECAT) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/08_05_00_24/exports/docs/api_guide_am64x/INDUSTRIAL_COMMS.html>`__
- For Industrial Drives (EnDAT,HDSL) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/08_05_00_24/exports/docs/api_guide_am64x/EXAMPLES_MOTORCONTROL.html>`__
- For RTOS/NO-RTOS source (MCU+ SDK) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/10_01_00_32/exports/docs/api_guide_am64x/index.html>`__
- For Industrial Protocols (ECAT) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/10_01_00_32/exports/docs/api_guide_am64x/INDUSTRIAL_COMMS.html>`__
- For Industrial Drives (EnDAT,HDSL) `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/10_01_00_32/exports/docs/api_guide_am64x/EXAMPLES_MOTORCONTROL.html>`__



2 changes: 1 addition & 1 deletion source/linux/Foundational_Components_IPC64x.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Prerequisites
Please be sure that you have the same version number
for both Processor SDK RTOS and Linux.

`Please refer to the MCU+SDK IPC documentation for R5F and M4F IPC architecture and builds: <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/08_05_00_24/exports/docs/api_guide_am64x/IPC_GUIDE.html>`__
`Please refer to the MCU+SDK IPC documentation for R5F and M4F IPC architecture and builds: <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/10_01_00_32/exports/docs/api_guide_am64x/IPC_GUIDE.html>`__

Typical Boot Flow on AM64x for ARM Linux users
----------------------------------------------
Expand Down
26 changes: 13 additions & 13 deletions source/linux/How_to_Guides/Target/How_to_boot_quickly.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,38 +123,38 @@ Reducing bootloader time

.. ifconfig:: CONFIG_part_variant in ('AM62X')

You can track current performance numbers here: `AM62X <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_00_00_14/exports/docs/api_guide_am62x/DATASHEET_AM62X_EVM.html#autotoc_md105>`_
You can track current performance numbers here: `AM62X <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_01_00_33/exports/docs/api_guide_am62x/DATASHEET_AM62X_EVM.html#autotoc_md105>`_

.. ifconfig:: CONFIG_part_variant in ('AM62AX')

You can track current performance numbers here: `AM62AX <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_00_00_14/exports/docs/api_guide_am62ax/DATASHEET_AM62AX_EVM.html#autotoc_md75>`_
You can track current performance numbers here: `AM62AX <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_01_00_33/exports/docs/api_guide_am62ax/DATASHEET_AM62AX_EVM.html#autotoc_md75>`_

.. ifconfig:: CONFIG_part_variant in ('AM62PX')

You can track current performance numbers here: `AM62PX <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_00_00_14/exports/docs/api_guide_am62px/DATASHEET_AM62PX_EVM.html#autotoc_md47>`_
You can track current performance numbers here: `AM62PX <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/DATASHEET_AM62PX_EVM.html#autotoc_md47>`_


- Flashing binaries:

.. ifconfig:: CONFIG_part_variant in ('AM62X')

- `UART flashing tool AM62X <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_00_00_14/exports/docs/api_guide_am62x/TOOLS_FLASH.html>`_
- `UART flashing tool AM62X <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_01_00_33/exports/docs/api_guide_am62x/TOOLS_FLASH.html>`_

- `U-Boot eMMC flashing tool AM62X <https://software-dl.ti.com/processor-sdk-linux/esd/AM62X/latest/exports/docs/linux/Foundational_Components/U-Boot/UG-General-Info.html#u-boot-environment>`_

- `U-Boot SPI flashing tool AM62X <https://software-dl.ti.com/processor-sdk-linux/esd/AM62X/latest/exports/docs/linux/Foundational_Components/U-Boot/UG-SPI.html#spi>`_

.. ifconfig:: CONFIG_part_variant in ('AM62AX')

- `UART flashing tool AM62AX <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_00_00_14/exports/docs/api_guide_am62ax/TOOLS_FLASH.html>`_
- `UART flashing tool AM62AX <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_01_00_33/exports/docs/api_guide_am62ax/TOOLS_FLASH.html>`_

- `U-Boot eMMC flashing tool AM62AX <https://software-dl.ti.com/processor-sdk-linux/esd/AM62AX/latest/exports/docs/linux/Foundational_Components/U-Boot/UG-General-Info.html#u-boot-environment>`_

- `U-Boot SPI flashing tool AM62AX <https://software-dl.ti.com/processor-sdk-linux/esd/AM62AX/latest/exports/docs/linux/Foundational_Components/U-Boot/UG-SPI.html#spi>`_

.. ifconfig:: CONFIG_part_variant in ('AM62PX')

- `UART flashing tool AM62PX <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_00_00_14/exports/docs/api_guide_am62px/TOOLS_FLASH.html>`_
- `UART flashing tool AM62PX <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/TOOLS_FLASH.html>`_

- `U-Boot eMMC flashing tool AM62PX <https://software-dl.ti.com/processor-sdk-linux/esd/AM62PX/latest/exports/docs/linux/Foundational_Components/U-Boot/UG-General-Info.html#u-boot-environment>`_

Expand All @@ -164,27 +164,27 @@ Secondary Boot Loader (SBL)
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. ifconfig:: CONFIG_part_variant in ('AM62X')

The following section will reference `AM62X MCU+ SDK's SBL examples <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_00_00_14/exports/docs/api_guide_am62x/EXAMPLES_DRIVERS_SBL.html>`_.
The following section will reference `AM62X MCU+ SDK's SBL examples <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_01_00_33/exports/docs/api_guide_am62x/EXAMPLES_DRIVERS_SBL.html>`_.

.. ifconfig:: CONFIG_part_variant in ('AM62AX')

The following section will reference `AM62AX MCU+ SDK's SBL examples <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_00_00_14/exports/docs/api_guide_am62ax/EXAMPLES_DRIVERS_SBL.html>`_.
The following section will reference `AM62AX MCU+ SDK's SBL examples <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_01_00_33/exports/docs/api_guide_am62ax/EXAMPLES_DRIVERS_SBL.html>`_.

.. ifconfig:: CONFIG_part_variant in ('AM62PX')

The following section will reference `AM62PX MCU+ SDK's SBL examples <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_00_00_14/exports/docs/api_guide_am62px/EXAMPLES_DRIVERS_SBL.html>`_.
The following section will reference `AM62PX MCU+ SDK's SBL examples <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/EXAMPLES_DRIVERS_SBL.html>`_.

.. ifconfig:: CONFIG_part_variant in ('AM62X')

- `AM62X Falcon Mode <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_00_00_14/exports/docs/api_guide_am62x/TOOLS_BOOT.html#LINUX_APPIMAGE_GEN_TOOL>`_
- `AM62X Falcon Mode <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62X/10_01_00_33/exports/docs/api_guide_am62x/TOOLS_BOOT.html#LINUX_APPIMAGE_GEN_TOOL>`_

.. ifconfig:: CONFIG_part_variant in ('AM62AX')

- `AM62AX Falcon Mode <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_00_00_14/exports/docs/api_guide_am62ax/TOOLS_BOOT.html#LINUX_APPIMAGE_GEN_TOOL>`_
- `AM62AX Falcon Mode <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62AX/10_01_00_33/exports/docs/api_guide_am62ax/TOOLS_BOOT.html#LINUX_APPIMAGE_GEN_TOOL>`_

.. ifconfig:: CONFIG_part_variant in ('AM62PX')

- `AM62PX Falcon Mode <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_00_00_14/exports/docs/api_guide_am62px/TOOLS_BOOT.html#LINUX_APPIMAGE_GEN_TOOL>`_
- `AM62PX Falcon Mode <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/TOOLS_BOOT.html#LINUX_APPIMAGE_GEN_TOOL>`_

- Removing unnecessary prints

Expand Down Expand Up @@ -233,7 +233,7 @@ Secondary Boot Loader (SBL)

It is not possible to assign the first 2 channels to DM R5, the next 2 to A53, next 4 again to DM R5 and so on.

- Rebuild the boardcfg : `BOARCFG_GEN <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_00_00_14/exports/docs/api_guide_am62px/TOOLS_SYSFW.html#BOARCFG_GEN>`_
- Rebuild the boardcfg : `BOARCFG_GEN <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/TOOLS_SYSFW.html#BOARCFG_GEN>`_

- Flash the binaries

Expand Down
4 changes: 2 additions & 2 deletions source/system/Demo_User_Guides/Benchmark_Demo_User_Guide.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,9 @@ will then be displayed on the GUI every second.     
Build Baremetal Demos and Update SD card
----------------------------------------

1. Install MCU+ SDK `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/08_05_00_24/exports/docs/api_guide_am64x/SDK_DOWNLOAD_PAGE.html>`__.
1. Install MCU+ SDK `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/10_01_00_32/exports/docs/api_guide_am64x/SDK_DOWNLOAD_PAGE.html>`__.
Refer MCU+ SDK benchmark demo user guide
`[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/08_05_00_24/exports/docs/api_guide_am64x/EXAMPLE_MOTORCONTROL_BENCHMARKDEMO.html>`__
`[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/10_01_00_32/exports/docs/api_guide_am64x/EXAMPLE_MOTORCONTROL_BENCHMARKDEMO.html>`__
on how to build demos.
Generated binaries will be in <MCU+ SDK>/examples/motor_control/benchmark_demo/am64x-evm/system_nortos

Expand Down
2 changes: 1 addition & 1 deletion source/system/Demo_User_Guides/Display_Cluster_User_Guide.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,6 @@ Building the Linux Demo binary from sources
Building the MCU Firmware from sources
--------------------------------------

#. Please refer to the `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/09_02_00_38/exports/docs/api_guide_am62px/group__DRV__DSS__MODULE.html>`__
#. Please refer to the `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/10_01_00_33/exports/docs/api_guide_am62px/group__DRV__DSS__MODULE.html>`__


0 comments on commit a83ebc0

Please sign in to comment.