cocotb 1.9.2__cp311-cp311-win_amd64.whl → 2.0.0rc2__cp311-cp311-win_amd64.whl

cocotb/share/makefiles/simulators/Makefile.questa → cocotb_tools/makefiles/simulators/Makefile.questa-compat

@@ -1,33 +1,10 @@
-###############################################################################
 # Copyright (c) 2013, 2018 Potential Ventures Ltd
 # Copyright (c) 2013 SolarFlare Communications Inc
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#     * Redistributions of source code must retain the above copyright
-#       notice, this list of conditions and the following disclaimer.
-#     * Redistributions in binary form must reproduce the above copyright
-#       notice, this list of conditions and the following disclaimer in the
-#       documentation and/or other materials provided with the distribution.
-#     * Neither the name of Potential Ventures Ltd,
-#       SolarFlare Communications Inc nor the
-#       names of its contributors may be used to endorse or promote products
-#       derived from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
-# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-###############################################################################
-
-include $(shell cocotb-config --makefiles)/Makefile.inc
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# Questa compatibility flow using the vlog and vsim commands with the +acc
+# switch for design access.
 
 CMD_BIN := vsim
 
@@ -36,10 +13,7 @@ ifdef MODELSIM_BIN_DIR
 else
     # auto-detect bin dir from system path
     CMD := $(shell :; command -v $(CMD_BIN) 2>/dev/null)
-endif
-
-ifeq (, $(CMD))
-    $(error Unable to locate command >$(CMD_BIN)<)
+	MODELSIM_BIN_DIR := $(shell dirname $(CMD))
 endif
 
 ifdef RTL_LIBRARY
@@ -48,7 +22,7 @@ ifdef RTL_LIBRARY
 else
     TOPLEVEL_LIBRARY ?= work
 endif
-TOPLEVEL := "$(TOPLEVEL_LIBRARY).$(TOPLEVEL)"
+COCOTB_TOPLEVEL := "$(TOPLEVEL_LIBRARY).$(COCOTB_TOPLEVEL)"
 
 ifndef VLOG_ARGS
     VLOG_ARGS = -timescale $(COCOTB_HDL_TIMEUNIT)/$(COCOTB_HDL_TIMEPRECISION) -mfcu
@@ -73,14 +47,8 @@ else
     VSIM_ARGS += -onfinish exit
 endif
 
-FLI_LIB := $(shell cocotb-config --lib-name-path fli questa)
-# if this target is run, then cocotb did not build the library
-$(FLI_LIB):
-	@echo -e "ERROR: cocotb was not installed with an FLI library, as the mti.h header could not be located.\n\
-	If you installed an FLI-capable simulator after cocotb, you will need to reinstall cocotb.\n\
-	Please check the cocotb documentation on ModelSim support." >&2 && exit 1
-
-VHPI_LIB := $(shell cocotb-config --lib-name-path vhpi questa)
+FLI_LIB := $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path fli questa)
+VHPI_LIB := $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vhpi questa)
 
 GPI_EXTRA :=
 
@@ -99,13 +67,13 @@ else
     VSIM_ARGS += -voptargs="-access=rw+/." -foreign \"vhpi_startup_routines_bootstrap $(call to_tcl_path,$(VHPI_LIB))\"
 endif
 ifneq ($(VERILOG_SOURCES),)
-    GPI_EXTRA :=  $(shell cocotb-config --lib-name-path vpi questa):cocotbvpi_entry_point
+    GPI_EXTRA :=  $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vpi questa):cocotbvpi_entry_point
 endif
 
 else ifeq ($(TOPLEVEL_LANG),verilog)
-    VSIM_ARGS += -pli $(shell cocotb-config --lib-name-path vpi questa)
+    VSIM_ARGS += -pli $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vpi questa)
 ifneq ($(VHDL_SOURCES),)
-    GPI_EXTRA := $(shell cocotb-config --lib-name-path $(VHDL_GPI_INTERFACE) questa):cocotb$(VHDL_GPI_INTERFACE)_entry_point
+    GPI_EXTRA := $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path $(VHDL_GPI_INTERFACE) questa):cocotb$(VHDL_GPI_INTERFACE)_entry_point
 endif
 
 else
@@ -137,12 +105,12 @@ ifneq ($(VHDL_SOURCES),)
 	@echo "vcom -work $(TOPLEVEL_LIBRARY) $(VCOM_ARGS) $(call to_tcl_path,$(VHDL_SOURCES))" >> $@
 endif
 ifneq ($(VERILOG_SOURCES),)
-	@echo "vlog -work $(TOPLEVEL_LIBRARY) +define+COCOTB_SIM -sv $(VLOG_ARGS) $(EXTRA_ARGS) $(call to_tcl_path,$(VERILOG_SOURCES))" >> $@
+	@echo "vlog -work $(TOPLEVEL_LIBRARY) -sv $(VLOG_ARGS) $(EXTRA_ARGS) $(call to_tcl_path,$(VERILOG_SOURCES))" >> $@
 endif
 ifdef SCRIPT_FILE
 	@echo "do $(SCRIPT_FILE)" >> $@
 endif
-	@echo "vsim $(VSIM_ARGS) $(EXTRA_ARGS) $(PLUSARGS) $(TOPLEVEL)" >> $@
+	@echo "vsim $(VSIM_ARGS) $(EXTRA_ARGS) $(call deprecate,PLUSARGS,COCOTB_PLUSARGS) $(COCOTB_TOPLEVEL)" >> $@
 ifeq ($(WAVES),1)
 	@echo "log -recursive /*" >> $@
 endif
@@ -161,11 +129,15 @@ endif
 $(COCOTB_RESULTS_FILE): $(SIM_BUILD)/runsim.do
 	$(RM) $(COCOTB_RESULTS_FILE)
 
-	set -o pipefail; MODULE=$(MODULE) TESTCASE=$(TESTCASE) TOPLEVEL=$(TOPLEVEL) \
-	GPI_EXTRA=$(GPI_EXTRA) TOPLEVEL_LANG=$(TOPLEVEL_LANG) \
-	$(SIM_CMD_PREFIX) $(CMD) $(RUN_ARGS) -do $(SIM_BUILD)/runsim.do $(PLUSARGS) $(SIM_CMD_SUFFIX)
-
-	$(call check_for_results_file)
-
-clean::
-	$(RM) -r $(SIM_BUILD)
+	set -o pipefail; \
+	  COCOTB_TEST_MODULES=$(call deprecate,MODULE,COCOTB_TEST_MODULES) \
+	  COCOTB_TESTCASE=$(call deprecate,TESTCASE,COCOTB_TESTCASE) \
+	  COCOTB_TEST_FILTER=$(COCOTB_TEST_FILTER) \
+	  COCOTB_TOPLEVEL=$(call deprecate,TOPLEVEL,COCOTB_TOPLEVEL) \
+	  GPI_EXTRA=$(GPI_EXTRA) \
+	  TOPLEVEL_LANG=$(TOPLEVEL_LANG) \
+	  VHDL_GPI_INTERFACE=$(VHDL_GPI_INTERFACE) \
+	  COCOTB__QUESTA_MODE=compat \
+	$(SIM_CMD_PREFIX) $(CMD) $(RUN_ARGS) -do $(SIM_BUILD)/runsim.do $(call deprecate,PLUSARGS,COCOTB_PLUSARGS) $(SIM_CMD_SUFFIX)
+
+	$(call check_results)

cocotb_tools/makefiles/simulators/Makefile.questa-qisqrun

@@ -0,0 +1,149 @@
+# Copyright cocotb contributors
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+# Questa QIS/Qrun flow using the Questa Information System (QIS) for design
+# access and qrun to build and run the simulation.
+
+QRUN_BIN := qrun
+VIS_BIN := vis
+
+ifdef MODELSIM_BIN_DIR
+    QRUN_CMD := $(shell :; command -v $(MODELSIM_BIN_DIR)/$(QRUN_BIN) 2>/dev/null)
+    VIS_CMD := $(shell :; command -v $(MODELSIM_BIN_DIR)/$(VIS_BIN) 2>/dev/null)
+else
+    # auto-detect bin dir from system path
+    QRUN_CMD := $(shell :; command -v $(QRUN_BIN) 2>/dev/null)
+    VIS_CMD := $(shell :; command -v $(VIS_BIN) 2>/dev/null)
+endif
+
+ifeq (,$(QRUN_CMD))
+    $(error Unable to locate command >$(QRUN_BIN)<)
+endif
+ifeq (,$(VIS_CMD))
+    $(error Unable to locate command >$(VIS_BIN)<)
+endif
+
+DESIGNFILE ?= design.bin
+WAVEFILE ?= qwave.db
+TOPLEVEL_LIBRARY ?= work
+COCOTB_TOPLEVEL := "$(TOPLEVEL_LIBRARY).$(COCOTB_TOPLEVEL)"
+
+
+ifndef VLOG_ARGS
+    VLOG_ARGS = -timescale $(COCOTB_HDL_TIMEUNIT)/$(COCOTB_HDL_TIMEPRECISION) -mfcu
+endif
+
+ifdef VERILOG_INCLUDE_DIRS
+    VLOG_ARGS += $(addprefix +incdir+, $(VERILOG_INCLUDE_DIRS))
+endif
+
+# below allows for maintaining legacy syntax as well as enables using cross-simulator vars COMPILE_ARGS/SIM_ARGS
+VLOG_ARGS += $(COMPILE_ARGS)
+VCOM_ARGS +=
+VOPT_ARGS += -access=rw+/.
+VSIM_ARGS += $(SIM_ARGS)
+
+ifdef GUI
+    # Run in GUI mode.
+
+    # Two modes are supported:
+    # - GUI=livesim: Open the Visualizer GUI before running the simulation.
+    #   GUI=1 is a backwards-compatible alias for livesim.
+    # - GUI=postsim: Open the Visualizer GUI after the simulation has finished.
+
+    ifeq ($(filter livesim postsim 1,$(GUI)),)
+        $(error A valid value (livesim, postsim, or 1) was not provided for GUI=$(GUI))
+    endif
+
+    # Map GUI=1 to GUI=livesim.
+    ifeq ($(GUI),1)
+        GUI := livesim
+    endif
+
+    VOPT_ARGS += -designfile $(DESIGNFILE)
+    VSIM_ARGS += -onfinish stop -qwavedb=+signal+memory=all+class+assertion+uvm_schematic+msg+wavefile=$(WAVEFILE)
+
+    ifeq ($(GUI),livesim)
+        QRUN_CMD += -gui -visualizer
+        VOPT_ARGS += -debug,livesim
+    endif
+
+    # For GUI=postsim Visualizer is called in the $(COCOTB_RESULTS_FILE) target.
+else
+    # Run in batch mode (no GUI).
+    QRUN_CMD += -c
+    VSIM_ARGS += -onfinish exit
+endif # ifdef GUI
+
+FLI_LIB := $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path fli questa)
+VHPI_LIB := $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vhpi questa)
+GPI_EXTRA :=
+
+VHDL_GPI_INTERFACE ?= fli
+
+ifeq ($(filter vhpi fli,$(VHDL_GPI_INTERFACE)),)
+    $(error A valid value (fli or vhpi) was not provided for VHDL_GPI_INTERFACE=$(VHDL_GPI_INTERFACE))
+endif
+
+ifeq ($(TOPLEVEL_LANG),vhdl)
+    VSIM_ARGS += -t $(COCOTB_HDL_TIMEPRECISION)
+ifeq ($(VHDL_GPI_INTERFACE),fli)
+    CUSTOM_COMPILE_DEPS += $(FLI_LIB)
+    VSIM_ARGS += -foreign "cocotb_init $(FLI_LIB)"
+else
+    VSIM_ARGS += -foreign "vhpi_startup_routines_bootstrap $(call to_tcl_path,$(VHPI_LIB))"
+endif
+ifneq ($(VERILOG_SOURCES),)
+    GPI_EXTRA :=  $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vpi questa):cocotbvpi_entry_point
+endif
+
+else ifeq ($(TOPLEVEL_LANG),verilog)
+    VSIM_ARGS += -pli $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vpi questa)
+ifneq ($(VHDL_SOURCES),)
+    GPI_EXTRA := $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path $(VHDL_GPI_INTERFACE) questa):cocotb$(VHDL_GPI_INTERFACE)_entry_point
+endif
+
+else
+    $(error A valid value (verilog or vhdl) was not provided for TOPLEVEL_LANG=$(TOPLEVEL_LANG))
+endif
+
+ifdef SCRIPT_FILE
+    VSIM_ARGS += -do $(SCRIPT_FILE)
+endif
+
+ifeq ($(PYTHON_ARCH),64bit)
+    QRUN_CMD += -64
+endif
+
+define make_lib
+  -makelib $(LIB) $(VHDL_SOURCES_$(LIB)) -end
+endef
+
+$(COCOTB_RESULTS_FILE):
+	# Make sure all libs in SOURCES_VHDL_* are mentioned in VHDL_LIB_ORDER and vice versa
+	$(foreach LIB, $(VHDL_LIB_ORDER), $(check_vhdl_sources))
+	$(foreach SOURCES_VAR, $(filter VHDL_SOURCES_%, $(.VARIABLES)), $(check_lib_order))
+
+	$(RM) $(COCOTB_RESULTS_FILE)
+	mkdir -p $(SIM_BUILD)
+
+	set -o pipefail; \
+	  COCOTB_TEST_MODULES=$(COCOTB_TEST_MODULES) \
+	  COCOTB_TESTCASE=$(COCOTB_TESTCASE) \
+	  COCOTB_TEST_FILTER=$(COCOTB_TEST_FILTER) \
+	  COCOTB_TOPLEVEL=$(COCOTB_TOPLEVEL) \
+	  GPI_EXTRA=$(GPI_EXTRA) TOPLEVEL_LANG=$(TOPLEVEL_LANG) \
+	  VHDL_GPI_INTERFACE=$(VHDL_GPI_INTERFACE) \
+	  COCOTB__QUESTA_MODE=qisqrun \
+	  $(SIM_CMD_PREFIX) $(QRUN_CMD) $(RUN_ARGS) -outdir $(SIM_BUILD) \
+	  $(foreach LIB, $(VHDL_LIB_ORDER), $(make_lib)) \
+	  -makelib $(TOPLEVEL_LIBRARY) $(VERILOG_SOURCES) $(VHDL_SOURCES) $(VLOG_ARGS) $(VCOM_ARGS) -end \
+	  $(VOPT_ARGS) $(VSIM_ARGS) $(EXTRA_ARGS) $(COCOTB_PLUSARGS) -sv \
+	  -top $(COCOTB_TOPLEVEL) 2>&1 | tee $(SIM_BUILD)/sim.log
+
+ifeq ($(GUI),postsim)
+	$(VIS_CMD) -designfile $(DESIGNFILE) -wavefile $(WAVEFILE)
+endif
+
+	$(call check_results)

{cocotb/share → cocotb_tools}/makefiles/simulators/Makefile.riviera

@@ -1,36 +1,11 @@
-###############################################################################
+# Copyright cocotb contributors
 # Copyright (c) 2013 Potential Ventures Ltd
 # Copyright (c) 2013 SolarFlare Communications Inc
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#     * Redistributions of source code must retain the above copyright
-#       notice, this list of conditions and the following disclaimer.
-#     * Redistributions in binary form must reproduce the above copyright
-#       notice, this list of conditions and the following disclaimer in the
-#       documentation and/or other materials provided with the distribution.
-#     * Neither the name of Potential Ventures Ltd,
-#       SolarFlare Communications Inc nor the
-#       names of its contributors may be used to endorse or promote products
-#       derived from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL POTENTIAL VENTURES LTD BE LIABLE FOR ANY
-# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-###############################################################################
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
 
 # Common Makefile for Aldec Riviera-PRO simulator
 
-include $(shell cocotb-config --makefiles)/Makefile.inc
-
 ifeq ($(GUI),1)
     CMD_BIN := riviera
 else
@@ -42,13 +17,7 @@ ifdef ALDEC_BIN_DIR
 else
     # auto-detect bin dir from system path
     CMD := $(shell :; command -v $(CMD_BIN) 2>/dev/null)
-endif
-
-ifeq (, $(CMD))
-    $(error Unable to locate command >$(CMD_BIN)<)
-else
-    ALDEC_BIN_DIR := $(shell dirname $(CMD))
-    export ALDEC_BIN_DIR
+	ALDEC_BIN_DIR := $(shell dirname $(CMD))
 endif
 
 ifeq ($(GUI),1)
@@ -67,9 +36,7 @@ ACOM_ARGS += $(COMPILE_ARGS)
 ASIM_ARGS += $(SIM_ARGS)
 
 # Plusargs need to be passed to ASIM command not vsimsa
-ASIM_ARGS += $(PLUSARGS)
-
-ALOG_ARGS += +define+COCOTB_SIM
+ASIM_ARGS += $(call deprecate,PLUSARGS,COCOTB_PLUSARGS)
 
 ifdef RTL_LIBRARY
     $(warning Using RTL_LIBRARY is deprecated, please use TOPLEVEL_LIBRARY instead.)
@@ -79,7 +46,7 @@ else
 endif
 
 # Pass the VPI library to the Verilog compilation to get extended checking.
-ALOG_ARGS += -pli $(shell cocotb-config --lib-name-path vpi riviera)
+ALOG_ARGS += -pli $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vpi riviera)
 
 # Aldec-specific coverage types:
 # - (s)tatement
@@ -91,7 +58,7 @@ ALOG_ARGS += -pli $(shell cocotb-config --lib-name-path vpi riviera)
 # - finite state (m)achine
 # Documentation: Riviera Pro 2017.02 Documentation - Page 359
 COVERAGE_TYPES ?= sb
-ifeq ($(COVERAGE),1)
+ifeq ($(COCOTB_USER_COVERAGE),1)
     ALOG_ARGS += -dbg -coverage $(COVERAGE_TYPES)
     ACOM_ARGS += -dbg -coverage $(COVERAGE_TYPES)
 
@@ -100,15 +67,15 @@ endif
 
 GPI_EXTRA:=
 ifeq ($(TOPLEVEL_LANG),verilog)
-    GPI_ARGS = -pli $(shell cocotb-config --lib-name-path vpi riviera)
+    GPI_ARGS = -pli $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vpi riviera)
 ifneq ($(VHDL_SOURCES),)
-    GPI_EXTRA = $(shell cocotb-config --lib-name-path vhpi riviera):cocotbvhpi_entry_point
+    GPI_EXTRA = $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vhpi riviera):cocotbvhpi_entry_point
 endif
 
 else ifeq ($(TOPLEVEL_LANG),vhdl)
-    GPI_ARGS = -loadvhpi $(shell cocotb-config --lib-name-path vhpi riviera):vhpi_startup_routines_bootstrap
+    GPI_ARGS = -loadvhpi $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vhpi riviera):vhpi_startup_routines_bootstrap
 ifneq ($(VERILOG_SOURCES),)
-    GPI_EXTRA = $(shell cocotb-config --lib-name-path vpi riviera):cocotbvpi_entry_point
+    GPI_EXTRA = $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vpi riviera):cocotbvpi_entry_point
 endif
 
 else
@@ -119,7 +86,7 @@ define make_lib
   echo "if [file exists $(SIM_BUILD)/$(LIB)] {adel -lib $(SIM_BUILD)/$(LIB) -all}" >> $@;
   echo "alib $(SIM_BUILD)/$(LIB)" >> $@;
   echo "amap $(LIB) $(SIM_BUILD)/$(LIB)" >> $@;
-  echo "acom -work $(LIB) $(VCOM_ARGS) $(call to_tcl_path,$(VHDL_SOURCES_$(LIB)))" >> $@;
+  echo "acom -work $(LIB) $(ACOM_ARGS) $(call to_tcl_path,$(VHDL_SOURCES_$(LIB)))" >> $@;
 endef
 
 # Create a TCL script based on the list of $(VERILOG_SOURCES)
@@ -133,7 +100,7 @@ $(SIM_BUILD)/runsim.tcl : $(VERILOG_SOURCES) $(VHDL_SOURCES) | $(SIM_BUILD)
 	@echo "@if [string length [array get env LICENSE_QUEUE]] {" >> $@
 	@echo " set LICENSE_QUEUE $$::env(LICENSE_QUEUE)" >> $@
 	@echo "}" >> $@
-	@echo "if [file exists $(SIM_BUILD)/$(TOPLEVEL_LIBRARY)] {adel -lib $(SIM_BUILD)/$(TOPLEVEL_LIBRARY) -all}" >> $@;
+	@echo "if [file exists $(SIM_BUILD)/$(TOPLEVEL_LIBRARY)] {adel -lib $(SIM_BUILD)/$(TOPLEVEL_LIBRARYRTL_LIBRARY) -all}" >> $@;
 	@echo "alib $(SIM_BUILD)/$(TOPLEVEL_LIBRARY)" >> $@
 	@echo "amap $(TOPLEVEL_LIBRARY) $(SIM_BUILD)/$(TOPLEVEL_LIBRARY)" >> $@;
 	@echo "set worklib $(TOPLEVEL_LIBRARY)" >> $@;
@@ -149,7 +116,7 @@ endif
 ifneq ($(CFG_TOPLEVEL),)
 	@echo "asim $(ASIM_ARGS) +access +w_nets -interceptcoutput $(GPI_ARGS) $(CFG_TOPLEVEL) $(EXTRA_TOPS)" >> $@
 else
-	@echo "asim $(ASIM_ARGS) +access +w_nets -interceptcoutput $(GPI_ARGS) $(TOPLEVEL) $(EXTRA_TOPS)" >> $@
+	@echo "asim $(ASIM_ARGS) +access +w_nets -interceptcoutput $(GPI_ARGS) $(COCOTB_TOPLEVEL) $(EXTRA_TOPS)" >> $@
 endif
 ifeq ($(WAVES),1)
 	@echo "log -recursive *" >> $@
@@ -159,7 +126,7 @@ ifeq ($(GUI),1)
 else
 	@echo "run -all" >> $@
 	@echo "endsim" >> $@
-ifeq ($(COVERAGE),1)
+ifeq ($(COCOTB_USER_COVERAGE),1)
 	@echo "acdb report -cov $(COVERAGE_TYPES) -db $(TOPLEVEL_LIBRARY).acdb -html -o coverage/acdb_report.html" >> $@
 	@echo "acdb report -cov $(COVERAGE_TYPES) -db $(TOPLEVEL_LIBRARY).acdb -txt -o coverage/acdb_report.txt" >> $@
 endif
@@ -172,12 +139,6 @@ $(COCOTB_RESULTS_FILE): $(SIM_BUILD)/runsim.tcl $(CUSTOM_COMPILE_DEPS) $(CUSTOM_
 	$(RM) $(COCOTB_RESULTS_FILE)
 
 	set -o pipefail; GPI_EXTRA=$(GPI_EXTRA) TOPLEVEL_LANG=$(TOPLEVEL_LANG) \
-	MODULE=$(MODULE) TESTCASE=$(TESTCASE) TOPLEVEL=$(TOPLEVEL) $(SIM_CMD_PREFIX) $(CMD) $(RUN_ARGS) -do $(SIM_BUILD)/runsim.tcl $(SIM_CMD_SUFFIX)
-
-	$(call check_for_results_file)
+	COCOTB_TEST_MODULES=$(call deprecate,MODULE,COCOTB_TEST_MODULES) COCOTB_TESTCASE=$(call deprecate,TESTCASE,COCOTB_TESTCASE) COCOTB_TEST_FILTER=$(COCOTB_TEST_FILTER) COCOTB_TOPLEVEL=$(call deprecate,TOPLEVEL,COCOTB_TOPLEVEL) $(SIM_CMD_PREFIX) $(CMD) $(RUN_ARGS) -do $(SIM_BUILD)/runsim.tcl $(SIM_CMD_SUFFIX)
 
-clean::
-	$(RM) -r $(SIM_BUILD)
-	$(RM) -r compile
-	$(RM) -r library.cfg
-	$(RM) -r dataset.asdb
+	$(call check_results)

cocotb_tools/makefiles/simulators/Makefile.vcs

@@ -0,0 +1,65 @@
+# Copyright cocotb contributors
+# Copyright (c) 2013 Potential Ventures Ltd
+# Copyright (c) 2013 SolarFlare Communications Inc
+# Licensed under the Revised BSD License, see LICENSE for details.
+# SPDX-License-Identifier: BSD-3-Clause
+
+ifneq ($(VHDL_SOURCES),)
+
+$(COCOTB_RESULTS_FILE):
+	@echo "Skipping simulation as VHDL is not supported on simulator=$(SIM)"
+
+else
+
+CMD_BIN := vcs
+
+ifdef VCS_BIN_DIR
+    CMD := $(shell :; command -v $(VCS_BIN_DIR)/$(CMD_BIN) 2>/dev/null)
+else
+    # auto-detect bin dir from system path
+    CMD := $(shell :; command -v $(CMD_BIN) 2>/dev/null)
+    VCS_BIN_DIR := $(shell dirname $(CMD))
+endif
+
+ifdef VERILOG_INCLUDE_DIRS
+    COMPILE_ARGS += $(addprefix +incdir+, $(VERILOG_INCLUDE_DIRS))
+endif
+
+ifeq ($(PYTHON_ARCH),64bit)
+    COMPILE_ARGS += -full64
+endif
+
+ifeq ($(GUI),1)
+    EXTRA_ARGS += -gui -kdb
+endif
+
+# Avoid linker "undefined reference to" error
+COMPILE_ARGS += -LDFLAGS -Wl,--no-as-needed
+
+# Enables globally access for read, write, and callback capabilities.
+COMPILE_ARGS += +acc+3
+
+# Enables globally debug capabilities.
+COMPILE_ARGS += -debug_access+all
+
+# TODO:
+# investigate +vpi+1 option which reduces memory requirements
+
+# Compilation phase
+$(SIM_BUILD)/simv: $(VERILOG_SOURCES) $(CUSTOM_COMPILE_DEPS) | $(SIM_BUILD)
+	cd $(SIM_BUILD) && \
+	COCOTB_TOPLEVEL=$(call deprecate,TOPLEVEL,COCOTB_TOPLEVEL) \
+	$(CMD) -top $(COCOTB_TOPLEVEL) $(call deprecate,PLUSARGS,COCOTB_PLUSARGS) -sverilog \
+	-timescale=$(COCOTB_HDL_TIMEUNIT)/$(COCOTB_HDL_TIMEPRECISION) \
+	$(EXTRA_ARGS) -load $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-name-path vpi vcs) $(COMPILE_ARGS) $(VERILOG_SOURCES)
+
+# Execution phase
+$(COCOTB_RESULTS_FILE): $(SIM_BUILD)/simv $(CUSTOM_SIM_DEPS)
+	$(RM) $(COCOTB_RESULTS_FILE)
+
+	COCOTB_TEST_MODULES=$(call deprecate,MODULE,COCOTB_TEST_MODULES) COCOTB_TESTCASE=$(call deprecate,TESTCASE,COCOTB_TESTCASE) COCOTB_TEST_FILTER=$(COCOTB_TEST_FILTER) COCOTB_TOPLEVEL=$(call deprecate,TOPLEVEL,COCOTB_TOPLEVEL) TOPLEVEL_LANG=$(TOPLEVEL_LANG) \
+	$(SIM_CMD_PREFIX) $(SIM_BUILD)/simv $(SIM_ARGS) $(EXTRA_ARGS) $(call deprecate,PLUSARGS,COCOTB_PLUSARGS) $(SIM_CMD_SUFFIX)
+
+	$(call check_results)
+
+endif

{cocotb/share → cocotb_tools}/makefiles/simulators/Makefile.verilator

@@ -4,14 +4,11 @@
 
 TOPLEVEL_LANG ?= verilog
 
-include $(shell cocotb-config --makefiles)/Makefile.inc
-
 ifneq ($(or $(filter-out $(TOPLEVEL_LANG),verilog),$(VHDL_SOURCES)),)
 
 results.xml:
 	@echo "Skipping simulation as only Verilog is supported on simulator=$(SIM)"
 debug: results.xml
-clean::
 
 else
 
@@ -22,28 +19,25 @@ ifdef VERILATOR_BIN_DIR
 else
   # auto-detect bin dir from system path
   CMD := $(shell :; command -v $(CMD_BIN) 2>/dev/null)
+  VERILATOR_BIN_DIR := $(shell dirname $(CMD))
 endif
 
-ifeq (, $(CMD))
-  $(error Unable to locate command >$(CMD_BIN)<)
-endif
-
-VLT_MIN := 4.106
+VLT_MIN := 5.036
 VLT_VERSION := $(shell $(CMD) --version | cut -d " " -f 2)
 MIN_VERSION := $(shell printf "%s\n%s\n" "$(VLT_MIN)" "$(VLT_VERSION)" | sort -g | head -1)
 ifneq ($(MIN_VERSION),$(VLT_MIN))
   $(error cocotb requires Verilator $(VLT_MIN) or later, but using $(VLT_VERSION))
 endif
 
-ifdef TOPLEVEL
-  TOPMODULE_ARG := --top-module $(TOPLEVEL)
+ifdef COCOTB_TOPLEVEL
+  TOPMODULE_ARG := --top-module $(COCOTB_TOPLEVEL)
 else
   TOPMODULE_ARG :=
 endif
 
 ifeq ($(VERILATOR_SIM_DEBUG), 1)
-  COMPILE_ARGS += --debug -CFLAGS "-DVL_DEBUG -DVERILATOR_SIM_DEBUG -g"
-  PLUSARGS += +verilator+debug
+  COMPILE_ARGS += --debug -CFLAGS "-DVL_DEBUG -DVERILATOR_SIM_DEBUG -g -Og"
+  DEBUG = +verilator+debug
   BUILD_ARGS += OPT_FAST=-Og OPT_SLOW=-Og OPT_GLOBAL=-Og
 endif
 
@@ -54,14 +48,17 @@ endif
 
 COMPILE_ARGS += --timescale $(COCOTB_HDL_TIMEUNIT)/$(COCOTB_HDL_TIMEPRECISION)
 
-COMPILE_ARGS += --vpi --public-flat-rw --prefix Vtop -o Vtop -LDFLAGS "-Wl,-rpath,$(shell cocotb-config --lib-dir) -L$(shell cocotb-config --lib-dir) -lcocotbvpi_verilator"
+_COCOTB_LIB_DIR = $(shell $(PYTHON_BIN) -m cocotb_tools.config --lib-dir)
+COMPILE_ARGS += --vpi --public-flat-rw --prefix Vtop -o Vtop -LDFLAGS "-Wl,-rpath,$(_COCOTB_LIB_DIR) -L$(_COCOTB_LIB_DIR) -lcocotbvpi_verilator"
 
 ifdef VERILOG_INCLUDE_DIRS
   COMPILE_ARGS += $(addprefix +incdir+, $(VERILOG_INCLUDE_DIRS))
 endif
 
-$(SIM_BUILD)/Vtop.mk: $(VERILOG_SOURCES) $(CUSTOM_COMPILE_DEPS) $(COCOTB_SHARE_DIR)/lib/verilator/verilator.cpp | $(SIM_BUILD)
-	$(CMD) -cc --exe -Mdir $(SIM_BUILD) -DCOCOTB_SIM=1 $(TOPMODULE_ARG) $(COMPILE_ARGS) $(EXTRA_ARGS) $(VERILOG_SOURCES) $(COCOTB_SHARE_DIR)/lib/verilator/verilator.cpp
+VERILATOR_CPP := $(shell $(PYTHON_BIN) -m cocotb_tools.config --share)/lib/verilator/verilator.cpp
+
+$(SIM_BUILD)/Vtop.mk: $(VERILOG_SOURCES) $(CUSTOM_COMPILE_DEPS) $(VERILATOR_CPP) | $(SIM_BUILD)
+	$(CMD) -cc --exe -Mdir $(SIM_BUILD) $(TOPMODULE_ARG) $(COMPILE_ARGS) $(EXTRA_ARGS) $(VERILOG_SOURCES) $(VERILATOR_CPP)
 
 # Compilation phase
 $(SIM_BUILD)/Vtop: $(SIM_BUILD)/Vtop.mk
@@ -70,17 +67,13 @@ $(SIM_BUILD)/Vtop: $(SIM_BUILD)/Vtop.mk
 $(COCOTB_RESULTS_FILE): $(SIM_BUILD)/Vtop $(CUSTOM_SIM_DEPS)
 	$(RM) $(COCOTB_RESULTS_FILE)
 
-	MODULE=$(MODULE) TESTCASE=$(TESTCASE) TOPLEVEL=$(TOPLEVEL) TOPLEVEL_LANG=$(TOPLEVEL_LANG) \
-        $(SIM_CMD_PREFIX) $< $(SIM_ARGS) $(EXTRA_ARGS) $(PLUSARGS) $(SIM_CMD_SUFFIX)
+	-COCOTB_TEST_MODULES=$(call deprecate,MODULE,COCOTB_TEST_MODULES) COCOTB_TESTCASE=$(call deprecate,TESTCASE,COCOTB_TESTCASE) COCOTB_TEST_FILTER=$(COCOTB_TEST_FILTER) COCOTB_TOPLEVEL=$(call deprecate,TOPLEVEL,COCOTB_TOPLEVEL) TOPLEVEL_LANG=$(TOPLEVEL_LANG) \
+        $(SIM_CMD_PREFIX) $< $(SIM_ARGS) $(EXTRA_ARGS) $(call deprecate,PLUSARGS,COCOTB_PLUSARGS) $(DEBUG) $(SIM_CMD_SUFFIX)
 
-	$(call check_for_results_file)
+	$(call check_results)
 
 debug:
 	$(MAKE) VERILATOR_SIM_DEBUG=1 SIM_CMD_PREFIX="gdb --args" $(COCOTB_RESULTS_FILE)
 
-clean::
-	$(RM) -r $(SIM_BUILD)
-	$(RM) dump.vcd
-	$(RM) dump.fst
 
 endif