From 8fd4e60ccff401d4a552032469ae664b310ff4ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ola=20Gr=C3=B8ttvik?= Date: Thu, 29 Oct 2026 15:28:26 +0000 Subject: [PATCH] Share register layout helpers between the editor and all doc formats --- bust/editor/diagram.py | 108 +----------------- bust/editor/overview.py | 4 +- bust/generators/__init__.py | 4 +- bust/generators/documentation_generator.py | 21 ++-- bust/generators/register_layout.py | 116 ++++++++++++++++++++ bust/templates/latex/documentation.j2 | 27 ++--- bust/templates/markdown/documentation.j2 | 13 +-- example/example_prototype/doc/prototype.tex | 46 ++++---- tests/test_reserved_fields.py | 7 +- 9 files changed, 179 insertions(+), 167 deletions(-) create mode 100644 bust/generators/register_layout.py diff --git a/bust/editor/diagram.py b/bust/editor/diagram.py index cb3f070f..301f3b6e 100644 --- a/bust/editor/diagram.py +++ b/bust/editor/diagram.py @@ -7,47 +7,10 @@ box is wider than its bits where its name would not fit. """ -from dataclasses import dataclass -from typing import List, Tuple +from typing import List -from bust.core.enums import RegisterType -from bust.core.field import Field -from bust.core.module import Module from bust.core.register import Register - - -@dataclass -class _Segment: - name: str - high: int - low: int - reset: str - is_unused: bool = False - - @property - def width(self) -> int: - return self.high - self.low + 1 - - -def _reset(text: str, width: int) -> str: - value = int(text, 16) - return str(value) if width < 2 else f"0x{value:X}" - - -def bit_segments(register: Register) -> List[_Segment]: - """The fields of `register` from the highest bit down, with the bits no - field covers between them as reserved.""" - segments = [] - for bits in register.bit_ranges: - if bits.field is None: - segments.append(_Segment("reserved", bits.high, bits.low, "-", True)) - continue - name = ( - bits.field.name if register.type == RegisterType.FIELDS else register.name - ) - reset = _reset(bits.field.reset, bits.width) - segments.append(_Segment(name, bits.high, bits.low, reset)) - return segments +from bust.generators.register_layout import bit_segments def _fit(text: str, width: int) -> str: @@ -85,70 +48,3 @@ def bit_diagram(register: Register, data_width: int) -> List[str]: label = " " + high.ljust(inner - len(low) - 2) + low + " " numbers += " " + label return [numbers, top + "┐", names + "│", bottom + "┘", resets] - - -def _access(register: Register) -> str: - return f"{register.sw.value.upper()}/{register.hw.value.upper()}" - - -def register_list(module: Module) -> Tuple[List[str], List[List[str]]]: - """The headings and rows of the register list.""" - headers = ["#", "Name", "SW/HW", "Address", "Type", "Width", "Reset"] - rows = [ - [ - str(index), - reg.name, - _access(reg), - f"0x{reg.address:08X}", - reg.type.value.upper(), - str(reg.width), - f"0x{int(reg.reset, 16):X}", - ] - for index, reg in enumerate(module.registers) - ] - return headers, rows - - -def register_heading(register: Register) -> Tuple[str, str]: - """The name and access, and the address, as the documentation heads a - register.""" - return f"{register.name} - {_access(register)}", f"0x{register.address:08X}" - - -RESERVED_NOTE = "Read as 0, writes have no effect." - - -def _bits(high: int, low: int) -> str: - return f"{high}:{low}" if high > low else str(low) - - -def _field_note(field: Field) -> str: - keys = [f"sw: {field.sw.value}", f"hw: {field.hw.value}"] - if field.onread: - keys.append(f"onread: {field.onread.value}") - if field.onwrite: - keys.append(f"onwrite: {field.onwrite.value}") - if field.singlepulse: - keys.append("singlepulse") - text = f"({', '.join(keys)})" - if field.is_enum: - values = ", ".join(f"{e.name}={e.value}" for e in field.enums) - text = f"({', '.join(keys)}; values: {values})" - if field.description: - text = f"{field.description} {text}" - return text - - -def field_notes(register: Register) -> List[Tuple[str, str]]: - """Each field's name, and its description with its access, as the - documentation lists them under a register, from the lowest bit up, with - the bits no field covers listed as reserved.""" - notes = [] - for bits in reversed(register.bit_ranges): - if bits.field is not None: - notes.append((bits.field.name, _field_note(bits.field))) - else: - notes.append( - ("reserved", f"Bits {_bits(bits.high, bits.low)}. {RESERVED_NOTE}") - ) - return notes diff --git a/bust/editor/overview.py b/bust/editor/overview.py index f7b599c7..c3f9d6e0 100644 --- a/bust/editor/overview.py +++ b/bust/editor/overview.py @@ -11,8 +11,8 @@ from bust.core.enums import RegisterType from bust.core.module import Module -from bust.editor.diagram import ( - bit_diagram, +from bust.editor.diagram import bit_diagram +from bust.generators.register_layout import ( field_notes, register_heading, register_list, diff --git a/bust/generators/__init__.py b/bust/generators/__init__.py index f3f8300a..403aefd0 100644 --- a/bust/generators/__init__.py +++ b/bust/generators/__init__.py @@ -4,7 +4,9 @@ from module definitions: - HeaderGenerator: Language header file generation (C, C++, Python) -- DocumentationGenerator: LaTeX documentation generation +- DocumentationGenerator: LaTeX, HTML and Markdown documentation generation +- register_layout: The register list, bit segments and field notes the + documentation and the editor share - GeneratorFactory: Factory for creating VHDL generators - vhdl subpackage: VHDL code generators """ diff --git a/bust/generators/documentation_generator.py b/bust/generators/documentation_generator.py index 48363808..ffe0a7f6 100644 --- a/bust/generators/documentation_generator.py +++ b/bust/generators/documentation_generator.py @@ -9,8 +9,10 @@ from bust._version import __VERSION__ from bust.core.enums import RegisterType -from bust.editor.diagram import ( +from bust.generators.register_layout import ( + RESERVED_NOTE, bit_segments, + bits_text, field_notes, register_heading, register_list, @@ -118,12 +120,20 @@ def _render_template(self, template_name, version=None, **context): if version is None: version = __VERSION__ + headers, rows = register_list(self.module) return render_template( template_name, { "module": self.module, "version": version, "reg_type_fields": RegisterType.FIELDS, + "list_headers": headers, + "list_rows": list(zip(rows, self.module.registers)), + "register_heading": register_heading, + "bit_segments": bit_segments, + "field_notes": field_notes, + "bits_text": bits_text, + "reserved_note": RESERVED_NOTE, **context, }, ) @@ -154,15 +164,8 @@ def generate_html_documentation(self, test_version=None): Returns: HTML document as string. """ - headers, rows = register_list(self.module) return self._render_template( - "html/documentation.j2", - test_version, - list_headers=headers, - list_rows=zip(rows, self.module.registers), - register_heading=register_heading, - field_notes=field_notes, - bit_diagram_svg=bit_diagram_svg, + "html/documentation.j2", test_version, bit_diagram_svg=bit_diagram_svg ) def generate_markdown_documentation(self, test_version=None): diff --git a/bust/generators/register_layout.py b/bust/generators/register_layout.py new file mode 100644 index 00000000..9927a2f9 --- /dev/null +++ b/bust/generators/register_layout.py @@ -0,0 +1,116 @@ +"""The layout the documentation and the editor share: the register list, the +heading of each register, the fields of a register from the highest bit down, +and the notes listed under a register. + +The LaTeX, HTML and Markdown documentation and the editor overview all build on +these, so they show the same values in the same form. +""" + +from dataclasses import dataclass +from typing import List, Tuple + +from bust.core.enums import RegisterType +from bust.core.field import Field +from bust.core.module import Module +from bust.core.register import Register + + +@dataclass +class BitSegment: + name: str + high: int + low: int + reset: str + is_unused: bool = False + + @property + def width(self) -> int: + return self.high - self.low + 1 + + +def reset_text(text: str, width: int) -> str: + value = int(text, 16) + return str(value) if width < 2 else f"0x{value:X}" + + +def bit_segments(register: Register) -> List[BitSegment]: + """The fields of `register` from the highest bit down, with the bits no + field covers between them as reserved.""" + segments = [] + for bits in register.bit_ranges: + if bits.field is None: + segments.append(BitSegment("reserved", bits.high, bits.low, "-", True)) + continue + name = ( + bits.field.name if register.type == RegisterType.FIELDS else register.name + ) + reset = reset_text(bits.field.reset, bits.width) + segments.append(BitSegment(name, bits.high, bits.low, reset)) + return segments + + +def access_text(register: Register) -> str: + return f"{register.sw.value.upper()}/{register.hw.value.upper()}" + + +def register_list(module: Module) -> Tuple[List[str], List[List[str]]]: + """The headings and rows of the register list.""" + headers = ["#", "Name", "SW/HW", "Address", "Type", "Width", "Reset"] + rows = [ + [ + str(index), + reg.name, + access_text(reg), + f"0x{reg.address:08X}", + reg.type.value.upper(), + str(reg.width), + f"0x{int(reg.reset, 16):X}", + ] + for index, reg in enumerate(module.registers) + ] + return headers, rows + + +def register_heading(register: Register) -> Tuple[str, str]: + """The name and access, and the address, as the documentation heads a + register.""" + return f"{register.name} - {access_text(register)}", f"0x{register.address:08X}" + + +RESERVED_NOTE = "Read as 0, writes have no effect." + + +def bits_text(high: int, low: int) -> str: + return f"{high}:{low}" if high > low else str(low) + + +def field_note(field: Field) -> str: + keys = [f"sw: {field.sw.value}", f"hw: {field.hw.value}"] + if field.onread: + keys.append(f"onread: {field.onread.value}") + if field.onwrite: + keys.append(f"onwrite: {field.onwrite.value}") + if field.singlepulse: + keys.append("singlepulse") + text = f"({', '.join(keys)})" + if field.is_enum: + values = ", ".join(f"{e.name}={e.value}" for e in field.enums) + text = f"({', '.join(keys)}; values: {values})" + if field.description: + text = f"{field.description} {text}" + return text + + +def field_notes(register: Register) -> List[Tuple[str, str]]: + """Each field's name, and its description with its access, as the + documentation lists them under a register, from the lowest bit up, with + the bits no field covers listed as reserved.""" + notes = [] + for bits in reversed(register.bit_ranges): + if bits.field is not None: + notes.append((bits.field.name, field_note(bits.field))) + else: + notes.append( + ("reserved", f"Bits {bits_text(bits.high, bits.low)}. {RESERVED_NOTE}") + ) + return notes diff --git a/bust/templates/latex/documentation.j2 b/bust/templates/latex/documentation.j2 index c30dbe39..340a78c6 100644 --- a/bust/templates/latex/documentation.j2 +++ b/bust/templates/latex/documentation.j2 @@ -51,8 +51,8 @@ \textbf{\#} & \textbf{Name} & \textbf{SW/HW} & \textbf{Address} & \textbf{Type} & \textbf{Width} & \textbf{Reset} \\ \hline -{% for reg in module.registers %} - {{ loop.index0 }} & {{ reg.name | utf8tolatex }} & {{ reg.sw.value.upper() }}/{{ reg.hw.value.upper() }} & \texttt{0x{{ "%08X" | format(reg.address) }}} & {{ reg.type.value.upper() }} & {{ reg.width }} & \texttt{0x{{ "%X" | format(reg.reset[2:]|int(base=16)) }}} \\ +{% for row, reg in list_rows %} + {{ row[0] }} & {{ row[1] | utf8tolatex }} & {{ row[2] }} & \texttt{{ '{' }}{{ row[3] }}{{ '}' }} & {{ row[4] }} & {{ row[5] }} & \texttt{{ '{' }}{{ row[6] }}{{ '}' }} \\ \hline {% endfor %} \end{tabularx} @@ -62,25 +62,20 @@ \section{Registers} {% for reg in module.registers %} -\begin{register}{{ '{' }}H{{ '}' }}{{ '{' }}{{ reg.name | utf8tolatex }} - {{ reg.sw.value.upper() }}/{{ reg.hw.value.upper() }}{{ '}' }}{{ '{' }}0x{{ "%08X" | format(reg.address) }}{{ '}' }}{% if reg.description %} \par {{ reg.description | utf8tolatex }} \regnewline{% endif +%} +{% set title, address = register_heading(reg) %} +\begin{register}{{ '{' }}H{{ '}' }}{{ '{' }}{{ title | utf8tolatex }}{{ '}' }}{{ '{' }}{{ address }}{{ '}' }}{% if reg.description %} \par {{ reg.description | utf8tolatex }} \regnewline{% endif +%} \label{{ '{' }}{{ reg.name }}{{ '}' }} -{% for bits in reg.bit_ranges %} -{% if bits.field %} - \regfield{{ '{' }}{% if reg.type == reg_type_fields %}{{ bits.field.name | utf8tolatex }}{% endif %}{{ '}' }}{{ '{' }}{{ bits.width }}{{ '}' }}{{ '{' }}{{ bits.low }}{{ '}' }}{{ '{' }}{% if bits.width < 2 %}{{ bits.field.reset[2:]|int(base=16) }}{% else %}{0x{{ "%X" | format(bits.field.reset[2:]|int(base=16)) }}}{% endif %}{{ '}' }} -{% else %} - \regfield{{ '{' }}reserved{{ '}' }}{{ '{' }}{{ bits.width }}{{ '}' }}{{ '{' }}{{ bits.low }}{{ '}' }}{{ '{' }}-{{ '}' }} -{% endif %} +{% for segment in bit_segments(reg) %} +{# A register without fields is one unnamed box, as its name heads it already. #} +{% set name = segment.name if reg.type == reg_type_fields or segment.is_unused else "" %} +{% set reset = segment.reset if segment.width < 2 or segment.is_unused else "{" ~ segment.reset ~ "}" %} + \regfield{{ '{' }}{{ name | utf8tolatex }}{{ '}' }}{{ '{' }}{{ segment.width }}{{ '}' }}{{ '{' }}{{ segment.low }}{{ '}' }}{{ '{' }}{{ reset }}{{ '}' }} {% endfor %} \reglabel{Reset}\regnewline {% if reg.type == reg_type_fields %} \begin{{ '{' }}regdesc{{ '}' }}\begin{{ '{' }}reglist{{ '}' }}[{{ reg.fields | map(attribute='name') | min | utf8tolatex }}] -{% for bits in reg.bit_ranges | reverse %} -{% if not bits.field %} - \item [reserved] Bits {% if bits.width > 1 %}{{ bits.high }}:{% endif %}{{ bits.low }}. Read as 0, writes have no effect. -{% else %} -{% set field = bits.field %} - \item [{{ field.name | utf8tolatex }}] {{ field.description | utf8tolatex }} (sw: {{ field.sw.value }}, hw: {{ field.hw.value }}{% if field.onread %}, onread: {{ field.onread.value }}{% endif %}{% if field.onwrite %}, onwrite: {{ field.onwrite.value }}{% endif %}{% if field.singlepulse %}, singlepulse{% endif %}{% if field.is_enum %}; values: {% for e in field.enums %}{{ e.name }}={{ e.value }}{% if not loop.last %}, {% endif %}{% endfor %}{% endif %}) -{% endif %} +{% for name, note in field_notes(reg) %} + \item [{{ name | utf8tolatex }}] {{ note | utf8tolatex }} {% endfor %} \end{{ '{' }}reglist{{ '}' }}\end{{ '{' }}regdesc{{ '}' }} {% endif %} \end{register} diff --git a/bust/templates/markdown/documentation.j2 b/bust/templates/markdown/documentation.j2 index 13327d6b..d7fe7154 100644 --- a/bust/templates/markdown/documentation.j2 +++ b/bust/templates/markdown/documentation.j2 @@ -1,5 +1,4 @@ -{% macro bits(high, low) %}{{ high }}{% if high > low %}:{{ low }}{% endif %}{% endmacro %} -{% macro field_notes(field) %} +{% macro field_cell(field) %} {% set notes = [] %} {% if field.description %}{% set _ = notes.append(field.description | markdown_cell) %}{% endif %} {% if field.onread %}{% set _ = notes.append("onread: " ~ field.onread.value ~ ".") %}{% endif %} @@ -27,8 +26,8 @@ Generated by bust v{{ version }}. {% if module.version %}Version: {{ module.vers | # | Name | SW/HW | Address | Type | Width | Reset | |--:|------|-------|---------|------|------:|-------| -{% for reg in module.registers %} -| {{ loop.index0 }} | [{{ reg.name }}](#{{ reg.name | lower }}) | {{ reg.sw.value.upper() }}/{{ reg.hw.value.upper() }} | `0x{{ "%08X" | format(reg.address) }}` | {{ reg.type.value.upper() }} | {{ reg.width }} | `0x{{ "%X" | format(reg.reset[2:]|int(base=16)) }}` | +{% for row, reg in list_rows %} +| {{ row[0] }} | [{{ row[1] }}](#{{ reg.name | lower }}) | {{ row[2] }} | `{{ row[3] }}` | {{ row[4] }} | {{ row[5] }} | `{{ row[6] }}` | {% endfor %} ## Registers @@ -46,11 +45,11 @@ Address `0x{{ "%08X" | format(reg.address) }}`, {{ reg.sw.value.upper() }}/{{ re |------|------|----|----|-------|-------------| {% for range in reg.bit_ranges %} {% if not range.field %} -| {{ bits(range.high, range.low) }} | reserved | | | | Read as 0, writes have no effect. | +| {{ bits_text(range.high, range.low) }} | reserved | | | | {{ reserved_note }} | {% else %} {% set field = range.field %} -{% set notes = field_notes(field) %} -| {{ bits(field.pos_high, field.pos_low) }} | {{ field.name }} | {{ field.sw.value }} | {{ field.hw.value }} | `0x{{ "%X" | format(field.reset[2:]|int(base=16)) }}` |{% if notes %} {{ notes }}{% endif %} | +{% set notes = field_cell(field) %} +| {{ bits_text(field.pos_high, field.pos_low) }} | {{ field.name }} | {{ field.sw.value }} | {{ field.hw.value }} | `0x{{ "%X" | format(field.reset[2:]|int(base=16)) }}` |{% if notes %} {{ notes }}{% endif %} | {% endif %} {% endfor %} {% endfor %} diff --git a/example/example_prototype/doc/prototype.tex b/example/example_prototype/doc/prototype.tex index 4f9f21ae..081e1a03 100644 --- a/example/example_prototype/doc/prototype.tex +++ b/example/example_prototype/doc/prototype.tex @@ -88,8 +88,8 @@ \section{Registers} \regfield{field0}{1}{0}{0} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: r) - \item [field1] (sw: rw, hw: r) + \item [field0] (sw: rw, hw: r) + \item [field1] (sw: rw, hw: r) \item [reserved] Bits 31:3. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -102,9 +102,9 @@ \section{Registers} \regfield{field0}{4}{0}{{0x0}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: ro, hw: w) - \item [field1] (sw: ro, hw: w) - \item [field2] (sw: ro, hw: w) + \item [field0] (sw: ro, hw: w) + \item [field1] (sw: ro, hw: w) + \item [field2] (sw: ro, hw: w) \item [reserved] Bits 31:6. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -115,7 +115,7 @@ \section{Registers} \regfield{field0}{1}{0}{0} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: wo, hw: r) + \item [field0] (sw: wo, hw: r) \item [reserved] Bits 31:1. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -126,7 +126,7 @@ \section{Registers} \regfield{field0}{8}{0}{{0x0}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: na) + \item [field0] (sw: rw, hw: na) \item [reserved] Bits 31:8. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -139,9 +139,9 @@ \section{Registers} \regfield{field0}{4}{0}{{0x0}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: rw) + \item [field0] (sw: rw, hw: rw) \item [reserved] Bits 7:4. Read as 0, writes have no effect. - \item [field1] (sw: rw, hw: r) + \item [field1] (sw: rw, hw: r) \item [reserved] Bits 31:9. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -153,8 +153,8 @@ \section{Registers} \regfield{field0}{4}{0}{{0x0}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: r, onread: rclr) - \item [field1] (sw: rw, hw: r, onread: rset) + \item [field0] (sw: rw, hw: r, onread: rclr) + \item [field1] (sw: rw, hw: r, onread: rset) \item [reserved] Bits 31:8. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -167,9 +167,9 @@ \section{Registers} \regfield{field0}{4}{0}{{0x0}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: r, onwrite: woset) - \item [field1] (sw: rw, hw: r, onwrite: woclr) - \item [field2] (sw: rw, hw: r, onwrite: wot) + \item [field0] (sw: rw, hw: r, onwrite: woset) + \item [field1] (sw: rw, hw: r, onwrite: woclr) + \item [field2] (sw: rw, hw: r, onwrite: wot) \item [reserved] Bits 31:12. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -182,9 +182,9 @@ \section{Registers} \regfield{field0}{4}{0}{{0x0}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: r, onwrite: wzs) - \item [field1] (sw: rw, hw: r, onwrite: wzc) - \item [field2] (sw: rw, hw: r, onwrite: wzt) + \item [field0] (sw: rw, hw: r, onwrite: wzs) + \item [field1] (sw: rw, hw: r, onwrite: wzc) + \item [field2] (sw: rw, hw: r, onwrite: wzt) \item [reserved] Bits 31:12. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -196,8 +196,8 @@ \section{Registers} \regfield{field0}{4}{0}{{0xF}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: r, onwrite: wclr) - \item [field1] (sw: rw, hw: r, onwrite: wset) + \item [field0] (sw: rw, hw: r, onwrite: wclr) + \item [field1] (sw: rw, hw: r, onwrite: wset) \item [reserved] Bits 31:8. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -209,8 +209,8 @@ \section{Registers} \regfield{field0}{4}{0}{{0x0}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: r) - \item [field1] (sw: rw, hw: r) + \item [field0] (sw: rw, hw: r) + \item [field1] (sw: rw, hw: r) \item [reserved] Bits 31:8. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -221,7 +221,7 @@ \section{Registers} \regfield{field0}{4}{0}{{0x0}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: r, singlepulse) + \item [field0] (sw: rw, hw: r, singlepulse) \item [reserved] Bits 31:4. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} @@ -232,7 +232,7 @@ \section{Registers} \regfield{field0}{2}{0}{{0x0}} \reglabel{Reset}\regnewline \begin{regdesc}\begin{reglist}[field0] - \item [field0] (sw: rw, hw: r; values: STATE0=0, STATE1=1, STATE2=2, STATE3=3) + \item [field0] (sw: rw, hw: r; values: STATE0=0, STATE1=1, STATE2=2, STATE3=3) \item [reserved] Bits 31:2. Read as 0, writes have no effect. \end{reglist}\end{regdesc} \end{register} diff --git a/tests/test_reserved_fields.py b/tests/test_reserved_fields.py index 319b2136..199ed019 100644 --- a/tests/test_reserved_fields.py +++ b/tests/test_reserved_fields.py @@ -56,9 +56,9 @@ def test_latex_documentation_lists_reserved_fields(): ) in tex assert " \\regfield{reserved}{24}{8}{-}\n \\regfield{}{8}{0}" in tex assert ( - " \\item [enable] (sw: rw, hw: r)\n" + " \\item [enable] (sw: rw, hw: r)\n" " \\item [reserved] Bits 3:1. Read as 0, writes have no effect.\n" - " \\item [mode] (sw: rw, hw: r)\n" + " \\item [mode] (sw: rw, hw: r)\n" " \\item [reserved] Bits 31:6. Read as 0, writes have no effect.\n" ) in tex assert "unused" not in tex @@ -93,7 +93,8 @@ def test_markdown_documentation_lists_bits_below_the_lowest_field(): def test_the_editor_overview_shows_reserved_fields(): pytest.importorskip("textual") - from bust.editor.diagram import bit_diagram, field_notes + from bust.editor.diagram import bit_diagram + from bust.generators.register_layout import field_notes ctrl = _module().registers[0]