feat: Add minimum simulation time warnings to testbenches

Author: nselvara

ip/ff_synchroniser/tb/tb_ff_synchroniser.vhd

@@ -35,7 +35,9 @@ architecture tb of tb_ff_synchroniser is
     -------------------------------------------------------------
     -- Internal tb signals/constants
     -------------------------------------------------------------
-    constant SIMULATION_TIMEOUT_TIME: time := real'value(SIMULATION_TIMEOUT_IN_MS) * 1 ms;
+    constant MINIMUM_SIMULATION_TIME_IN_MS: real := 3.7; -- Minimum time needed for synchronizer test
+    constant REQUESTED_SIMULATION_TIMEOUT_TIME: time := real'value(SIMULATION_TIMEOUT_IN_MS) * 1 ms;
+    constant SIMULATION_TIMEOUT_TIME: time := maximum(REQUESTED_SIMULATION_TIMEOUT_TIME, MINIMUM_SIMULATION_TIME_IN_MS * 1 ms);
     constant ENABLE_DEBUG_PRINT: boolean := false;
 
     constant SOURCE_CLK_FREQUENCY: real := real(100e6);
@@ -77,6 +79,10 @@ begin
         test_runner_setup(runner, runner_cfg);
         info("Starting tb_ff_synchroniser");
 
+        if REQUESTED_SIMULATION_TIMEOUT_TIME < MINIMUM_SIMULATION_TIME_IN_MS * 1 ms then
+            warning("Simulation timeout (" & SIMULATION_TIMEOUT_IN_MS & " ms) is less than minimum required (" & real'image(MINIMUM_SIMULATION_TIME_IN_MS) & " ms). Using minimum timeout instead.");
+        end if;
+
         if ENABLE_DEBUG_PRINT then
             show(display_handler, debug);
         end if;

ip/memories/ram/single_port/tb/tb_single_port_ram.vhd

@@ -33,7 +33,9 @@ architecture tb of tb_single_port_ram is
     -- Internal tb signals/constants
     -------------------------------------------------------------
     constant PROPAGATION_TIME: time := 1 ns;
-    constant SIMULATION_TIMEOUT_TIME: time := real'value(SIMULATION_TIMEOUT_IN_MS) * 1 ms;
+    constant MINIMUM_SIMULATION_TIME_IN_MS: real := 1.2; -- Minimum time needed for all tests
+    constant REQUESTED_SIMULATION_TIMEOUT_TIME: time := real'value(SIMULATION_TIMEOUT_IN_MS) * 1 ms;
+    constant SIMULATION_TIMEOUT_TIME: time := maximum(REQUESTED_SIMULATION_TIMEOUT_TIME, MINIMUM_SIMULATION_TIME_IN_MS * 1 ms);
     constant ENABLE_DEBUG_PRINT: boolean := false;
     constant RANDOM_REPETITIONS: natural := 10;
 
@@ -75,6 +77,10 @@ begin
         test_runner_setup(runner, runner_cfg);
         info("Starting tb_single_port_ram");
 
+        if REQUESTED_SIMULATION_TIMEOUT_TIME < MINIMUM_SIMULATION_TIME_IN_MS * 1 ms then
+            warning("Simulation timeout (" & SIMULATION_TIMEOUT_IN_MS & " ms) is less than minimum required (" & real'image(MINIMUM_SIMULATION_TIME_IN_MS) & " ms). Using minimum timeout instead.");
+        end if;
+
         if ENABLE_DEBUG_PRINT then
             show(display_handler, debug);
         end if;

ip/memories/rom/tb/tb_rom.vhd

@@ -35,7 +35,9 @@ architecture tb of tb_rom is
     -- Internal tb signals/constants
     -------------------------------------------------------------
     constant PROPAGATION_TIME: time := 1 ns;
-    constant SIMULATION_TIMEOUT_TIME: time := real'value(SIMULATION_TIMEOUT_IN_MS) * 1 ms;
+    constant MINIMUM_SIMULATION_TIME_IN_MS: real := 1.5; -- Minimum time needed for test_full_rom (2^16 iterations)
+    constant REQUESTED_SIMULATION_TIMEOUT_TIME: time := real'value(SIMULATION_TIMEOUT_IN_MS) * 1 ms;
+    constant SIMULATION_TIMEOUT_TIME: time := maximum(REQUESTED_SIMULATION_TIMEOUT_TIME, MINIMUM_SIMULATION_TIME_IN_MS * 1 ms);
     constant ENABLE_DEBUG_PRINT: boolean := false;
 
     constant SYS_CLK_FREQUENCY: real := real(100e6);
@@ -73,6 +75,10 @@ begin
         test_runner_setup(runner, runner_cfg);
         info("Starting tb_rom");
 
+        if REQUESTED_SIMULATION_TIMEOUT_TIME < MINIMUM_SIMULATION_TIME_IN_MS * 1 ms then
+            warning("Simulation timeout (" & SIMULATION_TIMEOUT_IN_MS & " ms) is less than minimum required (" & real'image(MINIMUM_SIMULATION_TIME_IN_MS) & " ms). Using minimum timeout instead.");
+        end if;
+
         if ENABLE_DEBUG_PRINT then
             show(display_handler, debug);
         end if;

ip/reset_on_startup/tb/tb_reset_on_startup.vhd

@@ -31,7 +31,9 @@ architecture tb of tb_reset_on_startup is
     -------------------------------------------------------------
     -- Internal tb signals/constants
     -------------------------------------------------------------
-    constant SIMULATION_TIMEOUT_TIME: time := real'value(SIMULATION_TIMEOUT_IN_MS) * 1 ms;
+    constant MINIMUM_SIMULATION_TIME_IN_MS: real := 3.0; -- Minimum time needed for reset startup test
+    constant REQUESTED_SIMULATION_TIMEOUT_TIME: time := real'value(SIMULATION_TIMEOUT_IN_MS) * 1 ms;
+    constant SIMULATION_TIMEOUT_TIME: time := maximum(REQUESTED_SIMULATION_TIMEOUT_TIME, MINIMUM_SIMULATION_TIME_IN_MS * 1 ms);
     constant ENABLE_DEBUG_PRINT: boolean := false;
 
     constant SYS_CLK_FREQUENCY: real := real(100e6);
@@ -73,6 +75,10 @@ begin
         test_runner_setup(runner, runner_cfg);
         info("Starting tb_lcd_controller");
 
+        if REQUESTED_SIMULATION_TIMEOUT_TIME < MINIMUM_SIMULATION_TIME_IN_MS * 1 ms then
+            warning("Simulation timeout (" & SIMULATION_TIMEOUT_IN_MS & " ms) is less than minimum required (" & real'image(MINIMUM_SIMULATION_TIME_IN_MS) & " ms). Using minimum timeout instead.");
+        end if;
+
         if ENABLE_DEBUG_PRINT then
             show(display_handler, debug);
         end if;