Skip to content

[top,all] Drop _aon suffix from IP names#30563

Draft
glaserf wants to merge 33 commits into
lowRISC:masterfrom
glaserf:toplevel-hier-suffix
Draft

[top,all] Drop _aon suffix from IP names#30563
glaserf wants to merge 33 commits into
lowRISC:masterfrom
glaserf:toplevel-hier-suffix

Conversation

@glaserf

@glaserf glaserf commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Historically, OpenTitan tops used the _aon suffix in IP instance names to identify IPs that belong to the Aon power domain, because all IPs were instantiated under a single wrapper/level of hierarchy.

Since we now have a separate wrapper for each power domain (merged in #30076), this suffixing is no longer required; domain attribution is indicated through which wrapper an IP is instantiated in. Additionally, since this suffixing propagated through device tables to software and other parts the code base, this made IPs somewhat power domain-locked (e.g., symbols in the generated memory map contained the suffix in a capitalized form, rendering software shared between tops unusable for some of them if an IP ever gets instantiated in two different domains).

This PR therefore drops the _aon suffix from the toplevel.hjsons single-source-of-truth as well as from a large number of both manually maintained and auto-generated files. The PR touches a sizable part of the code base but is completely mechanical in nature.

This PR (following #30076 and #30387) marks the end of the power domain hierarchy reorganization efforts as described in this RFC.

Depends on #30387. The Verible Lint job is currently failing due to the set of changed files being too large.

@glaserf glaserf force-pushed the toplevel-hier-suffix branch 28 times, most recently from bb86fd0 to d3da45c Compare July 3, 2026 15:56
glaserf added 2 commits July 5, 2026 20:45
In accordance with the power domain reorganization RFC, this commit
consistently names the toplevel power domain HDL modules
`{topname}_pd_{domain}`. This mainly means that all the `top_{topname}`
modules are now called `{topname}_pd_main`, i.e., the default power
domain no longer has a special name for the corresponding HDL module.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
After the recent power domain reorganization (lowRISC#30076), the HDL paths in
the generated RAL collateral require knowledge about the power domain of
each IP. This issue so far hasn't shown itself since so far the path to
the main power domain wasn't changed, and the chip level dv env did not
do any RAL-based accesses to IPs in the Aon domain.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
glaserf added 15 commits July 5, 2026 20:45
Similar to the preceeding commit for the englishbreakfast top. Only
touches the toplevel hjson and the peri xbar hjson.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
Similar to the preceeding commit for the darjeeling top.
Touches the toplevel hjson, the peri xbar hjson, and the
darjeeling-specific toplevel/chiplevel sv template.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
This commit contains a large amount of auto-generated changes in all
parts of the design, including software and documentation collateral due
to the removal of the _aon suffix in the names of IPs instantiated in
the Aon domain.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
Analogous to the preceeding commit for the englishbreakfast top.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
Analogous to the preceeding commit for the darjeeling top.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
This commit contains a large amount of path-related changes to the
vseqs, the chip-level testbenches and a number of macros and
connect-related dv collateral.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
Analogous to the preceeding commit for the darjeeling top.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
Contains changes to both earlgrey and englishbreakfast FPGA constraints.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
…uffix

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
Signed-off-by: Florian Glaser <glaserf@lowrisc.org>

[dv/cov] Update coverage cfg paths for new top-level wrapper

Mirror the dv/cov path updates done earlier for the PD reorganization,
this time accounting for the additional top_{topname} wrapper level.
Coverage and exclusion paths now traverse
tb.dut.top_{topname}.{topname}_pd_{main,aon}.u_* instead of
tb.dut.top_{topname}.u_* or tb.dut.top_{topname}_pd_aon.u_*.

For darjeeling, AON instances that had not yet been re-rooted under
top_darjeeling_pd_aon are placed directly under
top_darjeeling.darjeeling_pd_aon.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
This commit touches a large part of the device software, but only drops
the Aon IP suffix in various forms.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
As a counterpart to the preceeding commit, this one gets rid of all
traces of the various forms of the Aon suffix for the host software,
including scripts for the penetration tests.

Signed-off-by: Florian Glaser <glaserf@lowrisc.org>
@glaserf glaserf force-pushed the toplevel-hier-suffix branch from d3da45c to 71ab093 Compare July 5, 2026 18:46
@glaserf glaserf marked this pull request as ready for review July 6, 2026 07:47
@glaserf glaserf requested review from a team and cfrantz as code owners July 6, 2026 07:47
@glaserf glaserf requested review from engdoreis and martin-velay and removed request for a team, cfrantz, engdoreis and martin-velay July 6, 2026 07:47
@glaserf glaserf marked this pull request as draft July 6, 2026 10:12
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.

1 participant