TF-A: Documentation Updates and Fixes #483
Open
Conversation
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
Improve the wording in the Getting ATF source code section along with a few grammatical fixes. Signed-off-by: Dhruva Gole <[email protected]>
DhruvaG2000
requested review from
StaticRocket,
VeeruPrudhvi,
aniket-l,
cshilwant,
praneethbajjuri and
uditkumarti
as code owners
cshilwant
reviewed
Oct 15, 2025
ATF is no longer the recognised short hand for Trusted Firmware-A anywhere. Replace all such instances of ATF with TF-A Signed-off-by: Dhruva Gole <[email protected]>
Use the ti-fork of ATF for AM62L and for other devices move to an upstream baseline Signed-off-by: Dhruva Gole <[email protected]>
DhruvaG2000
force-pushed
the
fix-tfa-links
branch
from
e70df3d to
7af976e
Compare
Add some more documentation talking about the transition to SCMI from TI SCI and also add what all we now support in TF-A via the SCMI interface. Signed-off-by: Dhruva Gole <[email protected]>
praneethbajjuri
approved these changes
Oct 15, 2025
| Exception Level 3 (EL3). | ||
|
|
||
| Arm Trusted Firmware (ATF) is the initial code on ARMv8-A cores for all K3 platforms. | ||
| TF-A is the initial code on ARMv8-A cores for all K3 platforms. |
There was a problem hiding this comment.
There's still a lot of sections that refer to TF-A as ATF. May be a good idea to clarify the name change in the overview. At least until the name change propagates through the rest of the documentation.
madweshanshu
approved these changes
Oct 15, 2025
kwillis01
approved these changes
Oct 15, 2025
| * ``plat/ti/k3/common/drivers/scmi/scmi_clock.c`` - Clock control and configuration | ||
| * ``plat/ti/k3/board/am62l/scmi/scmi_pd_data.h`` - Device-specific power domain definitions | ||
| * ``plat/ti/k3/board/am62l/scmi/scmi_clk_data.h`` - Device-specific clock tree definitions | ||
| * ``plat/ti/k3/common/drivers/scmi/plat_scmi_def.h`` - Platform SCMI definitions |
There was a problem hiding this comment.
could use the :file: directive here, but I'm not sure if that matters
cshilwant
approved these changes
Oct 15, 2025
glneo
reviewed
Oct 16, 2025
| .. rubric:: SCMI and TI SCI | ||
|
|
||
| The AM62Lx represents a transition in Texas Instruments' approach to system control | ||
| interfaces. In older K3 devices, the Texas Instruments System Controller Interface (TI SCI) |
There was a problem hiding this comment.
"older" might have a negative connotation, maybe use "previous"
glneo
reviewed
Oct 16, 2025
| interfaces. In older K3 devices, the Texas Instruments System Controller Interface (TI SCI) | ||
| was the primary protocol used for power, clock, and resource management. SCMI now serves | ||
| as a replacement for newer devices like the AM62L, offering similar functionality through | ||
| an industry-standard ARM protocol. This transition is the result of not having any Device |
There was a problem hiding this comment.
"not having any x" feels grammatically wrong (it's probably technically fine, just has that feeling), the whole line might be better as:
This transition allowed for the removal of the dedicated Device Management (Cortex-R5F) core for AM62Lx.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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.
Summary
This PR updates and improves the documentation related to Trusted Firmware-A (TF-A). The changes focus on standardizing terminology, fixing source code repository links, and improving overall readability.
🔄 Changes
✅ Terminology Update
🔗 Repository Link Corrections
https://github.com/TexasInstruments/arm-trusted-firmware.git
https://review.trustedfirmware.org/TF-A/trusted-firmware-a.git
📝 Grammar and Readability Improvements