Skip to content

Commit 0298a69

Browse files
Add LibArchFPGA tab to doxygen generated docs
1 parent 6d3a21d commit 0298a69

File tree

7 files changed

+91
-16
lines changed

7 files changed

+91
-16
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
========
2+
Grid Specification Types
3+
========
4+
5+
These types are used to capture user's intended architecture specification and will be later turned into a flattened device grid according to the device's size.
6+
7+
.. doxygenstruct:: t_grid_loc_spec
8+
:project: vpr
9+
:members:
10+
11+
.. doxygenstruct:: t_grid_loc_def
12+
:project: vpr
13+
:members:
14+

doc/src/api/libarchfpga/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _libarchfpga:
2+
3+
LIBARCHFPGA
4+
=======
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
physical_types
10+
grid_types
11+
scatter_gather_types
12+
interposer_types
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
========
2+
Interposer Types
3+
========
4+
5+
These types are used to store information about interposer based architectures.
6+
7+
.. doxygenstruct:: t_interposer_cut_inf
8+
:project: vpr
9+
:members:
10+
11+
.. doxygenstruct:: t_interdie_wire_inf
12+
:project: vpr
13+
:members:
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
========
2+
Physical Types
3+
========
4+
5+
These types are used to capture user's intended architecture specification and will be later turned into a flattened device grid according to the device's size.
6+
7+
.. doxygenstruct:: t_arch
8+
:project: vpr
9+
:members:
10+
11+
.. doxygenstruct:: t_arch_switch_inf
12+
:project: vpr
13+
:members:
14+
15+
.. doxygenstruct:: t_segment_inf
16+
:project: vpr
17+
:members:
18+
19+
.. doxygenstruct:: t_physical_tile_loc
20+
:project: vpr
21+
:members:
22+
23+
.. doxygenstruct:: t_sub_tile
24+
:project: vpr
25+
:members:
26+
27+
.. doxygenstruct:: t_layer_def
28+
:project: vpr
29+
:members:
30+
31+
.. doxygenstruct:: t_grid_def
32+
:project: vpr
33+
:members:
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
========
2+
Scatter-Gather Types
3+
========
4+
5+
These types store information about about scatter-gather patterns
6+
7+
.. doxygenstruct:: t_scatter_gather_pattern
8+
:project: vpr
9+
:members:
10+
11+
.. doxygenstruct:: t_sg_link
12+
:project: vpr
13+
:members:
14+
15+
.. doxygenstruct:: t_sg_location
16+
:project: vpr
17+
:members:

doc/src/api/vpr/grid.rst

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,4 @@ DeviceGrid
77

88
.. doxygenclass:: DeviceGrid
99
:project: vpr
10-
:members:
11-
12-
-------
13-
Grid Specification Types
14-
-------
15-
16-
These types are used to capture user's intended architecture specification and will be later turned into a flattened device grid according to the device's size.
17-
18-
.. doxygenstruct:: t_grid_loc_spec
19-
:project: vpr
20-
:members:
21-
22-
.. doxygenstruct:: t_grid_loc_def
23-
:project: vpr
24-
:members:
25-
10+
:members:

doc/src/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ For more specific documentation about VPR see :ref:`vpr`.
6464
api/vtrutil/index
6565
api/ezgl/index
6666
api/vprinternals/index
67+
api/libarchfpga/index
6768

6869
Indices and tables
6970
==================

0 commit comments

Comments
 (0)