Skip to content

Toolchains and simulators

Chipforge runs the EDA tools installed on the machine where its companion runs: your computer, or your remote EDA server. It finds most installs on its own. This page explains where it looks, and how to point it at tools it misses.

For the tools Chipforge works with, see System requirements.

  • On the Simulation page, the simulator list shows every simulator Chipforge knows. One it can’t use is marked Not found, Not usable (found, but it can’t be used, such as a Verilator older than 5.0) or Not available on this OS.
  • Under the simulator list, and under Project toolchain on the flow pages, a line ending in not found — how to fix appears when tools are missing. Select it to see why each one is missing and which setting fixes it.
  • If the project’s toolchain can’t run on this machine, the Synthesis, Implementation and Bitstream pages say so.

Chipforge looks for tools when a project opens, and when you apply new settings. After you install a tool, reopen the project.

For each tool, Chipforge tries these in order and uses the first that works:

  1. The path you set for the tool in Settings → Local Toolchains. If you set a path, Chipforge uses only that one: if it doesn’t work, the tool shows as unavailable rather than Chipforge picking another install.
  2. The tool vendor’s own variables in the companion’s environment, such as XILINX_VIVADO, QUARTUS_ROOTDIR, VCS_HOME or XCELIUM_HOME.
  3. The folders on the companion’s PATH.
  4. Search roots: folders under which tools are installed. Chipforge searches the ones you set first, then common install locations such as /tools/Xilinx, /opt/Xilinx, C:\Xilinx, /opt/intelFPGA and C:\intelFPGA_lite.

When several versions of Vivado or Quartus Prime are installed, Chipforge uses the first one it finds in the order above, and the newest one in a search root. To build a project with a particular version, choose it with Project toolchain on the Synthesis, Implementation or Bitstream page. Chipforge remembers the choice for the project.

  1. Select Settings in the sidebar, then select Local Toolchains.

  2. Find the tool’s section, such as Toolchains / Xilinx (synthesis) or Toolchains / Simulators.

  3. Either enter the full path to the program, for example in Vivado path or Icarus Verilog path, or add the folder it’s installed under to the tool’s search roots, for example Vivado search roots.

    A path must be absolute and point at the program itself, such as vivado or iverilog. Search roots are listed with the locations Chipforge also searches on its own.

  4. Select Save.

  5. A notice appears saying which services must restart to apply your changes. Select Apply.

To undo a setting, select its Reset button to go back to the default.

The companion saves these settings in a file on the machine where it runs. The top of the Local Toolchains page shows its path. It’s usually:

%AppData%\Chipforge\agent\config.json

If a run is in progress when you select Apply, Chipforge asks whether to Force apply, which interrupts the running work. Chipforge doesn’t apply settings while a board is being programmed.

Chipforge doesn’t manage licences: your tools check out licences from your licence servers as they normally do.

Chipforge starts your tools with a limited set of environment variables, not with everything from your login profile. Each tool also gets its usual licence variables, such as LM_LICENSE_FILE, XILINXD_LICENSE_FILE or SNPSLMD_LICENSE_FILE, if they were set when the companion started.

If your licence variables aren’t in the companion’s environment, set them in Settings → Local Toolchains → License variables:

  • Enter one variable per line, as NAME=VALUE, for example LM_LICENSE_FILE=27000@licserver.
  • The name must end in _LICENSE_FILE, _LICENSE_SERVER or _LIC_FILE.
  • Each line applies to every tool Chipforge runs, and replaces a variable of the same name from the environment.

When a simulator can’t get a licence, the run fails with a message such as “… licence checkout failed: …”, followed by the variables that tool reads. Chipforge reports it as a licence problem, not as a fault in your design.

By default, Chipforge runs one vendor-tool job at a time for each project, so that one project doesn’t hold several licence seats. A run that’s waiting for its turn says so in its log. To change this, set Concurrent vendor tool runs under Limits.

Verilator and Quartus Prime can’t build in a folder whose path contains a space, such as C:\Users\John Smith. For those projects, Chipforge builds in a private build folder of its own and copies the results back into your project. You don’t need to do anything.

If Chipforge’s choice of build folder doesn’t suit you, set Build folder under Builds to a folder whose path has no spaces.

Some other characters in a project’s path stop particular tools from running at all. Chipforge then refuses the run with a message that starts with the tool’s name and can't run here, says which character is the problem, and suggests a folder to move the project to.