Skip to content

Split struct and type definition to allow parameterized types #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Split struct and type definition to allow parameterized types #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b03ab6e
Split struct and type definition to allow parameterized types
yanicasa Aug 21, 2024
db0af00
fix to be squashed
yanicasa Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 111 additions & 83 deletions include/obi/typedef.svh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,109 +7,137 @@
`ifndef OBI_TYPEDEF_SVH
`define OBI_TYPEDEF_SVH

`define OBI_A_CHAN_T(ADDR_WIDTH, DATA_WIDTH, ID_WIDTH, a_optional_t) \
struct packed { \
logic [ ADDR_WIDTH-1:0] addr; \
logic we; \
logic [DATA_WIDTH/8-1:0] be; \
logic [ DATA_WIDTH-1:0] wdata; \
logic [ ID_WIDTH-1:0] aid; \
a_optional_t a_optional; \
}
`define OBI_TYPEDEF_A_CHAN_T(a_chan_t, ADDR_WIDTH, DATA_WIDTH, ID_WIDTH, a_optional_t) \
typedef struct packed { \
logic [ ADDR_WIDTH-1:0] addr; \
logic we; \
logic [DATA_WIDTH/8-1:0] be; \
logic [ DATA_WIDTH-1:0] wdata; \
logic [ ID_WIDTH-1:0] aid; \
a_optional_t a_optional; \
} a_chan_t;

typedef `OBI_A_CHAN_T(ADDR_WIDTH, DATA_WIDTH, ID_WIDTH, a_optional_t) a_chan_t;

`define OBI_A_TYPE_CHAN_T(addr_t, data_t, strb_t, id_t, a_optional_t) \
struct packed { \
addr_t addr; \
logic we; \
strb_t be; \
data_t wdata; \
id_t aid; \
a_optional_t a_optional; \
}
`define OBI_TYPEDEF_TYPE_A_CHAN_T(a_chan_t, addr_t, data_t, strb_t, id_t, a_optional_t) \
typedef struct packed { \
addr_t addr; \
logic we; \
strb_t be; \
data_t wdata; \
id_t aid; \
a_optional_t a_optional; \
} a_chan_t;
typedef `OBI_A_TYPE_CHAN_T(addr_t, data_t, strb_t, id_t, a_optional_t) a_chan_t;

`define OBI_MINIMAL_A_OPTIONAL(a_optional_t) \
logic a_optional_t;
`define OBI_TYPEDEF_MINIMAL_A_OPTIONAL(a_optional_t) \
typedef logic a_optional_t;
Comment on lines +34 to 37
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`define OBI_MINIMAL_A_OPTIONAL(a_optional_t) \
logic a_optional_t;
`define OBI_TYPEDEF_MINIMAL_A_OPTIONAL(a_optional_t) \
typedef logic a_optional_t;
`define OBI_MINIMAL_A_OPTIONAL \
logic
`define OBI_TYPEDEF_MINIMAL_A_OPTIONAL(a_optional_t) \
typedef `OBI_MINIMAL_A_OPTIONAL a_optional_t;


`define OBI_TYPEDEF_ATOP_A_OPTIONAL(a_optional_t) \
typedef struct packed { \
`define OBI_ATOP_A_OPTIONAL(a_optional_t) \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`define OBI_ATOP_A_OPTIONAL(a_optional_t) \
`define OBI_ATOP_A_OPTIONAL \

struct packed { \
obi_pkg::atop_t atop; \
} a_optional_t;

}
`define OBI_TYPEDEF_ATOP_A_OPTIONAL \
typedef OBI_ATOP_A_OPTIONAL a_optional_t;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
typedef OBI_ATOP_A_OPTIONAL a_optional_t;
typedef `OBI_ATOP_A_OPTIONAL a_optional_t;


`define OBI_ALL_A_OPTIONAL(AUSER_WIDTH, WUSER_WIDTH, MID_WIDTH, ACHK_WIDTH) \
struct packed { \
logic [ AUSER_WIDTH-1:0] auser; \
logic [ WUSER_WIDTH-1:0] wuser; \
obi_pkg::atop_t atop; \
obi_pkg::memtype_t memtype; \
logic [ MID_WIDTH-1:0] mid; \
obi_pkg::prot_t prot; \
logic dbg; \
logic [ ACHK_WIDTH-1:0] achk; \
}
`define OBI_TYPEDEF_ALL_A_OPTIONAL(a_optional_t, AUSER_WIDTH, WUSER_WIDTH, MID_WIDTH, ACHK_WIDTH) \
typedef struct packed { \
logic [ AUSER_WIDTH-1:0] auser; \
logic [ WUSER_WIDTH-1:0] wuser; \
obi_pkg::atop_t atop; \
obi_pkg::memtype_t memtype; \
logic [ MID_WIDTH-1:0] mid; \
obi_pkg::prot_t prot; \
logic dbg; \
logic [ ACHK_WIDTH-1:0] achk; \
} a_optional_t;

typedef `OBI_ALL_A_OPTIONAL(AUSER_WIDTH, WUSER_WIDTH, MID_WIDTH, ACHK_WIDTH) a_optional_t;

`define OBI_R_CHAN_T(RDATA_WIDTH, ID_WIDTH, r_optional_t) \
struct packed { \
logic [RDATA_WIDTH-1:0] rdata; \
logic [ ID_WIDTH-1:0] rid; \
logic err; \
r_optional_t r_optional; \
}
`define OBI_TYPEDEF_R_CHAN_T(r_chan_t, RDATA_WIDTH, ID_WIDTH, r_optional_t) \
typedef struct packed { \
logic [RDATA_WIDTH-1:0] rdata; \
logic [ ID_WIDTH-1:0] rid; \
logic err; \
r_optional_t r_optional; \
} r_chan_t;

typedef `OBI_R_CHAN_T(RDATA_WIDTH, ID_WIDTH, r_optional_t) r_chan_t;

`define OBI_TYPE_R_CHAN_T(data_t, id_t, r_optional_t) \
struct packed { \
data_t rdata; \
id_t rid; \
logic err; \
r_optional_t r_optional; \
}
`define OBI_TYPEDEF_TYPE_R_CHAN_T(r_chan_t, data_t, id_t, r_optional_t) \
typedef struct packed { \
data_t rdata; \
id_t rid; \
logic err; \
r_optional_t r_optional; \
} r_chan_t;
typedef `OBI_TYPE_R_CHAN_T(data_t, id_t, r_optional_t) r_chan_t;

`define OBI_MINIMAL_R_OPTIONAL(r_optional_t) \
logic r_optional_t;
`define OBI_TYPEDEF_MINIMAL_R_OPTIONAL(r_optional_t) \
typedef logic r_optional_t;
Comment on lines +80 to 83
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`define OBI_MINIMAL_R_OPTIONAL(r_optional_t) \
logic r_optional_t;
`define OBI_TYPEDEF_MINIMAL_R_OPTIONAL(r_optional_t) \
typedef logic r_optional_t;
`define OBI_MINIMAL_R_OPTIONAL \
logic
`define OBI_TYPEDEF_MINIMAL_R_OPTIONAL(r_optional_t) \
typedef `OBI_MINIMAL_R_OPTIONAL r_optional_t;


`define OBI_ALL_R_OPTIONAL(RUSER_WIDTH, RCHK_WIDTH) \
struct packed { \
logic [RUSER_WIDTH-1:0] ruser; \
logic exokay; \
logic [ RCHK_WIDTH-1:0] rchk; \
}
`define OBI_TYPEDEF_ALL_R_OPTIONAL(r_optional_t, RUSER_WIDTH, RCHK_WIDTH) \
typedef struct packed { \
logic [RUSER_WIDTH-1:0] ruser; \
logic exokay; \
logic [ RCHK_WIDTH-1:0] rchk; \
} r_optional_t;
typedef `OBI_ALL_R_OPTIONAL(RUSER_WIDTH, RCHK_WIDTH) r_optional_t;

`define OBI_DEFAULT_REQ_T(req_t, a_chan_t) \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`define OBI_DEFAULT_REQ_T(req_t, a_chan_t) \
`define OBI_DEFAULT_REQ_T(a_chan_t) \

struct packed { \
a_chan_t a; \
logic req; \
}
`define OBI_TYPEDEF_DEFAULT_REQ_T(req_t, a_chan_t) \
typedef struct packed { \
a_chan_t a; \
logic req; \
} req_t;

typedef `OBI_DEFAULT_REQ_T(req_t, a_chan_t) req_t;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
typedef `OBI_DEFAULT_REQ_T(req_t, a_chan_t) req_t;
typedef `OBI_DEFAULT_REQ_T(a_chan_t) req_t;


`define OBI_REQ_T(req_t, a_chan_t) \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`define OBI_REQ_T(req_t, a_chan_t) \
`define OBI_REQ_T(a_chan_t) \

struct packed { \
a_chan_t a; \
logic req; \
logic rready; \
}
`define OBI_TYPEDEF_REQ_T(req_t, a_chan_t) \
typedef struct packed { \
a_chan_t a; \
logic req; \
logic rready; \
} req_t;

typedef `OBI_REQ_T(req_t, a_chan_t) req_t;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
typedef `OBI_REQ_T(req_t, a_chan_t) req_t;
typedef `OBI_REQ_T(a_chan_t) req_t;


`define OBI_RSP_T(rsp_t, r_chan_t) \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`define OBI_RSP_T(rsp_t, r_chan_t) \
`define OBI_RSP_T(r_chan_t) \

struct packed { \
r_chan_t r; \
logic gnt; \
logic rvalid; \
}
`define OBI_TYPEDEF_RSP_T(rsp_t, r_chan_t) \
typedef struct packed { \
r_chan_t r; \
logic gnt; \
logic rvalid; \
} rsp_t;

typedef `OBI_RSP_T(rsp_t, r_chan_t) rsp_t;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
typedef `OBI_RSP_T(rsp_t, r_chan_t) rsp_t;
typedef `OBI_RSP_T(r_chan_t) rsp_t;


`define OBI_INTEGRITY_REQ_T(a_chan_t) \
struct packed { \
a_chan_t a; \
logic req; \
logic rready; \
logic reqpar; \
logic rreadypar; \
}
`define OBI_TYPEDEF_INTEGRITY_REQ_T(req_t, a_chan_t) \
typedef struct packed { \
a_chan_t a; \
logic req; \
logic rready; \
logic reqpar; \
logic rreadypar; \
} req_t;

typedef `OBI_INTEGRITY_REQ_T(a_chan_t) req_t;

`define OBI_INTEGRITY_RSP_T(r_chan_t) \
struct packed { \
r_chan_t r; \
logic gnt; \
logic gntpar; \
logic rvalid; \
logic rvalidpar; \
}
`define OBI_TYPEDEF_INTEGRITY_RSP_T(rsp_t, r_chan_t) \
typedef struct packed { \
r_chan_t r; \
logic gnt; \
logic gntpar; \
logic rvalid; \
logic rvalidpar; \
} rsp_t;
typedef `OBI_INTEGRITY_RSP_T(r_chan_t) rsp_t;

`define OBI_TYPEDEF_ALL(obi_t, cfg) \
`OBI_TYPEDEF_ALL_A_OPTIONAL(obi_t``_a_optional_t, cfg.OptionalCfg.AUserWidth, cfg.OptionalCfg.WUserWidth, cfg.OptionalCfg.MidWidth, cfg.OptionalCfg.AChkWidth) \
Expand All @@ -119,4 +147,4 @@
`OBI_TYPEDEF_R_CHAN_T(obi_t``_r_chan_t, cfg.DataWidth, cfg.IdWidth, obi_t``_r_optional_t) \
`OBI_TYPEDEF_INTEGRITY_RSP_T(obi_t``_rsp_t, obi_t``_r_chan_t)

`endif // OBI_TYPEDEF_SVH
`endif // OBI_TYPEDEF_SVH
Loading