-
Notifications
You must be signed in to change notification settings - Fork 76
docs(linux): Add initial documentation for BeagleBadge #602
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.
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
base: master
Are you sure you want to change the base?
Conversation
|
New warnings found with rstcheck: |
1bb0711 to
758fc3d
Compare
StaticRocket
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please review the vale warnings as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use the standard section hierarchy.
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections
source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst
Outdated
Show resolved
Hide resolved
source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst
Show resolved
Hide resolved
source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst
Outdated
Show resolved
Hide resolved
source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst
Outdated
Show resolved
Hide resolved
source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst
Outdated
Show resolved
Hide resolved
praneethbajjuri
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok for initial docs.
@Grippy98 please review. We can always expand this more based on incremental feedback later
758fc3d to
3ccd503
Compare
source/linux/How_to_Guides/Target/How_to_BeagleBadge_getting_started.rst
Outdated
Show resolved
Hide resolved
3ccd503 to
aefb06c
Compare
Add an initial 'How to guide' for BeagleBadge board supported in Debian in Arago distributions. Signed-off-by: Judith Mendez <jm@ti.com>
aefb06c to
438f8ef
Compare
StaticRocket
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two suggestions to make vale happy. Please also fix the sections.
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 4. Send bootloader binaries from host MACHINE | |
| 4. Send boot loader binaries from host MACHINE |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bootloader is typically one word
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
|
|
||
| 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, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick, but it should say "Debian or Yocto" or "Armbian or Arago", instead of the mixed "Debian or Arago", elsewhere in guide too
|
|
||
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| SD boot: | ||
| 1. Flash SD card with Debian or Arago image | ||
| 2. Insert Micro SD card | ||
| 3. Press & hold Select until step 4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not just "until" step 4, it needs to be held "through" step 4, or until step 5.
| => fatload mmc 1 ${loadaddr} tiboot3.bin | ||
| 221296 bytes read in 11 ms (19.2 MiB/s) | ||
| => print filesize |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to print filesize, just use it directly in the commands below.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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}
| $ export MACHINE=beaglebadge-ti | ||
| $ ARAGO_SYSVINIT=1 bitbake -k tisdk-tiny-image | ||
| For more information go :ref:`here <building-the-sdk-with-yocto>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No longer putting debian build instructions or a link to the existing debian build guide ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is your solution now just addition of beaglebadge.conf line in source/debian/Building_Debian_Image.rst ?
|
|
||
| .. code-block:: console | ||
| git clone https://github.com/TexasInstruments/armbian-build.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If yes to #602, you should add note to git checkout 2025.12-beaglebadge dev branch for beaglebadge only until officially supported. Later on it can be on default branch and note removed
Add an initial 'How to guide' for BeagleBadge board supported in Debian in Arago distributions.