[topgen] Naming convention for negative signals
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
Topgen currently does not follow the naming guideline for low active signals. It is not possible to define a signal which gets rendered as `signal_ni` (same for outputs). If a signal is named `signal_n` it will be rendered as `signal_n_i`.
This violates our styleguide.
The only use currently is in rstmgr and ast. We should clean this up, probably by adding a polarity tag for IOs or just assume a signal name ending on `_n` is low active.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with topgen's signal and output naming logic, then inspect the current uses in rstmgr and ast mentioned in the issue. Decide how low-active polarity should be represented, and consider both the explicit polarity-tag and `_n` naming approaches before checking that signals such as `signal_n` render as `signal_ni` without unwanted separators.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100