Skip to content

Commit 1dc487a

Browse files
committed
Adding main NoC datastructures to the VPR internals documentation
1 parent 49fb237 commit 1dc487a

File tree

8 files changed

+65
-0
lines changed

8 files changed

+65
-0
lines changed

doc/src/api/vprinternals/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ VPR INTERNALS
99
draw_structs
1010
vpr_ui
1111
draw_files
12+
vpr_noc
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
==============
2+
NoC Data Types
3+
==============
4+
5+
Types
6+
-----
7+
.. doxygenfile:: noc_data_types.h
8+
:project: vpr
9+
:sections: typedef

doc/src/api/vprinternals/noc_link.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
========
2+
NoC Link
3+
========
4+
5+
NocLink
6+
-------
7+
.. doxygenfile:: noc_link.h
8+
:project: vpr
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
==========
2+
NoC Router
3+
==========
4+
5+
NocRouter
6+
---------
7+
.. doxygenfile:: noc_router.h
8+
:project: vpr
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
===========
2+
NoC Routing
3+
===========
4+
5+
NocRouting
6+
---------------
7+
.. doxygenfile:: noc_routing.h
8+
:project: vpr
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
===========
2+
NoC Storage
3+
===========
4+
5+
NocStorage
6+
----------
7+
.. doxygenfile:: noc_storage.h
8+
:project: vpr
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=================
2+
NoC Traffic Flows
3+
=================
4+
5+
NocTrafficFlows
6+
---------------
7+
.. doxygenfile:: noc_traffic_flows.h
8+
:project: vpr

doc/src/api/vprinternals/vpr_noc.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _noc:
2+
3+
=======
4+
VPR NoC
5+
=======
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
noc_router
11+
noc_link
12+
noc_storage
13+
noc_traffic_flows
14+
noc_routing
15+
noc_data_types

0 commit comments

Comments
 (0)