Verilog Package Manager (VPM)

VPM is a powerful package manager for Verilog projects, currently being piloted at Stanford and UC Berkeley. It's designed to streamline the management, reuse, and communication of IP cores and dependencies in hardware design workflows, significantly accelerating your design process.

Features

• Module Management: Easily include, update, and remove modules in your project.
• Documentation Generation: Automatically create comprehensive documentation for your Verilog modules.
• Dependency Handling: Manage project dependencies with ease.
• Simulation Support: Simulate your Verilog files directly through VPM.
• Tool Integration: Seamlessly install and set up open-source tools for your project.
• File Generation: Automatically generate necessary files like .f, .svh, .xcd, and .tcl.

Installation

VPM is designed for easy installation with no additional dependencies.

Default Installation (Linux/MacOS):

curl -f https://getinstachip.com/install.sh | sh

Default Installation (Windows):

1. Download the .zip file matching your Windows architecture from the latest release page
2. Extract and run the .exe file

If installation doesn't work, try the following:

Linux alternative:

We support Snap

snap download instachip-vpm
alias vpm='instachip-vpm.vpm'

MacOS alternative:

brew tap getinstachip/vpm
brew install vpm

After installation, the vpm command will be available in any terminal.

Commands

• vpm include <path_to_module.sv>: Include any module from a repo (and all its submodules).
• vpm docs <module.sv>: Generate documentation for any module (highlighting bugs and edge cases)
• vpm install <tool>: Auto-integrate an open-source tool without manual setup
• vpm update <module.sv>: Update module to the latest version
• vpm remove <module.sv>: Remove a module from your project
• vpm list: List all modules in our standard library
• vpm dotf <module.sv>: Generate a .f filelist when exporting your project
• vpm sim <module.sv> <testbench.sv>: Simulate Verilog module using iVerilog

vpm include

Include a module or repository in your project.

This command:

• Downloads the specified module or repository
• Analyzes the module hierarchy
• Includes all necessary submodules and generates appropriate header files
• Updates the vpm.toml file with new module details

This command comes in two forms:

1. Include a module and all its submodules:

vpm include <URL_TO_TOP_MODULE.sv>

URL_TO_TOP_MODULE: Full GitHub URL to the top module to include. The URL should come in the format of https://github.com/<AUTHOR_NAME>/<REPO_NAME>/blob/branch/<PATH_TO_MODULE.sv>.

Example:

vpm include https://github.com/ZipCPU/zipcpu/blob/master/rtl/core/prefetch.v

2. Include a repository:

vpm include --repo <AUTHOR_NAME/REPO_NAME>

Press tab to select multiple modules and press ENTER to install. If no modules are selected, all modules in the repository will be installed.

Example:

vpm include --repo ZipCPU/zipcpu

vpm docs

Generate comprehensive documentation for a module.

This command generates a Markdown README file containing:

• Overview and module description
• Pinout diagram
• Table of ports
• Table of parameters
• Important implementation details
• Simulation output and GTKWave waveform details (Coming soon!)
• List of any major bugs or caveats if they exist

vpm docs <MODULE.sv>

<MODULE>: Name of the module to generate documentation for. Include the file extension.

[URL]: Optional URL of the repository to generate documentation for. If not specified, VPM will assume the module is local, and will search for the module in the vpm_modules directory.

Examples:

vpm docs pfcache.v
vpm docs pfcache.v https://github.com/ZipCPU/zipcpu

vpm update

Update a package to the latest version.

This command:

• Checks for the latest version of the specified module
• Downloads and replaces the current version with the latest
• Updates all dependencies and submodules
• Modifies the vpm.toml file to reflect the changes

vpm update <PACKAGE_PATH>

<PACKAGE_PATH>: Full module path of the package to update

Example:

vpm update my_project/modules/counter

vpm remove

Remove a package from your project.

This command:

• Removes the specified module from your project
• Updates the vpm.toml file to remove the module entry
• Cleans up any orphaned dependencies

vpm remove <PACKAGE_PATH>

<PACKAGE_PATH>: Full module path of the package to remove

Example:

vpm remove my_project/modules/unused_module

vpm dotf

Generate a .f file list for a Verilog or SystemVerilog module.

vpm dotf <PATH_TO_TOP_MODULE>

<PATH_TO_TOP_MODULE>: Path to the top module to generate the file list for. File should be local.

Example:

vpm dotf ./vpm_modules/pfcache/fwb_master.v

This command:

• Analyzes the specified top module
• Identifies all submodules and dependencies
• Generates a .f file containing all necessary file paths
• Includes all locally scoped defines for submodules

vpm install

Install and set up an open-source tool for integration into your project.

This command:

• Downloads the specified tool
• Configures the tool for your system
• Integrates it with your VPM project setup

vpm install <TOOL_NAME>

<TOOL_NAME>: Name of the tool to install

Example:

vpm install verilator

Currently supported tools:

• Verilator
• Chipyard
• OpenROAD
• Edalize
• Icarus Verilog

Coming soon:

• Yosys (with support for ABC)
• RISC-V GNU Toolchain

vpm sim

Simulate Verilog files.

This command:

• Compiles the specified Verilog files
• Runs the simulation
• Provides output and analysis of the simulation results

vpm sim <VERILOG_FILES>...

<VERILOG_FILES>: List of Verilog files to simulate using Icarus Verilog.

Example:

vpm sim testbench.v module1.v module2.v

vpm list

List all modules in VPM's standard library.

This command displays all available modules in the standard Verilog library, including:

• Common modules
• RISC-V modules

vpm list

vpm config

Configure VPM settings.

This command allows you to enable or disable anonymous usage data collection.

vpm config <OPTION> <VALUE>

OPTIONS:

• analytics (true/false): Enable or disable anonymous usage data collection.

Example:

vpm config --analytics true

Configuration

VPM uses a vpm.toml file for project configuration. This file allows you to specify project properties, dependencies, and custom settings.

Example vpm.toml file:

[library]
name = "my_cpu"
version = "0.3.5"
description = "A basic CPU."

[dependencies]
"https://github.com/ZipCPU/zipcpu" = { modules = ["alu", "register_file"], commit = "1234567890abcdef" }

Support and Contribution

For issues, feature requests, or contributions, please email [email protected] or create a GitHub Issue. Please read our CONTRIBUTING.md file for guidelines on how to contribute to VPM.

License

VPM is released under the MIT License.

Acknowledgements

We'd like to thank our early adopters for their valuable feedback and support in developing VPM:

• Kasun Buddhi
• Krishna
• Yash
• Max Korbel
• Samuel
• Biplab Das
• Nikhil Raju

And many more contributors who have helped shape VPM.