Linting file for spyglass

[rahulraveendran15-coder]

Hi,

Do you have any rules file defined with the lowRISC coding guidelines that I can run on Spyglass?

[imphil]

Unfortunately not. I looked into it briefly a while ago, but didn't move forward with it.

You can potentially start by looking at the AscentLint, Verilator, and Verible waiver and configuration files at https://github.com/lowRISC/opentitan/tree/master/hw/lint/tools.

It would be fantastic if you can put a SpyGlass waiver together and share it!

[rahulraveendran15-coder]

Thank you, my question is can I get a rule defined file either its verilator or AscentLint which has the lowRISC coding guidelines ?

[imphil]

Yes, the rules I linked above are both following the lowRISC style guide, since opentitan follows this style guide.

[rahulraveendran15-coder]

I can see only some waiver files. I am very much interested on the other rules that lowRISC suggests, for example naming convention, no usage of defparam etc.

[imphil]

That's all the rules there are.

• Verible lint follows by default mostly the lowRISC style guide, so the explicit rules only override some limited aspects, everything else is "Verible default".
• Verilator doesn't check for things like defparams.
• AscentLint has an extensive ruleset that is enabled by choosing a built-in configuration that RealIntent is shipping with the product (https://github.com/lowRISC/opentitan/blob/master/hw/lint/tools/ascentlint/ascentlint-config.tcl#L9)