# HLx Flow for DRAM DMA Example

## Table of Contents

1. [Overview](#overview)
2. [Setup HLx Environment](#env)
3. [Create Example Design (GUI)](#createbdgui)
4. [Create Example Design (Command line)](#createbd)
5. [Simulation](#sim)
6. [Changing Simulation Sources for Tests](#othersim)
7. [Implementing the Design](#impl)
8. [AFI Creation](#aficreation)
9. [CL Example Software and executing on F1](#swf1)

<a name="overview"></a>
### Overview

For more information about the cl_dram_dma example, read the following information [DRAM DMA CL Example](./../cl_dram_dma/README.md)

<a name="env"></a>
### Setup HLx Environment

* Clone the github and setup the HDK environment
   ```
   $ git clone https://github.com/aws/aws-fpga.git $AWS_FPGA_REPO_DIR
   $ cd $AWS_FPGA_REPO_DIR
   $ source hdk_setup.sh
   ```
* To setup the HLx Environment, run the following commands:
   ```
   $ mkdir -p ~/.Xilinx/Vivado
   $ echo 'source $::env(HDK_SHELL_DIR)/hlx/hlx_setup.tcl' >> ~/.Xilinx/Vivado/Vivado_init.tcl
   ```
   **NOTE**: *This modifies Vivado defaults, it is recommended you remove this if you wish to run non-HLx examples.* 
   
   For more information please see: [HLx Setup Instructions](../../../../hdk/docs/IPI_GUI_Vivado_Setup.md).

* You will also need to [setup AWS CLI and S3 Bucket](../../../../SDAccel/docs/Setup_AWS_CLI_and_S3_Bucket.md) to enable AFI creation

<a name="createbdgui"></a>
### Create Example Design (GUI)

* To launch Vivado GUI
   * Change directories to the cl/examples/cl_dram_dma_hlx directory
   * Invoke Vivado by typing `vivado` in the console
   * In the Vivado TCL Console, enter the following to configure the design
   ```
   set ::env(CLOCK_A_RECIPE) "0"
   set ::env(CLOCK_B_RECIPE) "0"
   set ::env(CLOCK_C_RECIPE) "0"
   set ::env(device_id) "0xF001"
   set ::env(vendor_id) "0x1D0F"
   set ::env(subsystem_id) "0x1D51"
   set ::env(subsystem_vendor_id) "0xFEDC"
   ```
   * In the Vivado TCL Console type in the following to create the cl_dram_dma example. The example will be generated in cl/examples/cl_dram_dma_hlx/example_projects. The vivado project is examples_projects/cl_dram_dma.xpr
   ```
   aws::make_rtl -examples cl_dram_dma
   ```

<a name="createbd"></a>
### Create Example Design (Command line)

* Alternatively, to run the Vivado GUI from command line (Linux only)
   * Make sure your $CL_DIR is pointing to the example directory. The following will generate the IPI Block Design (BD)
   ```
   $ cd $HDK_DIR/cl/examples/cl_dram_dma_hlx
   $ export CL_DIR=$(pwd)
   $ cd $CL_DIR/build/scripts
   $ ./aws_build_dcp_from_cl.sh -gui
   ```    
   **NOTE**: *The "-gui" switch is optional. It allows you to modify the example design, you will need to have a DISPLAY setup for the GUI to launch. To run the full creation and default implementation flow without the GUI, remove this switch.*

<a name="sim"></a>
### Simulation

* To launch simulation from within the Vivado GUI, 
   * Click on Simulation->Run Simulation->Run Behavioral Simulation
   * Add signals needed in the simulation
   * Type `run -all` in the TCL console

<a name="othersim"></a>
### Changing Simulation Sources for Tests

cl\_dram\_dma has several simulation sources that can be used for simulation (test\_ddr, test\_dram\_dma, test\_int, test\_peek\_poke, test\_peek\_poke\_pcis\_axsize).  

By default the test\_dram\_dma is used in the project. 

To switch tests:
* Right click on SIMULATION in the Project Manager
* Select Simulation Settings…
* For Verilog options select the … box and modify TEST\_NAME to test_null to disable sv stimulus
```
TEST_NAME=test_ddr
```
* Click OK
* Click Apply
* Click OK to go back into the Vivado project.

<a name="impl"></a>
### Implementing the Design

* To run implmentation from within the GUI is opened, in the Design Runs tab:
   * Right click on impl\_1 in the Design Runs tab and select Launch Runs…
   * Click OK in the Launch Runs Dialog Box.
   * Click OK in the Missing Synthesis Results Dialog Box

This will run both synthesis and implementation.

<a name="aficreation"></a>
### AFI Creation

The completed .tar file is located in: 
```
$CL_DIR/build/scripts/example_projects/cl_dram_dma.runs/faas_1/build/checkpoints/to_aws/<timestamp>.Developer_CL.tar  
```
For information on how to create AFI from this tar file, follow the [steps outlined here](../../../README.md#step3).

<a name="swf1"></a>
### CL Example Software and executing on F1

The runtime software must be compiled for the AFI to run on F1.

Use the software in cl/examples/cl\_dram\_dma
```
$ cd $HDK_DIR/cl/examples/cl_dram_dma/software/runtime/
$ make all
$ sudo ./test_dram_dma
```