From df01650444dca89981e866ccc9985ff8b1246a21 Mon Sep 17 00:00:00 2001
From: Ethan Sifferman <ethan@sifferman.dev>
Date: Sun, 10 Mar 2024 20:45:01 -0700
Subject: [PATCH] Added `full_case` and `parallel_case` attributes (#274)

---
 CHANGELOG.md                           |  2 ++
 src/Convert/Unique.hs                  | 23 +++++++++++----
 test/core/case_violation_checks.sv     | 41 ++++++++++++++++++++++++++
 test/core/case_violation_checks.sv.pat |  3 ++
 test/core/case_violation_checks.v      | 41 ++++++++++++++++++++++++++
 test/core/case_violation_checks_tb.v   |  7 +++++
 6 files changed, 112 insertions(+), 5 deletions(-)
 create mode 100644 test/core/case_violation_checks.sv
 create mode 100644 test/core/case_violation_checks.sv.pat
 create mode 100644 test/core/case_violation_checks.v
 create mode 100644 test/core/case_violation_checks_tb.v

diff --git a/CHANGELOG.md b/CHANGELOG.md
index b6c777d..588f320 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,8 @@
 
 ### New Features
 
+* `unique`, `unique0`, and `priority` case statements now produce corresponding
+  `parallel_case` and `full_case` statement attributes
 * Added support for attributes in unary, binary, and ternary expressions
 * Added support for shadowing interface names with local typenames
 * Added support for streaming concatenations within ternary expressions
diff --git a/src/Convert/Unique.hs b/src/Convert/Unique.hs
index e39eceb..107631e 100644
--- a/src/Convert/Unique.hs
+++ b/src/Convert/Unique.hs
@@ -3,9 +3,9 @@
  -
  - Conversion for `unique`, `unique0`, and `priority` (verification checks)
  -
- - This conversion simply drops these keywords, as they are only used for
- - optimization and verification. There may be ways to communicate these
- - attributes to certain downstream toolchains.
+ - For `case`, these verification checks are replaced with equivalent
+ - `full_case` and `parallel_case` attributes. For `if`, they are simply
+ - dropped.
  -}
 
 module Convert.Unique (convert) where
@@ -21,6 +21,19 @@ convert =
 convertStmt :: Stmt -> Stmt
 convertStmt (If _ cc s1 s2) =
     If NoCheck cc s1 s2
-convertStmt (Case _ kw expr cases) =
-    Case NoCheck kw expr cases
+convertStmt (Case Priority kw expr cases) =
+    StmtAttr caseAttr caseStmt
+    where
+        caseAttr = Attr [("full_case", Nil)]
+        caseStmt = Case NoCheck kw expr cases
+convertStmt (Case Unique kw expr cases) =
+    StmtAttr caseAttr caseStmt
+    where
+        caseAttr = Attr [("full_case", Nil), ("parallel_case", Nil)]
+        caseStmt = Case NoCheck kw expr cases
+convertStmt (Case Unique0 kw expr cases) =
+    StmtAttr caseAttr caseStmt
+    where
+        caseAttr = Attr [("parallel_case", Nil)]
+        caseStmt = Case NoCheck kw expr cases
 convertStmt other = other
diff --git a/test/core/case_violation_checks.sv b/test/core/case_violation_checks.sv
new file mode 100644
index 0000000..8d5ba40
--- /dev/null
+++ b/test/core/case_violation_checks.sv
@@ -0,0 +1,41 @@
+module UniqueCase(
+    input logic [1:0] select,
+    output logic [3:0] data
+);
+    always_comb begin
+        data = 4'b0;
+        unique case (select)
+            2'd0: data = 4'ha;
+            2'd1: data = 4'h6;
+            2'd2: data = 4'h3;
+        endcase
+    end
+endmodule
+
+module Unique0Case(
+    input logic [1:0] select,
+    output logic [3:0] data
+);
+    always_comb begin
+        data = 4'b0;
+        unique0 case (select)
+            2'd0: data = 4'ha;
+            2'd1: data = 4'h6;
+            2'd2: data = 4'h3;
+        endcase
+    end
+endmodule
+
+module PriorityCase(
+    input logic [1:0] select,
+    output logic [3:0] data
+);
+    always_comb begin
+        data = 4'b0;
+        priority case (select)
+            2'd0: data = 4'ha;
+            2'd1: data = 4'h6;
+            2'd2: data = 4'h3;
+        endcase
+    end
+endmodule
diff --git a/test/core/case_violation_checks.sv.pat b/test/core/case_violation_checks.sv.pat
new file mode 100644
index 0000000..5d742e2
--- /dev/null
+++ b/test/core/case_violation_checks.sv.pat
@@ -0,0 +1,3 @@
+affirm (* full_case, parallel_case *)
+affirm (* parallel_case *)
+affirm (* full_case *)
diff --git a/test/core/case_violation_checks.v b/test/core/case_violation_checks.v
new file mode 100644
index 0000000..684faba
--- /dev/null
+++ b/test/core/case_violation_checks.v
@@ -0,0 +1,41 @@
+module UniqueCase(
+    input wire [1:0] select,
+    output reg [3:0] data
+);
+    always @* begin
+        data = 4'b0;
+        case (select)
+            2'd0: data = 4'ha;
+            2'd1: data = 4'h6;
+            2'd2: data = 4'h3;
+        endcase
+    end
+endmodule
+
+module Unique0Case(
+    input wire [1:0] select,
+    output reg [3:0] data
+);
+    always @* begin
+        data = 4'b0;
+        case (select)
+            2'd0: data = 4'ha;
+            2'd1: data = 4'h6;
+            2'd2: data = 4'h3;
+        endcase
+    end
+endmodule
+
+module PriorityCase(
+    input wire [1:0] select,
+    output reg [3:0] data
+);
+    always @* begin
+        data = 4'b0;
+        case (select)
+            2'd0: data = 4'ha;
+            2'd1: data = 4'h6;
+            2'd2: data = 4'h3;
+        endcase
+    end
+endmodule
diff --git a/test/core/case_violation_checks_tb.v b/test/core/case_violation_checks_tb.v
new file mode 100644
index 0000000..ca1bb86
--- /dev/null
+++ b/test/core/case_violation_checks_tb.v
@@ -0,0 +1,7 @@
+module top;
+    reg [1:0] select;
+    wire [3:0] data [2:0];
+    UniqueCase case0(select, data[0]);
+    Unique0Case case1(select, data[1]);
+    PriorityCase case2(select, data[2]);
+endmodule