Merge pull request pulp-platform#160 from pulp-platform/typedef-axi-lite

typedef.svh: Add `AXI_LITE_TYPEDEF_ALL`
zhguanw · Jan 30, 2021 · 0702f1e · 0702f1e
2 parents 4535693 + 2a7428d
commit 0702f1e
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,8 +8,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## Unreleased
 
 ### Added
-- `typedef.svh`: Add `AXI_TYPEDEF_ALL` macro for defining all channels and request/response
-  `struct`s in a single macro call.
+- `typedef.svh`: Add `AXI_TYPEDEF_ALL` and `AXI_LITE_TYPEDEF_ALL` macros for defining all channels
+  and request/response `struct`s of an AXI4+ATOPs and an AXI4-Lite interface, respectively, in a
+  single macro call.
 - `axi_test::axi_rand_slave`: Add parameter `RAND_RESP`, which enables randomization of the `resp`
   field in B and R beats.
 

diff --git a/include/axi/typedef.svh b/include/axi/typedef.svh
@@ -103,18 +103,18 @@
   } resp_t;
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////
-// AXI4+ATOP Define All Channels and Request/Response Structs
+// All AXI4+ATOP Channels and Request/Response Structs in One Macro
 //
-// This can be used whenever the user is not interested in "precise" control of
-// the naming of the individual channels.
+// This can be used whenever the user is not interested in "precise" control of the naming of the
+// individual channels.
 //
 // Usage Example:
 // `AXI_TYPEDEF_ALL(axi, addr_t, id_t, data_t, strb_t, user_t)
 //
-// This defines `axi_req_t` and `axi_resp_t` request/response structs as well as
-// `axi_aw_chan_t`, `axi_w_chan_t`, `axi_b_chan_t`, `axi_ar_chan_t`, and
-// `axi_r_chan_t` channel structs.
+// This defines `axi_req_t` and `axi_resp_t` request/response structs as well as `axi_aw_chan_t`,
+// `axi_w_chan_t`, `axi_b_chan_t`, `axi_ar_chan_t`, and `axi_r_chan_t` channel structs.
 `define AXI_TYPEDEF_ALL(__name, __addr_t, __id_t, __data_t, __strb_t, __user_t)                 \
   `AXI_TYPEDEF_AW_CHAN_T(__name``_aw_chan_t, __addr_t, __id_t, __user_t)                        \
   `AXI_TYPEDEF_W_CHAN_T(__name``_w_chan_t, __data_t, __strb_t, __user_t)                        \
@@ -123,9 +123,11 @@
   `AXI_TYPEDEF_R_CHAN_T(__name``_r_chan_t, __data_t, __id_t, __user_t)                          \
   `AXI_TYPEDEF_REQ_T(__name``_req_t, __name``_aw_chan_t, __name``_w_chan_t, __name``_ar_chan_t) \
   `AXI_TYPEDEF_RESP_T(__name``_resp_t, __name``_b_chan_t, __name``_r_chan_t)
+////////////////////////////////////////////////////////////////////////////////////////////////////
+
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
-// AXI-Lite (4+Prot) Channel and Request/Response Structs
+// AXI4-Lite Channel and Request/Response Structs
 //
 // Usage Example:
 // `AXI_LITE_TYPEDEF_AW_CHAN_T(axi_lite_aw_t, axi_lite_addr_t)
@@ -183,4 +185,27 @@
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 
 
+////////////////////////////////////////////////////////////////////////////////////////////////////
+// All AXI4-Lite Channels and Request/Response Structs in One Macro
+//
+// This can be used whenever the user is not interested in "precise" control of the naming of the
+// individual channels.
+//
+// Usage Example:
+// `AXI_LITE_TYPEDEF_ALL(axi_lite, addr_t, data_t, strb_t)
+//
+// This defines `axi_lite_req_t` and `axi_lite_resp_t` request/response structs as well as
+// `axi_lite_aw_chan_t`, `axi_lite_w_chan_t`, `axi_lite_b_chan_t`, `axi_lite_ar_chan_t`, and
+// `axi_lite_r_chan_t` channel structs.
+`define AXI_LITE_TYPEDEF_ALL(__name, __addr_t, __data_t, __strb_t)                                    \
+  `AXI_LITE_TYPEDEF_AW_CHAN_T(__name``_aw_chan_t, __addr_t)                                           \
+  `AXI_LITE_TYPEDEF_W_CHAN_T(__name``_w_chan_t, __data_t, __strb_t)                                   \
+  `AXI_LITE_TYPEDEF_B_CHAN_T(__name``_b_chan_t)                                                       \
+  `AXI_LITE_TYPEDEF_AR_CHAN_T(__name``_ar_chan_t, __addr_t)                                           \
+  `AXI_LITE_TYPEDEF_R_CHAN_T(__name``_r_chan_t, __data_t)                                             \
+  `AXI_LITE_TYPEDEF_REQ_T(__name``_req_t, __name``_aw_chan_t, __name``_w_chan_t, __name``_ar_chan_t)  \
+  `AXI_LITE_TYPEDEF_RESP_T(__name``_resp_t, __name``_b_chan_t, __name``_r_chan_t)
+////////////////////////////////////////////////////////////////////////////////////////////////////
+
+
 `endif