User Guide¶
symbiflow¶
usage: symbiflow [-h] [-v] {all,syn,pnr,bit,pgm} ...
SymbiFlow CLI
positional arguments:
{all,syn,pnr,bit,pgm}
Available commands
all Performs from synthesis to bitstream generation
syn Performs synthesis
pnr Performs place and route
bit Performs bitstream generation
pgm Performs programming
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
symbiflow all¶
usage: symbiflow all [-h] [-t NAME] [--param NAME VALUE] [--arch NAME]
[--define NAME VALUE] [--include PATH] [--scf FILE]
[--pcf FILE] [--project NAME] [-p FPGA] [-o PATH]
[--oci-engine {None,docker,podman}]
[--oci-volumes HOST-DIR:CONT-DIR] [--oci-work WORK]
FILE[,LIBRARY] [FILE[,LIBRARY] ...]
Performs from synthesis to bitstream generation
positional arguments:
FILE[,LIBRARY] HDL file (with an optional LIBRARY specification for
VHDL)
optional arguments:
-h, --help show this help message and exit
-t NAME, --top NAME specify a top-level name
--param NAME VALUE specify a top-level Generic/Parameter (can be
specified multiple times)
--arch NAME specify a VHDL top-level Architecture
--define NAME VALUE specify a [System] Verilog Define (can be specified
multiple times)
--include PATH specify a [System] Verilog Include Path (can be
specified multiple times)
--scf FILE Synthesis Constraint File (can be specified multiple
times)
--pcf FILE Physical Constraint File (can be specified multiple
times)
--project NAME basename for generated files [symbiflow]
-p FPGA, --part FPGA name of the target FPGA part [hx8k-ct256]
-o PATH, --outdir PATH
location for generated files [.]
--oci-engine {None,docker,podman}
OCI engine internally employed [None]
--oci-volumes HOST-DIR:CONT-DIR
volumes for the OCI engine [$HOME:$HOME] (can be
specified multiple times)
--oci-work WORK working directory for the OCI engine [$PWD]
symbiflow syn¶
usage: symbiflow syn [-h] [-t NAME] [--param NAME VALUE] [--arch NAME]
[--define NAME VALUE] [--include PATH] [--scf FILE]
[--project NAME] [-p FPGA] [-o PATH]
[--oci-engine {None,docker,podman}]
[--oci-volumes HOST-DIR:CONT-DIR] [--oci-work WORK]
FILE[,LIBRARY] [FILE[,LIBRARY] ...]
Performs synthesis
positional arguments:
FILE[,LIBRARY] HDL file (with an optional LIBRARY specification for
VHDL)
optional arguments:
-h, --help show this help message and exit
-t NAME, --top NAME specify a top-level name
--param NAME VALUE specify a top-level Generic/Parameter (can be
specified multiple times)
--arch NAME specify a VHDL top-level Architecture
--define NAME VALUE specify a [System] Verilog Define (can be specified
multiple times)
--include PATH specify a [System] Verilog Include Path (can be
specified multiple times)
--scf FILE Synthesis Constraint File (can be specified multiple
times)
--project NAME basename for generated files [symbiflow]
-p FPGA, --part FPGA name of the target FPGA part [hx8k-ct256]
-o PATH, --outdir PATH
location for generated files [.]
--oci-engine {None,docker,podman}
OCI engine internally employed [None]
--oci-volumes HOST-DIR:CONT-DIR
volumes for the OCI engine [$HOME:$HOME] (can be
specified multiple times)
--oci-work WORK working directory for the OCI engine [$PWD]
symbiflow pnr¶
usage: symbiflow pnr [-h] [--pcf FILE] [--project NAME] [-p FPGA] [-o PATH]
[--oci-engine {None,docker,podman}]
[--oci-volumes HOST-DIR:CONT-DIR] [--oci-work WORK]
Performs place and route
optional arguments:
-h, --help show this help message and exit
--pcf FILE Physical Constraint File (can be specified multiple
times)
--project NAME basename for generated files [symbiflow]
-p FPGA, --part FPGA name of the target FPGA part [hx8k-ct256]
-o PATH, --outdir PATH
location for generated files [.]
--oci-engine {None,docker,podman}
OCI engine internally employed [None]
--oci-volumes HOST-DIR:CONT-DIR
volumes for the OCI engine [$HOME:$HOME] (can be
specified multiple times)
--oci-work WORK working directory for the OCI engine [$PWD]
symbiflow bit¶
usage: symbiflow bit [-h] [--project NAME] [-p FPGA] [-o PATH]
[--oci-engine {None,docker,podman}]
[--oci-volumes HOST-DIR:CONT-DIR] [--oci-work WORK]
Performs bitstream generation
optional arguments:
-h, --help show this help message and exit
--project NAME basename for generated files [symbiflow]
-p FPGA, --part FPGA name of the target FPGA part [hx8k-ct256]
-o PATH, --outdir PATH
location for generated files [.]
--oci-engine {None,docker,podman}
OCI engine internally employed [None]
--oci-volumes HOST-DIR:CONT-DIR
volumes for the OCI engine [$HOME:$HOME] (can be
specified multiple times)
--oci-work WORK working directory for the OCI engine [$PWD]
symbiflow pgm¶
usage: symbiflow pgm [-h] [--project NAME] [-p FPGA] [-o PATH]
[--oci-engine {None,docker,podman}]
[--oci-volumes HOST-DIR:CONT-DIR] [--oci-work WORK]
Performs programming
optional arguments:
-h, --help show this help message and exit
--project NAME basename for generated files [symbiflow]
-p FPGA, --part FPGA name of the target FPGA part [hx8k-ct256]
-o PATH, --outdir PATH
location for generated files [.]
--oci-engine {None,docker,podman}
OCI engine internally employed [None]
--oci-volumes HOST-DIR:CONT-DIR
volumes for the OCI engine [$HOME:$HOME] (can be
specified multiple times)
--oci-work WORK working directory for the OCI engine [$PWD]