OpenFPGA/docs/source/manual/file_formats/bus_group_file.rst

49 lines
1.1 KiB
ReStructuredText

.. _file_format_bus_group_file:
Bus Group File (.xml)
=====================
The bus group file aims to show
- How bus ports are flatten by EDA engines, e.g., synthesis.
- What are the pins in post-routing corresponding to the bus ports before synthesis
An example of file is shown as follows.
.. code-block:: xml
<bus_groups>
<bus name="i_addr" lsb="0" msb="3">
<pin id="0" name="i_addr_0_"/>
<pin id="1" name="i_addr_1_"/>
<pin id="2" name="i_addr_2_"/>
<pin id="3" name="i_addr_3_"/>
</bus>
</bus_groups>
Bus-related Syntax
------------------
.. option:: name="<string>"
The bus port name defined before synthesis.
.. option:: lsb="<int>"
The *Least Significant Bit* (LSB) of the bus
.. option:: msb="<int>"
The *Most Significant Bit* (MSB) of the bus
Pin-related Syntax
------------------
.. option:: id="<int>"
The index of the current pin in a bus port. The index must be the range of **[LSB, MSB-1]** that are defined in the bus.
.. option:: name="<string>"
The pin name after bus flatten in synthesis results