Skip to content

Commit f57a6fa

Browse files
sadik-smdVeeruPrudhvi
sadik-smd
authored and
VeeruPrudhvi
committed
feat(linux): add initial doc support for am62d.
Update the configs/ and source/ files for am62d platform. Signed-off-by: sadik <[email protected]>
1 parent 86a0cc9 commit f57a6fa

18 files changed

+754
-0
lines changed

‎configs/AM62DX/AM62DX_linux_config.txt‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# General family replacement variables and configuration values for Linux build
2+
3+
# This file is processed by Python scripts to define both replacement
4+
# variable and configuration values for a device family build.
5+
# For replacement variables, all variables should be listed on a single
6+
# line, and all the variables should be listed on consecutive lines
7+
# (i.e. no additional blank lines between the replacement variables).
8+
# Similarly, all the configuration values should be listed on individual,
9+
# consecutive lines (with no blank linues between the configuration values).
10+
#
11+
# Note that neither replacement variables nor configuration values may contain
12+
# a colon (i.e. ":") in their name. However, values may contain colons.
13+
14+
Replacement Variables
15+
---------------------
16+
'__PART_FAMILY_NAME__' : 'AM62DX'
17+
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62DX'
18+
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
19+
'__SDK_BUILD_MACHINE__' : 'am62dxx-evm'
20+
'__SDK_FULL_NAME__' : 'AM62D-Linux-SDK'
21+
'__SDK_SHORT_NAME__' : 'PSDK'
22+
'__SDK_INSTALL_FILE__' : 'ti-processor-sdk-linux-am62dxx-evm-<version>-Linux-x86-Install.bin'
23+
'__SDK_INSTALL_DIR__' : 'ti-processor-sdk-linux-am62dxx-evm-<version>'
24+
'__SDK_DOWNLOAD_URL__' : '`AM62D-SDK-Download-page <https://www.ti.com/tool/AM62D-PROCESSOR-SDK>`__'
25+
'__LINUX_UBUNTU_VERSION_LONG__' : '22.04 (64-bit)'
26+
'__LINUX_UBUNTU_VERSION_SHORT__' : '22.04'
27+
'__OPTEE_PLATFORM_FLAVOR__' : 'am62dxx'
28+
'__RTOS_UBUNTU_VERSION_LONG__' : '22.04 (64-bit), 16.04 (64-bit)'
29+
'__FAMILY_NAME__' : 'am62dxx'
30+
'__WINDOWS_SUPPORTED_LONG__' : '10 (64-bit)'
31+
'__FEATURINGMATRIX__' : \
32+
'__SYSFW_CORE_NAME__' : 'TIFS'
33+
'__IMAGE_TYPE__' : 'default'
34+
35+
Configuration Values
36+
--------------------
37+
'CONFIG_part_family' : 'AM62DX_family'
38+
'CONFIG_part_variant' : 'AM62DX'
39+
'CONFIG_sdk' : 'SITARA'
40+
'CONFIG_image_type' : 'default'
41+
'CONFIG_icss_support' : 'yes'
42+
'CONFIG_rt_linux_support' : 'yes'
43+
'CONFIG_crypto' : 'DTHEv2'

‎configs/AM62DX/AM62DX_linux_tags.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Device Family name
2+
fam_name = 'AM62D'
3+
4+
# Project name and HTML title
5+
project = u'Linux SDK for AM62D'
6+
html_title = 'Linux SDK for AM62D Documentation'
7+
8+
# The master toctree document.
9+
master_doc = 'devices/AM62DX/index'

‎configs/AM62DX/AM62DX_linux_toc.txt‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
devices/AM62DX/index
2+
devices/AM62DX/linux/Overview
3+
devices/AM62DX/linux/Overview_Getting_Started_Guide
4+
devices/AM62DX/linux/Overview/Download_and_Install_the_SDK
5+
linux/Overview/Run_Setup_Scripts
6+
devices/AM62DX/linux/Release_Specific
7+
devices/AM62DX/linux/Release_Specific_Release_Notes
8+
devices/AM62DX/linux/Release_Specific_Yocto_layer_Configuration
9+
devices/AM62DX/linux/Release_Specific_Migration_Guide
10+
devices/AM62DX/linux/Release_Specific_Kernel_Performance_Guide
11+
devices/AM62DX/linux/Linux_Performance_Guide
12+
devices/AM62DX/linux/RT_Linux_Performance_Guide
13+
devices/AM62DX/linux/Release_Specific_Workarounds
14+
devices/AM62DX/linux/Release_Specific_Supported_Platforms_and_Versions
15+
16+
linux/Overview_Building_the_SDK
17+
linux/Overview/Top_Level_Makefile
18+
linux/Overview_Directory_Structure_Overview
19+
linux/Overview_Technical_Support
20+
linux/Overview_GPLv3_Disclaimer
21+
linux/Overview/GCC_ToolChain
22+
linux/Overview/Processor_SDK_Linux_create_SD_card
23+
24+
linux/Foundational_Components
25+
linux/Foundational_Components_U-Boot
26+
linux/Foundational_Components/U-Boot/Users-Guide
27+
linux/Foundational_Components/U-Boot/UG-General-Info
28+
linux/Foundational_Components/U-Boot/UG-DFU
29+
linux/Foundational_Components/U-Boot/UG-Memory-K3
30+
linux/Foundational_Components/U-Boot/UG-SPI
31+
linux/Foundational_Components/U-Boot/UG-QSPI
32+
linux/Foundational_Components/U-Boot/UG-UART
33+
34+
linux/Foundational_Components/U-Boot/Applications
35+
linux/Foundational_Components/U-Boot/Apps-SPL-Debug-OpenOCD
36+
37+
linux/Foundational_Components_Kernel
38+
linux/Foundational_Components_Kernel_Drivers
39+
linux/Foundational_Components/Kernel/Kernel_Drivers/Audio
40+
linux/Foundational_Components/Kernel/Kernel_Drivers/EQEP
41+
linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO
42+
linux/Foundational_Components/Kernel/Kernel_Drivers/I2C
43+
linux/Foundational_Components/Kernel/Kernel_Drivers/MCAN
44+
linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-Ethernet
45+
linux/Foundational_Components/Kernel/Kernel_Drivers/PWM
46+
linux/Foundational_Components/Kernel/Kernel_Drivers/SPI
47+
linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI
48+
linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD
49+
linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND
50+
linux/Foundational_Components/Kernel/Kernel_Drivers/UART
51+
linux/Foundational_Components/Kernel/Kernel_Drivers/UBIFS
52+
linux/Foundational_Components/Kernel/Kernel_Drivers/VTM
53+
linux/Foundational_Components/Kernel/Kernel_Drivers/Watchdog
54+
55+
linux/Foundational_Components_Power_Management
56+
57+
linux/Foundational_Components_Kernel_Users_Guide
58+
linux/Foundational_Components_Kernel_LTP-DDT_Validation
59+
linux/Foundational_Components_Security
60+
linux/Foundational_Components_Filesystem
61+
linux/Foundational_Components_Tools
62+
linux/Foundational_Components/Tools/Development_Tools
63+
linux/Foundational_Components/Tools/Pin_Mux_Tools
64+
linux/Foundational_Components_ATF
65+
66+
linux/How_to_Guides
67+
linux/How_to_Guides_Developer_Notes
68+
linux/How_to_Guides/Host/SYSFW_Trace_Parser
69+
linux/How_to_Guides/Target/How_to_enable_DT_overlays_in_linux
70+
linux/How_to_Guides/Target/How_to_emmc_boot
71+
linux/How_to_Guides/Target/How_to_mmcsd_boot_emmc_uda
72+
linux/How_to_Guides/Target/Runtime_debug_unlock_on_secure_device
73+
linux/How_to_Guides/FAQ/How_to_Check_Device_Tree_Info
74+
linux/How_to_Guides/FAQ/How_to_Integrate_Open_Source_Software
75+
linux/How_to_Guides_Hardware_Setup_with_CCS
76+
linux/How_to_Guides/Hardware_Setup_with_CCS/AM62DX_EVM_Hardware_Setup
77+
78+
linux/Documentation_Tarball

‎source/devices/AM62DX/index.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. _linux-index:
2+
3+
************************************
4+
Linux SDK Software Developer's Guide
5+
************************************
6+
7+
.. rubric:: Welcome to the Linux SDK Software Developer's Guide for AM62D
8+
9+
.. include:: /linux/Overview/_Processor_SDK_Linux_Software_Developers_Guide.rst
10+
11+
.. toctree::
12+
:maxdepth: 5
13+
:hidden:
14+
:numbered:
15+
16+
/devices/AM62DX/linux/Overview
17+
/devices/AM62DX/linux/Release_Specific
18+
/linux/Foundational_Components
19+
/linux/How_to_Guides
20+
/linux/Demo_User_Guides/index_Demos
21+
/linux/Documentation_Tarball
22+
23+
|
24+
25+
.. rubric:: Software Build Sheet
26+
27+
The build sheet of supported features for this SDK is available at the following link:
28+
29+
.. raw:: html
30+
31+
<a href="../../AM62DX_build_sheet_11_00_15_05_files/AM62DX_build_sheet_11.00.15.htm">AM62DX Software Build Sheet</a>
32+
33+
.. include:: /devices/AM62DX/linux/_Release_Specific_QSG.rst
34+
35+
.. rubric:: Feedback
36+
37+
If you have feedback, suggestions, or ideas on how to improve the SDK,
38+
it is very appreciated. Please post your ideas to the Linux
39+
forum listed at :ref:`Technical Support <overview-technical-support>`.
40+
41+
42+
+--------------------------------+---------------------------------------------------------------------------------------------------+
43+
| .. Image:: /images/E2e.jpg | For technical support post your questions at `https://e2e.ti.com <https://e2e.ti.com/>`__. |
44+
+--------------------------------+---------------------------------------------------------------------------------------------------+
45+

‎source/devices/AM62DX/linux/Linux_Performance_Guide.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
====================================
3+
Linux 11.01.00.00 Performance Guide
4+
====================================
5+
6+
.. rubric:: **Read This First**
7+
:name: read-this-first-kernel-perf-guide
8+
9+
**All performance numbers provided in this document are gathered using
10+
following Evaluation Modules unless otherwise specified.**
11+
12+
+----------------+----------------------------------------------------------------------------------------------------------------+
13+
| Name | Description |
14+
+================+================================================================================================================+
15+
| AM62Dx EVM | |
16+
+----------------+----------------------------------------------------------------------------------------------------------------+

‎source/devices/AM62DX/linux/Overview.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
########
2+
Overview
3+
########
4+
5+
The **Processor Software Development Kit (Processor SDK)** is a unified software platform for TI embedded processors
6+
providing easy setup and fast out of box access to benchmarks and demos. All releases of Processor SDK are
7+
consistent across TI`s broad portfolio, allowing developers to seamlessly reuse and develop software across devices.
8+
Developing a scalable platform solutions has never been easier than with the Processor SDK and TI`s embedded processor
9+
solutions.
10+
11+
.. toctree::
12+
:maxdepth: 5
13+
14+
Overview_Getting_Started_Guide
15+
/linux/Overview_Building_the_SDK
16+
/linux/Overview_Directory_Structure_Overview
17+
/linux/Overview_Software_Stack
18+
/linux/Overview_Technical_Support
19+
/linux/Overview_Training
20+
/linux/Overview_GPLv3_Disclaimer
21+

‎source/devices/AM62DX/linux/Overview/Build_and_Run_the_Demos.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Build and Run the Demos
2+
=======================
3+
4+
**Build Instructions**
5+
6+
Processor SDK AM62D support GNU make based build system.
7+

‎source/devices/AM62DX/linux/Overview/Download_and_Install_the_SDK.rst‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
.. _download-and-install-sdk:
2+
3+
Download and Install the SDK
4+
============================
5+
6+
The |__SDK_FULL_NAME__| Installer will install the necessary components
7+
to start Linux development on the TI microprocessor.
8+
9+
**The** |__SDK_FULL_NAME__| **Release supports installer only for Linux machine.**
10+
11+
+----------------------------------------------+----------------------------------------------------------------------+
12+
| **Installer Details** | **Installers Name** |
13+
+----------------------------------------------+----------------------------------------------------------------------+
14+
| AM62D Linux SDK Installer (Linux version) | ti-processor-sdk-linux-am62dxx-evm-<version>-Linux-x86-Install.bin |
15+
+----------------------------------------------+----------------------------------------------------------------------+
16+
17+
Use Linux installer for complete source package, tools, prebuilt-image, filesystems,
18+
etc for product development.
19+
20+
From a windows machine, you can only flash a SD card. This can be done without
21+
installing the SDK. Use balenaEtcher to flash SD card from windows machine.
22+
23+
The |__SDK_FULL_NAME__| includes the ARM GCC toolchain.
24+
The |__SDK_FULL_NAME__| was built and tested against a specific Linux
25+
Distribution name and version, Ubuntu |__LINUX_UBUNTU_VERSION_SHORT__|.
26+
Note that this **does not** prevent the user from installing the SDK on other Linux
27+
distributions.
28+
29+
Download & Install the SDK Installer Inside a Container
30+
-------------------------------------------------------
31+
32+
TI provides a Ubuntu 22.04 based docker image with all the packages that are required to install the SDK Installer.
33+
34+
The Docker image is hosted on `ghcr.io/texasinstruments <https://github.com/TexasInstruments/ti-docker-images/pkgs/container/ubuntu-distro>`__.
35+
36+
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.
37+
38+
.. note::
39+
40+
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>`__.
41+
42+
Download & Install the SDK Installer on Host
43+
--------------------------------------------
44+
45+
You can download the latest |__SDK_FULL_NAME__| installer from the
46+
|__SDK_DOWNLOAD_URL__|.
47+
48+
.. rubric:: Required Host Packages to Install the SDK Installer in Linux
49+
:name: required-host-packages-to-install-the-sdk-installer-linux
50+
51+
Please run the following command to install all packages required to Install the SDK Installer on Ubuntu |__LINUX_UBUNTU_VERSION_SHORT__|.
52+
53+
.. code-block:: console
54+
55+
host# sudo apt-get install file fdisk dosfstools
56+
57+
.. rubric:: How to Run the SDK Installer in Linux
58+
:name: how-to-run-the-sdk-installer-linux
59+
60+
Make sure that the execute permissions are set. Open the terminal
61+
window and change directories to where installation program is located
62+
(probably the Downloads directory) and run the following commands:
63+
64+
.. parsed-literal::
65+
66+
# For AM62D (am62dxx-evm) Installer
67+
chmod +x ./ti-processor-sdk-linux-am62dxx-evm-<version>-Linux-x86-Install.bin
68+
./ti-processor-sdk-linux-am62dxx-evm-<version>-Linux-x86-Install.bin
69+
70+
Alternatively, you can give execute permissions and run the SDK Installer
71+
by double clicking on it within your Linux host PC.
72+
73+
.. note::
74+
As a part of the installation, installation program will run a script to configure
75+
your environment and extract the Linux devkit. This will cause the installation to
76+
continue for roughly a minute even after it shows that it has reached 100%.
77+
78+
.. note::
79+
If nothing seems to happen, your computer may be running a 32-bit version of
80+
its operating system. The installation program is 64-bit, and will not execute properly.
81+
82+
83+
**MCU+ SDK for RTOS/NO-RTOS**
84+
85+
.. note::
86+
AM62D Linux SDK contains only the Linux specific source and application intended
87+
to run on A53/Linux core. For A53 based FreeRTOS side source and applications, refer **MCU+ SDK**
88+
89+
90+
**Instructions to set-up CCS**
91+
92+

0 commit comments

Comments
 (0)