Home | Projects | Notes > ARM Cortex-M3/M4 Processor > Using printf() with Serial Wire Viewer (SWV)

Using `printf()` with Serial Wire Viewer (SWV)

Introduction

Serial Wire Viewer (SWV) is a data trace feature found on many ARM Cortex-M3, M4, M7, M23, and M33 processors. Coretx-M0 and Cortex-M0+ do not have SWV. The SWV frames can be sent out either the one pin SWO (Serial Wire Output) pin or the 4 bit Trace Port.
This notes explains using printf() over Serial Wire Output (SWO) pin of Serial Wire Debug (SWD) interface.

Serial Wire Debug (SWD)

Two-wire protocol for accessing the ARM debug interface
Part of the ARM Debug Interface Specification v5 and is an alternative to JTAG
The physical layer of SWD consists of two lines:
- SWDIO - A bidirectional data line that carries debug-related data (e.g., break point)
- SWCLK - A clock driven by the host (i.e., ST Link circuitry)
Both of these are managed by the ST Link circuitry on the board.
By using SWD interface you should be able to program MCUs internal flash, you can access memory regions, and break points, stop/run CPU.
Also, you can use the serial wire viewer for your printf() statements for debugging.

printf-using-serial-wire-viewer

Not all IDEs support capturing SWO pin. CubeIDE and TrueSTUDIO does!

Test

Copy and past the following code (implementation of ITM_SendChar()) into the syscall.c file of your project. (It goes right after the #includes.)


xxxxxxxxxx
28
1
/* syscalls.c */
2

3
// Implementation of printf like feature using ARM Cortex M3/M4/ ITM functionality.
4
// This function will not work for ARM Cortex M0/M0+.
5
// If you are using Cortex M0, then you can use semihosting feature of openOCD.
6

7
//Debug Exception and Monitor Control Register base address
8
#define DEMCR                   *((volatile uint32_t*) 0xE000EDFCU )
9

10
/* ITM register addresses */
11
#define ITM_STIMULUS_PORT0      *((volatile uint32_t*) 0xE0000000 )
12
#define ITM_TRACE_EN            *((volatile uint32_t*) 0xE0000E00 )
13

14
// Sends the message to the ITM registers
15
void ITM_SendChar(uint8_t ch)
16
{
17
    //Enable TRCENA
18
    DEMCR |= ( 1 << 24);
19

20
    //enable stimulus port 0
21
    ITM_TRACE_EN |= ( 1 << 0);
22

23
    // read FIFO status in bit [0]:
24
    while(!(ITM_STIMULUS_PORT0 & 1));
25

26
    //Write to ITM stimulus port0
27
    ITM_STIMULUS_PORT0 = ch;
28
}

Also, in the _write() system call, do the following modification:


xxxxxxxxxx
13
1
/* syscalls.c */
2

3
__attribute__((weak)) int _write(int file, char *ptr, int len)
4
{
5
    int DataIdx;
6

7
    for (DataIdx = 0; DataIdx < len; DataIdx++)
8
    {
9
        // __io_putchar(*ptr++); // commented out by Klee to implement printf like feature
10
        ITM_SendChar(*ptr++); // added this instead to use ITM feature
11
    }
12
    return len;
13
}

Don't forget to make this modification. I've spent hours to figure out why I couldn't see the printf() messages from the SWV ITM Data Consol.

Include <stdio.h> in your source file in which printf() will be used.

The way printf() works is as follows:


xxxxxxxxxx
2
1
/* your project */
2
printf();


xxxxxxxxxx
5
1
/* printf implementation in the standard library */
2
printf()
3
{
4
    __write();
5
}


xxxxxxxxxx
8
1
/* your project (in syscall.c) */
2
__write()
3
{
4
    ITM_SendChar();
5
    LCD_SendChar();     /* if using LCD */
6
    UART_SendChar();    /* if using UART */
7
    ...
8
}

To use printf() on the program for target board, set the Debug Configurations as follows:

When configuring the debugger settings to use printf() over SWO pin, you also need to set the system clock speed.
$\to$ Clock Configuration, and check the following: (In the following example, system's clock runs at 25 MHz)

Then also set the system clock speed to 25 MHz in the Debug Configuration window!
Debug as target application
$\to$ $\to$ SWV ITM Data Console
Click "Configure trace" and select the port 0
Now, click on the "Start trace" button and run the code.

SWD vs. JTAG

JTAG was the traditional mechanism for debug connections for ARM 7/9 family, but with the Cortex-M family, ARM introduced the Serial Wire Debug (SWD) interface.
SWD is designed to reduce the pin countr required for debug from 4 used by JTAG (excluding GND) down to 2.
In addition, SWD interface provides one more pin called Serial Wire Output (SWO) which is used for Single Wire Viewing (SWV), which is a loc cost tracing technology.

References