riscv
/
OpenFPGA
mirror of https://github.com/lnis-uofu/OpenFPGA.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update doc to fix format problem; add frame_view to doc

This commit is contained in:
tangxifan 2020-07-26 22:39:33 -06:00
parent 177de90822
commit 872a35fc60
2 changed files with 30 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/source/manual/fpga_bitstream/fabric_dependent_bitstream.rst
View File

@ -20,11 +20,11 @@ The information depends on the type of configuration procotol.
.. option:: vanilla .. option:: vanilla
A line consisting of ``0``|``1`` A line consisting of ``0`` | ``1``
.. option:: scan_chain .. option:: scan_chain
A line consisting of ``0``|``1`` A line consisting of ``0`` | ``1``
.. option:: memory_bank .. option:: memory_bank
@ -34,7 +34,7 @@ The information depends on the type of configuration procotol.
The second line represents the Word-Line address and configuration bit. The second line represents the Word-Line address and configuration bit.
For example For example
.. code_block:: .. code_block:: xml
<bitline_address> <bit_value> <bitline_address> <bit_value>
<wordline_address> <bit_value> <wordline_address> <bit_value>
@ -45,10 +45,11 @@ The information depends on the type of configuration procotol.
<wordline_address> <bit_value> <wordline_address> <bit_value>
.. option:: frame_based .. option:: frame_based
Multiple lines will be included, each of which is organized as <address><space><bit>. Multiple lines will be included, each of which is organized as <address><space><bit>.
For example For example
.. code_block:: .. code_block:: xml
<frame_address> <bit_value> <frame_address> <bit_value>
<frame_address> <bit_value> <frame_address> <bit_value>
@ -98,17 +99,17 @@ Other information may depend on the type of configuration procotol.
.. code_block:: xml .. code_block:: xml
<bit id="0" value="1"> <bit id="0" value="1">
<hierarchy> <hierarchy>
<instance level="0" name="fpga_top"/> <instance level="0" name="fpga_top"/>
<instance level="1" name="grid_io_bottom_1__0_"/> <instance level="1" name="grid_io_bottom_1__0_"/>
<instance level="2" name="logical_tile_io_mode_io__0"/> <instance level="2" name="logical_tile_io_mode_io__0"/>
<instance level="3" name="logical_tile_io_mode_physical__iopad_0"/> <instance level="3" name="logical_tile_io_mode_physical__iopad_0"/>
<instance level="4" name="iopad_sram_blwl_mem"/> <instance level="4" name="iopad_sram_blwl_mem"/>
</hierarchy> </hierarchy>
<bl address="000000"/> <bl address="000000"/>
<wl address="000000"/> <wl address="000000"/>
</bit> </bit>
.. option:: frame_based .. option:: frame_based
@ -118,13 +119,13 @@ Other information may depend on the type of configuration procotol.
.. code_block:: xml .. code_block:: xml
<bit id="0" value="1"> <bit id="0" value="1">
<hierarchy> <hierarchy>
<instance level="0" name="fpga_top"/> <instance level="0" name="fpga_top"/>
<instance level="1" name="grid_io_bottom_1__0_"/> <instance level="1" name="grid_io_bottom_1__0_"/>
<instance level="2" name="logical_tile_io_mode_io__0"/> <instance level="2" name="logical_tile_io_mode_io__0"/>
<instance level="3" name="logical_tile_io_mode_physical__iopad_0"/> <instance level="3" name="logical_tile_io_mode_physical__iopad_0"/>
<instance level="4" name="iopad_config_latch_mem"/> <instance level="4" name="iopad_config_latch_mem"/>
</hierarchy> </hierarchy>
<frame address="0000000000000000"/> <frame address="0000000000000000"/>
</bit> </bit>

4
docs/source/manual/openfpga_shell/openfpga_commands/setup_commands.rst
View File

@ -109,6 +109,10 @@ build_fabric
- ``--write_fabric_key <xml_file>`` Output current fabric key to an XML file - ``--write_fabric_key <xml_file>`` Output current fabric key to an XML file
- ``--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.
.. 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!
- ``--verbose`` Show verbose log - ``--verbose`` Show verbose log
.. note:: This is a must-run command before launching FPGA-Verilog, FPGA-Bitstream, FPGA-SDC and FPGA-SPICE .. note:: This is a must-run command before launching FPGA-Verilog, FPGA-Bitstream, FPGA-SDC and FPGA-SPICE