Contribution Guidelines

Coding Style

All SystemVerilog code in this repository must adhere to the SystemVerilog Coding Style Guide by lowRISC and the following rules:

All module names must start with axi_.
User-facing modules must have SystemVerilog structs as AXI ports. The concrete struct type must be defined as parameter to the module. The fields of the struct must correspond to those defined by our typedef macros.
User-facing modules may come with a variant that has SystemVerilog interfaces as AXI ports.
- Such an interface variant module must not implement any functionality except wiring its interfaces to the struct ports of the original module.
- The name of an interface variant must be the name of the original module suffixed by _intf.
- The parameters of an interface variant must be formatted ALL_CAPS.