Template:EvalBoardTraceDefault

From SEGGER Knowledge Base
Jump to navigation Jump to search


This template can be used to add a tracing section to an eval board page. It is using the three sub-templates covering the default single core use case

For non-default devices (e.g. multi core) templates can be used individually.

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. The "Optional" parameter can be used to add an arbitrary section.
The pages derived from this template will inherit the category "Trace Support" and thus can be found at https://wiki.segger.com/Category:Trace_Support

Parameters

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

Parameter Meaning Example value
Vendor MCU Vendor Renesas
Device MCU R7FA4M3
BoardName Board identifier EK-RA4M3
JlinkVersion DLL version tested V7.96f
OzoneVersion Ozone version tested V3.32a
StudioVersion Embedded Studion version tested V8.12a
PinTrace Display pin trace content (yes,no)
BufTrace Display buffer trace content (yes,no)
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
  TraceBuf   Display buffer trace content   (yes,no)
  TracePins   Display buffer trace content   (yes,no)
***
TestedHw Display tested HW section (yes,no)
  TestedHwPic  Picture of tested HW (only if TestedHw=yes)  Board.png
PinTrace Display pin trace measurements (yes,no)
  PinTraceClk   Screenshot trace clock (only if PinTrace=yes)   DEVICE_Multiple_TCLK.png
  PinTraceRise   Screenshot of clock rise time (only if PinTrace=yes)   DEVICE_Risetime_TCLK.png
  PinTraceSetup   Screenshot of clock setup time (only if PinTrace=yes)   DEVICE_Setuptime_TD0.png
Optional Optional, can be used to add e.g. limitations section ...

Example

For an live example see NUCLEO-H7S3L8#Tracing_on_ST_STM32H7S3L8 or try out pasting the example at Special:ExpandTemplates

Old style trace example

{{:Template:EvalBoardTraceDefault
| Vendor=Super Inc.
| Device=SuperDuper
| BoardName=SuperDuperBoard
| JlinkVersion=V7.96f
| OzoneVersion=V3.32a
| StudioVersion=V8.12a
| TestedHw=yes
| TestedHwPic=Board.png
| Heading=
| PinTrace=yes
| PinTraceEx=DEVICE_TracePins.zip
| PinTraceClk=DEVICE_Multiple_TCLK.png
| PinTraceRise=DEVICE_RiseTime_TCLK.png
| PinTraceSetup=DEVICE_SetupTime_TD0.png
| BufTrace=yes
| BufTraceEx=DEVICE_TraceBuffer.zip
| Optional=
=== Specifics/Limitations ===
The SuperDuper needs some modifications for all 4 trace data pins to work. Sacrifice a living chicken to your local shaman. For more information about this see the board specific user manual.
}}

New style trace example

{{:Template:EvalBoardTraceDefault
| Vendor=Super Inc.
| Device=SuperDuper
| BoardName=SuperDuperBoard
| JlinkVersion=V7.96f
| OzoneVersion=V3.32a
| StudioVersion=V8.12a
| TestedHw=yes
| TestedHwPic=Board.png
| PinTraceClk=DEVICE_Multiple_TCLK.png
| PinTraceRise=DEVICE_RiseTime_TCLK.png
| PinTraceSetup=DEVICE_SetupTime_TD0.png
| Heading=
| TraceEx=DEVICE_TraceExample.zip
| PinTrace=yes
| BufTrace=yes
| Optional=
=== Specifics/Limitations ===
The SuperDuper needs some modifications for all 4 trace data pins to work. Sacrifice a living chicken to your local shaman. For more information about this see the board specific user manual.
}}

Example Custom

For multicore devices do not use this template but rather call the templates manually and add multiple Template:EvalBoardTraceExample for each core.

{{:Template:EvalBoardTraceHeader
| Vendor=Super Inc.
| Device=SuperDuper
| BoardName=SuperDuperBoard
| JlinkVersion=V7.96f
| OzoneVersion=V3.32a
| StudioVersion=V8.12a
| PinTrace=yes
| BufTrace=yes
}}{{:Template:EvalBoardTraceExample
| BoardName=SuperDuperBoard
| Heading=SuperCore0
| PinTrace=yes
| PinTraceEx=DEVICE_TracePins.zip
| BufTrace=yes
| BufTraceEx=DEVICE_TraceBuffer.zip
| BufTrace=yes
}}{{:Template:EvalBoardTraceExample
| BoardName=SuperDuperBoard
| Heading=SuperCore1
| TraceEx=DEVICE_TraceExample.zip
| PinTrace=yes
| BufTrace=yes
}}{{:Template:EvalBoardTraceSignals
| TestedHw=yes
| BoardName=SuperDuperBoard
| TestedHwPic=Board.png
| PinTrace=yes
| PinTraceClk=DEVICE_Multiple_TCLK.png
| PinTraceRise=DEVICE_RiseTime_TCLK.png
| PinTraceSetup=DEVICE_SetupTime_TD0.png
| Optional=
=== Specifics/Limitations ===
The SuperDuper needs some modifications for all 4 trace data pins to work. Sacrifice a living chicken to your local shaman. For more information about this see the board specific user manual.
}}