Skip to content

Commit fcf4bff

Browse files
committed
add missing docs
1 parent ef2a18c commit fcf4bff

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

docs/configuring.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,13 @@ All regblock-specific options are defined under the ``[regblock]`` TOML heading.
4343
4444
[regblock]
4545
default_reset = "arst"
46+
47+
.. data:: err_if_bad_addr
48+
49+
If set to true, generate CPUIF error response if a transaction attempts to
50+
access an address that does not map to anything.
51+
52+
.. data:: err_if_bad_rw
53+
54+
If set to true, generate CPUIF error response if an illegal access is
55+
performed to a read-only or write-only register.

src/peakrdl_regblock/__peakrdl__.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,8 @@ def add_exporter_arguments(self, arg_group: 'argparse._ActionsContainer') -> Non
121121
"--rt-read-fanin",
122122
action="store_true",
123123
default=False,
124-
help="Enable additional read path retiming. Good for register blocks with large readback fan-in"
124+
help="""Enable additional read path retiming. Good for register
125+
blocks with large readback fan-in"""
125126
)
126127
arg_group.add_argument(
127128
"--rt-read-response",
@@ -131,7 +132,8 @@ def add_exporter_arguments(self, arg_group: 'argparse._ActionsContainer') -> Non
131132
)
132133
arg_group.add_argument(
133134
"--rt-external",
134-
help="Retime outputs to external components. Specify a comma-separated list of: reg,regfile,mem,addrmap,all"
135+
help="""Retime outputs to external components. Specify a
136+
comma-separated list of: reg,regfile,mem,addrmap,all"""
135137
)
136138

137139
arg_group.add_argument(
@@ -147,15 +149,16 @@ def add_exporter_arguments(self, arg_group: 'argparse._ActionsContainer') -> Non
147149
"--err-if-bad-addr",
148150
action="store_true",
149151
default=False,
150-
help="Generate CPUIF error response, when the address is decoded incorrectly"
152+
help="""Generate CPUIF error response if a transaction attempts to
153+
access an address that does not map to anything."""
151154
)
152155

153156
arg_group.add_argument(
154157
"--err-if-bad-rw",
155158
action="store_true",
156159
default=False,
157-
help="""Generate CPUIF error response, when an illegal access is
158-
performed to a read-only or write-only register"""
160+
help="""Generate CPUIF error response if an illegal access is
161+
performed to a read-only or write-only register."""
159162
)
160163

161164
def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> None:

0 commit comments

Comments
 (0)