docs(linux): Add initial documentation for BeagleBadge #602

jmenti · 2025-12-18T21:35:05Z

Add an initial 'How to guide' for BeagleBadge board supported in Debian in Arago distributions.

github-actions · 2025-12-18T21:35:55Z

New warnings found with rstcheck:

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst:3: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)

StaticRocket

Please review the vale warnings as well

configs/AM62LX/AM62LX_linux_toc.txt

StaticRocket · 2025-12-18T21:49:58Z

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

Please use the standard section hierarchy.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections

This comment is still valid

WYM, headers are already fixed. *** for chapters, ==== for sections, and ---- for subsections. Am I missing something here?

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

praneethbajjuri

Ok for initial docs.
@Grippy98 please review. We can always expand this more based on incremental feedback later

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

StaticRocket · 2025-12-19T01:01:30Z

also, https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#commit-types

StaticRocket

Two suggestions to make vale happy. Please also fix the sections.

StaticRocket · 2025-12-19T17:19:43Z

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

+seven-segment displays, and an RGB LED. Fully supported in TI sources, the BeagleBadge offers flexible
+boot options (OSPI, UART, SD, USB-DFU) and runs Zephyr or Linux OS with Debian or Arago distributions,
+making it an ideal open source solution for modern IoT and HMI projects.


Suggested change

seven-segment displays, and an RGB LED. Fully supported in TI sources, the BeagleBadge offers flexible

boot options (OSPI, UART, SD, USB-DFU) and runs Zephyr or Linux OS with Debian or Arago distributions,

making it an ideal open source solution for modern IoT and HMI projects.

seven-segment displays, and an RGB LED. Fully supported in TI sources, the BeagleBadge offers flexible

boot options (OSPI, UART, SD, USB-DFU). It supports Zephyr or Linux (with Debian or Arago distributions),

making it an ideal open source solution for modern IoT and HMI projects.

StaticRocket · 2025-12-19T17:20:07Z

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

+   1. Press & hold Select until step 4
+   2. Connect USB C cable
+   3. Connect to /dev/ttyUSB0 on host machine
+   4. Send bootloader binaries from host MACHINE


Suggested change

4. Send bootloader binaries from host MACHINE

4. Send boot loader binaries from host MACHINE

bootloader is typically one word

Even GRUB [1] includes both spellings, but most spellcheck utilities do not recognize the single word spelling. If you look up the definition of the single word spelling, you are redirected to the dual word definition.

[1] https://www.gnu.org/software/grub/index.html

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

+
+The board provides a rich interface including an e-paper connector, DSI connector, Grove expansion,
+seven-segment displays, and an RGB LED. Fully supported in TI sources, the BeagleBadge offers flexible
+boot options (OSPI, UART, SD, USB-DFU) and runs Zephyr or Linux OS with Debian or Arago distributions,


glneo · 2025-12-19T17:34:53Z

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

+
+   Yocto: Due to the limited 128MB size of LPDDR on BeagleBadge, only the *tisdk-tiny-image*
+   can boot on BeagleBadge. Switching to SystemV for init system instead of SystemD will reduce
+   the memory footprint since more system services will be enabled by default with SystemD.


Although this isn't necessarily true, it just happens to be true today as most services are now ported over to systemd (btw systemd is usually stylized as all lower-case) and the old sysvinit versions have started to bit-rot away.

glneo · 2025-12-19T17:35:59Z

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

+SD boot:
+   1. Flash SD card with Debian or Arago image
+   2. Insert Micro SD card
+   3. Press & hold Select until step 4


Not just "until" step 4, it needs to be held "through" step 4, or until step 5.

glneo · 2025-12-19T17:37:02Z

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

+
+         => fatload mmc 1 ${loadaddr} tiboot3.bin
+         221296 bytes read in 11 ms (19.2 MiB/s)
+         => print filesize


No need to print filesize, just use it directly in the commands below.

glneo · 2025-12-19T17:41:11Z

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

+         SF: Detected is25wx256 with page size 256 Bytes, erase size 4 KiB, total 32 MiB
+         => sf erase 0 40000
+         SF: 262144 bytes @ 0x0 Erased: OK
+         => sf write ${loadaddr} 0 36070


Like here, instead of having to type in the number from print filesize above, simply use ${filesize}.

Also if you use sf update instead of sf write you don't need to do the sf erase step above first.

One last thing, you shouldn't need to do sf probe after each operation. So this whole code block could be just:

=> sf probe => fatload mmc 1 ${loadaddr} tiboot3.bin => sf write ${loadaddr} 0 ${filesize} => fatload mmc 1 ${loadaddr} tispl.bin => sf write ${loadaddr} 0x80000 ${filesize} => fatload mmc 1 ${loadaddr} tiboot3.bin => sf write ${loadaddr} 0x280000 ${filesize}

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

+   $ export MACHINE=beaglebadge-ti
+   $ ARAGO_SYSVINIT=1 bitbake -k tisdk-tiny-image
+
+For more information go :ref:`here <building-the-sdk-with-yocto>`


source/debian/Building_Debian_Image.rst


 .. code-block:: console

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


jmende27 · 2026-01-05T20:24:34Z

all comments, have been adressed in update, @StaticRocket @glneo @jonaswood01 please review

jmende27 · 2026-01-05T22:41:18Z

source/debian/Building_Debian_Image.rst


+.. ifconfig:: CONFIG_part_variant in ('AM62LX')
+
+-  Note for BeagleBadge:


That is going to throw off the flow, look and feel, of the document but alright, it not my documentation.

it shouldn't. reason is you're putting that git checkout command after the actual build command, so a user would miss it unless they read the entire page first. a checkout should go directly after the clone. only reason a checkout command isn't already there is because ti-main is default + desired branch for everything else

jmende27 · 2026-01-05T22:47:59Z

source/debian/Building_Debian_Image.rst


      ./compile.sh build BOARD=<board> BRANCH=vendor BUILD_MINIMAL=yes KERNEL_CONFIGURE=no RELEASE=trixie GIT_SKIP_SUBMODULES=yes SKIP_ARMBIAN_REPO=yes

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


oh, Ok I see what you are doing here. Fine will update

source/debian/Building_Debian_Image.rst

+
+-  Note for BeagleBadge:
+
+   BeagleBadge is supported in Armbian but is not supported on **ti-main** branch, therefore run the following command


jmende27 · 2026-01-05T22:58:37Z

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst

+   `here <https://www.linuxjournal.com/content/embracing-future-transition-sysvinit-systemd-linux>`__
+   for a comparison of both init systems.
+
+To build Armbian for BeagleBadge, refer to **Debian SDK user manual** found `here <https://www.ti.com/tool/AM62L-PROCESSOR-SDK>`__.


Missed this, will update

jonaswood01

it won't let me resolve my comments for some reason, but approved on my end pending #602 (comment) (my last comment)

Add an initial 'How to guide' for BeagleBadge board supported in Debian in Arago distributions. Signed-off-by: Judith Mendez <[email protected]>

jmenti requested review from StaticRocket, VeeruPrudhvi, cshilwant, gehariprasath, jeevantelukula, praneethbajjuri and uditkumarti as code owners December 18, 2025 21:35

jmenti force-pushed the beaglebadge-initial-docs branch from 1bb0711 to 758fc3d Compare December 18, 2025 21:44

StaticRocket requested changes Dec 18, 2025

View reviewed changes

praneethbajjuri previously approved these changes Dec 18, 2025

View reviewed changes

jmenti dismissed praneethbajjuri’s stale review via 3ccd503 December 18, 2025 23:30

jmenti force-pushed the beaglebadge-initial-docs branch from 758fc3d to 3ccd503 Compare December 18, 2025 23:30

praneethbajjuri requested a review from StaticRocket December 18, 2025 23:52

StaticRocket reviewed Dec 19, 2025

View reviewed changes

source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst Outdated Show resolved Hide resolved

jmenti force-pushed the beaglebadge-initial-docs branch 2 times, most recently from aefb06c to 438f8ef Compare December 19, 2025 16:34

praneethbajjuri previously approved these changes Dec 19, 2025

View reviewed changes

praneethbajjuri requested a review from StaticRocket December 19, 2025 16:40

StaticRocket requested changes Dec 19, 2025

View reviewed changes

StaticRocket requested a review from jonaswood01 December 19, 2025 17:21

jonaswood01 reviewed Dec 19, 2025

View reviewed changes

glneo reviewed Dec 19, 2025

View reviewed changes

jonaswood01 reviewed Dec 19, 2025

View reviewed changes

source/debian/Building_Debian_Image.rst

.. code-block:: console

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

This comment was marked as resolved.

Sign in to view

praneethbajjuri self-requested a review December 19, 2025 21:02

jmenti dismissed praneethbajjuri’s stale review via 336fdda January 5, 2026 18:59

jmenti force-pushed the beaglebadge-initial-docs branch from 438f8ef to 336fdda Compare January 5, 2026 18:59

glneo approved these changes Jan 5, 2026

View reviewed changes

jonaswood01 reviewed Jan 5, 2026

View reviewed changes

source/debian/Building_Debian_Image.rst Outdated

- Note for BeagleBadge:

BeagleBadge is supported in Armbian but is not supported on **ti-main** branch, therefore run the following command

This comment was marked as resolved.

Sign in to view

jonaswood01 reviewed Jan 5, 2026

View reviewed changes

jmenti force-pushed the beaglebadge-initial-docs branch from 336fdda to 61d7c47 Compare January 5, 2026 22:49

jonaswood01 approved these changes Jan 5, 2026

View reviewed changes

feat(linux): Add initial documentation for BeagleBadge

1671f3e

Add an initial 'How to guide' for BeagleBadge board supported in Debian in Arago distributions. Signed-off-by: Judith Mendez <[email protected]>

jmenti force-pushed the beaglebadge-initial-docs branch from 61d7c47 to 1671f3e Compare January 5, 2026 23:01

	4. Send bootloader binaries from host MACHINE
	4. Send boot loader binaries from host MACHINE


		.. code-block:: console

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


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

		- Note for BeagleBadge:


		./compile.sh build BOARD=<board> BRANCH=vendor BUILD_MINIMAL=yes KERNEL_CONFIGURE=no RELEASE=trixie GIT_SKIP_SUBMODULES=yes SKIP_ARMBIAN_REPO=yes

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


		- Note for BeagleBadge:

		BeagleBadge is supported in Armbian but is not supported on ti-main branch, therefore run the following command

docs(linux): Add initial documentation for BeagleBadge #602

Are you sure you want to change the base?

docs(linux): Add initial documentation for BeagleBadge #602

Conversation

jmenti commented Dec 18, 2025

Uh oh!

github-actions bot commented Dec 18, 2025

Uh oh!

StaticRocket left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

praneethbajjuri left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

StaticRocket commented Dec 19, 2025

Uh oh!

StaticRocket left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

glneo Dec 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

jmende27 commented Jan 5, 2026

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonaswood01 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

glneo Dec 19, 2025 •

edited

Loading