VSCODE-BLIF

This is the README for the BLIF extension (vscode-blif) for Visual Studio Code.

BLIF is SIS' Berkeley Logic Interchange Format.

SIS is a tool that optimizes and simulates logic gate and finite state machine networks

This extension allows you to:

• Start to develop a .blif file from a template

  Currently the included templates are:

  • !fsm, which is a Finite State Machine template
  • !lgate, which is a Logic Gate template

• Autocomplete keywords (commands that start with the dot .)

• See what a keyword does while using the autocomplete feature

• Syntax highlight keywords

Disclaimer:

I'm not affiliated with the SIS and the Visual Studio Code developers in any way.

The aim of the extension is only to add syntax highlighting and autocompletion for the BLIF format, SIS' Berkeley Logic Interchange Format, on VS Code.

README Index

• Installation
• Features
  • Templates
  • Keyword autocompletion
  • Keyword description
  • Syntax highlighting
• Development
• Release Notes

Installation

• (BEST) First option: You can install this extension on the the Visual Studio Code extension marketplace, (from browser or from VS Code): From VS Code:

  • Open the extensions marketplace
  • search for the "BLIF (SIS)" extension by mario33881 (me)
  • click on the install button

  From the browser:

  • Click this link to go to the marketplace
  • Click the install button and accept to open the link with Visual Studio Code

• Second option: you can also download and install the VSIX package from the latest github release by clicking here

  The VSIX package can then be installed from VS Code:

  • go to the Extensions marketplace
  • click on the three dots ... (positioned on top of the seach bar)
  • then click on Install from VSIX..., select the VSIX file and click open

  The VSIX package can also be installed from the terminal using the following command:

  code --install-extension <file>
  

  Replace <file> with the correct file name (example vscode-blif-v1.0.1.vsix)

• Third option: You can also copy this repository folder into the extensions folder:

  • Windows: %USERPROFILE%\.vscode\extensions
  • macOS: ~/.vscode/extensions
  • Linux: ~/.vscode/extensions

  and then restart Code.

• Fourth option: download this repository, navigate to this directory via the terminal and execute the following command:

    npm install && npm run install_ext
  

  NPM is required to install the extension using this option

Features

Templates

Templates allow you to develop your .blif file from a basic, common, baseline.

Currently the included templates are:

• !fsm, which is a Finite State Machine template

  

• !lgate, which is a Logic Gate template

  

Keyword autocompletion

Keyword autocompletion allows you to write keywords efficiently by completing a keyword using the tab key:

• Start writing a keyword, like .m

  

• The extension suggests you all the possible options for autocompletion, use the arrow keys to hover over an option

• You can read what the keyword does on the right of the hovered option. Select the option by clicking the tab key.

  

• If default values follow the keyword, start typing to replace the value and then use the tab key to move to the next default value (if available).

  You can repeat this operation (tab key and then overwriting values) for every default value.

  If you close the autocompletion you can also modify the values by modifing them normally

Keyword description

Each keyword has a description that is shown while using the autocompletion feature.

These are the keywords that have a description:

• .model: Define a sub-cell by specifying the name of its model
• .inputs: Define the name of the input(s)
• .outputs: Define the name of the output(s)
• .names: Define a link between inputs and an output (on a new line write a truth table with only minterms).
• .exdc: Specifies that the following truth tables have don't care(s) as an output
• .start_kiss: Defines a FSM.
• .end_kiss: Closes the definition of an FSM.
• .i: Specifies the number of inputs of a FSM.
• .o: Specifies the number of outputs of a FSM.
• .s: Specifies the number of states of a FSM
• .p: Specifies the number of states transitions of a FSM
• .r: Specifies the name of the reset state of a FSM
• .code: Define a state encoding
• .subckt: Initialize an instance of a sub-cell model.
• .search: Searches (imports) sub-cell models defined in another .blif file.
• .latch: Defines a latch.
• .end: Closes the definition of a sub-cell model.

Syntax highlighting

This extension highlights keywords that start with the dot . and .subckt parameters.

Highlighted keywords:

Development

• Open this repository with visual studio code and then press F5 to open a new window with the extension loaded.
• You can relaunch the extension from the debug toolbar after making changes to the extensions files.
• You can also reload (Ctrl+R or Cmd+R on Mac) the VS Code window with the extension to load your changes.

Release Notes

1.0.1

Initial release

Author

Zenaro Stefano (mario33881)