[cbuild-run] Initial debug sequences output (single core)

Author: spcaipers-arm

external/yaml-cpp.patch

@@ -69,6 +69,15 @@ diff --git a/src/emitter.cpp b/src/emitter.cpp
 index 4d48307..d4485be 100644
 --- a/src/emitter.cpp
 +++ b/src/emitter.cpp
+@@ -721,7 +721,7 @@ Emitter& Emitter::Write(const std::string& str) {
+ 
+   StringEscaping::value stringEscaping = GetStringEscapingStyle(m_pState->GetOutputCharset());
+ 
+-  const StringFormat::value strFormat =
++  const StringFormat::value strFormat = str.compare(0, 2, "|\n") == 0 ? StringFormat::Literal :
+       Utils::ComputeStringFormat(str, m_pState->GetStringFormat(),
+                                  m_pState->CurGroupFlowType(), stringEscaping == StringEscaping::NonAscii);
+ 
 @@ -816,6 +816,8 @@ const char* Emitter::ComputeNullName() const {
        return "NULL";
      case CamelNull:
@@ -90,6 +99,19 @@ index 3dbe401..0dd0b17 100644
      case TildeNull:
        _Set(m_nullFmt, value, scope);
        return true;
+diff --git a/src/emitterutils.cpp b/src/emitterutils.cpp
+index 6cdf6de..b48b7c0 100644
+--- a/src/emitterutils.cpp
++++ b/src/emitterutils.cpp
+@@ -365,7 +365,7 @@ bool WriteDoubleQuotedString(ostream_wrapper& out, const std::string& str,
+ 
+ bool WriteLiteralString(ostream_wrapper& out, const std::string& str,
+                         std::size_t indent) {
+-  out << "|\n";
++  out << (str.compare(0, 2, "|\n") == 0 ? "" : "|\n");
+   int codePoint;
+   for (std::string::const_iterator i = str.begin();
+        GetNextCodePointAndAdvance(codePoint, i, str.end());) {
 diff --git a/src/exceptions.cpp b/src/exceptions.cpp
 index 43a7976..af99fd6 100644
 --- a/src/exceptions.cpp

tools/projmgr/include/ProjMgrRunDebug.h

@@ -29,6 +29,28 @@ struct FilesType {
   std::string type;
 };
 
+/**
+ * @brief debug sequences block type
+*/
+struct DebugSequencesBlockType {
+  std::string info;
+  std::string execute;
+  std::string control_if;
+  std::string control_while;
+  std::string timeout;
+  bool atomic;
+  std::vector<DebugSequencesBlockType> blocks;
+};
+
+/**
+ * @brief debug sequences type
+*/
+struct DebugSequencesType {
+  std::string name;
+  std::string info;
+  std::vector<DebugSequencesBlockType> blocks;
+};
+
  /**
   * @brief debug run manager types
  */
@@ -43,6 +65,7 @@ struct RunDebugType {
   std::vector<AlgorithmType> algorithms;
   std::vector<FilesType> outputs;
   std::vector<FilesType> systemDescriptions;
+  std::vector<DebugSequencesType> debugSequences;
 };
 
 /**
@@ -75,6 +98,7 @@ class ProjMgrRunDebug {
 
 protected:
   RunDebugType m_runDebug;
+  void GetDebugSequenceBlock(const RteItem* item, DebugSequencesBlockType& block);
 };
 
 #endif  // PROJMGRRUNDEBUG_H

tools/projmgr/include/ProjMgrYamlParser.h

@@ -22,11 +22,13 @@ static constexpr const char* YAML_ADDPATH_ASM = "add-path-asm";
 static constexpr const char* YAML_ALWAYS = "always";
 static constexpr const char* YAML_ARGUMENT = "argument";
 static constexpr const char* YAML_ARGUMENTS = "arguments";
+static constexpr const char* YAML_ATOMIC = "atomic";
 static constexpr const char* YAML_ATTR = "attr";
 static constexpr const char* YAML_AUTO = "auto";
 static constexpr const char* YAML_BASE = "base";
 static constexpr const char* YAML_BASE_DIR = "base-dir";
 static constexpr const char* YAML_BASE_NAME = "base-name";
+static constexpr const char* YAML_BLOCKS = "blocks";
 static constexpr const char* YAML_BOARD = "board";
 static constexpr const char* YAML_BOARD_BOOKS = "board-books";
 static constexpr const char* YAML_BOARD_PACK = "board-pack";
@@ -103,6 +105,7 @@ static constexpr const char* YAML_GROUP = "group";
 static constexpr const char* YAML_GROUPS = "groups";
 static constexpr const char* YAML_HOST = "host";
 static constexpr const char* YAML_ID = "id";
+static constexpr const char* YAML_IF = "if";
 static constexpr const char* YAML_IMPLEMENTED_BY = "implemented-by";
 static constexpr const char* YAML_IMPLEMENTS = "implements";
 static constexpr const char* YAML_INFO = "info";
@@ -168,6 +171,7 @@ static constexpr const char* YAML_SOLUTION = "solution";
 static constexpr const char* YAML_SELECT = "select";
 static constexpr const char* YAML_SELECTED_BY = "selected-by";
 static constexpr const char* YAML_SELECTED_BY_PACK = "selected-by-pack";
+static constexpr const char* YAML_SEQUENCES = "sequences";
 static constexpr const char* YAML_SETUPS = "setups";
 static constexpr const char* YAML_SETUP = "setup";
 static constexpr const char* YAML_SET = "set";
@@ -181,6 +185,7 @@ static constexpr const char* YAML_SYSTEM_DESCRIPTIONS = "system-descriptions";
 static constexpr const char* YAML_TARGET_CONFIGURATIONS = "target-configurations";
 static constexpr const char* YAML_TARGETTYPE = "target-type";
 static constexpr const char* YAML_TARGETTYPES = "target-types";
+static constexpr const char* YAML_TIMEOUT = "timeout";
 static constexpr const char* YAML_TRUSTZONE = "trustzone";
 static constexpr const char* YAML_CORE = "core";
 static constexpr const char* YAML_TITLE = "title";
@@ -190,6 +195,7 @@ static constexpr const char* YAML_UPDATE = "update";
 static constexpr const char* YAML_VARIABLES = "variables";
 static constexpr const char* YAML_VERSION = "version";
 static constexpr const char* YAML_WARNINGS = "warnings";
+static constexpr const char* YAML_WHILE = "while";
 static constexpr const char* YAML_WORKING_DIR = "working-dir";
 
 /**

tools/projmgr/schemas/common.schema.json

@@ -1970,6 +1970,41 @@
       },
       "additionalProperties": false
     },
+    "DebugSequencesType": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": { "$ref": "#/definitions/DebugSequenceType" }
+    },
+    "DebugSequenceType": {
+      "description": "A list of command blocks in order of execution.",
+      "type": "object",
+      "properties": {
+        "name":    { "type": "string", "description": "Name of the sequence." },
+        "info":    { "type": "string", "description": "Descriptive text to display for example for error diagnostics." },
+        "blocks":  { "$ref": "#/definitions/DebugBlocksType" }
+      },
+      "additionalProperties": false,
+      "required": ["name"]
+    },
+    "DebugBlocksType": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": { "$ref": "#/definitions/DebugBlockType" }
+    },
+    "DebugBlockType": {
+      "description": "A list of command blocks in order of execution.",
+      "type": "object",
+      "properties": {
+        "info":    { "type": "string", "description": "Descriptive text to display for example for error diagnostics." },
+        "blocks":  { "$ref": "#/definitions/DebugBlocksType" },
+        "execute": { "type": "string", "description": "Commands for execution." },
+        "atomic":  { "type": "null", "description": "Atomic execution of commands; cannot be used with 'blocks'" },
+        "if":      { "anyOf": [{"type": "string"}, {"type": "number"}], "description": "Only executed when expression is true." },
+        "while":   { "anyOf": [{"type": "string"}, {"type": "number"}], "description": "Executed in loop until while expression is true." },
+        "timeout": { "type": "number", "description": "Timeout in milliseconds for while loop." }
+      },
+      "additionalProperties": false
+    },
     "RunDebugDescType": {
       "description": "This section describes generated contents",
       "type": "object",
@@ -1984,7 +2019,8 @@
         "device-pack":          { "$ref": "#/definitions/PackID" },
         "programming":          { "$ref": "#/definitions/ProgrammingType" },
         "system-descriptions":  { "$ref": "#/definitions/RunFilesType", "description": "System description files." },
-        "output":               { "$ref": "#/definitions/RunFilesType", "description": "Application image files." }
+        "output":               { "$ref": "#/definitions/RunFilesType", "description": "Application image files." },
+        "sequences":            { "$ref": "#/definitions/DebugSequencesType", "description": "Debug sequences for the target." }
       },
       "additionalProperties": false
     }

tools/projmgr/src/ProjMgrCbuildRun.cpp

@@ -21,6 +21,8 @@ class ProjMgrCbuildRun : public ProjMgrCbuildBase {
   std::string m_directory;
   void SetProgrammingNode(YAML::Node node, const std::vector<AlgorithmType>& algorithms);
   void SetFilesNode(YAML::Node node, const std::vector<FilesType>& outputs);
+  void SetDebugSequencesNode(YAML::Node node, const std::vector<DebugSequencesType>& algorithms);
+  void SetDebugSequencesBlockNode(YAML::Node node, const std::vector<DebugSequencesBlockType>& blocks);
 };
 
 ProjMgrCbuildRun::ProjMgrCbuildRun(YAML::Node node,
@@ -36,6 +38,7 @@ ProjMgrCbuildRun::ProjMgrCbuildRun(YAML::Node node,
   SetProgrammingNode(node[YAML_PROGRAMMING], debugRun.algorithms);
   SetFilesNode(node[YAML_SYSTEM_DESCRIPTIONS], debugRun.systemDescriptions);
   SetFilesNode(node[YAML_OUTPUT], debugRun.outputs);
+  SetDebugSequencesNode(node[YAML_SEQUENCES], debugRun.debugSequences);
 };
 
 void ProjMgrCbuildRun::SetProgrammingNode(YAML::Node node, const std::vector<AlgorithmType>& algorithms) {
@@ -66,6 +69,36 @@ void ProjMgrCbuildRun::SetFilesNode(YAML::Node node, const std::vector<FilesType
   }
 }
 
+void ProjMgrCbuildRun::SetDebugSequencesNode(YAML::Node node, const std::vector<DebugSequencesType>& sequences) {
+  for (const auto& sequence : sequences) {
+    YAML::Node sequenceNode;
+    SetNodeValue(sequenceNode[YAML_NAME], sequence.name);
+    SetNodeValue(sequenceNode[YAML_INFO], sequence.info);
+    SetDebugSequencesBlockNode(sequenceNode[YAML_BLOCKS], sequence.blocks);
+    node.push_back(sequenceNode);
+  }
+}
+
+void ProjMgrCbuildRun::SetDebugSequencesBlockNode(YAML::Node node, const std::vector<DebugSequencesBlockType>& blocks) {
+  for (const auto& block : blocks) {
+    YAML::Node blockNode;
+    SetNodeValue(blockNode[YAML_INFO], block.info);
+    SetNodeValue(blockNode[YAML_IF], block.control_if);
+    SetNodeValue(blockNode[YAML_WHILE], block.control_while);
+    if (!block.timeout.empty()) {
+      blockNode[YAML_TIMEOUT] = RteUtils::StringToULL(block.timeout);
+    }
+    if (block.atomic) {
+      blockNode[YAML_ATOMIC] = YAML::Null;
+    }
+    if (!block.execute.empty()) {
+      SetNodeValue(blockNode[YAML_EXECUTE], "|\n" + block.execute);
+    }
+    SetDebugSequencesBlockNode(blockNode[YAML_BLOCKS], block.blocks);
+    node.push_back(blockNode);
+  }
+}
+
 //-- ProjMgrYamlEmitter::GenerateCbuildRun --------------------------------------------------------
 bool ProjMgrYamlEmitter::GenerateCbuildRun(const RunDebugType& debugRun) {
   // generate cbuild-run.yml

tools/projmgr/src/ProjMgrRunDebug.cpp

@@ -9,6 +9,8 @@
 #include "ProjMgrYamlEmitter.h"
 #include "RteFsUtils.h"
 
+#include <regex>
+
 using namespace std;
 
 ProjMgrRunDebug::ProjMgrRunDebug(void) {
@@ -39,6 +41,8 @@ bool ProjMgrRunDebug::CollectSettings(const vector<ContextItem*>& contexts) {
   Collection<RteItem*> algorithms;
   // debug infos
   Collection<RteItem*> debugs;
+  // debug sequences
+  Collection<RteItem*> debugSequences;
 
   // device collections
   if (context->devicePack) {
@@ -51,6 +55,10 @@ bool ProjMgrRunDebug::CollectSettings(const vector<ContextItem*>& contexts) {
     for (const auto& deviceDebug : deviceDebugs) {
       debugs.push_back(deviceDebug);
     }
+    const auto& deviceDebugSequences = context->rteDevice->GetEffectiveProperties("sequence", context->deviceItem.pname);
+    for (const auto& deviceDebugSequence : deviceDebugSequences) {
+      debugSequences.push_back(deviceDebugSequence);
+    }
   }
 
   // board collections
@@ -103,5 +111,53 @@ bool ProjMgrRunDebug::CollectSettings(const vector<ContextItem*>& contexts) {
       m_runDebug.outputs.push_back({ output.hex.filename, RteConstants::OUTPUT_TYPE_HEX });
     }
   }
+
+  // debug sequences
+  for (const auto& debugSequence : debugSequences) {
+    DebugSequencesType sequence;
+    sequence.name = debugSequence->GetName();
+    sequence.info = debugSequence->GetAttribute("info");
+    for (const auto& debugSequenceBlock : debugSequence->GetChildren()) {
+      DebugSequencesBlockType block;
+      GetDebugSequenceBlock(debugSequenceBlock, block);
+      sequence.blocks.push_back(block);
+    }
+    m_runDebug.debugSequences.push_back(sequence);
+  }
+
   return true;
 }
+
+void ProjMgrRunDebug::GetDebugSequenceBlock(const RteItem* item, DebugSequencesBlockType& block) {
+  // get 'block' attributes
+  if (item->GetTag() == "block") {
+    block.info = block.info.empty() ? item->GetAttribute("info") : block.info;
+    block.atomic = item->GetAttributeAsBool("atomic");
+    const string execute = RteUtils::EnsureLf(item->GetText());
+    block.execute = regex_replace(execute, regex("\n +"), "\n");
+    // 'block' doesn't have children, stop here
+    return;
+  }
+
+  // get 'control' attributes
+  if (item->GetTag() == "control") {
+    block.info = item->GetAttribute("info");
+    block.control_if = item->GetAttribute("if");
+    block.control_while = item->GetAttribute("while");
+    block.timeout = item->GetAttribute("timeout");
+  }
+
+  const auto& children = item->GetChildren();
+  if ((children.size() == 1) && (children.front()->GetTag() == "block")) {
+    // last child block
+    GetDebugSequenceBlock(children.front(), block);
+    return;
+  }
+
+  for (const auto& child : children) {
+    // get children blocks recursively
+    DebugSequencesBlockType childBlock;
+    GetDebugSequenceBlock(child, childBlock);
+    block.blocks.push_back(childBlock);
+  }
+}

tools/projmgr/test/data/TestRunDebug/ref/TestHW.cbuild-run.yml

@@ -32,3 +32,61 @@ cbuild-run:
   output:
     - file: out/run-debug/TestHW/run-debug.axf
       type: elf
+  sequences:
+    - name: DebugDeviceUnlock
+      blocks:
+        - execute: |
+            Sequence("CheckID");
+    - name: DebugCoreStart
+      blocks:
+        - execute: |
+            // Replication of Standard Functionality
+            Write32(0xE000EDF0, 0xA05F0001);                                        // Enable Core Debug via DHCSR
+        - info: DbgMCU registers
+          execute: |
+            // Device Specific Debug Setup
+            Write32(0x40021018, Read32(0x40021018) | 0x00400000);                   // Set RCC_APB2ENR.DBGMCUEN
+    - name: CheckID
+      blocks:
+        - execute: |
+            __var pidr1 = 0;
+            __var pidr2 = 0;
+            __var jep106id = 0;
+            __var ROMTableBase = 0;
+
+            __ap = 0;      // AHB-AP
+
+            ROMTableBase = ReadAP(0xF8) & ~0x3;
+
+            pidr1 = Read32(ROMTableBase + 0x0FE4);
+            pidr2 = Read32(ROMTableBase + 0x0FE8);
+            jep106id = ((pidr2 & 0x7) << 4 ) | ((pidr1 >> 4) & 0xF);
+        - if: jep106id != 0x20
+          execute: |
+            Query(0, "Incorrect ID! Abort connection", 1);
+            Message(2, "Incorrect ID! Abort connection.");
+    - name: DebugPortStop
+      blocks:
+        - execute: |
+            __var connectionFlash = ( __connection & 0xF ) == 2 ;
+            __var FLASH_BASE = 0x40022000 ;
+            __var FLASH_CR = FLASH_BASE + 0x10 ;
+            __var OBL_LAUNCH_BIT = ( 1 << 13 ) ;
+            __var FLASH_CR_Value = 0 ;
+            __var DoDebugPortStop = 1 ;
+            __var DP_CTRL_STAT = 0x4 ;
+            __var DP_SELECT = 0x8 ;
+        - if: connectionFlash && DoDebugPortStop
+          execute: |
+            DoDebugPortStop = 0 ;
+            FLASH_CR_Value = Read32( FLASH_CR ) ;
+            __errorcontrol = 1 ;
+            // write OBL_LAUNCH bit (causes a reset)
+            Write32( FLASH_CR, FLASH_CR_Value | ( OBL_LAUNCH_BIT ) ) ;
+            __errorcontrol = 0 ;
+        - if: DoDebugPortStop
+          execute: |
+            // Switch to DP Register Bank 0
+            WriteDP(DP_SELECT, 0x00000000);
+            // Power Down Debug port
+            WriteDP(DP_CTRL_STAT, 0x00000000);