Skip to content

feat(linux): add initial doc support for am62d. #338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VeeruPrudhvi merged 1 commit into from
Jul 2, 2025
Merged

feat(linux): add initial doc support for am62d. #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions configs/AM62DX/AM62DX_linux_config.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# General family replacement variables and configuration values for Linux build

# This file is processed by Python scripts to define both replacement
# variable and configuration values for a device family build.
# For replacement variables, all variables should be listed on a single
# line, and all the variables should be listed on consecutive lines
# (i.e. no additional blank lines between the replacement variables).
# Similarly, all the configuration values should be listed on individual,
# consecutive lines (with no blank linues between the configuration values).
#
# Note that neither replacement variables nor configuration values may contain
# a colon (i.e. ":") in their name. However, values may contain colons.

Replacement Variables
---------------------
'__PART_FAMILY_NAME__' : 'AM62DX'
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62DX'
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
'__SDK_BUILD_MACHINE__' : 'am62dxx-evm'
'__SDK_FULL_NAME__' : 'AM62D-Linux-SDK'
'__SDK_SHORT_NAME__' : 'PSDK'
'__SDK_INSTALL_FILE__' : 'ti-processor-sdk-linux-am62dxx-evm-<version>-Linux-x86-Install.bin'
'__SDK_INSTALL_DIR__' : 'ti-processor-sdk-linux-am62dxx-evm-<version>'
'__SDK_DOWNLOAD_URL__' : '`AM62D-SDK-Download-page <https://www.ti.com/tool/AM62D-PROCESSOR-SDK>`__'
'__LINUX_UBUNTU_VERSION_LONG__' : '22.04 (64-bit)'
'__LINUX_UBUNTU_VERSION_SHORT__' : '22.04'
'__OPTEE_PLATFORM_FLAVOR__' : 'am62dxx'
'__RTOS_UBUNTU_VERSION_LONG__' : '22.04 (64-bit), 16.04 (64-bit)'
'__FAMILY_NAME__' : 'am62dxx'
'__WINDOWS_SUPPORTED_LONG__' : '10 (64-bit)'
'__FEATURINGMATRIX__' : \
Copy link
Member

@cshilwant cshilwant Jul 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FEATURINGMATRIX is this getting used?

'__SYSFW_CORE_NAME__' : 'TIFS'
'__IMAGE_TYPE__' : 'default'

Configuration Values
--------------------
'CONFIG_part_family' : 'AM62DX_family'
'CONFIG_part_variant' : 'AM62DX'
'CONFIG_sdk' : 'SITARA'
'CONFIG_image_type' : 'default'
'CONFIG_icss_support' : 'yes'
'CONFIG_rt_linux_support' : 'yes'
'CONFIG_crypto' : 'DTHEv2'
Copy link
Member

@cshilwant cshilwant Jul 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this DTHEv2 for AM62D?

9 changes: 9 additions & 0 deletions configs/AM62DX/AM62DX_linux_tags.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Device Family name
fam_name = 'AM62D'

# Project name and HTML title
project = u'Linux SDK for AM62D'
html_title = 'Linux SDK for AM62D Documentation'

# The master toctree document.
master_doc = 'devices/AM62DX/index'
78 changes: 78 additions & 0 deletions configs/AM62DX/AM62DX_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
devices/AM62DX/index
devices/AM62DX/linux/Overview
devices/AM62DX/linux/Overview_Getting_Started_Guide
devices/AM62DX/linux/Overview/Download_and_Install_the_SDK
linux/Overview/Run_Setup_Scripts
devices/AM62DX/linux/Release_Specific
devices/AM62DX/linux/Release_Specific_Release_Notes
devices/AM62DX/linux/Release_Specific_Yocto_layer_Configuration
devices/AM62DX/linux/Release_Specific_Migration_Guide
devices/AM62DX/linux/Release_Specific_Kernel_Performance_Guide
devices/AM62DX/linux/Linux_Performance_Guide
devices/AM62DX/linux/RT_Linux_Performance_Guide
devices/AM62DX/linux/Release_Specific_Workarounds
devices/AM62DX/linux/Release_Specific_Supported_Platforms_and_Versions

linux/Overview_Building_the_SDK
linux/Overview/Top_Level_Makefile
linux/Overview_Directory_Structure_Overview
linux/Overview_Technical_Support
linux/Overview_GPLv3_Disclaimer
linux/Overview/GCC_ToolChain
linux/Overview/Processor_SDK_Linux_create_SD_card

linux/Foundational_Components
linux/Foundational_Components_U-Boot
linux/Foundational_Components/U-Boot/Users-Guide
linux/Foundational_Components/U-Boot/UG-General-Info
linux/Foundational_Components/U-Boot/UG-DFU
linux/Foundational_Components/U-Boot/UG-Memory-K3
linux/Foundational_Components/U-Boot/UG-SPI
linux/Foundational_Components/U-Boot/UG-QSPI
Copy link
Contributor

@v-singh1 v-singh1 Jul 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

QSPI is not enabled in this release

linux/Foundational_Components/U-Boot/UG-UART

linux/Foundational_Components/U-Boot/Applications
linux/Foundational_Components/U-Boot/Apps-SPL-Debug-OpenOCD

linux/Foundational_Components_Kernel
linux/Foundational_Components_Kernel_Drivers
linux/Foundational_Components/Kernel/Kernel_Drivers/Audio
linux/Foundational_Components/Kernel/Kernel_Drivers/EQEP
linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO
linux/Foundational_Components/Kernel/Kernel_Drivers/I2C
linux/Foundational_Components/Kernel/Kernel_Drivers/MCAN
linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-Ethernet
linux/Foundational_Components/Kernel/Kernel_Drivers/PWM
linux/Foundational_Components/Kernel/Kernel_Drivers/SPI
linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI
linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD
linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND
linux/Foundational_Components/Kernel/Kernel_Drivers/UART
linux/Foundational_Components/Kernel/Kernel_Drivers/UBIFS
linux/Foundational_Components/Kernel/Kernel_Drivers/VTM
linux/Foundational_Components/Kernel/Kernel_Drivers/Watchdog

linux/Foundational_Components_Power_Management

linux/Foundational_Components_Kernel_Users_Guide
linux/Foundational_Components_Kernel_LTP-DDT_Validation
linux/Foundational_Components_Security
linux/Foundational_Components_Filesystem
linux/Foundational_Components_Tools
linux/Foundational_Components/Tools/Development_Tools
linux/Foundational_Components/Tools/Pin_Mux_Tools
linux/Foundational_Components_ATF

linux/How_to_Guides
linux/How_to_Guides_Developer_Notes
linux/How_to_Guides/Host/SYSFW_Trace_Parser
linux/How_to_Guides/Target/How_to_enable_DT_overlays_in_linux
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/Runtime_debug_unlock_on_secure_device
linux/How_to_Guides/FAQ/How_to_Check_Device_Tree_Info
linux/How_to_Guides/FAQ/How_to_Integrate_Open_Source_Software
linux/How_to_Guides_Hardware_Setup_with_CCS
linux/How_to_Guides/Hardware_Setup_with_CCS/AM62DX_EVM_Hardware_Setup

linux/Documentation_Tarball
45 changes: 45 additions & 0 deletions source/devices/AM62DX/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.. _linux-index:

************************************
Linux SDK Software Developer's Guide

Check warning on line 4 in source/devices/AM62DX/index.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Linux SDK Software Developer's Guide'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Linux SDK Software Developer's Guide'.", "location": {"path": "source/devices/AM62DX/index.rst", "range": {"start": {"line": 4, "column": 1}}}, "severity": "INFO"}
************************************

.. rubric:: Welcome to the Linux SDK Software Developer's Guide for AM62D

.. include:: /linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst

.. toctree::
:maxdepth: 5
:hidden:
:numbered:

/devices/AM62DX/linux/Overview
/devices/AM62DX/linux/Release_Specific
/linux/Foundational_Components
/linux/How_to_Guides
/linux/Demo_User_Guides/index_Demos
/linux/Documentation_Tarball

|

.. rubric:: Software Build Sheet

The build sheet of supported features for this SDK is available at the following link:

.. raw:: html

<a href="../../AM62DX_build_sheet_11_00_15_05_files/AM62DX_build_sheet_11.00.15.htm">AM62DX Software Build Sheet</a>

.. include:: /devices/AM62DX/linux/_Release_Specific_QSG.rst

.. rubric:: Feedback

If you have feedback, suggestions, or ideas on how to improve the SDK,
it is very appreciated. Please post your ideas to the Linux
forum listed at :ref:`Technical Support <overview-technical-support>`.

Check warning on line 39 in source/devices/AM62DX/index.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message": "[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.", "location": {"path": "source/devices/AM62DX/index.rst", "range": {"start": {"line": 39, "column": 41}}}, "severity": "INFO"}


+--------------------------------+---------------------------------------------------------------------------------------------------+
| .. Image:: /images/E2e.jpg | For technical support post your questions at `https://e2e.ti.com <https://e2e.ti.com/>`__. |
+--------------------------------+---------------------------------------------------------------------------------------------------+

16 changes: 16 additions & 0 deletions source/devices/AM62DX/linux/Linux_Performance_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

Check warning on line 1 in source/devices/AM62DX/linux/Linux_Performance_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.ReadabilityGrade] Simplify your language. The calculated Flesch–Kincaid grade level of 12.96 is above the recommended reading grade level of 9.

Raw Output:
{"message": "[RedHat.ReadabilityGrade] Simplify your language. The calculated Flesch–Kincaid grade level of 12.96 is above the recommended reading grade level of 9.", "location": {"path": "source/devices/AM62DX/linux/Linux_Performance_Guide.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "INFO"}
====================================
Linux 11.01.00.00 Performance Guide

Check warning on line 3 in source/devices/AM62DX/linux/Linux_Performance_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Linux 11.01.00.00 Performance Guide'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Linux 11.01.00.00 Performance Guide'.", "location": {"path": "source/devices/AM62DX/linux/Linux_Performance_Guide.rst", "range": {"start": {"line": 3, "column": 2}}}, "severity": "INFO"}
====================================

.. rubric:: **Read This First**
:name: read-this-first-kernel-perf-guide

**All performance numbers provided in this document are gathered using

Check warning on line 9 in source/devices/AM62DX/linux/Linux_Performance_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.PassiveVoice] 'are gathered' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message": "[RedHat.PassiveVoice] 'are gathered' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.", "location": {"path": "source/devices/AM62DX/linux/Linux_Performance_Guide.rst", "range": {"start": {"line": 9, "column": 53}}}, "severity": "INFO"}
following Evaluation Modules unless otherwise specified.**

+----------------+----------------------------------------------------------------------------------------------------------------+
| Name | Description |
+================+================================================================================================================+
| AM62Dx EVM | |

Check warning on line 15 in source/devices/AM62DX/linux/Linux_Performance_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'EVM') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'EVM') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/devices/AM62DX/linux/Linux_Performance_Guide.rst", "range": {"start": {"line": 15, "column": 10}}}, "severity": "INFO"}
+----------------+----------------------------------------------------------------------------------------------------------------+
21 changes: 21 additions & 0 deletions source/devices/AM62DX/linux/Overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
########

Check warning on line 1 in source/devices/AM62DX/linux/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.ReadabilityGrade] Simplify your language. The calculated Flesch–Kincaid grade level of 16.24 is above the recommended reading grade level of 9.

Raw Output:
{"message": "[RedHat.ReadabilityGrade] Simplify your language. The calculated Flesch–Kincaid grade level of 16.24 is above the recommended reading grade level of 9.", "location": {"path": "source/devices/AM62DX/linux/Overview.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "INFO"}
Overview
########

The **Processor Software Development Kit (Processor SDK)** is a unified software platform for TI embedded processors
providing easy setup and fast out of box access to benchmarks and demos. All releases of Processor SDK are
consistent across TI`s broad portfolio, allowing developers to seamlessly reuse and develop software across devices.
Developing a scalable platform solutions has never been easier than with the Processor SDK and TI`s embedded processor
solutions.

.. toctree::
:maxdepth: 5

Overview_Getting_Started_Guide
/linux/Overview_Building_the_SDK
/linux/Overview_Directory_Structure_Overview
/linux/Overview_Software_Stack
/linux/Overview_Technical_Support
/linux/Overview_Training
/linux/Overview_GPLv3_Disclaimer

7 changes: 7 additions & 0 deletions source/devices/AM62DX/linux/Overview/Build_and_Run_the_Demos.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Build and Run the Demos

Check warning on line 1 in source/devices/AM62DX/linux/Overview/Build_and_Run_the_Demos.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Build and Run the Demos'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Build and Run the Demos'.", "location": {"path": "source/devices/AM62DX/linux/Overview/Build_and_Run_the_Demos.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "INFO"}
=======================

**Build Instructions**

Processor SDK AM62D support GNU make based build system.

92 changes: 92 additions & 0 deletions source/devices/AM62DX/linux/Overview/Download_and_Install_the_SDK.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
.. _download-and-install-sdk:

Download and Install the SDK
============================

The |__SDK_FULL_NAME__| Installer will install the necessary components
to start Linux development on the TI microprocessor.

**The** |__SDK_FULL_NAME__| **Release supports installer only for Linux machine.**

+----------------------------------------------+----------------------------------------------------------------------+
| **Installer Details** | **Installers Name** |
+----------------------------------------------+----------------------------------------------------------------------+
| AM62D Linux SDK Installer (Linux version) | ti-processor-sdk-linux-am62dxx-evm-<version>-Linux-x86-Install.bin |

Check warning on line 14 in source/devices/AM62DX/linux/Overview/Download_and_Install_the_SDK.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.", "location": {"path": "source/devices/AM62DX/linux/Overview/Download_and_Install_the_SDK.rst", "range": {"start": {"line": 14, "column": 67}}}, "severity": "WARNING"}
+----------------------------------------------+----------------------------------------------------------------------+

Use Linux installer for complete source package, tools, prebuilt-image, filesystems,
etc for product development.

Check warning on line 18 in source/devices/AM62DX/linux/Overview/Download_and_Install_the_SDK.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsWarnings] Consider using 'and so on' rather than 'etc' unless updating existing content that uses the term.

Raw Output:
{"message": "[RedHat.TermsWarnings] Consider using 'and so on' rather than 'etc' unless updating existing content that uses the term.", "location": {"path": "source/devices/AM62DX/linux/Overview/Download_and_Install_the_SDK.rst", "range": {"start": {"line": 18, "column": 1}}}, "severity": "WARNING"}

From a windows machine, you can only flash a SD card. This can be done without
installing the SDK. Use balenaEtcher to flash SD card from windows machine.

The |__SDK_FULL_NAME__| includes the ARM GCC toolchain.
The |__SDK_FULL_NAME__| was built and tested against a specific Linux
Distribution name and version, Ubuntu |__LINUX_UBUNTU_VERSION_SHORT__|.
Note that this **does not** prevent the user from installing the SDK on other Linux
distributions.

Download & Install the SDK Installer Inside a Container
-------------------------------------------------------

TI provides a Ubuntu 22.04 based docker image with all the packages that are required to install the SDK Installer.

The Docker image is hosted on `ghcr.io/texasinstruments <https://github.com/TexasInstruments/ti-docker-images/pkgs/container/ubuntu-distro>`__.

Refer `Steps to Run SDK Installer inside a Container <https://github.com/TexasInstruments/ti-docker-images?tab=readme-ov-file#steps-to-run-sdk-installer-inside-container>`__ for a comprehensive guide.

.. note::

Before starting the container, ensure that you have completed all the Pre-Requisites as mentioned `here <https://github.com/TexasInstruments/ti-docker-images?tab=readme-ov-file#pre-requisites>`__.

Download & Install the SDK Installer on Host
--------------------------------------------

You can download the latest |__SDK_FULL_NAME__| installer from the
|__SDK_DOWNLOAD_URL__|.

.. rubric:: Required Host Packages to Install the SDK Installer in Linux
:name: required-host-packages-to-install-the-sdk-installer-linux

Please run the following command to install all packages required to Install the SDK Installer on Ubuntu |__LINUX_UBUNTU_VERSION_SHORT__|.

.. code-block:: console

host# sudo apt-get install file fdisk dosfstools

.. rubric:: How to Run the SDK Installer in Linux
:name: how-to-run-the-sdk-installer-linux

Make sure that the execute permissions are set. Open the terminal
window and change directories to where installation program is located
(probably the Downloads directory) and run the following commands:

.. parsed-literal::

# For AM62D (am62dxx-evm) Installer
chmod +x ./ti-processor-sdk-linux-am62dxx-evm-<version>-Linux-x86-Install.bin
./ti-processor-sdk-linux-am62dxx-evm-<version>-Linux-x86-Install.bin

Alternatively, you can give execute permissions and run the SDK Installer
by double clicking on it within your Linux host PC.

.. note::
As a part of the installation, installation program will run a script to configure
your environment and extract the Linux devkit. This will cause the installation to
continue for roughly a minute even after it shows that it has reached 100%.

.. note::
If nothing seems to happen, your computer may be running a 32-bit version of
its operating system. The installation program is 64-bit, and will not execute properly.


**MCU+ SDK for RTOS/NO-RTOS**

.. note::
AM62D Linux SDK contains only the Linux specific source and application intended
to run on A53/Linux core. For A53 based FreeRTOS side source and applications, refer **MCU+ SDK**


**Instructions to set-up CCS**


Loading
Loading