[rdlgenerator] Add none member to bitmask enums

Signed-off-by: Douglas Reis <doreis@lowrisc.org>

Author: engdoreis

sw/device/lib/hal/autogen/clkmgr.h

@@ -9,6 +9,7 @@
 #include <stdint.h>
 
 typedef enum [[clang::flag_enum]] clkmgr_alert_test : uint32_t {
+    clkmgr_alert_test_none = 0,
     clkmgr_alert_test_recov_fault = (1u << 0),
     clkmgr_alert_test_fatal_fault = (1u << 1),
 } clkmgr_alert_test;
@@ -66,6 +67,7 @@ typedef struct [[gnu::aligned(4)]] {
 } clkmgr_main_meas_ctrl_shadowed;
 
 typedef enum [[clang::flag_enum]] clkmgr_recov_err_code : uint32_t {
+    clkmgr_recov_err_code_none = 0,
     clkmgr_recov_err_code_shadow_update_err = (1u << 0),
     clkmgr_recov_err_code_io_measure_err = (1u << 1),
     clkmgr_recov_err_code_main_measure_err = (1u << 2),
@@ -74,6 +76,7 @@ typedef enum [[clang::flag_enum]] clkmgr_recov_err_code : uint32_t {
 } clkmgr_recov_err_code;
 
 typedef enum [[clang::flag_enum]] clkmgr_fatal_err_code : uint32_t {
+    clkmgr_fatal_err_code_none = 0,
     clkmgr_fatal_err_code_reg_intg = (1u << 0),
     clkmgr_fatal_err_code_idle_cnt = (1u << 1),
     clkmgr_fatal_err_code_shadow_storage_err = (1u << 2),

sw/device/lib/hal/autogen/entropy_src.h

@@ -9,13 +9,15 @@
 #include <stdint.h>
 
 typedef enum [[clang::flag_enum]] entropy_src_intr : uint32_t {
+    entropy_src_intr_none = 0,
     entropy_src_intr_es_entropy_valid = (1u << 0),
     entropy_src_intr_es_health_test_failed = (1u << 1),
     entropy_src_intr_es_observe_fifo_ready = (1u << 2),
     entropy_src_intr_es_fatal_err = (1u << 3),
 } entropy_src_intr;
 
 typedef enum [[clang::flag_enum]] entropy_src_alert_test : uint32_t {
+    entropy_src_alert_test_none = 0,
     entropy_src_alert_test_recov_alert = (1u << 0),
     entropy_src_alert_test_fatal_alert = (1u << 1),
 } entropy_src_alert_test;

sw/device/lib/hal/autogen/i2c.h

@@ -9,6 +9,7 @@
 #include <stdint.h>
 
 typedef enum [[clang::flag_enum]] i2c_intr : uint32_t {
+    i2c_intr_none = 0,
     i2c_intr_fmt_threshold = (1u << 0),
     i2c_intr_rx_threshold = (1u << 1),
     i2c_intr_acq_threshold = (1u << 2),
@@ -32,6 +33,7 @@ typedef struct [[gnu::aligned(4)]] {
 } i2c_alert_test;
 
 typedef enum [[clang::flag_enum]] i2c_ctrl : uint32_t {
+    i2c_ctrl_none = 0,
     i2c_ctrl_enablehost = (1u << 0),
     i2c_ctrl_enabletarget = (1u << 1),
     i2c_ctrl_llpbk = (1u << 2),
@@ -42,6 +44,7 @@ typedef enum [[clang::flag_enum]] i2c_ctrl : uint32_t {
 } i2c_ctrl;
 
 typedef enum [[clang::flag_enum]] i2c_status : uint32_t {
+    i2c_status_none = 0,
     i2c_status_fmtfull = (1u << 0),
     i2c_status_rxfull = (1u << 1),
     i2c_status_fmtempty = (1u << 2),
@@ -108,6 +111,7 @@ typedef struct [[gnu::aligned(4)]] {
 } i2c_target_fifo_status;
 
 typedef enum [[clang::flag_enum]] i2c_ovrd : uint32_t {
+    i2c_ovrd_none = 0,
     i2c_ovrd_txovrden = (1u << 0),
     i2c_ovrd_sclval = (1u << 1),
     i2c_ovrd_sdaval = (1u << 2),
@@ -210,13 +214,15 @@ typedef struct [[gnu::aligned(4)]] {
 } i2c_acq_fifo_next_data;
 
 typedef enum [[clang::flag_enum]] i2c_controller_events : uint32_t {
+    i2c_controller_events_none = 0,
     i2c_controller_events_nack = (1u << 0),
     i2c_controller_events_unhandled_nack_timeout = (1u << 1),
     i2c_controller_events_bus_timeout = (1u << 2),
     i2c_controller_events_arbitration_lost = (1u << 3),
 } i2c_controller_events;
 
 typedef enum [[clang::flag_enum]] i2c_target_events : uint32_t {
+    i2c_target_events_none = 0,
     i2c_target_events_tx_pending = (1u << 0),
     i2c_target_events_bus_timeout = (1u << 1),
     i2c_target_events_arbitration_lost = (1u << 2),

sw/device/lib/hal/autogen/kmac.h

@@ -9,12 +9,14 @@
 #include <stdint.h>
 
 typedef enum [[clang::flag_enum]] kmac_intr : uint32_t {
+    kmac_intr_none = 0,
     kmac_intr_kmac_done = (1u << 0),
     kmac_intr_fifo_empty = (1u << 1),
     kmac_intr_kmac_err = (1u << 2),
 } kmac_intr;
 
 typedef enum [[clang::flag_enum]] kmac_alert_test : uint32_t {
+    kmac_alert_test_none = 0,
     kmac_alert_test_recov_operation_err = (1u << 0),
     kmac_alert_test_fatal_fault_err = (1u << 1),
 } kmac_alert_test;

sw/device/lib/hal/autogen/rom_ctrl.h

@@ -14,6 +14,7 @@ typedef struct [[gnu::aligned(4)]] {
 } rom_ctrl_alert_test;
 
 typedef enum [[clang::flag_enum]] rom_ctrl_fatal_alert_cause : uint32_t {
+    rom_ctrl_fatal_alert_cause_none = 0,
     rom_ctrl_fatal_alert_cause_checker_error = (1u << 0),
     rom_ctrl_fatal_alert_cause_integrity_error = (1u << 1),
 } rom_ctrl_fatal_alert_cause;

sw/device/lib/hal/autogen/rstmgr.h

@@ -9,6 +9,7 @@
 #include <stdint.h>
 
 typedef enum [[clang::flag_enum]] rstmgr_alert_test : uint32_t {
+    rstmgr_alert_test_none = 0,
     rstmgr_alert_test_fatal_fault = (1u << 0),
     rstmgr_alert_test_fatal_cnsty_fault = (1u << 1),
 } rstmgr_alert_test;
@@ -71,6 +72,7 @@ typedef struct [[gnu::aligned(4)]] {
 } rstmgr_sw_rst_ctrl_n;
 
 typedef enum [[clang::flag_enum]] rstmgr_err_code : uint32_t {
+    rstmgr_err_code_none = 0,
     rstmgr_err_code_reg_intg_err = (1u << 0),
     rstmgr_err_code_reset_consistency_err = (1u << 1),
     rstmgr_err_code_fsm_err = (1u << 2),

sw/device/lib/hal/autogen/spi_device.h

@@ -9,6 +9,7 @@
 #include <stdint.h>
 
 typedef enum [[clang::flag_enum]] spi_device_intr : uint32_t {
+    spi_device_intr_none = 0,
     spi_device_intr_upload_cmdfifo_not_empty = (1u << 0),
     spi_device_intr_upload_payload_not_empty = (1u << 1),
     spi_device_intr_upload_payload_overflow = (1u << 2),
@@ -49,6 +50,7 @@ typedef struct [[gnu::aligned(4)]] {
 } spi_device_status;
 
 typedef enum [[clang::flag_enum]] spi_device_intercept_en : uint32_t {
+    spi_device_intercept_en_none = 0,
     spi_device_intercept_en_status = (1u << 0),
     spi_device_intercept_en_jedec = (1u << 1),
     spi_device_intercept_en_sfdp = (1u << 2),
@@ -163,6 +165,7 @@ typedef struct [[gnu::aligned(4)]] {
 } spi_device_tpm_cap;
 
 typedef enum [[clang::flag_enum]] spi_device_tpm_cfg : uint32_t {
+    spi_device_tpm_cfg_none = 0,
     spi_device_tpm_cfg_en = (1u << 0),
     spi_device_tpm_cfg_tpm_mode = (1u << 1),
     spi_device_tpm_cfg_hw_reg_dis = (1u << 2),
@@ -171,6 +174,7 @@ typedef enum [[clang::flag_enum]] spi_device_tpm_cfg : uint32_t {
 } spi_device_tpm_cfg;
 
 typedef enum [[clang::flag_enum]] spi_device_tpm_status : uint32_t {
+    spi_device_tpm_status_none = 0,
     spi_device_tpm_status_cmdaddr_notempty = (1u << 0),
     spi_device_tpm_status_wrfifo_pending = (1u << 1),
     spi_device_tpm_status_rdfifo_aborted = (1u << 2),

sw/device/lib/hal/autogen/uart.h

@@ -9,6 +9,7 @@
 #include <stdint.h>
 
 typedef enum [[clang::flag_enum]] uart_intr : uint32_t {
+    uart_intr_none = 0,
     uart_intr_tx_watermark = (1u << 0),
     uart_intr_rx_watermark = (1u << 1),
     uart_intr_tx_done = (1u << 2),
@@ -40,6 +41,7 @@ typedef struct [[gnu::aligned(4)]] {
 } uart_ctrl;
 
 typedef enum [[clang::flag_enum]] uart_status : uint32_t {
+    uart_status_none = 0,
     uart_status_txfull = (1u << 0),
     uart_status_rxfull = (1u << 1),
     uart_status_txempty = (1u << 2),
@@ -74,6 +76,7 @@ typedef struct [[gnu::aligned(4)]] {
 } uart_fifo_status;
 
 typedef enum [[clang::flag_enum]] uart_ovrd : uint32_t {
+    uart_ovrd_none = 0,
     uart_ovrd_txen = (1u << 0),
     uart_ovrd_txval = (1u << 1),
 } uart_ovrd;

util/rdlgenerator.py

@@ -269,7 +269,7 @@ def emit_register_flag_enum(device_name: str, reg: dict) -> str:
     """
     reg_name = reg["name"].lower()
     fully_qualified_type_name = "_".join([device_name, reg_name])
-    enum_variants = []
+    enum_variants = [f"{fully_qualified_type_name}_none = 0,"]
     for bit, field in enumerate(fields_ascending_by_lsb(reg)):
         field_name = field["name"].lower()
         fully_qualified_field_name = "_".join([device_name, reg_name, field_name])
@@ -288,7 +288,7 @@ def emit_common_device_register_declaration(
 ) -> tuple[str, str]:
     common_name = stripped_longest_common_prefix([x["name"] for x in register_set])
     fully_qualified_type_name = "_".join([device_name, common_name])
-    enum_variants = []
+    enum_variants = [f"{fully_qualified_type_name}_none = 0,"]
     for bit, field in enumerate(fields_ascending_by_lsb(register_set[0])):
         field_name = field["name"].lower()
         fully_qualified_field_name = "_".join([device_name, common_name, field_name])