02 設定

優先順位

下にあるものほど優先される。

config/vvd.defaults.conf (組み込み既定値)
<project>/vvd.conf
<project>/vvd.local.conf — マシン固有。.gitignore 済み
環境変数 VVD_*
コマンドラインフラグ

書式

KEY=VALUE のみを受け付ける。値のクォートは任意であり、1 段だけ除去される。シェルとしては評価されないため、$(...) や ` は使用できない。未知のキーや不正な行はエラーとなる。打ち間違いが無視されることはない。

# コメント
VVD_TOP=blinky
VVD_SOURCES="rtl/*.v rtl/sub/*.v"

解決後の全キーは vvd info --all で確認できる。

ツールチェーン

キー	既定	意味
`VVD_VIVADO_VERSION`	`2025.2`	Vivado のバージョン。`--vivado`
`VVD_VIVADO_EDITION`	`Vivado`	インストール先の直下ディレクトリ名
`VVD_XILINX_ROOT`	`/tools/Xilinx`	ホスト側インストールルート (mount モード)
`VVD_VIVADO_MODE`	`mount`	`mount` = ホストから bind、`image` = イメージに同梱、`none` = Vivado なし (CI のコンテナ検証用)

イメージと実行

キー	既定	意味
`VVD_IMAGE_NAME`	`vivado-container-suite`	イメージ名
`VVD_IMAGE_TAG`	自動	既定は `<version>-base` (mount / none) / `<version>` (image)
`VVD_IMAGE`	自動	完全な参照。`--image` で上書き
`VVD_ENGINE`	`auto`	`auto` \| `docker` \| `podman`。`--engine`
`VVD_PLATFORM`	`linux/amd64`	Vivado は x86_64 専用
`VVD_CA_CERT`	なし	ビルド時だけ信頼する追加 CA 証明書。TLS 検査プロキシ配下で必要。`vvd build --ca-cert`
`VVD_USER_MODE`	`match`	`match` = ホストの uid/gid に合わせる、`root` = 降格しない
`VVD_CACHE_DIR`	`$XDG_CACHE_HOME/vivado-container-suite`	コンテナの `$HOME`。IP キャッシュ等が残る
`VVD_JOBS`	`nproc`	並列度
`VVD_MEMORY` / `VVD_CPUS`	なし	エンジンのリソース制限
`VVD_NETWORK`	なし	`--network` に渡す値
`VVD_TMPFS_SIZE`	なし	`/tmp` を tmpfs にする (実装が速くなる。要メモリ)
`VVD_EXTRA_MOUNTS`	なし	`host:container[:ro\\|rw]` を空白区切りで
`VVD_EXTRA_ENV`	なし	`KEY=VALUE` か、ホストから引き継ぐ変数名
`VVD_EXTRA_RUN_ARGS`	なし	エンジンへの生の追加引数

プロジェクト構成

パスはすべてプロジェクトルートからの相対。glob 可。 マッチしないパターンはエラーになる (空の設計が黙って合成されるのを防ぐ)。

キー	意味
`VVD_PROJECT_NAME`	既定はプロジェクトディレクトリ名
`VVD_BUILD_DIR`	出力先。既定 `build`。`--build-dir`
`VVD_TOP`	トップモジュール。`--top`
`VVD_PART`	デバイス。`--part`
`VVD_BOARD_PART`	ボードパーツ (任意)
`VVD_SOURCES`	Verilog
`VVD_SV_SOURCES`	SystemVerilog (`read_verilog -sv`)
`VVD_VHDL_SOURCES`	VHDL
`VVD_CONSTRAINTS`	XDC
`VVD_IP`	`.xci`。`generate_target` + `synth_ip` される
`VVD_BD`	ブロックデザイン `.bd`
`VVD_INCLUDE_DIRS`	`include_dirs` プロパティ
`VVD_GENERICS`	`NAME=VALUE` を空白区切り。`synth_design -generic` に渡る
`VVD_SYNTH_ARGS`	`synth_design` への追加引数
`VVD_IMPL_DIRECTIVE`	`opt/place/route_design -directive`
`VVD_ALLOW_TIMING_VIOLATION`	`1` にするとタイミング未達でも失敗させない (既定 `0`)
`VVD_PRE_TCL` / `VVD_POST_TCL`	合成前 / ビットストリーム後に `source` する Tcl

フローモード

キー	既定	意味
`VVD_FLOW_MODE`	`nonproject`	`nonproject` = チェックポイント方式、`project` = `.xpr` を駆動
`VVD_XPR`	なし	`project` モードで必須

nonproject はディスク上に .xpr を作らず、再現性が高いので CI 向き。既存の IDE プロジェクトが正なら project を使う。詳細は 05 フロー。

シミュレーション

キー	意味
`VVD_SIM_TOP`	テストベンチのトップ
`VVD_SIM_SOURCES`	テストベンチ (Verilog/SV)。設計ソースは自動で追加される
`VVD_SIM_VHDL_SOURCES`	テストベンチ (VHDL)
`VVD_SIM_TIME`	`run <値>`。未設定なら `run all`
`VVD_SIM_LIBS`	`xelab -L` に渡す追加ライブラリ
`VVD_SIM_XVLOG_ARGS` / `VVD_SIM_XELAB_ARGS`	追加引数

ライセンス

キー	意味
`VVD_LICENSE`	`port@host` \| `/abs/path.lic` \| `dir:/abs/path` \| `none`。`--license`
`VVD_XILINX_DOTDIR`	`~/.Xilinx` 相当のディレクトリ。既定は存在すれば自動

04 ライセンス参照。

ディスプレイと JTAG

キー	既定	意味
`VVD_DISPLAY_MODE`	`auto`	`auto` \| `x11` \| `wayland` \| `xvfb` \| `none`。`--display`
`VVD_VNC`	`0`	ヘッドレス表示を VNC で公開。`vvd gui --vnc`
`VVD_VNC_PORT`	`5901`	ホスト側の公開ポート
`VVD_VNC_BIND`	`127.0.0.1`	公開アドレス。`0.0.0.0` は要注意
`VVD_VNC_PASSWORD`	なし	未設定なら 1 回限りのものを生成。`vvd info` では伏せ字になる
`VVD_JTAG_MODE`	`host`	`host` \| `usb` \| `remote:HOST[:PORT]` \| `none`。`--jtag`
`VVD_HW_SERVER_PORT`	`3121`	`hw_server` のポート

06 GUI と Tcl / 07 JTAG 参照。

グローバルフラグ

-C, --project DIR    プロジェクトルート
    --config FILE    vvd.conf の代わりに使うファイル
    --vivado VER     Vivado バージョン
    --engine E       auto | docker | podman
    --image REF      イメージ参照
    --license SPEC   ライセンス指定
    --display MODE   ディスプレイ方式
    --jtag MODE      JTAG 方式
    --part PART      デバイス
    --top MODULE     トップモジュール
    --build-dir DIR  出力先
    --gpu            /dev/dri を渡す (ハードウェア GL)
-n, --dry-run        コンテナを起動せず、コマンドだけ表示
-v, --verbose        デバッグログ
-q, --quiet          警告以上のみ