Skip to content

feat: Enhance build instructions for BeagleBadge #685

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
praneethbajjuri merged 1 commit into from
Apr 24, 2026
Merged

feat: Enhance build instructions for BeagleBadge #685

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
17 changes: 11 additions & 6 deletions source/boards/beagle/BeagleBadge/linux/Getting_Started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,20 @@

.. list-table::
:header-rows: 1
:widths: 15, 15, 15
:widths: 15, 15, 15, 15

* - Component
- Branch
- Source File
- Build Instructions
* - U-Boot
- `ti-u-boot-2025.01 <https://git.ti.com/cgit/ti-u-boot/ti-u-boot/log/?h=ti-u-boot-2025.01>`__
- :file:`configs/am62lx_beaglebadge_defconfig`
- :ref:`U-Boot Build Guide <u-boot-build-guide-setup-k3>`
* - Linux Kernel
- `ti-linux-6.12.y <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/log/?h=ti-linux-6.12.y>`__
- :file:`arch/arm64/boot/dts/ti/k3-am62l3-beaglebadge.dts`
- :ref:`Linux Kernel Build Guide <preparing-to-build>`

Check warning on line 36 in source/boards/beagle/BeagleBadge/linux/Getting_Started.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/boards/beagle/BeagleBadge/linux/Getting_Started.rst", "range": {"start": {"line": 36, "column": 39}}}, "severity": "INFO"}

Check warning on line 36 in source/boards/beagle/BeagleBadge/linux/Getting_Started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'kernel' rather than 'Kernel'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'kernel' rather than 'Kernel'.", "location": {"path": "source/boards/beagle/BeagleBadge/linux/Getting_Started.rst", "range": {"start": {"line": 36, "column": 20}}}, "severity": "WARNING"}

########################
Building for BeagleBadge
Expand All @@ -44,18 +47,20 @@
$ cd build
$ . conf/setenv
$ export MACHINE=beaglebadge-ti
$ ARAGO_SYSVINIT=1 bitbake -k tisdk-tiny-image
$ bitbake -k tisdk-default-image

For more information on building Arago for BeagleBadge, go :ref:`here <building-the-sdk-with-yocto>`.

.. note::

Yocto: Due to the 256MB size of LPDDR on BeagleBadge, there may be limited free memory (about 17-20MB)
for developing applications with the **default**, TI-provided Arago distribution image. Switching to
sysVinit for init system instead of systemd can help reduce the memory footprint further. Please go
`here <https://www.linuxjournal.com/content/embracing-future-transition-sysvinit-systemd-linux>`__
Yocto: The BeagleBadge's 256MB LPDDR memory might limit the free memory available for developing

Check warning on line 56 in source/boards/beagle/BeagleBadge/linux/Getting_Started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'LPDDR') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'LPDDR') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/boards/beagle/BeagleBadge/linux/Getting_Started.rst", "range": {"start": {"line": 56, "column": 35}}}, "severity": "INFO"}
applications with the **default**, TI-provided Arago distribution image. Switching to sysVinit for

Check warning on line 57 in source/boards/beagle/BeagleBadge/linux/Getting_Started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'Arago'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'Arago'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.", "location": {"path": "source/boards/beagle/BeagleBadge/linux/Getting_Started.rst", "range": {"start": {"line": 57, "column": 51}}}, "severity": "WARNING"}
init system instead of systemd and building TI **tiny** image can help reduce the memory footprint.
Please go `here <https://www.linuxjournal.com/content/embracing-future-transition-sysvinit-systemd-linux>`__
for a comparison of both init systems.

$ ARAGO_SYSVINIT=1 bitbake -k tisdk-tiny-image

Check warning on line 62 in source/boards/beagle/BeagleBadge/linux/Getting_Started.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'bitbake'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'bitbake'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.", "location": {"path": "source/boards/beagle/BeagleBadge/linux/Getting_Started.rst", "range": {"start": {"line": 62, "column": 23}}}, "severity": "WARNING"}

To build Armbian for BeagleBadge, refer to **Debian SDK user manual** found `here <https://www.ti.com/tool/download/AM62L-LINUX-SDK>`__.

###################
Expand Down
2 changes: 2 additions & 0 deletions source/linux/Foundational_Components/Kernel/_Users_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,8 @@ Compiling the Device Tree Binaries
+===========================================+======================================+
| AM62Lx EVM | k3-am62l3-evm.dts |
+-------------------------------------------+--------------------------------------+
| BeagleBadge | k3-am62l3-badge.dts |
+-------------------------------------------+--------------------------------------+
| AM62Px SK | k3-am62p5-sk.dts |
+-------------------------------------------+--------------------------------------+
| AM62Ax SK | k3-am62a7-sk.dts |
Expand Down
20 changes: 15 additions & 5 deletions source/linux/Foundational_Components/U-Boot/BG-Build-K3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,9 +423,10 @@ All of these binaries are available in the SDK at :file:`<path to tisdk>/board-s
.. ifconfig:: CONFIG_part_variant in ('AM62LX')

.. csv-table::
:header: "Board","SD / eMMC / UART / OSPI / USB DFU / USB MSC"
:header: "Board","SD / UART / OSPI / USB DFU","USB MSC"

"AM62LX EVM", ``am62lx_evm_defconfig``
"AM62LX EVM", ``am62lx_evm_defconfig``, ``am62lx_evm_defconfig``
"BeagleBadge", ``am62lx_badge_defconfig``, ""

.. note::

Expand All @@ -438,6 +439,15 @@ All of these binaries are available in the SDK at :file:`<path to tisdk>/board-s
$ export TFA_DIR=<path-to-arm-trusted-firmware>
$ export OPTEE_DIR=<path-to-ti-optee-os>

# Build for AM62LX EVM:
$ export UBOOT_CONFIG=am62lx_evm_defconfig
$ export TFA_BOARD=am62lx

# Build for BeagleBadge:
$ export UBOOT_CONFIG=am62lx_badge_defconfig
$ export TFA_BOARD=am62l3_badge # on ti-tfa-2.14.y
$ export TFA_BOARD=am62lx_badge # on ti-master

.. note::

The instructions below assume all binaries are built manually.
Expand All @@ -451,10 +461,10 @@ All of these binaries are available in the SDK at :file:`<path to tisdk>/board-s
.. code-block:: console

$ cd $UBOOT_DIR
$ make CROSS_COMPILE="$CROSS_COMPILE_64" am62lx_evm_defconfig
$ make CROSS_COMPILE="$CROSS_COMPILE_64" $UBOOT_CONFIG
$ make CROSS_COMPILE="$CROSS_COMPILE_64" \
BL1=$TFA_DIR/build/k3low/am62lx/release/bl1.bin \
BL31=$TFA_DIR/build/k3low/am62lx/release/bl31.bin \
BL1=$TFA_DIR/build/k3low/$TFA_BOARD/release/bl1.bin \
BL31=$TFA_DIR/build/k3low/$TFA_BOARD/release/bl31.bin \
BINMAN_INDIRS=$TI_LINUX_FW_DIR \
TEE=$OPTEE_DIR/out/arm-plat-k3/core/tee-pager_v2.bin

Expand Down
10 changes: 8 additions & 2 deletions source/linux/Foundational_Components_ATF.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,19 @@

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

.. code-block:: console

$ export TFA_BOARD=am62lx # for AM62L EVM
$ export TFA_BOARD=am62l3_badge # for BeagleBadge on ti-tfa-2.14.y
$ export TFA_BOARD=am62lx_badge # for BeagleBadge on ti-master
$ export TFA_DIR=<path-to-arm-trusted-firmware>

Check warning on line 123 in source/linux/Foundational_Components_ATF.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/linux/Foundational_Components_ATF.rst", "range": {"start": {"line": 123, "column": 30}}}, "severity": "INFO"}

*Without OP-TEE enabled:*

.. code-block:: console

$ export TFA_DIR=<path-to-arm-trusted-firmware>
$ cd $TFA_DIR
$ make ARCH=aarch64 CROSS_COMPILE="$CROSS_COMPILE_64" PLAT=k3low TARGET_BOARD=am62lx
$ make ARCH=aarch64 CROSS_COMPILE="$CROSS_COMPILE_64" PLAT=k3low TARGET_BOARD=$TFA_BOARD

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

Expand Down
Loading