Merge branch 'master' of https://github.com/vortexgpgpu/vortex-dev

Flubber_FPGA_Startup_Guide.md

@@ -1,6 +1,6 @@
 # Flubber FPGA Startup and Configuration Guide 
 
-Flubber OPAE setup
+OPAE environment setup
 ------------------
 
     $ source /opt/inteldevstack/init_env_user.sh
@@ -13,8 +13,18 @@ Flubber OPAE setup
     $ export PATH=:/opt/verilator/bin:$PATH
     $ export VERILATOR_ROOT=/opt/verilator
 
+OPAE Build Configuration
+------------------------
 
-Flubber OPAE build
+Within the /hw/syn/opae directory, there are source text files for each core-option for the fpga build (the 32 and 64 core options are not currently implemented) which have the following parameters that can be configured:
+- NUM_CORES: the number of cores per cluster
+- NUM_CLUSTERS: the number of clusters alotted to the processor
+- L3_ENABLE: enable the use of the L3 cache
+- PERF_ENABLE: enable the use of all profile counters
+
+To enable L3 cache and profile counters for a build, simply uncomment the definition within the respective source file.
+
+OPAE build
 ------------------
 
 The Flubber FPGA has to following configuration options:
@@ -23,29 +33,39 @@ The Flubber FPGA has to following configuration options:
 - 4 cores fpga (fpga-4c)
 - 8 cores fpga (fpga-8c)
 - 16 cores fpga (fpga-16c)
+
     $ cd hw/syn/opae
     $ make fpga-`# of cores`c
+
 Example: `make fpga-4c`
 
 A new folder *build_fpga_`# of cores`c* will be created and the build will start and take ~30-45 min to complete.
 
-Flubber Config Build Progress
------------------------------
+OPAE Build Progress
+-------------------
 
 You could check the last 10 lines in the build log for possible errors until build completion.
+
     $ tail -n 10 ./build_fpga_`# of cores`c/build.log
+
 Example: `tail -n 10 ./build_fpga_4c/build.log`
 
 Check if the build is still running by looking for quartus_sh, quartus_syn, or quartus_fit programs.
+
     $ ps -u `username`
 
+
 If the build fails and you need to restart it, clean up the build folder using the following command:
+
     $ make clean-fpga-`# of cores`c
+
 Example: `make clean-fpga-4c`
 
 The file `vortex_afu.gbs` should exist when the build is done:
+
     $ ls -lsa ./build_fpga_`# of cores`c/vortex_afu.gbs
 
+
 Signing the bitstream and Programming the FPGA
 ----------------------------------------------
 
@@ -57,12 +77,6 @@ FPGA sample test running OpenCL sgemm kernel
 --------------------------------------------
 
 Run the following from the Vortex root directory
+
     $ ./ci/blackbox.sh --driver=fpga --app=sgemm --args="-n64"
 
-Build Script Configuration
---------------------------
-
-Inside the ci folder there is a script called `blackbox.sh` which runs different tests on the Vortex processor with different configurations. Run:
-    $ ./ci/blackbox.sh --help
-To see the different configuration options available.
-The most important ones are `--driver`, which runs the Vortex test on either the fpga, rtlsim, vlsim, or simx simulators, and `--perf`, which enables the profiling counters for each core.