Skip to content

Commit 5f5086c

Browse files
author
Ed-5100
committed
doc: added floorplan dse doc
1 parent 9fc6ba8 commit 5f5086c

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ those contributing to or extending the TAPA framework itself.
5858
tutorial/mini_example
5959
tutorial/realworld_example
6060
tutorial/custom_rtl
61+
tutorial/floorplan_dse_compile
6162

6263
.. toctree::
6364
:caption: Reference
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
Run Tapa Projects With Floorplan DSE
2+
====================================
3+
4+
.. note::
5+
6+
In this tutorial, we explore how to compile a tapa project with floorplan
7+
design space exploration (DSE) and add pipeline to the project.
8+
9+
Example: Compile Autosa with Floorplan DSE
10+
------------------------------------------
11+
12+
The following example demonstrates how to compile a TAPA project with floorplan DSE.
13+
You can use the `tapa generate-floorplan` command to run the floorplan DSE and get floorplan
14+
solutions.
15+
16+
.. code-block:: bash
17+
18+
tapa generate-floorplan \
19+
-f tapa/src/kernel_kernel.cpp \
20+
-t kernel0 \
21+
--device-config device_config.json \
22+
--floorplan-config floorplan_config.json \
23+
--clock-period 3.00 \
24+
--part-num xcu55c-fsvh2892-2L-e
25+
26+
After generating the floorplan solutions, you can compile the project with a specific
27+
floorplan solution with the `tapa compile` command by specifying the `--floorplan-path` option.
28+
The application will be reorganized according to the floorplan solution, and pipeline
29+
will be added.
30+
31+
.. code-block:: bash
32+
33+
tapa compile \
34+
-f tapa/src/kernel_kernel.cpp \
35+
-t kernel0 \
36+
--device-config device_config.json \
37+
--floorplan-path floorplan_0.json \
38+
--clock-period 3.00 \
39+
--part-num xcu55c-fsvh2892-2L-e
40+
41+
Alternatively, you can use the `tapa compile-with-floorplan-dse` command to compile the project
42+
with floorplan DSE directly. This command will automatically run the floorplan DSE, compile,
43+
and add pipeline to the project for each floorplan solution generated.
44+
45+
.. code-block:: bash
46+
47+
tapa compile-with-floorplan-dse \
48+
-f tapa/src/kernel_kernel.cpp \
49+
-t kernel0 \
50+
--device-config device_config.json \
51+
--floorplan-config floorplan_config.json \
52+
--clock-period 3.00 \
53+
--part-num xcu55c-fsvh2892-2L-e

0 commit comments

Comments
 (0)