Skip to content

docs: add a PRU-ICSS documentation map (per-device TRM / register addendum / instruction guide pointers) #156

Description

@pratheesh

Summary

There is no single place in open-pru (or a standalone TI reference guide) that tells a developer where the PRU-ICSS documentation lives for the currently supported Sitara MCUs. Users coming from the AM335x era expect a dedicated PRU-ICSS Reference Guide (SPRUHF8A). For the newer AM26x / AM24x parts that content is instead folded into the device TRM chapter, a register addendum, and the PRU Assembly Instruction User Guide — and that mapping is not obvious.

This is a recurring question on E2E — e.g. "AM263P4 PRU-ICSS: Is there a Technical Reference Manual equivalent to SPRUHF8A?" (E2E thread 1665810).

Proposal

Add a short docs/ page — a PRU-ICSS documentation map — that lists, per supported device, the authoritative references, and states explicitly that there is no SPRUHF8A-style standalone guide for these parts (PRU-ICSS/ICSSM is documented as a chapter of the device TRM plus the register addendum). Link it from README.md / docs/getting_started.md.

Suggested table (literature numbers verified against ti.com):

Device family TRM (PRU-ICSS/ICSSM chapter) Register Addendum Assembly instruction guide
AM263Px SPRUJ55 AM263Px Register Addendum SPRUIJ2
AM263x SPRUJ17 SPRUJ42 SPRUIJ2
AM261x SPRUJB6 AM261x Register Addendum SPRUIJ2
AM243x / AM64x SPRUIM2 (device register addendum) SPRUIJ2

Plus a one-line note: the AM26x parts use PRU-ICSSM (a later-generation, MCU-oriented ICSS), which differs from the first-generation AM335x PRU-ICSS that SPRUHF8A describes — so there is no direct SPRUHF8A equivalent by design.

Scope

Documentation only. docs/ already hosts getting_started* and the PRU Assembly Instruction Cheat Sheet (which points to SPRUIJ2); this extends that with a device→reference map. Happy to submit the PR.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions