Reorg cleanup

README.md

@@ -56,9 +56,11 @@
 
 ## How to simulate
 
+Scripts are located in the './scripts' directory.
+
 ```sh
 ./scripts/build.sh gpio/dv/dut_gpio.v         # compile gpio testbench (example)
-./scripts/sim.sh gpio/dv/tests/test_basic.emf # run a simulation with "test_regs.emf"
+./scripts/sim.sh gpio/dv/tests/test_basic.emf # run "test_basic.emf" test
 ./scripts/view.sh                             # open the waveform with gtkwave
 ```
 
@@ -68,13 +70,14 @@
 * Runs test $name/dv/tests/test_basic.emf
 
 ```sh
-./run.sh accelerator
-./run.sh elink
-./run.sh emailbox
-./run.sh emmu
-./run.sh gpio
-./run.sh spi
-./run.sh pic
+./run.sh accelerator  # Run accelerator simulation
+./run.sh elink        # Run elink simulation
+./run.sh emailbox     # Run emailbox simulation
+./run.sh emmu         # Run emmu simulation
+./run.sh gpio         # Run gpio simulation
+./run.sh mio          # run mio simulation
+./run.sh spi          # Run spi simulation
+./run.sh pic          # Run pic simulation
 ```
 
 ----

run.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 
-./build.sh $1/dv/dut_$1.v
-./sim.sh $1/dv/tests/test_basic.emf
+./scripts/build.sh src/$1/dv/dut_$1.v
+./scripts/sim.sh src/$1/dv/tests/test_basic.emf
 

scripts/build.sh

@@ -2,9 +2,11 @@
 
 ############################################################################
 # Icarus Verilog build script for OH! 
+#
 # Requires $OH_HOME variable to be set
-# Input argument should be the "device under test". In general this 
-# would be something like "elink/hdl/dut_elink.v"
+#
+# Example: ./scripts/build.sh elink/hdl/dut_elink.v
+#
 ############################################################################
 
 DUT=$1
@@ -12,17 +14,8 @@ DUT=$1
 ##############################
 #Create directory of all links
 ##############################
-if [ -d "symlinks" ]
-then
-    rm -r symlinks
-fi
-mkdir -p $OH_HOME/symlinks/hdl
-mkdir -p $OH_HOME/symlinks/dv
-pushd $OH_HOME/symlinks/hdl > /dev/null
-ln -s ../../*/hdl/*.{v,vh} .
-cd ../dv
-ln -s ../../*/dv/*.v .
-popd > /dev/null
+$OH_HOME/scripts/link.sh
+
 ##############################
 #Build
 ###############################

scripts/build_all.sh

@@ -6,7 +6,7 @@ list=(accelerator elink emailbox emmu gpio mio pic spi)
 for dut in ${list[*]}
 do
     echo "**Building $dut"
-    ./build.sh $dut/dv/dut_$dut.v
+    $OH_HOME/scripts/build.sh $OH_HOME/src/$dut/dv/dut_$dut.v
 done
 cd ../
 

scripts/link.sh

@@ -10,8 +10,8 @@ fi
 mkdir -p $OH_HOME/symlinks/hdl
 mkdir -p $OH_HOME/symlinks/dv
 pushd $OH_HOME/symlinks/hdl > /dev/null
-ln -s ../../*/hdl/*.{v,vh} .
+ln -s ../../src/*/hdl/*.{v,vh} .
 cd ../dv
-ln -s ../../*/dv/*.v .
+ln -s ../../src/*/dv/*.v .
 popd > /dev/null
 

src/chip/README.md

@@ -10,8 +10,8 @@ This folder contains a recommended reference flow for implementing chips using O
 * [Signoff](signoff/README.md)
 
 ## Other Resources
-* [Glossary](docs/glossary.md)
-* [Constants](docs/constants.md)
+* [Glossary](../../docs/chip_glossary.md)
+* [Constants](../../docs/chip_constants.md)
 
 ## Required Shell Variables