Skip to content

Fix #77: update linker command README references#144

Open
pratheesh wants to merge 1 commit into
TexasInstruments:mainfrom
pratheesh:fix/issue-77-linker-readmes
Open

Fix #77: update linker command README references#144
pratheesh wants to merge 1 commit into
TexasInstruments:mainfrom
pratheesh:fix/issue-77-linker-readmes

Conversation

@pratheesh

Copy link
Copy Markdown
Contributor

Summary

  • Link the linker command README files to the PRU Academy Getting Started Labs
  • Add direct lab references for linker command setup and memory/debugging guidance
  • Replace stale PSSP template references with OpenPRU rpmsg_echo_linux and source/include/linux references

Fixes #77.

Verification

  • git show --check --stat 877fb4c3
  • rg -n "PSSP|<PSSP_PATH>|PRU Academy|Lab 2|Lab 5|rpmsg_echo_linux" source/linker_cmd -g 'README.md'

@qodo-code-review

qodo-code-review Bot commented Jun 15, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (1) 📎 Requirement gaps (1)

Context used

Grey Divider


Action required

1. Memory allocation link missing 📎 Requirement gap ⚙ Maintainability
Description
The updated asm_code/README.md and c_code/README.md under source/linker_cmd add PRU Academy
lab links but do not include any hyperlink to memory allocation documentation. This violates the
requirement to provide a direct, working reference for PRU memory allocation guidance.
Code

source/linker_cmd/asm_code/README.md[R10-14]

+For training on how to customize the linker.cmd file for your project, refer to:
+
+* [PRU Academy Getting Started Labs](https://dev.ti.com/tirex/explore/node?node=A__AJo3DdH.80GKNY3N0Yedpg__com.ti.PRU-ICSS-ACADEMY__Yt0fM6x__LATEST)
+* [Lab 2: How to Write PRU Firmware](https://software-dl.ti.com/processor-sdk-linux/esd/AM335X/11_02_05_02/exports/docs/common/PRU-ICSS/PRU-Getting-Started-Labs_Lab2_cCode.html)
+* [Lab 5: Basic Debugging of PRU Firmware](https://software-dl.ti.com/processor-sdk-linux/esd/AM62X/latest/exports/docs/common/PRU-ICSS/PRU-Getting-Started-Labs_Lab5.html)
Evidence
PR Compliance ID 2 requires a working hyperlink to memory allocation documentation in the updated
source/linker_cmd README files. In both the updated source/linker_cmd/asm_code/README.md and
source/linker_cmd/c_code/README.md, the “More information” section contains only PRU Academy/Lab
links and provides no memory allocation documentation link, demonstrating the required reference is
missing.

README includes link to memory allocation documentation
source/linker_cmd/asm_code/README.md[10-14]
source/linker_cmd/c_code/README.md[8-12]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
Both `source/linker_cmd/asm_code/README.md` and `source/linker_cmd/c_code/README.md` are missing a hyperlink to the PRU memory allocation documentation pages.

## Issue Context
Compliance requires that updated `source/linker_cmd` README files include a working link to memory allocation documentation so users can find PRU memory layout/allocation guidance.

## Fix Focus Areas
- source/linker_cmd/asm_code/README.md[10-14]
- source/linker_cmd/c_code/README.md[8-12]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Remediation recommended

2. Unwrapped long URL line 📘 Rule violation ⚙ Maintainability
Description
The newly added markdown link line is very long and is not reflowed/wrapped, which risks exceeding
repository line-length expectations and harming markdown readability. This violates the
documentation formatting requirement to reflow long lines to repository limits.
Code

source/linker_cmd/asm_code/README.md[12]

+* [PRU Academy Getting Started Labs](https://dev.ti.com/tirex/explore/node?node=A__AJo3DdH.80GKNY3N0Yedpg__com.ti.PRU-ICSS-ACADEMY__Yt0fM6x__LATEST)
Evidence
PR Compliance ID 23 requires long documentation lines to be reflowed to repository limits. The added
inline URL line is not wrapped/reflowed and is substantially longer than typical markdown
line-length standards, demonstrating non-compliance with the formatting requirement.

source/linker_cmd/asm_code/README.md[12-12]
source/linker_cmd/c_code/README.md[10-10]
Best Practice: Learned patterns

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
A newly added markdown link line is excessively long and should be wrapped/reflowed to meet repository documentation formatting expectations.

## Issue Context
The README now includes long inline URLs; use reference-style links or wrap so that lines stay within repository line-length limits.

## Fix Focus Areas
- source/linker_cmd/asm_code/README.md[12-14]
- source/linker_cmd/c_code/README.md[10-12]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


3. INTC header name mismatch 🐞 Bug ≡ Correctness
Description
In source/linker_cmd/c_code/README.md, the INTC-map template path points to intc_map.h but the
subsequent include snippet still shows intc_map_0.h, which is inconsistent with the OpenPRU
rpmsg_echo_linux examples and can cause copy/paste mistakes.
Code

source/linker_cmd/c_code/README.md[R25-29]

1. Add the INTC map file to the project. Use this file as a template:
-   <PSSP_PATH>/examples/<processor>/PRU_Direct_Connect0/intc_map_0.h
+   `examples/rpmsg_echo_linux/firmware/<board>/<core>/ti-pru-cgt/intc_map.h`

2. Include the INTC map file in the main.c file.
Evidence
The README points users at .../intc_map.h as the template, but the include snippet immediately
below uses intc_map_0.h. The canonical rpmsg_echo_linux firmware includes intc_map.h, indicating
the snippet should match that filename.

source/linker_cmd/c_code/README.md[20-36]
examples/rpmsg_echo_linux/firmware/main.c[6-13]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`source/linker_cmd/c_code/README.md` instructs users to use `intc_map.h` as the INTC-map template, but the example `#include` line still references `intc_map_0.h`. This mismatch makes the instructions self-inconsistent and diverges from the `rpmsg_echo_linux` example firmware.

### Issue Context
The OpenPRU `rpmsg_echo_linux` example firmware includes `intc_map.h`.

### Fix Focus Areas
- source/linker_cmd/c_code/README.md[25-32]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

Qodo Logo

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Refresh linker_cmd READMEs with PRU Academy and OpenPRU references
📝 Documentation 🕐 Less than 10 minutes

Grey Divider

Walkthroughs

Description
• Add direct links to PRU Academy Getting Started Labs and relevant lab pages
• Replace stale PSSP template paths with OpenPRU rpmsg_echo_linux and linux headers
• Clarify where to find INTC map and resource table linker examples for Linux RPMsg
High-Level Assessment

The PR’s approach (updating the docs to point at current PRU Academy labs and OpenPRU example locations) is the most maintainable option. Alternatives like duplicating content from labs into this repo would likely go stale again and increase doc maintenance burden.

Grey Divider

File Changes

Documentation (2)
README.md Add PRU Academy and lab links for linker.cmd training +5/-2

Add PRU Academy and lab links for linker.cmd training

• Replaces the generic PRU Academy mention with a short list of direct links to PRU Academy Getting Started Labs and specific labs relevant to firmware authoring and debugging.

source/linker_cmd/asm_code/README.md


README.md Swap PSSP references for OpenPRU Linux RPMsg examples and headers +12/-9

Swap PSSP references for OpenPRU Linux RPMsg examples and headers

• Adds direct PRU Academy and lab links in the 'More information' section. Replaces legacy PSSP template paths with OpenPRU locations for INTC map and resource table examples (rpmsg_echo_linux firmware and source/include/linux).

source/linker_cmd/c_code/README.md


Grey Divider

ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan

Qodo Logo

Comment thread source/linker_cmd/asm_code/README.md Outdated
Comment thread source/linker_cmd/asm_code/README.md Outdated
Comment thread source/linker_cmd/asm_code/README.md
Comment thread source/linker_cmd/c_code/README.md
Comment thread source/linker_cmd/c_code/README.md Outdated
@nsaulnier-ti nsaulnier-ti force-pushed the fix/issue-77-linker-readmes branch from 877fb4c to 5f32039 Compare June 24, 2026 14:04
@pratheesh pratheesh force-pushed the fix/issue-77-linker-readmes branch from 5f32039 to 47f7e20 Compare June 26, 2026 15:08
@pratheesh

Copy link
Copy Markdown
Contributor Author

@nsaulnier-ti thanks for the review — addressed in 47f7e20.

  • Removed the replicated PRU Academy / Lab link list from both source/linker_cmd/asm_code/README.md and source/linker_cmd/c_code/README.md.
  • Reworded the sentence as suggested: "For training on how to customize the linker.cmd file for your project, refer to your processor's PRU Academy > Getting Started Labs > Lab 2: How to Write PRU Firmware." This keeps the academy links only in the top-level README for easier maintenance.
  • The PSSP → OpenPRU reference updates in c_code/README.md (INTC map / resource table paths now pointing at examples/rpmsg_echo_linux/... and source/include/linux/...) are unchanged, since those weren't flagged.

Re the qodo bot's "memory allocation link" note: skipped intentionally, per your guidance that the added links were not wanted here.

@nsaulnier-ti nsaulnier-ti force-pushed the fix/issue-77-linker-readmes branch from 47f7e20 to e4f5fbe Compare June 26, 2026 15:16
@nsaulnier-ti nsaulnier-ti force-pushed the fix/issue-77-linker-readmes branch from e4f5fbe to 981c849 Compare June 26, 2026 16:55
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.

update source/linker_cmd README files

2 participants