Closes #11: Add flag to turn off error-response on illegal addresses

README.md

@@ -122,8 +122,8 @@ The following bus protocols are planned at this point:
 # Help function
 A comprehensive help function of the tool can be invoked by running `srdl2sv --help`.
 ```
-usage: srdl2sv [-h] [-a ADDRESS_WIDTH] [-b {simple,amba3ahblite}] [-c DESCRIPTIONS]
+sage: srdl2sv [-h] [-a ADDRESS_WIDTH] [-b {simple,amba3ahblite}] [-d DESCRIPTIONS]
-               [-d SEARCH_PATHS [SEARCH_PATHS ...]] [-e]
+               [-s SEARCH_PATHS [SEARCH_PATHS ...]] [--no-enums] [--no-address-errors] [--no-unpacked]
                [--file-logging {DEBUG,INFO,WARNING,ERROR,CRITICAL,NONE}]
                [--stdout-logging {DEBUG,INFO,WARNING,ERROR,CRITICAL,NONE}] [--no-byte-enable]
                [-o OUT_DIR] [-r] [--real-tabs] [--tab-width TAB_WIDTH]
@@ -143,13 +143,15 @@ optional arguments:
                         Set the bus protocol that shall be used by software to communicate with the
                         registers. If just a simple interface to the registers is needed, use the
                         'simple' protocol. (default: amba3ahblite)
-  -c DESCRIPTIONS, --descriptions DESCRIPTIONS
+  -d DESCRIPTIONS, --descriptions DESCRIPTIONS
                         Include descriptions of addrmaps (+16), regfiles (+8), memories (+4) registers
                         (+2), and fields (+1) in RTL. This is a bitfield.
-  -d SEARCH_PATHS [SEARCH_PATHS ...], --search-paths SEARCH_PATHS [SEARCH_PATHS ...]
+  -s SEARCH_PATHS [SEARCH_PATHS ...], --search-paths SEARCH_PATHS [SEARCH_PATHS ...]
                         Point to one (or more) directories that will be searched for RDL files.
-  -e, --no-enums        Disable enumeration generation. This will prevent the compiler from generating
+  --no-enums            Disable enumeration generation. This will prevent the compiler from generating
                         packages and it will prevent it from using enums in the port list.
+  --no-address-errors   Disable an error response when illegal addresses are accessed.
+  --no-unpacked         Disable unpacked arrays in the module's I/O interface.
   --file-logging {DEBUG,INFO,WARNING,ERROR,CRITICAL,NONE}
                         Set verbosity level of output to log-file. When set to 'NONE', nothing will be
                         printed to the shell. (default: NONE)

srdl2sv/cli/cli.py

@@ -41,7 +41,7 @@ class CliArguments():
                   (default: %(default)s)")
 
         self.parser.add_argument(
-            "-c",
+            "-d",
             "--descriptions",
             type=int,
             default=0,
@@ -49,7 +49,7 @@ class CliArguments():
                   registers (+2), and fields (+1) in RTL. This is a bitfield.")
 
         self.parser.add_argument(
-            "-d",
+            "-s",
             "--search-paths",
             type=str,
             nargs="+",
@@ -57,7 +57,6 @@ class CliArguments():
                   be searched for RDL files.")
 
         self.parser.add_argument(
-            "-e",
             "--no-enums",
             action="store_true",
             help="Disable enumeration generation. This will prevent the\
@@ -65,7 +64,12 @@ class CliArguments():
                   it from using enums in the port list.")
 
         self.parser.add_argument(
-            "-u",
+            "--no-address-errors",
+            action="store_true",
+            help="Disable an error response when illegal addresses are \
+                  accessed.")
+
+        self.parser.add_argument(
             "--no-unpacked",
             action="store_true",
             help="Disable unpacked arrays in the module's I/O interface.")
@@ -177,6 +181,10 @@ class CliArguments():
         config['enums'] = not args.no_enums
         config['list_args'].append(f"Enums Enabled    : {config['enums']}")
 
+        # Set enums
+        config['illegal_addresses'] = not args.no_address_errors
+        config['list_args'].append(f"Address Errors   : {config['illegal_addresses']}")
+
         # Set unpacked arrays
         config['unpacked_arrays'] = not args.no_unpacked
         config['list_args'].append(f"Unpacked I/Os    : {config['enums']}")

srdl2sv/components/register.py

@@ -215,6 +215,7 @@ class Register(Component):
             # an error.
             #
             # Furthermore, consider an error indication that is set for external registers
+            if self.config['illegal_addresses']:
                 wdgt_str = 'widget_if.byte_en'
 
                 bytes_read_format = []
@@ -294,6 +295,8 @@ class Register(Component):
                             )
 
                 sw_err_condition = ' || '.join(sw_err_condition_vec)
+            else:
+                sw_err_condition = "1'b0"
 
             # If registers are implemented in RTL, they will be ready immediately. However,
             # if they are defined as 'external', there might be some delay