From fcf4bffeb70b448748d1795dad1aca4a7d94ef96 Mon Sep 17 00:00:00 2001 From: Alex Mykyta Date: Tue, 4 Nov 2025 21:28:51 -0800 Subject: [PATCH] add missing docs --- docs/configuring.rst | 10 ++++++++++ src/peakrdl_regblock/__peakrdl__.py | 13 ++++++++----- 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/configuring.rst b/docs/configuring.rst index 6be6f63..a61d168 100644 --- a/docs/configuring.rst +++ b/docs/configuring.rst @@ -43,3 +43,13 @@ All regblock-specific options are defined under the ``[regblock]`` TOML heading. [regblock] 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. diff --git a/src/peakrdl_regblock/__peakrdl__.py b/src/peakrdl_regblock/__peakrdl__.py index e1c2987..6ecef93 100644 --- a/src/peakrdl_regblock/__peakrdl__.py +++ b/src/peakrdl_regblock/__peakrdl__.py @@ -121,7 +121,8 @@ class Exporter(ExporterSubcommandPlugin): "--rt-read-fanin", action="store_true", 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( "--rt-read-response", @@ -131,7 +132,8 @@ class Exporter(ExporterSubcommandPlugin): ) arg_group.add_argument( "--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( @@ -147,15 +149,16 @@ class Exporter(ExporterSubcommandPlugin): "--err-if-bad-addr", action="store_true", 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( "--err-if-bad-rw", action="store_true", default=False, - help="""Generate CPUIF error response, when an illegal access is - performed to a read-only or write-only register""" + help="""Generate CPUIF error response if an illegal access is + performed to a read-only or write-only register.""" ) def do_export(self, top_node: 'AddrmapNode', options: 'argparse.Namespace') -> None: