feat[platforms]: more user friendly platform selection

Author: Djokzer

hls4ml/backends/vitis_accelerator/vitis_accelerator_config.py

@@ -1,6 +1,6 @@
 import json
 import os
-
+import subprocess
 
 class VitisAcceleratorConfig:
     def __init__(self, config):
@@ -15,18 +15,33 @@ def __init__(self, config):
             board_info = self.supported_boards[self.board]
             self.board_type = board_info["board_type"]
             self.part = board_info["part"]
+
+            # Get available platforms for the board
+            platforms = self.get_available_platforms()
+            platforms = self.filter_platforms(platforms, self.board)
+            if not platforms:
+                raise Exception("No platforms available for the board " + self.board)
+            else:
+                print("Available platforms for the board " + self.board + ": ")
+                self.print_platforms(platforms)
+
+            # Set platform based on the config or default to the first available platform
             if accel_config.get("Platform") is not None:
-                if accel_config.get("Platform") in board_info["platform"]:
+                if accel_config.get("Platform") in platforms:
                     self.platform = accel_config.get("Platform")
                 else:
                     print(
                         "WARNING: You set an unrecognized Platform."
-                        "Using " + board_info["platform"][0] + " platform instead"
+                        "Using " + platforms[0] + " platform instead"
                     )
-                    self.platform = board_info["platform"][0]
+                    self.platform = platforms[0]
             else:
-                print("Using " + board_info["platform"][0] + " platform")
-                self.platform = board_info["platform"][0]
+                print(
+                    "WARNING: You didn't set a Platform."
+                    "Using " + platforms[0] + " platform instead"
+                )
+                self.platform = platforms[0]
+                
             self.memory_type = board_info["memory"]["type"]
             self.memory_channel_count = board_info["memory"]["channels"]
         else:
@@ -47,6 +62,33 @@ def __init__(self, config):
 
         self.vivado_directives = accel_config.get("Vivado_Directives", [])
 
+    def get_available_platforms(self):
+        if "XILINX_VITIS" not in os.environ:
+            raise Exception("XILINX_VITIS Variable is not set, please set correctly and rerun")
+    
+        output = subprocess.run(["platforminfo", "-l"], stdout=subprocess.PIPE)
+        p_info = json.loads(output.stdout.decode('utf-8'))
+        platforms = []
+        for p in p_info['platforms']:
+            platforms.append(p['baseName'])
+        return platforms
+    
+    def filter_platforms(self, platforms = None, board="alveo-u55c"):
+        b = board.split('-')
+        b_len = len(b)
+        name = b[b_len-1]
+
+        f_platforms = []
+        for p in platforms:
+            p_name = p.split('_')[1]
+            if p_name == name:
+                f_platforms.append(p)
+        return f_platforms
+
+    def print_platforms(self, platforms):
+        for p in platforms:
+            print(p)
+
     def get_board_type(self):
         return self.board_type