Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions configs/AM62PX/AM62PX_buildroot_config.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# General family replacement variables and configuration values for Buildroot 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__' : 'AM62Px'
'__PART_FAMILY_DEVICE_NAMES__' : 'AM62Px'
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
'__SDK_BUILD_MACHINE__' : 'am62pxx-evm'
'__SDK_FULL_NAME__' : 'Buildroot for AM62Px'
'__SDK_SHORT_NAME__' : 'Buildroot'
'__SDK_DOWNLOAD_URL__' : '`AM62Px-SDK-Download-page <https://www.ti.com/tool/PROCESSOR-SDK-AM62PX>`__'
'__LINUX_UBUNTU_VERSION_LONG__' : '22.04 (64-bit)'
'__LINUX_UBUNTU_VERSION_SHORT__' : '22.04'

Configuration Values
--------------------
'CONFIG_part_family' : 'AM62PX_family'
'CONFIG_part_variant' : 'AM62PX'
'CONFIG_sdk' : 'BuildrootSDK'
6 changes: 6 additions & 0 deletions configs/AM62PX/AM62PX_buildroot_tags.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Project name and HTML title
project = u'Buildroot for AM62Px'
html_title = 'Buildroot AM62Px Documentation'

# The master toctree document.
master_doc = 'devices/AM62PX/buildroot/index'
8 changes: 8 additions & 0 deletions configs/AM62PX/AM62PX_buildroot_toc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
devices/AM62PX/buildroot/index
devices/AM62PX/buildroot/Getting_Started_Guide

buildroot/Overview
devices/AM62PX/linux/Release_Specific
devices/AM62PX/linux/Release_Specific_Release_Notes
buildroot/Building_Buildroot_Image
buildroot/Building_Buildroot_Packages
30 changes: 30 additions & 0 deletions configs/AM64X/AM64X_buildroot_config.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# General family replacement variables and configuration values for Buildroot 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__' : 'AM64x'
'__PART_FAMILY_DEVICE_NAMES__' : 'AM64x'
'__PRODUCT_LINE_NAME__' : 'Sitara MPU'
'__SDK_BUILD_MACHINE__' : 'am64xx-evm'
'__SDK_FULL_NAME__' : 'Buildroot for AM64x'
'__SDK_SHORT_NAME__' : 'Buildroot'
'__SDK_DOWNLOAD_URL__' : '`AM64x-SDK-Download-page <https://www.ti.com/tool/PROCESSOR-SDK-AM64X>`__'
'__LINUX_UBUNTU_VERSION_LONG__' : '22.04 (64-bit)'
'__LINUX_UBUNTU_VERSION_SHORT__' : '22.04'

Configuration Values
--------------------
'CONFIG_part_family' : 'AM64X_family'
'CONFIG_part_variant' : 'AM64X'
'CONFIG_sdk' : 'BuildrootSDK'
6 changes: 6 additions & 0 deletions configs/AM64X/AM64X_buildroot_tags.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Project name and HTML title
project = u'Buildroot for AM64x'
html_title = 'Buildroot AM64x Documentation'

# The master toctree document.
master_doc = 'devices/AM64X/buildroot/index'
8 changes: 8 additions & 0 deletions configs/AM64X/AM64X_buildroot_toc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
devices/AM64X/buildroot/index
devices/AM64X/buildroot/Getting_Started_Guide

buildroot/Overview
devices/AM64X/linux/Release_Specific
devices/AM64X/linux/Release_Specific_Release_Notes
buildroot/Building_Buildroot_Image
buildroot/Building_Buildroot_Packages
79 changes: 79 additions & 0 deletions source/devices/AM62PX/buildroot/Getting_Started_Guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
##############################
Getting Started with Buildroot

Check warning on line 2 in source/devices/AM62PX/buildroot/Getting_Started_Guide.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [RedHat.Headings] Use sentence-style capitalization in 'Getting Started with Buildroot'. Raw Output: {"message": "[RedHat.Headings] Use sentence-style capitalization in 'Getting Started with Buildroot'.", "location": {"path": "source/devices/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 2, "column": 1}}}, "severity": "INFO"}

Check warning on line 2 in source/devices/AM62PX/buildroot/Getting_Started_Guide.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [RedHat.NoGerundsInTitles] Where possible, avoid using gerunds in topic titles. Use the imperative form instead. Raw Output: {"message": "[RedHat.NoGerundsInTitles] Where possible, avoid using gerunds in topic titles. Use the imperative form instead.", "location": {"path": "source/devices/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 2, "column": 1}}}, "severity": "INFO"}
##############################

The SD card Image sdcard.img provided on the |__SDK_DOWNLOAD_URL__| is all you
need to get started and explore Buildroot on TI microprocessors.

The Buildroot Image provided has all the basic packages required to boot with
Weston as default window manager. The user can install any new package and
customize the filesystem as required.

Follow the steps mentioned in this page to create an SD card Image.

**************
Hardware Setup

Check warning on line 15 in source/devices/AM62PX/buildroot/Getting_Started_Guide.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [RedHat.Headings] Use sentence-style capitalization in 'Hardware Setup'. Raw Output: {"message": "[RedHat.Headings] Use sentence-style capitalization in 'Hardware Setup'.", "location": {"path": "source/devices/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 15, "column": 1}}}, "severity": "INFO"}
**************

In addition to the SK EVM itself, the following hardware is needed:

Check warning on line 18 in source/devices/AM62PX/buildroot/Getting_Started_Guide.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [RedHat.PassiveVoice] 'is needed' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice. Raw Output: {"message": "[RedHat.PassiveVoice] 'is needed' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.", "location": {"path": "source/devices/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 18, "column": 58}}}, "severity": "INFO"}

Check warning on line 18 in source/devices/AM62PX/buildroot/Getting_Started_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/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 18, "column": 23}}}, "severity": "INFO"}

1. USB Type-C 5V - 15V and 3A power supply
2. Micro-SD card reader
3. Micro-SD card (16GB or larger recommended)
4. USB Micro-B cable for UART serial communication

Check warning on line 23 in source/devices/AM62PX/buildroot/Getting_Started_Guide.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [RedHat.Definitions] Define acronyms and abbreviations (such as 'UART') on first occurrence if they're likely to be unfamiliar. Raw Output: {"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'UART') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/devices/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 23, "column": 26}}}, "severity": "INFO"}
5. HDMI display and HDMI cable

Check warning on line 24 in source/devices/AM62PX/buildroot/Getting_Started_Guide.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [RedHat.Definitions] Define acronyms and abbreviations (such as 'HDMI') on first occurrence if they're likely to be unfamiliar. Raw Output: {"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'HDMI') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/devices/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 24, "column": 21}}}, "severity": "INFO"}

Check warning on line 24 in source/devices/AM62PX/buildroot/Getting_Started_Guide.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [RedHat.Definitions] Define acronyms and abbreviations (such as 'HDMI') on first occurrence if they're likely to be unfamiliar. Raw Output: {"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'HDMI') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/devices/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 24, "column": 4}}}, "severity": "INFO"}
6. USB mouse and Keyboard (For controlling the UI)
7. Ethernet cable (For network access)

*********************************
Create SD Card using balenaEtcher

Check warning on line 29 in source/devices/AM62PX/buildroot/Getting_Started_Guide.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [RedHat.Headings] Use sentence-style capitalization in 'Create SD Card using balenaEtcher'. Raw Output: {"message": "[RedHat.Headings] Use sentence-style capitalization in 'Create SD Card using balenaEtcher'.", "location": {"path": "source/devices/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 29, "column": 1}}}, "severity": "INFO"}
*********************************

1. Download the default bootable SD card image available on the release page as
:file:`tisdk-buildroot-sdcard-image-am62pxx-evm-<version>.img` for Linux image
or :file:`tisdk-buildroot-sdcard-image-rt-am62pxx-evm-<version>.img` for RT-Linux
image.

2. Download and install the balenaEtcher tool:

Balena Etcher is an open-source utility that can be installed on both Linux and Windows.

Check warning on line 39 in source/devices/AM62PX/buildroot/Getting_Started_Guide.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [RedHat.Hyphens] Use 'open source' rather than 'open-source'. Raw Output: {"message": "[RedHat.Hyphens] Use 'open source' rather than 'open-source'.", "location": {"path": "source/devices/AM62PX/buildroot/Getting_Started_Guide.rst", "range": {"start": {"line": 39, "column": 29}}}, "severity": "WARNING"}
Download the tool from `this link <https://www.balena.io/etcher/>`__ and install it.

3. Flash the SD Card image to the SD card:

Insert a micro SD card into the USB SD card reader and start Etcher. Choose the sdcard
image to be flashed, choose the USB SD card reader as the target, and then click "Flash".
Etcher will decompress the image and write it to the SD card, as shown below:

.. figure:: /images/balena_etcher.png
:height: 600
:width: 800
Comment on lines +48 to +50

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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


********************************
Set the EVM to SD card Boot mode
********************************

The simplest way to run Linux on the SK EVM is through an SD card. For that, the
EVM will need to be configured for SD card boot.
Refer to `AM62Px SK EVM User's Guide <https://www.ti.com/tool/SK-AM62P-LP>`__ for
detailed information about boot mode configurations. For quick reference,
the figure below shows the boot mode switch setting for SD card boot.

.. figure:: /images/AM62x_SD_boot.jpg
:height: 600
:width: 800

***************************
Boot and Validate Buildroot
***************************

Make sure to connect the Ethernet cable, HDMI Display, Mouse and Keyboard to the EVM.
Insert the SD Card in the board and Power ON the EVM.

Booting to prompt will take around 12 seconds.

.. figure:: /images/buildroot_homescreen.png
:height: 600
:width: 800

You've successfully booted Buildroot on AM62Px.
33 changes: 33 additions & 0 deletions source/devices/AM62PX/buildroot/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. _linux-index:

###########################
Buildroot Developer's Guide
###########################

.. rubric:: Welcome to the Buildroot Developer's Guide
:name: welcome-to-the-buildroot-developers-guide

.. include:: ../../../buildroot/_Buildroot_Developers_Guide.rst

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

../../../buildroot/Overview
/devices/AM62PX/linux/Release_Specific

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please don't mix and match absolute and relative paths

Getting_Started_Guide
../../../buildroot/Building_Buildroot_Image
../../../buildroot/Building_Buildroot_Packages

.. rubric:: Feedback
:name: feedback

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


+--------------------------------+-------------------------------------------------------------------------------------+
| .. Image:: /images/E2e.jpg | For technical support please post your questions at `E2E <https://e2e.ti.com/>`__. |
+--------------------------------+-------------------------------------------------------------------------------------+
1 change: 1 addition & 0 deletions source/devices/AM62PX/buildroot/version.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
12_01_00_05_03
74 changes: 74 additions & 0 deletions source/devices/AM64X/buildroot/Getting_Started_Guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
##############################
Getting Started with Buildroot
##############################

The SD card Image sdcard.img provided on the |__SDK_DOWNLOAD_URL__| is all you
need to get started and explore Buildroot on TI microprocessors.

The Buildroot Image provided has all the basic packages required to boot with
Weston as default window manager. The user can install any new package and
customize the filesystem as required.

Follow the steps mentioned in this page to create an SD card Image.

**************
Hardware Setup
**************

In addition to the SK EVM itself, the following hardware is needed:

1. USB Type-C 5V - 15V and 3A power supply
2. Micro-SD card reader
3. Micro-SD card (16GB or larger recommended)
4. USB Micro-B cable for UART serial communication
5. HDMI display and HDMI cable
6. USB mouse and Keyboard (For controlling the UI)
7. Ethernet cable (For network access)

*********************************
Create SD Card using balenaEtcher
*********************************

1. Download the default bootable SD card image available on the release page as
:file:`tisdk-buildroot-sdcard-image-am64xx-evm-<version>.img` for Linux image
or :file:`tisdk-buildroot-sdcard-image-rt-am64xx-evm-<version>.img` for RT-Linux
image.

2. Download and install the balenaEtcher tool:

Balena Etcher is an open-source utility that can be installed on both Linux and Windows.
Download the tool from `this link <https://www.balena.io/etcher/>`__ and install it.

3. Flash the SD Card image to the SD card:

Insert a micro SD card into the USB SD card reader and start Etcher. Choose the sdcard
image to be flashed, choose the USB SD card reader as the target, and then click "Flash".
Etcher will decompress the image and write it to the SD card, as shown below:

.. figure:: /images/balena_etcher.png
:height: 600
:width: 800

********************************
Set the EVM to SD card Boot mode
********************************

The simplest way to run Linux on the SK EVM is through an SD card. For that, the
EVM will need to be configured for SD card boot.
Refer to `AM64x EVM User's Guide <https://www.ti.com/tool/TMDS64EVM>`__ for
detailed information about boot mode configurations.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

/images/AM64x_SD_boot.jpg Image exists. Can you add it here similar to AM62P

***************************
Boot and Validate Buildroot
***************************

Make sure to connect the Ethernet cable, HDMI Display, Mouse and Keyboard to the EVM.
Insert the SD Card in the board and Power ON the EVM.

Booting to prompt will take around 12 seconds.

.. figure:: /images/buildroot_homescreen.png
:height: 600
:width: 800

You've successfully booted Buildroot on AM64x.
33 changes: 33 additions & 0 deletions source/devices/AM64X/buildroot/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. _linux-index:

###########################
Buildroot Developer's Guide
###########################

.. rubric:: Welcome to the Buildroot Developer's Guide
:name: welcome-to-the-buildroot-developers-guide

.. include:: ../../../buildroot/_Buildroot_Developers_Guide.rst

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

../../../buildroot/Overview
/devices/AM64X/linux/Release_Specific
Getting_Started_Guide
../../../buildroot/Building_Buildroot_Image
../../../buildroot/Building_Buildroot_Packages

.. rubric:: Feedback
:name: feedback

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


+--------------------------------+-------------------------------------------------------------------------------------+
| .. Image:: /images/E2e.jpg | For technical support please post your questions at `E2E <https://e2e.ti.com/>`__. |
+--------------------------------+-------------------------------------------------------------------------------------+
1 change: 1 addition & 0 deletions source/devices/AM64X/buildroot/version.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
12_01_00_05_03
Loading