Skip to content

Commit 4f50aeb

Browse files
sadik-smdjeevantelukula
sadik-smd
authored and
jeevantelukula
committed
feat(linux): Add AM62L Buildroot and Debian documentation
This commit provides initial doc support for Buildroot and Debian distributions for AM62L platform with changes in configs/ and source/ folders. Signed-off-by: sadik <[email protected]>
1 parent d806792 commit 4f50aeb

File tree

14 files changed

+304
-9
lines changed

14 files changed

+304
-9
lines changed

‎configs/AM62LX/AM62LX_buildroot_config.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,18 @@
1313

1414
Replacement Variables
1515
---------------------
16-
'__PART_FAMILY_NAME__' : 'AM62L'
17-
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62L'
16+
'__PART_FAMILY_NAME__' : 'AM62LX'
17+
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62LX'
1818
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
1919
'__SDK_BUILD_MACHINE__' : 'am62lxx-evm'
2020
'__SDK_FULL_NAME__' : 'Buildroot for AM62L'
2121
'__SDK_SHORT_NAME__' : 'Buildroot'
22-
'__SDK_DOWNLOAD_URL__' : '`AM62L-SDK-Download-page <https://www.ti.com/tool/LINUX-SDK-AM62L>`__'
22+
'__SDK_DOWNLOAD_URL__' : '`AM62L-SDK-Download-page <https://www.ti.com/tool/AM62L-PROCESSOR-SDK>`__'
2323
'__LINUX_UBUNTU_VERSION_LONG__' : '22.04 (64-bit)'
2424
'__LINUX_UBUNTU_VERSION_SHORT__' : '22.04'
2525

2626
Configuration Values
2727
--------------------
28-
'CONFIG_part_family' : 'AM62L_family'
29-
'CONFIG_part_variant' : 'AM62L'
28+
'CONFIG_part_family' : 'AM62LX_family'
29+
'CONFIG_part_variant' : 'AM62LX'
3030
'CONFIG_sdk' : 'BuildrootSDK'

‎configs/AM62LX/AM62LX_debian_config.txt‎

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 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__' : 'AM62LX'
17+
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62LX'
18+
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
19+
'__SDK_BUILD_MACHINE__' : 'am62lxx-evm'
20+
'__SDK_FULL_NAME__' : 'Debian for AM62L'
21+
'__SDK_SHORT_NAME__' : 'Debian'
22+
'__SDK_DOWNLOAD_URL__' : '`AM62L-SDK-Download-page <https://www.ti.com/tool/AM62L-PROCESSOR-SDK>`__'
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' : 'AM62LX_family'
29+
'CONFIG_part_variant' : 'AM62LX'
30+
'CONFIG_sdk' : 'DebianSDK'

‎configs/AM62LX/AM62LX_debian_tags.py‎

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 = 'AM62LX'
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'Debian for AM62LX'
8+
html_title = 'Debian AM62LX Documentation'
9+
10+
# The master toctree document.
11+
master_doc = 'devices/AM62LX/debian/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/AM62X', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX']
19+
20+
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
21+
sdk_os = 'debian'
22+
23+

‎configs/AM62LX/AM62LX_debian_toc.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
devices/AM62LX/debian/index
2+
3+
debian/Overview
4+
devices/AM62LX/debian/Getting_Started_Guide
5+
debian/Building_Debian_Image
6+
debian/Building_Debian_Packages
7+
debian/How_to_Guides/index_How_to_Guides
8+
linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux
9+
debian/Demo_User_Guides/index_Demos

‎configs/AM62PX/AM62PX_debian_tags.py‎

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

1616
# AM62x 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/AM62X', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX']
18+
exclude_patterns = ['android', 'example_code', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM62X', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX', 'devices/AM62LX']
1919

2020
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
2121
sdk_os = 'debian'

‎configs/AM62X/AM62X_buildroot_tags.py‎

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

1616
# AM62x 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/AM62PX', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX', 'linux', 'debian']
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' , 'devices/AM62LX','linux', 'debian']
1919

2020
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
2121
sdk_os = 'buildroot'

‎configs/AM62X/AM62X_debian_tags.py‎

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

1616
# AM62x 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/AM62PX', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX']
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', 'devices/AM62LX']
1919

2020
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
2121
sdk_os = 'debian'

‎configs/AM64X/AM64X_debian_tags.py‎

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

1616
# AM64x 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/AM62X', 'devices/AM62PX', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX', 'linux']
18+
exclude_patterns = ['android', 'example_code', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM62X', 'devices/AM62PX', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX', 'devices/AM62LX', 'linux']
1919

2020
# OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
2121
sdk_os = 'debian'

‎source/devices/AM62LX/buildroot/Getting_Started_Guide.rst‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
##############################
2+
Getting Started with Buildroot
3+
##############################
4+
5+
The SD card Image sdcard.img provided on the |__SDK_DOWNLOAD_URL__| is all you
6+
need to get started and explore Buildroot on TI microprocessors.
7+
8+
The Buildroot Image provided has all the basic packages required to boot with
9+
Weston as default window manager. The user can install any new package and
10+
customize the filesystem as required.
11+
12+
Follow the steps mentioned in this page to create an SD card Image.
13+
14+
**************
15+
Hardware Setup
16+
**************
17+
18+
In addition to the EVM itself, the following hardware is needed:
19+
20+
1. USB Type-C 5V - 15V and 3A power supply
21+
2. Micro-SD card reader
22+
3. Micro-SD card (16GB or larger recommended)
23+
4. USB Micro-B cable for UART serial communication
24+
5. HDMI display and HDMI cable
25+
6. USB mouse and Keyboard (For controlling the UI)
26+
7. Ethernet cable (For network access)
27+
28+
*********************************
29+
Create SD Card using balenaEtcher
30+
*********************************
31+
32+
1. Download the default bootable SD card image available on the release page as
33+
:file:`tisdk-buildroot-sdcard-image-am62lxx-evm-<version>.img` for Linux image
34+
or :file:`tisdk-buildroot-sdcard-image-rt-am62lxx-evm-<version>.img` for RT-Linux
35+
image.
36+
37+
2. Download and install the balenaEtcher tool:
38+
39+
Balena Etcher is an open-source utility that can be installed on both Linux and Windows.
40+
Download the tool from `this link <https://www.balena.io/etcher/>`__ and install it.
41+
42+
3. Flash the SD Card image to the SD card:
43+
44+
Insert a micro SD card into the USB SD card reader and start Etcher. Choose the sdcard
45+
image to be flashed, choose the USB SD card reader as the target, and then click "Flash".
46+
Etcher will decompress the image and write it to the SD card, as shown below:
47+
48+
.. figure:: /images/balena_etcher.png
49+
:height: 600
50+
:width: 800
51+
52+
********************************
53+
Set the EVM to SD card Boot mode
54+
********************************
55+
56+
The simplest way to run Linux on the EVM is through an SD card. For that, the
57+
EVM will need to be configured for SD card boot.
58+
Refer to `AM62L EVM User's Guide <https://www.ti.com/tool/EVM-AM62L>`__ for
59+
detailed information about boot mode configurations. For quick reference,
60+
the figure below shows the boot mode switch setting for SD card boot.
61+
62+
.. figure:: /images/AM62x_SD_boot.jpg
63+
:height: 600
64+
:width: 800
65+
66+
***************************
67+
Boot and Validate Buildroot
68+
***************************
69+
70+
Make sure to connect the Ethernet cable, HDMI Display, Mouse and Keyboard to the EVM.
71+
Insert the SD Card in the board and Power ON the EVM.
72+
73+
After few seconds the booting prompt will appear.
74+
75+
.. figure:: /images/buildroot_homescreen.png
76+
:height: 600
77+
:width: 800
78+
79+
You've successfully booted Buildroot on AM62L.

‎source/devices/AM62LX/buildroot/index.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _linux-index:
2+
3+
###########################
4+
Buildroot Developer's Guide
5+
###########################
6+
7+
.. rubric:: Welcome to the Buildroot Developer's Guide
8+
:name: welcome-to-the-buildroot-developers-guide
9+
10+
.. include:: ../../../buildroot/_Buildroot_Developers_Guide.rst
11+
12+
.. toctree::
13+
:maxdepth: 5
14+
:hidden:
15+
:numbered:
16+
17+
../../../buildroot/Overview
18+
Getting_Started_Guide
19+
../../../buildroot/Building_Buildroot_Image
20+
../../../buildroot/Building_Buildroot_Packages
21+
22+
.. rubric:: Feedback
23+
:name: feedback
24+
25+
If you have feedback, suggestions, or ideas on how to improve the SDK
26+
or docs, it is very appreciated. Please post your ideas to the Linux
27+
forum listed at :ref:`Technical Support <technical-support>`.
28+
29+
30+
+--------------------------------+-------------------------------------------------------------------------------------+
31+
| .. Image:: /images/E2e.jpg | For technical support please post your questions at `E2E <https://e2e.ti.com/>`__. |
32+
+--------------------------------+-------------------------------------------------------------------------------------+

0 commit comments

Comments
 (0)