opencsd: Add marker generic element type.

Some trace packets can act as positional markers in the trace stream for packets that
are output later to allow the analyzer to associate the later packet with the correct position.

This adds a generic element type to handle these marker packets and put a generic packet
in the output stream for the same reason.

Signed-off-by: Mike Leach <mike.leach@linaro.org>

4 files changed, 49 insertions, 0 deletions

diff --git a/decoder/docs/prog_guide/prog_guide_generic_pkts.md b/decoder/docs/prog_guide/prog_guide_generic_pkts.md
index e4d50b7..0eaa9f9 100644
--- a/decoder/docs/prog_guide/prog_guide_generic_pkts.md
+++ b/decoder/docs/prog_guide/prog_guide_generic_pkts.md
@@ -84,6 +84,7 @@ typedef struct _ocsd_generic_trace_elem {
         ocsd_swt_info_t sw_trace_info;      /* software trace packet info    */
 		uint32_t num_instr_range;	        /* number of instructions covered by range packet (for T32 this cannot be calculated from en-st/i_size) */
         unsync_info_t unsync_eot_info;      /* additional information for unsync / end-of-trace packets. */
+		trace_marker_payload_t sync_marker; /* marker element - sync later element to position in stream */
     };
 
     const void *ptr_extended_data;        /* pointer to extended data buffer (data trace, sw trace payload) / custom structure */
@@ -326,6 +327,27 @@ SW trace packets that have a payload will use the extended_data flag and pointer
 SW trace packets that include timestamp information will us the `has_ts` flag and fill in the timestamp value.
 
 
+### OCSD_GEN_TRC_ELEM_SYNC_MARKER ###
+__packet fields valid__: `sync_marker`
+
+Synchronisation marker - marks position in stream of an element that is output later.
+e.g. a timestamp marker can be output to represent the correct position in the stream for a 
+timestamp packet the is output later.
+
+The `sync_marker` field has a structure as shown below.
+
+~~~{.c}
+typedef enum _trace_sync_marker_t {
+    ELEM_MARKER_TS,        /**< Marker for timestamp element */
+} trace_sync_marker_t;
+
+typedef struct _trace_marker_payload_t {
+    trace_sync_marker_t type;   /**< type of sync marker */
+    uint32_t value;             /**< sync marker value - usage depends on type */
+} trace_marker_payload_t;
+~~~
+
+
 ### OCSD_GEN_TRC_ELEM_CUSTOM ###
 __packet fields optional__: `extended_data -> ptr_extended_data`,_any others_
 
diff --git a/decoder/include/common/trc_gen_elem.h b/decoder/include/common/trc_gen_elem.h
index 5d8983a..b03283c 100644
--- a/decoder/include/common/trc_gen_elem.h
+++ b/decoder/include/common/trc_gen_elem.h
@@ -82,6 +82,8 @@ public:
     void setSWTInfo(const ocsd_swt_info_t swt_info) { sw_trace_info = swt_info; };
     void setExtendedDataPtr(const void *data_ptr);
 
+    void setSyncMarker(const trace_marker_payload_t &marker);
+
 // stringize the element
 
     virtual void toString(std::string &str) const;
@@ -208,6 +210,11 @@ inline void OcsdTraceElement::setExtendedDataPtr(const void *data_ptr)
     ptr_extended_data = data_ptr;
 }
 
+inline void OcsdTraceElement::setSyncMarker(const trace_marker_payload_t &marker)
+{
+    sync_marker = marker;
+}
+
 // set persistent data between output packets.
 inline void OcsdTraceElement::copyPersistentData(const OcsdTraceElement &src)
 {
diff --git a/decoder/include/opencsd/trc_gen_elem_types.h b/decoder/include/opencsd/trc_gen_elem_types.h
index 1a285a0..da56603 100644
--- a/decoder/include/opencsd/trc_gen_elem_types.h
+++ b/decoder/include/opencsd/trc_gen_elem_types.h
@@ -61,6 +61,7 @@ typedef enum _ocsd_gen_trc_elem_t
     OCSD_GEN_TRC_ELEM_CYCLE_COUNT,     /*!< Cycle count - cycles since last cycle count value - associated with a preceding instruction range. */
     OCSD_GEN_TRC_ELEM_EVENT,           /*!< Event - trigger or numbered event  */   
     OCSD_GEN_TRC_ELEM_SWTRACE,         /*!< Software trace packet - may contain data payload. */
+    OCSD_GEN_TRC_ELEM_SYNC_MARKER,     /*!< Synchronisation marker - marks position in stream of an element that is output later. */
     OCSD_GEN_TRC_ELEM_CUSTOM,          /*!< Fully custom packet type - used by none-ARM architecture decoders */
 } ocsd_gen_trc_elem_t;
 
@@ -86,6 +87,15 @@ typedef enum _unsync_info_t {
     UNSYNC_EOT,             /**< end of trace - no additional info */
 } unsync_info_t;
 
+typedef enum _trace_sync_marker_t {
+    ELEM_MARKER_TS,        /**< Marker for timestamp element */
+} trace_sync_marker_t;
+
+typedef struct _trace_marker_payload_t {
+    trace_sync_marker_t type;   /**< type of sync marker */
+    uint32_t value;             /**< sync marker value - usage depends on type */
+} trace_marker_payload_t;
+
 typedef struct _ocsd_generic_trace_elem {
     ocsd_gen_trc_elem_t elem_type;   /**< Element type - remaining data interpreted according to this value */
     ocsd_isa           isa;          /**< instruction set for executed instructions */
@@ -122,6 +132,7 @@ typedef struct _ocsd_generic_trace_elem {
         ocsd_swt_info_t sw_trace_info;      /**< software trace packet info    */
 		uint32_t num_instr_range;	        /**< number of instructions covered by range packet (for T32 this cannot be calculated from en-st/i_size) */
         unsync_info_t unsync_eot_info;      /**< additional information for unsync / end-of-trace packets. */
+        trace_marker_payload_t sync_marker; /**< marker element - sync later element to position in stream */
     };
 
     const void *ptr_extended_data;        /**< pointer to extended data buffer (data trace, sw trace payload) / custom structure */
diff --git a/decoder/source/trc_gen_elem.cpp b/decoder/source/trc_gen_elem.cpp
index e177420..c2e5fc9 100644
--- a/decoder/source/trc_gen_elem.cpp
+++ b/decoder/source/trc_gen_elem.cpp
@@ -55,6 +55,7 @@ static const char *s_elem_descs[][2] =
     {"OCSD_GEN_TRC_ELEM_CYCLE_COUNT","Cycle count - cycles since last cycle count value - associated with a preceding instruction range."},
     {"OCSD_GEN_TRC_ELEM_EVENT","Event - numbered event or trigger"},
     {"OCSD_GEN_TRC_ELEM_SWTRACE","Software trace packet - may contain data payload."},
+    {"OCSD_GEN_TRC_ELEM_SYNC_MARKER","Synchronisation marker - marks position in stream of an element that is output later."},
     {"OCSD_GEN_TRC_ELEM_CUSTOM","Fully custom packet type."}
 };
 
@@ -106,6 +107,10 @@ static const char *s_unsync_reason[] = {
     "end-of-trace",         // UNSYNC_EOT - end of trace info.
 };
 
+static const char *s_marker_t[] = {
+  "Timestamp marker",  //  ELEM_MARKER_TS  
+};
+
 void OcsdTraceElement::toString(std::string &str) const
 {
     std::ostringstream oss;
@@ -190,6 +195,10 @@ void OcsdTraceElement::toString(std::string &str) const
                 oss << " [" << s_unsync_reason[unsync_eot_info] << "]";
             break;
 
+        case OCSD_GEN_TRC_ELEM_SYNC_MARKER:
+            oss << " [" << s_marker_t[sync_marker.type] << "(0x" << std::setfill('0') << std::setw(8) << std::hex << sync_marker.value << ")]";
+            break;
+
         default: break;
         }
         if(has_cc)