SEGGER

SystemView
Recording and analyzing runtime
behavior of embedded systems

User Guide

Document: UM08027
Software Version: 3.52
Revision: 0
Date: July 4, 2023

A product of SEGGER Microcontroller GmbH

www.segger.com
2

Disclaimer
The information written in this document is assumed to be accurate without guarantee. The
information in this manual is subject to change for functional or performance improvements
without notice. SEGGER Microcontroller GmbH (SEGGER) assumes no responsibility for any errors
or omissions in this document. SEGGER disclaims any warranties or conditions, express, implied
or statutory for the fitness of the product for a particular purpose. It is your sole responsibility
to evaluate the fitness of the product for any specific use.

Copyright notice
You may not extract portions of this manual or modify the PDF file in any way without the prior
written permission of SEGGER. The software described in this document is furnished under a
license and may only be used or copied in accordance with the terms of such a license.
© 2015 - 2023 SEGGER Microcontroller GmbH, Monheim am Rhein / Germany

Trademarks
Names mentioned in this manual may be trademarks of their respective companies.
Brand and product names are trademarks or registered trademarks of their respective holders.

Contact address
SEGGER Microcontroller GmbH
Ecolab-Allee 5
D-40789 Monheim am Rhein

Germany

Tel. +49-2173-99312-0
Fax. +49-2173-99312-28
E-mail: support@segger.com
Internet: www.segger.com

Credits
Special thanks to Jean Labrosse for continuous feedback, beta testing, and good ideas.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

3

Manual versions
This manual describes the current software version. If you find an error in the manual or a
problem in the software, please inform us and we will try to assist you as soon as possible.
Contact us for further information on topics or functions that are not yet documented.
Print date: July 4, 2023

Software Revision Date By Description

3.42 0 221208 PC
• Added Peak Load and Peak Used metrics to heap monitoring.

3.40 0 221208 PC • Section “Heap” added.

• Section “Dynamic memory monitor functions” added.

3.32 0 210426 JL • Section “NuttX” added.

• Section “Zephyr” added.

• Chapter “Overview” updated.

• Section “Package Content” updated.
3.20 0 201013 PO • Section “Licensing” updatedt to refer to SFL.
• Chapter “Getting Started” updated to match example recording.
• Chapter “The SystemView Application” updated to match latest GUI.
• Section “Command Line Options” added.

3.10 0 191213 JL
• Manual updated to SystemView V3.

2.52 4 180921 NV • Section “FreeRTOS” added Note about number of tasks displayed by
default.

2.52 3 180809 NV
• Section “No OS” added link to generic setup example.

2.52 2 180315 NV
• Section “FreeRTOS” updated for V10.

2.52 1 170907 JL • Section “FreeRTOS” updated.

• Section “uC/OS-II” added.

• Section “Command Line Options” added.

2.52 0 170818 JL
• Section “Micrium OS Kernel” added.
• Chapter “API reference” updated.

2.50 0 170426 JL • Section “SystemView PRO” added.

• Section “Event filter” added.

2.42 1 170306 AG
• Chapter “Supported CPUs” updated.

2.42 0 170209 JL • Section “GUI Controls” updated.

• Section “Trigger Modes” added.

2.40 0 160728 JL • Chapter “Getting started with SystemView” updated.

• Chapter “API reference” updated.

2.38 0 160624 JL
• Section “Renesas RX” to “Supported Devices” added.

• Section “Getting started with SystemView” updated.

2.36 0 160524 JL • Section “The SystemView Application” updated.
• Section “Supported OSes” updated.
• Section “Integration guide” updated.

2.34 0 160401 JL • Section “Optimizing SystemView” added.

• Section “uC/OS-III” to “Supported OSes” added.

2.32 1 160322 JL
• Chapter “Performance and resource usage” added.

2.32 0 160310 JL
• Section Supported OSes added.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

4

Software Revision Date By Description

• Post-Mortem mode added.
• Chapters restructured by relevance.
• Sample configuration for TI AM3350 Cortex-A8 added

• Section Using SystemViewer added.

• Section Integrating SEGGER SystemView into an OS added.
• Section Integrating SEGGER SystemView into a middleware module
2.30 0 160127 JL
added.
• Section Frequently asked questions added.
• Section Supported CPUs added.
• Section SEGGER SystemView API functions updated.

2.28 0 160114 JL • Terminal Window description added.

• Screenshots updated.

2.26 1 160106 JL
Configuration for embOS and FreeRTOS added.

2.26 0 151223 JL
• Printf functionality added.

2.24 0 151216 JL
• macOS and Linux version added.

2.22 0 151214 JL
• GUI and performance improvements.

2.20 1 151119 JL • Screenshots updated.

• Fixed defines in configuration.

2.20 0 151118 JL • SystemViewer GUI elements restructured.

• SystemView Config module added.

2.10 0 151106 JL
• Official Release.

2.09 0 151026 JL
• Initial Pre-Release.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

5

About this document

Assumptions
This document assumes that you already have a solid knowledge of the following:
• The software tools used for building your application (assembler, linker, C compiler).
• The C programming language.
• The target processor.
• DOS command line.
If you feel that your knowledge of C is not sufficient, we recommend The C Programming Lan-
guage by Kernighan and Ritchie (ISBN 0--13--1103628), which describes the standard in C pro-
gramming and, in newer editions, also covers the ANSI C standard.

How to use this manual

This manual explains all the functions and macros that the product offers. It assumes you have
a working knowledge of the C language. Knowledge of assembly programming is not required.

Typographic conventions for syntax

This manual uses the following typographic conventions:

Style Used for

Body Body text.

Text that you enter at the command prompt or that appears on
Keyword
the display (that is system functions, file- or pathnames).
Parameter Parameters in API functions.
Sample Sample code in program examples.
Sample comment Comments in program examples.
Reference to chapters, sections, tables and figures or other doc-
Reference
uments.
GUIElement Buttons, dialog boxes, menu names, menu commands.
Emphasis Very important sections.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

6

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

7

Table of contents

1 Overview ..................................................................................................................... 12
1.1 What is SEGGER SystemView? .......................................................................13
1.1.1 How does it work? ............................................................................ 13
1.1.2 What resources are required on the target side? ................................... 13
1.1.3 On which CPUs can SystemView be used? ............................................ 14
1.1.4 How much work is it to add it to a target system? .................................14
1.2 The SEGGER SystemView package ................................................................. 15
1.2.1 Download and installation .................................................................. 15
1.2.2 Package content ................................................................................15
1.3 Licensing .....................................................................................................18
1.3.1 Non-commercial license ..................................................................... 18

2 Getting started with the SystemView Application ....................................................... 19

2.1 Starting SystemView and loading data ............................................................20
2.2 A first look at the system ............................................................................. 21
2.3 Analysing system activity .............................................................................. 23
2.4 Further analysis of the application core ...........................................................24
2.5 Analysis conclusion .......................................................................................26

3 The SystemView Application ...................................................................................... 27

3.1 Introduction .................................................................................................28
3.2 Timeline ...................................................................................................... 29
3.3 Events list ................................................................................................... 30
3.3.1 Event Filter ...................................................................................... 31
3.4 Terminal ......................................................................................................32
3.5 CPU Load .................................................................................................... 33
3.6 Contexts ..................................................................................................... 34
3.7 Runtime ...................................................................................................... 35
3.8 Heap .......................................................................................................... 36
3.8.1 Heap events ..................................................................................... 36
3.8.2 API Functions ................................................................................... 36
3.9 System ....................................................................................................... 37
3.10 Trigger Modes ............................................................................................ 40
3.11 GUI controls .............................................................................................. 41
3.12 Command Line Options ............................................................................... 44
3.13 Recording with SystemView ......................................................................... 46
3.13.1 Continuous recording ....................................................................... 46
3.13.1.1 J-Link Recorder .................................................................... 46
3.13.1.2 IP Recorder ......................................................................... 47

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

8

3.13.1.3 UART Recorder ..................................................................... 47

3.13.2 Single-shot recording ....................................................................... 47
3.13.3 Post-mortem analysis .......................................................................48
3.13.4 Save and load recordings ................................................................. 49
3.13.5 Export recordings ............................................................................ 49

4 Getting started with SystemView on the target .......................................................... 50

4.1 Including SystemView in the application ......................................................... 51
4.1.1 Generic files ..................................................................................... 51
4.1.2 Generic configuration .........................................................................51
4.1.3 OS-specific and target-specific files ..................................................... 51
4.1.4 Recorder files ................................................................................... 52
4.2 Initializing SystemView ................................................................................. 53
4.3 Sending system information .......................................................................... 54
4.4 Start and stop recording ............................................................................... 56
4.5 Compile-time configuration ............................................................................57
4.5.1 System-specific configuration ..............................................................57
4.5.1.1 SEGGER_SYSVIEW_GET_TIMESTAMP() ......................................58
4.5.1.2 SEGGER_SYSVIEW_TIMESTAMP_BITS ....................................... 59
4.5.1.3 SEGGER_SYSVIEW_GET_INTERRUPT_ID() ................................. 60
4.5.1.4 SEGGER_SYSVIEW_LOCK() ......................................................61
4.5.1.5 SEGGER_SYSVIEW_UNLOCK() ..................................................62
4.5.2 Generic configuration .........................................................................62
4.5.2.1 SEGGER_SYSVIEW_RTT_BUFFER_SIZE ......................................63
4.5.2.2 SEGGER_SYSVIEW_RTT_CHANNEL ............................................64
4.5.2.3 SEGGER_SYSVIEW_USE_STATIC_BUFFER .................................. 65
4.5.2.4 SEGGER_SYSVIEW_POST_MORTEM_MODE ................................ 66
4.5.2.5 SEGGER_SYSVIEW_SYNC_PERIOD_SHIFT ................................. 67
4.5.2.6 SEGGER_SYSVIEW_ID_BASE ................................................... 68
4.5.2.7 SEGGER_SYSVIEW_ID_SHIFT .................................................. 69
4.5.2.8 SEGGER_SYSVIEW_MAX_STRING_LEN ...................................... 70
4.5.2.9 SEGGER_SYSVIEW_MAX_ARGUMENTS ...................................... 71
4.5.2.10 SEGGER_SYSVIEW_BUFFER_SECTION ..................................... 72
4.5.3 RTT configuration .............................................................................. 72
4.5.3.1 BUFFER_SIZE_UP ................................................................... 73
4.5.3.2 BUFFER_SIZE_DOWN ..............................................................74
4.5.3.3 SEGGER_RTT_MAX_NUM_UP_BUFFERS ......................................75
4.5.3.4 SEGGER_RTT_MAX_NUM_DOWN_BUFFERS ................................ 76
4.5.3.5 SEGGER_RTT_MODE_DEFAULT ................................................. 77
4.5.3.6 SEGGER_RTT_PRINTF_BUFFER_SIZE .........................................78
4.5.3.7 SEGGER_RTT_SECTION ........................................................... 79
4.5.3.8 SEGGER_RTT_BUFFER_SECTION .............................................. 80
4.5.4 Optimizing SystemView ......................................................................80
4.5.4.1 Compiler optimization ............................................................. 80
4.5.4.2 Recording optimization ............................................................80
4.5.4.3 Buffer configuration ................................................................ 81
4.6 Supported CPUs ........................................................................................... 82
4.6.1 Cortex-M3 / Cortex-M4 ...................................................................... 82
4.6.1.1 Event timestamp ....................................................................82
4.6.1.2 Interrupt ID .......................................................................... 82
4.6.1.3 SystemView lock and unlock ....................................................82
4.6.1.4 Sample configuration .............................................................. 83
4.6.2 Cortex-M7 ........................................................................................ 86
4.6.3 Cortex-M0 / Cortex-M0+ / Cortex-M1 .................................................. 86
4.6.3.1 Cortex-M0 Event timestamp .................................................... 86
4.6.3.2 Cortex-M0 Interrupt ID ........................................................... 87
4.6.3.3 Cortex-M0 SystemView lock and unlock .................................... 88
4.6.3.4 Cortex-M0 Sample configuration ...............................................88
4.6.4 Cortex-A / Cortex-R ...........................................................................91

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

9

4.6.4.1 Cortex-A/R Event timestamp ................................................... 92

4.6.4.2 Cortex-A/R Interrupt ID .......................................................... 93
4.6.4.3 Cortex-A/R SystemView lock and unlock ................................... 94
4.6.4.4 Renesas RZ/A1 Cortex-A9 sample configuration ......................... 95
4.6.4.5 TI AM3358 Cortex-A8 sample configuration ............................... 98
4.6.5 Renesas RX .................................................................................... 102
4.6.5.1 Renesas RX Event timestamp .................................................102
4.6.5.2 Renesas RX Interrupt ID ....................................................... 103
4.6.5.3 Renesas RX SystemView lock and unlock ................................. 103
4.6.5.4 Renesas RX Sample configuration ........................................... 104
4.6.6 Other CPUs .....................................................................................107
4.7 Supported OSes ......................................................................................... 108
4.7.1 embOS ...........................................................................................108
4.7.1.1 Configuring embOS for SystemView ........................................ 108
4.7.2 uC/OS-III ....................................................................................... 108
4.7.2.1 Configuring uC/OS-III for SystemView .................................... 108
4.7.3 uC/OS-II ........................................................................................ 109
4.7.3.1 Configuring uC/OS-II for SystemView ......................................109
4.7.4 Micrium OS Kernel ...........................................................................110
4.7.4.1 Configuring Micrium OS Kernel for SystemView ........................ 110
4.7.5 FreeRTOS ....................................................................................... 110
4.7.5.1 Configuring FreeRTOS for SystemView .................................... 111
4.7.6 NuttX ............................................................................................. 111
4.7.7 Zephyr ........................................................................................... 111
4.7.8 Other OSes .....................................................................................111
4.7.8.1 No OS .................................................................................111

5 SystemView on the target .........................................................................................113

5.1 Performance Markers .................................................................................. 114
5.2 Terminal Output ......................................................................................... 115
5.3 Resource Names ........................................................................................ 116

6 Instrumenting OSes and software modules ..............................................................117

6.1 Integrating SEGGER SystemView into an OS ..................................................118
6.1.1 Recording task activity ..................................................................... 118
6.1.1.1 Task Create ......................................................................... 118
6.1.1.2 Task Start Ready .................................................................. 119
6.1.1.3 Task Start Exec .................................................................... 119
6.1.1.4 Task Stop Ready .................................................................. 120
6.1.1.5 Task Stop Exec .................................................................... 120
6.1.1.6 System Idle ......................................................................... 120
6.1.2 Recording interrupts ........................................................................ 121
6.1.2.1 Enter Interrupt .....................................................................121
6.1.2.2 Exit Interrupt ....................................................................... 121
6.1.2.3 Example ISRs ...................................................................... 122
6.1.3 Recording run-time information ......................................................... 122
6.1.3.1 pfGetTime ........................................................................... 123
6.1.3.2 pfSendTaskList ..................................................................... 123
6.1.4 Recording OS API calls .....................................................................124
6.1.5 OS description file ........................................................................... 124
6.1.5.1 API Function description ........................................................ 124
6.1.5.2 Task State description ........................................................... 125
6.1.5.3 Option description ................................................................ 126
6.1.6 OS integration sample ..................................................................... 126
6.2 Integrating SEGGER SystemView into a middleware module .............................129
6.2.1 Registering the module .................................................................... 129
6.2.2 Recording module activity .................................................................130
6.2.3 Providing the module description .......................................................130

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

10

7 API reference ............................................................................................................ 132

7.1 Formatted output control strings .................................................................. 133
7.1.1 Composition ....................................................................................133
7.1.2 Flag characters ............................................................................... 133
7.1.3 Length modifiers ............................................................................. 133
7.1.4 Conversion specifiers ....................................................................... 133
7.2 Control functions ........................................................................................ 135
7.2.1 SEGGER_SYSVIEW_Init() ..................................................................136
7.2.2 SEGGER_SYSVIEW_Start() ............................................................... 137
7.2.3 SEGGER_SYSVIEW_Stop() ................................................................ 138
7.2.4 SEGGER_SYSVIEW_IsStarted() ..........................................................139
7.2.5 SEGGER_SYSVIEW_EnableEvents() .................................................... 140
7.2.6 SEGGER_SYSVIEW_DisableEvents() ................................................... 141
7.3 Configuration functions ............................................................................... 142
7.3.1 SEGGER_SYSVIEW_SetRAMBase() ..................................................... 143
7.3.2 SEGGER_SYSVIEW_SendTaskInfo() .................................................... 144
7.3.3 SEGGER_SYSVIEW_SendTaskList() .....................................................145
7.3.4 SEGGER_SYSVIEW_SendSysDesc() .................................................... 146
7.3.5 SEGGER_SYSVIEW_SendModule() ......................................................147
7.3.6 SEGGER_SYSVIEW_SendModuleDescription() ...................................... 148
7.3.7 SEGGER_SYSVIEW_SendNumModules() ..............................................149
7.4 Application-level event recording functions .................................................... 150
7.4.1 SEGGER_SYSVIEW_MarkStart() .........................................................151
7.4.2 SEGGER_SYSVIEW_Mark() ................................................................152
7.4.3 SEGGER_SYSVIEW_MarkStop() ......................................................... 153
7.4.4 SEGGER_SYSVIEW_NameMarker() ..................................................... 154
7.4.5 SEGGER_SYSVIEW_NameResource() .................................................. 155
7.4.6 SEGGER_SYSVIEW_Print() ................................................................ 156
7.4.7 SEGGER_SYSVIEW_PrintfHost() .........................................................157
7.4.8 SEGGER_SYSVIEW_PrintfHostEx() ..................................................... 158
7.4.9 SEGGER_SYSVIEW_PrintfTarget() ...................................................... 159
7.4.10 SEGGER_SYSVIEW_PrintfTargetEx() ................................................. 160
7.4.11 SEGGER_SYSVIEW_Warn() ............................................................. 161
7.4.12 SEGGER_SYSVIEW_WarnfHost() ...................................................... 162
7.4.13 SEGGER_SYSVIEW_WarnfTarget() .................................................... 163
7.4.14 SEGGER_SYSVIEW_Error() ..............................................................164
7.4.15 SEGGER_SYSVIEW_ErrorfHost() ...................................................... 165
7.4.16 SEGGER_SYSVIEW_ErrorfTarget() .................................................... 166
7.5 Module and RTOS object functions ................................................................167
7.5.1 SEGGER_SYSVIEW_RegisterModule() ................................................. 168
7.5.2 SEGGER_SYSVIEW_RecordModuleDescription() ....................................169
7.6 Realtime event recording functions ............................................................... 170
7.6.1 SEGGER_SYSVIEW_OnIdle() ............................................................. 171
7.6.2 SEGGER_SYSVIEW_OnTaskCreate() ................................................... 172
7.6.3 SEGGER_SYSVIEW_OnTaskStartExec() ............................................... 173
7.6.4 SEGGER_SYSVIEW_OnTaskStartReady() ............................................. 174
7.6.5 SEGGER_SYSVIEW_OnTaskStopExec() ................................................175
7.6.6 SEGGER_SYSVIEW_OnTaskStopReady() ..............................................176
7.6.7 SEGGER_SYSVIEW_OnTaskTerminate() ...............................................177
7.6.8 SEGGER_SYSVIEW_RecordEnterISR() .................................................178
7.6.9 SEGGER_SYSVIEW_RecordExitISR() ...................................................179
7.6.10 SEGGER_SYSVIEW_RecordExitISRToScheduler() ................................ 180
7.6.11 SEGGER_SYSVIEW_RecordEnterTimer() ............................................ 181
7.6.12 SEGGER_SYSVIEW_RecordExitTimer() .............................................. 182
7.6.13 SEGGER_SYSVIEW_RecordSystime() ................................................ 183
7.7 Dynamic memory monitor functions ............................................................. 184
7.7.1 SEGGER_SYSVIEW_HeapDefine() ...................................................... 185
7.7.2 SEGGER_SYSVIEW_HeapAlloc() ......................................................... 186
7.7.3 SEGGER_SYSVIEW_HeapAllocEx() ..................................................... 187

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

11

7.7.4 SEGGER_SYSVIEW_HeapFree() ......................................................... 188

7.8 High-level API instrumentation functions ....................................................... 189
7.8.1 SEGGER_SYSVIEW_RecordVoid() ....................................................... 190
7.8.2 SEGGER_SYSVIEW_RecordU32() ....................................................... 191
7.8.3 SEGGER_SYSVIEW_RecordU32x2() .................................................... 192
7.8.4 SEGGER_SYSVIEW_RecordU32x3() .................................................... 193
7.8.5 SEGGER_SYSVIEW_RecordU32x4() .................................................... 194
7.8.6 SEGGER_SYSVIEW_RecordU32x5() .................................................... 195
7.8.7 SEGGER_SYSVIEW_RecordU32x6() .................................................... 196
7.8.8 SEGGER_SYSVIEW_RecordU32x7() .................................................... 197
7.8.9 SEGGER_SYSVIEW_RecordU32x8() .................................................... 198
7.8.10 SEGGER_SYSVIEW_RecordU32x9() .................................................. 199
7.8.11 SEGGER_SYSVIEW_RecordU32x10() .................................................200
7.8.12 SEGGER_SYSVIEW_RecordString() ................................................... 201
7.8.13 SEGGER_SYSVIEW_RecordEndCall() ................................................. 202
7.8.14 SEGGER_SYSVIEW_RecordEndCallU32() ........................................... 203
7.9 Low-level event encoding functions ...............................................................204
7.9.1 SEGGER_SYSVIEW_EncodeU32() ....................................................... 205
7.9.2 SEGGER_SYSVIEW_EncodeData() ...................................................... 206
7.9.3 SEGGER_SYSVIEW_EncodeString() .................................................... 207
7.9.4 SEGGER_SYSVIEW_EncodeId() ..........................................................208
7.9.5 SEGGER_SYSVIEW_ShrinkId() ...........................................................209
7.9.6 SEGGER_SYSVIEW_SendPacket() ...................................................... 210
7.10 Application-provided functions .................................................................... 211
7.10.1 SEGGER_SYSVIEW_Conf() .............................................................. 212
7.10.2 SEGGER_SYSVIEW_X_GetTimestamp() ............................................. 213

8 Performance and resource usage ............................................................................ 214

8.1 Memory requirements ................................................................................. 215
8.1.1 ROM usage ..................................................................................... 215
8.1.2 Static RAM usage ............................................................................ 215
8.1.3 Stack RAM usage ............................................................................ 215

9 Frequently asked questions ......................................................................................217

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

 Chapter 1

Overview

This section describes SEGGER SystemView in general.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

13 CHAPTER 1 What is SEGGER SystemView?

1.1 What is SEGGER SystemView?

SystemView is a toolkit for visual analysis of any embedded system. SystemView gives
complete insight into an application, to gain a deep understanding of the runtime behavior,
going far beyond what a debugger is offering. This is particularly advantageous when de-
veloping and working in complex systems with multiple tasks and events.
SystemView consists of two parts:
• The PC visualization SystemView Application,
• Code that gathers telemetry data on the target system.
The SystemView application allows analysis and profiling of the behavior of an embedded
system. It records the telemetry data generated by the embedded system and visualizes
that information in a variety of ways. The recording can be saved to a file for later analysis
or for documentation of the system.
The telemtery data is recorded through the debug interface, through a network connection,
or over a serial line. When recording through the debug interface, no additional hardware
(and additional pinning) is required to use SystemView. It can be used on any system that
allows debug access.
With a SEGGER J-Link and its Real Time Transfer (RTT) technology, SystemView can con-
tinuously record, analyze, and visualize data in real time.
SystemView makes it possible to analyze which interrupts, tasks, and software timers have
executed, how often, when exactly and how much time they have used. It sheds light on
what exactly happened, in which order, which interrupt has triggered which task switch,
which interrupt and task has called which API function of the underlying modules.
Cycle-accurate profiling can be performed and performance markers can be added in the
system to measure timings.
SystemView can be used to verify that the embedded system behaves as expected and can
be used to find problems and inefficiencies, such as superfluous and spurious interrupts,
unexpected task changes, or badly-chosen task priorities. It can be used with any (RT)OS
which is instrumented to call SystemView event functions, but also in systems without an
instrumented RTOS or without any RTOS at all, to analyze interrupt execution and to time
user functionality like time-critical subroutines.

1.1.1 How does it work?

On the target side a small software module, containing SYSTEMVIEW and RTT, must be
included. The SYSTEMVIEW module collects and formats the monitor data and passes it
to RTT.
The target system calls SYSTEMVIEW functions in certain situations, such as interrupt start
and interrupt end, to monitor events. SystemView stores these events together with a
configurable, high-accuracy timestamp. Timestamps can be as accurate as 1 CPU cycle,
which equates to 5 ns on a 200 MHz CPU.
The RTT module stores the data in the target buffer, which enables continuous recording,
as well as single-shot recording and post-mortem analysis.
The recorder interface reads the data from the RTT buffer and sends it to the SystemView
Application.

1.1.2 What resources are required on the target side?

The combined ROM size of RTT and the SYSTEMVIEW modules is less than 2 KByte. For
typical systems, about 600 bytes of RAM are sufficient for continuous recording. For sys-
tem-triggered recording the buffer size is determined by the time to be recorded and the
amount of events. No other hardware is required. The CPU requires less than 1 us for typical
events (based on a 200 MHz Cortex-M4 CPU), which results in less than 1% overhead in a
system with 10,000 events per second. Since the debug interface (JTAG, SWD, FINE, …) is
used to transfer the data, no additional pins are required.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

14 CHAPTER 1 What is SEGGER SystemView?

1.1.3 On which CPUs can SystemView be used?

SystemView can be used on any CPU. Continuous real-time recording can be carried out on
any system supported by J-Link RTT technology or using a network connection or serial line.
RTT requires the ability to read memory via the debug interface during program execution
which is generally supported in ARM Cortex-M0, M0+, M1, M3, M4, M7, M23, M33 processors
as well as all Renesas RX devices.
On systems which are not supported by the RTT technology the buffer content can also be
read manually through the debug probe when the system is halted, which allows single-shot
recording until the buffer is filled and post-mortem analysis to capture the latest recorded
data. Single-shot and post-mortem recording can be triggered by the system to be able to
control when a recording starts and stops.

1.1.4 How much work is it to add it to a target system?

Not very much. A small number of files need to be added to the makefile or project. If the
operating system supports SystemView, then only one function needs to be called. In a
system without RTOS or non-instrumented RTOS, two lines of code need to be added to
every interrupt or function which should be monitored. That’s all and should not take more
than a few minutes.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

15 CHAPTER 1 The SEGGER SystemView package

1.2 The SEGGER SystemView package

The following sections describe how to install the SEGGER SystemView package and its
contents.

1.2.1 Download and installation

The SEGGER SystemView package is available for Windows, macOS and Linux as an installer
setup and a portable archive.
Download the latest package for your operation system from https://www.segger.com/sys-
temview.
In order to do live recording the current J-Link Software and Documentation Package must
be installed. Download and instructions are available at https://www.segger.com/jlink.

Windows Installer
Download the latest setup from http://www.segger.com/systemview and execute it. The
setup wizard guides through the installation.
After installation the package content can be accessed through the Windows Start menu
or from the file explorer.

Windows Portable Package

Download the latest zip from http://www.segger.com/systemview and extract it to any
directory on the file system.
No installation is required, after extraction the package content can be used directly.

macOS Installer
Download the latest pkg installer from http://www.segger.com/systemview and execute it.
The package installer guides through the installation.
After installation the SystemView Application can be accessed through Launchpad.

Linux Requirements
To run SystemView on Linux the Qt V4.8 libraries have to be installed on the system.

Linux Installer
Download the latest DEB or RPM installer for your Linux from http://www.segger.com/sys-
temview and execute it. The software installer guides through the installation.

Linux Portable Package

Download the latest archive for your Linux from http://www.segger.com/systemview and
extract it to any directory on the file system.
No installation is required, after extraction the package content can be used directly.

Target Sources
Download the latest sources to be included in the embedded application from http://
www.segger.com/systemview and extract it to a folder of your choice.
Sources to interface with SEGGER software, such as embOS are also included.

1.2.2 Package content

The SEGGER SystemView package includes everything needed for application tracing — the
host PC visualization SystemView Application and sample trace files for a quick and easy
start.
The following tables list the package content.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

16 CHAPTER 1 The SEGGER SystemView package

SystemView package

File Description

The SystemView analysis and visualization

./SystemView*
tool.
./Doc/UM08027_SystemView.pdf This documentation.
./Doc/Release_SystemView.html Release notes and revision history.
./Description/SYSVIEW_*.txt SystemView API description files.
Demonstrates the usage of the callback in-
./Sample/FS_DeviceActivity.SVDat
voked on each device operation.
SystemView Sample recording of SEG-
GER emFile, testing read and write
performance of the Macronix NAND
./Sample/FS_Performance.SVDat
Flash (MX30LF1GE8ABTI) on the
SEGGER emPower board (Freescale
MK66FN2M0VMD18)
SystemView sample trace file of a web
./Sample/OS_IP_WebServer.SVDat
server application.
SystemView sample trace file of a simple
./Sample/OS_Start_LEDBlink.SVDat
embOS application.
SystemView sample recording showing
./Sample/Sample_Overflow.SVDat
SystemView buffer overflows.
SystemView sample trace file of a simple
./Sample/uCOS_Start.SVDat
uC/OS-III application.

Target source package

File Description

./Src/Config/Global.h Global data types for SystemView.

SEGGER Real Time Transfer (RTT) configu-
./Src/Config/SEGGER_RTT_Conf.h
ration file.
./Src/Config/SEGGER_SYSVIEW_Conf.h SEGGER SYSTEMVIEW configuration file.
Recorder via network connection using
./Src/Sample/COMM
embOS and emNet.
Initialization and configuration of Sys-
./Src/Sample/embOS
temView with embOS.
Initialization and configuration of Sys-
./Src/Sample/FreeRTOSV8
temView with FreeRTOS V8.
Initialization and configuration of Sys-
./Src/Sample/FreeRTOSV9
temView with FreeRTOS V9.
Initialization and configuration of Sys-
./Src/Sample/FreeRTOSV10
temView with FreeRTOS V10.
Initialization and configuration of Sys-
./Src/Sample/MicriumOSKernel
temView with the Micrium OS Kernel.
Initialization and configuration of Sys-
./Src/Sample/NoOS
temView with no OS.
Initialization and configuration of Sys-
./Src/Sample/uCOS-II
temView with uC/OS-II.
Initialization and configuration of Sys-
./Src/Sample/uCOS-III
temView with uC/OS-III.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

17 CHAPTER 1 The SEGGER SystemView package

File Description

Global types & general purpose utility

./Src/SEGGER/SEGGER.h
functions.
./Src/SEGGER/SEGGER_RTT.c SEGGER RTT module source.
./Src/SEGGER/SEGGER_RTT.h SEGGER RTT module header.
./Src/SEGGER/SEGGER_RTT_ASM_ARMv7M.S Optimized RTT routines for Cortex-M.
./Src/SEGGER/SEGGER_SYSVIEW.c SEGGER SYSTEMVIEW module source.
./Src/SEGGER/SEGGER_SYSVIEW.h SEGGER SYSTEMVIEW module header.
./Src/SEGGER/SEGGER_SYSVIEW_ConfDe- SEGGER SYSTEMVIEW configuration fall-
faults.h back.
./Src/SEGGER/SEGGER_SYSVIEW_Int.h SEGGER SYSTEMVIEW internal header.
./Src/SEGGER/Syscalls/SEGGER_RT- Sources for toolchain dependent low level
T_Syscalls_*.c routines for I/O via RTT.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

18 CHAPTER 1 Licensing

1.3 Licensing
SystemView can be used free of charge for non-commercial purposes under SEGGER’s
Friendly License (https://www.segger.com/license-sfl). For any other use a commercial-use
license is required.
There are no feature limitations with a non-commercial license. SystemView enables un-
limited recording and comes with features for better analysis, search, and filtering.
Commercial-use licenses for SystemView are available as single-user licenses as well as
group or company-wide licenses. For more information refer to SEGGER’s Commercial-use
License (https://www.segger.com/license-cul).

1.3.1 Non-commercial license

SystemView may be used with a non-commercial license for evaluation, educational and
hobbyist purposes.
When you use SystemView under the non-commercial license, no activation is required.
On start of the SystemView Application, a popup is presented. Click continue to accept the
license terms.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

 Chapter 2

Getting started with the

SystemView Application

This section describes how to get started with SEGGER SystemView. It explains how to
analyze an application based on monitored data.
This chapter refers to the sample data file OS_IP_WebServer.SVDat which is part of the
SEGGER SystemView package.
The sample data file shows the behavior of a target system running the embOS RTOS, the
emNet TCP/IP stack and a web server application.
We are going to analyze what the application is doing with the information from SEGGER
SystemView.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

20 CHAPTER 2 Starting SystemView and loading data

2.1 Starting SystemView and loading data

SystemView can monitor data live from the target application. The monitored data can be
saved to a file for later work with it. Saved data can analyzed without a J-Link and even
without the target hardware or the target application. This enables analysis of the system
by developers who do not have physical access to it.
• Start the SystemView Application (SystemView.exe) from the Windows Start menu or
the installation directory.
• On the first start of SystemView it will open the sample recording.
• On further starts select File →Recent Files → $PackageInstallationDir$/
Sample/OS_IP_WebServer.SVdat.
SystemView loads and analyzes the data, shows the system information of the loaded
recording, and should now look like this:

SystemView after File Load

The recording was done for an application that creates a web server that delivers the
embOS/IP demo web page, when accessed by a web-browser. The sample data has been
gathered while the web server was running and the browser loaded the web page multiple
times.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

21 CHAPTER 2 A first look at the system

2.2 A first look at the system

We will take a first look at the data to get some information about the monitored system.

System Information
The System Information dialog, shown after loading the data, provides a first overview on
the recording. It displays information about the target system, the recording and statistical
information of tasks, interrupts, and events. The system information is reported by the
application, therefore SystemView does not require any additional configuration to analyze
and display the system behavior.

Timeline

SystemView Timeline
The Timeline window shows the complete monitored data. In the Events list, scroll to the
first item to get started.
The Timeline window visualizes the system activity by context (task, interrupt, scheduler
and idle) over the system time. Each row refers to one context item and we can see all
items which have been used in the application while it has been monitored.
At the beginning we can see that there are two tasks, IP_Task and IP_WebServer, indicated
by the light background in the context row.
Zoom in to a timeline width of 2.0 ms and double-click on the vertical line below ’+1. 0 ms’
to center and select the item. (Use the mouse wheel or the [+]/[-] keys to zoom, or use
the menu or context menu to set the zoom level to a distinct value.)
There is some system activity every millisecond from the SysTick interrupt.
Move the mouse over a context name to get more information about the context type and
run time information.
Click on the right arrow button of the IP_Task context to jump to its next execution.
Zoom in or out to show the activity in detail.
We can see the SysTick interrupt returned to the OS Scheduler, which makes the IP_Task
ready, indicated by the grey bar in the IP_Task’s row, and lets it run. The IP_Task returns
from the embOS API function OS_TASKEVENT_GetTimed with return value 0, which indicates
that no event has been signaled in time.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

22 CHAPTER 2 A first look at the system

The IP_Task calls three other embOS API functions which quickly return and OS_TASKEVEN-
T_GetTimed, which activates the scheduler, deactivates the task, and puts the system into
idle. IP_Task will be activated again when the event (EventMask = 1) occurs or after the
timeout of 10 ticks (i.e. 10.0 ms, as a tick occures every 1.0 ms).
Recorded function calls are visualized in the timeline as small bars in the context row.
The vertical peak line indicates the call of a function, the bar shows the length of the call.
Stacked bars visualize nested function calls.
Move the mouse over the context activity to get more information about context runtime,
events and function calls.

Conclusion
We have got some first information about the monitored system. From the Timeline we
know which tasks and interrupts are used by the application, that it is controlled by the
1 kHz SysTick interrupt, and the IP_Task is activated at least every 10 ms.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

23 CHAPTER 2 Analysing system activity

2.3 Analysing system activity

After getting some information of the system we will analyze how the system is activated.

SystemView Events List and synchronized Timeline

Events list
The Events list shows all events as they are reported from the system and displays their
information, including timestamp of the event, active context, type of event and event
details. It is synchronized with the Timeline.
We have seen that every millisecond the SysTick ISR enters and exits and that it activates
the IP_Task every 10 ms because its timeout occurred.
Go to event #66 with Go →Goto Event… (Keyboard shortcut: Ctrl+G). It is a call of
OS_TASKEVENT_GetTimed with a timeout of 10 ms from the IP_Task at 00.016 052 607.
The timeout would happen at 00.026 052 607.
Set a time reference on the event (View →Toggle Reference, Right-Click → Toggle Ref-
erence, or (Keyboard shortcut R). All following timestamps in the Events list are measured
from the latest reference.
To now see whether the IP_Task runs because of the timeout or because of the event it
waits for, go to the next activity of IP_Task with Go →Forward (Keyboard shortcut: F).
The timestamp is 00.003 467 857, so 3 ms after the last reference and clearly before the
10 ms timeout. So the task has been activated by the event it waited for.
We can see the ETH_Rx interrupt happened before. We received a packet via ethernet (60
Bytes on interface 0). Therefore the ETH_Rx interrupt signaled the event, which marked the
task as ready as indicated in the timeline. The ETH_Rx interrupt returns to the Scheduler.
IP_Task runs and returns from OS_TASKEVENT_GetTimed with return value 0b1, indicating
that this event happened.

Conclusion
Going further through the events, we can see that the IP_Task is activated after the 10 ms
timeout occurred or after we received something and the ETH_Rx interrupt occurred.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

24 CHAPTER 2 Further analysis of the application core

2.4 Further analysis of the application core

We now know that the system is mainly controlled by the ETH_Rx interrupt. The next step
is to see what the system does when it is more active.

SystemView Application Analysis

Timeline, Events list, Terminal and Contexts window

The windows of SystemView are synchronized and provide the best possibilities for system
analysis when used together.
The Log output of the web-server application has also been sent through SystemView and
is displayed in the Terminal window along with the timestamp it has been logged and the
active context.
Select a message in the Terminal to also select it in the Events list and the Timeline. The
Timeline also indicates all Terminal output.
Go through the messages to see the system initialization when the Ethernet connection
is established and select “WebS: Get /”, which is the request from the browser to get the
root index webpage.
Go to event #12894, right before the message for detailed analysis.
Here we see that an ETH_Rx interrupt occurred, which calls the embOS/IP function _Read-
PacketsSingleIF and receives the packet. Upon reception the embOS event is signaled as
seen before, and the interrupt exits into the scheduler which activates the IP_Task.
The IP_Task sets the system event which signals the IP_WebServer Task to become ready.
Another packet is received immediately and handled by the IP_Task.
When IP_WebServer starts running it is in accept() which calls some OS functions and
then returns. It then checks if the Webserver Child task exists and creates it since it did not.
On creation of the task it is added to the contexts and marked with a light background in
the timeline while it is not active.
IP_WebServer waits for another connection in accept() and the Webserver Child handles
the received HTTP request and serves the webpage. While Webserver Child is active, it may
be interrupted by other ETH_Rx interrupts, which cause a preemptive task switch to the
IP_Task, because the IP_Task has a higher priority than the Webserver Child.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

25 CHAPTER 2 Further analysis of the application core

Note: Tasks are ordered by priority in the Timeline, the exact task priority can be seen
in the Contexts window.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

26 CHAPTER 2 Analysis conclusion

2.5 Analysis conclusion

We analyzed what a system does without insight into the application code. With the ap-
plication source we can check with SEGGER SystemView that the system does what it is
supposed to do.
SEGGER SystemView can actively help developing applications, since it not only shows what
the system does, but also allows exact time measurement and visualizes the influence of
interrupts and events on the application flow. This provides advanced possibilities to find
problems and to improve the system.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

 Chapter 3

The SystemView Application

This section describes the SystemView analysis and visualization tool.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

28 CHAPTER 3 Introduction

3.1 Introduction

SystemView Application
The SystemView Application is the host PC visualization tool for SEGGER SystemView. It
connects to the target application, controls the system events and reads its data. The mon-
itored data is analyzed on runtime and visualized in the different windows of SystemView.
After recording has stopped, the data can be saved to a file which allows later analysis of
the application trace.
To get started with SystemView please refer to the previous chapter.
SystemView provides different windows to visualize the execution in the system, measure
timing and analyze the CPU load. All windows are synchronized to always get all information
of the currently selected state.
For a description of the application windows please refer to the following sections.
SystemView allows going through the monitored data and keeping track of what happened
in the system at any time.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

29 CHAPTER 3 Timeline

3.2 Timeline

SystemView Timeline
The Timeline window gathers all system information within one view. It shows the system
activity by context (task, interrupt, scheduler, timer and idle) over the system time. Each
row refers to one context item to show all context items which have been used in the
application while it has been monitored.
A mouse-over tooltip on the context items reveals more details and run time information
about the context.
A mouse-over tooltip on context activity shows the details of the current event and the
invokated functions if available.
A ruler shown on mouse-over on context activity, marks the activity time span.
A tasks life time is marked with a light background from creation to termination to provide
a quick overview which tasks exist at any time.
Switches between contexts are displayed as connection lines to easily identify which events
cause context switches and when they occurred.
Tasks which are marked ready for execution are displayed with a light grey bar until their
execution starts.
Contexts are ordered by priority. The first row displays all activity in a unified context.
Interrupts are top of the list, ordered by Id. Followed by the Scheduler and software timers,
if they are used in the system. Below the Scheduler (and timer) the tasks are ordered by
priority. The bottom context displays idle time, when no other context is active.
The Timeline is synchronized with the Events list. The event marker (the blue line or range)
matches the event selection in the Events list.
The corresponding context label is highlighted when context under the event marker is
active.
The marker can be fixed at 10% to 90% of the window and update the selection in the
Events list when scrolling through the timeline.
An event can be dragged under the event marker to select the corresponding event in the
Events list and vice-versa.
To get an overview of the whole system or to see the exact duration of an event the Timeline
view can be zoomed in or out.
To jump to the next or previous activity of a context, the context labels include buttons
for forward and backward naviagtion on mouse-over, or use the shortcut keys F and B,
respectively.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

30 CHAPTER 3 Events list

3.3 Events list

SystemView Events list and Timeline

The Events list window shows all events as they are reported by the system and displays
their information. An event is displayed with the following items:
• An ID to locate events in the list.
• A timestamp selectable to be shown either in target time or recording time, with a
resolution down to nanoseconds, if applicable.
• The active context during event reporting, i.e. the task which was running.
• An event description, displayed with the type of event (IRS enter and exit, task activity,
API call).
• Event details describing the parameters of the event, for example the API call
parameters.
The Events list allows browsing through the list, jumping to the next or previous context, or
to the next or previous similar event. The Timeline and CPU Load windows are synchronized
to match the currently selected event.
The timestamps in the Events list could be displayed as relative to the start of recording or
to the target system time, when reported by the system (View →Display Target Time and
Display Recording Time, respectively). Events can be set as time reference for following
events to allow easy measurement of when an event occurred after another one (shortcut
R).
The Events list has an event filter that allows to show or hide APIs, ISRs, System Informa-
tion, Messages, Tasks, and User Events.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

31 CHAPTER 3 Events list

3.3.1 Event Filter

The Events list features filtering of events. This can be useful for example to hide interrupt
events or to show only task execution.
In SystemView events can be filtered by different groups:
• APIs - OS or module generated events.
• ISRs - Interrupt enter and exit.
• Messages - Terminal Output.
• System Events - System and Task information.
• Tasks - Task execution.
• Markers - Performance marker start, stop, and mark.
The setting of filters for single system events as well as registered OS or middleware events
could be done individual in the System window (System on page 37).

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

32 CHAPTER 3 Terminal

3.4 Terminal

SystemView Terminal
The Terminal window shows printf() output from the target application next to the task
context from which the output has been sent and the timestamp when the message was
sent.
Double-click on a message to show it with all information in the Events list.
The Timeline window also displays indicators for output. When indicators overlapping in
display they are ordered by severity level - Errors are shown always on top. The minimum
severity level for output indicators to be displayed in Timeline can be configured via View
→ Message Indicators….
SystemView printf output (SEGGER_SYSVIEW_Print*) can be sent formatted by the ap-
plication or unformatted with all parameters for formatted display by the SystemView ap-
plication.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

33 CHAPTER 3 CPU Load

3.5 CPU Load

SystemView CPU Load

The CPU Load window is linked to the time span displayed in the Timeline.
The time span displayed in the Timeline window is divided into a configurable number of
bins displayed in the CPU Load window. For each context its active time is displayed relative
to the corresponding bin width. The CPU load distribution in a bin is shown in order of
context priority.
The number of bins can be adjusted for finer or coarser time granaularity. When using a
single bin the CPU load ratios are calculated over the entire displayed Timeline section.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

34 CHAPTER 3 Contexts

3.6 Contexts

SystemView Contexts
The Contexts window shows statistical information for each reported context (Tasks, Inter-
rupts, Scheduler, Timer, and Idle). Each context can be identified by its Name and Type.
The Type includes the priority for tasks and the ID for interrupts (e.g. the Cortex-M SysTick
is interrupt ID #15.)
The Contexts window information include following items:
• The context name and type.
• Stack information for tasks, if available.
• Number of activations of the context.
• Total, Min and Max Blocked Time, total, minimal and maximal duration the context was
ready, but not active, respectively.
• Total Run Time, total time the context was active.
• Time Interrupted, total time the context was suspended by interrupts.
• CPU Load, ratio of contexts active time to complete recorded time.
• Last, Min and Max Run Time, the duration of the latest, shortest and longest time the
context was active, respectively.
• Min and Max Run Time/s, the minimal and maximal contexts active time in the last
recorded second.
The Contexts window is updated during the recording.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

35 CHAPTER 3 Runtime

3.7 Runtime

SystemView Runtime
The Runtime window displays statistical measures for every context regarding its active
time. The measures shown are (over all invocations of a certain context):
• Minimal active time,
• Quartiles (25%, 50%, 75%)
• Maximal active time.
The statistical measures will be shown on request as a box plot over activation time as
multiples of 1 or 5 * 10N cycles as reported by target. N is chosen dynamically so, that
the until then appearing maximum active time will fit. The histogram of duration samples
always consists of 100 bins over the box plot span for a certain context.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

36 CHAPTER 3 Heap

3.8 Heap

SystemView Heap
The Heap window records allocations and deallocations of dynamic memory recorded us-
ing SEGGER_RTL_HeapAlloc(), SEGGER_RTL_HeapFree(), and other heap-related API func-
tions.
Each allocation or deallocation event updates SystemView’s model of one or more heaps
maintained by the application. SystemView maintains this model and each allocation and
deallocation event in the Event and Heap window shows the state of this model. If event
overflow causes allocation or deallocation events to be lost, the model of the heap becomed
invalid.

3.8.1 Heap events

Each allocation or deallocation event records the address and size of the block allocated on
the target. In addition to these, the event detail displayed in the Event and Heap windows
can show, for each monitored heap on a per-heap basis:
• The number of bytes in use (allocated)
• The number of bytes free (unallocated)
• The loading, i.e. the percentage of the heap used for allocated bytes
• The total number of allocation events
• The total number of deallocations events
• The user-provided tag for the allocated block
• The peak number of bytes in use
• The peak loading
• The number of allocation events without a matching deallocation
• The lifespan of an allocated block in the heap, i.e. for how long the block was allocated
• The matching allocation or deallocation event for the block
Color coding of the events enabled swift identification of potential memory leaks:
• An allocation event with matching dellocation is shown as a green hollow diamond
• A deallocation event with matching allocation is shown as a red hollow diamond
• An allocation event with no matching deallocation is shown as a solid green diamond

3.8.2 API Functions

The following are the API functions to monitor a heap:
• SEGGER_SYSVIEW_HeapDefine on page 185
• SEGGER_SYSVIEW_HeapAlloc on page 186
• SEGGER_SYSVIEW_HeapAllocEx on page 187
• SEGGER_SYSVIEW_HeapFree on page 188

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

37 CHAPTER 3 System

3.9 System

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

38 CHAPTER 3 System

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

39 CHAPTER 3 System

SystemView System
The System window displays:
• Target System, information about the system, which has been reported by the
application to identify it. Also located in this section are user-settable properties for
configuring the display of operating system, module and system events.
• Recording information, like Number of Events, the average and peak event frequency
and additional user provided meta-information about the record.
• Analysis information, statistical information about the analysis phase of recording.
• Statistics about tasks, interrupts, timers and other SystemView events.
The Target System information include i.a. the application name, the running OS, informa-
tion about the target hardware, and timing information. Additional information about task
switches and interrupt frequency provide a quick overview of the system.
The properties and meta-information settable by the user are saved with the record and
allow identification and pre-set configuration of a record for later analysis.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

40 CHAPTER 3 Trigger Modes

3.10 Trigger Modes

During a real-time continuous recording and analysis of events, trigger modes allow the
automatic selection and a focused display of events meeting configurable criteria.
The Trigger Mode can be seleced in the toolbar.
In Manual Scroll Mode, the selection is not automatically updated and the user can scroll
through the events and analyze the system while recording is done.
In Auto Scroll Mode, the selection is synchronized every 100 ms. The event with the last
multiple of 100 ms is selected.
In the continuous trigger mode, the user can configure at which event and in which context
(taks, interruption or marker) the triggering should occur. SystemView then always selects
the last occurrence of an event that meets the configured condition.
In single trigger mode, SystemView triggers once on the next received event that meets
the configured condition and switches back to manual scrolling mode.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

41 CHAPTER 3 GUI controls

3.11 GUI controls

SystemView can be controlled with mouse and keyboard, via menus and context menus.
The most important controls are also accessible in the toolbar.
The following table describes the controls of SystemView.

Action Menu Shortcut

Recording control
Start recording on the target. Target →Start Recording F5
Stop recording. Target →Stop Recording Shift+F5
Read post-mortem or single-shot
Target →Read Recorded Data Ctrl+F5
data from the system.
Configuring the recorder interface
Target →Recorder Configuration Alt+Enter
to target
Configuring trigger modes Target →Trigger →…
Data handling
Save recorded data to a file. File →Save Data Ctrl+S
Load a record file. File →Load Data Ctrl+O
Load a recently used file. File →Recent Files none
Load a sample recording. File →Sample Recordings none
Export recorded data as file with
File →Export Data Ctrl+E
CSV (comma separated values).
View, Timeline
Set/clear the current event as
View →Toggle Reference R
time reference.
Remove all time references. View →Clear References Ctrl+Shift+R
Display timestamps as absolute
View →Display Target Time None
target time.
Display timestamps relative to
View →Display Recording Time None
start of recording.
Zoom in. when Timeline is focused +, scroll up
-, scroll
Zoom out. when Timeline is focused
down
Quick set defined Timeline width View →Zoom →View 10us, …, View
None
(in us, ms or s, in 1-2-5 steps …) 1ms, …, View 1s, …, View 100s
Set the marker to 0% of the
View →Marker →Marker Left 0
timeline.
Set the marker to x% of the
View →Marker →Marker at 10% …
timeline. (x=10% .. 90%, 10% 1…9
→Cursor at 90%
steps)
Set the marker to 100% of the
View →Marker →Marker Right None
timeline.
Show all output indicators in View →Message Indicators →Show
None
Timeline All Messages
Show output indicators with
View →Message Indicators →Show
severity error and warning in None
Errors and Warnings
Timeline
Show output indicators with View →Message Indicators →Show
None
severity error in Timeline Errors only
View, Events list

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

42 CHAPTER 3 GUI controls

Action Menu Shortcut

Show/Hide API calls in the Events
View →Event Filter →Show APIs Shift+A
list.
Show/Hide ISR Enter/Exit in the
View →Event Filter →Show ISRs Shift+I
Events list.
Show/Hide Messages in the View →Event Filter →Show Mes-
Shift+M
Events list. sages
Show/Hide System events in View →Event Filter →Show Sys-
Shift+S
Events list. tem Events
Show/Hide Task activity in Events
View →Event Filter →Show Tasks Shift+T
list.
Show/Hide output indicators in View →Event Filter →Show Mark-
Shift+E
Events list. ers
Show only API calls in the Events View →Event Filter →Show APIs
Ctrl+Shift+A
list. only
Show only ISR Enter/Exit in the View →Event Filter →Show ISRs
Ctrl+Shift+I
Events list. only
Show only Messages in the View →Event Filter →Show Mes-
Ctrl+Shift+M
Events list. sages only
Show only System events in View →Event Filter →Show Sys-
Ctrl+Shift+S
Events list. tem Events only
Show only Task activity in Events View →Event Filter →Show Tasks
Ctrl+Shift+T
list. only
Show only output indicators in View →Event Filter →Show Mark-
Ctrl+Shift+E
Events list. ers only
Hide registered API invocation
(and corrsponding exit) event. View →Event Filter →Hide This
Shift+Ctrl+H
(Only available on selected invo- Event
cation event)
View →Event Filter →Reset all Ctrl+Shift
Reset all event filters.
Filters +Space
Trigger control
Manually Scroll mode while
Target →Trigger →Manual Scroll
recording.
Automatic Scroll mode while
Target →Trigger →Auto Scroll
recording.
Continuously trigger on a condi-
Target →Trigger →Continuous
tion and focus triggering event
Trigger
while recording.
Trigger on a condition once and
focus on triggering event while Target →Trigger →Trigger Once
recording.
Target →Trigger →configure
Configure the trigger condition.
Trigger
View, Runtime
Show/Hide statistic measures in
View →Show Runtime Statistics None
Runtime window
Show/Hide boxplots for statistic
View →Show Runtime Boxplot None
measures in Runtime window
Show/Hide histograms in boxplots
View →Show Runtime Histogram None
in Runtime window

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

43 CHAPTER 3 GUI controls

Action Menu Shortcut

Navigation, Timeline
Jump to the next context switch. Go →Forward F
Jump to the previous context
Go →Back B
switch.
Jump to the next similar event. Go →Next [Event] N
Jump to the previous similar
Go →Previous [Event] P
event.
Jump to the next similar event
Go →Next [Event] in [Context] Shift+N
with the same context.
Jump to the previous similar Go →Previous [Event] in [Con-
Shift+P
event with the same context. text]
Open dialog to go to an event by
Go →Go to Event… Ctrl+G
Id.
Open dialog to go to an event by
Go →Go to Timestamp… Ctrl+Shift+G
timestamp.
Left, Ctrl
Scroll forward. when Timeline is focused +Scroll up,
Click&Drag
Right, Ctrl
+Scroll
Scroll back. when Timeline is focused
down,
Click&Drag
Window
Show/hide the System informa-
Window →System None
tion window.
Show/hide the Timeline window. Window →Timeline None
Show/hide the CPU Load window. Window →CPU Load None
Show/hide the Runtime window. Window →Runtime None
Show/hide the Contexts window. Window →Context View None
Show/hide the Terminal window. Window →Terminal View None
Show/hide the Log window. Window →Log View None
Show/Hide the Status bar Window →Show Status Bar None
Show/Hide the Tool bar Window →Show Tool Bar None
Miscellaneous
Open application preferences dia-
Tool →Preferences Alt+.
log.
Open License manager dialog. Tool →Licence Manager Alt+L
Help
Open this SystemView Manual. Help →User Guide F11
Show SystemView information. Help →About F12

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

44 CHAPTER 3 Command Line Options

3.12 Command Line Options

SystemView can be controlled and configured via command line options. To skip the con-
figuration dialog on start of recording, the target configuration can be given via command
line options.
After the configuration options, zero, one, or multiple options can be given on the command
line to control SystemView and to automate part of its execution.
If started in single instance mode, the first instance of SystemView starts normally and
parses its command line. Any further instance passes its command line control options to
the already running instance.
Alternatively, a running instance can be controlled by sending the commands on a TCP/
IP socket to localhost:19050.

C:> SystemView.exe <Filename>

Load a selected recording file on start of SystemView.
(Used for drag and drop on SystemView executable.)

C:> SystemView.exe [-recorder J-Link|UART|IP] [-device <Device>] [-usb [<SN>]]|[-

ip <Host>] [-if SWD|JTAG|FINE] [-speed <Speed>] [-rttcbaddr <Addr>]|[-rttcbrange
auto|<Range>] [-start|-stop|-quit|-save [<Filename>]|-load[<Filename>]|-export
[<Filename>]|-export-contexts [<Filename>]|-export-terminal [<Filename>]]*

Command Line Options:

-recorder Select the recorder interface. Parameter: J-Link,
UART, IP.

-device Set the target device. Parameter: Device name

as supported by J-Link.

-usb Connect to J-Link via USB. Parameter: S/N of J-

Link. (Optional)
-ip Connect to J-Link via IP. Parameter: IP or S/N of
J-Link.

-if Set the target interface. Parameter: SWD, JTAG,

or FINE.
-speed Set the target interface speed. Parameter: Speed in
kHz.
-jtagconf Set the JTAG scan chain configuration. Parameter: IRPre and
DRPRe of the target device.

-rttcbaddr Set the RTT Control Block address. Parameter: Address in

hexadecimal.
-rttcbrange Set the search range for RTT Control Block. Parameter: auto or
ranges as "<Address> <Size>".

-single Start SystemView in single instance mode.

-port Set local port for single instance mode. Parameter: Port.

Command Line Control:

-start Start recording.
-stop Stop recording.
-quit Quit SystemView.
-load Load a recording from file. Parameter: File
to load.
-save Save current recording. Parameter: File
to save to.
-export Export the current recording to a file. Parameter: File
to export to.
-export-contexts Export the Contexts window to csv. Parameter: File
to export to.
-export-terminal Export the Terminal window to csv. Parameter: File
to export to.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

45 CHAPTER 3 Command Line Options

-delay Delay before executing the next command. Parameter: Time

to delay in ms.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

46 CHAPTER 3 Recording with SystemView

3.13 Recording with SystemView

This section describes how to use the SystemView Application for continuous recording and
how to do manual single-shot recording with a debugger.

3.13.1 Continuous recording

SystemView can continuously record target execution in real time, while the target is run-
ning.
Continuous recording can be done externally and non-intrusively with a J-Link debug probe,
which reads the recorded events through the debug interface, or controlled by the target
application which sends the data through a network connection or over a serial line.

Start recording
To start continuous recording, connect the target and the chosen recorder interface.
Select Target →Start Recording. On the first start of SystemView, the recorder configu-
ration is opened. The configuration is saved for subsequent recordings. To switch to another
recorder or change the configuration, select Target →Recorder Configuration.
When the recorder is configured, SystemView connects and starts recording.

Stop recording
To stop recording select Target →Stop Recording.

3.13.1.1 J-Link Recorder

To use the J-Link Recorder, the connection to J-Link, connection to target, and the location
of the RTT control block needs to be configured.
Select to connect to J-Link via USB or IP and optionally enter the serial number or IP to
select a specific J-Link.
Enter or select the device name. If the current device is not part of the list, it can be entered
manually or selected from the device selection dialog.

Note

For RTT Control Block Auto Detection, as well as to properly connect to a device, the
exact device has to be known. It is recommended to not select a generic core instead.

Select the target interface and target interface speed for the connected device.
Configure the RTT Control Block Detection. In most cases Auto Detection can be used. If the
RTT Control Block can not be detected, get the address of _SEGGER_RTT from the application
or its map file and enter it, or enter a Search Range in which the symbol might be located
in the format <StartAddress> <Size>, for example 0x10000000 0x10000.

Note

SystemView can be used parallel to a debugger. In this case recording can be done
while the debugger is running. Make sure all required configuration is done in the
debugger. When the debugger is stopped, SystemView recording will stop, too.

With a J-Link debug probe and the SEGGER Real Time Transfer technology (RTT), Sys-
temView can continuously record target execution in real time, while the target is running.
RTT requires the ability of reading memory via the debug interface during program execu-
tion. This especially includes ARM Cortex-M0, M0+, M1, M3, M4 and M7 processors as well
as all Renesas RX devices.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

47 CHAPTER 3 Recording with SystemView

How Systemview works with J-Link

3.13.1.2 IP Recorder
The SystemView IP Recorder connects to its counterpart running on the target device.
On the target the “IP Recorder host” is running and accepting connections form the Sys-
temView Application to send its data to.
Select the IP of the target device and the port (default: 19111).

3.13.1.3 UART Recorder

The UART Recorder connects to the target over a serial line, i.e. UART on RS232. On modern
computers usually a USB to RS232 converter is used.
On the target the UART needs to be configured to receive commands and store it in the
SystemView buffer, as well as send data from the SystemView buffer when it becomes
available.
Select the COM Port the target is connected to and the Baud rate to communicate with
via UART.

3.13.2 Single-shot recording

When the target device does not support RTT or when no J-Link is used, SEGGER Sys-
temView can be used to record data until its target buffer is filled.
In single-shot mode the recording is started manually in the application, which allows
recording only specific parts, which are of interest.
As a usual application generates about 5 to 15 kByte recording data per second and peaks
only to higher rates at full load, even a small buffer in the internal RAM can be used to
record data for analysis of critical parts. When using external RAM SystemView can record
for a long time, even in single-shot mode.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

48 CHAPTER 3 Recording with SystemView

How Systemview works in single-shot mode

Get single-shot data from the system

To get the data which has been recorded in single-shot mode, the SystemView buffer has
to be read via the SystemView Application or an external debugger.
• Connect a debugger and load the target application.
• Configure and initialize SystemView from the application (SEGGER_SYSVIEW_Conf() or
SEGGER_SYSVIEW_Init).
• Start recording in the application from where it should be analyzed
(SEGGER_SYSVIEW_Start).
;With a J-Link SystemView can automatically read single-shot data from the target. ; ;
• Start the SystemView Application and select Target →Read Recorded Data. ; ;Without
a J-Link or without SystemView the data can be read using following steps: ;
• Halt the application in the debugger when the buffer is full or after recording has been
done.
• Get the SystemView RTT buffer address and the number of bytes used (Normally
_SEGGER_RTT.aUp[1].pBuffer and _SEGGER_RTT.aUp[1].WrOff).
• Save the number of bytes from the buffer to a file with .SVDat extension.
• Open the file with the SystemView Application.
To be able to record more than once, the buffer write offset (_SEGGER_RTT.aUp[1].WrOff)
can be set to 0 when the data has been read. To prevent SystemView overflow events to
happen, the application should be halted as soon as the buffer is filled and cannot hold
another SystemView event.

3.13.3 Post-mortem analysis

Post-mortem analysis is similar to single-shot recording, with one difference: SystemView
events are continuously recorded and the SystemView buffer wraps around to overwrite
older events when the buffer is filled. When reading out the buffer, the newest events are
available.
Post-mortem analysis can be useful when a system runs for a long time and suddenly
crashes. In this case the SystemView buffer can be read from the target and SystemView
can show what happened in the system immediately before the crash.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

49 CHAPTER 3 Recording with SystemView

Note

Post-mortem analysis requires the debugger or debug probe to be able to connect to

the target system without resetting it or modifying the RAM.

To get as much useful data for analysis as possible it is recommended to use a large buffer
for SystemView, 8 kByte or more. External RAM can be used for the SystemView buffer.
To configure the target system for post-mortem mode, please refer to SEG-
GER_SYSVIEW_POST_MORTEM_MODE on page 66 and SEGGER_SYSVIEW_SYNC_PERIOD_SHIFT
on page 67.

Get post-mortem data from the system

To get the data which has been recorded in post-mortem mode, the SystemView buffer has
to be read via the SystemView Application or an external debugger.
• Configure and initialize SystemView from the application (SEGGER_SYSVIEW_Conf() or
SEGGER_SYSVIEW_Init).
• Start recording in the application from where it should be analyzed
(SEGGER_SYSVIEW_Start).
• Connect a debugger, load the target application, and let the system run.
With a J-Link SystemView can automatically read post-mortem data from the target.
• Start SystemView and select Target →Read Recorded Data.
Without a J-Link or without SystemView the data can be read using following steps:
Since the SystemView buffer is a ring buffer, the data might have to be read in two chunks
to start reading at the beginning and save as much data as possible.
• Configure and initialize SystemView from the application (SEGGER_SYSVIEW_Conf() or
SEGGER_SYSVIEW_Init).
• Start recording in the application from where it should be analyzed
(SEGGER_SYSVIEW_Start).
• Connect a debugger, load the target application, and let the system run.
• when the system crashed or all tests are done, attach with a debugger to the system
and halt it.
• Get the SystemView RTT buffer (Usually _SEGGER_RTT.aUp[1].pBuffer).
• Save the data from pBuffer + WrOff until the end of the buffer to a file.
• Append the data from pBuffer until pBuffer + RdOff - 1 to the file.
• Save the file as *.SVdat or *.bin.
• Open the file with the SystemView Application.

3.13.4 Save and load recordings

When recording is stopped, the recorded data can be saved to a file for later analysis and
documentation. Select File →Save Data. The Recording Properties Dialog pops up, which
allows saving a title, author, and description with the data file. Click OK. Select where to
save the data and click Save.
Saved data can be opened via File →Load Data. The most recently used data files are
available via the menu at File →Recent Files, too. SystemView can open *.bin and *.SV-
Dat files.

3.13.5 Export recordings

For further analysis in external tools, recorded events can be exported to a csv file. Select
File →Export Data. Each event will be exported to the csv file as it is shown in the Events
Window.
Additionally the contents of the Contexts Window and the Terminal Window can be exported
to csv files. From the context menu of the window select Export….

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

 Chapter 4

Getting started with

SystemView on the target

This section describes how to add the SystemView modules to a target system.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

51 CHAPTER 4 Including SystemView in the application

4.1 Including SystemView in the application

The following files are part of the SEGGER SystemView target implementation. We recom-
mend to copy all files into the application project and keep the given directory structure.

File Description

/Config/Global.h Global type definitions for SEGGER code.

SEGGER Real Time Transfer (RTT) configu-
/Config/SEGGER_RTT_Conf.h
ration file.
/Config/SEGGER_SYSVIEW_Conf.h SEGGER SYSTEMVIEW configuration file.
/Config/SEGGER_SYSVIEW_Con-
Initialization of SystemView for [SYSTEM].
fig_[SYSTEM].c
/Sample/OS/SEGGER_SYSVIEW_[OS].c Interface between SYSTEMVIEW and [OS].
/Sample/OS/SEGGER_SYSVIEW_[OS].h Interface header.
Global header for SEGGER global types
/SEGGER/SEGGER.h
and general purpose utility functions.
/SEGGER/SEGGER_RTT.c SEGGER RTT module source.
/SEGGER/SEGGER_RTT.h SEGGER RTT module header.
/SEGGER/SEGGER_SYSVIEW.c SEGGER SYSTEMVIEW module source.
/SEGGER/SEGGER_SYSVIEW.h SEGGER SYSTEMVIEW module header.
/SEGGER/SEGGER_SYSVIEW_ConfDe- SEGGER SYSTEMVIEW configuration fall-
faults.h back.
/SEGGER/SEGGER_SYSVIEW_Int.h SEGGER SYSTEMVIEW internal header.

4.1.1 Generic files

The generic files, SEGGER_SYSVIEW, and SEGGER_RTT are located in /SEGGER/. They need to
be added to any project, and the folder should be set as include directory.

4.1.2 Generic configuration

The generic configuration files for SYSVIEW and RTT are located in /Config/. The folder
needs to be set as include directory.
SEGGER_SYSVIEW_Conf.h and SEGGER_RTT_Conf.h can be modified to match the target
system.

4.1.3 OS-specific and target-specific files

The SystemView target sources include integration with different RTOSes that have already
been instrumented and configurations for different target systems.
The matching files for the target system need to be added to the project.

Example
For a system with embOS on a Cortex-M3 include /Sample/embOS/Config/Cor-
tex-M/SEGGER_SYSVIEW_Config_embOS.c, /Sample/embOS/SEGGER_SYSVIEW_embOS.c and
/Sample/embOS/SEGGER_SYSVIEW_embOS.h.
For a system with no OS or no instrumented OS on a Cortex-M3 include /Sample/NoOS/
Config/Cortex-M/SEGGER_SYSVIEW_Config_NoOS.c only.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

52 CHAPTER 4 Including SystemView in the application

4.1.4 Recorder files

When SystemView events are not recorded via J-Link, but via IP connection or serial line,
the recorder sources need to be added to the project, too.
The SystemView target sources include an example recorder using embOS and emNet in
/Sample/COMM/.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

53 CHAPTER 4 Initializing SystemView

4.2 Initializing SystemView

The system information are sent by the application. This information can be configured via
defines in SEGGER_SYSVIEW_Config_[SYSTEM].c. Add a call to SEGGER_SYSVIEW_Conf() in
the main function to initialize SystemView.

#include "SEGGER_SYSVIEW.h"

/*********************************************************************
*
* main()
*
* Function description
* Application entry point
*/
int main(void) {
OS_IncDI(); /* Initially disable interrupts */
OS_InitKern(); /* Initialize OS */
OS_InitHW(); /* Initialize Hardware for OS */
BSP_Init(); /* Initialize BSP module */

SEGGER_SYSVIEW_Conf(); /* Configure and initialize SystemView */

/* You need to create at least one task before calling OS_Start() */

OS_CREATETASK(&TCB0, "MainTask", MainTask, 100, Stack0);
OS_Start(); /* Start multitasking */
return 0;
}

The generic part of SEGGER SystemView is now ready to monitor the application.
When using embOS V4.12 or later with profiling enabled, SystemView events for ISRs,
Task, and API calls are generated. When not using embOS, appropriate events must be
generated by the application.
Download the application to the target and let it run. As long as the SystemView Application
is not connected, and SEGGER_SYSVIEW_Start() is not called, the application will not gen-
erate SystemView events. When SystemView is connected or SEGGER_SYSVIEW_Start() is
called it will activate recording SystemView events.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

54 CHAPTER 4 Sending system information

4.3 Sending system information

The included files SEGGER_SYSVIEW_Config_[SYSTEM].c provide the system information to
the SystemView Application and can in most cases be used without modification.

/*********************************************************************
* (c) SEGGER Microcontroller GmbH *
* The Embedded Experts *
* www.segger.com *
**********************************************************************

-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Config_embOS.c
Purpose : Sample setup configuration of SystemView with embOS.
Revision: $Rev: 25330 $
*/
#include "RTOS.h"
#include "SEGGER_SYSVIEW.h"
#include "SEGGER_SYSVIEW_embOS.h"

/*********************************************************************
*
* Defines, fixed
*
**********************************************************************
*/
#define DEMCR (*(volatile U32*) (0xE000EDFCuL))
// Debug Exception and Monitor Control Register
#define TRACEENA_BIT (1uL << 24) // Trace enable bit
#define DWT_CTRL (*(volatile U32*) (0xE0001000uL)) // DWT Control Register
#define NOCYCCNT_BIT (1uL << 25)
// Cycle counter support bit
#define CYCCNTENA_BIT (1uL << 0)
// Cycle counter enable bit
//
// If events will be recorded without a debug probe (J-Link) attached,
// enable the cycle counter
//
#define ENABLE_DWT_CYCCNT (SEGGER_SYSVIEW_POST_MORTEM_MODE || SEGGER_SYSVIEW_USE_INTERNAL_RECORDE

/*********************************************************************
*
* Local functions
*
**********************************************************************
*/
/*********************************************************************
*
* _cbSendSystemDesc()
*
* Function description
* Sends SystemView description strings.
*/
static void _cbSendSystemDesc(void) {
SEGGER_SYSVIEW_SendSysDesc("N=" SEGGER_SYSVIEW_APP_NAME ",O=embOS,D=" SEGGER_SYSVIEW_DEVICE_NAM
#ifdef SEGGER_SYSVIEW_SYSDESC0
SEGGER_SYSVIEW_SendSysDesc(SEGGER_SYSVIEW_SYSDESC0);
#endif
#ifdef SEGGER_SYSVIEW_SYSDESC1
SEGGER_SYSVIEW_SendSysDesc(SEGGER_SYSVIEW_SYSDESC1);
#endif
#ifdef SEGGER_SYSVIEW_SYSDESC2
SEGGER_SYSVIEW_SendSysDesc(SEGGER_SYSVIEW_SYSDESC2);
#endif
}

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

55 CHAPTER 4 Sending system information

/*********************************************************************
*
* Global functions
*
**********************************************************************
*/
/*********************************************************************
*
* SEGGER_SYSVIEW_Conf()
*
* Function description
* Configure and initialize SystemView and register it with embOS.
*
* Additional information
* If enabled, SEGGER_SYSVIEW_Conf() will also immediately start
* recording events with SystemView.
*/
void SEGGER_SYSVIEW_Conf(void) {
#if ENABLE_DWT_CYCCNT
//
// If no debugger is connected, the DWT must be enabled by the application
//
if ((DEMCR & TRACEENA_BIT) == 0) {
DEMCR |= TRACEENA_BIT;
}
#endif
//
// The cycle counter must be activated in order
// to use time related functions.
//
if ((DWT_CTRL & NOCYCCNT_BIT) == 0) { // Cycle counter supported?
if ((DWT_CTRL & CYCCNTENA_BIT) == 0) { // Cycle counter not enabled?
DWT_CTRL |= CYCCNTENA_BIT; // Enable Cycle counter
}
}
SEGGER_SYSVIEW_Init(SEGGER_SYSVIEW_TIMESTAMP_FREQ, SEGGER_SYSVIEW_CPU_FREQ,
&SYSVIEW_X_OS_TraceAPI, _cbSendSystemDesc);
OS_SetTraceAPI(&embOS_TraceAPI_SYSVIEW); // Configure embOS to use SYSVIEW.
#if SEGGER_SYSVIEW_START_ON_INIT
SEGGER_SYSVIEW_Start();
// Start recording to catch system initialization.
#endif
}

/*************************** End of file ****************************/

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

56 CHAPTER 4 Start and stop recording

4.4 Start and stop recording

When the data is read continuously with SystemView, the recording is started and stopped
automatically by the SystemView Application. While SystemView is not recording the target
system will not generate SystemView events, minimizing the system overhead.
For single-shot recording SEGGER_SYSVIEW_Start() must be called in the application to
activate recording SystemView events. Events are recorded until the SystemView buffer is
filled or SEGGER_SYSVIEW_Stop() is called.
For post-mortem analysis SEGGER_SYSVIEW_Start() must be called in the application to ac-
tivate recording SystemView events. Events are recorded until SEGGER_SYSVIEW_Stop*( is
called. Older events are overwritten when the SystemView buffer is filled.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

57 CHAPTER 4 Compile-time configuration

4.5 Compile-time configuration

SEGGER SystemView is configurable to match the target device and application. The default
compile-time configuration flags are preconfigured with valid values, to match the require-
ments of most systems and normally do not require modification.
The default configuration of SystemView can be changed via compile-time flags which can
be added to SEGGER_SYSVIEW_Conf.h.

4.5.1 System-specific configuration

The following compile-time configuration is required to match the target system. The sam-
ple configuration in SEGGER_SYSVIEW_Conf.h defines the configuration to match most sys-
tems (for example Cortex-M devices with Embedded Studio, GCC, IAR or Keil ARM). If the
sample configuration does not include the used system, the configuration must be adapted
accordingly.
For a detailed description of the system-specific configuration, refer to Supported CPUs on
page 82.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

58 CHAPTER 4 Compile-time configuration

4.5.1.1 SEGGER_SYSVIEW_GET_TIMESTAMP()
Function macro to retrieve the system timestamp for SystemView events.
On Cortex-M3/4/7 devices the Cortex-M cycle counter can be used as system timestamp.
Default on Cortex-M3/4/7: (*(U32 *)(0xE0001004))
On most other devices the system timestamp has to be generated by a timer. With the de-
fault configuration the system timestamp is retrieved via the user-provided function SEG-
GER_SYSVIEW_X_GetTimestamp().
Default on other cores: SEGGER_SYSVIEW_X_GetTimestamp()
For an example, please refer to Sample/embOS/Config/Cortex-M0/SEGGER_SYSVIEW_Con-
fig_embOS_CM0.c or Sample/NoOS/Config/RX/SEGGER_SYSVIEW_Config_NoOS_RX.c

Note

The frequency of the system timestamp has to be provided in SEG-

GER_SYSVIEW_Init().

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

59 CHAPTER 4 Compile-time configuration

4.5.1.2 SEGGER_SYSVIEW_TIMESTAMP_BITS
Number of valid low-order bits delivered by clock source as system timestamp.
If an unmodified clock source is used as system timestamp, the number of valid bits is the
bit-width of the clock source (e.g. 32 or 16 bit).
Default: 32 (32-bit clock source used)

Example to save bandwidth

As SystemView packets use a variable-length encoding, shifting timestamps can save both
buffer space and bandwidth.
A 32-bit clock source, e.g. the Cortex-M cycle counter on Cortex-M4 can be shifted by 4,
resulting in the number of valid timestamp bits to be 28 and the timestamp frequency, as
used in SEGGER_SYSVIEW_Init, to be the core clock frequency divided by 16.
#define SEGGER_SYSVIEW_GET_TIMESTAMP() ((*(U32 *)(0xE0001004)) >> 4)
#define SEGGER_SYSVIEW_TIMESTAMP_BITS 28.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

60 CHAPTER 4 Compile-time configuration

4.5.1.3 SEGGER_SYSVIEW_GET_INTERRUPT_ID()
Function macro to get the currently active interrupt.
On Cortex-M devices the active vector can be read from the ICSR.
Default on Cortex-M3/4/7: ((*(U32*)(0xE000ED04)) & 0x1FF)
Default on Cortex-M0/1: ((*(U32*)(0xE000ED04)) & 0x3F)
On other devices the active interrupt can either be retrieved from the interrupt controller
directly, can be saved in a variable in the generic interrupt handler, or has to be assigned
manually in each interrupt routine.
By default this can be done with the user-provided function SEGGER_SYSVIEW_X_GetInter-
ruptId() or by replacing the macro definition.
For an example refer to Sample/embOS/Config/RX/SEGGER_SYSVIEW_Config_embOS_RX.c
or Cortex-A/R Interrupt ID on page 93.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

61 CHAPTER 4 Compile-time configuration

4.5.1.4 SEGGER_SYSVIEW_LOCK()
Function macro to recursively lock SystemView transfers from being interrupted. I.e. disable
interrupts.
SEGGER_SYSVIEW_LOCK() must preserve the previous lock state to be restored in SEG-
GER_SYSVIEW_UNLOCK().
Recording a SystemView event must not be interrupted by recording another event. There-
fore all interrupts which are recorded by SystemView (call SEGGER_SYSVIEW_RecordEn-
terISR / SEGGER_SYSVIEW_RecordExitISR), call an instrumented function (e.g. an OS API
function), cause an immediate context switch, or possibly create any other SystemView
event must be disabled.
SEGGER_SYSVIEW_LOCK() can use the same locking mechanism as SEGGER_RTT_LOCK().
Default: SEGGER_RTT_LOCK()
SEGGER_RTT_LOCK() is defined for most systems (for example Cortex-M devices with Em-
bedded Studio, GCC, IAR or Keil ARM, and RX devices with IAR) in SEGGER_RTT_Conf.h. If
the macro is not defined, or empty, it has to be provided to match the target system.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

62 CHAPTER 4 Compile-time configuration

4.5.1.5 SEGGER_SYSVIEW_UNLOCK()
Function macro to recursively unlock SystemView transfers from being interrupted. I.e.
restore previous interrupt state.
SEGGER_SYSVIEW_UNLOCK() can use the same locking mechanism as SEGGER_RTT_UN-
LOCK().
Default: SEGGER_RTT_UNLOCK()
SEGGER_RTT_UNLOCK() is defined for most systems (for example Cortex-M devices with
Embedded Studio, GCC, IAR or Keil ARM, and RX devices with IAR) in SEGGER_RTT_Conf.h.
If the macro is not defined, or empty, it has to be provided to match the target system.

4.5.2 Generic configuration

The following compile-time flags can be used to tune or change how SystemView events
are recorded.
The default compile-time configuration flags are preconfigured with valid values, to match
the requirements of most systems and normally do not require modification.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

63 CHAPTER 4 Compile-time configuration

4.5.2.1 SEGGER_SYSVIEW_RTT_BUFFER_SIZE
Number of bytes that SystemView uses for the recording buffer.
For continuous recording a buffer of 1024 bytes is sufficient in most cases. Depending on
the target interface speed, the target speed and the system load the buffer size might be
increased to up to 4096 bytes.
For single-shot recording the buffer size determines the number of events which can be
recorded. A system might generate between 10 and 200 kByte/s, depending on its load.
A buffer of at least 8 kByte, up to the whole free RAM space is recommended. The buffer
can also be in external RAM.
For post-mortem analysis the buffer size determines the maximum number of events which
will be available for analysis. A system might generate between 10 and 200 kByte/s, de-
pending on its load. A buffer of at least 8 kByte, up to the whole free RAM space is recom-
mended. The buffer can also be in external RAM.
Default: 1024 bytes

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

64 CHAPTER 4 Compile-time configuration

4.5.2.2 SEGGER_SYSVIEW_RTT_CHANNEL
The RTT Channel used for SystemView event recording and communication. 0: Auto selec-
tion

Note

SEGGER_RTT_MAX_NUM_UP_BUFFERS, defined in SEGGER_RTT_Conf.h has to be greater

than SEGGER_SYSVIEW_RTT_CHANNEL.

Default: 0

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

65 CHAPTER 4 Compile-time configuration

4.5.2.3 SEGGER_SYSVIEW_USE_STATIC_BUFFER
If set to 1 SystemView uses a static buffer to create SystemView events. This in general
saves space, since only one buffer is required and task stacks can be as small as possible.
When a static buffer is used, critical code executed between SystemView locking invocations
takes slightly longer.
If set to 0 SystemView events are created on the stack. Make sure all task stacks, as well
as the C stack for interrupts are large enough to hold the largest SystemView events (~228
bytes). SystemView locks only while transferring the stack buffer into the RTT buffer.
Default: 1

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

66 CHAPTER 4 Compile-time configuration

4.5.2.4 SEGGER_SYSVIEW_POST_MORTEM_MODE
If set to 1 post-mortem analysis mode is enabled.
In post-mortem mode, SystemView uses a cyclical buffer and preserves all events up to
the final recorded even rather than dropping events when the buffer is full.

Note

Do not use post-mortem analysis mode when an attached J-Link actively reads RTT
data.

Default: 0

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

67 CHAPTER 4 Compile-time configuration

4.5.2.5 SEGGER_SYSVIEW_SYNC_PERIOD_SHIFT
Configure how often Sync and System Info events are sent in post-mortem mode. Make
sure at least one sync is available in the SystemView buffer.
The recommended sync frequency is Buffer Size / 16
Default: 8 = Sync every 256 Packets

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

68 CHAPTER 4 Compile-time configuration

4.5.2.6 SEGGER_SYSVIEW_ID_BASE
Value to be subtracted from IDs recorded in SystemView packets.
IDs are TaskIds, TimerIds, and ResourceIds, which are usually pointers to a structure in
RAM. Parameters sent in OS and middleware API events can also be encoded as IDs by
the instrumentation.

Note

If the instrumented OS does not use pointers for TaskIds, TimerIds, or ResourceIds,
SEGGER_SYSVIEW_ID_BASE must be set to 0.

As SystemView packets use a variable-length encoding for pointers, correctly re-basing

addresses can save both buffer space and bandwidth.
Define as the lowest RAM address used in the system.
Can be overridden by the application via SEGGER_SYSVIEW_SetRAMBase() on initialization.
In case of doubt define SEGGER_SYSVIEW_ID_BASE as 0.
Default: 0x10000000

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

69 CHAPTER 4 Compile-time configuration

4.5.2.7 SEGGER_SYSVIEW_ID_SHIFT
Number of bits to shift IDs recorded in SystemView packets.
IDs are TaskIds, TimerIds, and ResourceIds, which are usually pointers to a structure in
RAM. Parameters sent in OS and middleware API events can also be encoded as IDs by
the instrumentation.

Note

If the instrumented OS does not use pointers for TaskIds, TimerIds, or ResourceIds,
SEGGER_SYSVIEW_ID_SHIFT must be set to 0.

As SystemView packets use a variable-length encoding for pointers, correctly shifting ad-
dresses can save both buffer space and bandwidth.
For most applications on 32-bit processors, all IDs recorded in SystemView events are really
pointers and as such multiples of 4, so that the lowest 2 bits can be safely ignored.
In case of doubt define SEGGER_SYSVIEW_ID_SHIFT as 0.
Default: 2

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

70 CHAPTER 4 Compile-time configuration

4.5.2.8 SEGGER_SYSVIEW_MAX_STRING_LEN
Maximum string length to be recorded by SystemView events.
Strings are used in the SystemView printf-style user functions, as well as in
SEGGER_SYSVIEW_SendSysDesc() and SEGGER_SYSVIEW_RecordModuleDescription. Make
sure SEGGER_SYSVIEW_MAX_STRING_LEN matches the string length used in these functions.
Default: 128

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

71 CHAPTER 4 Compile-time configuration

4.5.2.9 SEGGER_SYSVIEW_MAX_ARGUMENTS
Maximum number of arguments to be sent with SEGGER_SYSVIEW_PrintfHost,
SEGGER_SYSVIEW_PrintfHostEx, SEGGER_SYSVIEW_WarnfHost, and SEGGER_SYSVIEW_Er-
rorfHost.
If these functions are not used in the application SEGGER_SYSVIEW_MAX_ARGUMENTS can be
set to 0 to minimize the static buffer size.
Default: 16

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

72 CHAPTER 4 Compile-time configuration

4.5.2.10 SEGGER_SYSVIEW_BUFFER_SECTION
The SystemView RTT Buffer may be placed into a dedicated section, instead of the default
data section. This allows placing the buffer into external memory or at a given address.
When SEGGER_SYSVIEW_BUFFER_SECTION is defined, the section has to be defined in the
linker script.
Default: SEGGER_RTT_SECTION or not defined

Example in Embedded Studio

//
// SEGGER_SYSVIEW_Conf.h
//
#define SEGGER_SYSVIEW_BUFFER_SECTION "SYSTEMVIEW_RAM"

//
// flash_placement.xml
//
<MemorySegment name="ExtRAM">
<ProgramSection load="No" name="SYSTEMVIEW_RAM" start="0x40000000" />
</MemorySegment>

4.5.3 RTT configuration

The following compile-time flags can be used to tune or change RTT.
The default compile-time configuration flags are preconfigured with valid values, to match
the requirements of most systems and normally do not require modification.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

73 CHAPTER 4 Compile-time configuration

4.5.3.1 BUFFER_SIZE_UP
Number of bytes to be used for the RTT Terminal output channel.
RTT can be used for printf terminal output without modification. BUFFER_SIZE_UP defines
how many bytes can be buffered for this.
If RTT Terminal output is not used, define BUFFER_SIZE_UP to its minimum of 4.
Default: 1024 Bytes

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

74 CHAPTER 4 Compile-time configuration

4.5.3.2 BUFFER_SIZE_DOWN
Number of bytes to be used for the RTT Terminal input channel.
RTT can receive input from the host on the terminal input channel. BUFFER_SIZE_DOWN
defines how many bytes can be buffered and therefore sent at once from the host.
If RTT Terminal input is not used, define BUFFER_SIZE_DOWN to its minimum of 4.
Default: 16 Bytes

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

75 CHAPTER 4 Compile-time configuration

4.5.3.3 SEGGER_RTT_MAX_NUM_UP_BUFFERS
Maximum number of RTT up (to host) buffers. Buffer 0 is always used for RTT terminal
output, so to use it with SystemView SEGGER_RTT_MAX_NUM_UP_BUFFERS has to be at least 2.
Default: 2

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

76 CHAPTER 4 Compile-time configuration

4.5.3.4 SEGGER_RTT_MAX_NUM_DOWN_BUFFERS
Maximum number of RTT down (to target) buffers. Buffer 0 is always used for RTT terminal
input, so to use it with SystemView SEGGER_RTT_MAX_NUM_UP_BUFFERS has to be at least 2.
Default: 2

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

77 CHAPTER 4 Compile-time configuration

4.5.3.5 SEGGER_RTT_MODE_DEFAULT
Mode for pre-initialized RTT terminal channel (buffer 0).
Default: SEGGER_RTT_MODE_NO_BLOCK_SKIP

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

78 CHAPTER 4 Compile-time configuration

4.5.3.6 SEGGER_RTT_PRINTF_BUFFER_SIZE
Size of buffer for RTT printf to bulk-send chars via RTT. Can be defined as 0 if SEGGER_RT-
T_Printf is not used.
Default: 64

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

79 CHAPTER 4 Compile-time configuration

4.5.3.7 SEGGER_RTT_SECTION
The RTT Control Block may be placed into a dedicated section, instead of the default data
section. This allows placing it at a known address to be able to use the J-Link auto-detection
or easily specify a search range.
When SEGGER_RTT_SECTION is defined, the application has to make sure the section is
valid, either by initializing it with 0 in the startup code or explicitly calling SEGGER_RT-
T_Init() at the start of the application. SEGGER_RTT_Init() is implicitly called by SEG-
GER_SYSVIEW_Init().
Default: not defined

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

80 CHAPTER 4 Compile-time configuration

4.5.3.8 SEGGER_RTT_BUFFER_SECTION
The RTT terminal buffer may be placed into a dedicated section, instead of the default data
section. This allows placing the buffer into external memory or at a given address.
Default: SEGGER_RTT_SECTION or not defined

4.5.4 Optimizing SystemView

In order to get the most precise run-time information from a target system, the recording
instrumentation code must be fast, least intrusive, small, and efficient. The SystemView
code is written to be efficient and least intrusive. Speed and size of SystemView are a
matter of target and compiler configuration. The following sections describe how to optimize
SystemView.

4.5.4.1 Compiler optimization

The compiler optimization of the SystemView target implementation should always be
turned on, even in debug builds, to generate fast recording routines, causing less overhead
and be least intrusive.
The configuration to favour speed or size optimization is compiler-dependent. In some cases
a balanced configuration can be faster than a speed-only configuration.

4.5.4.2 Recording optimization

SystemView uses a variable-length encoding to store and transfer events, which enables
saving buffer space and bandwidth on the debug interface.
The size of some event parameters can be optimized via compile-time configuration.

Shrink IDs
IDs are pointers to a symbol in RAM, for example a Task ID is a pointer to the task control
block. To minimize the length of recorded IDs they can be shrunken.
SEGGER_SYSVIEW_ID_BASE is subtracted from a pointer to get its ID. It can be set to sub-
tract the base RAM address from pointers, which still results in unique, but smaller IDs.
For example if the RAM range is 0x20000000 to 0x20001000 it is recommended to define
SEGGER_SYSVIEW_ID_BASE as 0x20000000, which results in the pointer 0x20000100 to have
the ID 0x100 and requires two instead of four bits to store it.
SEGGER_SYSVIEW_ID_SHIFT is the number of bits a pointer is shifted right to get its ID. If
all recorded pointers are 4 byte aligned, SEGGER_SYSVIEW_ID_SHIFT can be defined as 2.
A pointer 0x20000100 would then have the ID 0x8000040 or with the previous subtraction
of SEGGER_SYSVIEW_ID_BASE as 0x20000000 the ID would be 0x40, requiring only one byte
to be recorded.

Timestamp source
Event timestamps in SystemView are recorded as the difference of the timestamp to the
previous event. This saves buffer space per se.
While it is recommended to use a timestamp source with the CPU clock frequency for highest
time resolution, a lower timestamp frequency might save additional buffer space as the
timestamp delta is lower.
With a CPU clock frequency of 160 MHz the timestamp might be shifted by 4, resulting in
a timestamp frequency of 10 MHz (100 ns resolution), and 4 bits less to be encoded.
When the timestamp size is not 32-bit any more, i.e. it wraps around before 0xFFFFFFFF,
SEGGER_SYSVIEW_TIMESTAMP_BITS has to be defined as the timestamp size, e.g. as 28
when shifting a 32-bit timestamp by 4.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

81 CHAPTER 4 Compile-time configuration

4.5.4.3 Buffer configuration

The recording and communication buffer size for SystemView and RTT can be set in the
target configuration.
For continuous recording a small buffer of 1 to 4 kByte is sufficient in most cases and allows
using SystemView even with a small internal RAM.
For single-shot and post-mortem mode a larger buffer can be desirable. In this case SEG-
GER_SYSVIEW_RTT_BUFFER_SIZE can be set to a larger value. To place the SystemView
recording buffer into external RAM a SEGGER_SYSVIEW_BUFFER_SECTION can be defined and
the linker script adapted accordingly.
If only SystemView is used and no terminal output with RTT, BUFFER_SIZE_UP in SEGGER_RT-
T_Conf.h can be set to a smaller value to save memory.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

82 CHAPTER 4 Supported CPUs

4.6 Supported CPUs

This section describes how to set up and configure the SystemView modules for different
target CPUs.
SEGGER SystemView virtually supports any target CPU, however, continuous recording is
only possible with CPUs, which support background memory access - ARM Cortex-M and
Renesas RX. On other CPUs SystemView can be used in single-shot or post-mortem analysis
mode. Refer to Single-shot recording on page 47.
In order for SystemView to run properly, some target-specific configuration nust be under-
taken. This configuration is described for some CPUs below.

4.6.1 Cortex-M3 / Cortex-M4

Recording mode Supported?
Continuous recording Yes
Single-shot recording Yes
Post-mortem analysis Yes

4.6.1.1 Event timestamp

The timestamp source on Cortex-M3 / Cortex-M4 can be the cycle counter, which allows
cycle-accurate event recording.
In order to save bandwith when recording events, the cycle counter can optionally be right-
shifted, for example by 4 bits, which results in a timestamp frequency of core speed divided
by 16.

Configuration:

//
// Use full cycle counter for higher precision
//
#define SEGGER_SYSVIEW_GET_TIMESTAMP() (*(U32 *)(0xE0001004))
#define SEGGER_SYSVIEW_TIMESTAMP_BITS (32)
//
// Use cycle counter divided by 16 for smaller size / bandwidth
//
#define SEGGER_SYSVIEW_GET_TIMESTAMP() ((*(U32 *)(0xE0001004)) >> 4)
#define SEGGER_SYSVIEW_TIMESTAMP_BITS (28)

4.6.1.2 Interrupt ID
The currently active interrupt can be directly identified by reading the Cortex-M ICSR[8:0],
which is the active vector field in the interrupt controller status register (ICSR).

Configuration:

//
// Get the interrupt Id by reading the Cortex-M ICSR[8:0]
//
#define SEGGER_SYSVIEW_GET_INTERRUPT_ID() ((*(U32 *)(0xE000ED04)) & 0x1FF)

4.6.1.3 SystemView lock and unlock

Locking and unlocking SystemView to prevent transferring records from being interrupted
can be done by disabling interrupts. On Cortex-M3 / Cortex-M4 not all interrupts need to
be disabled, only those which might itself generate SystemView events or cause a task
switch in the OS.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

83 CHAPTER 4 Supported CPUs

By default the priority mask is set to 32, disabling all interrupts with a priority of 32 or
lower (higher numerical value).
Make sure to mask all interrupts which can send RTT data, i.e. generate SystemView events,
or cause task switches. When high-priority interrupts must not be masked while sending
RTT data, SEGGER_RTT_MAX_INTERRUPT_PRIORITY must be adjusted accordingly. (Higher
priority = lower priority number)
Default value for embOS: 128u
Default configuration in FreeRTOS: configMAX_SYSCALL_INTERRUPT_PRIORITY: ( con-
figLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
In case of doubt disable all interrupts.
Lock and unlock for SystemView and RTT can be the same.

Configuration:

//
// RTT locking for GCC toolchains in SEGGER_RTT_Conf.h
//
#define SEGGER_RTT_LOCK() { \
unsigned int LockState; \
__asm volatile ("mrs %0, basepri \n\t" \
"mov r1, $32 \n\t" \
"msr basepri, r1 \n\t" \
: "=r" (LockState) \
: \
: "r1" \
);

#define SEGGER_RTT_UNLOCK() __asm volatile ("msr basepri, %0 \n\t" \

: \
: "r" (LockState) \
: \
); \
}
//
// Define SystemView locking in SEGGER_SYSVIEW_Conf.h
//
#define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK()
#define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK()

4.6.1.4 Sample configuration

SEGGER_SYSVIEW_Conf.h

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *
**********************************************************************
-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Conf.h
Purpose : SEGGER SysView configuration for Cortex-M3 / Cortex-M4.
*/

#ifndef SEGGER_SYSVIEW_CONF_H
#define SEGGER_SYSVIEW_CONF_H

/*********************************************************************
*
* SysView timestamp configuration
*/
// Cortex-M cycle counter.
#define SEGGER_SYSVIEW_GET_TIMESTAMP() ((*(U32 *)(0xE0001004)))
// Number of valid bits low-order delivered as timestamp.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

84 CHAPTER 4 Supported CPUs

#define SEGGER_SYSVIEW_TIMESTAMP_BITS 32

/*********************************************************************
*
* SysView Id configuration
*/
// Default value for the lowest Id reported by the application.
// Can be overridden by the application via SEGGER_SYSVIEW_SetRAMBase().
#define SEGGER_SYSVIEW_ID_BASE 0x20000000
// Number of bits to shift the Id to save bandwidth.
// (e.g. 2 when all reported Ids (pointers) are 4 byte aligned)
#define SEGGER_SYSVIEW_ID_SHIFT 0

/*********************************************************************
*
* SysView interrupt configuration
*/
// Get the currently active interrupt Id. (read Cortex-M ICSR[8:0]
= active vector)
#define SEGGER_SYSVIEW_GET_INTERRUPT_ID() ((*(U32 *)(0xE000ED04)) & 0x1FF)

/*********************************************************************
*
* SysView locking
*/
// Lock SysView (nestable)
#define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK()
// Unlock SysView (nestable)
#define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK()

#endif

/*************************** End of file ****************************/

SEGGER_SYSVIEW_Config_NoOS_CM3.c

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *
* The Embedded Experts *
* www.segger.com *
**********************************************************************

-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Config_NoOS.c
Purpose : Sample setup configuration of SystemView without an OS.
Revision: $Rev: 9599 $
*/
#include "SEGGER_SYSVIEW.h"
#include "SEGGER_SYSVIEW_Conf.h"

// SystemcoreClock can be used in most CMSIS compatible projects.

// In non-CMSIS projects define SYSVIEW_CPU_FREQ.
extern unsigned int SystemCoreClock;

/*********************************************************************
*
* Defines, configurable
*
**********************************************************************
*/
// The application name to be displayed in SystemViewer
#define SYSVIEW_APP_NAME "Demo Application"

// The target device name

#define SYSVIEW_DEVICE_NAME "Cortex-M4"

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

85 CHAPTER 4 Supported CPUs

// Frequency of the timestamp. Must match SEGGER_SYSVIEW_Conf.h

#define SYSVIEW_TIMESTAMP_FREQ (SystemCoreClock)

// System Frequency. SystemcoreClock is used in most CMSIS compatible projects.

#define SYSVIEW_CPU_FREQ (SystemCoreClock)

// The lowest RAM address used for IDs (pointers)

#define SYSVIEW_RAM_BASE (0x10000000)

// Define as
1 if the Cortex-M cycle counter is used as SystemView timestamp. Must match SEGGER_SYSVIEW_Conf.
#ifndef USE_CYCCNT_TIMESTAMP
#define USE_CYCCNT_TIMESTAMP 1
#endif

// Define as
1 if the Cortex-M cycle counter is used and there might be no debugger attached while recording.
#ifndef ENABLE_DWT_CYCCNT
#define ENABLE_DWT_CYCCNT
(USE_CYCCNT_TIMESTAMP & SEGGER_SYSVIEW_POST_MORTEM_MODE)
#endif

/*********************************************************************
*
* Defines, fixed
*
**********************************************************************
*/
#define DEMCR (*(volatile unsigned long*) (0xE000EDFCuL))
// Debug Exception and Monitor Control Register
#define TRACEENA_BIT (1uL << 24)
// Trace enable bit
#define DWT_CTRL (*(volatile unsigned long*) (0xE0001000uL))
// DWT Control Register
#define NOCYCCNT_BIT (1uL << 25)
// Cycle counter support bit
#define CYCCNTENA_BIT (1uL << 0)
// Cycle counter enable bit

/*********************************************************************
*
* _cbSendSystemDesc()
*
* Function description
* Sends SystemView description strings.
*/
static void _cbSendSystemDesc(void) {
SEGGER_SYSVIEW_SendSysDesc("N="SYSVIEW_APP_NAME",D="SYSVIEW_DEVICE_NAME);
SEGGER_SYSVIEW_SendSysDesc("I#15=SysTick");
}

/*********************************************************************
*
* Global functions
*
**********************************************************************
*/
void SEGGER_SYSVIEW_Conf(void) {
#if USE_CYCCNT_TIMESTAMP
#if ENABLE_DWT_CYCCNT
//
// If no debugger is connected, the DWT must be enabled by the application
//
if ((DEMCR & TRACEENA_BIT) == 0) {
DEMCR |= TRACEENA_BIT;
}
#endif
//

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

86 CHAPTER 4 Supported CPUs

// The cycle counter must be activated in order

// to use time related functions.
//
if ((DWT_CTRL & NOCYCCNT_BIT) == 0) { // Cycle counter supported?
if ((DWT_CTRL & CYCCNTENA_BIT) == 0) { // Cycle counter not enabled?
DWT_CTRL |= CYCCNTENA_BIT; // Enable Cycle counter
}
}
#endif
SEGGER_SYSVIEW_Init(SYSVIEW_TIMESTAMP_FREQ, SYSVIEW_CPU_FREQ,
0, _cbSendSystemDesc);
SEGGER_SYSVIEW_SetRAMBase(SYSVIEW_RAM_BASE);
}

/*************************** End of file ****************************/

4.6.2 Cortex-M7
Same features / settings etc. as for Cortex-M4 apply. For more information, please refer
to Cortex-M3 / Cortex-M4 on page 82.

Cache
When placing the RTT buffer for SystemView into memory that is cacheable, the perfor-
mance is slightly lower (< 1% decrease in performance) for continuous recording mode via
J-Link and RTT. This is because J-Link must perform cache maintenance operations when
accessing the RTT buffer.

4.6.3 Cortex-M0 / Cortex-M0+ / Cortex-M1

Recording mode Supported?
Continuous recording Yes
Single-shot recording Yes
Post-mortem analysis Yes

4.6.3.1 Cortex-M0 Event timestamp

Cortex-M0, Cortex-M0+ and Cortex-M1 do not have a cycle count register. the event time-
stamp has to be provided by an application clock source, for example the system timer,
SysTick. SEGGER_SYSVIEW_X_GetTimestamp() can be used to implement the functionality.
When the SysTick interrupt is used in the application, e.g. by the RTOS, the SysTick handler
should increment SEGGER_SYSVIEW_TickCnt, otherwise a SysTick handler has to be added
to the application and configured accordingly.

Configuration:

//
// SEGGER_SYSVIEW_TickCnt has to be defined in the module which
// handles the SysTick and must be incremented in the SysTick
// handler before any SYSVIEW event is generated.
//
// Example in embOS RTOSInit.c:
//
// unsigned int SEGGER_SYSVIEW_TickCnt; // <<-- Define SEGGER_SYSVIEW_TickCnt.
// void SysTick_Handler(void) {
// #if OS_PROFILE
// SEGGER_SYSVIEW_TickCnt++; // <<-- Increment SEGGER_SYSVIEW_TickCnt asap.
// #endif
// OS_EnterNestableInterrupt();
// OS_TICK_Handle();
// OS_LeaveNestableInterrupt();

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

87 CHAPTER 4 Supported CPUs

// }
//
extern unsigned int SEGGER_SYSVIEW_TickCnt;

/*********************************************************************
*
* Defines, fixed
*
**********************************************************************
*/
#define SCB_ICSR
(*(volatile U32*) (0xE000ED04uL)) // Interrupt Control State Register
#define SCB_ICSR_PENDSTSET_MASK (1UL << 26) // SysTick pending bit
#define SYST_RVR
(*(volatile U32*) (0xE000E014uL)) // SysTick Reload Value Register
#define SYST_CVR
(*(volatile U32*) (0xE000E018uL)) // SysTick Current Value Register
/*********************************************************************
*
* SEGGER_SYSVIEW_X_GetTimestamp()
*
* Function description
* Returns the current timestamp in ticks using the system tick
* count and the SysTick counter.
* All parameters of the SysTick have to be known and are set via
* configuration defines on top of the file.
*
* Return value
* The current timestamp.
*
* Additional information
* SEGGER_SYSVIEW_X_GetTimestamp is always called when interrupts are
* disabled. Therefore locking here is not required.
*/
U32 SEGGER_SYSVIEW_X_GetTimestamp(void) {
U32 TickCount;
U32 Cycles;
U32 CyclesPerTick;
//
// Get the cycles of the current system tick.
// SysTick is down-counting, subtract the current value from the number of cycles per tick.
//
CyclesPerTick = SYST_RVR + 1;
Cycles = (CyclesPerTick - SYST_CVR);
//
// Get the system tick count.
//
TickCount = SEGGER_SYSVIEW_TickCnt;
//
// If a SysTick interrupt is pending, re-read timer and adjust result
//
if ((SCB_ICSR & SCB_ICSR_PENDSTSET_MASK) != 0) {
Cycles = (CyclesPerTick - SYST_CVR);
TickCount++;
}
Cycles += TickCount * CyclesPerTick;

return Cycles;
}

4.6.3.2 Cortex-M0 Interrupt ID

The currently active interrupt can be directly identified by reading the Cortex-M ICSR[5:0],
which is the active vector field in the interrupt controller status register (ICSR).

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

88 CHAPTER 4 Supported CPUs

Configuration:

//
// Get the interrupt Id by reading the Cortex-M ICSR[5:0]
//
#define SEGGER_SYSVIEW_GET_INTERRUPT_ID() ((*(U32 *)(0xE000ED04)) & 0x3F)

4.6.3.3 Cortex-M0 SystemView lock and unlock

Locking and unlocking SystemView to prevent transferring records from being interrupted
can be done by disabling interrupts.
Lock and unlock for SystemView and RTT can be the same.

Configuration:

//
// RTT locking for GCC toolchains in SEGGER_RTT_Conf.h
//
#define SEGGER_RTT_LOCK() { \
unsigned int LockState; \
__asm volatile ("mrs %0, primask \n\t" \
"mov r1, $1 \n\t" \
"msr primask, r1 \n\t" \
: "=r" (LockState) \
: \
: "r1" \
);

#define SEGGER_RTT_UNLOCK() __asm volatile ("msr primask, %0 \n\t" \

: \
: "r" (LockState) \
: \
); \
}

//
// Define SystemView locking in SEGGER_SYSVIEW_Conf.h
//
#define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK()
#define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK()

4.6.3.4 Cortex-M0 Sample configuration

SEGGER_SYSVIEW_Conf.h

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *
**********************************************************************
-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Conf.h
Purpose : SEGGER SysView configuration for Cortex-M0, Cortex-M0+,
and Cortex-M1
*/

#ifndef SEGGER_SYSVIEW_CONF_H
#define SEGGER_SYSVIEW_CONF_H

/*********************************************************************
*
* SysView timestamp configuration
*/
// Retrieve a system timestamp via user-defined function

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

89 CHAPTER 4 Supported CPUs

#define SEGGER_SYSVIEW_GET_TIMESTAMP() SEGGER_SYSVIEW_X_GetTimestamp()

// number of valid bits low-order delivered by SEGGER_SYSVIEW_X_GetTimestamp()
#define SEGGER_SYSVIEW_TIMESTAMP_BITS 32

/*********************************************************************
*
* SysView Id configuration
*/
// Default value for the lowest Id reported by the application.
// Can be overridden by the application via SEGGER_SYSVIEW_SetRAMBase().
#define SEGGER_SYSVIEW_ID_BASE 0x20000000
// Number of bits to shift the Id to save bandwidth.
// (for example 2 when all reported Ids (pointers) are 4 byte aligned)
#define SEGGER_SYSVIEW_ID_SHIFT 0

/*********************************************************************
*
* SysView interrupt configuration
*/
// Get the currently active interrupt Id. (read Cortex-M ICSR[8:0]
= active vector)
#define SEGGER_SYSVIEW_GET_INTERRUPT_ID() ((*(U32 *)(0xE000ED04)) & 0x3F)

/*********************************************************************
*
* SysView locking
*/
// Lock SysView (nestable)
#define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK()
// Unlock SysView (nestable)
#define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK()

#endif

/*************************** End of file ****************************/

SEGGER_SYSVIEW_Config_embOS_CM0.c

/*********************************************************************
* (c) SEGGER Microcontroller GmbH *
* The Embedded Experts *
* www.segger.com *
**********************************************************************

-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Config_embOS_CM0.c
Purpose : Sample setup configuration of SystemView with embOS
on Cortex-M0/Cortex-M0+/Cortex-M1 systems which do not
have a cycle counter.
Revision: $Rev: 25330 $

Additional information:
SEGGER_SYSVIEW_TickCnt must be incremented in the SysTick
handler before any SYSVIEW event is generated.

Example in embOS RTOSInit.c:

void SysTick_Handler(void) {
#if (OS_PROFILE != 0)
SEGGER_SYSVIEW_TickCnt++; // Increment SEGGER_SYSVIEW_TickCnt before calling
OS_EnterNestableInterrupt().
#endif
OS_EnterNestableInterrupt();
OS_TICK_Handle();
OS_LeaveNestableInterrupt();
}

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

90 CHAPTER 4 Supported CPUs

*/
#include "RTOS.h"
#include "SEGGER_SYSVIEW.h"
#include "SEGGER_SYSVIEW_embOS.h"

/*********************************************************************
*
* Defines, fixed
*
**********************************************************************
*/
#define SCB_ICSR (*(volatile U32*) (0xE000ED04uL))
// Interrupt Control State Register
#define SCB_ICSR_PENDSTSET_MASK (1UL << 26) // SysTick pending bit
#define SYST_RVR (*(volatile U32*) (0xE000E014uL))
// SysTick Reload Value Register
#define SYST_CVR (*(volatile U32*) (0xE000E018uL))
// SysTick Current Value Register

/*********************************************************************
*
* Local functions
*
**********************************************************************
*/
/*********************************************************************
*
* _cbSendSystemDesc()
*
* Function description
* Sends SystemView description strings.
*/
static void _cbSendSystemDesc(void) {
SEGGER_SYSVIEW_SendSysDesc("N=" SEGGER_SYSVIEW_APP_NAME ",O=embOS,D=" SEGGER_SYSVIEW_DEVICE_NAM
#ifdef SEGGER_SYSVIEW_SYSDESC0
SEGGER_SYSVIEW_SendSysDesc(SEGGER_SYSVIEW_SYSDESC0);
#endif
#ifdef SEGGER_SYSVIEW_SYSDESC1
SEGGER_SYSVIEW_SendSysDesc(SEGGER_SYSVIEW_SYSDESC1);
#endif
#ifdef SEGGER_SYSVIEW_SYSDESC2
SEGGER_SYSVIEW_SendSysDesc(SEGGER_SYSVIEW_SYSDESC2);
#endif
}

/*********************************************************************
*
* Global functions
*
**********************************************************************
*/
/*********************************************************************
*
* SEGGER_SYSVIEW_Conf()
*
* Function description
* Configure and initialize SystemView and register it with embOS.
*
* Additional information
* If enabled, SEGGER_SYSVIEW_Conf() will also immediately start
* recording events with SystemView.
*/
void SEGGER_SYSVIEW_Conf(void) {
SEGGER_SYSVIEW_Init(SEGGER_SYSVIEW_TIMESTAMP_FREQ, SEGGER_SYSVIEW_CPU_FREQ,
&SYSVIEW_X_OS_TraceAPI, _cbSendSystemDesc);
OS_SetTraceAPI(&embOS_TraceAPI_SYSVIEW); // Configure embOS to use SYSVIEW.
#if SEGGER_SYSVIEW_START_ON_INIT

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

91 CHAPTER 4 Supported CPUs

SEGGER_SYSVIEW_Start();
// Start recording to catch system initialization.
#endif
}

/*********************************************************************
*
* SEGGER_SYSVIEW_X_GetTimestamp()
*
* Function description
* Returns the current timestamp in cycles using the system tick
* count and the SysTick counter.
* All parameters of the SysTick have to be known and are set via
* configuration defines on top of the file.
*
* Return value
* The current timestamp.
*
* Additional information
* SEGGER_SYSVIEW_X_GetTimestamp is always called when interrupts are
* disabled. Therefore locking here is not required.
*/
U32 SEGGER_SYSVIEW_X_GetTimestamp(void) {
U32 TickCount;
U32 Cycles;
U32 CyclesPerTick;
//
// Get the cycles of the current system tick.
// SysTick is down-counting, subtract the current value from the number of cycles per tick.
//
CyclesPerTick = SYST_RVR + 1;
Cycles = (CyclesPerTick - SYST_CVR);
//
// Get the system tick count.
//
TickCount = SEGGER_SYSVIEW_TickCnt;
//
// If a SysTick interrupt is pending, re-read timer and adjust result
//
if ((SCB_ICSR & SCB_ICSR_PENDSTSET_MASK) != 0) {
Cycles = (CyclesPerTick - SYST_CVR);
TickCount++;
}
Cycles += TickCount * CyclesPerTick;

return Cycles;
}

/*************************** End of file ****************************/

4.6.4 Cortex-A / Cortex-R

Recording mode Supported?
Continuous recording Yes/NO
Single-shot recording Yes
Post-mortem analysis Yes

Continuous recording is only supported on Cortex-A / Cortex-R devices, which support RTT
via background memory access via the AHB-AP. For more information please refer to the
J-Link User Manual and website.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

92 CHAPTER 4 Supported CPUs

4.6.4.1 Cortex-A/R Event timestamp

The Cortex-A and Cortex-R cycle counter is implemented only as part of the Performance
Monitor Extension and might not always be accessible. Cortex-A and Cortex-R do not have
a generic system timer source, like the Cortex-M SysTick, either.
For an example on how to initialize the Performance counter, refer to TI AM3358 Cortex-A8
sample configuration on page 98.
Otherwise the event timestamp has to be provided by an application clock source. Refer to
Renesas RZ/A1 Cortex-A9 sample configuration on page 95.
For the clock source any suitable timer can be used. It is recommended to use the OS system
timer if possible, since it normally saves additional configuration and resource usage. If
no timer is used in the application, a suitable timer has to be configured to be used with
SystemView.
Some OSes implement API functions to get the OS time in cycles. If such a function is avail-
able it can be used directly or wrapped by SEGGER_SYSVIEW_X_GetTimestamp() If the OS
does not provide functionality to retrieve the OS time in cycles, SEGGER_SYSVIEW_X_Get-
Timestamp() has to be implemented to get the timestamp from the timer.
• The timer should run at 1 MHz (1 tick/us) or faster.
• The timer should generate an interrupt on overflow or zero
• The timer should be in auto reload mode

Dummy configuration:

//
// SEGGER_SYSVIEW_TickCnt has to be defined in the module which
// handles interrupts and must be incremented in the interrupt
// handler as soon as the timer interrupt is acknowledged and
// before any SYSVIEW event is generated.
//
// Example:
//
// unsigned int SEGGER_SYSVIEW_TickCnt; // <<-- Define SEGGER_SYSVIEW_TickCnt.
// void OS_irq_handler(void) {
// U32 InterruptId;
// InterruptId = INTC_ICCIAR & 0x3FF; // read and extract the interrupt ID
// if (InterruptId == TIMER_TICK_ID) {
// SEGGER_SYSVIEW_TickCnt++; // <<-- Increment SEGGER_SYSVIEW_TickCnt asap.
// }
// SEGGER_SYSVIEW_InterruptId
= InterruptId; // Save active interrupt for SystemView event
// SEGGER_SYSVIEW_RecordEnterISR();
// //
// // Handle interrupt, call ISR
// //
// SEGGER_SYSVIEW_RecordExitISR();
// }
//
extern unsigned int SEGGER_SYSVIEW_TickCnt;

/*********************************************************************
*
* Defines, fixed
*
**********************************************************************
*/
//
// Define the required timer registers here.
//
#define TIMER_RELOAD_VALUE /* as value which is used to initialize and
reload the timer */
#define TIMER_COUNT /* as timer register which holds the current
counter value */
#define TIMER_INTERRUPT_PENDING() /* as check if a timer interrupt is pending */

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

93 CHAPTER 4 Supported CPUs

/*********************************************************************
*
* SEGGER_SYSVIEW_X_GetTimestamp()
*
* Function description
* Returns the current timestamp in ticks using the system tick
* count and the SysTick counter.
* All parameters of the SysTick have to be known and are set via
* configuration defines on top of the file.
*
* Return value
* The current timestamp.
*
* Additional information
* SEGGER_SYSVIEW_X_GetTimestamp is always called when interrupts are
* disabled. Therefore locking here is not required.
*/
U32 SEGGER_SYSVIEW_X_GetTimestamp(void) {
U32 TickCount;
U32 Cycles;
U32 CyclesPerTick;
//
// Get the cycles of the current system tick.
// Sample timer is down-counting,
// subtract the current value from the number of cycles per tick.
//
CyclesPerTick = TIMER_RELOAD_VALUE + 1;
Cycles = (CyclesPerTick - TIMER_COUNT);
//
// Get the system tick count.
//
TickCount = SEGGER_SYSVIEW_TickCnt;
//
// Check if a timer interrupt is pending
//
if (TIMER_INTERRUPT_PENDING()) {
TickCount++;
Cycles = (CyclesPerTick - TIMER_COUNT);
}
Cycles += TickCount * CyclesPerTick;

return Cycles;
}

4.6.4.2 Cortex-A/R Interrupt ID

As the Cortex-A and Cortex-R core does not have an internal interrupt controller, retrieving
the currently active interrrupt Id depends on the interrupt controller, which is used on the
target device. SEGGER_SYSVIEW_GET_INTERRUPT_ID() must be implemented to match this
interrupt controller.
The configuration below shows how to get the interrupt Id on devices, which include the
ARM Generic Interrupt Controller (GIC).
For other interrupt controllers the operation may vary. Refer to TI AM3358 Cortex-A8 sam-
ple configuration on page 98.
Since the active interrupt Id can only be retrieved from the GIC in connection with an
acknowledge of the interrupt it can only be read once. Therefore the Id has to be stored in
a variable when acknowledging it in the generic interrupt handler.

Dummy configuration:

//
// SEGGER_SYSVIEW_InterruptId has to be defined in the module which
// handles the interrupts and must be set to the acknowledged interrupt Id.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

94 CHAPTER 4 Supported CPUs

//
// Example:
//
// #define GIC_BASE_ADDR /* as base address of the GIC on the device */
// #define GICC_BASE_ADDR (GIC_BASE_ADDR + 0x2000u)
// #define GICC_IAR (*(volatile unsigned*)(GICC_BASE_ADDR + 0x000C))
//
// unsigned int SEGGER_SYSVIEW_InterruptId; //
<<-- Define SEGGER_SYSVIEW_InterruptId.
// void OS_irq_handler(void) {
//
// int_id = GICC_IAR & 0x03FF; // Read interrupt ID, acknowledge interrupt
// SEGGER_SYSVIEW_InterruptId = iar_val;
// OS_EnterInterrupt(); // Inform OS that interrupt handler is running
// pISR(); // Call interrupt service routine
// OS_LeaveInterrupt();
// Leave interrupt, perform task switch if required
// }
//
extern unsigned int SEGGER_SYSVIEW_InterruptId;

#define SEGGER_SYSVIEW_GET_INTERRUPT_ID() (SEGGER_SYSVIEW_InterruptId)

4.6.4.3 Cortex-A/R SystemView lock and unlock

As the Cortex-A and Cortex-R core does not have an internal interrupt controller, locking
and unlocking SystemView to prevent transferring records from being interrupted can be
done generic by disabling FIQ and IRQ completely, or by using interrupt controller specif-
ic methods. The configuration below shows how to disable all interrupts for RTT and Sys-
temView.
Lock and unlock for SystemView and RTT can be the same.

Configuration:

//
// RTT locking for GCC toolchains in SEGGER_RTT_Conf.h
// Set and restore IRQ and FIQ mask bits.
//
#define SEGGER_RTT_LOCK() { \
unsigned int LockState; \
__asm volatile ("mrs r1, CPSR \n\t" \
"mov %0, r1 \n\t" \
"orr r1, r1, #0xC0 \n\t" \
"msr CPSR_c, r1 \n\t" \
: "=r" (LockState) \
: \
: "r1" \
);

#define SEGGER_RTT_UNLOCK() __asm volatile ("mov r0, %0 \n\t" \

"mrs r1, CPSR \n\t" \
"bic r1, r1, #0xC0 \n\t" \
"and r0, r0, #0xC0 \n\t" \
"orr r1, r1, r0 \n\t" \
"msr CPSR_c, r1 \n\t" \
: \
: "r" (LockState) \
: "r0", "r1" \
); \
}

//
// Define SystemView locking in SEGGER_SYSVIEW_Conf.h
//
#define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK()

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

95 CHAPTER 4 Supported CPUs

#define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK()

4.6.4.4 Renesas RZ/A1 Cortex-A9 sample configuration

This sample configuration for the Renesas RZ/A1 (R7S72100) retrieves the currently active
interrupt and the system tick counter from embOS.
It uses the OS Timer for timestamp generation. The RZ/A1 includes a GIC.

SEGGER_SYSVIEW_Conf.h

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *
**********************************************************************
-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Conf.h
Purpose : SEGGER SysView configuration for Renesas RZ/A1 Cortex-A9
with SEGGER embOS.
*/

#ifndef SEGGER_SYSVIEW_CONF_H
#define SEGGER_SYSVIEW_CONF_H

/*********************************************************************
*
* SysView buffer configuration
*/
// Number of bytes that SysView uses for the buffer.
// Should be large enough for single-shot recording.
#define SEGGER_SYSVIEW_RTT_BUFFER_SIZE 1024 * 1024
// The RTT channel that SysView will use.
#define SEGGER_SYSVIEW_RTT_CHANNEL 1

/*********************************************************************
*
* SysView timestamp configuration
*/
// Retrieve a system timestamp via OS-specific function
#define SEGGER_SYSVIEW_GET_TIMESTAMP() SEGGER_SYSVIEW_X_GetTimestamp()
// number of valid bits low-order delivered by SEGGER_SYSVIEW_X_GetTimestamp()
#define SEGGER_SYSVIEW_TIMESTAMP_BITS 32

/*********************************************************************
*
* SysView interrupt configuration
*/
//
// SEGGER_SYSVIEW_InterruptId has to be defined in the module which
// handles the interrupts and must be set to the acknowledged interrupt Id.
//
// Example:
//
// #define GIC_BASE_ADDR /* as base address of the GIC on the device */
// #define GICC_BASE_ADDR (GIC_BASE_ADDR + 0x2000u)
// #define GICC_IAR (*(volatile unsigned*)(GICC_BASE_ADDR + 0x000C))
//
// unsigned int SEGGER_SYSVIEW_InterruptId; //
<<-- Define SEGGER_SYSVIEW_InterruptId.
// void OS_irq_handler(void) {
//
// int_id = GICC_IAR & 0x03FF; // Read interrupt ID, acknowledge interrupt
// SEGGER_SYSVIEW_InterruptId = iar_val;
// OS_EnterInterrupt(); // Inform OS that interrupt handler is running
// pISR(); // Call interrupt service routine
// OS_LeaveInterrupt();
// Leave interrupt, perform task switch if required

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

96 CHAPTER 4 Supported CPUs

// }
//
extern unsigned int SEGGER_SYSVIEW_InterruptId;

#define SEGGER_SYSVIEW_GET_INTERRUPT_ID() (SEGGER_SYSVIEW_InterruptId)

/*********************************************************************
*
* SysView locking
*/
// Lock SysView (nestable)
#define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK()
// Unlock SysView (nestable)
#define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK()

#endif

/*************************** End of file ****************************/

SEGGER_SYSVIEW_Config_embOS_RZA1.c

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *
**********************************************************************
-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Config_embOS_RZA1.c
Purpose : Sample setup configuration of SystemView with embOS
for Renesas RZ/A1 Cortex-A9.
*/
#include "RTOS.h"
#include "SEGGER_SYSVIEW.h"
#include "SEGGER_SYSVIEW_embOS.h"

// SystemcoreClock can be used in most CMSIS compatible projects.

// In non-CMSIS projects define SYSVIEW_CPU_FREQ below.
extern unsigned int SystemCoreClock;

/*********************************************************************
*
* Defines, configurable
*
**********************************************************************
*/
// The application name to be displayed in SystemView
#define SYSVIEW_APP_NAME "embOS Demo Application"

// The target device name

#define SYSVIEW_DEVICE_NAME "R7S72100"

// Frequency of the timestamp. Must match SEGGER_SYSVIEW_Conf.h

// and SEGGER_SYSVIEW_X_GetTimestamp().
#define SYSVIEW_TIMESTAMP_FREQ (399900000u / 12)

// System Frequency. SystemcoreClock is used in most CMSIS compatible projects.

#define SYSVIEW_CPU_FREQ (399900000u)

// The lowest RAM address used for IDs (pointers)

// Should be adjusted if the RAM does not start at 0x20000000.
#define SYSVIEW_RAM_BASE (0x60020000)

#define TIMER_INTERRUPT_PENDING() /* as check if a timer interrupt is pending */

/*********************************************************************
*

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

97 CHAPTER 4 Supported CPUs

* _cbSendSystemDesc()
*
* Function description
* Sends SystemView description strings.
*/
static void _cbSendSystemDesc(void) {
SEGGER_SYSVIEW_SendSysDesc("N="SYSVIEW_APP_NAME",D="SYSVIEW_DEVICE_NAME);
}

/*********************************************************************
*
* Global functions
*
**********************************************************************
*/
void SEGGER_SYSVIEW_Conf(void) {
SEGGER_SYSVIEW_Init(SYSVIEW_TIMESTAMP_FREQ, SYSVIEW_CPU_FREQ,
&SYSVIEW_X_OS_TraceAPI, _cbSendSystemDesc);
SEGGER_SYSVIEW_SetRAMBase(SYSVIEW_RAM_BASE);
OS_SetTraceAPI(&embOS_TraceAPI_SYSVIEW); // Configure embOS to use SYSVIEW.
}

/*********************************************************************
*
* SEGGER_SYSVIEW_X_GetTimestamp()
*
* Function description
* Returns the current timestamp in ticks using the system tick
* count and the SysTick counter.
* All parameters of the SysTick have to be known and are set via
* configuration defines on top of the file.
*
* Return value
* The current timestamp.
*
* Additional information
* SEGGER_SYSVIEW_X_GetTimestamp is always called when interrupts are
* disabled. Therefore locking here is not required.
*/
U32 SEGGER_SYSVIEW_X_GetTimestamp(void) {
U32 TickCount;
U32 Cycles;
U32 CyclesPerTick;
//
// Get the cycles of the current system tick.
// Sample timer is down-counting,
// subtract the current value from the number of cycles per tick.
//
CyclesPerTick = 33249 + 1;
Cycles = (CyclesPerTick - OSTM_CNT);
//
// Get the system tick count.
//
TickCount = SEGGER_SYSVIEW_TickCnt;
//
// Check if a timer interrupt is pending
//
if (TIMER_INTERRUPT_PENDING()) {
TickCount++;
Cycles = (CyclesPerTick - OSTM_CNT);
}
Cycles += TickCount * CyclesPerTick;

return Cycles;
}

/*************************** End of file ****************************/

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

98 CHAPTER 4 Supported CPUs

4.6.4.5 TI AM3358 Cortex-A8 sample configuration

This sample configuration for the TI AM3358 retrieves the currently active interrupt directly.
It initializes and uses the Cortex-A performance counter for timestamp generation.
The SystemView timestmap generation can be used for other Cortex-A devices, which in-
clude the performance counter unit.

SEGGER_SYSVIEW_Conf.h

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *
**********************************************************************
-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Conf.h
Purpose : Generic SEGGER SysView configuration for non-Cortex-M
devices.
*/

#ifndef SEGGER_SYSVIEW_CONF_H
#define SEGGER_SYSVIEW_CONF_H

/*********************************************************************
*
* SysView timestamp configuration
*/
// Retrieve a system timestamp via user-defined function
#define SEGGER_SYSVIEW_GET_TIMESTAMP() SEGGER_SYSVIEW_X_GetTimestamp()
// number of valid bits low-order delivered by SEGGER_SYSVIEW_X_GetTimestamp()
#define SEGGER_SYSVIEW_TIMESTAMP_BITS 32

/*********************************************************************
*
* SysView Id configuration
*/
// Default value for the lowest Id reported by the application.
// Can be overridden by the application via SEGGER_SYSVIEW_SetRAMBase().
#define SEGGER_SYSVIEW_ID_BASE 0
// Number of bits to shift the Id to save bandwidth.
// (for example 2 when all reported Ids (pointers) are 4 byte aligned)
#define SEGGER_SYSVIEW_ID_SHIFT 0

/*********************************************************************
*
* SysView interrupt configuration
*/
#define SEGGER_SYSVIEW_GET_INTERRUPT_ID() SEGGER_SYSVIEW_X_GetInterruptId()

/*********************************************************************
*
* SysView locking
*/
// Lock SysView (nestable)
#define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK()
// Unlock SysView (nestable)
#define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK()

#endif

/*************************** End of file ****************************/

SEGGER_SYSVIEW_Config_embOS_AM3358.c

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

99 CHAPTER 4 Supported CPUs

**********************************************************************
-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Config_embOS_RZA1.c
Purpose : Sample setup configuration of SystemView with embOS
for TI AM3358 Cortex-A8.
*/
#include "RTOS.h"
#include "SEGGER_SYSVIEW.h"
#include "SEGGER_SYSVIEW_embOS.h"

//
// SystemcoreClock can be used in most CMSIS compatible projects.
// In non-CMSIS projects define SYSVIEW_CPU_FREQ directly.
//
extern unsigned int SystemCoreClock;

/*********************************************************************
*
* Defines, configurable
*
**********************************************************************
*/
// The application name to be displayed in SystemView
#ifndef SYSVIEW_APP_NAME
#define SYSVIEW_APP_NAME "embOS start project"
#endif

// The target device name

#ifndef SYSVIEW_DEVICE_NAME
#define SYSVIEW_DEVICE_NAME "AM3358"
#endif

// Frequency of the timestamp. Must match SEGGER_SYSVIEW_Conf.h

// The performance counter frequency equals the core clock frequency.
#define SYSVIEW_TIMESTAMP_FREQ (SystemCoreClock)

// System Frequency. SystemcoreClock is used in most CMSIS compatible projects.

#ifndef SYSVIEW_CPU_FREQ
#define SYSVIEW_CPU_FREQ (SystemCoreClock)
#endif

// The lowest RAM address used for IDs (pointers)

#ifndef SYSVIEW_RAM_BASE
#define SYSVIEW_RAM_BASE (0x80000000)
#endif

#ifndef SYSVIEW_SYSDESC0
#define SYSVIEW_SYSDESC0 "I#67=SysTick,I#18=USB,I#17=USBSS,I#36=LCDC"
#endif

#define INTC_BASE (0x48200000uL)

#define INTC_SIR_IRQ (*(volatile U32*) (INTC_BASE + 0x40uL))

/*********************************************************************
*
* Local functions
*
**********************************************************************
*/
/*********************************************************************
*
* _cbSendSystemDesc()
*
* Function description
* Sends SystemView description strings.
*/
static void _cbSendSystemDesc(void) {

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

100 CHAPTER 4 Supported CPUs

SEGGER_SYSVIEW_SendSysDesc("N="SYSVIEW_APP_NAME",O=embOS,D="SYSVIEW_DEVICE_NAME);
#ifdef SYSVIEW_SYSDESC0
SEGGER_SYSVIEW_SendSysDesc(SYSVIEW_SYSDESC0);
#endif
#ifdef SYSVIEW_SYSDESC1
SEGGER_SYSVIEW_SendSysDesc(SYSVIEW_SYSDESC1);
#endif
#ifdef SYSVIEW_SYSDESC2
SEGGER_SYSVIEW_SendSysDesc(SYSVIEW_SYSDESC2);
#endif
}

/*********************************************************************
*
* _InitPerformanceCounter
*
* Function description
* Initialize the internal Cortex-A Performance counter.
* The function will work for Cortex-A8, Cortex-A9.
* Please check whether this also suites for your core.
*/
static void _InitPerformanceCounter(U32 PerformReset, I32 UseDivider) {
//
// in general enable all counters (including cycle counter)
//
I32 Value = 1;

//
// Peform reset:
//
if (PerformReset) {
Value |= 2; // reset all counters to zero.
Value |= 4; // reset cycle counter to zero.
}

if (UseDivider) {
Value |= 8; // enable "by 64" divider for CCNT.
}
Value |= 16;

// program the performance-counter control-register:

__asm volatile ("MCR p15, 0, %0, c9, c12, 0\t\n"
: // Output result
: "r"(Value) // Input
: // Clobbered list
);
//
// Enable all counters
//
__asm volatile ("MCR p15, 0, %0, c9, c12, 1\t\n"
: // Output result
: "r"(0x8000000f) // Input
: // Clobbered list
);
//
// Clear overflows
//
__asm volatile ("MCR p15, 0, %0, c9, c12, 3\t\n"
: // Output result
: "r"(0x8000000f) // Input
: // Clobbered list
);
}

/*********************************************************************
*
* Global functions
*

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

101 CHAPTER 4 Supported CPUs

**********************************************************************
*/

/*********************************************************************
*
* SEGGER_SYSVIEW_Conf
*
* Function description
* Configures SYSVIEW.
*
* Please check whether this also suites for your core.
*/
void SEGGER_SYSVIEW_Conf(void) {
//
// Write USEREN Register
//
__asm volatile ("MCR p15, 0, %0, C9, C14, 0\n\t"
: // Output result
: "r"(1) // Input
: // Clobbered list
);

//
// Disable counter overflow interrupts
//
__asm volatile ("MCR p15, 0, %0, C9, C14, 2\n\t"
: // Output result
: "r"(0x8000000f) // Input
: // Clobbered list
);
_InitPerformanceCounter(1, 0);
SEGGER_SYSVIEW_Init(SYSVIEW_TIMESTAMP_FREQ, SYSVIEW_CPU_FREQ,
&SYSVIEW_X_OS_TraceAPI, _cbSendSystemDesc);
SEGGER_SYSVIEW_SetRAMBase(SYSVIEW_RAM_BASE);
OS_SetTraceAPI(&embOS_TraceAPI_SYSVIEW); // Configure embOS to use SYSVIEW.
}

/*********************************************************************
*
* SEGGER_SYSVIEW_X_GetTimestamp()
*
* Function description
* Returns the current timestamp in ticks using the performance counter.
*
* Return value
* The current timestamp.
*
* Additional information
* SEGGER_SYSVIEW_X_GetTimestamp is always called when interrupts are
* disabled. Therefore locking here is not required.
*/
U32 SEGGER_SYSVIEW_X_GetTimestamp(void) {
register U32 r = 0;
//
// Read CCNT Register
//
__asm volatile ("MRC p15, 0, %0, c9, c13, 0"
: "+r"(r) // Output result
: // Inputs
: ); // Clobbered list
return r;
}

/*********************************************************************
*
* SEGGER_SYSVIEW_X_GetInterruptId()
*
* Function description

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

102 CHAPTER 4 Supported CPUs

* Return the currently active IRQ interrupt number

* from the INTC_SIR_IRQ.
*/
U32 SEGGER_SYSVIEW_X_GetInterruptId(void) {
return (INTC_SIR_IRQ & (0x7Fu)); // INTC_SIR_IRQ[6:0]: ActiveIRQ
}

4.6.5 Renesas RX
Recording mode Supported?
Continuous recording Yes
Single-shot recording Yes
Post-mortem analysis Yes

4.6.5.1 Renesas RX Event timestamp

The event timestamp has to be provided by an application clock source timer. SEG-
GER_SYSVIEW_X_GetTimestamp() can be used to implement the functionality.
Before creating any other event in the timer interrupt, the interrupt handler should incre-
ment SEGGER_SYSVIEW_TickCnt.

Configuration:

//
// SEGGER_SYSVIEW_TickCnt has to be defined in the module which
// handles the system tick timer and must be incremented in the timer interrupt
// handler before any SYSVIEW event is generated.
//
// Example in embOS RTOSInit.c:
//
// unsigned int SEGGER_SYSVIEW_TickCnt; // <<-- Define SEGGER_SYSVIEW_TickCnt.
// void SysTick_Handler(void) {
// #if OS_PROFILE
// SEGGER_SYSVIEW_TickCnt++; // <<-- Increment SEGGER_SYSVIEW_TickCnt asap.
// #endif
// OS_EnterNestableInterrupt();
// OS_TICK_Handle();
// OS_LeaveNestableInterrupt();
// }
//
extern unsigned int SEGGER_SYSVIEW_TickCnt;

/*********************************************************************
*
* Defines, fixed
*
**********************************************************************
*/
// System Timer configuration
#define IRR_BASE_ADDR (0x00087000u)
#define CMT0_VECT 28u
#define OS_TIMER_VECT CMT0_VECT
#define TIMER_PRESCALE (8u)
#define CMT0_BASE_ADDR (0x00088000u)
#define CMT0_CMCNT (*(volatile U16*) (CMT0_BASE_ADDR + 0x04u))

/*********************************************************************
*
* SEGGER_SYSVIEW_X_GetTimestamp()
*
* Function description
* Returns the current timestamp in ticks using the system tick
* count and the system timer counter.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

103 CHAPTER 4 Supported CPUs

* All parameters of the system timer have to be known and are set via
* configuration defines on top of the file.
*
* Return value
* The current timestamp.
*
* Additional information
* SEGGER_SYSVIEW_X_GetTimestamp is always called when interrupts are
* disabled. Therefore locking here is not required.
*/
U32 SEGGER_SYSVIEW_X_GetTimestamp(void) {
U32 Time;
U32 Cnt;

Time = SEGGER_SYSVIEW_TickCnt;
Cnt = CMT0_CMCNT;
//
// Check if timer interrupt pending ...
//
if ((*(volatile U8*)(IRR_BASE_ADDR + OS_TIMER_VECT) & (1u << 0u)) != 0u) {
Cnt = CMT0_CMCNT; // Interrupt pending, re-read timer and adjust result
Time++;
}
return ((SYSVIEW_TIMESTAMP_FREQ/1000) * Time) + Cnt;
}

4.6.5.2 Renesas RX Interrupt ID

The currently active interrupt level can be used as the interrupt ID on RX devices. In
the sample configuration it is provided by SEGGER_SYSVIEW_X_GetInterruptId() in SEG-
GER_SYSVIEW_Config_[System]_RX.c.

Configuration:

//
// Get the interrupt Id via user-provided function
//
#define SEGGER_SYSVIEW_GET_INTERRUPT_ID() SEGGER_SYSVIEW_X_GetInterruptId()

4.6.5.3 Renesas RX SystemView lock and unlock

Locking and unlocking SystemView to prevent transferring records from being interrupted
can be done by disabling interrupts.
Lock and unlock for SystemView and RTT can be the same.

Configuration:

//
// RTT locking for IAR toolchains in SEGGER_RTT_Conf.h
//
#define SEGGER_RTT_LOCK() { \
unsigned long LockState; \
LockState = __get_interrupt_state(); \
__disable_interrupt();

#define SEGGER_RTT_UNLOCK() __set_interrupt_state(LockState); \

}

//
// Define SystemView locking in SEGGER_SYSVIEW_Conf.h
//
#define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK()
#define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK()

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

104 CHAPTER 4 Supported CPUs

4.6.5.4 Renesas RX Sample configuration

SEGGER_SYSVIEW_Conf.h

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *
**********************************************************************
-------------------------- END-OF-HEADER -----------------------------

File : SEGGER_SYSVIEW_Conf.h
Purpose : SEGGER SysView configuration for Renesas RX
*/

#ifndef SEGGER_SYSVIEW_CONF_H
#define SEGGER_SYSVIEW_CONF_H

/*********************************************************************
*
* SysView timestamp configuration
*/
// Retrieve a system timestamp via user-defined function
#define SEGGER_SYSVIEW_GET_TIMESTAMP() SEGGER_SYSVIEW_X_GetTimestamp()
// number of valid bits low-order delivered by SEGGER_SYSVIEW_X_GetTimestamp()
#define SEGGER_SYSVIEW_TIMESTAMP_BITS 32

/*********************************************************************
*
* SysView Id configuration
*/
// Default value for the lowest Id reported by the application.
// Can be overridden by the application via SEGGER_SYSVIEW_SetRAMBase().
#define SEGGER_SYSVIEW_ID_BASE 0
// Number of bits to shift the Id to save bandwidth.
// (for example 2 when all reported Ids (pointers) are 4 byte aligned)
#define SEGGER_SYSVIEW_ID_SHIFT 0

/*********************************************************************
*
* SysView interrupt configuration
*/
// Get the currently active interrupt Id. (read Cortex-M ICSR[8:0]
= active vector)
#define SEGGER_SYSVIEW_GET_INTERRUPT_ID() SEGGER_SYSVIEW_X_GetInterruptId()

/*********************************************************************
*
* SysView locking
*/
// Lock SysView (nestable)
#define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK()
// Unlock SysView (nestable)
#define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK()

#endif

/*************************** End of file ****************************/

SEGGER_SYSVIEW_Config_embOS_CM0.c

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *
* The Embedded Experts *
* www.segger.com *
**********************************************************************

-------------------------- END-OF-HEADER -----------------------------

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

105 CHAPTER 4 Supported CPUs

File : SEGGER_SYSVIEW_Config_NoOS_RX.c
Purpose : Sample setup configuration of SystemView on Renesas RX
systems without an operating system.
Revision: $Rev: 18540 $
*/
#include "RTOS.h"
#include "SEGGER_SYSVIEW.h"
#include "SEGGER_SYSVIEW_embOS.h"

//
// SystemcoreClock can be used in most CMSIS compatible projects.
// In non-CMSIS projects define SYSVIEW_CPU_FREQ directly.
//
extern unsigned int SystemCoreClock;

/*********************************************************************
*
* Defines, fixed
*
**********************************************************************
*/

/*********************************************************************
*
* Defines, configurable
*
**********************************************************************
*/
// The application name to be displayed in SystemViewer
#ifndef SYSVIEW_APP_NAME
#define SYSVIEW_APP_NAME "Demo Application"
#endif

// The target device name

#ifndef SYSVIEW_DEVICE_NAME
#define SYSVIEW_DEVICE_NAME "RX64M"
#endif

// System Frequency. SystemcoreClock is used in most CMSIS compatible projects.

#ifndef SYSVIEW_CPU_FREQ
#define SYSVIEW_CPU_FREQ (SystemCoreClock)
#endif

// Frequency of the timestamp. Must match SEGGER_SYSVIEW_Conf.h and RTOSInit.c

#ifndef SYSVIEW_TIMESTAMP_FREQ
#define SYSVIEW_TIMESTAMP_FREQ
(SYSVIEW_CPU_FREQ/2u/8u) // Assume system timer runs at
1/16th of the CPU frequency
#endif

// The lowest RAM address used for IDs (pointers)

#ifndef SYSVIEW_RAM_BASE
#define SYSVIEW_RAM_BASE (0)
#endif

#ifndef SYSVIEW_SYSDESC0
#define SYSVIEW_SYSDESC0
"I#0=IntPrio0,I#1=IntPrio1,I#2=IntPrio2,I#3=IntPrio3,I#4=IntPrio4"
#endif

//#ifndef SYSVIEW_SYSDESC1
// #define SYSVIEW_SYSDESC1
"I#5=IntPrio5,I#6=IntPrio6,I#7=IntPrio7,I#8=IntPrio8,I#9=IntPrio9,I#10=IntPrio10"
//#endif

//#ifndef SYSVIEW_SYSDESC2

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

106 CHAPTER 4 Supported CPUs

// #define SYSVIEW_SYSDESC2
"I#11=IntPrio11,I#12=IntPrio12,I#13=IntPrio13,I#14=IntPrio14,I#15=IntPrio15"
//#endif

// System Timer configuration

#define IRR_BASE_ADDR (0x00087000u)
#define CMT0_VECT 28u
#define OS_TIMER_VECT CMT0_VECT
#define TIMER_PRESCALE (8u)
#define CMT0_BASE_ADDR (0x00088000u)
#define CMT0_CMCNT (*(volatile U16*) (CMT0_BASE_ADDR + 0x04u))

extern unsigned SEGGER_SYSVIEW_TickCnt;

// Tick Counter value incremented in the tick handler.

/*********************************************************************
*
* _cbSendSystemDesc()
*
* Function description
* Sends SystemView description strings.
*/
static void _cbSendSystemDesc(void) {
SEGGER_SYSVIEW_SendSysDesc("N="SYSVIEW_APP_NAME",D="SYSVIEW_DEVICE_NAME);
#ifdef SYSVIEW_SYSDESC0
SEGGER_SYSVIEW_SendSysDesc(SYSVIEW_SYSDESC0);
#endif
#ifdef SYSVIEW_SYSDESC1
SEGGER_SYSVIEW_SendSysDesc(SYSVIEW_SYSDESC1);
#endif
#ifdef SYSVIEW_SYSDESC2
SEGGER_SYSVIEW_SendSysDesc(SYSVIEW_SYSDESC2);
#endif
}

/*********************************************************************
*
* Global functions
*
**********************************************************************
*/
void SEGGER_SYSVIEW_Conf(void) {
SEGGER_SYSVIEW_Init(SYSVIEW_TIMESTAMP_FREQ, SYSVIEW_CPU_FREQ,
0, _cbSendSystemDesc);
SEGGER_SYSVIEW_SetRAMBase(SYSVIEW_RAM_BASE);
}

/*********************************************************************
*
* SEGGER_SYSVIEW_X_GetTimestamp()
*
* Function description
* Returns the current timestamp in ticks using the system tick
* count and the SysTick counter.
* All parameters of the SysTick have to be known and are set via
* configuration defines on top of the file.
*
* Return value
* The current timestamp.
*
* Additional information
* SEGGER_SYSVIEW_X_GetTimestamp is always called when interrupts are
* disabled.
* Therefore locking here is not required and OS_GetTime_Cycles() may
* be called.
*/
U32 SEGGER_SYSVIEW_X_GetTimestamp(void) {
U32 Time;

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

107 CHAPTER 4 Supported CPUs

U32 Cnt;

Time = SEGGER_SYSVIEW_TickCnt;
Cnt = CMT0_CMCNT;
//
// Check if timer interrupt pending ...
//
if ((*(volatile U8*)(IRR_BASE_ADDR + OS_TIMER_VECT) & (1u << 0u)) != 0u) {
Cnt = CMT0_CMCNT; // Interrupt pending, re-read timer and adjust result
Time++;
}
return ((SYSVIEW_TIMESTAMP_FREQ/1000) * Time) + Cnt;
}

/*********************************************************************
*
* SEGGER_SYSVIEW_X_GetInterruptId()
*
* Function description
* Return the priority of the currently active interrupt.
*/
U32 SEGGER_SYSVIEW_X_GetInterruptId(void) {
U32 IntId;
__asm volatile ("mvfc PSW, %0 \t\n" // Load current PSW
"and #0x0F000000, %0 \t\n" // Clear all except IPL
([27:24])
"shlr #24, %0 \t\n" // Shift IPL to [3:0]
: "=r" (IntId) // Output result
: // Input
: // Clobbered list
);
return IntId;
}

/*************************** End of file ****************************/

4.6.6 Other CPUs

Recording mode Supported?
Continuous recording No
Single-shot recording Yes
Post-mortem analysis Yes

On CPUs, which are not covered by the sections above SystemView can be used in sin-
gle-shot mode, too.
To properly run SystemView the same items have to be configured:
• Get an event timestamp.
• Get an interrupt Id of the active interrupt.
• Lock and unlock SystemView to prevent recording being interrupted.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

108 CHAPTER 4 Supported OSes

4.7 Supported OSes

The following chapter describes which (RT)OSes are already instrumented to use Sys-
temView and how to configure them.

4.7.1 embOS
SEGGER embOS (V4.12a and later) can generate trace events for SystemView and other
recording implementations when profiling is enabled.

4.7.1.1 Configuring embOS for SystemView

Profiling is enabled in the OS_LIBMODE_SP, OS_LIBMODE_DP and OS_LIBMODE_DT embOS li-
brary configurations (For detailed information refer to the embOS User Manual UM01001).
In addition to the SYSTEMVIEW and RTT core module, the following file must be included
in the application:
• For Cortex-M3 and Cortex-M4 targets include SEGGER_SYSVIEW_Config_embOS.c.
• For Cortex-M0 and Cortex-M1 targets include SEGGER_SYSVIEW_Config_embOS.c.
This file provides additionally required functions for SystemView and allows configuration to
fit the target system, like defines for the application name, the target device and the target
core frequency. It initializes the SYSTEMVIEW module and configures embOS to send trace
events to SystemView. For an example configuration, refer to Supported CPUs on page 82.
At the start of the application, at main, after the target is initialized, SEGGER_SYSVIEW_Con-
f() has to be called to enable SystemView.
Now, when the application is running, SystemView can connect to the target and start
recording events. All task, interrupt, and OS Scheduler activity, as well as embOS API calls
are recorded when SystemView is connected or SEGGER_SYSVIEW_Start() has been called.

4.7.2 uC/OS-III
SystemView can be used with Micrium’s uC/OS-III to record task, interrupt, and scheduler
activity.

4.7.2.1 Configuring uC/OS-III for SystemView

In addition to the SYSTEMVIEW and RTT core module the following files have to be included
in the application project:
SEGGER_SYSVIEW_Config_uCOSIII.c provides additionally required functions for Sys-
temView and allows configuration to fit the target system, like defines for the application
name, the target device and the target core frequency. The example configuration file,
shipped with the SystemView package is configured to be used with most Cortex-M3, Cor-
tex-M4, and Cortex-M7 targets. For an example configuration, refer to Supported CPUs on
page 82.
SEGGER_SYSVIEW_uCOSIII.c and os_trace_events.h provide the interface between uC/
OS-III and SystemView. They usually do not need to be modified.
os_cfg_trace.h is the minimal uc/OS-III Trace configuration file required for SystemView.
If the project already includes this file, make sure the content fits the application. This file
includes two defines to configure the maximum number of tasks and the maximum number
of resources to be managed and named in the SystemView recording.

#define TRACE_CFG_MAX_TASK 16u

#define TRACE_CFG_MAX_RESOURCES 16u

Enable recording
Recording of uC/OS-III events can be configured in os_cfg.h.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

109 CHAPTER 4 Supported OSes

Define OS_CFG_TRACE_EN as 1u to enable basic recording.

When OS_CFG_TRACE_API_ENTER_EN is defined as 1u, API function calls will be recorded,
too.
To also record when an API function exits, define OS_CFG_TRACE_API_EXIT_EN as 1u as well.
Call TRACE_INIT() at the beginning of the application, after the system has been initialized:

[...]
BSP_Init(); /* Initialize BSP functions */
CPU_Init(); /* Initialize the uC/CPU services */

#if (defined(OS_CFG_TRACE_EN) && (OS_CFG_TRACE_EN > 0u))

/* Initialize uC/OS-III Trace. Should be called after initializing the
system. */
TRACE_INIT();
#endif
[...]

4.7.3 uC/OS-II
SystemView can be used with Micrium’s uC/OS-II to record task, interrupt, and scheduler
activity. SystemView support has been added with v2.92.13
For information on how to configure uC/OS-II for SystemView, follow the guide at https://
doc.micrium.com/display/osiidoc/SEGGER+SystemView

4.7.3.1 Configuring uC/OS-II for SystemView

In addition to the SYSTEMVIEW and RTT core module the following files have to be included
in the application project:
SEGGER_SYSVIEW_Config_uCOSII.c provides additionally required functions for Sys-
temView and allows configuration to fit the target system, like defines for the application
name, the target device and the target core frequency. The example configuration file,
shipped with the SystemView package is configured to be used with most Cortex-M3, Cor-
tex-M4, and Cortex-M7 targets. For an example configuration, refer to Supported CPUs on
page 82.
SEGGER_SYSVIEW_uCOSII.c and os_trace_events.h provide the interface between uC/OS-
II and SystemView. They usually do not need to be modified.
os_cfg_trace.h is the minimal uc/OS-II Trace configuration file required for SystemView.
If the project already includes this file, make sure the content fits the application. This file
includes two defines to configure the maximum number of tasks and the maximum number
of resources to be managed and named in the SystemView recording.

#define TRACE_CFG_MAX_TASK 16u

#define TRACE_CFG_MAX_RESOURCES 16u

Enable recording
Recording of uC/OS-II events can be configured in os_cfg.h.
Define OS_CFG_TRACE_EN as 1u to enable basic recording.
When OS_CFG_TRACE_API_ENTER_EN is defined as 1u, API function calls will be recorded,
too.
To also record when an API function exits, define OS_CFG_TRACE_API_EXIT_EN as 1u as well.
Call TRACE_INIT() at the beginning of the application, after the system has been initialized:

[...]
BSP_Init(); /* Initialize BSP functions */
CPU_Init(); /* Initialize the uC/CPU services */

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

110 CHAPTER 4 Supported OSes

#if (defined(OS_CFG_TRACE_EN) && (OS_CFG_TRACE_EN > 0u))

/* Initialize uC/OS-II Trace. Should be called after initializing the system.
*/
TRACE_INIT();
#endif
[...]

4.7.4 Micrium OS Kernel

SystemView can be used with the Micrium OS Kernel to record task, interrupt, and scheduler
activity.

4.7.4.1 Configuring Micrium OS Kernel for SystemView

In addition to the SYSTEMVIEW and RTT core module the following files have to be included
in the application project:
SEGGER_SYSVIEW_Config_MicriumOSKernel.c provides additionally required functions for
SystemView and allows configuration to fit the target system, like defines for the applica-
tion name, the target device and the target core frequency. The example configuration
file, shipped with the SystemView package is configured to be used with most Cortex-M3,
Cortex-M4, and Cortex-M7 targets. For an example configuration, refer to Supported CPUs
on page 82.
SEGGER_SYSVIEW_MicriumOSKernel.c and os_trace_events.h provide the interface be-
tween the Micrium OS Kernel and SystemView. They usually do not need to be modified.
os_cfg_trace.h is the minimal Micrium OS Kernel Trace configuration file required for Sys-
temView. If the project already includes this file, make sure the content fits the application.
This file includes two defines to configure the maximum number of tasks and the maximum
number of resources to be managed and named in the SystemView recording.

#define TRACE_CFG_MAX_TASK 16u

#define TRACE_CFG_MAX_RESOURCES 16u

Enable recording
Recording of Micrium OS Kernel events can be configured in os_cfg.h.
Define OS_CFG_TRACE_EN as 1u to enable basic recording.
When OS_CFG_TRACE_API_ENTER_EN is defined as 1u, API function calls will be recorded,
too.
To also record when an API function exits, define OS_CFG_TRACE_API_EXIT_EN as 1u as well.
Call TRACE_INIT() at the beginning of the application, after the system has been initialized:

[...]
BSP_Init(); /* Initialize BSP functions */
CPU_Init(); /* Initialize the uC/CPU services */

#if (defined(OS_CFG_TRACE_EN) && (OS_CFG_TRACE_EN > 0u))

/* Initialize Micrium OS Kernel Trace. Should be called after initializing
the system. */
TRACE_INIT();
#endif
[...]

4.7.5 FreeRTOS
FreeRTOS can also generate trace events for SystemView and allows basic but useful analy-
sis without modification.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

111 CHAPTER 4 Supported OSes

For more detailed analysis, like Scheduler activity and interrupts, the FreeRTOS source and
the used port have to be slightly modified.

4.7.5.1 Configuring FreeRTOS for SystemView

In addition to the SYSTEMVIEW and RTT core module, SEGGER_SYSVIEW_Config_FreeR-
TOS.c must be included in the application. This file provides additionally required functions
for SystemView and allows configuration to fit the target system, like defines for the appli-
cation name, the target device and the target core frequency. For an example configura-
tion, refer to Supported CPUs on page 82.
The SEGGER_SYSVIEW_FreeRTOS.h header has to be included at the end of FreeRTOS-
Config.h or above every include of FreeRTOS.h. It defines the trace macros to create
SYSTEMVIEW events..
To get the best results INCLUDE_xTaskGetIdleTaskHandle and INCLUDE_pxTaskGetStack-
Start should be defined as 1 in FreeRTOSConfig.h.
The patch file Sample/FreeRTOSV8/Patch/FreeRTOSV8.2.3_Core.patch shows the re-
quired modifications of the FreeRTOS 8.2.3 source and the GCC/ARM_CM4F port. It can
be used as a reference when using another version or port of FreeRTOS. E.g. if an-
other port than GCC/ARM_CM4F is used, the traceISR_ENTER(), traceISR_EXIT(), and
traceISR_EXIT_TO_SCHEDULER() calls have to be added accordingly.
The patch file Sample/FreeRTOSV9/Patch/FreeRTOSV9_Core.patch can be used to patch
FreeRTOS V9.
The patch file Sample/FreeRTOSV10/Patch/FreeRTOSV10_Core.patch can be used to patch
FreeRTOS V10.0.0 and can be used as a reference to patch other versions of FreeRTOS.
Note: Due to certain limitations by FreeRTOS, SystemView must store task names man-
ually. Per default 8 task names will be buffered. To increase this value go to the SEG-
GER_SYSVIEW_FreeRTOS.h and edit entry SYSVIEW_FREERTOS_MAX_NOF_TASKS to the num-
ber of tasks used in your application.

4.7.6 NuttX
SystemView can be used with NuttX RTOS to record system activity.
SystemView has been added to the NuttX mainline and can be enabled and configured in
its setup tools.
More information is available in the NuttX project documentation.

4.7.7 Zephyr
SystemView can be used as a recorder in Zephyr to record events.
More information is available in the Zephyr project documentation.

4.7.8 Other OSes

Other OSes are not officially instrumented, yet.
If you want to use SystemView with an other OS, get it touch with SEGGER or the OS
Vendor. The OS instrumentation can also be done with the guide in the following chapter.

4.7.8.1 No OS
SystemView can be used without any instrumented OS at all, to record interrupt activity
and user events.

Configuring a system for SystemView

In addition to the SYSTEMVIEW and RTT core module, SEGGER_SYSVIEW_Config_NoOS.c
must be included in the application. This file provides the basic configuration of the required

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

112 CHAPTER 4 Supported OSes

functions for SystemView and can be modified to fit the system. For an example configu-
ration, refer to Supported CPUs on page 82. An additional SEGGER_SYSVIEW_OS_API pointer
can be passed in SEGGER_SYSVIEW_Init to provide information about the system time or
“tasks” of the system.
For a description on how to record interrupts in the system, refer to Recording interrupts
on page 121.
A generic guide on how to implement SystemView on a NoOS system can be found on our
Wiki: https://wiki.segger.com/Use_SystemView_without_RTOS.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

 Chapter 5

SystemView on the target

This section describes how SystemView can be used in user application code to extend the
analysis information generated by the instrumented OS.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

114 CHAPTER 5 Performance Markers

5.1 Performance Markers

Performance Markers can be used to measure the timing in a system, for example the ex-
ecution time of a routine, or the delay from receiving an Ethernet packet until it is analyzed
and processed.
Performance Markers are shown in the Events list with runtime and count, and visualized
in the Timeline window.
To add Performance Markers in the application, use SEGGER_SYSVIEW_MarkStart(), SEG-
GER_SYSVIEW_Mark(), and SEGGER_SYSVIEW_MarkStop().
Performance Markers are identified and correlated by a MarkerId. For easier identification
in the SystemView Application, a name can be set per Id with SEGGER_SYSVIEW_NameMark-
er(), which can be called from the system description callback.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

115 CHAPTER 5 Terminal Output

5.2 Terminal Output

SystemView supports formatted output to the SystemView Application. This enables debug
log messages to be shown within the Events list, which can add more information for better
system analysis.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

116 CHAPTER 5 Resource Names

5.3 Resource Names

Resources, such as semaphores, mutextes, or mailboxes, are usually passed to API func-
tions as pointer and recorded in events as a (compressed) address.
For easier identification in the SystemView Application, a name can be set for each resource
address with SEGGER_SYSVIEW_NameResource().
When the name is known, and the OS description identifies a parameter as resource, the
name is shown instead of the resource address.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

 Chapter 6

Instrumenting OSes and

software modules

This section describes how to integrate SEGGER SystemView into an OS or middleware

module to be able to record its execution.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

118 CHAPTER 6 Integrating SEGGER SystemView into an OS

6.1 Integrating SEGGER SystemView into an OS

SEGGER SystemView can be integrated in any (RT)OS to get information about task exe-
cution, OS internal activity, like a scheduler, and OS API calls. For the following RTOSes
this integration has already been done and can be used out-of-the box.
• SEGGER embOS (V4.12a or later)
• Micrium uC/OS-II
• Micrium uC/OS-III (V3.06 or later)
• FreeRTOS (V8.2.3 or later)
For integration into other OSes, contact the OS distributor or do the integration following
the instructions in this sections.
The examples in this section are pseudo-code to illustrate when to call specific SystemView
functions. To allow general integration of trace instrumentation tools calls to these functions
can also be integrated as function macros or via a configurable trace API.

Instrumenting the OS core

In order to be able to record task execution and context switches, the OS core has to be
instrumented to generate SystemView events at the appropriate core functions.
Interrupt execution is in most cases handled by the OS, too. This allows instrumenting the
according OS functions called on enter and exit interrupt, which would otherwise have to
be done for each ISR in the application.
The third aspect of instrumenting the OS core is to provide run-time information for a more
detailed analysis. This information includes the system time to allow SystemView to display
timestamps relative to the start of the application, instead of to the start of recording, and
the task list, which is used by SystemView to display task names, stack information and
to order tasks by priority.

6.1.1 Recording task activity

SystemView can record a set of pre-defined system events for the main information of
system and OS activity, like task execution. These events should be generated by the OS
in the corresponding functions.
The pre-defined events are:

Event Description SystemView API

SEGGER_SYSVIEW_OnTaskCreate on
Task Create A new task is created.
page 172
A task is marked as ready
SEGGER_SYSVIEW_OnTaskStartReady
Task Start Ready to start or resume execu-
on page 174
tion.
A task is activated, it starts SEGGER_SYSVIEW_OnTaskStartExec
Task Start Exec
or resumes execution. on page 173
A task is blocked or sus- SEGGER_SYSVIEW_OnTaskStopReady
Task Stop Ready
pended. on page 176
SEGGER_SYSVIEW_OnTaskStopExec on
Task Stop Exec A task terminates.
page 175
No task is executing, the SEGGER_SYSVIEW_OnIdle on
System Idle
system goes into Idle state. page 171

6.1.1.1 Task Create

A new task is created.
Task Create events happen when a task is created by the system.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

119 CHAPTER 6 Integrating SEGGER SystemView into an OS

On Task Create events call SEGGER_SYSVIEW_OnTaskCreate() with the Id of the new task.
Additionally it is recommended to record the task information of the new task with SEG-
GER_SYSVIEW_SendTaskInfo().

Example

void OS_CreateTask(TaskFunc* pF, unsigned Prio, const char* sName, void* pStack) {
SEGGER_SYSVIEW_TASKINFO Info;
OS_TASK* pTask; // Pseudo struct to be replaced

[OS specific code ...]

SEGGER_SYSVIEW_OnTaskCreate((unsigned)pTask);
memset(&Info, 0, sizeof(Info));
//
// Fill elements with current task information
//
Info.TaskID = (U32)pTask;
Info.sName = pTask->Name;
Info.Prio = pTask->Priority;
Info.StackBase = (U32)pTask->pStack;
Info.StackSize = pTask->StackSize;
SEGGER_SYSVIEW_SendTaskInfo(&Info);
}

6.1.1.2 Task Start Ready

A task is marked as ready to start or resume execution.
Task Start Ready events can for example happen, when the delay time of the task expired,
or when a resource the task was waiting for is available, or when an event was triggered.
On Task Start Ready events call SEGGER_SYSVIEW_OnTaskStartReady() with the Id of the
task which has become ready.

Example

int OS_HandleTick(void) {
int TaskReady = 0; // Pseudo variable indicating a task is ready

[OS specific code ...]

if (TaskReady) {
SEGGER_SYSVIEW_OnTaskStartReady((unsigned)pTask);
}
}

6.1.1.3 Task Start Exec

A task is activated, it starts or resumes execution.
Task Start Exec events happen when the context is about to be switched to the activated
task. This is normally done by the Scheduler when there is a ready task.
On Task Start Exec events call SEGGER_SYSVIEW_OnTaskStartExec() with the Id of the task
which will execute.

Example

void OS_Switch(void) {

[OS specific code ...]

//
// If a task is activated

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

120 CHAPTER 6 Integrating SEGGER SystemView into an OS

//
SEGGER_SYSVIEW_OnTaskStartExec((unsigned)pTask);
//
// Else no task activated, go into idle state
//
SEGGER_SYSVIEW_OnIdle()
}

6.1.1.4 Task Stop Ready

A task is blocked or suspended.
Task Stop Ready events happen when a task is suspended or blocked, for example because
it delays for a specific time, or when it tries to claim a resource which is in use by another
task, or when it waits for an event to happen. When a task is suspended or blocked the
Scheduler will activate another task or go into idle state.
On Task Stop Ready events call SEGGER_SYSVIEW_OnTaskStopReady() with the Id of the
task which is blocked and a ReasonId which can indicate why the task is blocked.

Example

void OS_Delay(unsigned NumTicks) {

[OS specific code ...]

SEGGER_SYSVIEW_OnTaskStopReady(OS_Global.pCurrentTask, OS_CAUSE_WAITING);
}

6.1.1.5 Task Stop Exec

A task terminates.
Task Stop Exec events happen when a task finally stops execution, for example when it
has done its job and terminates.
On Task Stop Ready events call SEGGER_SYSVIEW_OnTaskStopExec() to record the current
task as stopped.

Example

void OS_TerminateTask(void) {

[OS specific code ...]

SEGGER_SYSVIEW_OnTaskStopExec();
}

6.1.1.6 System Idle

No task is executing, the system goes into Idle state.
System Idle events happen, when a task is suspended or stopped and no other task is
ready. The system can switch into an idle state to save power, wait for an interrupt or a
task to become ready.
In some OSes Idle is handled by an additional task. In this case it is recommended to record
System Idle events, when the Idle task is activated, too.
Time spent in Idle state is displayed as not CPU Load in SystemView.
On System Idle events call SEGGER_SYSVIEW_OnIdle().

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

121 CHAPTER 6 Integrating SEGGER SystemView into an OS

Example

void OS_Switch(void) {

[OS specific code ...]

//
// If a task is activated
//
SEGGER_SYSVIEW_OnTaskStartExec((unsigned)pTask);
//
// Else no task activated, go into idle state
//
SEGGER_SYSVIEW_OnIdle()
}

6.1.2 Recording interrupts

SystemView can record entering and leaving interrupt service routines (ISRs). The Sys-
temView API provides functions for these events which should be added to the OS when it
provides functions to mark interrupt execution.
When the OS scheduler is controlled by interrupts, for example the SysTick interrupt, the
exit interrupt event should distinguish between resuming normal execution or switching
into the scheduler, and call the appropriate SystemView function.

6.1.2.1 Enter Interrupt

When the OS provides a function to inform the OS that interrupt code is executing, to
be called at the start of an Interrupt Service Routine (ISR), the OS function should call
SEGGER_SYSVIEW_RecordEnterISR() to record the Enter Interrupt event.
When the OS does not provide an enter interrupt function, or the ISR does not call it, it
is the user’s responsibility to call SEGGER_SYSVIEW_RecordEnterISR() to be able to record
interrupt execution.
SEGGER_SYSVIEW_RecordEnterISR() automatically retrieves the interrupt ID via the SEG-
GER_SYSVIEW_GET_INTERRUPT_ID() function macro as defined in SEGGER_SYSVIEW_Conf.h.

Example

void OS_EnterInterrupt(void) {

[OS specific code ...]

SEGGER_SYSVIEW_RecordEnterISR();
}

6.1.2.2 Exit Interrupt

When the OS provides a function to inform the OS that interrupt code has executed, to be
called at the and of an Interrupt Service Routine (ISR), the OS function should call:
• SEGGER_SYSVIEW_RecordExitISR() when the system will resume normal execution.
• SEGGER_SYSVIEW_RecordExitISRToScheduler() when the interrupt caused a context
switch.

Example

void OS_ExitInterrupt(void) {

[OS specific code ...]

//
// If the interrupt will switch to the Scheduler

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

122 CHAPTER 6 Integrating SEGGER SystemView into an OS

//
SEGGER_SYSVIEW_RecordExitISRToScheduler();
//
// Otherwise
//
SEGGER_SYSVIEW_RecordExitISR();
}

6.1.2.3 Example ISRs

The following two examples show how to record interrupt execution with SystemView with
OS interrupt handling and without.

Example with OS handling

void Timer_Handler(void) {
//
// Inform OS about start of interrupt execution
// (records SystemView Enter Interrupt event).
//
OS_EnterInterrupt();
//
// Interrupt functionality could be here
//
APP_TimerCnt++;
//
// Inform OS about end of interrupt execution
// (records SystemView Exit Interrupt event).
//
OS_ExitInterrupt();
}

Example without OS handling

void ADC_Handler(void) {
//
// Explicitly record SystemView Enter Interrupt event.
// Should not be called in high-frequency interrupts.
//
SEGGER_SYSVIEW_RecordEnterISR();
//
// Interrupt functionality could be here
//
APP_ADCValue = ADC.Value;
//
// Explicitly record SystemView Exit Interrupt event.
// Should not be called in high-frequency interrupts.
//
SEGGER_SYSVIEW_RecordExitISR();
}

6.1.3 Recording run-time information

SystemView can record more detailed run-time information like the system time and in-
formation about tasks. These information are recorded when the recording is started and
periodically requested when SystemView is running.
To request the information a SEGGER_SYSVIEW_OS_API struct with the OS-specific functions
as callbacks can be passed to SystemView upon initialization.
Setting the SEGGER_SYSVIEW_OS_API is optional, but is recommended to allow SystemView
to display more detailed information.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

123 CHAPTER 6 Integrating SEGGER SystemView into an OS

SEGGER_SYSVIEW_OS_API

typedef struct {
U64 (*pfGetTime) (void);
void (*pfSendTaskList) (void);
} SEGGER_SYSVIEW_OS_API;

Parameters
Parameter Description
pfGetTime Pointer to a function returning the system time.
pfSendTaskList Pointer to a function recording the entire task list.

6.1.3.1 pfGetTime
Description
Get the system time, i.e. the time since starting the system, in microseconds.
If pfGetTime is NULL SystemView can show timestamps relative to the start of recording
only.

Prototype

U64 (*pfGetTime) (void);

6.1.3.2 pfSendTaskList
Description
Record the entire task list via SEGGER_SYSVIEW_SendTaskInfo().
If pfSendTaskList is NULL SystemView might only get task information of tasks which are
newly created while recording. pfSendTaskList is called on start of a recording when the
SystemView Application connects to get all information on the current task list.

Prototype

void (*pfSendTaskList) (void);

Example

void cbSendTaskList(void) {
SEGGER_SYSVIEW_TASKINFO Info;
OS_TASK* pTask;

OS_EnterRegion(); // Disable scheduling to make sure the task list does not change.
for (pTask = OS_Global.pTask; pTask; pTask = pTask->pNext) {
//
// Fill all elements with 0 to allow extending the structure
// in future version without breaking the code.
//
memset(&Info, 0, sizeof(Info));
//
// Fill elements with current task information
//
Info.TaskID = (U32)pTask;
Info.sName = pTask->Name;
Info.Prio = pTask->Priority;
Info.StackBase = (U32)pTask->pStackBot;
Info.StackSize = pTask->StackSize;
//

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

124 CHAPTER 6 Integrating SEGGER SystemView into an OS

// Record current task information

//
SEGGER_SYSVIEW_SendTaskInfo(&Info);
}
OS_LeaveRegion(); // Enable scheduling again.
}

6.1.4 Recording OS API calls

In addition to the OS core instrumentation, SystemView can record OS API calls which are
done from the application. API functions can be instrumented like the OS core.
Recording API events with SystemView can be done with the ready-to-use SEG-
GER_SYSVIEW_RecordXXX() functions when passing simple parameters, or by using the ap-
propriate SEGGER_SYSVIEW_EncodeXXX() functions to create a SystemView event and call-
ing SEGGER_SYSVIEW_SendPacket() to record it.

Example

/*********************************************************************
*
* OS_malloc()
*
* Function description
* API function to allocate memory on the heap.
*/
void OS_malloc(unsigned Size) {
SEGGER_SYSVIEW_RecordU32(ID_OS_MALLOC, // Id of OS_malloc (>= 32)
Size // First parameter
);

[OS specific code...]

}

To record how long the execution of an API function takes and to record its return value, the
return of an API function can be instrumented, too by calling SEGGER_SYSVIEW_RecordEnd-
Call to only record the return or SEGGER_SYSVIEW_RecordEndCallReturnValue to record
the return and its return value.

6.1.5 OS description file

In order for SystemView to properly decode API calls it requires a description file to be
present in the /description/ directory of SystemView. The name of the file has to be
SYSVIEW_<OSName>.txt where <OSName> is the name as sent in the system description.

6.1.5.1 API Function description

A description file includes all API functions which can be recorded by the OS. Each line in
the file is one function in the following format:

<EventID> <FunctionName> <ParameterDescription> | <ReturnValueDescription>

<EventId> is the Id which is recorded for the API function. It can be in the range of 32
to 511.
<FunctionName> is the name of the API function, displayed in the Event column of Sys-
temView. It may not contain spaces.
<ParameterDescription> is the description string of the parameters which are recorded
with the API function.
<ReturnValueDescription> is the description string of the return value which can be
recorded with SystemView. The ReturnValueDescription is optional.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

125 CHAPTER 6 Integrating SEGGER SystemView into an OS

The parameter display can be configured by a set of modifiers:

• %b - Display parameter as binary.
• %B - Display parameter as hexadecimal string (e.g. 00 AA FF …).
• %d - Display parameter as signed decimal integer.
• %D - Display parameter as time value.
• %I - Display parameter as a resource name if the resource id is known to SystemView.
• %p - Display parameter as 4 byte hexadecimal integer (e.g. 0xAABBCCDD).
• %s - Display parameter as string.
• %t - Display parameter as a task name if the task id is known to SystemView.
• %u - Display parameter as unsigned decimal integer.
• %x - Display parameter as hexadecimal integer.

Example
The following example shows a part of SYSVIEW_embOS.txt

35 OS_CheckTimer pGlobal=%p
42 OS_Delay Delay=%u
43 OS_DelayUntil Time=%u
44 OS_setPriority Task=%t Pri=%u
45 OS_WakeTask Task=%t
46 OS_CreateTask Task=%t Pri=%u Stack=%p Size=%u

In addition to the default modifiers the description file can define NamedTypes to map nu-
merical values to strings, which can for example be useful to display the textual value of
enums or error codes.
NamedTypes have following format:

NamedType <TypeName> <Key>=<Value> [<Key1>=<Value1> ...]

NamedTypes can be used in the ParameterDescription and the ReturnValueDescription.

Example

#
# Types for parameter formatters
#
NamedType OSErr 0=OS_ERR_NONE
NamedType OSErr 10000=OS_ERR_A 10001=OS_ERR_ACCEPT_ISR
NamedType OSErr 12000=OS_ERR_C 12001=OS_ERR_CREATE_ISR
NamedType OSErr 13000=OS_ERR_D 13001=OS_ERR_DEL_ISR

NamedType OSFlag 0=FLAG_NONE 1=FLAG_READ 2=FLAG_WRITE 3=FLAG_READ_WRITE

#
# API Functions
#
34 OSFunc Param=%OSFlag | Returns %OSErr

6.1.5.2 Task State description

When a task pauses execution its state is recorded in the SystemView event.
This task state can be converted to a textual representation in SystemView with the TaskS-
tate desctiption.
TaskState has following format:

TaskState <Mask> <Key>=<Value>, [<Key1>=<Value1>, ...]

Example

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

126 CHAPTER 6 Integrating SEGGER SystemView into an OS

# Task States
#
TaskState 0xFF 0=Ready, 1=Delayed or Timeout, 2=Pending, 3=Pending with Timeout,
4=Suspended, 5=Suspended with Timeout, 6=Suspended and Pending, 7=Suspended and
Pending with Timeout, 255=Deleted

6.1.5.3 Option description

OS-Specific options can also be set in the description file to configure SystemView.
Currently available options to be inserted in the description files are:
Option ReversePriority: Higher task priority value equals lower task priority.

6.1.6 OS integration sample

The code below shows where to integrate SystemView in an OS based on pseudo-code
snippets and can be used as reference.

/*********************************************************************
* (c) 1995 - 2018 SEGGER Microcontroller GmbH *
* The Embedded Experts *
* www.segger.com *
**********************************************************************
-------------------------- END-OF-HEADER -----------------------------

Purpose : Pseudo-code OS with SEGGER SystemView integration.

*/

/*********************************************************************
*
* OS_CreateTask()
*
* Function description
* Create a new task and add it to the system.
*/
void OS_CreateTask(TaskFunc* pF, unsigned Prio, const char* sName, void* pStack) {
SEGGER_SYSVIEW_TASKINFO Info;
OS_TASK* pTask; // Pseudo struct to be replaced

[OS specific code ...]

SEGGER_SYSVIEW_OnTaskCreate((unsigned)pTask);
memset(&Info, 0, sizeof(Info));
//
// Fill elements with current task information
//
Info.TaskID = (U32)pTask;
Info.sName = pTask->Name;
Info.Prio = pTask->Priority;
Info.StackBase = (U32)pTask->pStack;
Info.StackSize = pTask->StackSize;
SEGGER_SYSVIEW_SendTaskInfo(&Info);
}

/*********************************************************************
*
* OS_TerminateTask()
*
* Function description
* Terminate a task and remove it from the system.
*/
void OS_TerminateTask(void) {

[OS specific code ...]

SEGGER_SYSVIEW_OnTaskStopExec();

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

127 CHAPTER 6 Integrating SEGGER SystemView into an OS

/*********************************************************************
*
* OS_Delay()
*
* Function description
* Delay and suspend a task for the given time.
*/
void OS_Delay(unsigned NumTicks) {

[OS specific code ...]

SEGGER_SYSVIEW_OnTaskStopReady(OS_Global.pCurrentTask, OS_CAUSE_WAITING);
}

/*********************************************************************
*
* OS_HandleTick()
*
* Function description
* OS System Tick handler.
*/
int OS_HandleTick(void) {
int TaskReady = 0; // Pseudo variable indicating a task is ready

[OS specific code ...]

if (TaskReady) {
SEGGER_SYSVIEW_OnTaskStartReady((unsigned)pTask);
}
}

/*********************************************************************
*
* OS_Switch()
*
* Function description
* Switch to the next ready task or go to idle.
*/
void OS_Switch(void) {

[OS specific code ...]

//
// If a task is activated
//
SEGGER_SYSVIEW_OnTaskStartExec((unsigned)pTask);
//
// Else no task activated, go into idle state
//
SEGGER_SYSVIEW_OnIdle()
}

/*********************************************************************
*
* OS_EnterInterrupt()
*
* Function description
* Inform the OS about start of interrupt execution.
*/
void OS_EnterInterrupt(void) {

[OS specific code ...]

SEGGER_SYSVIEW_RecordEnterISR();
}

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

128 CHAPTER 6 Integrating SEGGER SystemView into an OS

/*********************************************************************
*
* OS_ExitInterrupt()
*
* Function description
* Inform the OS about end of interrupt execution and switch to
* Scheduler if necessary.
*/
void OS_ExitInterrupt(void) {

[OS specific code ...]

//
// If the interrupt will switch to the Scheduler
//
SEGGER_SYSVIEW_RecordExitISRToScheduler();
//
// Otherwise
//
SEGGER_SYSVIEW_RecordExitISR();
}

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

129 CHAPTER 6 Integrating SEGGER SystemView into a
middleware module

6.2 Integrating SEGGER SystemView into a

middleware module
SEGGER SystemView can also be integrated into middleware modules or even applica-
tion modules to get information about execution of these modules, like API calls or inter-
rupt-triggered events. This integration is for example used in SEGGER embOS/IP to monitor
sending and receiving packets via IP and SEGGER emFile to record API calls.
For integration into other modules, contact your distributor or do the integration following
the instructions in this section.

6.2.1 Registering the module

To be able to record middleware module events, the module has to register at SystemView
via SEGGER_SYSVIEW_RegisterModule().
The module passes a SEGGER_SYSVIEW_MODULE struct pointer, which contains information
about the module and receives the event offset for the event Ids the module can generate.
sDescription and NumEvents have to be set in the SEGGER_SYSVIEW_MODULE struct when
registering. Optionally pfSendModuleDesc can be set, too.
Upon return of SEGGER_SYSVIEW_RegisterModule(), EventOffset of the SEG-
GER_SYSVIEW_MODULE struct is set to the lowest event Id the module may generate, and
pNext is set to point to the next registered module to create a linked list. Because of this, the
SEGGER_SYSVIEW_MODULE struct has to be writeable and may not be allocated on the stack.

SEGGER_SYSVIEW_MODULE

struct SEGGER_SYSVIEW_MODULE {
const char* sModule;
U32 NumEvents;
U32 EventOffset;
void (*pfSendModuleDesc)(void);
SEGGER_SYSVIEW_MODULE* pNext;
};

Parameters
Parameter Description
Pointer to a string containing the module name and optional-
sModule
ly the module event description.
NumEvents Number of events the module wants to register.
Offset to be added to the event Ids. Out parameter, set by
EventOffset
this function. Do not modify after calling this function.
Callback function pointer to send more detailed module de-
pfSendModuleDesc
scription to SystemView.
Pointer to next registered module. Out parameter, set by
pNext
this function. Do not modify after calling this function.

Example

SEGGER_SYSVIEW_MODULE IPModule = {
"M=embOSIP, " \
"0 SendPacket IFace=%u NumBytes=%u, " \
"1 ReceivePacket Iface=%d NumBytes=%u", // sModule
2, // NumEvents
0,
// EventOffset, Set by SEGGER_SYSVIEW_RegisterModule()
NULL,
// pfSendModuleDesc, NULL: No additional module description

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

130 CHAPTER 6 Integrating SEGGER SystemView into a
middleware module
NULL,
// pNext, Set by SEGGER_SYSVIEW_RegisterModule()
};

static void _IPTraceConfig(void) {

//
// Register embOS/IP at SystemView.
// SystemView has to be initialized before.
//
SEGGER_SYSVIEW_RegisterModule(&IPModule);
}

6.2.2 Recording module activity

In order to be able to record module activity, the module has to be instrumented to generate
SystemView events in the appropriate functions.
Instrumenting a module can be done by integrating the SystemView functions directly,
via configurable macro functions or with an API structure which can be filled and set by
SystemView.
Recording events with SystemView can be done with the ready-to-use SEG-
GER_SYSVIEW_RecordXXX() functions when passing simple parameters, or by using the ap-
propriate SEGGER_SYSVIEW_EncodeXXX() functions to create a SystemView event and call-
ing SEGGER_SYSVIEW_SendPacket() to record it.

Example

int SendPacket(IP_PACKET *pPacket) {

//
// The IP stack sends a packet.
// Record it according to the module description of SendPacket.
//
SEGGER_SYSVIEW_RecordU32x2(
// Id of SendPacket (0) + Offset for the registered module
ID_SENDPACKET + IPModule.EventOffset,
// First parameter (displayed as event parameter IFace)
pPacket->Interface,
// Second parameter (displayed as event parameter NumBytes)
pPacket->NumBytes
);

[Module specific code...]

}

For more information refer to Recording OS API calls on page 124 and the API reference
on page 132.
As with OSes, the middleware module description can be made available in a description
file with the name of the module (Value of M=). Refer to OS description file on page 124.

6.2.3 Providing the module description

SEGGER_SYSVIEW_MODULE.sModule points to a string which contains the basic information
of the registered module, which is a comma-separated list and can contain following items:

Item Identifier Example

Module name M “M=embOSIP”

Module token T “T=IP”
Description S “S=’embOS/IP V12.09’”
<ID> <Event> <Parame- “0 SendPacket IFace=%u
Module event
ter> NumBytes=%u”

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

131 CHAPTER 6 Integrating SEGGER SystemView into a
middleware module

The string length may not exceed SEGGER_SYSVIEW_MAX_STRING_LEN which is 128 by de-
fault.
To send additional description strings and to send the name of resources which are used
and recorded by the module, SEGGER_SYSVIEW_MODULE.pfSendModuleDesc can be set when
registering the module.
SEGGER_SYSVIEW_MODULE.pfSendModuleDesc is called periodically when SystemView
is connected. It can call SEGGER_SYSVIEW_RecordModuleDescription() and SEG-
GER_SYSVIEW_NameResource().

Example

static void _cbSendIPModuleDesc(void) {

SEGGER_SYSVIEW_NameResource((U32)&(RxPacketFifo), "Rx FIFO");
SEGGER_SYSVIEW_NameResource((U32)&(TxPacketFifo), "Tx FIFO");
SEGGER_SYSVIEW_RecordModuleDescription(&IPModule, "T=IP, S='embOS/IP V12.09'");
}

SEGGER_SYSVIEW_MODULE IPModule = {
"M=embOSIP, " \
"0 SendPacket IFace=%u NumBytes=%u, " \
"1 ReceivePacket Iface=%d NumBytes=%u", // sModule
2, // NumEvents
0, // EventOffset, Set by RegisterModule()
_cbSendIPModuleDesc, // pfSendModuleDesc
NULL, // pNext, Set by RegisterModule()
};

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

 Chapter 7

API reference

This section describes the public API of SEGGER SystemView.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

133 CHAPTER 7 Formatted output control strings

7.1 Formatted output control strings

The functions in this section that accept a formatted output control string do so according
to the specification that follows for target formatting.

7.1.1 Composition
The format is composed of zero or more directives: ordinary characters (not %, which are
copied unchanged to the output stream; and conversion specifications, each of which results
in fetching zero or more subsequent arguments, converting them, if applicable, according
to the corresponding conversion specifier, and then writing the result to the output stream.
Each conversion specification is introduced by the character %. After the % the following
appear in sequence:
• Zero or more flags (in any order) that modify the meaning of the conversion
specification.
• An optional minimum field width. If the converted value has fewer characters than
the field width, it is padded with spaces (by default) on the left (or right, if the left
adjustment flag has been given) to the field width. The field width takes the form of
an asterisk * or a decimal integer.
• An optional precision that gives the minimum number of digits to appear for the d, u,
x, and X conversions. The precision takes the form of a period . followed an optional
decimal integer; if only the period is specified, the precision is taken as zero. If a
precision appears with any other conversion specifier, the behavior is undefined.
• A conversion specifier character that specifies the type of conversion to be applied.

7.1.2 Flag characters

The flag characters and their meanings are:

Flag Description
The result of the conversion is left-justified within the field. The de-
- fault, if this flag is not specified, is that the result of the conversion is
left-justified within the field.
The result of a signed conversion always begins with a plus or minus
+ sign. The default, if this flag is not specified, is that it begins with a
sign only when a negative value is converted.
For d, u, x, and X, leading zeros (following any indication of sign or
base) are used to pad to the field width rather than performing space
0 padding. If the 0 and - flags both appear, the 0 flag is ignored. For
d, u, x, and X conversions, if a precision is specified, the 0 flag is ig-
nored. For other conversions, the behavior is undefined.

7.1.3 Length modifiers

The length modifiers h and l are both ignored.

7.1.4 Conversion specifiers

The conversion specifiers and their meanings are:

Flag Description
The argument is converted to signed decimal in the style [-]dddd.
The precision specifies the minimum number of digits to appear; if
d the value being converted can be represented in fewer digits, it is ex-
panded with leading spaces. The default precision is one. The result
of converting a zero value with a precision of zero is no characters.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

134 CHAPTER 7 Formatted output control strings

Flag Description
The unsigned argument is converted to unsigned octal for o, unsigned
decimal for u, or unsigned hexadecimal notation for x or X in the style
dddd the letters abcdef are used for x conversion and the letters
ABCDEF for X conversion. The precision specifies the minimum number
u, x, X
of digits to appear; if the value being converted can be represented in
fewer digits, it is expanded with leading spaces. The default precision
is one. The result of converting a zero value with a precision of zero is
no characters.
The argument is converted to an unsigned char, and the resulting
c
character is written.
s The s specifier is not supported.
The argument is a pointer to void. The value of the pointer is con-
p verted in the same format as the x conversion specifier with a fixed
precision of 2*sizeof(void *).
% A % character is written. No argument is converted.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

135 CHAPTER 7 Control functions

7.2 Control functions

Control functions to be called by the application.

Function Description
SEGGER_SYSVIEW_Init() Initializes the SYSVIEW module.
SEGGER_SYSVIEW_Start() Start recording SystemView events.
SEGGER_SYSVIEW_Stop() Stop recording SystemView events.
Handle incoming packets if any and check
SEGGER_SYSVIEW_IsStarted()
if recording is started.
Enable standard SystemView events to be
SEGGER_SYSVIEW_EnableEvents()
generated.
Disable standard SystemView events to
SEGGER_SYSVIEW_DisableEvents()
not be generated.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

136 CHAPTER 7 Control functions

7.2.1 SEGGER_SYSVIEW_Init()
Description
Initializes the SYSVIEW module. Must be called before the SystemView Application connects
to the system.

Prototype
void SEGGER_SYSVIEW_Init( U32 SysFreq,
U32 CPUFreq,
const SEGGER_SYSVIEW_OS_API * pOSAPI,
SEGGER_SYSVIEW_SEND_SYS_DESC_FUNC pfSendSysDesc);

Parameters
Parameter Description
SysFreq Frequency of timestamp, usually CPU core clock frequency.
CPUFreq CPU core clock frequency.
pOSAPI Pointer to the API structure for OS-specific functions.
pfSendSysDesc Pointer to record system description callback function.

Additional information
This function initializes the RTT channel used to transport SEGGER SystemView packets.
The channel is assigned the label “SysView” for client software to identify the SystemView
channel.
The channel is configured with the macro SEGGER_SYSVIEW_RTT_CHANNEL.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

137 CHAPTER 7 Control functions

7.2.2 SEGGER_SYSVIEW_Start()
Description
Start recording SystemView events.
This function is triggered by the SystemView Application on connect. For single-shot or
post-mortem mode recording, it needs to be called by the application.

Prototype
void SEGGER_SYSVIEW_Start(void);

Additional information
This function enables transmission of SystemView packets recorded by subsequent trace
calls and records a SystemView Start event.
As part of start, a SystemView Init packet is sent, containing the system frequency. The
list of current tasks, the current system time and the system description string is sent, too.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

138 CHAPTER 7 Control functions

7.2.3 SEGGER_SYSVIEW_Stop()
Description
Stop recording SystemView events.
This function is triggered by the SystemView Application on disconnect. For single-shot or
postmortem mode recording, it can be called by the application.

Prototype
void SEGGER_SYSVIEW_Stop(void);

Additional information
This function disables transmission of SystemView packets recorded by subsequent trace
calls. If transmission is enabled when this function is called, a single SystemView Stop
event is recorded to the trace, send, and then trace transmission is halted.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

139 CHAPTER 7 Control functions

7.2.4 SEGGER_SYSVIEW_IsStarted()
Description
Handle incoming packets if any and check if recording is started.

Prototype
int SEGGER_SYSVIEW_IsStarted(void);

Return value
0: Recording not started.
>0 Recording started.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

140 CHAPTER 7 Control functions

7.2.5 SEGGER_SYSVIEW_EnableEvents()
Description
Enable standard SystemView events to be generated.

Prototype
void SEGGER_SYSVIEW_EnableEvents(U32 EnableMask);

Parameters
Parameter Description
EnableMask Events to be enabled.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

141 CHAPTER 7 Control functions

7.2.6 SEGGER_SYSVIEW_DisableEvents()
Description
Disable standard SystemView events to not be generated.

Prototype
void SEGGER_SYSVIEW_DisableEvents(U32 DisableMask);

Parameters
Parameter Description
DisableMask Events to be disabled.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

142 CHAPTER 7 Configuration functions

7.3 Configuration functions

Configuration functions to be called by the application system. Usually included in the sys-
tem callback functions.

Function Description
Sets the RAM base address, which is sub-
SEGGER_SYSVIEW_SetRAMBase() tracted from IDs in order to save band-
width.
SEGGER_SYSVIEW_SendTaskList() Send all tasks descriptors to the host.
Send a Task Info Packet, containing TaskId
SEGGER_SYSVIEW_SendTaskInfo() for identification, task priority and task
name.
Send the system description string to the
SEGGER_SYSVIEW_SendSysDesc()
host.
SEGGER_SYSVIEW_SendPacket() Send an event packet.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

143 CHAPTER 7 Configuration functions

7.3.1 SEGGER_SYSVIEW_SetRAMBase()
Description
Sets the RAM base address, which is subtracted from IDs in order to save bandwidth.

Prototype
void SEGGER_SYSVIEW_SetRAMBase(U32 RAMBaseAddress);

Parameters
Parameter Description
RAMBaseAddress Lowest RAM Address. (i.e. 0x20000000 on most Cortex-M)

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

144 CHAPTER 7 Configuration functions

7.3.2 SEGGER_SYSVIEW_SendTaskInfo()
Description
Send a Task Info Packet, containing TaskId for identification, task priority and task name.

Prototype
void SEGGER_SYSVIEW_SendTaskInfo(const SEGGER_SYSVIEW_TASKINFO * pInfo);

Parameters
Parameter Description
pInfo Pointer to task information to send.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

145 CHAPTER 7 Configuration functions

7.3.3 SEGGER_SYSVIEW_SendTaskList()
Description
Send all tasks descriptors to the host.

Prototype
void SEGGER_SYSVIEW_SendTaskList(void);

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

146 CHAPTER 7 Configuration functions

7.3.4 SEGGER_SYSVIEW_SendSysDesc()
Description
Send the system description string to the host. The system description is used by the
SystemView Application to identify the current application and handle events accordingly.
The system description is usually called by the system description callback, to ensure it is
only sent when the SystemView Application is connected.

Prototype
void SEGGER_SYSVIEW_SendSysDesc(const char * sSysDesc);

Parameters
Parameter Description
sSysDesc Pointer to the 0-terminated system description string.

Additional information
One system description string may not exceed SEGGER_SYSVIEW_MAX_STRING_LEN charac-
ters. Multiple description strings can be recorded.
The Following items can be described in a system description string. Each item is identified
by its identifier, followed by ’=’ and the value. Items are separated by ’,’.

Item Identifier Example

Application name N “N=Test Application”

Operating system O “O=embOS”
Additional module M “M=embOS/IP”
Target device D “D=MK66FN2M0xxx18”
Target core C “C=Cortex-M4”
Interrupt I#<InterruptID> “I#15=SysTick”

Example strings
• N=Test Application,O=embOS,D=MK66FN2M0xxx18
• I#15=SysTick,I#99=ETH_Tx,I#100=ETH_Rx

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

147 CHAPTER 7 Configuration functions

7.3.5 SEGGER_SYSVIEW_SendModule()
Description
Sends the information of a registered module to the host.

Prototype
void SEGGER_SYSVIEW_SendModule(U8 ModuleId);

Parameters
Parameter Description
ModuleId Id of the requested module.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

148 CHAPTER 7 Configuration functions

7.3.6 SEGGER_SYSVIEW_SendModuleDescription()
Description
Triggers a send of the registered module descriptions.

Prototype
void SEGGER_SYSVIEW_SendModuleDescription(void);

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

149 CHAPTER 7 Configuration functions

7.3.7 SEGGER_SYSVIEW_SendNumModules()
Description
Send the number of registered modules to the host.

Prototype
void SEGGER_SYSVIEW_SendNumModules(void);

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

150 CHAPTER 7 Application-level event recording functions

7.4 Application-level event recording functions

User event recording functions to be called in the user application.

Function Description
Markers
Record a Performance Marker Start event
SEGGER_SYSVIEW_MarkStart()
to start measuring runtime.
Record a Performance Marker intermediate
SEGGER_SYSVIEW_Mark()
event.
Record a Performance Marker Stop event
SEGGER_SYSVIEW_MarkStop()
to stop measuring runtime.
Resources
Send the name of a resource to be dis-
SEGGER_SYSVIEW_NameResource()
played in SystemView.
Plain output functions
SEGGER_SYSVIEW_Print() Print a string to the host.
SEGGER_SYSVIEW_Warn() Print a warning string to the host.
SEGGER_SYSVIEW_Error() Print an error string to the host.
Host-based formatting
Print a string which is formatted on the
SEGGER_SYSVIEW_PrintfHost()
host by the SystemView Application.
Print a string which is formatted on the
SEGGER_SYSVIEW_PrintfHostEx() host by the SystemView Application with
Additional information.
Print a warning string which is formatted
SEGGER_SYSVIEW_WarnfHost() on the host by the SystemView Applica-
tion.
Print an error string which is formatted on
SEGGER_SYSVIEW_ErrorfHost()
the host by the SystemView Application.
Target-based formatting
Print a string which is formatted on the
SEGGER_SYSVIEW_PrintfTarget()
target before sent to the host.
Print a string which is formatted on the
SEGGER_SYSVIEW_PrintfTargetEx() target before sent to the host with Addi-
tional information.
Print a warning string which is formatted
SEGGER_SYSVIEW_WarnfTarget()
on the target before sent to the host.
Print an error string which is formatted on
SEGGER_SYSVIEW_ErrorfTarget()
the target before sent to the host.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

151 CHAPTER 7 Application-level event recording functions

7.4.1 SEGGER_SYSVIEW_MarkStart()
Description
Record a Performance Marker Start event to start measuring runtime.

Prototype
void SEGGER_SYSVIEW_MarkStart(unsigned MarkerId);

Parameters
Parameter Description
MarkerId User defined ID for the marker.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

152 CHAPTER 7 Application-level event recording functions

7.4.2 SEGGER_SYSVIEW_Mark()
Description
Record a Performance Marker intermediate event.

Prototype
void SEGGER_SYSVIEW_Mark(unsigned int MarkerId);

Parameters
Parameter Description
MarkerId User defined ID for the marker.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

153 CHAPTER 7 Application-level event recording functions

7.4.3 SEGGER_SYSVIEW_MarkStop()
Description
Record a Performance Marker Stop event to stop measuring runtime.

Prototype
void SEGGER_SYSVIEW_MarkStop(unsigned MarkerId);

Parameters
Parameter Description
MarkerId User defined ID for the marker.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

154 CHAPTER 7 Application-level event recording functions

7.4.4 SEGGER_SYSVIEW_NameMarker()
Description
Send the name of a Performance Marker to be displayed in SystemView.
Marker names are usually set in the system description callback, to ensure it is only sent
when the SystemView Application is connected.

Prototype
void SEGGER_SYSVIEW_NameMarker( unsigned int MarkerId,
const char * sName);

Parameters
Parameter Description
MarkerId User defined ID for the marker.
Pointer to the marker name. (Max. SEG-
sName
GER_SYSVIEW_MAX_STRING_LEN Bytes)

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

155 CHAPTER 7 Application-level event recording functions

7.4.5 SEGGER_SYSVIEW_NameResource()
Description
Send the name of a resource to be displayed in SystemView.
Marker names are usually set in the system description callback, to ensure it is only sent
when the SystemView Application is connected.

Prototype
void SEGGER_SYSVIEW_NameResource( U32 ResourceId,
const char * sName);

Parameters
Parameter Description
ResourceId Id of the resource to be named. i.e. its address.
Pointer to the resource name. (Max. SEG-
sName
GER_SYSVIEW_MAX_STRING_LEN Bytes)

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

156 CHAPTER 7 Application-level event recording functions

7.4.6 SEGGER_SYSVIEW_Print()
Description
Print a string to the host.

Prototype
void SEGGER_SYSVIEW_Print(const char * s);

Parameters
Parameter Description
s String to sent.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

157 CHAPTER 7 Application-level event recording functions

7.4.7 SEGGER_SYSVIEW_PrintfHost()
Description
Print a string which is formatted on the host by the SystemView Application.

Prototype
void SEGGER_SYSVIEW_PrintfHost(const char * s,
...);

Parameters
Parameter Description
s String to be formatted.

Additional information
All format arguments are treated as 32-bit scalar values.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

158 CHAPTER 7 Application-level event recording functions

7.4.8 SEGGER_SYSVIEW_PrintfHostEx()
Description
Print a string which is formatted on the host by the SystemView Application with Additional
information.

Prototype
void SEGGER_SYSVIEW_PrintfHostEx(const char * s,
U32 Options,
...);

Parameters
Parameter Description
s String to be formatted.
Options Options for the string. i.e. Log level.

Additional information
All format arguments are treated as 32-bit scalar values.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

159 CHAPTER 7 Application-level event recording functions

7.4.9 SEGGER_SYSVIEW_PrintfTarget()
Description
Print a string which is formatted on the target before sent to the host.

Prototype
void SEGGER_SYSVIEW_PrintfTarget(const char * s,
...);

Parameters
Parameter Description
s String to be formatted.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

160 CHAPTER 7 Application-level event recording functions

7.4.10 SEGGER_SYSVIEW_PrintfTargetEx()
Description
Print a string which is formatted on the target before sent to the host with Additional
information.

Prototype
void SEGGER_SYSVIEW_PrintfTargetEx(const char * s,
U32 Options,
...);

Parameters
Parameter Description
s String to be formatted.
Options Options for the string. i.e. Log level.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

161 CHAPTER 7 Application-level event recording functions

7.4.11 SEGGER_SYSVIEW_Warn()
Description
Print a warning string to the host.

Prototype
void SEGGER_SYSVIEW_Warn(const char * s);

Parameters
Parameter Description
s String to sent.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

162 CHAPTER 7 Application-level event recording functions

7.4.12 SEGGER_SYSVIEW_WarnfHost()
Description
Print a warning string which is formatted on the host by the SystemView Application.

Prototype
void SEGGER_SYSVIEW_WarnfHost(const char * s,
...);

Parameters
Parameter Description
s String to be formatted.

Additional information
All format arguments are treated as 32-bit scalar values.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

163 CHAPTER 7 Application-level event recording functions

7.4.13 SEGGER_SYSVIEW_WarnfTarget()
Description
Print a warning string which is formatted on the target before sent to the host.

Prototype
void SEGGER_SYSVIEW_WarnfTarget(const char * s,
...);

Parameters
Parameter Description
s String to be formatted.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

164 CHAPTER 7 Application-level event recording functions

7.4.14 SEGGER_SYSVIEW_Error()
Description
Print an error string to the host.

Prototype
void SEGGER_SYSVIEW_Error(const char * s);

Parameters
Parameter Description
s String to sent.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

165 CHAPTER 7 Application-level event recording functions

7.4.15 SEGGER_SYSVIEW_ErrorfHost()
Description
Print an error string which is formatted on the host by the SystemView Application.

Prototype
void SEGGER_SYSVIEW_ErrorfHost(const char * s,
...);

Parameters
Parameter Description
s String to be formatted.

Additional information
All format arguments are treated as 32-bit scalar values.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

166 CHAPTER 7 Application-level event recording functions

7.4.16 SEGGER_SYSVIEW_ErrorfTarget()
Description
Print an error string which is formatted on the target before sent to the host.

Prototype
void SEGGER_SYSVIEW_ErrorfTarget(const char * s,
...);

Parameters
Parameter Description
s String to be formatted.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

167 CHAPTER 7 Module and RTOS object functions

7.5 Module and RTOS object functions

Middleware module registration and configuration functions.

Function Description
Register a middleware module for record-
SEGGER_SYSVIEW_RegisterModule()
ing its events.
SEGGER_SYSVIEW_RecordModuleDescrip- Sends detailed information of a registered
tion() module to the host.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

168 CHAPTER 7 Module and RTOS object functions

7.5.1 SEGGER_SYSVIEW_RegisterModule()
Description
Register a middleware module for recording its events.

Prototype
void SEGGER_SYSVIEW_RegisterModule(SEGGER_SYSVIEW_MODULE * pModule);

Parameters
Parameter Description
pModule The middleware module information.

Additional information
SEGGER_SYSVIEW_MODULE elements: sDescription - Pointer to a string containing the module
name and optionally the module event description. NumEvents - Number of events the
module wants to register. EventOffset - Offset to be added to the event Ids. Out parameter,
set by this function. Do not modify after calling this function. pfSendModuleDesc - Callback
function pointer to send more detailed module description to SystemView Application. pNext
- Pointer to next registered module. Out parameter, set by this function. Do not modify
after calling this function.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

169 CHAPTER 7 Module and RTOS object functions

7.5.2 SEGGER_SYSVIEW_RecordModuleDescription()
Description
Sends detailed information of a registered module to the host.

Prototype
void SEGGER_SYSVIEW_RecordModuleDescription
(const SEGGER_SYSVIEW_MODULE * pModule,
const char * sDescription);

Parameters
Parameter Description
pModule Pointer to the described module.
sDescription Pointer to a description string.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

170 CHAPTER 7 Realtime event recording functions

7.6 Realtime event recording functions

OS-related event recording functions called by the OS instrumentation.

Function Description
High-level RTOS state recording
SEGGER_SYSVIEW_OnIdle() Record an Idle event.
SEGGER_SYSVIEW_OnTaskCreate() Record a Task Create event.
SEGGER_SYSVIEW_OnTaskStartExec() Record a Task Start Execution event.
SEGGER_SYSVIEW_OnTaskStartReady() Record a Task Start Ready event.
SEGGER_SYSVIEW_OnTaskStopExec() Record a Task Stop Execution event.
SEGGER_SYSVIEW_OnTaskStopReady() Record a Task Stop Ready event.
SEGGER_SYSVIEW_OnTaskTerminate() Record a Task termination event.
Low-level realtime recording
SEGGER_SYSVIEW_RecordEnterISR() Format and send an ISR entry event.
SEGGER_SYSVIEW_RecordExitISR() Format and send an ISR exit event.
SEGGER_SYSVIEW_RecordExitISRToSched- Format and send an ISR exit into sched-
uler() uler event.
SEGGER_SYSVIEW_RecordEnterTimer() Format and send a Timer entry event.
SEGGER_SYSVIEW_RecordExitTimer() Format and send a Timer exit event.
Formats and sends a SystemView Systime
SEGGER_SYSVIEW_RecordSystime() containing a single U64 or U32 parameter
payload.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

171 CHAPTER 7 Realtime event recording functions

7.6.1 SEGGER_SYSVIEW_OnIdle()
Description
Record an Idle event.

Prototype
void SEGGER_SYSVIEW_OnIdle(void);

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

172 CHAPTER 7 Realtime event recording functions

7.6.2 SEGGER_SYSVIEW_OnTaskCreate()
Description
Record a Task Create event. The Task Create event corresponds to creating a task in the OS.

Prototype
void SEGGER_SYSVIEW_OnTaskCreate(U32 TaskId);

Parameters
Parameter Description
TaskId Task ID of created task.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

173 CHAPTER 7 Realtime event recording functions

7.6.3 SEGGER_SYSVIEW_OnTaskStartExec()
Description
Record a Task Start Execution event. The Task Start event corresponds to when a task has
started to execute rather than when it is ready to execute.

Prototype
void SEGGER_SYSVIEW_OnTaskStartExec(U32 TaskId);

Parameters
Parameter Description
TaskId Task ID of task that started to execute.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

174 CHAPTER 7 Realtime event recording functions

7.6.4 SEGGER_SYSVIEW_OnTaskStartReady()
Description
Record a Task Start Ready event.

Prototype
void SEGGER_SYSVIEW_OnTaskStartReady(U32 TaskId);

Parameters
Parameter Description
TaskId Task ID of task that started to execute.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

175 CHAPTER 7 Realtime event recording functions

7.6.5 SEGGER_SYSVIEW_OnTaskStopExec()
Description
Record a Task Stop Execution event. The Task Stop event corresponds to when a task stops
executing and terminates.

Prototype
void SEGGER_SYSVIEW_OnTaskStopExec(void);

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

176 CHAPTER 7 Realtime event recording functions

7.6.6 SEGGER_SYSVIEW_OnTaskStopReady()
Description
Record a Task Stop Ready event.

Prototype
void SEGGER_SYSVIEW_OnTaskStopReady(U32 TaskId,
unsigned int Cause);

Parameters
Parameter Description
TaskId Task ID of task that completed execution.
Cause Reason for task to stop (i.e. Idle/Sleep)

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

177 CHAPTER 7 Realtime event recording functions

7.6.7 SEGGER_SYSVIEW_OnTaskTerminate()
Description
Record a Task termination event. The Task termination event corresponds to terminating a
task in the OS. If the TaskId is the currently active task, SEGGER_SYSVIEW_OnTaskStopExec
may be used, either.

Prototype
void SEGGER_SYSVIEW_OnTaskTerminate(U32 TaskId);

Parameters
Parameter Description
TaskId Task ID of terminated task.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

178 CHAPTER 7 Realtime event recording functions

7.6.8 SEGGER_SYSVIEW_RecordEnterISR()
Description
Format and send an ISR entry event.

Prototype
void SEGGER_SYSVIEW_RecordEnterISR(void);

Additional information
Example packets sent 02 0F 50 // ISR(15) Enter. Timestamp is 80 (0x50)

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

179 CHAPTER 7 Realtime event recording functions

7.6.9 SEGGER_SYSVIEW_RecordExitISR()
Description
Format and send an ISR exit event.

Prototype
void SEGGER_SYSVIEW_RecordExitISR(void);

Additional information
Format as follows: 03 <TimeStamp> // Max. packet len is 6
Example packets sent 03 20 // ISR Exit. Timestamp is 32 (0x20)

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

180 CHAPTER 7 Realtime event recording functions

7.6.10 SEGGER_SYSVIEW_RecordExitISRToScheduler()
Description
Format and send an ISR exit into scheduler event.

Prototype
void SEGGER_SYSVIEW_RecordExitISRToScheduler(void);

Additional information
Format as follows: 18 <TimeStamp> // Max. packet len is 6
Example packets sent 18 20 // ISR Exit to Scheduler. Timestamp is 32 (0x20)

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

181 CHAPTER 7 Realtime event recording functions

7.6.11 SEGGER_SYSVIEW_RecordEnterTimer()
Description
Format and send a Timer entry event.

Prototype
void SEGGER_SYSVIEW_RecordEnterTimer(U32 TimerId);

Parameters
Parameter Description
TimerId Id of the timer which starts.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

182 CHAPTER 7 Realtime event recording functions

7.6.12 SEGGER_SYSVIEW_RecordExitTimer()
Description
Format and send a Timer exit event.

Prototype
void SEGGER_SYSVIEW_RecordExitTimer(void);

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

183 CHAPTER 7 Realtime event recording functions

7.6.13 SEGGER_SYSVIEW_RecordSystime()
Description
Formats and sends a SystemView Systime containing a single U64 or U32 parameter pay-
load.

Prototype
void SEGGER_SYSVIEW_RecordSystime(void);

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

184 CHAPTER 7 Dynamic memory monitor functions

7.7 Dynamic memory monitor functions

These functions provide monitoring for system heaps and other dynamically-allocated ob-
jects.

Function Description
SEGGER_SYSVIEW_HeapDefine() Define heap.
SEGGER_SYSVIEW_HeapAlloc() Record a system-heap allocation event.
SEGGER_SYSVIEW_HeapAllocEx() Record a per-heap allocation event.
SEGGER_SYSVIEW_HeapFree() Record a heap deallocation event.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

185 CHAPTER 7 Dynamic memory monitor functions

7.7.1 SEGGER_SYSVIEW_HeapDefine()
Description
Define heap.

Prototype
void SEGGER_SYSVIEW_HeapDefine(void * pHeap,
void * pBase,
unsigned int HeapSize,
unsigned int MetadataSize);

Parameters
Parameter Description
pHeap Pointer to heap control structure.
pBase Pointer to managed heap memory.
HeapSize Size of managed heap memory in bytes.
MetadataSize Size of metadata associated with each heap allocation.

Additional information
SystemView can track allocations across multiple heaps.
HeapSize must be a multiple of the natural alignment unit of the target. This size is subject
to compression, controlled by the specific setting of SEGGER_SYSVIEW_ID_SHIFT.
MetadataSize defines the size of the per-allocation metadata. For many heap implementa-
tions, the metadata size is a multiple of the word size of the machine and typically contains
the size of the allocated block (used upon deallocation), optional pointers to the preceding
and/or following blocks, and optionally a tag identifying the owner of the block. Note that
MetadataSize is not compressed within the SystemView packet and is not required to be
a multiple of 1<<SEGGER_SYSVIEW_ID_SHIFT.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

186 CHAPTER 7 Dynamic memory monitor functions

7.7.2 SEGGER_SYSVIEW_HeapAlloc()
Description
Record a system-heap allocation event.

Prototype
void SEGGER_SYSVIEW_HeapAlloc(void * pHeap,
void * pUserData,
unsigned int UserDataLen);

Parameters
Parameter Description
pHeap Pointer to heap where allocation was made.
pUserData Pointer to allocated user data.
Size of block allocated to hold user data, excluding any
UserDataLen
metadata.

Additional information
The user data must be correctly aligned for the architecture, which typically requires that
the alignment is at least the alignment of a double or a long long. pUserData is, therefore,
compressed by shrinking as IDs are compressed, controlled by the specific setting of SEG-
GER_SYSVIEW_ID_SHIFT.
In the same way, UserDataLen must reflect the size of the allocated block, not the allocation
size requested by the application. This size is also subject to compression, controlled by
the specific setting of SEGGER_SYSVIEW_ID_SHIFT.
As an example, assume the allocator is running on a Cortex-M device with SEG-
GER_SYSVIEW_ID_SHIFT set to 2 (the word alignment of the device). If a user requests
an allocation of 5 bytes, a hypothetical heap allocator could allocate a block with size
32 bytes for this. The value of UserDataLen sent to SystemView for recording should be
32, not 5, and the 32 is compressed by shifting by two bits, the configured value of SEG-
GER_SYSVIEW_ID_SHIFT, and describes the number of bytes that are consumed from man-
aged memory from which SystemView can calculate accurate heap metrics.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

187 CHAPTER 7 Dynamic memory monitor functions

7.7.3 SEGGER_SYSVIEW_HeapAllocEx()
Description
Record a per-heap allocation event.

Prototype
void SEGGER_SYSVIEW_HeapAllocEx(void * pHeap,
void * pUserData,
unsigned int UserDataLen,
unsigned int Tag);

Parameters
Parameter Description
pHeap Pointer to heap where allocation was made.
pUserData Pointer to allocated user data.
Size of block allocated to hold user data, excluding any
UserDataLen
metadata.
Tag Block tag, typically used to identify the owner of the block.

Additional information
The user data must be correctly aligned for the architecture, which typically requires that
the alignment is at least the alignment of a double or a long long. pUserData is, therefore,
compressed by shrinking as IDs are compressed, controlled by the specific setting of SEG-
GER_SYSVIEW_ID_SHIFT.
In the same way, UserDataLen must reflect the size of the allocated block, not the allocation
size requested by the application. This size is also subject to compression, controlled by
the specific setting of SEGGER_SYSVIEW_ID_SHIFT.
As an example, assume the allocator is running on a Cortex-M device with SEG-
GER_SYSVIEW_ID_SHIFT set to 2 (the word alignment of the device). If a user requests
an allocation of 5 bytes, a hypothetical heap allocator could allocate a block with size
32 bytes for this. The value of UserDataLen sent to SystemView for recording should be
32, not 5, and the 32 is compressed by shifting by two bits, the configured value of SEG-
GER_SYSVIEW_ID_SHIFT, and describes the number of bytes that are consumed from man-
aged memory from which SystemView can calculate accurate heap metrics.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

188 CHAPTER 7 Dynamic memory monitor functions

7.7.4 SEGGER_SYSVIEW_HeapFree()
Description
Record a heap deallocation event.

Prototype
void SEGGER_SYSVIEW_HeapFree(void * pHeap,
void * pUserData);

Parameters
Parameter Description
pHeap Pointer to heap where allocation was made.
pUserData Pointer to allocated user data.

Additional information
SystemViews track allocations and knows the size of the allocated data.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

189 CHAPTER 7 High-level API instrumentation functions

7.8 High-level API instrumentation functions

Event recording functions called by OS and module instrumentation.

Function Description
API Function Call
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordVoid()
with an empty payload.
Formats and sends a SystemView pack-
SEGGER_SYSVIEW_RecordU32() et containing a single U32 parameter pay-
load.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordU32x2()
containing 2 U32 parameter payload.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordU32x3()
containing 3 U32 parameter payload.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordU32x4()
containing 4 U32 parameter payload.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordU32x5()
containing 5 U32 parameter payload.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordU32x6()
containing 6 U32 parameter payload.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordU32x7()
containing 7 U32 parameter payload.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordU32x8()
containing 8 U32 parameter payload.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordU32x9()
containing 9 U32 parameter payload.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordU32x10()
containing 10 U32 parameter payload.
Formats and sends a SystemView packet
SEGGER_SYSVIEW_RecordString()
containing a string.
API Function Return
Format and send an End API Call event
SEGGER_SYSVIEW_RecordEndCall()
without return value.
Format and send an End API Call event
SEGGER_SYSVIEW_RecordEndCallU32()
with return value.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

190 CHAPTER 7 High-level API instrumentation functions

7.8.1 SEGGER_SYSVIEW_RecordVoid()
Description
Formats and sends a SystemView packet with an empty payload.

Prototype
void SEGGER_SYSVIEW_RecordVoid(unsigned int EventID);

Parameters
Parameter Description
EventID SystemView event ID.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

191 CHAPTER 7 High-level API instrumentation functions

7.8.2 SEGGER_SYSVIEW_RecordU32()
Description
Formats and sends a SystemView packet containing a single U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32(unsigned int EventID,
U32 Value);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Value
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

192 CHAPTER 7 High-level API instrumentation functions

7.8.3 SEGGER_SYSVIEW_RecordU32x2()
Description
Formats and sends a SystemView packet containing 2 U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32x2(unsigned int EventID,
U32 Para0,
U32 Para1);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Para0
load.
The 32-bit parameter encoded to SystemView packet pay-
Para1
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

193 CHAPTER 7 High-level API instrumentation functions

7.8.4 SEGGER_SYSVIEW_RecordU32x3()
Description
Formats and sends a SystemView packet containing 3 U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32x3(unsigned int EventID,
U32 Para0,
U32 Para1,
U32 Para2);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Para0
load.
The 32-bit parameter encoded to SystemView packet pay-
Para1
load.
The 32-bit parameter encoded to SystemView packet pay-
Para2
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

194 CHAPTER 7 High-level API instrumentation functions

7.8.5 SEGGER_SYSVIEW_RecordU32x4()
Description
Formats and sends a SystemView packet containing 4 U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32x4(unsigned int EventID,
U32 Para0,
U32 Para1,
U32 Para2,
U32 Para3);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Para0
load.
The 32-bit parameter encoded to SystemView packet pay-
Para1
load.
The 32-bit parameter encoded to SystemView packet pay-
Para2
load.
The 32-bit parameter encoded to SystemView packet pay-
Para3
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

195 CHAPTER 7 High-level API instrumentation functions

7.8.6 SEGGER_SYSVIEW_RecordU32x5()
Description
Formats and sends a SystemView packet containing 5 U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32x5(unsigned int EventID,
U32 Para0,
U32 Para1,
U32 Para2,
U32 Para3,
U32 Para4);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Para0
load.
The 32-bit parameter encoded to SystemView packet pay-
Para1
load.
The 32-bit parameter encoded to SystemView packet pay-
Para2
load.
The 32-bit parameter encoded to SystemView packet pay-
Para3
load.
The 32-bit parameter encoded to SystemView packet pay-
Para4
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

196 CHAPTER 7 High-level API instrumentation functions

7.8.7 SEGGER_SYSVIEW_RecordU32x6()
Description
Formats and sends a SystemView packet containing 6 U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32x6(unsigned int EventID,
U32 Para0,
U32 Para1,
U32 Para2,
U32 Para3,
U32 Para4,
U32 Para5);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Para0
load.
The 32-bit parameter encoded to SystemView packet pay-
Para1
load.
The 32-bit parameter encoded to SystemView packet pay-
Para2
load.
The 32-bit parameter encoded to SystemView packet pay-
Para3
load.
The 32-bit parameter encoded to SystemView packet pay-
Para4
load.
The 32-bit parameter encoded to SystemView packet pay-
Para5
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

197 CHAPTER 7 High-level API instrumentation functions

7.8.8 SEGGER_SYSVIEW_RecordU32x7()
Description
Formats and sends a SystemView packet containing 7 U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32x7(unsigned int EventID,
U32 Para0,
U32 Para1,
U32 Para2,
U32 Para3,
U32 Para4,
U32 Para5,
U32 Para6);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Para0
load.
The 32-bit parameter encoded to SystemView packet pay-
Para1
load.
The 32-bit parameter encoded to SystemView packet pay-
Para2
load.
The 32-bit parameter encoded to SystemView packet pay-
Para3
load.
The 32-bit parameter encoded to SystemView packet pay-
Para4
load.
The 32-bit parameter encoded to SystemView packet pay-
Para5
load.
The 32-bit parameter encoded to SystemView packet pay-
Para6
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

198 CHAPTER 7 High-level API instrumentation functions

7.8.9 SEGGER_SYSVIEW_RecordU32x8()
Description
Formats and sends a SystemView packet containing 8 U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32x8(unsigned int EventID,
U32 Para0,
U32 Para1,
U32 Para2,
U32 Para3,
U32 Para4,
U32 Para5,
U32 Para6,
U32 Para7);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Para0
load.
The 32-bit parameter encoded to SystemView packet pay-
Para1
load.
The 32-bit parameter encoded to SystemView packet pay-
Para2
load.
The 32-bit parameter encoded to SystemView packet pay-
Para3
load.
The 32-bit parameter encoded to SystemView packet pay-
Para4
load.
The 32-bit parameter encoded to SystemView packet pay-
Para5
load.
The 32-bit parameter encoded to SystemView packet pay-
Para6
load.
The 32-bit parameter encoded to SystemView packet pay-
Para7
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

199 CHAPTER 7 High-level API instrumentation functions

7.8.10 SEGGER_SYSVIEW_RecordU32x9()
Description
Formats and sends a SystemView packet containing 9 U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32x9(unsigned int EventID,
U32 Para0,
U32 Para1,
U32 Para2,
U32 Para3,
U32 Para4,
U32 Para5,
U32 Para6,
U32 Para7,
U32 Para8);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Para0
load.
The 32-bit parameter encoded to SystemView packet pay-
Para1
load.
The 32-bit parameter encoded to SystemView packet pay-
Para2
load.
The 32-bit parameter encoded to SystemView packet pay-
Para3
load.
The 32-bit parameter encoded to SystemView packet pay-
Para4
load.
The 32-bit parameter encoded to SystemView packet pay-
Para5
load.
The 32-bit parameter encoded to SystemView packet pay-
Para6
load.
The 32-bit parameter encoded to SystemView packet pay-
Para7
load.
The 32-bit parameter encoded to SystemView packet pay-
Para8
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

200 CHAPTER 7 High-level API instrumentation functions

7.8.11 SEGGER_SYSVIEW_RecordU32x10()
Description
Formats and sends a SystemView packet containing 10 U32 parameter payload.

Prototype
void SEGGER_SYSVIEW_RecordU32x10(unsigned int EventID,
U32 Para0,
U32 Para1,
U32 Para2,
U32 Para3,
U32 Para4,
U32 Para5,
U32 Para6,
U32 Para7,
U32 Para8,
U32 Para9);

Parameters
Parameter Description
EventID SystemView event ID.
The 32-bit parameter encoded to SystemView packet pay-
Para0
load.
The 32-bit parameter encoded to SystemView packet pay-
Para1
load.
The 32-bit parameter encoded to SystemView packet pay-
Para2
load.
The 32-bit parameter encoded to SystemView packet pay-
Para3
load.
The 32-bit parameter encoded to SystemView packet pay-
Para4
load.
The 32-bit parameter encoded to SystemView packet pay-
Para5
load.
The 32-bit parameter encoded to SystemView packet pay-
Para6
load.
The 32-bit parameter encoded to SystemView packet pay-
Para7
load.
The 32-bit parameter encoded to SystemView packet pay-
Para8
load.
The 32-bit parameter encoded to SystemView packet pay-
Para9
load.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

201 CHAPTER 7 High-level API instrumentation functions

7.8.12 SEGGER_SYSVIEW_RecordString()
Description
Formats and sends a SystemView packet containing a string.

Prototype
void SEGGER_SYSVIEW_RecordString( unsigned int EventID,
const char * pString);

Parameters
Parameter Description
EventID SystemView event ID.
pString The string to be sent in the SystemView packet payload.

Additional information
The string is encoded as a count byte followed by the contents of the string. No more than
SEGGER_SYSVIEW_MAX_STRING_LEN bytes will be encoded to the payload.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

202 CHAPTER 7 High-level API instrumentation functions

7.8.13 SEGGER_SYSVIEW_RecordEndCall()
Description
Format and send an End API Call event without return value.

Prototype
void SEGGER_SYSVIEW_RecordEndCall(unsigned int EventID);

Parameters
Parameter Description
EventID Id of API function which ends.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

203 CHAPTER 7 High-level API instrumentation functions

7.8.14 SEGGER_SYSVIEW_RecordEndCallU32()
Description
Format and send an End API Call event with return value.

Prototype
void SEGGER_SYSVIEW_RecordEndCallU32(unsigned int EventID,
U32 Para0);

Parameters
Parameter Description
EventID Id of API function which ends.
Para0 Return value which will be returned by the API function.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

204 CHAPTER 7 Low-level event encoding functions

7.9 Low-level event encoding functions

Event-record building functions.

Function Description
SEGGER_SYSVIEW_EncodeU32() Encode a U32 in variable-length format.
Encode a byte buffer in variable-length for-
SEGGER_SYSVIEW_EncodeData()
mat.
SEGGER_SYSVIEW_EncodeString() Encode a string in variable-length format.
Encode a 32-bit Id in shrunken vari-
SEGGER_SYSVIEW_EncodeId()
able-length format.
Get the shrunken value of an Id
SEGGER_SYSVIEW_ShrinkId() for further processing like in SEG-
GER_SYSVIEW_NameResource().

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

205 CHAPTER 7 Low-level event encoding functions

7.9.1 SEGGER_SYSVIEW_EncodeU32()
Description
Encode a U32 in variable-length format.

Prototype
U8 *SEGGER_SYSVIEW_EncodeU32(U8 * pPayload,
U32 Value);

Parameters
Parameter Description
pPayload Pointer to where U32 will be encoded.
Value The 32-bit value to be encoded.

Return value
Pointer to the byte following the value, i.e. the first free byte in the payload and the next
position to store payload content.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

206 CHAPTER 7 Low-level event encoding functions

7.9.2 SEGGER_SYSVIEW_EncodeData()
Description
Encode a byte buffer in variable-length format.

Prototype
U8 *SEGGER_SYSVIEW_EncodeData( U8 * pPayload,
const char * pSrc,
unsigned int NumBytes);

Parameters
Parameter Description
pPayload Pointer to where string will be encoded.
pSrc Pointer to data buffer to be encoded.
NumBytes Number of bytes in the buffer to be encoded.

Return value
Pointer to the byte following the value, i.e. the first free byte in the payload and the next
position to store payload content.

Additional information
The data is encoded as a count byte followed by the contents of the data buffer. Make sure
NumBytes + 1 bytes are free for the payload.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

207 CHAPTER 7 Low-level event encoding functions

7.9.3 SEGGER_SYSVIEW_EncodeString()
Description
Encode a string in variable-length format.

Prototype
U8 *SEGGER_SYSVIEW_EncodeString( U8 * pPayload,
const char * s,
unsigned int MaxLen);

Parameters
Parameter Description
pPayload Pointer to where string will be encoded.
s String to encode.
MaxLen Maximum number of characters to encode from string.

Return value
Pointer to the byte following the value, i.e. the first free byte in the payload and the next
position to store payload content.

Additional information
The string is encoded as a count byte followed by the contents of the string. No more than
1 + MaxLen bytes will be encoded to the payload.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

208 CHAPTER 7 Low-level event encoding functions

7.9.4 SEGGER_SYSVIEW_EncodeId()
Description
Encode a 32-bit Id in shrunken variable-length format.

Prototype
U8 *SEGGER_SYSVIEW_EncodeId(U8 * pPayload,
U32 Id);

Parameters
Parameter Description
pPayload Pointer to where the Id will be encoded.
Id The 32-bit value to be encoded.

Return value
Pointer to the byte following the value, i.e. the first free byte in the payload and the next
position to store payload content.

Additional information
The parameters to shrink an Id can be configured in SEGGER_SYSVIEW_Conf.h and
via SEGGER_SYSVIEW_SetRAMBase(). SEGGER_SYSVIEW_ID_BASE: Lowest Id reported by
the application. (i.e. 0x20000000 when all Ids are an address in this RAM) SEG-
GER_SYSVIEW_ID_SHIFT: Number of bits to shift the Id to save bandwidth. (i.e. 2 when
Ids are 4 byte aligned)

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

209 CHAPTER 7 Low-level event encoding functions

7.9.5 SEGGER_SYSVIEW_ShrinkId()
Description
Get the shrunken value of an Id for further processing like in SEGGER_SYSVIEW_NameRe-
source().

Prototype
U32 SEGGER_SYSVIEW_ShrinkId(U32 Id);

Parameters
Parameter Description
Id The 32-bit value to be shrunken.

Return value
Shrunken Id.

Additional information
The parameters to shrink an Id can be configured in SEGGER_SYSVIEW_Conf.h and
via SEGGER_SYSVIEW_SetRAMBase(). SEGGER_SYSVIEW_ID_BASE: Lowest Id reported by
the application. (i.e. 0x20000000 when all Ids are an address in this RAM) SEG-
GER_SYSVIEW_ID_SHIFT: Number of bits to shift the Id to save bandwidth. (i.e. 2 when
Ids are 4 byte aligned)

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

210 CHAPTER 7 Low-level event encoding functions

7.9.6 SEGGER_SYSVIEW_SendPacket()
Description
Send an event packet.

Prototype
int SEGGER_SYSVIEW_SendPacket(U8 * pPacket,
U8 * pPayloadEnd,
unsigned int EventId);

Parameters
Parameter Description
pPacket Pointer to the start of the packet.
Pointer to the end of the payload. Make sure there are at
pPayloadEnd
least 5 bytes free after the payload.
EventId Id of the event packet.

Return value
≠0 Success, Message sent.
=0 Buffer full, Message *NOT* sent.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

211 CHAPTER 7 Application-provided functions

7.10 Application-provided functions

Application provided functions.

Function Description
SEGGER_SYSVIEW_Conf() Initialize and configures SystemView.
Callback called by SystemView to get the
SEGGER_SYSVIEW_X_GetTimestamp()
timestamp in cycles.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

212 CHAPTER 7 Application-provided functions

7.10.1 SEGGER_SYSVIEW_Conf()
Description
Can be used with OS integration to allow easier initialization of SystemView and the OS
SystemView interface.
This function is usually provided in the SEGGER_SYSVIEW_Config_<OS>.c configuration file
of the used OS.

Prototype

void SEGGER_SYSVIEW_Conf(void);

Example implementation

void SEGGER_SYSVIEW_Conf(void) {
//
// Initialize SystemView
//
SEGGER_SYSVIEW_Init(SYSVIEW_TIMESTAMP_FREQ, // Frequency of the timestamp.
SYSVIEW_CPU_FREQ, // Frequency of the system.
&SYSVIEW_X_OS_TraceAPI,
// OS-specific SEGGER_SYSVIEW_OS_API
_cbSendSystemDesc
// Callback for application-specific description
);
SEGGER_SYSVIEW_SetRAMBase(SYSVIEW_RAM_BASE);
// Explicitly set the RAM base address.
OS_SetTraceAPI(&embOS_TraceAPI_SYSVIEW);
// Configure embOS to use SystemView via the Trace-API.
}

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

213 CHAPTER 7 Application-provided functions

7.10.2 SEGGER_SYSVIEW_X_GetTimestamp()
Description
This function must be implemented when SEGGER_SYSVIEW_GET_TIMESTAMP() is configured
to call it. By default this is done on all non-Cortex-M3/4 targets.

Prototype

U32 SEGGER_SYSVIEW_X_GetTimestamp(void);

Return value
Returns the current system timestamp in timestamp cycles. On Cortex-M3 and Cortex-M4
this is the cycle counter.

Example implementation

U32 SEGGER_SYSVIEW_X_GetTimestamp(void) {
U32 TickCount;
U32 Cycles;
U32 CyclesPerTick;
//
// Get the cycles of the current system tick.
// SysTick is down-counting, subtract the current value from the number of cycles per tick.
//
CyclesPerTick = SYST_RVR + 1;
Cycles = (CyclesPerTick - SYST_CVR);
//
// Get the system tick count.
//
TickCount = SEGGER_SYSVIEW_TickCnt; // SEGGER_SYSVIEW_TickCnt is incremented by the system tick
//
// If a SysTick interrupt is pending increment the TickCount
//
if ((SCB_ICSR & SCB_ICSR_PENDSTSET_MASK) != 0) {
TickCount++;
}
Cycles += TickCount * CyclesPerTick;

return Cycles;
}

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

 Chapter 8

Performance and resource

usage

This chapter covers the performance and resource usage of SystemView. It contains infor-
mation about the memory requirements in typical systems which can be used to obtain
sufficient estimates for most target systems.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

215 CHAPTER 8 Memory requirements

8.1 Memory requirements

The memory requirements may differ, depending on the used OS integration, the target
configuration and the compiler optimizations.
To achieve a balanced result of performance and memory usage, it is recommended to set
the compiler optimization level for the SystemView and RTT module accordingly. Compiler
optimizations should always be switched on for the SystemView and RTT module - even
in Debug configuration builds.

8.1.1 ROM usage

The following table lists the ROM usage of SystemView by component. With a smart linker
only the used functions will be included in the application.

Description ROM
Minimum core code required when using SystemView ~920 Byte
Basic SystemView recording functions for application, OS and module
~380 Byte
events
OS-related SystemView recording functions ~360 Byte
Middleware module-related recording functions ~120 Byte
Complete SystemView Module ~1.8 KByte

The following table list the ROM usage of SystemView with different configurations.

Description Configuration ROM

SystemView Module Balanced optimization, no static buffer ~1.8 KByte
SystemView Module Balanced optimization, static buffer ~2.1 KByte
Balanced optimization, no static buffer,
SystemView Module ~1.4 KByte
post-mortem mode
Balanced optimization, static buffer, post-
SystemView Module ~1.7 KByte
mortem mode
RTT Module Balanced optimization ~0.5 KByte

8.1.2 Static RAM usage

The following table list the static RAM usage of SystemView with different configurations.

Description Configuration RAM

~70 Byte +
SystemView Module No static buffer
Channel Buffer
~280 Byte +
SystemView Module Static buffer
Channel Buffer
~60 Byte +
SystemView Module No static buffer, post-mortem mode
Channel Buffer
~180 Byte +
SystemView Module Static buffer, post-mortem mode
Channel Buffer
~30 Byte +
RTT Module
Channel Buffer

8.1.3 Stack RAM usage

SystemView requires stack to record events in every context, which might record events in
the application. This typically includes the system stack used by the scheduler, the interrupt
stack and the task stacks.

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

216 CHAPTER 8 Memory requirements

Since SystemView handles incoming requests for the system description and task informa-
tion, there must be enough free space on the stack to record an event and to send the
system description, which is recording another event.
SystemView can be configured to select between lower stack usage or less static RAM use.

Description Maximum Stack

Static buffer for event generation and encoding ~230 Bytes
Stack buffer for event generation and encoding ~510 Bytes
Static buffer for event generation and encoding, post-mortem mode ~150 Bytes
Stack buffer for event generation and encoding, post-mortem mode ~280 Bytes

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

 Chapter 9

Frequently asked questions

Q: Can I use the SystemView Application while I am debugging my application?

A: Yes. SystemView can run in parallel to a debugger and do continuous recording. To
make sure data can be read fast enough, configure the debugger connection to a high
interface speed (≥ 4 MHz).

Q: Can I do continuous recording without a J-Link?

A: No. Continuous recording requires the J-Link Real Time Transfer (RTT) technology to
automatically read the data from the target. Single-shot and post-mortem recording
can be done with any debug probe.

Q: Can I do continuous recording on Cortex-A, Cortex-R or ARM7, ARM9?

A: No. RTT requires memory access on the target while the target is running. If you have
one of these devices, only one-time recording can be done.

Q: I get overflow events when continuously recording. How can I prevent this?
A: Overflow events occur when the SystemVIew RTT buffer is full. This can happen for
following reasons:
• J-Link is kept busy by a debugger and cannot read the data fast enough.
• The target interface speed is too low to read the data fast enough.
• The application generates too many events to fit into the buffer.
To prevent this:
• Minimize the interactions of the debugger with J-Link while the target is running. (e.g.
disable live watches)
• Select a higher interface speed in all instances connected to J-Link. (e.g. the debugger
and SystemView)
• Choose a larger buffer for SystemView. (1 - 4 kByte)
• Run SystemView stand-alone without a debugger.

Q: SystemView cannot find the RTT Control Block, how can I configure it?
A: Auto-detection of the RTT Control Block can only be done in a known RAM address range
after it is initialized. Make sure the application startup has run when starting to record.
If the RTT Control Block is outside the known range for the selected device, either select
’Address’ and enter the exact address of the RTT Control Block or select ’Address Range’
and enter an address range in which the RTT Control Block will be.

Q: Do I have to select a Target Device to start recording?

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH

218 CHAPTER 9

A: Yes. J-Link must know which target device is connected. The drop-down lists the most
recently used devices. To select another device simply enter its name. A list of supported
devices can be found here.

Q: My question is not listed above. Where can I get more information?

A: For more information and help please ask your question in the SEGGER forum https://
forum.segger.com

SEGGER SystemView User Guide © 2015 - 2023 SEGGER Microcontroller GmbH