diff --git a/docs/source/manual/file_formats/bus_group_file.rst b/docs/source/manual/file_formats/bus_group_file.rst new file mode 100644 index 000000000..499db8900 --- /dev/null +++ b/docs/source/manual/file_formats/bus_group_file.rst @@ -0,0 +1,48 @@ +.. _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-related Syntax +------------------ + +.. option:: name="" + + The bus port name defined before synthesis. + +.. option:: lsb="" + + The *Least Significant Bit* (LSB) of the bus + +.. option:: msb="" + + The *Most Significant Bit* (MSB) of the bus + +Pin-related Syntax +------------------ + +.. option:: id="" + + 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="" + + The pin name after bus flatten in synthesis results diff --git a/docs/source/manual/file_formats/index.rst b/docs/source/manual/file_formats/index.rst index 7ed213012..c00f46b6b 100644 --- a/docs/source/manual/file_formats/index.rst +++ b/docs/source/manual/file_formats/index.rst @@ -25,3 +25,5 @@ OpenFPGA widely uses XML format for interchangable files io_mapping_file bitstream_distribution_file + + bus_group_file