SublimeLinter-contrib-verilator
👌 This linter plugin for SublimeLinter provides an interface to Verilator (Verilog Simulator)
Details
Installs
- Total 3K
- Win 2K
- Mac 317
- Linux 661
| Oct 3 | Oct 2 | Oct 1 | Sep 30 | Sep 29 | Sep 28 | Sep 27 | Sep 26 | Sep 25 | Sep 24 | Sep 23 | Sep 22 | Sep 21 | Sep 20 | Sep 19 | Sep 18 | Sep 17 | Sep 16 | Sep 15 | Sep 14 | Sep 13 | Sep 12 | Sep 11 | Sep 10 | Sep 9 | Sep 8 | Sep 7 | Sep 6 | Sep 5 | Sep 4 | Sep 3 | Sep 2 | Sep 1 | Aug 31 | Aug 30 | Aug 29 | Aug 28 | Aug 27 | Aug 26 | Aug 25 | Aug 24 | Aug 23 | Aug 22 | Aug 21 | Aug 20 | Aug 19 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 0 | 0 | 1 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 1 | 2 | 2 | 2 | 3 | 2 | 0 | 0 | 2 | 0 | 1 | 3 | 1 | 1 | 2 | 1 | 0 | 2 | 0 | 1 | 1 | 0 | 0 | 1 | 1 | 2 | 0 | 1 | 1 | 1 | 0 | 1 |
| Mac | 0 | 0 | 1 | 0 | 0 | 3 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| Linux | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 0 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 1 |
Readme
- Source
- raw.githubusercontent.com
SublimeLinter-contrib-verilator
This linter plugin for SublimeLinter provides an interface to Verilator. Verilator is a open source HDL simulator and can be used as a linter with –lint-only option. For more information, you can see here, https://www.veripool.org/wiki/verilator Verilator is fast and easy to use to link with Sublime Text Editor on variable OS before runnning commercial simulaton and synthesis tools.
Prerequisite
- SublimeLinter 4 installation - Guide from here
- Verilator installation - Guide from here
- Modified version of Verilator - Get source from https://github.com/poucotm/verilator (update for verilator-4.016, v1.5.0) or download compiled version (32) for Windows (v1.5.0) or (64) for Windows (v1.5.0) with 3 MinGW libraries.
- Verilator PATH settings - SublimeLinter-contrib-verilator uses verilator_bin or verilator_bin.exe instead of verilator. You have to add PATH environment variable for verilator_bin or verilator_bin.exe
Verilator Original vs. Modified Version
Verilator originally simulates all entities having all include and module files. If you miss even a file, it will generate an error message and stop simulation or linting. It is not good to be used with a editor. People don't open all files to edit or it is tired to pass the file list to Verilator every time. In order to lint single file based, the original codes are modified. It can ignore include and externally defined module's instance and its port connection even if there's a real error in port connection. You can select one of them. If you want to use original version, you may have to put all files in the same directory. Because, Verilator basically searches missed files in the same directory.
Options for Modified Version
- -Wno-IGNINC : Ignores include files
- -Wno-IGNDEF : Ignores define which may have been defined outside
Lint based on multiple files (higher than v2.8.0)
Two options are added to support linting based on multiple files. If you set full paths, the original version of verilator can be used.
- “use_multiple_source”: true
- “search_project_path”: true
an example of settings in a sublime-project file:
"sources":
[
"D:\\project\\srcs",
"D:\\project\\working"
]
Screenshot
Settings
In order to set arguments of Verilator or control lint message, Use SublimeLinter's user settings like the following.
{
"no_column_highlights_line": true,
"linters":
{
"verilator": {
"lint_mode": "load_save",
"styles" : [
{
"types": ["warning"],
"mark_style": "squiggly_underline",
"icon": "Packages/SublimeLinter/gutter-themes/Default/cog.png"
},
{
"types": ["error"],
"mark_style": "fill",
"icon": "Packages/SublimeLinter/gutter-themes/Default/cog.png"
}
],
"args": [
"--error-limit",
"500",
"--default-language",
// "1800-2017", // systemverilog
"1364-2005", // verilog
"--bbox-sys",
"--bbox-unsup",
"-Wall",
"-Wno-WIDTH",
"-Wno-IGNINC",
"-Wno-IGNDEF",
"-Wno-STMTDLY",
"-Wno-UNDRIVEN",
"-Wno-PINCONNECTEMPTY",
"-Wno-INPUTPINEMPTY",
"-Wno-OUTPUTPINEMPTY"
],
"filter_errors": [
"Unsupported:",
"\\[IGNDEF\\]",
// "expects 8192 bits" // not to use -Wno-WIDTH
],
// to lint based on single file (ignoring external module definition)
// "use_multiple_source": false,
// "search_project_path": false,
// to lint based on multiple files (searching external sources - the same directory or project path)
// "use_multiple_source": true,
// "search_project_path": true,
// example) example.sublime-project
// "sources": [ "D:\\project\\srcs", "D:\\project\\working" ]
"use_multiple_source": false,
"search_project_path": false,
// windows subsystem for linux (wsl verilator_bin)
"use_wsl": false,
// additional option to filter file type
"extension": [
".v"
],
// additional option for better highlighting near
"message_near_map": [
["Case values", "case"],
["Suggest casez", "casex"]
]
}
}
}
Key Map
'F1' : SublimeLinter Show All Errors 'Shift+F1' : SublimeLinter Lint This View
Troubleshooting
Turn on SublimeLinter's Debug Mode and Open the console of Sublime Text. You can check the communication status from SublimeLinter to Verilator. You can also add your own filter_errors messages by using them.
SublimeLinter: verilator: shift_reg.v ['D:\\Program\\verilator-3.902\\verilator_bin.exe', '--lint-only', ...
SublimeLinter: verilator output:
%Warning-LITENDIAN: c:/users/shift_reg.v:14: Little bit endian vector: MSB < LSB of bit range: 0:7
%Warning-LITENDIAN: Use "/* verilator lint_off LITENDIAN */" and lint_on around source to disable this message.
%Error: Exiting due to 1 warning(s)
Donate
Thank you for donating. It is helpful to continue to improve the plug-in.
Credits
Thanks to SublimeLinter Team and Veripool Organization.
Issues
When you have an issue, tell me through https://github.com/poucotm/SublimeLinter-contrib-verilator/issues, or send me an e-mail poucotm@gmail.com