Initial commit

verilog/dv/cocotb/README.md

@@ -0,0 +1,43 @@
+Overview
+======== 
+This directory contain tests to verify the example user project 16 bit counter and 2 other simple tests as examples. 
+
+directory hierarchy
+=====================
+
+# counter_tests 
+ 
+contain tests for 16 bit counter for more info refer to [counter_tests](counter_tests/README.md)
+ 
+ # hello_world 
+ 
+ Example test with empty firmware that only power and reset caravel the print "Hello World" 
+ 
+ # hello_world_uart 
+ 
+ Example test That uses the firmware to send "Hello World" using UART TX 
+ 
+# cocotb_tests.py 
+
+Module that should import all the tests used to be seen for cocotb as a test
+
+ 
+Run tests 
+===========
+# run hello_world_uart
+    ```bash
+    caravel_cocotb -t hello_world_uart -tag hello_world 
+    ```
+# run all counter testlist
+    ```bash
+    caravel_cocotb -tl counter_tests/counter_tests.yaml -tag counter_tests 
+    ```
+# run from different directory
+    ```bash
+    caravel_cocotb -t hello_world_uart -tag hello_world -design_info <path to design_info.yaml>
+    ```      
+# run with changing the results directory
+    ```bash
+    caravel_cocotb -t hello_world_uart -tag hello_world -sim  <path to results directory>
+    ```  
+