mirror of
https://github.com/retroSoC/retroSoC.git
synced 2026-11-04 22:32:36 +00:00
maksyuki
1e37314a99
- Updated to enforce stricter naming rules for new owned RTL. - Expanded documentation on RTL coding style to include detailed naming contracts. - Refactored RTL code to comply with new naming conventions, including: - Renaming typedefs to use suffix for enums and for other types. - Ensuring module names use lower snake case and ports have appropriate direction suffixes. - Adjusting instance names to start with and ensuring state variables use and suffixes. - Modified scripts to include checks for new naming rules and updated tests to validate these changes. - Updated to reflect new naming guidelines and exceptions.
117 lines
2.0 KiB
JSON
117 lines
2.0 KiB
JSON
{
|
|
"schema_version": 1,
|
|
"profiles": {
|
|
"owned": {
|
|
"roots": [
|
|
"rtl/ip",
|
|
"rtl/mini/top"
|
|
],
|
|
"suffixes": [
|
|
".sv",
|
|
".svh"
|
|
],
|
|
"format": "verible",
|
|
"lint": "strict",
|
|
"max_line_length": 100,
|
|
"language": "systemverilog-2017-restricted"
|
|
},
|
|
"verification": {
|
|
"roots": [
|
|
"rtl/mini/formal",
|
|
"rtl/mini/dv"
|
|
],
|
|
"suffixes": [
|
|
".sv",
|
|
".svh",
|
|
".v"
|
|
],
|
|
"format": "verible",
|
|
"lint": "verification"
|
|
},
|
|
"technology": {
|
|
"roots": [
|
|
"rtl/tech"
|
|
],
|
|
"suffixes": [
|
|
".sv",
|
|
".svh",
|
|
".v"
|
|
],
|
|
"format": "compile-only",
|
|
"lint": "technology"
|
|
}
|
|
},
|
|
"excluded_prefixes": [
|
|
"rtl/managed",
|
|
"rtl/mini/core/minirv.sv"
|
|
],
|
|
"abbreviations": {
|
|
"command": "cmd",
|
|
"request": "req",
|
|
"response": "resp",
|
|
"address": "addr",
|
|
"enable": "en",
|
|
"error": "err",
|
|
"status": "stat",
|
|
"counter": "cnt",
|
|
"configuration": "cfg",
|
|
"select": "sel",
|
|
"length": "len"
|
|
},
|
|
"reset_suffix": "rst_n_i",
|
|
"naming": {
|
|
"signal_case": "lower_snake_case",
|
|
"port_suffixes": [
|
|
"_i",
|
|
"_o",
|
|
"_io"
|
|
],
|
|
"active_low_suffixes": [
|
|
"_n_i",
|
|
"_n_o",
|
|
"_n_io"
|
|
],
|
|
"internal_prefix": "s_",
|
|
"instance_prefix": "u_",
|
|
"state_suffixes": [
|
|
"_d",
|
|
"_q",
|
|
"_q2",
|
|
"_q3"
|
|
],
|
|
"typedef_suffixes": {
|
|
"enum": "_e",
|
|
"other": "_t"
|
|
},
|
|
"parameter_case": "UpperCamelCase",
|
|
"macro_prefix": "RETROSOC_",
|
|
"macro_namespace_separator": "__",
|
|
"interface_name_exceptions": [
|
|
"rib",
|
|
"ribp",
|
|
"axi4",
|
|
"apb",
|
|
"gpio",
|
|
"uart",
|
|
"spi",
|
|
"i2c",
|
|
"i2s",
|
|
"ws2812",
|
|
"sysctrl",
|
|
"pll_ctrl",
|
|
"sdram",
|
|
"sdio",
|
|
"dvp",
|
|
"psram",
|
|
"opipsram"
|
|
],
|
|
"macro_namespace_exceptions": [
|
|
"SOC_",
|
|
"RIB_",
|
|
"RIBP_",
|
|
"AXI4_",
|
|
"APB_"
|
|
]
|
|
}
|
|
}
|