From b35b7b395a434c32b3c012843b90ee7221dabc79 Mon Sep 17 00:00:00 2001
From: Michael Platzer <michael.platzer@axelera.ai>
Date: Tue, 8 Oct 2024 12:12:35 +0000
Subject: [PATCH] assertions: Undefine lowRISC macros if their presence is
 detected

---
 include/common_cells/assertions.svh | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/include/common_cells/assertions.svh b/include/common_cells/assertions.svh
index 1428f97d..ed041fb4 100644
--- a/include/common_cells/assertions.svh
+++ b/include/common_cells/assertions.svh
@@ -39,6 +39,34 @@
 `endif
 `endif
 
+// detect and resolve potential collision with lowRISC's prim_assert macros by undefining all of
+// their macros (the variants in here should be backwards compatible with lowRISC's macros)
+`ifdef PRIM_ASSERT_SV
+  `ifdef INC_ASSERT
+    `undef ASSERT_I
+    `undef ASSERT_INIT
+    `undef ASSERT_FINAL
+    `undef ASSERT
+    `undef ASSERT_NEVER
+    `undef ASSERT_KNOWN
+    `undef COVER
+    `undef ASSERT_PULSE
+    `undef ASSERT_IF
+    `ifndef FPV_ON
+      `undef ASSERT_KNOWN_IF
+    `endif
+    `undef ASSUME
+    `undef ASSUME_I
+  `endif
+  `ifdef FPV_ON
+    `undef ASSUME_FPV
+    `undef ASSUME_I_FPV
+    `undef COVER_FPV
+  `endif
+`endif
+// define PRIM_ASSERT_SV to anticipate a later inclusion of lowRISC's prim_assert macros
+`define PRIM_ASSERT_SV
+
 // Converts an arbitrary block of code into a Verilog string
 `define ASSERT_STRINGIFY(__x) `"__x`"