Технология Real Time Transfer (RTT) от SEGGER предназначена для мониторинга системы и интерактивного ввода/вывода пользователя во встраиваемых приложениях. RTT сочетает достоинства SWO и семихостинга с очень высоким быстродействием.

Примечание: незнакомые термины и сокращения см. в Словарике [7].

Основные возможности RTT:

• Двунаправленный обмен с приложением MCU.
• Очень высокая скорость передачи, без влияния на поведение приложения в реальном времени.
• Для обмена используется канал отладчика.
• Не требуется дополнительных выводов и дополнительной аппаратуры на стороне MCU.
• Поддерживается любой моделью отладчика J-Link.
• Поддерживается архитектурами ARM Cortex-M0/M0+/M1/M3/M4/M7/M23/M33 и Renesas RX100/200/600.
• Полная реализация кода, обеспечивающая функциональность и свободу.

[Что такое RTT]

С помощью RTT можно выводить информацию из целевого MCU, и также передавать данные в его приложение на очень высокой скорости, не влияя на поведение приложения, в реальном времени. SEGGER RTT может использоваться с любой моделью адаптера J-Link и любым поддерживаемым целевым MCU, который обеспечивает фоновый доступ к памяти (архтектуры Cortex-M и RX).

RTT поддерживает несколько каналов для передачи данных в обоих направлениях (от MCU в сторону хоста отладки и обратно). Эту возможность можно использовать для разных целей, предоставляя пользователю максимальную свободу действий.

Реализация по умолчанию использует один канал на направление, которые предназначены для печатающего ввода и вывода терминала. Утилита J-Link RTT Viewer может использовать этот канал для организации нескольких "виртуальных" терминалов, что позволяет печатать в несколько окон. Например, одно окно используется для стандартного вывода (standard output), еще одно для сообщений об ошибках (error output), и одно для вывода сообщений отладки (debugging output) - только с одним буфером на целевом MCU. Дополнительный up-канал (в сторону хоста отладки) может использоваться, например, для отправки данных профайлинга или трассировки событий.

[Коммуникации RTT]

Обмен данными с помощью RTT на целевом MCU может осуществляться с различными приложениями. Эта функциональность может быть даже интегрирована в пользовательские программы при использовании J-Link SDK.

Применение RTT в приложении MCU довольно простое. Соответствующий код доступен для свободной загрузки, и может быть интегрирован в существующие приложения.

Для коммуникаций через RTT может использоваться любой J-Link. Простой способ обмена через терминал (Channel 0) - создать на хосте отладки соединение localhost:19021 через telnet-клиент, когда активно подключение MCU к адаптеру J-Link (например, во время сессии отладки).

J-Link Software Package поставляется с дополнительными продвинутыми примерами приложений для разных применений.

J-Link RTT Viewer. J-Link RTT Viewer это основная GUI-утилита Windows, предназначенная для использования возможностей RTT на хосте отладки.

RTT Viewer может использоваться либо самостоятельно, путем открытия собственного соединения с J-Link и целевым MCU, или параллельно с работающей сессией отладки, путем подключения к ней и использования уже открытого соединения с J-Link.

RTT Viewer поддерживает все основные функции RTT:

• Вывод в терминал через Channel 0.
• Отправка текста на ввод через Channel 0.
• До 16 виртуальных терминалов только с одним каналом целевого MCU.
• Управление выводом текста: цветной текст, очистка экрана консоли.
• Лог данных через Channel 1.

Для получения полной документации по J-Link RTT Viewer загрузите руководство пользователя J-Link [2] обратитесь к главе, посвященной RTT. J-Link RTT Viewer входит как часть в пакет ПО и документации J-Link [3], свободно доступный для загрузки.

J-Link RTT Client. Утилита J-Link RTT Client работает как telnet-клиент, однако в отличие от обычной программы telnet пытается восстановить соединение с J-Link, когда сессия отладки закрыта. J-Link RTT Client входит как часть в пакет ПО и документации J-Link [3] для операционных систем Windows, Linux и macOS.

J-Link RTT Logger. С помощью утилиты J-Link RTT Logger данные, поступающие из Up-Channel 1, могут быть прочитаны и записаны в файл. Этот канал может использоваться, например, для отправки на хост отладки данных анализа производительности. J-Link RTT Logger открывает выделенное соединение с адаптером J-Link, и может использоваться самостоятельно, без запуска отладки.

Логгер RTT входит как часть в пакет ПО и документации J-Link [3] для операционных систем Windows, Linux и macOS. Исходный код логгера может использоваться как начальная точка интеграции функций RTT в другие приложения PC, наподобие отладчиков и компонентов J-Link SDK.

[Как работает RTT]

Реализация на MCU. Real Time Transfer использует структуру блока управления (SEGGER RTT Control Block), расположенную в памяти целевого MCU, для поддержки операций чтения и записи данных. Блок управления содержит ID, чтобы его можно было найти подключенному J-Link. Также блок управления и содержит структуру кольцевого буфера для каждого доступного канала, описывающую буфер канала и его состояние.

Максимальное количество доступных каналов может быть сконфигурировано во время компиляции, и каждый буфер может быть сконфигурирован и добавлен приложением во время выполнения в реальном времени (run time). Буферы "вверх" и "вниз" могут обрабатываться отдельно.

Каждый канал может быть сконфигурирован для работы с блокированием и без блокирования выполнения. В блокирующем режиме приложение будет ждать, когда буфер заполнится, до тех пор, пока не удастся записать всю память, что приведет к блокировке состояния приложения, но в то же время предотвращает потерю данных. В неблокирующем режиме записываются только те данные, которые помещаются в буфер, или вообще не записываются, и остальная часть отбрасывается. Это позволяет работу в реальном времени, даже когда отладчик не подключен. Разработчику в этом случае не нужно создавать специальную отладочную версию разрабатываемого firmware, и отладочный код может оставаться в релизе приложения.

Место размещения Control Block. Когда работа RTT активна на PC хоста отладки, либо прямым использованием RTT с помощью приложения наподобие RTT Viewer [5], или путем подключения через Telnet к приложению, которое отлаживает firmware с использованием J-Link, наподобие отладчика, то J-Link автоматически ищет SEGGER RTT Control Block в известных регионах RAM целевого MCU. Эти регионы RAM или определенный адрес места нахождения Control Block можно также установить через приложения хоста отладки PC, чтобы ускорить процесс детектирования Control Block, или если Control Block не может быть найден автоматически.

Внутренние структуры. На рисунке ниже показана упрощенная структура памяти целевого MCU.

Здесь может быть любое количество как дескрипторов буфера вверх, "Up Buffer Descriptors" (Target -> Host), так и дескрипторов буфера вниз, "Down Buffer Descriptors" (Host -> Target). Размер каждого буфера можно конфигурировать индивидуально. Серые области в буферах это места, которые содержат достоверные данные. Для буферов вверх, указатель записи (Write Pointer) записывается целевым MCU, а указатель чтения (Read Pointer) записывается через адаптер отладки (хостом PC через J-Link). Когда указатели чтения и записи указывают на один и тот же элемент, буфер пуст. Это гарантирует отсутствие состояния конкурентного доступа (race condition).

Требования к использованию. SEGGER RTT не нуждается ни в каких дополнительных выводов целевого MCU или дополнительного оборудования, несмотря на то, что J-Link подключен через стандартный порт отладки целевого MCU. RTT не требует какой-либо конфигурации целевого MCU или среды отладки, и может даже использоваться с изменениями скоростей работы целевого MCU.

RTT может работать как параллельно с активной сессией отладки (без нарушения её работы), так и без какой-либо IDE или программного отладчика.

[Производительность RTT]

Быстродействие SEGGER RTT значительно выше, чем у любой другой технологии, используемой для вывода данных в хост отладки PC. Вывод строки среднего размера может занимать одну микросекунду или меньше. Обычно занимаемое время соответствует времени выполнения одного вызова memcopy().

На картинке ниже показано сравнение, выполненное на STM32F407 Cortex-M4, работающего с тактовой частотой 168 МГц. Удалена загрузка процессора на выполнение вызовов printf().

Скорость перемещения данных. Максимальная скорость, на которой данные могут быть отправлены хосту отладки PC, зависит от размера буфера целевого MCU и скорости его интерфейса отладки. Даже с маленьким буфером 512 байт скорость RTT доходит до 1 MiB/s на высокой скорости интерфейса, и 0.5 MiB/s на обычной модели адаптера J-Link.

Размер буфера MCU. Буфер RTT канала "вверх" (MCU -> хост PC) может быть относительно небольшим. Требуемый минимальный размер буфера может быть аппроксимирован по количеству данных, записанных в 1 миллисекунду, и максимальный размер определяется тем, сколько будет передано за одно действие записи. Если посылаемые данные менее часто, то в буфере должно быть достаточно места для данных, которые записываются за одно действие. Если данные посылаются более часто, то размер буфера должен быть достаточен, чтобы пропустить максимальное количество данных, записанных в течение одной миллисекунды. Диаграмма показывает требуемый минимальный размер буфера, когда отправляются разные количества данных - случайным образом, каждые 100 мкс и каждую 1 мс.

Показанные значения были измерены на J-Link PRO V4, на скорости JTAG 36 МГц. Отладочная плата и целевой MCU: SEGGER emPower eval board с процессором NXP K66, работающим на частоте 168 МГц.

Расход памяти. Код для реализации RTT занимает примерно 500 байт ROM и 24 байта ID + 24 байта на канал для Control Block в RAM. Каждому каналу необходим некоторый объем RAM для буфера. Рекомендуемый размер 1 килобайт для каналов "верх" и от 16 до 32 байт для каналов "вниз", в зависимости от нагрузки ввода/вывода.

[Реализация RTT]

Поддержка SEGGER RTT написана на ANSI C, и он может быть интегрирован в любое встраиваемое приложение с помощью кода, который можно загрузить с сайта SEGGER.

RTT легко и просто применять через его API. Можно даже переназначить стандартные функции printf() для использования RTT. Использование RTT уменьшает время отработки printf() до минимума, и позволяет делать печать отладочной информации на хост PC, в то время как приложение firmware выполняет в реальном времени задачи, критичные по времени выполнения.

Реализация SEGGER RTT включает в себя простую реализацию printf(), которая может использоваться для записи результата обработки форматированной строки через RTT. SEGGER_RTT_Printf() меньше, чем большинство библиотечных реализаций printf, не требует наличия кучи (heap), и занимает только лишь конфигурируемое пространство из стека.

Реализация SEGGER RTT конфигурируется полностью через директивы #define препроцессора. Операции чтение и записи могут быть сделаны безопасными для задач (task-safe) с использованием подпрограмм Lock() и Unlock(), несколькими буферами, и также можно легко настроить размер буферов терминала.

Код RTT для целевого MCU поставляется как часть пакета программного обеспечения и документации J-Link (J-Link Software and Documentation Pack), который можно загрузить по ссылке [3]. Модули исходного кода RTT можно найти в каталоге Samples/RTT пакета ПО J-Link.

API-функции RTT:

[Пример кода]

RTT поддерживается максимально простым и может использоваться без какой-либо конфигурации.

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

*               SEGGER MICROCONTROLLER GmbH & Co KG                  *

*       Solutions for real time microcontroller applications         *

**********************************************************************

*                                                                    *

*       (c) 2014  SEGGER Microcontroller GmbH & Co KG                *

*                                                                    *

*       www.segger.com     Support: support@segger.com               *

*                                                                    *

**********************************************************************

Файл       : RTT.c

Назначение : Простая реализация для вывода через RTT.

             Она может использоваться вместе с любой IDE. */

#include "SEGGER_RTT.h"

static void _Delay(int period)
{
   int i = 100000*period;
   do { ; } while (i--);
}

int main(void)
{
   do
   {
      SEGGER_RTT_WriteString(0, "Hello World from SEGGER!\r\n");
      _Delay(100);
   } while (1);
   return 0;
}

Работа printf через RTT. Низкоуровневые функции, используемые в библиотеках для printf() часто могут быть переназначены, чтобы была возможность применять свои собственные функции вывода. Пакет реализации SEGGER RTT включает необходимый код для GCC/Newlib, IAR и KEIL MDK, который можно легко подключить в проект, чтобы перенаправить printf() для вывода данных через RTT. Дополнительно пакет реализации SEGGER RTT включает в себя упрощенную версию printf: SEGGER_RTT_printf(), которая может использовать для печати форматированных строк через RTT напрямую, без вовлечения (потенциально медленной) стандартной библиотеки.

[Поддерживаемые MCU]

RTT можно использовать с любым целевым MCU, который поддерживает J-Link, с возможностью фонового доступа к памяти на работающем MCU. Поддерживаемые ядра архитектур:

Cortex-M
Cortex-R
Cortex-A
RISC-V
Renesas RX

В некоторых случаях поддержка RTT опциональна, и должны быть удовлетворены определенные требования. Для дополнительной информации посетите страничку wiki.segger.com/RTT.

[RTT в приложениях PC]

Вместо того, чтобы запускать внешнее приложение клиента Telnet, функционал RTT можно также непосредственно интегрировать в любое приложение PC, наподобие отладчика. Сделать это можно двумя способами.

Приложение может либо установить соединение с сокетом сервера RTT Telnet (он прослушивает соединения на localhost:19021), либо приложение может использовать J-Link RTT API, которое входит как часть в J-Link SDK, чтобы непосредственно сконфигурировать RTT и получать / отправлять данные.

[Вывод текста разными цветами]

Все данные, прочитанные через RTT, принимаются от целевого MCU без каких-либо изменений. Это дает возможность обрабатывать управляющие последовательности ANSI (ESC-коды) в приложении, которое выводит на печать данные RTT, чтобы отобразить из жирным шрифтом или поменять цвет выводимого текста. Обработка управляющих последовательностей ANSI в приложениях терминала изначально поддерживается в консоли Linux.

Необходимо Windows-приложение наподобие ANSICON [4], и оно может использоваться для вызова клиента RTT. Некоторые приложения Telnet наподобие PuTTY на операционной системе Windows также поддерживают управляющие последовательности ANSI.

[FAQ, решение проблем]

SetRTTSearchRanges 0x10000000 0x1000, 0x2000000 0x1000

SetRTTAddr 0x20000000

eval "monitor exec SetRTTAddr %p", &_SEGGER_RTT

Set_RTT_Address () {
   __var addr;
   __var str;
   addr = &_SEGGER_RTT;
   str = __smessage "SetRTTAddr ",addr:%x;
   __jlinkExecCommand(str);
}

      case 'd':
        v = va_arg(*pParamList, int);
        _PrintInt(&BufferDesc, v, 10u, NumDigits, FieldWidth, FormatFlags);
        break;

-u _printf_float

static void SEGGER_RTT_print_float (float floatNumber)
{
   char tempbuffer[20];

   sprintf(tempbuffer, "%f", floatNumber);
   SEGGER_RTT_printf(0, "%s", tempbuffer);
}

static void SEGGER_RTT_print_float (float floatNumber)
{

   #define PRECISION 10000

   int intPart = (int) floatNumber;
   int decimalPart = (floatNumber - intPart) * PRECISION;
   SEGGER_RTT_printf(0, "%d.%d", intPart, decimalPart);
}

[Ссылки]

1. J-Link RTT – Real Time Transfer site:segger.com.
2. UM08001 J-Link User Manual site:segger.com.
3. J-Link Software and Documentation Pack site:segger.com.
4. ANSICON ANSI escape sequence recognition for Windows console program site:adoxa.altervista.org.
5. Командная строка J-Link RTT Viewer.
6. 210912J-Link-Software-and-Documentation.zip - программное обеспечение и документация J-Link.
7. Bluetooth: аббревиатуры и термины.
8. nRF5x: отладка с помощью RTT.