Add cocotb flow to caravel_user_project_analog and port the mprj_por test to cocotb

Author: M0stafaRady

verilog/dv/cocotb/.gitignore

@@ -0,0 +1,4 @@
+sim/ 
+*.log
+*.vcd 
+*.pyc

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>
+    ```  
+

verilog/dv/cocotb/cocotb_tests.py

@@ -0,0 +1,3 @@
+from hello_world.hello_world import hello_world
+from hello_world_uart.hello_world_uart import hello_world_uart
+from mprj_por.mprj_por import mprj_por

verilog/dv/cocotb/design_info.yaml

@@ -0,0 +1,9 @@
+CARAVEL_ROOT: <path to>/caravel
+MCW_ROOT: <path to>/litex
+PDK: sky130A
+PDK_ROOT: <path to>/pdk
+USER_PROJECT_ROOT: <path to>/caravel_user_project_analog/
+caravan: true
+clk: 25
+emailto:
+- null

verilog/dv/cocotb/hello_world/hello_world.c

@@ -0,0 +1,4 @@
+#include <firmware_apis.h>
+void main(){
+    return;
+}

verilog/dv/cocotb/hello_world/hello_world.py

@@ -0,0 +1,9 @@
+from caravel_cocotb.caravel_interfaces import test_configure
+from caravel_cocotb.caravel_interfaces import report_test
+import cocotb
+
+@cocotb.test()
+@report_test
+async def hello_world(dut):
+    caravelEnv = await test_configure(dut,timeout_cycles=9373)
+    cocotb.log.info("Hello World")

verilog/dv/cocotb/hello_world/hello_world.yaml

@@ -0,0 +1,11 @@
+---
+# Yalm file contain general design information that would mostly need to be updated in the first run only 
+# example 
+## tests: [debug,clock_redirect]
+## sim: [RTL,RTL]
+Tests: 
+    - {name: hello_world, sim: RTL}
+
+
+
+

verilog/dv/cocotb/hello_world_uart/hello_world_uart.c

@@ -0,0 +1,13 @@
+#include <firmware_apis.h>
+
+void main(){
+    ManagmentGpio_write(0);
+    ManagmentGpio_outputEnable();
+    GPIOs_configure(6,GPIO_MODE_MGMT_STD_OUTPUT);
+    GPIOs_loadConfigs();
+    UART_enableTX(1);
+    ManagmentGpio_write(1); // configuration finished 
+
+    print("Hello World\n");
+    return;
+}

verilog/dv/cocotb/hello_world_uart/hello_world_uart.py

@@ -0,0 +1,21 @@
+from caravel_cocotb.caravel_interfaces import test_configure
+from caravel_cocotb.caravel_interfaces import report_test
+import cocotb
+from caravel_cocotb.caravel_interfaces import UART
+
+@cocotb.test()
+@report_test
+async def hello_world_uart(dut):
+    caravelEnv = await test_configure(dut,timeout_cycles=3346140)
+
+    cocotb.log.info(f"[TEST] Start uart test")  
+    expected_msg = "Hello World"
+    uart = UART(caravelEnv)
+    # wait for start of sending
+    await caravelEnv.wait_mgmt_gpio(1)
+    # read the msg sent
+    msg = await uart.get_line()
+    if msg in expected_msg :
+        cocotb.log.info (f"[TEST] Pass recieve the full expected msg '{msg}'")
+    else: 
+        cocotb.log.error (f"[TEST] recieved wrong msg from uart msg recieved:'{msg}' expected '{expected_msg}'")

verilog/dv/cocotb/hello_world_uart/hello_world_uart.yaml

@@ -0,0 +1,7 @@
+---
+# Yalm file contain general design information that would mostly need to be updated in the first run only 
+
+Tests: 
+    - {name: hello_world_uart, sim: RTL}
+
+

verilog/dv/cocotb/mprj_por/mprj_por.c

@@ -0,0 +1,46 @@
+/*
+ * SPDX-FileCopyrightText: 2020 Efabless Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <firmware_apis.h>
+
+// --------------------------------------------------------
+
+void main()
+{
+    ManagmentGpio_write(0);
+    ManagmentGpio_outputEnable();
+    GPIOs_writeLow(0x00000000);
+    GPIOs_writeHigh(0x00000000);
+
+    // Configure mprj_io 10 and 25 as analog (digital in/out = off)
+    // Configure mprj_io 11, 12, 26, and 27 as digital output
+    // mprj_io 14 to 24 are analog pads and cannot be configured
+    GPIOs_configure(27, GPIO_MODE_USER_STD_OUTPUT);
+    GPIOs_configure(26, GPIO_MODE_USER_STD_OUTPUT);
+    GPIOs_configure(25, GPIO_MODE_USER_STD_ANALOG);
+
+    GPIOs_configure(12, GPIO_MODE_USER_STD_OUTPUT);
+    GPIOs_configure(11, GPIO_MODE_USER_STD_OUTPUT);
+    GPIOs_configure(10, GPIO_MODE_USER_STD_ANALOG);
+
+    GPIOs_loadConfigs();
+    ManagmentGpio_write(1); // finish configuration
+
+    /* Block until end of test */
+    while (1);
+}
+

verilog/dv/cocotb/mprj_por/mprj_por.py

@@ -0,0 +1,41 @@
+from caravel_cocotb.caravel_interfaces import test_configure
+from caravel_cocotb.caravel_interfaces import report_test
+import cocotb
+from cocotb.triggers import ClockCycles
+
+
+@cocotb.test()
+@report_test
+async def mprj_por(dut):
+    caravelEnv = await test_configure(dut,timeout_cycles=3346140)
+    # Power supply for POR
+    caravelEnv.drive_gpio_in(18, 0)
+    await caravelEnv.reset()
+    await cocotb.start(power_por(caravelEnv))
+    await wait_status(caravelEnv, "01")
+    check_bits = caravelEnv.monitor_discontinuous_gpios([27, 26, 12, 11])
+    if check_bits != "1001":
+        cocotb.log.error(f"[TEST] POR test failed expected 1001 got {check_bits}")
+    else: 
+        cocotb.log.info(f"[TEST] phase 1 passed seen 1001 at gpios 27 26 12 11")
+    await wait_status(caravelEnv, "11")
+    check_bits = caravelEnv.monitor_discontinuous_gpios([27, 26, 12, 11])
+    if check_bits != "0101":
+        cocotb.log.error(f"[TEST] POR test failed expected 0101 got {check_bits}")
+    else:
+        cocotb.log.info(f"[TEST] phase 2 passed seen 0101 at gpios 27 26 12 11")
+
+
+async def wait_status(caravelEnv, val_to_wait):
+    while True:
+        if caravelEnv.monitor_discontinuous_gpios([25, 10]) == val_to_wait:
+            break
+        await ClockCycles(caravelEnv.clk, 1)
+    await ClockCycles(caravelEnv.clk, 3)
+    
+
+
+async def power_por(caravelEnv):
+    await caravelEnv.wait_mgmt_gpio(1)  # wait  configuration finished
+    await ClockCycles(caravelEnv.clk, 10)
+    caravelEnv.drive_gpio_in(18, 1)

verilog/includes/includes.gl+sdf.caravel_user_project

@@ -0,0 +1,18 @@
+// SPDX-FileCopyrightText: 2020 Efabless Corporation
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// SPDX-License-Identifier: Apache-2.0
+
+// Caravel user project includes		
+$USER_PROJECT_VERILOG/gl/user_project_wrapper.v
+$USER_PROJECT_VERILOG/gl/user_proj_example.v

verilog/includes/includes.gl.caravel_user_project

@@ -0,0 +1,18 @@
+# SPDX-FileCopyrightText: 2020 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# SPDX-License-Identifier: Apache-2.0
+
+# Caravel user project includes	     
+-v $(USER_PROJECT_VERILOG)/gl/user_project_wrapper.v    
+-v $(USER_PROJECT_VERILOG)/gl/user_proj_example.v

verilog/includes/includes.rtl.caravel_user_project

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: 2020 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# SPDX-License-Identifier: Apache-2.0
+
+# Caravel user project includes
+-v $(USER_PROJECT_VERILOG)/rtl/example_por.v
+-v $(USER_PROJECT_VERILOG)/rtl/user_analog_proj_example.v
+-v $(USER_PROJECT_VERILOG)/rtl/user_analog_project_wrapper.v
+-v $(USER_PROJECT_VERILOG)/rtl/user_defines.v
+
+ 

verilog/rtl/user_analog_proj_example.v

@@ -15,8 +15,9 @@
 
 `default_nettype none
 
+`ifndef COCOTB_SIM
 `include "example_por.v"
-
+`endif
 /*
  * I/O mapping for analog
  *