bslathi19/PeakRDL-regblock
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add missing docs

Browse Source
This commit is contained in:
Alex Mykyta
2025-11-04 21:28:51 -08:00
parent ef2a18c8c0
commit fcf4bffeb7
2 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/configuring.rst
View File

@@ -43,3 +43,13 @@ All regblock-specific options are defined under the ``[regblock]`` TOML heading.
[regblock] [regblock]
default_reset = "arst" default_reset = "arst"
.. data:: err_if_bad_addr
If set to true, generate CPUIF error response if a transaction attempts to
access an address that does not map to anything.
.. data:: err_if_bad_rw
If set to true, generate CPUIF error response if an illegal access is
performed to a read-only or write-only register.

13
src/peakrdl_regblock/__peakrdl__.py
View File

@@ -121,7 +121,8 @@ class Exporter(ExporterSubcommandPlugin):
"--rt-read-fanin", "--rt-read-fanin",
action="store_true", action="store_true",
default=False, default=False,
help="Enable additional read path retiming. Good for register blocks with large readback fan-in" help="""Enable additional read path retiming. Good for register
blocks with large readback fan-in"""
) )
arg_group.add_argument( arg_group.add_argument(
"--rt-read-response", "--rt-read-response",
@@ -131,7 +132,8 @@ class Exporter(ExporterSubcommandPlugin):
) )
arg_group.add_argument( arg_group.add_argument(
"--rt-external", "--rt-external",
help="Retime outputs to external components. Specify a comma-separated list of: reg,regfile,mem,addrmap,all" help="""Retime outputs to external components. Specify a
comma-separated list of: reg,regfile,mem,addrmap,all"""
) )
arg_group.add_argument( arg_group.add_argument(
@@ -147,15 +149,16 @@ class Exporter(ExporterSubcommandPlugin):
"--err-if-bad-addr", "--err-if-bad-addr",
action="store_true", action="store_true",
default=False, default=False,
help="Generate CPUIF error response, when the address is decoded incorrectly" help="""Generate CPUIF error response if a transaction attempts to
access an address that does not map to anything."""
) )
arg_group.add_argument( arg_group.add_argument(
"--err-if-bad-rw", "--err-if-bad-rw",
action="store_true", action="store_true",
default=False, default=False,
help="""Generate CPUIF error response, when an illegal access is help="""Generate CPUIF error response if an illegal access is
performed to a read-only or write-only register""" performed to a read-only or write-only register."""
) )
def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> None: def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> None: