Improve AM62X U-Boot documentation#711
Open
maybe-yiyi wants to merge 3 commits into
Open
Conversation
The previous build structure, split by R5/A53 followed by device, meant your eyes had to jump around to find the instructions for the one device you were compiling. Instead, a better way would be to first split by device, so that users can follow one contiguous set of instructions, since they need to build both R5 and A53. Signed-off-by: Yiyoung Liu <y-liu20@ti.com>
BeaglePlay has custom defconfigs (am62x_beagleplay_a53_defconfig and am62x_beagleplay_r5_defconfig) just like other community boards already documented (e.g. BeagleBadge), so it should be included in the build guide. Signed-off-by: Yiyoung Liu <y-liu20@ti.com>
maybe-yiyi
requested review from
StaticRocket,
VeeruPrudhvi,
cshilwant,
gehariprasath,
jeevantelukula,
praneethbajjuri and
uditkumarti
as code owners
github-actions
Bot
assigned
bryanbrattlof,
devarsht,
gehariprasath,
jmenti,
praneethbajjuri,
r-vignesh and
uditkumarti
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds clearer navigation and board-specific build guidance for K3 U-Boot documentation.
Changes:
- Added an introductory description and internal navigation links to the K3 target images page.
- Added BeaglePlay defconfig entries to the build matrix.
- Restructured K3 build instructions into per-board rubrics with explicit R5/A53 command blocks and clarified output artifacts/dependencies.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| source/linux/Foundational_Components/U-Boot/BG-Target-Images-K3.rst | Adds intro context and quick links to key sections. |
| source/linux/Foundational_Components/U-Boot/BG-Build-K3.rst | Adds BeaglePlay configs and reorganizes build instructions into clearer board-specific blocks. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+318
to
+326
| .. code-block:: console | ||
|
|
||
| R5 | ||
| $ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_32" am62x_evm_r5_defconfig O=$UBOOT_DIR/out/r5 | ||
| $ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_32" O=$UBOOT_DIR/out/r5 BINMAN_INDIRS=$TI_LINUX_FW_DIR | ||
|
|
||
| For AM62X LP | ||
| A53 | ||
| $ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_64" am62x_evm_a53_defconfig O=$UBOOT_DIR/out/a53 | ||
| $ make ARCH=arm CROSS_COMPILE="$CROSS_COMPILE_64" CC="$CC_64" BL31=$TFA_DIR/build/k3/lite/release/bl31.bin TEE=$OPTEE_DIR/out/arm-plat-k3/core/tee-pager_v2.bin O=$UBOOT_DIR/out/a53 BINMAN_INDIRS=$TI_LINUX_FW_DIR |
Author
There was a problem hiding this comment.
This is structured the same way as other sections across different architectures.
Since the first subsection is build/boot related, while the second subsection is technical information relating to binary layouts, a user may be confused if the first subsection is necessary for them to read at all (it is!) if no clarification is provided. Signed-off-by: Yiyoung Liu <y-liu20@ti.com>
maybe-yiyi
force-pushed
the
uboot-restructure
branch
from
cdfc43a to
ecc5e6e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improved U-Boot documentation structure:
Reorganized the AM62X build instructions to group by device first (AM62X, AM62X LP, AM62SIP), then architecture (R5 A53). Added documentation for BeaglePlay support with its custom defconfigs.
Additionally, improved the Target Images documentation by adding an introductory paragraph that reiterates the practical "copy to SD card" section and clarifies that Image Formats is reference material.