Skip to content

Commit 98f5e6f

Browse files
sadik-smdpraneethbajjuri
authored andcommitted
feat(linux): Initial documentation support for AM62L platform.
Signed-off-by: sadik <[email protected]>
1 parent 304b785 commit 98f5e6f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1016
-38
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ of directories listed under `configs/`. For example:
3232
* "AM62X" (representing AM62X family)
3333
* "AM62AX" (representing AM62AX family)
3434
* "AM62PX" (representing AM62PX family)
35+
* "AM62L" (representing AM62L family)
3536
* "AM65X" (representing AM65X family)
3637
* "DRA821A" (representing DRA821A)
3738
* "J721E" (representing Jacinto 7 ES)

configs/AM335X/AM335X_linux_tags.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
# List of patterns, relative to source directory, that match files and
1313
# directories to ignore when looking for source files.
14-
exclude_patterns = ['rtos', 'android', 'linux/index.rst', 'devices/AM335X/rtos', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62AX', 'devices/AM62PX']
14+
exclude_patterns = ['rtos', 'android', 'linux/index.rst', 'devices/AM335X/rtos', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62AX', 'devices/AM62PX', 'devices/AM62LX']
1515

1616
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
1717
sdk_os = 'linux'

configs/AM437X/AM437X_linux_tags.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
# List of patterns, relative to source directory, that match files and
1313
# directories to ignore when looking for source files.
14-
exclude_patterns = ['rtos', 'android', 'linux/index.rst', 'devices/AM437X/rtos', 'devices/AM335X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62AX', 'devices/AM62PX']
14+
exclude_patterns = ['rtos', 'android', 'linux/index.rst', 'devices/AM437X/rtos', 'devices/AM335X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62AX', 'devices/AM62PX', 'devices/AM62LX']
1515

1616
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
1717
sdk_os = 'linux'

configs/AM57X/AM57X_linux_tags.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
# List of patterns, relative to source directory, that match files and
1313
# directories to ignore when looking for source files.
14-
exclude_patterns = ['rtos', 'android', 'linux/index.rst', 'devices/AM57X/rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62AX', 'devices/AM62PX']
14+
exclude_patterns = ['rtos', 'android', 'linux/index.rst', 'devices/AM57X/rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62AX', 'devices/AM62PX', 'devices/AM62LX']
1515

1616
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
1717
sdk_os = 'linux'

configs/AM62AX/AM62AX_linux_tags.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
# AM62Ax RTOS docs are not in this project, rather referenced externally,
1717
# so exclude 'rtos' folder along with others.
18-
exclude_patterns = ['android', 'example_code', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62PX']
18+
exclude_patterns = ['android', 'example_code', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62PX', 'devices/AM62LX']
1919

2020
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
2121
sdk_os = 'linux'
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# General family replacement variables and configuration values for Buildroot 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__' : 'AM62L'
17+
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62L'
18+
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
19+
'__SDK_BUILD_MACHINE__' : 'am62lxx-evm'
20+
'__SDK_FULL_NAME__' : 'Buildroot for AM62L'
21+
'__SDK_SHORT_NAME__' : 'Buildroot'
22+
'__SDK_DOWNLOAD_URL__' : '`AM62L-SDK-Download-page <https://www.ti.com/tool/LINUX-SDK-AM62L>`__'
23+
'__LINUX_UBUNTU_VERSION_LONG__' : '22.04 (64-bit)'
24+
'__LINUX_UBUNTU_VERSION_SHORT__' : '22.04'
25+
26+
Configuration Values
27+
--------------------
28+
'CONFIG_part_family' : 'AM62L_family'
29+
'CONFIG_part_variant' : 'AM62L'
30+
'CONFIG_sdk' : 'BuildrootSDK'
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Device Family name
2+
fam_name = 'AM62L'
3+
4+
# Project name and HTML title
5+
sdk_product = 'null' #todo: remove after the new structure is used for all device families
6+
7+
project = u'Buildroot for AM62L'
8+
html_title = 'Buildroot AM62L Documentation'
9+
10+
# The master toctree document.
11+
master_doc = 'devices/AM62LX/buildroot/index'
12+
13+
# List of patterns, relative to source directory, that match files and
14+
# directories to ignore when looking for source files.
15+
16+
# AM62x RTOS docs are not in this project, rather referenced externally,
17+
# so exclude 'rtos' folder along with others.
18+
exclude_patterns = ['android', 'example_code', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM62PX', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX', 'linux', 'debian']
19+
20+
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
21+
sdk_os = 'buildroot'
22+
23+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
devices/AM62LX/buildroot/index
2+
devices/AM62LX/buildroot/Getting_Started_Guide
3+
4+
buildroot/Overview
5+
buildroot/Building_Buildroot_Image
6+
buildroot/Building_Buildroot_Packages
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__' : 'AM62L'
17+
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62L'
18+
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
19+
'__SDK_BUILD_MACHINE__' : 'am62lxx-evm'
20+
'__SDK_FULL_NAME__' : 'AM62L-Linux-SDK'
21+
'__SDK_SHORT_NAME__' : 'PSDK'
22+
'__SDK_INSTALL_FILE__' : 'ti-processor-sdk-linux-am62lxx-evm-<version>-Linux-x86-Install.bin'
23+
'__SDK_INSTALL_DIR__' : 'ti-processor-sdk-linux-am62lxx-evm-<version>'
24+
'__SDK_DOWNLOAD_URL__' : '`AM62L-SDK-Download-page <https://www.ti.com/tool/AM62L-PROCESSOR-SDK>`__'
25+
'__LINUX_UBUNTU_VERSION_LONG__' : '22.04 (64-bit)'
26+
'__LINUX_UBUNTU_VERSION_SHORT__' : '22.04'
27+
'__OPTEE_PLATFORM_FLAVOR__' : 'am62lxx'
28+
'__RTOS_UBUNTU_VERSION_LONG__' : '22.04 (64-bit), 16.04 (64-bit)'
29+
'__FAMILY_NAME__' : 'am62lxx'
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' : 'AM62L_family'
38+
'CONFIG_part_variant' : 'AM62L'
39+
'CONFIG_sdk' : 'SITARA'
40+
'CONFIG_image_type' : 'default'
41+
'CONFIG_icss_support' : 'yes'
42+
'CONFIG_rt_linux_support' : 'yes'
43+
'CONFIG_crypto' : 'DTHEv2'
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Device Family name
2+
fam_name = 'AM62L'
3+
4+
# Project name and HTML title
5+
sdk_product = 'null' #todo: remove after the new structure is used for all device families
6+
7+
project = u'Linux SDK for AM62L'
8+
html_title = 'Linux SDK for AM62L Documentation'
9+
10+
# The master toctree document.
11+
master_doc = 'devices/AM62LX/index'
12+
13+
# List of patterns, relative to source directory, that match files and
14+
# directories to ignore when looking for source files.
15+
16+
# AM62x RTOS docs are not in this project, rather referenced externally,
17+
# so exclude 'rtos' folder along with others.
18+
exclude_patterns = ['android', 'example_code', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62AX','devices/AM62PX']
19+
20+
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
21+
sdk_os = 'linux'
22+
23+

0 commit comments

Comments
 (0)