Skip to content

Commit

Permalink
Add ACE include and src files
Browse files Browse the repository at this point in the history 
* Provide TYPEDEF and ASSIGN macros
* Proivde ACE_BUS and SNOOP_BUS
  • Loading branch information
@ricted98
ricted98 committed Dec 2, 2024
1 parent e1edaf5 commit 548d297
Show file tree
Hide file tree
Showing 8 changed files with 1,335 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Bender.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,11 @@ sources:
# levels 1 and 0, etc. Files within a level are ordered alphabetically.
# Level 0
- src/axi_pkg.sv
- src/ace/ace_pkg.sv
# Level 1
- src/axi_intf.sv
- src/ace/ace_intf.sv
- src/ace/snoop_intf.sv
# Level 2
- src/axi_atop_filter.sv
- src/axi_burst_splitter.sv
Expand Down
510 changes: 510 additions & 0 deletions include/ace/assign.svh
View file

Large diffs are not rendered by default.

104 changes: 104 additions & 0 deletions include/ace/convert.svh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
`include "axi/assign.svh"

`ifndef ACE_CONVERT_SVH_
`define ACE_CONVERT_SVH_

`define __ACE_TO_AXI_R(__opt_as, __lhs, __lhs_sep, __rhs, __rhs_sep) \
__opt_as __lhs``__lhs_sep``id = __rhs``__rhs_sep``id; \
__opt_as __lhs``__lhs_sep``data = __rhs``__rhs_sep``data; \
__opt_as __lhs``__lhs_sep``resp = __rhs``__rhs_sep``resp[1:0]; \
__opt_as __lhs``__lhs_sep``last = __rhs``__rhs_sep``last; \
__opt_as __lhs``__lhs_sep``user = __rhs``__rhs_sep``user;
`define __AXI_TO_ACE_AW(__opt_as, __lhs, __lhs_sep, __rhs, __rhs_sep) \
__opt_as __lhs``__lhs_sep``id = __rhs``__rhs_sep``id; \
__opt_as __lhs``__lhs_sep``addr = __rhs``__rhs_sep``addr; \
__opt_as __lhs``__lhs_sep``len = __rhs``__rhs_sep``len; \
__opt_as __lhs``__lhs_sep``size = __rhs``__rhs_sep``size; \
__opt_as __lhs``__lhs_sep``burst = __rhs``__rhs_sep``burst; \
__opt_as __lhs``__lhs_sep``lock = __rhs``__rhs_sep``lock; \
__opt_as __lhs``__lhs_sep``cache = __rhs``__rhs_sep``cache; \
__opt_as __lhs``__lhs_sep``prot = __rhs``__rhs_sep``prot; \
__opt_as __lhs``__lhs_sep``qos = __rhs``__rhs_sep``qos; \
__opt_as __lhs``__lhs_sep``region = __rhs``__rhs_sep``region; \
__opt_as __lhs``__lhs_sep``atop = __rhs``__rhs_sep``atop; \
__opt_as __lhs``__lhs_sep``user = __rhs``__rhs_sep``user; \
__opt_as __lhs``__lhs_sep``snoop = '0; \
__opt_as __lhs``__lhs_sep``bar = '0; \
__opt_as __lhs``__lhs_sep``domain = '0; \
__opt_as __lhs``__lhs_sep``awunique = '0;
`define __AXI_TO_ACE_AR(__opt_as, __lhs, __lhs_sep, __rhs, __rhs_sep) \
__opt_as __lhs``__lhs_sep``id = __rhs``__rhs_sep``id; \
__opt_as __lhs``__lhs_sep``addr = __rhs``__rhs_sep``addr; \
__opt_as __lhs``__lhs_sep``len = __rhs``__rhs_sep``len; \
__opt_as __lhs``__lhs_sep``size = __rhs``__rhs_sep``size; \
__opt_as __lhs``__lhs_sep``burst = __rhs``__rhs_sep``burst; \
__opt_as __lhs``__lhs_sep``lock = __rhs``__rhs_sep``lock; \
__opt_as __lhs``__lhs_sep``cache = __rhs``__rhs_sep``cache; \
__opt_as __lhs``__lhs_sep``prot = __rhs``__rhs_sep``prot; \
__opt_as __lhs``__lhs_sep``qos = __rhs``__rhs_sep``qos; \
__opt_as __lhs``__lhs_sep``region = __rhs``__rhs_sep``region; \
__opt_as __lhs``__lhs_sep``user = __rhs``__rhs_sep``user; \
__opt_as __lhs``__lhs_sep``snoop = '0; \
__opt_as __lhs``__lhs_sep``bar = '0; \
__opt_as __lhs``__lhs_sep``domain = '0;
`define __AXI_TO_ACE_R(__opt_as, __lhs, __lhs_sep, __rhs, __rhs_sep) \
__opt_as __lhs``__lhs_sep``id = __rhs``__rhs_sep``id; \
__opt_as __lhs``__lhs_sep``data = __rhs``__rhs_sep``data; \
__opt_as __lhs``__lhs_sep``resp = {2'b00, __rhs``__rhs_sep``resp}; \
__opt_as __lhs``__lhs_sep``last = __rhs``__rhs_sep``last; \
__opt_as __lhs``__lhs_sep``user = __rhs``__rhs_sep``user;

`define ACE_TO_AXI_ASSIGN_R_STRUCT(dst, src) \
`__ACE_TO_AXI_R(assign, dst, ., src, .)

`define AXI_TO_ACE_ASSIGN_AW_STRUCT(dst, src) \
`__AXI_TO_ACE_AW(assign, dst, ., src, .)

`define AXI_TO_ACE_ASSIGN_AR_STRUCT(dst, src) \
`__AXI_TO_ACE_AR(assign, dst, ., src, .)

`define AXI_TO_ACE_ASSIGN_R_STRUCT(dst, src) \
`__AXI_TO_ACE_R(assign, dst, ., src, .)


`define ACE_TO_AXI_ASSIGN_REQ(dst, src) \
`AXI_ASSIGN_AW_STRUCT(dst.aw, src.aw) \
`AXI_ASSIGN_AR_STRUCT(dst.ar, src.ar) \
`AXI_ASSIGN_W_STRUCT(dst.w, src.w) \
assign dst.aw_valid = src.aw_valid; \
assign dst.ar_valid = src.ar_valid; \
assign dst.w_valid = src.w_valid; \
assign dst.b_ready = src.b_ready; \
assign dst.r_ready = src.r_ready;

`define ACE_TO_AXI_ASSIGN_RESP(dst, src) \
`ACE_TO_AXI_ASSIGN_R_STRUCT(dst.r, src.r) \
`AXI_ASSIGN_B_STRUCT(dst.b, src.b) \
assign dst.aw_ready = src.aw_ready; \
assign dst.ar_ready = src.ar_ready; \
assign dst.w_ready = src.w_ready; \
assign dst.b_valid = src.b_valid; \
assign dst.r_valid = src.r_valid;

`define AXI_TO_ACE_ASSIGN_REQ(dst, src) \
`AXI_TO_ACE_ASSIGN_AW_STRUCT(dst.aw, src.aw) \
`AXI_TO_ACE_ASSIGN_AR_STRUCT(dst.ar, src.ar) \
`AXI_ASSIGN_W_STRUCT(dst.w, src.w) \
assign dst.aw_valid = src.aw_valid; \
assign dst.ar_valid = src.ar_valid; \
assign dst.w_valid = src.w_valid; \
assign dst.b_ready = src.b_ready; \
assign dst.r_ready = src.r_ready;


`define AXI_TO_ACE_ASSIGN_RESP(dst, src) \
`AXI_TO_ACE_ASSIGN_R_STRUCT(dst.r, src.r) \
`AXI_ASSIGN_B_STRUCT(dst.b, src.b) \
assign dst.aw_ready = src.aw_ready; \
assign dst.ar_ready = src.ar_ready; \
assign dst.w_ready = src.w_ready; \
assign dst.b_valid = src.b_valid; \
assign dst.r_valid = src.r_valid;


`endif // ACE_CONVERT_SVH_
28 changes: 28 additions & 0 deletions include/ace/domain.svh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
`ifndef ACE_DOMAIN_SVH_
`define ACE_DOMAIN_SVH_

//////////////////
// Domain types //
//////////////////

`define DOMAIN_MASK_T(width)\
logic [width-1:0]
`define DOMAIN_SET_T \
struct packed { \
domain_mask_t initiator; \
domain_mask_t inner; \
domain_mask_t outer; \
}
`define DOMAIN_TYPEDEF_MASK_T(width) \
typedef logic [width-1:0] domain_mask_t;
`define DOMAIN_TYPEDEF_SET_T \
typedef struct packed { \
domain_mask_t initiator; \
domain_mask_t inner; \
domain_mask_t outer; \
} domain_set_t;
`define DOMAIN_TYPEDEF_ALL(width) \
`DOMAIN_TYPEDEF_MASK_T(width) \
`DOMAIN_TYPEDEF_SET_T

`endif // ACE_DOMAIN_SVH_
167 changes: 167 additions & 0 deletions include/ace/typedef.svh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
// Copyright (c) 2019 ETH Zurich, University of Bologna
// Copyright (c) 2022 PlanV GmbH
//
// Copyright and related rights are licensed under the Solderpad Hardware
// License, Version 0.51 (the "License"); you may not use this file except in
// compliance with the License. You may obtain a copy of the License at
// http://solderpad.org/licenses/SHL-0.51. Unless required by applicable law
// or agreed to in writing, software, hardware and materials distributed under
// this License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
// CONDITIONS OF ANY KIND, either express or implied. See the License for the
// specific language governing permissions and limitations under the License.
//

// Macros to define ACE Channel and Request/Response Structs

`ifndef ACE_TYPEDEF_SVH_
`define ACE_TYPEDEF_SVH_

`include "axi/typedef.svh"

////////////////////////////////////////////////////////////////////////////////////////////////////
// AXI4+ATOP Channel and Request/Response Structs (with snoop support)
//
// Usage Example:
// `ACE_TYPEDEF_AW_CHAN_T(axi_aw_t, axi_addr_t, axi_id_t, axi_user_t)
// `ACE_TYPEDEF_AR_CHAN_T(axi_ar_t, axi_addr_t, axi_id_t, axi_user_t)
// `ACE_TYPEDEF_R_CHAN_T(axi_r_t, axi_data_t, axi_id_t, axi_user_t)
// `ACE_TYPEDEF_REQ_T(axi_req_t, axi_aw_t, axi_w_t, axi_ar_t)
// `ACE_TYPEDEF_RESP_T(axi_resp_t, axi_b_t, axi_r_t)
`define ACE_TYPEDEF_AW_CHAN_T(aw_chan_t, addr_t, id_t, user_t) \
typedef struct packed { \
id_t id; \
addr_t addr; \
axi_pkg::len_t len; \
axi_pkg::size_t size; \
axi_pkg::burst_t burst; \
logic lock; \
axi_pkg::cache_t cache; \
axi_pkg::prot_t prot; \
axi_pkg::qos_t qos; \
axi_pkg::region_t region; \
axi_pkg::atop_t atop; \
user_t user; \
ace_pkg::awsnoop_t snoop; \
ace_pkg::axbar_t bar; \
ace_pkg::axdomain_t domain; \
ace_pkg::awunique_t awunique; \
} aw_chan_t;
`define ACE_TYPEDEF_AR_CHAN_T(ar_chan_t, addr_t, id_t, user_t) \
typedef struct packed { \
id_t id; \
addr_t addr; \
axi_pkg::len_t len; \
axi_pkg::size_t size; \
axi_pkg::burst_t burst; \
logic lock; \
axi_pkg::cache_t cache; \
axi_pkg::prot_t prot; \
axi_pkg::qos_t qos; \
axi_pkg::region_t region; \
user_t user; \
ace_pkg::arsnoop_t snoop; \
ace_pkg::axbar_t bar; \
ace_pkg::axdomain_t domain; \
} ar_chan_t;
`define ACE_TYPEDEF_R_CHAN_T(r_chan_t, data_t, id_t, user_t) \
typedef struct packed { \
id_t id; \
data_t data; \
ace_pkg::rresp_t resp; \
logic last; \
user_t user; \
} r_chan_t;
`define ACE_TYPEDEF_REQ_T(req_t, aw_chan_t, w_chan_t, ar_chan_t) \
typedef struct packed { \
aw_chan_t aw; \
logic aw_valid; \
w_chan_t w; \
logic w_valid; \
logic b_ready; \
ar_chan_t ar; \
logic ar_valid; \
logic r_ready; \
logic wack; \
logic rack; \
} req_t;
`define ACE_TYPEDEF_RESP_T(resp_t, b_chan_t, r_chan_t) \
typedef struct packed { \
logic aw_ready; \
logic ar_ready; \
logic w_ready; \
logic b_valid; \
b_chan_t b; \
logic r_valid; \
r_chan_t r; \
} resp_t;
////////////////////////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////////////////////////
// All AXI4+ATOP Channels and Request/Response Structs in One Macro (with snoop support)
//
// 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.
`define ACE_TYPEDEF_ALL(__name, __addr_t, __id_t, __data_t, __strb_t, __user_t) \
`ACE_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) \
`AXI_TYPEDEF_B_CHAN_T(__name``_b_chan_t, __id_t, __user_t) \
`ACE_TYPEDEF_AR_CHAN_T(__name``_ar_chan_t, __addr_t, __id_t, __user_t) \
`ACE_TYPEDEF_R_CHAN_T(__name``_r_chan_t, __data_t, __id_t, __user_t) \
`ACE_TYPEDEF_REQ_T(__name``_req_t, __name``_aw_chan_t, __name``_w_chan_t, __name``_ar_chan_t) \
`ACE_TYPEDEF_RESP_T(__name``_resp_t, __name``_b_chan_t, __name``_r_chan_t)
////////////////////////////////////////////////////////////////////////////////////////////////////
// Usage Example:
// `SNOOP_TYPEDEF_AC_CHAN_T(snoop_ac_t, snoop_addr_t)
// 'SNOOP_TYPEDEF_CD_CHAN_T(snoop_cd_t, snoop_data_t)
// `SNOOP_TYPEDEF_REQ_T(snoop_req_t, snoop_ac_t)
// `SNOOP_TYPEDEF_RESP_T(snoop_resp_t, snoop_cd_t, snoop_cr_t)
`define SNOOP_TYPEDEF_AC_CHAN_T(ac_chan_t, addr_t) \
typedef struct packed { \
addr_t addr; \
ace_pkg::acsnoop_t snoop; \
ace_pkg::acprot_t prot; \
} ac_chan_t;
`define SNOOP_TYPEDEF_CD_CHAN_T(cd_chan_t, data_t) \
typedef struct packed { \
data_t data; \
logic last; \
} cd_chan_t;
`define SNOOP_TYPEDEF_CR_CHAN_T(cr_chan_t) \
typedef ace_pkg::crresp_t cr_chan_t;
`define SNOOP_TYPEDEF_REQ_T(req_t, ac_chan_t) \
typedef struct packed { \
logic ac_valid; \
logic cd_ready; \
ac_chan_t ac; \
logic cr_ready; \
} req_t;
`define SNOOP_TYPEDEF_RESP_T(resp_t, cd_chan_t, cr_chan_t) \
typedef struct packed { \
logic ac_ready; \
logic cd_valid; \
cd_chan_t cd; \
logic cr_valid; \
cr_chan_t cr_resp; \
} resp_t;
////////////////////////////////////////////////////////////////////////////////////////////////////

// Usage Example:
// `SNOOP_TYPEDEF_ALL(snoop, addr_t, data_t)
//
// This defines `snoop_req_t` and `snoop_resp_t` request/response structs as well as `snoop_ac_chan_t`,
// `snoop_cd_chan_t` and `snoop_cr_chan_t` channel structs.
`define SNOOP_TYPEDEF_ALL(__name, __addr_t, __data_t) \
`SNOOP_TYPEDEF_AC_CHAN_T(__name``_aw_chan_t, __addr_t) \
`SNOOP_TYPEDEF_CR_CHAN_T(__name``_cr_chan_t) \
`SNOOP_TYPEDEF_CD_CHAN_T(__name``_cd_chan_t, __data_t) \
`SNOOP_TYPEDEF_REQ_T(__name``_req_t, __name``_ac_chan_t) \
`SNOOP_TYPEDEF_RESP_T(__name``_resp_t, __name``_cd_chan_t, __name``_cr_chan_t)
////////////////////////////////////////////////////////////////////////////////////////////////////

`endif
Loading

0 comments on commit 548d297

Please sign in to comment.