Skip to content

Conversation

@bryanbrattlof
Copy link
Collaborator

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.

@github-actions
Copy link

New issues found with check_toc_txt.py:

WARNING:root:Invalid slug: configs/AM62AX/AM62AX_linux_toc.txt:47 inux/Foundational_Components/U-Boot/UG-QoS

@github-actions
Copy link

New warnings found with rstcheck:

source/linux/Foundational_Components/U-Boot/UG-QoS.rst:49: (ERROR/3) Unknown target name: "an excellent guide".

@bryanbrattlof bryanbrattlof marked this pull request as draft December 12, 2025 21:13
@bryanbrattlof bryanbrattlof force-pushed the sdk11.2-qos branch 3 times, most recently from 792589f to c2884e4 Compare December 12, 2025 21:47
@bryanbrattlof bryanbrattlof marked this pull request as ready for review December 12, 2025 22:05
Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vale comments about simple language an passive voice should probably be addressed

@bryanbrattlof bryanbrattlof marked this pull request as draft December 15, 2025 13:09
@github-actions
Copy link

New issues found with check_toc_txt.py:

WARNING:root:Invalid slug: configs/AM62AX/AM62AX_linux_toc.txt:47 inux/Foundational_Components/U-Boot/UG-QoS

@bryanbrattlof bryanbrattlof force-pushed the sdk11.2-qos branch 3 times, most recently from a17be0c to 12fdf23 Compare December 15, 2025 23:59
@bryanbrattlof bryanbrattlof marked this pull request as ready for review December 16, 2025 00:03
@bryanbrattlof
Copy link
Collaborator Author

I took care of most of the Vale issues. What I scanned seems to be stuff I don't think we can fix unless I skipped over something.

I also split up the file endings to a separate patch

Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still some lengthy sentences here that vale doesn't like. Going to let others voice opinions about that

@cshilwant cshilwant added the stale PR is not updated by Author in recent times. Will be declined after 1 week label Jan 25, 2026
bryanbrattlof and others added 2 commits February 3, 2026 11:19
Simple invisible character fixes

Signed-off-by: Bryan Brattlof <bb@ti.com>
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>
linux/Documentation_Tarball

linux/Demo_User_Guides/Chromium_Browser No newline at end of file
linux/Demo_User_Guides/Chromium_Browser
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesnt belong in this patch.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what patch are you referring? Do I need a separate PR to fix the white-space with this file before I update it?

@StaticRocket StaticRocket removed the stale PR is not updated by Author in recent times. Will be declined after 1 week label Feb 5, 2026
Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typos and active voice

======================

Most transactions default to the lowest priority (ASEL 0, Order ID 0).
During boot-up, `U-Boot can update`_ these settings using data from the.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
During boot-up, `U-Boot can update`_ these settings using data from the.
During boot-up, `U-Boot can update`_ these settings with data from the


Most transactions default to the lowest priority (ASEL 0, Order ID 0).
During boot-up, `U-Boot can update`_ these settings using data from the.
Sysconfig Tool which you can download or launch online `here`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Sysconfig Tool which you can download or launch online `here`_.
Sysconfig Tool, which you can download or use online `here`_.


The Common Bus Architecture (CBASS) module includes Quality of Service
(QoS) blocks to route and prioritize SoC bus traffic. By adjusting
attributes like priority, Address Selection (ASEL), and Order ID
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
attributes like priority, Address Selection (ASEL), and Order ID
attributes such as priority, Address Selection (ASEL), and Order ID

.. _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
.. _here: https://www.ti.com/tool/SYSCONFIG

The MCU+ SDK documentation has `an excellent guide`_ on how to to use the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The MCU+ SDK documentation has `an excellent guide`_ on how to to use the
The MCU+ SDK documentation has `an excellent guide`_ on how to use the

.. note::

Configuring the QoS blocks of a running system can cause issues.
You can only modify these settings during boot-up by the boot-loaders
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can only modify these settings during boot-up by the boot-loaders
You can only change these settings during boot by using the boot-loaders,


For example, most K3 SoC External Memory Interface (EMIF) controllers
use two ports. Setting an Order ID between 8 and 15 routes traffic
through a high-priority port, ensuring it is serviced before standard
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
through a high-priority port, ensuring it is serviced before standard
through a high-priority port, ensuring it gets serviced before standard

@bryanbrattlof
Copy link
Collaborator Author

bryanbrattlof commented Feb 11, 2026

No. I've had enough. This has taken me 2 months to get through the nitpicking. So long in fact the people originally asking for this documentation are no longer with TI. I will be marking this a blocked until we get a proper copy editor.

I have better things to do with my time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants