[chip, gpio, sw] Adding Verilator as an option to .cmake

The motivation of this PR comes from #382 which is adding a
chip level GPIO smoke test. That test fails on verilator.
Reason being different tops used for different platforms (
DVSim(Xcelium), Verilator, FPGA). For Xcelium, an interface
is connecting the UVM to the GPIO. UVM has the control to
drive GPIOs inputs. In #382, SW waits for a specific pattern
driven by UVM to arrive in data_in reg. If we run the exact
test with the verilator top, which is using GPIO DPI, then
the abilty to drive inputs depends on a host SW
infrastructure which is currently missing.

Second problem is that we use cmake to build software images
for DVSim, verilator and FPGA. We run tests on FPGA and
Verilator in CI. If the build system develops an Xcelium
compatible image and feed that image to Verilator and FPGA
to execute the test in CI then the test will fail due to the
reason given in the first paragraph.

Hence, the best way forward is to make images only for the
compatible paltforms.

Signed-off-by: Kinza Qamar <kqzaman@lowrisc.org>

Author: KinzaQamar

sw/cmake/tests.cmake

@@ -59,7 +59,7 @@ set(ARCHS_FLAGS           VANILLA_FLAGS       CHERI_FLAGS ) # Flags
 # the output executable name and all of the libraries it is linked against.
 macro(mocha_add_test)
     # parse arguments
-    set(options FPGA)
+    set(options FPGA VERILATOR)
     set(one_value_args NAME)
     set(multi_value_args SOURCES LIBRARIES)
     cmake_parse_arguments(arg "${options}"
@@ -83,7 +83,7 @@ macro(mocha_add_test)
         # create artefacts
         mocha_add_executable_artefacts(${NAME})
 
-        if(SIM)
+        if(SIM AND arg_VERILATOR)
           mocha_add_verilator_test(${NAME})
         endif()
 

sw/device/tests/CMakeLists.txt

@@ -4,20 +4,30 @@
 
 set(LIBS hal runtime startup test_framework)
 
-mocha_add_test(NAME test_framework_test SOURCES test_framework/smoketest.c LIBRARIES ${LIBS} FPGA)
-mocha_add_test(NAME test_framework_exception_test SOURCES test_framework/exception.c LIBRARIES ${LIBS})
-mocha_add_test(NAME gpio_reg_access_test SOURCES gpio/reg_access_test.c LIBRARIES ${LIBS} FPGA)
-mocha_add_test(NAME i2c_smoketest SOURCES i2c/smoketest.c LIBRARIES ${LIBS} FPGA)
-mocha_add_test(NAME mailbox_smoketest SOURCES mailbox/smoketest.c LIBRARIES ${LIBS} FPGA)
-mocha_add_test(NAME plic_smoketest SOURCES plic/smoketest.c LIBRARIES ${LIBS} FPGA)
+mocha_add_test(NAME test_framework_test SOURCES test_framework/smoketest.c LIBRARIES ${LIBS} FPGA
+               VERILATOR)
+mocha_add_test(NAME test_framework_exception_test SOURCES test_framework/exception.c LIBRARIES
+               ${LIBS} VERILATOR)
+mocha_add_test(NAME gpio_reg_access_test SOURCES gpio/reg_access_test.c LIBRARIES ${LIBS} FPGA
+               VERILATOR)
+# Can't run this test on FPGA and verilators top and this test thinks that the GPIO inputs can be
+# driven
+mocha_add_test(NAME i2c_smoketest SOURCES i2c/smoketest.c LIBRARIES ${LIBS} FPGA VERILATOR)
+mocha_add_test(NAME mailbox_smoketest SOURCES mailbox/smoketest.c LIBRARIES ${LIBS} FPGA VERILATOR)
+mocha_add_test(NAME plic_smoketest SOURCES plic/smoketest.c LIBRARIES ${LIBS} FPGA VERILATOR)
 # Cannot currently run this on FPGA because the boot ROM expects the test to be provided on the SPI again.
-mocha_add_test(NAME rstmgr_software_reset SOURCES rstmgr/software_reset.c LIBRARIES ${LIBS})
-mocha_add_test(NAME spi_device_smoketest SOURCES spi_device/smoketest.c LIBRARIES ${LIBS} FPGA)
-mocha_add_test(NAME spi_host_smoketest SOURCES spi_host/smoketest.c LIBRARIES ${LIBS} FPGA)
-mocha_add_test(NAME tag_controller_smoketest SOURCES tag_controller/smoketest.c LIBRARIES ${LIBS} FPGA)
-mocha_add_test(NAME tag_controller_tag_test SOURCES tag_controller/tag_test.c LIBRARIES ${LIBS} FPGA)
-mocha_add_test(NAME timer_smoketest SOURCES timer/smoketest.c LIBRARIES ${LIBS} FPGA)
-mocha_add_test(NAME timer_interrupt_test SOURCES timer/interrupt.c LIBRARIES ${LIBS})
-mocha_add_test(NAME uart_smoketest SOURCES uart/smoketest.c LIBRARIES ${LIBS})
+mocha_add_test(NAME rstmgr_software_reset SOURCES rstmgr/software_reset.c LIBRARIES ${LIBS}
+               VERILATOR)
+mocha_add_test(NAME spi_device_smoketest SOURCES spi_device/smoketest.c LIBRARIES ${LIBS} FPGA
+               VERILATOR)
+mocha_add_test(NAME spi_host_smoketest SOURCES spi_host/smoketest.c LIBRARIES ${LIBS} FPGA
+               VERILATOR)
+mocha_add_test(NAME tag_controller_smoketest SOURCES tag_controller/smoketest.c LIBRARIES ${LIBS}
+               FPGA VERILATOR)
+mocha_add_test(NAME tag_controller_tag_test SOURCES tag_controller/tag_test.c LIBRARIES ${LIBS} FPGA
+               VERILATOR)
+mocha_add_test(NAME timer_smoketest SOURCES timer/smoketest.c LIBRARIES ${LIBS} FPGA VERILATOR)
+mocha_add_test(NAME timer_interrupt_test SOURCES timer/interrupt.c LIBRARIES ${LIBS} VERILATOR)
+mocha_add_test(NAME uart_smoketest SOURCES uart/smoketest.c LIBRARIES ${LIBS} VERILATOR)
 
 add_subdirectory(dram)