Update how to run cocotb tests documention and add SPDX-FileCopyright…

…Text to cocotb files
efabless · Aug 10, 2023 · f81d9f7 · f81d9f7
1 parent a848e3a
commit f81d9f7
Show file tree

Hide file tree

Showing 12 changed files with 171 additions and 13 deletions.
diff --git a/verilog/dv/cocotb/README.md b/verilog/dv/cocotb/README.md
@@ -2,12 +2,18 @@ Overview
 ======== 
 This directory contain tests to verify the example user project 16 bit counter and 2 other simple tests as examples. 
 
+Prerequisites
+==============
+
+- ```bash pip install caravel-cocotb```
+- update design_info.yaml
+
 directory hierarchy
 =====================
 
-# counter_tests 
- 
-contain tests for 16 bit counter for more info refer to [counter_tests](counter_tests/README.md)
+# mprj_por 
+
+Example test for the PoR user project example 
 
  # hello_world 
 
@@ -24,14 +30,15 @@ Module that should import all the tests used to be seen for cocotb as a test
 
 Run tests 
 ===========
-# run hello_world_uart
+# run mprj_por
     ```bash
-    caravel_cocotb -t hello_world_uart -tag hello_world 
+    caravel_cocotb -t mprj_por -tag mprj_por_run 
     ```
-# run all counter testlist
+# run hello_world_uart
     ```bash
-    caravel_cocotb -tl counter_tests/counter_tests.yaml -tag counter_tests 
+    caravel_cocotb -t hello_world_uart -tag hello_world 
     ```
+
 # run from different directory
     ```bash
     caravel_cocotb -t hello_world_uart -tag hello_world -design_info <path to design_info.yaml>
@@ -40,4 +47,3 @@ Run tests
     ```bash
     caravel_cocotb -t hello_world_uart -tag hello_world -sim  <path to results directory>
     ```  
-
diff --git a/verilog/dv/cocotb/cocotb_tests.py b/verilog/dv/cocotb/cocotb_tests.py
@@ -1,3 +1,20 @@
+# 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
+
+
 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
diff --git a/verilog/dv/cocotb/design_info.yaml b/verilog/dv/cocotb/design_info.yaml
@@ -1,3 +1,19 @@
+# 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_ROOT: <path to>/caravel
 MCW_ROOT: <path to>/litex
 PDK: sky130A

diff --git a/verilog/dv/cocotb/hello_world/hello_world.c b/verilog/dv/cocotb/hello_world/hello_world.c
@@ -1,3 +1,21 @@
+// 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(){
     return;

diff --git a/verilog/dv/cocotb/hello_world/hello_world.py b/verilog/dv/cocotb/hello_world/hello_world.py
@@ -1,3 +1,20 @@
+# 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
+
+
 from caravel_cocotb.caravel_interfaces import test_configure
 from caravel_cocotb.caravel_interfaces import report_test
 import cocotb

diff --git a/verilog/dv/cocotb/hello_world/hello_world.yaml b/verilog/dv/cocotb/hello_world/hello_world.yaml
@@ -1,4 +1,21 @@
----
+# 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
+
+
+
 # Yalm file contain general design information that would mostly need to be updated in the first run only 
 # example 
 ## tests: [debug,clock_redirect]

diff --git a/verilog/dv/cocotb/hello_world_uart/hello_world_uart.c b/verilog/dv/cocotb/hello_world_uart/hello_world_uart.c
@@ -1,3 +1,20 @@
+// 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(){

diff --git a/verilog/dv/cocotb/hello_world_uart/hello_world_uart.py b/verilog/dv/cocotb/hello_world_uart/hello_world_uart.py
@@ -1,3 +1,20 @@
+# 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
+
+
 from caravel_cocotb.caravel_interfaces import test_configure
 from caravel_cocotb.caravel_interfaces import report_test
 import cocotb

diff --git a/verilog/dv/cocotb/hello_world_uart/hello_world_uart.yaml b/verilog/dv/cocotb/hello_world_uart/hello_world_uart.yaml
@@ -1,4 +1,21 @@
----
+# 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
+
+
+
 # Yalm file contain general design information that would mostly need to be updated in the first run only 
 
 Tests: 

diff --git a/verilog/dv/cocotb/mprj_por/mprj_por.c b/verilog/dv/cocotb/mprj_por/mprj_por.c
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2020 Efabless Corporation
+ * SPDX-FileCopyrightText: 2023 Efabless Corporation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/verilog/dv/cocotb/mprj_por/mprj_por.py b/verilog/dv/cocotb/mprj_por/mprj_por.py
@@ -1,3 +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
+
 from caravel_cocotb.caravel_interfaces import test_configure
 from caravel_cocotb.caravel_interfaces import report_test
 import cocotb

diff --git a/verilog/dv/mprj_por/Makefile b/verilog/dv/mprj_por/Makefile
@@ -19,6 +19,7 @@ PDK_PATH = $(PDK_ROOT)/$(PDK)
 
 ## Caravel Pointers
 CARAVEL_ROOT ?= ../../../caravel
+MCW_ROOT ?= ../../../caravel_mgmt_soc_litex
 CARAVEL_PATH ?= $(CARAVEL_ROOT)
 CARAVEL_FIRMWARE_PATH = $(CARAVEL_PATH)/verilog/dv/caravel
 CARAVEL_VERILOG_PATH  = $(CARAVEL_PATH)/verilog
@@ -31,7 +32,7 @@ UPRJ_RTL_PATH = $(UPRJ_VERILOG_PATH)/rtl
 UPRJ_BEHAVIOURAL_MODELS = ../
 
 ## RISCV GCC 
-GCC_PATH?=/ef/apps/bin
+GCC_PATH?=/opt/riscv/bin
 GCC_PREFIX?=riscv32-unknown-elf
 
 ## Simulation mode: RTL/GL
@@ -50,7 +51,7 @@ hex:  ${PATTERN:=.hex}
 ifeq ($(SIM),RTL)
 	iverilog $(SIM_DEFINES) -I $(PDK_PATH) \
 	-I $(CARAVEL_BEHAVIOURAL_MODELS) -I $(CARAVEL_RTL_PATH) \
-	-I $(UPRJ_BEHAVIOURAL_MODELS)    -I $(UPRJ_RTL_PATH) \
+	-I $(UPRJ_BEHAVIOURAL_MODELS)    -I $(UPRJ_RTL_PATH) -I $(MCW_ROOT)/verilog/rtl \
 	$< -o $@ 
 else  
 	iverilog $(SIM_DEFINES) -DGL -I $(PDK_PATH) \