Linting file for spyglass

lowRISC / style-guides

lowRISC Style Guides

Creative Commons Attribution 4.0 International

345 stars 122 forks source link

Linting file for spyglass #56

Open rahulraveendran15-coder opened 2 years ago

rahulraveendran15-coder commented 2 years ago

Hi,

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

imphil commented 2 years ago

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 commented 2 years ago

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

imphil commented 2 years ago

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

rahulraveendran15-coder commented 2 years ago

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 commented 2 years ago

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)