Skip to content

Show bits that no field covers as reserved fields in the docs - #260

Merged
olagrottvik merged 5 commits into
masterfrom
reserved-fields
Oct 29, 2026
Merged

olagrottvik merged 5 commits into
masterfrom
reserved-fields

Conversation

@olagrottvik

@olagrottvik olagrottvik commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

Closes #223. The LaTeX, HTML and Markdown docs and the editor overview now label every bit that no field covers as reserved instead of unused, and list those bits among the fields. There is no option for this.

before:
  15               9     8     7       4   3    2     1       0
┌────────────────────┬───────┬───────────┬────────┬───────┬───────┐
│       unused       │ flush │   unused  │ parity │ rx_en │ tx_en │
└────────────────────┴───────┴───────────┴────────┴───────┴───────┘

after:
┌────────────────────┬───────┬───────────┬────────┬───────┬───────┐
│      reserved      │ flush │  reserved │ parity │ rx_en │ tx_en │
└────────────────────┴───────┴───────────┴────────┴───────┴───────┘
tx_en     Enable the transmitter. (sw: rw, hw: r)
rx_en     Enable the receiver. (sw: rw, hw: r)
parity    Parity bit. (sw: rw, hw: r)
reserved  Bits 7:4. Read as 0, writes have no effect.
flush     Write 1 to empty both FIFOs. (sw: rw, hw: r, singlepulse)
reserved  Bits 15:9. Read as 0, writes have no effect.
  • Register.bit_ranges lists every bit as either a field or an uncovered run. LaTeX, HTML, Markdown and the editor all build from it.
  • Fixes: the LaTeX diagram dropped gaps made by position, and the Markdown table dropped bits below the lowest field.
  • All doc goldens change (unused becomes reserved). VHDL, the headers, the IPBus table and the hash are unchanged.

@olagrottvik olagrottvik self-assigned this Oct 27, 2026
@read-the-docs-community

read-the-docs-community Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 bust | 🛠️ Build #35501147 | 📁 Comparing 6b72818 against latest (9ac90f3)

  🔍 Preview build  

11 files changed · + 3 added · ± 7 modified · - 1 deleted

+ Added

± Modified

- Deleted

@olagrottvik olagrottvik changed the title Add reserved_fields option for unused register bits Show bits that no field covers as reserved fields in the docs Oct 29, 2026
@olagrottvik
olagrottvik merged commit a43c1a1 into master Oct 29, 2026
11 checks passed
@olagrottvik
olagrottvik deleted the reserved-fields branch October 29, 2026 15:22
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.

Add option to always fill unused bits of a register with reserved fields

1 participant