Template:EvalBoardTraceExample

From SEGGER Knowledge Base
Jump to navigation Jump to search


This template can be used to add a tracing section example: to an eval board page.

Functionality

Template will display a trace page configure by given parameters.
Please note that the (yes,no) parameters will show/hide complete sections for tested HW, pin and buffer trace.

Old style PinTrace/Buftrace: Separate trace projects for pin trace and buffer trace.

New style TraceEx: One trace example project, different jdebug files for pin trace and buffer trace.

Parameters

Parameters may be passed in any order, when specified directly.

Parameter Meaning Example value
BoardName Board identifier EK-RA4M3
Heading Optional heading (e.g. for multicore) Cortex-M4 sub-core
*** Either use old style (distinct trace examples)
PinTrace Display pin trace content (yes,no)
  PinTraceEx   Example project zip file (only if PinTrace=yes)   DEVICE_TracePins.zip
BufTrace Display buffer trace content (yes,no)
  BufTraceEx   Example project zip flie (only if BufTrace=yes,
  leaving empty references to pin trace project)
  DEVICE_TraceBuffer.zip
*** ... or new style (one trace example)
TraceEx Example project zip file DEVICE_TraceExample.zip
  BufTrace   Display buffer trace content   (yes,no)
  PinTrace   Display buffer trace content   (yes,no)
***

Example

For template usage see Template:EvalBoardTraceDefault or try out pasting the example at Special:ExpandTemplates

Old style

{{:Template:EvalBoardTraceExample
| BoardName=SuperDuperBoard
| Heading=
| PinTrace=yes
| PinTraceEx=DEVICE_TracePins.zip
| BufTrace=yes
| BufTraceEx=DEVICE_TraceBuffer.zip
}}

New style

{{:Template:EvalBoardTraceExample
| BoardName=SuperDuperBoard
| Heading=Cortex-M4 sub-core
| TraceEx=DEVICE_TraceExample.zip
| PinTrace=yes
| BufTrace=yes
}}