Files
retroSoC/rtl/rtl_style_manifest.json
T
maksyuki 8a64c160c6 refactor: refactor parameter naming conventions and update RTL style
- Changed parameter names in various modules from uppercase to camel case for consistency.
- Updated local parameters in testbenches to follow the same naming convention.
- Modified the RTL style manifest to include additional prefixes for better organization.
- Enhanced the check_format and check_rtl_style scripts to improve file tracking and naming validation.
- Added new tests to ensure compliance with the updated naming conventions and allowed local parameters in specific contexts.
2026-08-13 15:08:24 +08:00

131 lines
2.2 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_",
"CLINT_",
"DMA_",
"DVP_",
"GPIO_",
"I2C_",
"I2S_",
"PSRAM_",
"SDIO_",
"SDRAM_",
"SPISD_",
"TIMER_",
"UART_",
"WS2812_",
"XPI_"
]
}
}