2020-06-12 17:15:16 -05:00
.. _openfpga_setup_commands:
Setup OpenFPGA
--------------
read_openfpga_arch
~~~~~~~~~~~~~~~~~~
Read the XML file about architecture description (see details in :ref: `arch_generality` )
2021-01-19 21:26:38 -06:00
.. option :: --file <string> or -f <string>
Specify the file name. For example, `` --file openfpga_arch.xml ``
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
.. option :: --verbose
Show verbose log
2020-06-12 17:15:16 -05:00
write_openfpga_arch
~~~~~~~~~~~~~~~~~~~
Write the OpenFPGA XML architecture file to a file
2021-01-19 21:26:38 -06:00
.. option :: --file <string> or -f <string>
Specify the file name. For example, `` --file arch_echo.xml ``
.. option :: --verbose
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
Show verbose log
2020-06-12 17:15:16 -05:00
read_openfpga_simulation_setting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Read the XML file about simulation settings (see details in :ref: `simulation_setting` )
2021-01-19 21:26:38 -06:00
.. option :: --file <string> or -f <string>
Specify the file name. For example, `` --file auto_simulation_setting.xml ``
.. option :: --verbose
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
Show verbose log
2020-06-12 17:15:16 -05:00
write_openfpga_simulation_setting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write the OpenFPGA XML simulation settings to a file
2021-01-19 21:26:38 -06:00
.. option :: --file <string> or -f <string>
2021-01-29 12:49:07 -06:00
Specify the file name. For example, `` --file auto_simulation_setting_echo.xml `` .
See details about file format at :ref: `simulation_setting` .
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
.. option :: --verbose
Show verbose log
2020-06-12 17:15:16 -05:00
2021-02-01 23:33:17 -06:00
read_openfpga_bitstream_setting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Read the XML file about bitstream settings (see details in :ref: `file_formats_bitstream_setting` )
.. option :: --file <string> or -f <string>
Specify the file name. For example, `` --file bitstream_setting.xml ``
.. option :: --verbose
Show verbose log
write_openfpga_bitstream_setting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write the OpenFPGA XML bitstream settings to a file
.. option :: --file <string> or -f <string>
Specify the file name. For example, `` --file auto_bitstream_setting_echo.xml `` .
See details about file format at :ref: `file_formats_bitstream_setting` .
.. option :: --verbose
Show verbose log
2020-06-12 17:15:16 -05:00
link_openfpga_arch
~~~~~~~~~~~~~~~~~~
Annotate the OpenFPGA architecture to VPR data base
2021-01-19 21:26:38 -06:00
.. option :: --activity_file <string>
2021-01-29 12:49:07 -06:00
Specify the signal activity file. For example, `` --activity_file counter.act `` .
This is required when users wants OpenFPGA to automatically find the number of clocks in simulations. See details at :ref: `simulation_setting` .
2021-01-19 21:26:38 -06:00
.. option :: --sort_gsb_chan_node_in_edges
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
Sort the edges for the routing tracks in General Switch Blocks (GSBs). Strongly recommand to turn this on for uniquifying the routing modules
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
.. option :: --verbose
Show verbose log
2020-06-12 17:15:16 -05:00
write_gsb_to_xml
~~~~~~~~~~~~~~~~
Write the internal structure of General Switch Blocks (GSBs) across a FPGA fabric, including the interconnection between the nodes and node-level details, to XML files
2021-01-19 21:26:38 -06:00
.. option :: --file <string> or -f <string>
Specify the output directory of the XML files. Each GSB will be written to an indepedent XML file
For example, `` --file /temp/gsb_output ``
2022-01-26 13:10:29 -06:00
.. option :: --unique
Only output unique GSBs to XML files
2021-01-19 21:26:38 -06:00
.. option :: --verbose
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
Show verbose log
2020-06-12 17:15:16 -05:00
.. note :: This command is used to help users to study the difference between GSBs
check_netlist_naming_conflict
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Check and correct any naming conflicts in the BLIF netlist
This is strongly recommended. Otherwise, the outputted Verilog netlists may not be compiled successfully.
.. warning :: This command may be deprecated in future when it is merged to VPR upstream
2021-01-19 21:26:38 -06:00
.. option :: --fix
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
Apply fix-up to the names that violate the syntax
.. option :: --report <string>
Report the naming fix-up to an XML-based log file. For example, `` --report rename.xml ``
2020-06-12 17:15:16 -05:00
pb_pin_fixup
~~~~~~~~~~~~
Apply fix-up to clustering nets based on routing results
This is strongly recommended. Otherwise, the bitstream generation may be wrong
.. warning :: This command may be deprecated in future when it is merged to VPR upstream
2021-01-19 21:26:38 -06:00
.. option :: --verbose
Show verbose log
2020-06-12 17:15:16 -05:00
lut_truth_table_fixup
~~~~~~~~~~~~~~~~~~~~~
Apply fix-up to Look-Up Table truth tables based on packing results
.. warning :: This command may be deprecated in future when it is merged to VPR upstream
2021-01-19 21:26:38 -06:00
.. option :: --verbose
Show verbose log
2020-06-12 17:15:16 -05:00
.. _cmd_build_fabric:
build_fabric
~~~~~~~~~~~~
Build the module graph.
2021-01-19 21:26:38 -06:00
.. option :: --compress_routing
Enable compression on routing architecture modules. Strongly recommend this as it will minimize the number of routing modules to be outputted. It can reduce the netlist size significantly.
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
.. option :: --duplicate_grid_pin
Enable pin duplication on grid modules. This is optional unless ultra-dense layout generation is needed
.. option :: --load_fabric_key <string>
Load an external fabric key from an XML file. For example, `` --load_fabric_key fpga_2x2.xml `` See details in :ref: `file_formats_fabric_key` .
2021-01-25 15:12:40 -06:00
.. option :: --generate_random_fabric_key
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
Generate a fabric key in a random way
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
.. option :: --write_fabric_key <string>.
2020-06-12 17:15:16 -05:00
2021-01-25 16:18:16 -06:00
Output current fabric key to an XML file. For example, `` --write_fabric_key fpga_2x2.xml `` See details in :ref: `file_formats_fabric_key` .
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
.. option :: --frame_view
Create only frame views of the module graph. When enabled, top-level module will not include any nets. This option is made for save runtime and memory.
2020-07-26 23:39:33 -05:00
.. warning :: Recommend to turn the option on when bitstream generation is the only purpose of the flow. Do not use it when you need generate netlists!
2021-01-19 21:26:38 -06:00
.. option :: --verbose
Show verbose log
2020-06-12 17:15:16 -05:00
.. note :: This is a must-run command before launching FPGA-Verilog, FPGA-Bitstream, FPGA-SDC and FPGA-SPICE
write_fabric_hierarchy
~~~~~~~~~~~~~~~~~~~~~~
Write the hierarchy of FPGA fabric graph to a plain-text file
2021-01-19 21:26:38 -06:00
.. option :: --file <string> or -f <string>
Specify the file name to write the hierarchy.
.. option :: --depth <int>
Specify at which depth of the fabric module graph should the writer stop outputting. The root module start from depth 0. For example, if you want a two-level hierarchy, you should specify depth as 1.
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
.. option :: --verbose
2020-06-12 17:15:16 -05:00
2021-01-19 21:26:38 -06:00
Show verbose log
2020-06-12 17:15:16 -05:00
.. note :: This file is designed for hierarchical PnR flow, which requires the tree of Multiple-Instanced-Blocks (MIBs).
2022-07-26 16:06:07 -05:00
2022-07-28 18:06:57 -05:00
.. _openfpga_setup_commands_write_fabric_io_info:
2022-07-26 16:06:07 -05:00
write_fabric_io_info
~~~~~~~~~~~~~~~~~~~~
Write the I/O information of FPGA fabric to an XML file
.. option :: --file <string> or -f <string>
Specify the file name to write the I/O information
.. option :: --no_time_stamp
Do not print time stamp in bitstream files
.. option :: --verbose
Show verbose log
.. note :: This file is designed for pin constraint file conversion.
2022-07-28 18:06:57 -05:00
pcf2place
~~~~~~~~~
2022-07-28 18:15:44 -05:00
Convert a Pin Constraint File (.pcf, see details in :ref: `file_format_pcf_file` ) to a `placement file <https://docs.verilogtorouting.org/en/latest/vpr/file_formats/#placement-file-format-place> `_ )
2022-07-28 18:06:57 -05:00
.. option :: --pcf <string>
Specify the path to the users' pin constraint file
.. option :: --blif <string>
Specify the path to the users' post-synthesis netlist
.. option :: --fpga_io_map <string>
Specify the path to the FPGA I/O location. Achieved by the command :ref: `openfpga_setup_commands_write_fabric_io_info`
.. option :: --pin_table <string>
Specify the path to the pin table file, which describes the pin mapping between chip I/Os to FPGA I/Os
.. option :: --fpga_fix_pins <string>
Specify the path to the placement file which will be outputted by running this command
.. option :: --no_time_stamp
Do not print time stamp in bitstream files
.. option :: --verbose
Show verbose log