From 9d9b2c0922e3dbb49111adb0415fc41e9d41ae37 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Risto=20Peja=C5=A1inovi=C4=87?=
 <risto.pejasinovic@gmail.com>
Date: Sun, 15 Sep 2024 23:51:57 +0200
Subject: [PATCH] iverilog use generator expressions, add descriptions to
 targets, update sim_example

---
 cmake/sim/iverilog/iverilog.cmake   | 45 +++++++++++++----------------
 examples/sim_example/CMakeLists.txt | 20 +++++++------
 2 files changed, 31 insertions(+), 34 deletions(-)

diff --git a/cmake/sim/iverilog/iverilog.cmake b/cmake/sim/iverilog/iverilog.cmake
index fb95e8f..c7c9e56 100644
--- a/cmake/sim/iverilog/iverilog.cmake
+++ b/cmake/sim/iverilog/iverilog.cmake
@@ -32,21 +32,8 @@ function(iverilog IP_LIB)
     # Get the binary directory of the IP library
     get_target_property(BINARY_DIR ${IP_LIB} BINARY_DIR)
 
-    # Set the output directory for iverilog results
-    if(NOT ARG_OUTDIR)
-        set(OUTDIR ${BINARY_DIR})
-    else()
-        set(OUTDIR ${ARG_OUTDIR})
-    endif()
-
-    if(ARG_TOP_MODULE)
-        set(TOP_MODULE "-s${ARG_TOP_MODULE}")
-    endif()
-
     # Get the IP RTL sources
     get_ip_sources(SOURCES ${IP_LIB} SYSTEMVERILOG VERILOG)
-    # Where is defined V_SOURCES (if it's defined)?
-    list(PREPEND SOURCES ${V_SOURCES})
     # Get IP include directories
     get_ip_include_directories(INC_DIRS ${IP_LIB} SYSTEMVERILOG VERILOG)
     # Prepare include directories arguments for iverilog
@@ -61,41 +48,49 @@ function(iverilog IP_LIB)
         list(APPEND CMP_DEFS_ARG -D${def})
     endforeach()
 
+    # Generator expression for OUTDIR = defined(ARG_OUTDIR) ? ARG_OUTDIR : BINARY_DIR
+    set(OUTDIR $<IF:$<BOOL:${ARG_OUTDIR}>,${ARG_OUTDIR},${BINARY_DIR}>)
     # Set the output executable name
-    if(NOT ARG_EXECUTABLE)
-        set(ARG_EXECUTABLE "${OUTDIR}/${IP_LIB}_iv")
-    endif()
+    set(ARG_EXECUTABLE $<IF:$<BOOL:${ARG_EXECUTABLE}>,${ARG_EXECUTABLE},${OUTDIR}/${IP_LIB}_iverilog>)
 
     # Set the stamp file path (is the stamp file really needed?)
     set(STAMP_FILE "${BINARY_DIR}/${IP_LIB}_${CMAKE_CURRENT_FUNCTION}.stamp")
+    set(DESCRIPTION "Compile ${IP_LIB} with ${CMAKE_CURRENT_FUNCTION}")
 
     # Add a custom command to run iverilog
     add_custom_command(
         OUTPUT ${ARG_EXECUTABLE} ${STAMP_FILE}
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${OUTDIR}
         COMMAND iverilog
-        ${TOP_MODULE}
-        ${ARG_INCDIRS}
-        ${CMP_DEFS_ARG}
-        ${ARG_CLI_FLAGS}
-        -o ${ARG_EXECUTABLE}
-        ${SOURCES}
+            $<$<BOOL:${ARG_TOP_MODULE}>:-s${ARG_TOP_MODULE}>
+            ${ARG_INCDIRS}
+            ${CMP_DEFS_ARG}
+            ${ARG_CLI_FLAGS}
+            -o ${ARG_EXECUTABLE}
+            ${SOURCES}
         COMMAND touch ${STAMP_FILE}
+        BYPRODUCTS ${OUTDIR}
         DEPENDS ${SOURCES}
-        COMMENT "Running iverilog on ${IP_LIB}"
+        COMMENT ${DESCRIPTION}
     )
 
     # Add a custom target that depends on the executable and stamp file
     add_custom_target(
         ${IP_LIB}_${CMAKE_CURRENT_FUNCTION}
         DEPENDS ${ARG_EXECUTABLE} ${STAMP_FILE} ${IP_LIB}
+        COMMENT ${DESCRIPTION}
     )
+    set_property(TARGET ${IP_LIB}_${CMAKE_CURRENT_FUNCTION} PROPERTY DESCRIPTION ${DESCRIPTION})
 
+    set(DESCRIPTION "Run ${CMAKE_CURRENT_FUNCTION} testbench compiled from ${IP_LIB}")
     # Add a custom target to run the generated executable
     add_custom_target(
-        run_${IP_LIB}_iv
-        COMMAND exec ${ARG_EXECUTABLE}
+        run_${IP_LIB}_${CMAKE_CURRENT_FUNCTION}
+        COMMAND ${ARG_EXECUTABLE}
         DEPENDS ${ARG_EXECUTABLE} ${STAMP_FILE} ${SOURCES} ${IP_LIB}_${CMAKE_CURRENT_FUNCTION}
+        COMMENT ${DESCRIPTION}
     )
+    set_property(TARGET run_${IP_LIB}_${CMAKE_CURRENT_FUNCTION} PROPERTY DESCRIPTION ${DESCRIPTION})
 
 endfunction()
 
diff --git a/examples/sim_example/CMakeLists.txt b/examples/sim_example/CMakeLists.txt
index a0098bd..00e688b 100644
--- a/examples/sim_example/CMakeLists.txt
+++ b/examples/sim_example/CMakeLists.txt
@@ -3,18 +3,20 @@ project(example NONE)
 
 include("deps/deps.cmake")
 
-add_ip(tb           # Name of the IP block
-    VENDOR cern     # Vendor name (can be ommited, but not recommended)
-    LIBRARY ip      # Library name (can be ommited, but not recommended)
-    VERSION 0.0.1   # Version Number (can be ommited, but not recommended)
+add_ip(cern::ip::tb::0.0.1
+    DESCRIPTION "Simple verilog testbench"
     )
 
-ip_sources(tb VERILOG           # Add source files to the VERILOG file set
+ip_sources(${IP} VERILOG           # Add source files to the VERILOG file set
     ${PROJECT_SOURCE_DIR}/tb.v
     )
 
-iverilog(tb) # Create iverilog target
-
-verilate(tb  # Create verilate target
-    MAIN     # Let Verilator create a main.cpp testbench
+iverilog(${IP}
+    OUTDIR ${PROJECT_BINARY_DIR}/random # Create iverilog target
+    EXECUTABLE ${PROJECT_BINARY_DIR}/tb
     )
+
+verilate(${IP}  # Create verilate target
+    MAIN)        # Let Verilator create a main.cpp testbench
+    
+help()