search

lowRISC / style-guides

lowRISC Style Guides
Creative Commons Attribution 4.0 International
359 stars 122 forks source link

[dv style guide] More macro usage guidelines #34

Closed sriyerg closed 3 years ago

sriyerg commented 4 years ago

This was prompted by this PR made on OpenTitan, which was seemingly hard to debug.

Signed-off-by: Srikrishna Iyer sriyer@google.com

GregAC commented 4 years ago

Have yet to read this in detail but we may want these in the main style guide as we use macros in non-DV RTL and they will have the same gotchas. Perhaps we want the bulk of this in VerilogCodingStyle.md with anything DV specific in DVCodingStyle.md?

asb commented 4 years ago

Have yet to read this in detail but we may want these in the main style guide as we use macros in non-DV RTL and they will have the same gotchas. Perhaps we want the bulk of this in VerilogCodingStyle.md with anything DV specific in DVCodingStyle.md?

+1. It feels like the majority of this is non-DV specific and so would be best added to VerilogCodingStyle.md

sjgitty commented 4 years ago

@sriyerg I think this is close, but there are a few requested changes here.

sjgitty commented 4 years ago

@sriyerg I think this is close, but there are a few requested changes here.

@sriyerg this is lingering for a long time. Is it still relevant? If so, can you finish it off? If not, can you amend or close?

sriyerg commented 3 years ago

Wow, sorry about this. I will try to close it by this weekend.