Generate HTML register documentation from an IP-XACT register definition: address maps, registers, fields and reset values.
Reads an IP-XACT register description (a component, memoryMap or addressBlock XML) and writes a self-contained HTML register viewer: top.html plus three data scripts (blocks.js, registers.js, fields.js). The viewer is a single document (no frames, no fetch/XHR), so it opens from a file:// URL in any browser; its three tables (address blocks, registers, bit fields) are virtualised and filterable.
Usage
genregisterdochtml -in <ipxact.xml> [-outdir <dir>] [-v2009 | -v2022] [options]
Every option is listed by genregisterdochtml -help, and the complete reference is in the capability file that ships with the tool's AGENTS.md.
Exit status
- 0 on a normal finish, including runs that reported errors (missing
-in, unreadable XML, unsupported element all return 0). 10 = license checkout failed. 1 =EDAUTILS_ROOTmissing/invalid. - Message format:
genregisterdochtml: <Severity>: <id>: <text>, severity one ofError,Fatal Error,Warning,Note;<id>is a 5-digit message number. Usage lines have no severity or id. - Missing input:
Missing mandatory input- the IP-XACT Register Definition XML or the instance map file ..andNULL object passed as component definition XML .... Unsupported root element:Unsupported IP-XACT Element of type : <class>.
Requirements
Java 11 or newer on PATH (Java 21 recommended), Linux or Windows. Unpack the bundle, run source setup_env.sh and call genregisterdochtml. Install in one command with curl -fsSL https://edautils.com/install.sh | sh -s -- genregisterdochtml.