diff --git a/Dockerfile b/Dockerfile index 3df6669..e530380 100644 --- a/Dockerfile +++ b/Dockerfile @@ -70,6 +70,7 @@ RUN echo "echo \" |\_________\ \|__| \|__| \|__| \|_______|\|__|\|__|\| RUN echo "echo \" \|_________| \"" >> /home/stitchup/.bashrc USER root +RUN apt-get -y install doxygen RUN apt-get -y install software-properties-common RUN add-apt-repository -y ppa:ubuntu-toolchain-r/test RUN apt-get -y update diff --git a/README.txt b/README.txt index 3419f15..e12b0a1 100644 --- a/README.txt +++ b/README.txt @@ -11,17 +11,25 @@ StitchUp is a plugin to the LegUp High Level Synthesis tool that enables the gen Verison 1.0 : release date 06/06/2016 -##Docker file +-------------- Docker file --------------------- The fastest way to get up and running with StitchUp is to use docker. Make sure Docker is installed on your machine and type the following commands in the root directory of the project. docker build -t "stitchup_container" . docker run -ti stitchup_container /bin/bash -This will setup a container, install all the legup & stitchup required dependencies, builds legup, and patches in stitchup and builds it. +This will setup a container, install all the legup & stitchup required dependencies, download legup, build legup, and patch in stitchup. +--------------- Running example builds --------------------------- -##Running example builds +Examples are contained in the directory examples/. +To build one of the examples navigate to that directory and type make. +In the docker image the examples build a verilog file of the StitchUp protected circuit and an AXI wrapper for instantiating them in a Xilinx device. +The build script does not wrap all the components into an IP core for use in Vivado, however this is possible if the Xilinx build tools are installed. +--------------- Contact and about ------------------------- +Any queries about using the tool feel free to contact me at: shane.fleming06@imperial.ac.uk +Written by, Shane T. Fleming. + diff --git a/config/legup.tcl b/config/legup.tcl index e62918d..a5364ff 100644 --- a/config/legup.tcl +++ b/config/legup.tcl @@ -100,7 +100,7 @@ set_parameter LOCAL_RAMS 1 # Note: inferred RAMs don't support structs (no byte-enable) so having # structs in your program forces this parameter to turn off set_parameter INFERRED_RAMS 1 -#set_parameter INFERRED_RAM_FORMAT "xilinx" +set_parameter INFERRED_RAM_FORMAT "xilinx" # Place constant arrays into RAMs instead of the default read-only memory #set_parameter NO_ROMS 1 diff --git a/examples/chstone/adpcm/build b/examples/chstone/adpcm/build index 1b72f2e..09b51a8 100755 --- a/examples/chstone/adpcm/build +++ b/examples/chstone/adpcm/build @@ -12,5 +12,5 @@ rm adpcm.renamed.stitchedup.v make adpcm.wrapper.v make adpcm_tb.v #./runVsim -make adpcm.ipcore +#make adpcm.ipcore #make adpcm.system.bit diff --git a/examples/chstone/aes/build b/examples/chstone/aes/build index 69b4848..396037b 100755 --- a/examples/chstone/aes/build +++ b/examples/chstone/aes/build @@ -12,5 +12,5 @@ rm aes.renamed.stitchedup.v make aes.wrapper.v make aes_tb.v #./runVsim -make aes.ipcore +#make aes.ipcore #make aes.system.bit diff --git a/examples/chstone/blowfish/build b/examples/chstone/blowfish/build index e7f7035..01abc14 100755 --- a/examples/chstone/blowfish/build +++ b/examples/chstone/blowfish/build @@ -12,4 +12,4 @@ rm bf.renamed.stitchedup.v make bf.wrapper.v make bf_tb.v #./runVsim -make bf.ipcore +#make bf.ipcore diff --git a/examples/chstone/dfadd/build b/examples/chstone/dfadd/build index 4a72ee9..9167eb0 100755 --- a/examples/chstone/dfadd/build +++ b/examples/chstone/dfadd/build @@ -12,5 +12,5 @@ rm dfadd.renamed.stitchedup.v make dfadd.wrapper.v make dfadd_tb.v #./runVsim -make dfadd.ipcore +#make dfadd.ipcore #make dfadd.system.bit diff --git a/examples/chstone/dfdiv/build b/examples/chstone/dfdiv/build index a08c9e4..39cafc3 100755 --- a/examples/chstone/dfdiv/build +++ b/examples/chstone/dfdiv/build @@ -12,4 +12,4 @@ rm dfdiv.renamed.stitchedup.v make dfdiv.wrapper.v make dfdiv_tb.v #./runVsim -make dfdiv.ipcore +#make dfdiv.ipcore diff --git a/examples/chstone/dfmul/build b/examples/chstone/dfmul/build index 9a407fe..5d2ddf1 100755 --- a/examples/chstone/dfmul/build +++ b/examples/chstone/dfmul/build @@ -12,4 +12,4 @@ rm dfmul.renamed.stitchedup.v make dfmul.wrapper.v make dfmul_tb.v #./runVsim -make dfmul.ipcore +#make dfmul.ipcore diff --git a/examples/chstone/dfsin/build b/examples/chstone/dfsin/build index f732b99..629719a 100755 --- a/examples/chstone/dfsin/build +++ b/examples/chstone/dfsin/build @@ -12,4 +12,4 @@ rm dfsin.renamed.stitchedup.v make dfsin.wrapper.v make dfsin_tb.v #./runVsim -make dfsin.ipcore +#make dfsin.ipcore diff --git a/examples/chstone/gsm/build b/examples/chstone/gsm/build index 901a988..ff4c496 100755 --- a/examples/chstone/gsm/build +++ b/examples/chstone/gsm/build @@ -12,4 +12,4 @@ rm gsm.renamed.stitchedup.v make gsm.wrapper.v make gsm_tb.v #./runVsim -make gsm.ipcore +#make gsm.ipcore diff --git a/examples/chstone/jpeg/build b/examples/chstone/jpeg/build index d77dd4b..916eeb1 100755 --- a/examples/chstone/jpeg/build +++ b/examples/chstone/jpeg/build @@ -13,4 +13,4 @@ rm main.renamed.stitchedup.v make main.wrapper.v make main_tb.v #./runVsim -make main.ipcore +#make main.ipcore diff --git a/examples/chstone/mips/build b/examples/chstone/mips/build index 8e69e06..1a0c240 100755 --- a/examples/chstone/mips/build +++ b/examples/chstone/mips/build @@ -12,4 +12,4 @@ rm mips.renamed.stitchedup.v make mips.wrapper.v make mips_tb.v ./runVsim -make mips.ipcore +#make mips.ipcore diff --git a/examples/chstone/motion/build b/examples/chstone/motion/build index 4ffc2c1..dfa736c 100755 --- a/examples/chstone/motion/build +++ b/examples/chstone/motion/build @@ -12,4 +12,4 @@ rm mpeg2.renamed.stitchedup.v make mpeg2.wrapper.v make mpeg2_tb.v #./runVsim -make mpeg2.ipcore +#make mpeg2.ipcore diff --git a/examples/chstone/sha/build b/examples/chstone/sha/build index 75b3843..9bfd76f 100755 --- a/examples/chstone/sha/build +++ b/examples/chstone/sha/build @@ -12,4 +12,4 @@ rm sha_driver.renamed.stitchedup.v make sha_driver.wrapper.v make sha_driver_tb.v #./runVsim -make sha_driver.ipcore +#make sha_driver.ipcore