Update all READMEs, port HW UART & MAC C code examples from PSSP - #132
Conversation
Review Summary by Qodo(Agentic_describe updated until commit c1493d3)Port HW UART and MAC C examples from PSSP and standardize repository documentation
WalkthroughsDescription• **Port HW UART and MAC C code examples from PSSP**: Added two new firmware projects (uart_loopback and mac_c) ported from the PRU Software Support Package, demonstrating UART peripheral loopback and MAC (Multiply-Accumulate) hardware accelerator functionality • **Comprehensive build infrastructure**: Added makefiles, linker configurations, and CCS project specifications for multiple processor variants (AM62x-SK, AM64x-EVM) and PRU cores (PRU0, PRU1) • **Updated all README files**: Standardized documentation across the repository with consistent structure including Introduction, Supported Combinations, and Validated HW & SW sections with hardware/software version tables • **Enhanced academy and examples documentation**: Updated parent README files to reference new projects and improved formatting consistency across all example and academy project documentation • **Build system integration**: Updated academy makefile to include new projects in the build system • **Note**: Ported code has not been tested on silicon yet Diagramflowchart LR
PSSP["PSSP Projects<br/>UART & MAC"]
PORT["Port to<br/>OpenPRU"]
UART["UART Loopback<br/>Project"]
MAC["MAC C<br/>Project"]
BUILD["Build Infrastructure<br/>Makefiles & Configs"]
DOCS["Standardized<br/>Documentation"]
PSSP -- "Port code" --> PORT
PORT --> UART
PORT --> MAC
UART --> BUILD
MAC --> BUILD
BUILD --> DOCS
File Changes1. academy/uart/uart_loopback/firmware/main.c
|
Code Review by Qodo
Context used 1. Validated HW & SW TODOs
|
34e250f to
622958a
Compare
Review Summary by QodoPort UART and MAC C examples from PSSP and update all repository documentation
WalkthroughsDescription• Port HW UART loopback project from PRU Software Support Package (PSSP) with firmware implementation for AM62x processor • Port MAC (Multiply-Accumulate) C code example from PSSP with support for AM62x and AM64x processors • Add comprehensive build configuration files (makefiles, linker scripts, CCS project specifications) for both new projects across multiple processor variants • Standardize and update all README files across the repository to align with OpenPRU v2026.01.00 • Add "Training" section to main README with links to PRU Academy resources • Improve build instructions documentation with dedicated "Building MCU+ projects in CCS" subsection • Standardize documentation format across all academy labs and examples with consistent "Validated HW & SW" sections • Update academy project registry and build system to include new MAC C and UART loopback projects Diagramflowchart LR
PSSP["PSSP Examples<br/>UART & MAC"]
UART["UART Loopback<br/>Firmware"]
MAC["MAC C<br/>Firmware"]
BUILD["Build Config<br/>Makefiles & Linker"]
DOCS["README Updates<br/>Standardization"]
REGISTRY["Academy Registry<br/>& Build System"]
PSSP -->|"Port"| UART
PSSP -->|"Port"| MAC
UART -->|"Configure"| BUILD
MAC -->|"Configure"| BUILD
BUILD -->|"Document"| DOCS
UART -->|"Register"| REGISTRY
MAC -->|"Register"| REGISTRY
DOCS -->|"Update"| REGISTRY
File Changes1. academy/uart/uart_loopback/firmware/main.c
|
|
Persistent review updated to latest commit 622958a |
622958a to
c1493d3
Compare
|
Persistent review updated to latest commit c1493d3 |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
9 similar comments
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Import PRU Software Support Package (PSSP) project https://git.ti.com/cgit/pru-software-support-package/pru-software-support-package/tree/examples/am62x/PRU_MAC_Multiply_Accum https://git.ti.com/cgit/pru-software-support-package/pru-software-support-package/tree/examples/am64x/PRU_MAC_Multiply_Accum into the OpenPRU repository. This is a test of new documentation to guide AI agents to perform specific actions in the OpenPRU project. This project tested the action "create a new OpenPRU project", when the project does not require any pinmux, SysConfig, etc. The project creation was done by claude code. However, I had to code quite a few manual fixes after the initial project creation. Tested-by: Rupesh Yadav <r-yadav@ti.com> Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
Import PRU Software Support Package (PSSP) project https://git.ti.com/cgit/pru-software-support-package/pru-software-support-package/tree/examples/am62x/PRU_Hardware_UART into the OpenPRU repository. This is a test of new documentation to guide AI agents to perform specific actions in the OpenPRU project. This project tested the action "create a new OpenPRU project", when the project does not require any pinmux, SysConfig, etc. The project creation was done by claude code. However, I had to code quite a few manual fixes after the initial project creation. Tested-by: Rupesh Yadav <r-yadav@ti.com> Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
Add the new mac_c and uart projects to the academy/makefile & academy/readme.md files. Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
These projects are used as the template for most new projects created in the OpenPRU repository. Update the README template to look the way we expect new project README files to look. Additionally, point to central documentation for creating a new project or building a project, instead of replicating that information per-project. Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
Standardize the README format to match examples/empty. Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
Standardize the README format to match examples/empty. Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
c1493d3 to
79fc71a
Compare
Update all README files in the OpenPRU repository to align with the latest OpenPRU v2026.01.00.
Port the HW UART project from the PRU Software Support Package (PSSP) as well as the C code version of the MAC example.
The project ports were used to test the behavior of AI agents based on #130.
This pull request should be merged in before #128
Ported code has not been tested on silicon yet
The README updates are the first step to addressing #42