[projmgr] Implement debug-adapters.yml handling

Author: grasci-arm

tools/projmgr/include/ProjMgr.h

@@ -122,7 +122,14 @@ class ProjMgr {
    * @brief get cmsis-toolbox version from manifest file
    * @return version as string
   */
-  std::string GetToolboxVersion(const std::string& manifestFilePath);
+  const std::string GetToolboxVersion(const std::string& manifestFilePath);
+
+  /**
+   * @brief get debug adapters file path
+   * @return file path or empty string if it does not exist
+  */
+  const std::string GetDebugAdaptersFile(void);
+
 protected:
   ProjMgrParser m_parser;
   ProjMgrExtGenerator m_extGenerator;

tools/projmgr/include/ProjMgrParser.h

@@ -596,6 +596,39 @@ struct CbuildSetItem {
   std::string compiler;
 };
 
+/**
+ * @brief debug-adapter defaults item containing
+ *        port number of processor
+ *        debug protocol(jtag or swd)
+ *        debug clock speed
+*/
+struct DebugAdapterDefaultsItem {
+  std::string port;
+  std::string protocol;
+  std::string clock;
+};
+
+/**
+ * @brief debug-adapter item containing
+ *        name
+ *        list of alias
+ *        template
+ *        gdbserver
+ *        defaults
+*/
+struct DebugAdapterItem {
+  std::string name;
+  std::vector<std::string> alias;
+  std::string templateFile;
+  bool gdbserver = false;
+  DebugAdapterDefaultsItem defaults;
+};
+
+/**
+ * @brief debug-adapters item containing
+ *        list of debug-adapters
+*/
+typedef std::vector<DebugAdapterItem> DebugAdaptersItem;
 
 /**
  * @brief projmgr parser class for public interfacing
@@ -656,6 +689,13 @@ class ProjMgrParser {
   */
   bool ParseCbuildSet(const std::string& input, bool checkSchema);
 
+  /**
+   * @brief parse debug-adapters file
+   * @param checkSchema false to skip schema validation
+   * @param input path to *.debug-adapters.yml file
+  */
+  bool ParseDebugAdapters(const std::string& input, bool checkSchema);
+
   /**
    * @brief get cdefault
    * @return cdefault item
@@ -692,10 +732,17 @@ class ProjMgrParser {
   */
   CbuildSetItem& GetCbuildSetItem(void);
 
+  /**
+   * @brief get debug adapters
+   * @return debug adapters list
+  */
+  DebugAdaptersItem& GetDebugAdaptersItem(void);
+
 protected:
   CdefaultItem m_cdefault;
   CsolutionItem m_csolution;
   CbuildSetItem m_cbuildSet;
+  DebugAdaptersItem m_debugAdapters;
   std::map<std::string, CprojectItem> m_cprojects;
   std::map<std::string, ClayerItem> m_clayers;
   std::map<std::string, ClayerItem> m_genericClayers;

tools/projmgr/include/ProjMgrRunDebug.h

@@ -203,18 +203,23 @@ class ProjMgrRunDebug {
    * @param vector of selected contexts
    * @return true if executed successfully
   */
-  bool CollectSettings(const std::vector<ContextItem*>& contexts);
+  bool CollectSettings(const std::vector<ContextItem*>& contexts, const DebugAdaptersItem& adapters);
 
 protected:
   RunDebugType m_runDebug;
   void GetDebugSequenceBlock(const RteItem* item, DebugSequencesBlockType& block);
   void PushBackUniquely(std::vector<std::pair<const RteItem*, std::vector<std::string>>>& vec,
     const RteItem* item, const std::string pname);
   FilesType SetLoadFromOutput(const ContextItem* context, OutputType output, const std::string type);
-  std::string GetAccessAttributes(const RteItem* mem);
+  const std::string GetAccessAttributes(const RteItem* mem);
   void SetAccessPorts(std::vector<AccessPortType>& parent, const std::map<unsigned int,
     std::vector<AccessPortType>>& childrenMap);
   void SetProtNodes(const RteDeviceProperty* item, AccessPortType& ap);
+  bool GetDebugAdapter(const std::string& name, const DebugAdaptersItem& adapters, DebugAdapterItem& match);
+  void CollectDebuggerSettings(const ContextItem& context, const DebugAdaptersItem& adapters,
+    const std::map<std::string, RteDeviceProperty*>& pnames);
+  void CollectDebugTopology(const ContextItem& context, std::vector<std::pair<const RteItem*, std::vector<std::string>>> debugs,
+    const std::map<std::string, RteDeviceProperty*>& pnames);
 };
 
 #endif  // PROJMGRRUNDEBUG_H

tools/projmgr/include/ProjMgrWorker.h

@@ -242,6 +242,26 @@ struct ContextTypesItem {
   BoolMap missingTargetTypes;
 };
 
+/**
+ * @brief gdb core item containing
+ *        port number of processor
+ *        processor name
+ *        primary processor
+*/
+struct GdbCoreItem {
+  unsigned long long port;
+  std::string pname;
+  bool start = false;
+};
+
+/**
+ * @brief gdb server item containing
+ *        list of the gdb core items
+*/
+struct GdbServerItem {
+  std::vector<GdbCoreItem> core;
+};
+
 /**
  * @brief debugger type
  *        name of debug configuration
@@ -250,6 +270,7 @@ struct ContextTypesItem {
  *        debug clock speed
  *        debug configuration file
  *        start pname
+ *        gdbserver
 */
 struct DebuggerType {
   std::string name;
@@ -258,6 +279,7 @@ struct DebuggerType {
   std::optional<unsigned long long> clock;
   std::string dbgconf;
   std::string startPname;
+  GdbServerItem gdbserver;
 };
 
 /**

tools/projmgr/include/ProjMgrYamlParser.h

@@ -17,6 +17,7 @@ static constexpr const char* YAML_ACCESS = "access";
 static constexpr const char* YAML_ACCESSPORTS = "accessports";
 static constexpr const char* YAML_ALGORITHM = "algorithm";
 static constexpr const char* YAML_ALIAS = "alias";
+static constexpr const char* YAML_ALIAS_NAME = "alias-name";
 static constexpr const char* YAML_ADDPATH = "add-path";
 static constexpr const char* YAML_ADDPATH_ASM = "add-path-asm";
 static constexpr const char* YAML_ADDRESS = "address";
@@ -78,13 +79,15 @@ static constexpr const char* YAML_CREATED_BY = "created-by";
 static constexpr const char* YAML_CREATED_FOR = "created-for";
 static constexpr const char* YAML_DATAPATCH = "datapatch";
 static constexpr const char* YAML_DEBUG = "debug";
+static constexpr const char* YAML_DEBUG_ADAPTERS = "debug-adapters";
 static constexpr const char* YAML_DEBUG_SEQUENCES = "debug-sequences";
 static constexpr const char* YAML_DEBUG_VARS = "debug-vars";
 static constexpr const char* YAML_DEBUG_TOPOLOGY = "debug-topology";
 static constexpr const char* YAML_DEBUGGER = "debugger";
 static constexpr const char* YAML_DEBUGPORTS = "debugports";
 static constexpr const char* YAML_DBGCONF = "dbgconf";
 static constexpr const char* YAML_DEFAULT = "default";
+static constexpr const char* YAML_DEFAULTS = "defaults";
 static constexpr const char* YAML_DEFINE = "define";
 static constexpr const char* YAML_DEFINE_ASM = "define-asm";
 static constexpr const char* YAML_DELPATH = "del-path";
@@ -111,6 +114,7 @@ static constexpr const char* YAML_FORCONTEXT = "for-context";
 static constexpr const char* YAML_FORDEVICE = "for-device";
 static constexpr const char* YAML_FORPROJECTPART = "for-project-part";
 static constexpr const char* YAML_FPU = "fpu";
+static constexpr const char* YAML_GDBSERVER = "gdbserver";
 static constexpr const char* YAML_GENERATED_BY = "generated-by";
 static constexpr const char* YAML_GENERATOR = "generator";
 static constexpr const char* YAML_GENERATORS = "generators";
@@ -175,6 +179,7 @@ static constexpr const char* YAML_PACKS_MISSING = "packs-missing";
 static constexpr const char* YAML_PACKS_UNUSED = "packs-unused";
 static constexpr const char* YAML_PATH = "path";
 static constexpr const char* YAML_PNAME = "pname";
+static constexpr const char* YAML_PORT = "port";
 static constexpr const char* YAML_PUNITS = "punits";
 static constexpr const char* YAML_PUNIT = "punit";
 static constexpr const char* YAML_PROCESSORS = "processors";
@@ -223,6 +228,7 @@ static constexpr const char* YAML_TARGETSEL = "targetsel";
 static constexpr const char* YAML_TARGET_SET = "target-set";
 static constexpr const char* YAML_TARGETTYPE = "target-type";
 static constexpr const char* YAML_TARGETTYPES = "target-types";
+static constexpr const char* YAML_TEMPLATE = "template";
 static constexpr const char* YAML_TIMEOUT = "timeout";
 static constexpr const char* YAML_TRUSTZONE = "trustzone";
 static constexpr const char* YAML_TITLE = "title";
@@ -298,6 +304,14 @@ class ProjMgrYamlParser {
   */
   bool ParseCbuildSet(const std::string& input, CbuildSetItem& cbuildSet, bool checkSchema);
 
+  /**
+   * @brief parse debug-adapters file
+   * @param input path to debug-adapters.yml file
+   * @param reference to store parsed debug-adapters item
+   * @param checkSchema false to skip schema validation
+   * @return true if executed successfully
+  */
+  bool ParseDebugAdapters(const std::string& input, DebugAdaptersItem& adapters, bool checkSchema);
 
 protected:
   bool ParseCbuildPack(const std::string& input, CbuildPackItem& cbuildPack, bool checkSchema);
@@ -336,6 +350,7 @@ class ProjMgrYamlParser {
   bool ParseTypePair(std::vector<std::string>& vec, std::vector<TypePair>& typeVec);
   bool ParseLinker(const YAML::Node& parent, const std::string& file, std::vector<LinkerItem>& linker);
   void ParseRte(const YAML::Node& parent, std::string& rteBaseDir);
+  void ParseDebugDefaults(const YAML::Node& parent, const std::string& file, DebugAdapterDefaultsItem& defaults);
   bool GetTypes(const std::string& type, std::string& buildType, std::string& targetType, std::string& pattern);
   bool ValidateCdefault(const std::string& input, const YAML::Node& root);
   bool ValidateCsolution(const std::string& input, const YAML::Node& root);

tools/projmgr/schemas/common.schema.json

@@ -65,11 +65,6 @@
           "title": "update:",
           "type": "string",
           "description": "New configuration file used for merge utility."
-        },
-        "debugger": {
-          "title": "debugger:",
-          "type": "string",
-          "description": "Associated debugger connections."
         }
       },
       "required": [ "file" ],
@@ -2359,7 +2354,11 @@
         "load":            { "$ref": "#/definitions/TargetSetLoadType" },
         "load-offset":     { "type": "number", "description": "Offset applied to the binary content when loading the file." }
       },
-      "additionalProperties": false
+      "additionalProperties": false,
+      "oneOf": [
+        { "required": ["project-context"], "not": {"required": ["image"]} },
+        { "required": ["image"], "not": {"required": ["project-context"]} }
+      ]
     },
     "TargetSetDebuggerType": {
       "title": "optimize:\nDocumentation: https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#debugger",
@@ -2379,6 +2378,35 @@
       "title": "optimize:\nDocumentation: https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#load",
       "description": "Specifies the load mode for the project output or image file.",
       "enum": [ "image+symbols", "symbols", "image", "none" ]
+    },
+    "DebugAdaptersDescType": {
+      "title": "debug-adapters:\nDocumentation: https://open-cmsis-pack.github.io/cmsis-toolbox/build-operation/#debug-adapter-integration",
+      "description": "Contains the list of supported debug adapters.",
+      "type": "array",
+      "uniqueItems": true,
+      "items": { "$ref": "#/definitions/DebugAdapterDescType" }
+    },
+    "DebugAdapterDescType": {
+      "type": "object",
+      "properties": {
+        "name":       { "type": "string", "description": "Debugger adapter name." },
+        "alias-name": { "type": "array",  "items": { "type": "string"}, "description": "List of names (in input node or BSP) that map to this debug adapter." },
+        "template":   { "type": "string", "description": "Used only by the VS Code CMSIS Solution extension for configuration." },
+        "gdbserver":  { "type": "null", "description": "Add the gdbserver: node in the cbuild-run.yml file." },
+        "defaults":   { "$ref": "#/definitions/DebugAdaptersDefaultsType" }
+      },
+      "additionalProperties": false,
+      "required": ["name"]
+    },
+    "DebugAdaptersDefaultsType": {
+      "description": "List of default options to use when not specified in the target-set: node.",
+      "type": "object",
+      "properties": {
+        "port":     { "type": "number", "description": "Port number." },
+        "protocol": { "enum": [ "jtag", "swd" ], "description": "Selected debug protocol (jtag or swd)." },
+        "clock":    { "type": "number", "description": "Selected debug clock speed (in Hz)." }
+      },
+      "additionalProperties": false
     }
   }
 }

tools/projmgr/schemas/debug-adapters.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/Open-CMSIS-Pack/devtools/schemas/projmgr/2.9.0/tools/projmgr/schemas/debug-adapters.schema.json",
+  "title": "CMSIS debug-adapters",
+  "description": "contains the list of supported debug adapters",
+  "version": "2.9.0",
+  "type": "object",
+  "properties": {
+    "debug-adapters": {
+      "$ref": "./common.schema.json#/definitions/DebugAdaptersDescType"
+    }
+  },
+  "additionalProperties": false,
+  "required": [ "debug-adapters" ]
+}

tools/projmgr/src/ProjMgr.cpp

@@ -538,7 +538,13 @@ bool ProjMgr::GenerateYMLConfigurationFiles(bool previousResult) {
   // Generate cbuild-run file
   if (previousResult && !m_processedContexts.empty() &&
     (m_contextSet || !m_activeTargetSet.empty())) {
-    if (!m_runDebug.CollectSettings(m_processedContexts)) {
+    const auto& debugAdapters = GetDebugAdaptersFile();
+    if (!debugAdapters.empty()) {
+      if (!m_parser.ParseDebugAdapters(debugAdapters, m_checkSchema)) {
+        return false;
+      }
+    }
+    if (!m_runDebug.CollectSettings(m_processedContexts, m_parser.GetDebugAdaptersItem())) {
       result = false;
     }
     if (!m_emitter.GenerateCbuildRun(m_runDebug.Get())) {
@@ -1127,7 +1133,7 @@ bool ProjMgr::ValidateCreatedFor(const string& createdFor) {
   return true;
 }
 
-string ProjMgr::GetToolboxVersion(const string& toolboxDir) {
+const string ProjMgr::GetToolboxVersion(const string& toolboxDir) {
   // Find file non recursively under given search directory
   string manifestFilePattern = "manifest_(\\d+\\.\\d+\\.\\d+)(.*).yml";
   string manifestFile;
@@ -1143,3 +1149,13 @@ string ProjMgr::GetToolboxVersion(const string& toolboxDir) {
   regex_match(manifestFile, matchResult, regEx);
   return matchResult[1].str();
 }
+
+const string ProjMgr::GetDebugAdaptersFile(void) {
+  error_code ec;
+  const string exePath = RteUtils::ExtractFilePath(CrossPlatformUtils::GetExecutablePath(ec), true);
+  const string debugAdapterFile = fs::path(exePath).parent_path().parent_path().append("etc/debug-adapters.yml").generic_string();
+  if (RteFsUtils::Exists(debugAdapterFile)) {
+    return debugAdapterFile;
+  }
+  return RteUtils::EMPTY_STRING;
+}

tools/projmgr/src/ProjMgrCbuild.cpp

@@ -164,7 +164,6 @@ void ProjMgrCbuild::SetDebugConfigNode(YAML::Node node, const ContextItem* conte
       SetNodeValue(fileNode[YAML_VERSION], context->dbgconf.second->GetSemVer(true));
       SetPLMStatus(fileNode, context, dbgconf);
     }
-    SetNodeValue(fileNode[YAML_DEBUGGER], context->debugger.name);
     node.push_back(fileNode);
   }
 }

tools/projmgr/src/ProjMgrCbuildRun.cpp

@@ -31,6 +31,7 @@ class ProjMgrCbuildRun : public ProjMgrCbuildBase {
   void SetDebugPortsNode(YAML::Node node, const std::vector<DebugPortType>& debugPorts);
   void SetAccessPortsNode(YAML::Node node, const std::vector<AccessPortType>& accessPorts);
   void SetDatapatchNode(YAML::Node node, const std::vector<DatapatchType>& datapatch);
+  void SetGdbServerNode(YAML::Node node, const GdbServerItem& gdbserver);
 };
 
 ProjMgrCbuildRun::ProjMgrCbuildRun(YAML::Node node,
@@ -106,6 +107,19 @@ void ProjMgrCbuildRun::SetDebuggerNode(YAML::Node node, const DebuggerType& debu
     }
     SetNodeValue(node[YAML_DBGCONF], FormatPath(debugger.dbgconf, m_directory));
     SetNodeValue(node[YAML_START_PNAME], debugger.startPname);
+    SetGdbServerNode(node[YAML_GDBSERVER], debugger.gdbserver);
+  }
+}
+
+void ProjMgrCbuildRun::SetGdbServerNode(YAML::Node node, const GdbServerItem& gdbserver) {
+  for (const auto& item : gdbserver.core) {
+    YAML::Node coreNode;
+    coreNode[YAML_PORT] = item.port;
+    SetNodeValue(coreNode[YAML_PNAME], item.pname);
+    if (item.start) {
+      coreNode[YAML_START] = YAML::Null;
+    }
+    node[YAML_CORE].push_back(coreNode);
   }
 }