build dir name + versal packaging + ultraclean

Author: alex-yang-upenn

hls4ml/backends/vitis_accelerator/supported_boards.json

@@ -18,7 +18,7 @@
       "memory": {"type": "ddr", "channels": 4, "capacity": 64}
     },
     "vck5000": {
-      "board_type": "versal",
+      "board_type": "alveo-versal",
       "part": "xcvc1902-2msevsvd1760", 
       "platform": "xilinx_vck5000_gen4x8_qdma_2_202220_1",
       "memory":{"type": "ddr", "channels": 3, "capacity": 12}

hls4ml/backends/vitis_accelerator/vitis_accelerator_backend.py

@@ -44,7 +44,7 @@ def create_initial_config(
         config['AcceleratorConfig']['Batchsize'] = batchsize
         return config
 
-    def build(self, model, reset=False, synth=True, vsynth=True):
+    def build(self, model, reset=False, synth=True, vsynth=True, csim=False, cosim=False, debug=False, **kwargs):
         if 'linux' in sys.platform:
             if 'XILINX_VITIS' not in os.environ:
                 raise Exception("XILINX_VITIS environmental variable missing. Please install XRT and Vitis, and run the setup scripts before building")
@@ -65,13 +65,22 @@ def build(self, model, reset=False, synth=True, vsynth=True):
 
             if vsynth:
                 if synth:
-                    target = "all"
+                    target = "all "
                 else:
-                    target = "xclbin"
+                    target = "xclbin "
             elif synth:
-                target = "hls"
+                target = "hls "
             else:
-                target = "host"
+                target = "host "
+
+            if cosim:
+                target += "TARGET=hw_emu "
+            elif csim:
+                target += "TARGET=sw_emu "
+
+            if debug:
+                target += "DEBUG"
+
             command = "make " + target
 
             # Pre-loading libudev

hls4ml/templates/vitis_accelerator/Makefile

@@ -31,14 +31,22 @@ CARD_CFG ?= accelerator_card.cfg
 # Platform (currently extracted from accelerator_card.cfg if not already set)
 PLATFORM ?= $(shell awk -F '=' '/platform=/ {print $$2}' $(CARD_CFG))
 
-# kernel name
+# Board Type (determines whether design will go through packaging step)
+BOARD_TYPE := 
+
+# Kernel name
 KERNEL_NAME := myproject
 
 # Wrapper name
 WRAPPER_NAME := kernel_wrapper
 
 # Top level build directory
 BUILD_DIR := ./build_$(TARGET)
+ifdef DEBUG
+BUILD_DIR += _deb
+else
+BUILD_DIR += _rel
+endif
 
 # Directories for kernel synthesis
 XO_DIR := $(BUILD_DIR)/xo
@@ -78,27 +86,27 @@ hls: $(BUILD_DIR)/$(KERNEL_NAME)_kernel.xo
 
 # Kernel linking & packaging ##################################################
 
+ifeq ($(BOARD_TYPE),alveo)
 # For Standard Alveo, a single step is required for linking and packaging
-ifeq (,$(findstring vck5000,$(PLATFORM)))
 # This is standard Alveo linking and packaging
-
 $(BUILD_DIR)/$(WRAPPER_NAME).xclbin: $(BUILD_DIR)/$(KERNEL_NAME)_kernel.xo
 	mkdir -p $(XCLBIN_DIR)
 	v++ -l $(XOLDFLAGS) --temp_dir $(XCLBIN_DIR) --log_dir $(XCLBIN_DIR) -o $@ $^
 
-else
-# For VCK5000, linking and packaging are separate steps
-
+else ifeq ($(BOARD_TYPE),alveo-versal) || ($(BOARD_TYPE),versal)
+# For Versal architecture, linking and packaging are separate steps
 $(BUILD_DIR)/$(WRAPPER_NAME).xsa: $(BUILD_DIR)/$(KERNEL_NAME)_kernel.xo
 	mkdir -p $(XCLBIN_DIR)
 	v++ -l $(XOLDFLAGS) --temp_dir $(XCLBIN_DIR) --log_dir $(XCLBIN_DIR) -o $@ $^
 
-XOCCPFLAGS := -t $(TARGET) -f $(PLATFORM) --package.boot_mode=ospi --messageDb=$(BUILD_DIR)/kernel_wrapper.mdb
-
 # VCK5000 specific packaging
+XOCCPFLAGS := -t $(TARGET) -f $(PLATFORM) --package.boot_mode=ospi --messageDb=$(BUILD_DIR)/kernel_wrapper.mdb
 $(BUILD_DIR)/$(WRAPPER_NAME).xclbin: $(BUILD_DIR)/$(WRAPPER_NAME).xsa
 	v++ -p $(XOCCPFLAGS) --temp_dir $(XCLBIN_DIR) --log_dir $(XCLBIN_DIR) -o $@ $^
 
+else
+    @echo "$(BOARD_TYPE) board type is currently unsupported"
+
 endif
 
 xclbin: $(BUILD_DIR)/$(WRAPPER_NAME).xclbin
@@ -114,14 +122,19 @@ host: $(KERNEL_NAME)_host_cl.cpp libs/xcl2.cpp
 # Cleanup #####################################################################
 
 cleanxclbin:
-	rm -rf host tb_data/hw_results.dat
+	rm -rf host tb_data/hw_results.dat tb_data/tb_input_features.dat
 	rm -rf *$(WRAPPER_NAME)*.log
-	rm -rf $(BUILD_DIR)/$(WRAPPER_NAME).xclbin* $(BUILD_DIR)/$(WRAPPER_NAME).xsa* $(BUILD_DIR)/$(WRAPPER_NAME).ltx $(BUILD_DIR)/$(WRAPPER_NAME).mdb
-	rm -rf $(BUILD_DIR)/xclbincleanhls
+	rm -rf $(BUILD_DIR)/$(WRAPPER_NAME).xclbin.* $(BUILD_DIR)/$(WRAPPER_NAME).xsa* $(BUILD_DIR)/$(WRAPPER_NAME).ltx $(BUILD_DIR)/$(WRAPPER_NAME).mdb
+	rm -rf $(XCLBIN_DIR)
 
 cleanhls:
-	rm -rf $(BUILD_DIR)/$(KERNEL_NAME)_kernel.xo*
-	rm -rf $(BUILD_DIR)/xo
 	rm -rf *$(KERNEL_NAME)_kernel*.log
+	rm -rf $(BUILD_DIR)/$(KERNEL_NAME)_kernel.xo.*
+	rm -rf $(XO_DIR)
 
 clean: cleanxclbin cleanhls
+
+ultraclean: 
+	rm -rf host tb_data/hw_results.dat tb_data/tb_input_features.dat *.log
+	rm -rf $(BUILD_DIR)
+	

hls4ml/writer/vitis_accelerator_writer.py

@@ -184,6 +184,9 @@ def write_makefile(self, model):
         for line in f.readlines():
             if 'myproject' in line:
                 newline = line.replace('myproject', project_name)
+            if 'BOARD_TYPE :=' in line:
+                newline = line
+                newline += board_type
             else:
                 newline = line
             fout.write(newline)