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

[doc] update doc for module rename assistant

This commit is contained in:
tangxifan 2023-09-22 19:36:01 -07:00
parent 0a94763422
commit c3443a288c
3 changed files with 61 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/manual/utilities/fabric_key_assistant.rst
View File

@ -8,7 +8,7 @@ Note that crafting a fabric key is not an easy task for engineers, as its comple
This tool is developed to assist engineers when finalizing fabric key files.
It can apply sanity checks on hand-crafted fabric key files, helping engineers to correct and debug.
The tool can be found at ``/build/libs/libfabrickey/test/fabric_key_assistant``
The tool can be found at ``/build/libs/libfabrickey/fabric_key_assistant``
The tool includes the following options:

2
docs/source/manual/utilities/index.rst
View File

@ -11,3 +11,5 @@ OpenFPGA contains a number of utility tools to help users to craft files.
:maxdepth: 2
fabric_key_assistant
module_rename_assistant

58
docs/source/manual/utilities/module_rename_assistant.rst Normal file
View File

@ -0,0 +1,58 @@
.. _utility_module_rename_assistant:
Module Rename Assistant
-----------------------
Module Rename Assistant is a tool to help users to craft module name files (see details in :ref:`file_formats_module_naming_files`).
This tool is useful to adapt module naming from a fabric to another, considering the two fabrics share the same building blocks, i.e., tile, routing blocks *etc.*
For example, when engineers craft a module naming file for a fabric ``A``, and would like to migrate the module naming rules for anthor fabric ``B``, module naming rules have to be adapted due to the changes on default names of building blocks.
The tool can be found at ``/build/libs/libnamemanager/module_rename_assistant``
The tool includes the following options:
.. option:: --reference_fabricA_names <string>
Specifiy a reference module name file for fabric A. This is typically generated by OpenFPGA through the commmand :ref:`openfpga_setup_commands_write_module_naming_rules`. The reference fabric key file is treated as the baseline, on which the renamed module file will be compared to.
.. option:: --renamed_fabricA_names <string>
Specify the hand-crafted module name file for fabric A, which is typically hand-crafted by users.
.. option:: --reference_fabricB_names <string>
Specifiy a reference module name file for fabric B. This is typically generated by OpenFPGA through the commmand :ref:`openfpga_setup_commands_write_module_naming_rules`. The reference fabric key file is treated as the baseline, on which the renamed module file will be compared to.
.. option:: --output <string>
Specify the renamed module name file for fabric B to be outputted. For example, the fabric A contains reference names:
.. code-block:: xml
<module_name default="tile_1__1_" given="tile_4_"/>
while the renamed module for fabric A includes:
.. code-block:: xml
<module_name default="tile_1__1_" given="tile_big"/>
the fabric B shares the same given name ``tile_4_`` but in a different default name.
.. code-block:: xml
<module_name default="tile_2__2_" given="tile_4_"/>
the resulting output renamed module file includes:
.. code-block:: xml
<module_name default="tile_2__2_" given="tile_big"/>
.. option:: --verbose
To enable verbose output
.. option:: --help
Show help desk