feat(U-Boot): add QoS configuration section#713
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a new U-Boot Quality of Service (QoS) user guide page and wires it into the documentation navigation across supported SoCs.
Changes:
- Added a new
UG-QoS.rstpage describing CBASS QoS concepts and how to modify QoS defaults. - Linked the new QoS page from the U-Boot User’s Guide and multiple platform TOC files.
- Updated the docs linter vocabulary to accept “SysConfig”.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| source/linux/Foundational_Components/U-Boot/Users-Guide.rst | Adds UG-QoS to the U-Boot User’s Guide toctree. |
| source/linux/Foundational_Components/U-Boot/UG-QoS.rst | Introduces new QoS documentation, including references and a safety note. |
| configs/TDA4VM/TDA4VM_linux_toc.txt | Adds UG-QoS to the TDA4VM Linux TOC. |
| configs/J784S4/J784S4_linux_toc.txt | Adds UG-QoS to the J784S4 Linux TOC (also adjusts a Chromium browser line entry). |
| configs/J742S2/J742S2_linux_toc.txt | Adds UG-QoS to the J742S2 Linux TOC. |
| configs/J722S/J722S_linux_toc.txt | Adds UG-QoS to the J722S Linux TOC. |
| configs/J721S2/J721S2_linux_toc.txt | Adds UG-QoS to the J721S2 Linux TOC (also adjusts a Chromium browser line entry). |
| configs/J721E/J721E_linux_toc.txt | Adds UG-QoS to the J721E Linux TOC. |
| configs/J7200/J7200_linux_toc.txt | Adds UG-QoS to the J7200 Linux TOC. |
| configs/AM69A/AM69A_linux_toc.txt | Adds UG-QoS to the AM69A Linux TOC. |
| configs/AM69/AM69_linux_toc.txt | Adds UG-QoS to the AM69 Linux TOC. |
| configs/AM68A/AM68A_linux_toc.txt | Adds UG-QoS to the AM68A Linux TOC. |
| configs/AM68/AM68_linux_toc.txt | Adds UG-QoS to the AM68 Linux TOC. |
| configs/AM67A/AM67A_linux_toc.txt | Adds UG-QoS to the AM67A Linux TOC. |
| configs/AM67/AM67_linux_toc.txt | Adds UG-QoS to the AM67 Linux TOC. |
| configs/AM64X/AM64X_linux_toc.txt | Adds UG-QoS to the AM64X Linux TOC. |
| configs/AM62X/AM62X_linux_toc.txt | Adds UG-QoS to the AM62X Linux TOC. |
| configs/AM62PX/AM62PX_linux_toc.txt | Adds UG-QoS to the AM62PX Linux TOC. |
| configs/AM62LX/AM62LX_linux_toc.txt | Adds UG-QoS to the AM62LX Linux TOC. |
| configs/AM62DX/AM62DX_linux_toc.txt | Adds UG-QoS to the AM62DX Linux TOC. |
| configs/AM62AX/AM62AX_linux_toc.txt | Adds UG-QoS to the AM62AX Linux TOC. |
| .github/styles/config/vocabularies/PSDK/accept.txt | Adds “SysConfig” to the accepted vocabulary list. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| During boot-up, `U-Boot can update`_ these settings by using data from | ||
| the SysConfig tool, which you can download or use online `here`_. | ||
|
|
||
| .. _U-Boot can update: https://source.denx.de/u-boot/u-boot/-/blob/v2025.10/arch/arm/mach-k3/am62px/am62p5_init.c?ref_type=tags#L253 |
|
|
||
| Configuring the QoS blocks of a running system can cause issues. | ||
| You can only change these settings during boot-up by using the | ||
| boot-loaders, when many of the systems in the SoC are idle. |
| copy the file into the :file:`arch/arm/mach-k3/r5/${SOC}/${SOC}_qos_uboot.c` | ||
| and rebuild U-Boot to apply your changes. |
|
just rebased changes and fixed merge conflict |
| During boot-up, `U-Boot can update`_ these settings by using data from | ||
| the SysConfig tool, which you can download or use online `here`_. | ||
|
|
||
| .. _U-Boot can update: https://source.denx.de/u-boot/u-boot/-/blob/v2025.10/arch/arm/mach-k3/am62px/am62p5_init.c?ref_type=tags#L253 |
There was a problem hiding this comment.
Preferred latest mainline tag
| linux/Documentation_Tarball | ||
|
|
||
| linux/Demo_User_Guides/Chromium_Browser No newline at end of file | ||
| linux/Demo_User_Guides/Chromium_Browser |
There was a problem hiding this comment.
Weird, this change doesn't belong on the patch.. seems some whitespace error.. remove this change
| linux/Documentation_Tarball | ||
|
|
||
| linux/Demo_User_Guides/Chromium_Browser No newline at end of file | ||
| linux/Demo_User_Guides/Chromium_Browser |
There was a problem hiding this comment.
Same comment. Remove this change from this pr
|
@nsaulnier-ti for review as well. Thanks @maybe-yiyi form addressing the vale comments from the previous pr. Have one more minor comment, once you address it's lgtm. |
Add basic documentation on how the CBASS QoS blocks function and how Sysconfig can be used to generate the files for U-Boot to apply during the SoC's bootup phase. Co-authored-by: Randolph Sapp <res.sapp@gmail.com> Signed-off-by: Bryan Brattlof <bb@ti.com> Signed-off-by: Yiyoung Liu <y-liu20@ti.com>
|
changes:
|
|
REJECT PR for now. Thanks YiYoung for the work, here is the logic for rejecting this version of the doc:
Must re-file a new Jira ticket to make sure this eventually gets resolved. Nick to file an e2e FAQ with an initial draft explaining QoS generally, others can decide how much to integrate into Linux SDK docs. |
nsaulnier-ti
left a comment
There was a problem hiding this comment.
Do NOT merge this PR as-is. Reject and circle back later with a new doc.
Add basic documentation on how the CBASS QoS blocks function and how Sysconfig can be used to generate the files for U-Boot to apply during the SoC's bootup phase.
Picked up from @bryanbrattlof, old PR is #582.