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

[doc] add missing file

This commit is contained in:
tangxifan 2023-08-06 23:26:14 -07:00
parent d402d2322d
commit 4ed83cdb17
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/source/manual/file_formats/tile_config_file.rst Normal file
View File

@ -0,0 +1,39 @@
.. _file_formats_tile_config_file:
Tile Organization (.xml)
------------------------
The XML-based description language is used to describe how each tile is composed.
For example, what programmable blocks, connection blocks and switch blocks should be included.
Using the description language, users can customize the tiles of an FPGA fabric, as detailed as each component in each tile.
Under the root node ``<tiles>``, the detailes of tile organization can be described.
.. code-block:: xml
<tiles style="<string>"/>
</tiles>
Syntax
``````
Detailed syntax are presented as follows.
.. option:: style="<string>"
Specify the style of tile organization. Can be [``top_left`` | ``top_right`` | ``bottom_left`` | ``bottom_right`` | ``custom``]
.. warning:: Currently, only ``top_left`` is supported!
The ``top_left`` is a shortcut to define the organization for all the tiles. :numref:`fig_tile_style_top_left` shows an example of tiles in the top-left sytle, where the programmable block locates in the top-left corner of all the tiles, surrounded by two connection blocks and one switch blocks.
.. _fig_tile_style_top_left:
.. figure:: ./figures/tile_style_top_left.png
:width: 100%
:alt: An example of top-left style of tile
An example of top-left style of a tile in FPGA fabric