man/swodec.1

   1 .TH swodec 1 "Dec 23, 2015"
   2 .SH NAME
   3 swodec \- decode SWO trace data
   4
   5 .SH SYNOPSIS
   6 .B swodec [OPTIONS]
   7
   8 .SH DESCRIPTION
   9 .B swodec
  10 is a command-line utility to decode SWO trace data.
  11
  12 .SH OPTIONS
  13 .TP
  14 .B \-h, \-\-help
  15 Show a help text and exit.
  16
  17 .TP
  18 .B \-V, \-\-version
  19 Show version information and exit.
  20
  21 .TP
  22 .BR "\-i, \-\-input\-file " <filename>
  23 Load trace data from a file instead of using standard input.
  24
  25 .TP
  26 .BR "\-f, \-\-filter " <list>
  27 A comma-separated list of packet types to filter for. The following packet types
  28 are available:
  29
  30 .RS
  31 .RS
  32 .TP
  33 .B sync
  34 Synchronization
  35 .TP
  36 .B of
  37 Overflow
  38 .TP
  39 .B lts
  40 Local timestamp
  41 .TP
  42 .B gts
  43 Global timestamp. This is a shortcut for \fBgts1\fP and \fBgts2\fP.
  44 .TP
  45 .B gts1
  46 Global timestamp (GTS1)
  47 .TP
  48 .B gts2
  49 Global timestamp (GTS2)
  50 .TP
  51 .B ext
  52 Extension
  53 .TP
  54 .B inst
  55 Instrumentation
  56 .TP
  57 .B hw
  58 Hardware source. This is for hardware source packets which could not be decoded
  59 as Data Watchpoint and Trace (DWT) packets.
  60 .TP
  61 .B dwt
  62 Data Watchpoint and Trace (DWT). This is a shortcut for \fBevcnt\fP,
  63 \fBexc\fP, \fBpc\fP, \fBdtpc\fP, \fBdtaddr\fP and \fBdtval\fP.
  64 .TP
  65 .B evcnt
  66 Event counter
  67 .TP
  68 .B exc
  69 Exception trace
  70 .TP
  71 .B pc
  72 Periodic PC sample
  73 .TP
  74 .B dtpc
  75 Data trace PC value
  76 .TP
  77 .B dtaddr
  78 Data trace address offset
  79 .TP
  80 .B dtval
  81 Data trace data value
  82 .TP
  83 .B unknown
  84 Unknown data
  85 .RE
  86 .RE
  87
  88 .RS
  89 If a tilde (~) precedes the list the machting sense is inverted.
  90 .RE
  91
  92 .TP
  93 .BR "\-\-filter-inst " <list>
  94 A comma-separated list of instrumentation source addresses to filter for. If a
  95 tilde (~) precedes the list the machting sense is inverted. Each address must be
  96 in the range from \fB0\fP to \fB31\fP.
  97
  98 .TP
  99 .B \-\-dump-inst
 100 Dump the payload of instrumentation packets. All other packet types are filtered
 101 out.
 102
 103 .SH EXAMPLES
 104
 105 In order to decode trace data from a file (e.g. trace.bin), run the following
 106 command:
 107
 108 .RB " $ " "swodec \-\-input\-file trace.bin"
 109
 110 If you want to filter for instrumentation and hardware source packets only, use:
 111
 112 .RB " $ " "swodec \-\-input-file trace.bin \-\-filter inst,hw"
 113
 114 If you are interested in all packets except for unknown data and
 115 synchronization, the simplest way is to invert the sense of matching:
 116
 117 .RB " $ " "swodec \-\-input-file trace.bin \-\-filter ~unknown,sync"