Skip to content

feat(debian): AM62LX: Armbian-ize Debian docs for AM62L #317

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
jeevantelukula merged 1 commit into from
Jun 12, 2025
Merged

feat(debian): AM62LX: Armbian-ize Debian docs for AM62L #317

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
3 changes: 3 additions & 0 deletions .github/styles/config/vocabularies/PSDK/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ Zink
[Ss]carthgap
[Tt]oolchain
balenaEtcher
Armbian
Debian
Weston
2 changes: 1 addition & 1 deletion configs/AM62LX/AM62LX_debian_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ devices/AM62LX/debian/index

debian/Overview
devices/AM62LX/debian/Getting_Started_Guide
debian/Building_Debian_Image
devices/AM62LX/debian/Building_Debian_Image
debian/Building_Debian_Packages
debian/How_to_Guides/index_How_to_Guides
linux/How_to_Guides/Target/How_To_Enable_M2CC3301_in_linux
Expand Down
21 changes: 18 additions & 3 deletions source/debian/Overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,34 @@
Overview
########

.. ifconfig:: CONFIG_part_variant in ('AM62LX')

Armbian is a highly-optimized **base operating system** (i.e. an extensive build framework) for building Debian-based images for Single-Board Computers (SBCs).


Comment thread
StaticRocket marked this conversation as resolved.
Debian, also known as Debian GNU/Linux, is a Linux distribution composed of free and open-source software, developed by the community-supported Debian Project.

The Linux Debian distribution is enabled for TI's AM62Lx, AM62Px, AM62x and AM64x platforms. Few key highlights of this project are:
.. ifconfig:: CONFIG_part_variant in ('AM62LX')

The Linux Debian distribution, built using Armbian, is enabled for TI's AM62Lx platform. Few key highlights of this project are:

.. ifconfig:: CONFIG_part_variant not in ('AM62LX')

The Linux Debian distribution is enabled for TI's AM62Px, AM62x and AM64x platforms. Few key highlights of this project are:

- The Debian filesystem image requires standard packages from debian.org and TI's customizations as .deb packages. The deb packages for the components owned by TI are built using the public sources hosted on respective git repositories and the deb packages are hosted on TI's official PPA repository maintained on `Github/TexasInstruments <https://github.com/TexasInstruments/ti-debpkgs>`__.

- The entire Debian build process is made easy with a build script, the script "ti-bdebstrap" is hosted on `TI Debian Github <https://github.com/TexasInstruments/ti-bdebstrap>`__.
.. ifconfig:: CONFIG_part_variant not in ('AM62LX')

- The entire Debian build process is made easy with a build script, the script "ti-bdebstrap" is hosted on `TI Debian Github <https://github.com/TexasInstruments/ti-bdebstrap>`__.

- This document also provides the required steps and instructions to customize the TI's components for AM62Lx, AM62Px, AM62x and AM64x SOCs and create the corresponding deb packages.

- The entire project is made public and we accept community contributions as pull requests to github repositories.

- Github actions are enabled for the buildscripts workflow. So, any change in the config files, package additions or modifications in build scripts will result in auto generation of a new debian filesystem that reflects these changes. The new builds will store the filesystem image as an artifact hosted on the same repo, allowing other users to test the change without making a new build. These images are available via github for 90 days after which they may be purged to save disk space.
.. ifconfig:: CONFIG_part_variant not in ('AM62LX')

- Github actions are enabled for the buildscripts workflow. So, any change in the config files, package additions or modifications in build scripts will result in auto generation of a new debian filesystem that reflects these changes. The new builds will store the filesystem image as an artifact hosted on the same repo, allowing other users to test the change without making a new build. These images are available via github for 90 days after which they may be purged to save disk space.

Check warning on line 32 in source/debian/Overview.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsWarnings] Consider using 'might' or 'can' rather than 'may' unless updating existing content that uses the term.

Raw Output:
{"message": "[RedHat.TermsWarnings] Consider using 'might' or 'can' rather than 'may' unless updating existing content that uses the term.", "location": {"path": "source/debian/Overview.rst", "range": {"start": {"line": 32, "column": 461}}}, "severity": "WARNING"}


Debian vs Yocto
Expand Down
73 changes: 73 additions & 0 deletions source/devices/AM62LX/debian/Building_Debian_Image.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
======================

Check warning on line 1 in source/devices/AM62LX/debian/Building_Debian_Image.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 9.26 is above the recommended reading grade level of 9.

Raw Output:
{"message": "[RedHat.ReadabilityGrade] Simplify your language. The calculated Flesch–Kincaid grade level of 9.26 is above the recommended reading grade level of 9.", "location": {"path": "source/devices/AM62LX/debian/Building_Debian_Image.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "INFO"}
Building Debian Images

Check warning on line 2 in source/devices/AM62LX/debian/Building_Debian_Image.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Building Debian Images'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Building Debian Images'.", "location": {"path": "source/devices/AM62LX/debian/Building_Debian_Image.rst", "range": {"start": {"line": 2, "column": 1}}}, "severity": "INFO"}
Comment thread
StaticRocket marked this conversation as resolved.
======================

Introduction
============

Texas Instruments uses the **Armbian** build framework to generate Debian images for its platforms. *Armbian* describes itself to be a "base operating system"; that is, a build framework used to build Linux images optimized for Single-Board Computers.

|__SDK_DOWNLOAD_URL__| provides Debian images for AM62L, but users can also build these, especially if users require something custom (such as different kernel configurations or default desktop environments).

Armbian Usage

Check warning on line 12 in source/devices/AM62LX/debian/Building_Debian_Image.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Armbian Usage'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Armbian Usage'.", "location": {"path": "source/devices/AM62LX/debian/Building_Debian_Image.rst", "range": {"start": {"line": 12, "column": 1}}}, "severity": "INFO"}
=============

This document provides high-level information about how to build Debian images for AM62LX, using Armbian. For a full list of options available for users to configure these images at build time, see `Armbian Documentation <https://docs.armbian.com/>`__.

Get Armbian
-----------

For the time being, TI's fork of Armbian maintains AM62L support. Therefore, the first step is to fetch TI's fork:

.. code-block:: console

git clone https://github.com/TexasInstruments/armbian-build.git

Repository Structure

Check warning on line 26 in source/devices/AM62LX/debian/Building_Debian_Image.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Repository Structure'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Repository Structure'.", "location": {"path": "source/devices/AM62LX/debian/Building_Debian_Image.rst", "range": {"start": {"line": 26, "column": 1}}}, "severity": "INFO"}
--------------------

There are 4 files and directories of relevance to this high-level overview:

- ``configs/``: This directory has configurations for boards, families, kernel configurations, desktop or CLI environments and so on. To find configuration files relevant to TI, see:
- ``configs/sources/families/k3.conf``
- ``configs/kernel/linux-k3-current.conf``
- ``configs/kernel/linux-k3-rt-current.conf``

- ``compile.sh``: This is the script that the user should run for building Armbian images.

- ``lib/``: This directory stores the scripts that do most of the work in building Armbian images.

- ``extensions/``: This directory has files that define **extension hooks**. In Armbian, *extension hooks* are function signatures, which the build framework calls in the process of building an image. However, the build framework does not define these in ``lib/``. Users can define these functions and integrate custom steps in the build process. TI has ``extensions/ti-debpkgs.sh`` extension file for AM62L. To customize the build process, create a new file in this directory, and define your extension hooks there. Once the file is created, be sure to add the following line to board/family config file:

.. code-block:: console

enable_extension <extension_name>

- ``userpatches/``: This directory stores files that define build parameters, user patches and so on.

Building Images

Check warning on line 48 in source/devices/AM62LX/debian/Building_Debian_Image.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Building Images'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'Building Images'.", "location": {"path": "source/devices/AM62LX/debian/Building_Debian_Image.rst", "range": {"start": {"line": 48, "column": 1}}}, "severity": "INFO"}
---------------

Armbian supports an interactive build process. To build interactively, go to TI's Armbian fork you cloned, and use the following command:

.. code-block:: console

./compile.sh

The build framework will then display dialog boxes. The user can use this to select the board, CLI or desktop environment, kernel configurations and so on.

To build the image non-interactively, specify all required **Build Switches** in the command:

.. code-block:: console

./compile.sh [command] [switch...] [command...]

A full list of build switches is available at `Build Switches <https://docs.armbian.com/Developer-Guide_Build-Switches/>`__.

For example, the following command builds the image at |__SDK_DOWNLOAD_URL__|:

.. code-block:: console

./compile.sh build BOARD=am62l-evm BRANCH=current BUILD_MINIMAL=yes KERNEL_CONFIGURE=no RELEASE=trixie SKIP_ARMBIAN_REPO=yes

``output/images/`` stores the built images. These images have a ``.img`` extension.
4 changes: 2 additions & 2 deletions source/devices/AM62LX/debian/Getting_Started_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Getting Started with Debian
***************************

The SD card Image tisdk-debian-trixie-<machine>-<version>.wic.xz provided on the |__SDK_DOWNLOAD_URL__| is all you need to get started and explore Debian on TI microprocessors.
The SD card Image ti_debian_trixie_<machine>-<armbian-version>.img provided on the |__SDK_DOWNLOAD_URL__| is all you need to get started and explore Debian on TI microprocessors.

Check warning on line 7 in source/devices/AM62LX/debian/Getting_Started_Guide.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/AM62LX/debian/Getting_Started_Guide.rst", "range": {"start": {"line": 7, "column": 46}}}, "severity": "INFO"}

The Debian Image provided has all the basic packages required to boot with weston as default window manager. The user can install any new package using inbuilt 'apt' utility
and customize the filesystem as required.
Expand Down Expand Up @@ -59,7 +59,7 @@
------------------------
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.

After a few seconds, the boot prompt will appear. After boot, the weston homescreen will appear.
After a few seconds, a setup script will run. This script guides the user through setting up user account, root password, date and so on. Once the setup ends, reboot the board. Weston screen will appear on the display.

.. Image:: /images/debian_homescreen.png

Expand Down
2 changes: 1 addition & 1 deletion source/devices/AM62LX/debian/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Debian Developer's Guide

/debian/Overview
Getting_Started_Guide
/debian/Building_Debian_Image
Building_Debian_Image
/debian/Building_Debian_Packages
/debian/How_to_Guides/index_How_to_Guides
/debian/Demo_User_Guides/index_Demos
Expand Down