HW: Adding documentation for integration of HLS actions
@@ -83,11 +83,15 @@ which defaults to `1` if not set differently.
An example for an action together with a corresponding wrapper may be found
in `$DONUT_HARDWARE_ROOT/action_examples/memcopy`.
+## HLS Actions
+You'll find examples for HLS actions in `$DONUT_HARDWARE_ROOT/action_examples`. For each example the HLS kernel to be integrated into the SNAP framework is contained in a file `kernel.cpp`. Before initiating the SNAP framework's make process you need to create the necessary RTL files (VHDL or Verilog) out of the `kernel.cpp` file. A `Makefile` that takes care of this is contained in each example. In order to make sure that the resulting top level entity fits into the SNAP framework the HLS kernel's top level function needs to be named `hls_action`. All RTL files generated by the example's make process will be placed into a subdirectory `vhdl` (or `verilog`). The environment variable `$ACTION_ROOT` needs to point to that directory when initiating the SNAP framework's make process.
-# DDR3 Card Memory
+***Note*** that for the integration of HLS actions into the SNAP framework the `$ACTION_ROOT` directory name needs to contain the term `HLS` (case doesn't matter) or the environment variable `$HLS_SUPPORT` needs to be defined and to be set to `TRUE` (case doesn't matter).
+
+# DRAM Card Memory
The SNAP framework supports the usage of the on-card DRAM. It is accessible for the actions via the action wrapper
-through an AXI master interface. The existence of that interface is configurable via the environment variable `DDR3_USED`.
+through an AXI master interface. The existence of that interface is configurable via the environment variable `SDRAM_USED`.
When setting
```bash
@@ -154,7 +158,7 @@ Please refer to `$DONUT_HARDWARE_ROOT/Makefile` for more supported targets like
# Simulation
-You may kick off simulation from within subdirectory sim using the script run_sim.
+You may kick off simulation from within the subdirectory sim using the script run_sim.
For the memcopy example (`ACTION_ROOT=$DONUT_HARDWARE_ROOT/action_examples/memcopy`) call:
```bash
