samples: debug: remove sysview sample
We will implement this as a core feature using tracing points and make it available to any application. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif
parent
3f02e0d5d3
commit
457fc799ba
6 changed files with 0 additions and 397 deletions
|
|
@ -1,10 +0,0 @@
|
|||
.. _debug-samples:
|
||||
|
||||
Debugging Samples
|
||||
#################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
**/*
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
cmake_minimum_required(VERSION 3.8.2)
|
||||
include($ENV{ZEPHYR_BASE}/cmake/app/boilerplate.cmake NO_POLICY_SCOPE)
|
||||
project(NONE)
|
||||
|
||||
FILE(GLOB app_sources src/*.c)
|
||||
target_sources(app PRIVATE ${app_sources})
|
||||
|
|
@ -1,89 +0,0 @@
|
|||
.. _segger_sysview:
|
||||
|
||||
SEGGER SystemView Sample
|
||||
########################
|
||||
|
||||
Overview
|
||||
********
|
||||
This sample application uses the kernel system logger and publishes events
|
||||
through the SEGGER RTT protocol, making it available to the SEGGER
|
||||
SystemView application.
|
||||
|
||||
Requirements
|
||||
************
|
||||
|
||||
* Board supported by J-Link (`list of supported boards <https://www.segger.com/jlink_supported_devices.html#DeviceList>`_)
|
||||
* `SEGGER J-Link Software and Documentation pack <https://www.segger.com/downloads/jlink>`_
|
||||
* The board might require a `special bootloader <https://www.segger.com/opensda.html>`_, also available from SEGGER
|
||||
* `SEGGER SystemView <https://www.segger.com/systemview.html?p=1731>`_
|
||||
|
||||
|
||||
Building and Running
|
||||
********************
|
||||
|
||||
* Follow the instructions to install J-Link and SystemView software on your
|
||||
computer
|
||||
* Open J-Link Commander. On Linux, its executable is named ``JLinkExe``:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
SEGGER J-Link Commander V6.10m (Compiled Nov 10 2016 18:38:45)
|
||||
DLL version V6.10m, compiled Nov 10 2016 18:38:36
|
||||
|
||||
Connecting to J-Link via USB...O.K.
|
||||
Firmware: J-Link OpenSDA 2 compiled Feb 28 2017 19:27:22
|
||||
Hardware version: V1.00
|
||||
S/N: 621000000
|
||||
VTref = 3.300V
|
||||
|
||||
|
||||
Type "connect" to establish a target connection, '?' for help
|
||||
J-Link>
|
||||
|
||||
* Issue the "connect" command. If it's the only connected board, ``Enter``
|
||||
can be pressed at the ``Device>`` prompt.
|
||||
* Select the target interface. Some devices only support the ``SWD`` type,
|
||||
so select it by typing ``S`` followed by ``Enter``.
|
||||
* At the ``Speed>`` prompt, select the interface polling frequency. The
|
||||
default of 4000kHz is sufficient, but a higher frequency can be specified.
|
||||
* Once the connection has been successful, an output similar to this one
|
||||
should be produced:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
Device "MK64FN1M0XXX12" selected.
|
||||
|
||||
|
||||
Found SWD-DP with ID 0x2BA01477
|
||||
Found SWD-DP with ID 0x2BA01477
|
||||
AP-IDR: 0x24770011, Type: AHB-AP
|
||||
Found Cortex-M4 r0p1, Little endian.
|
||||
FPUnit: 6 code (BP) slots and 2 literal slots
|
||||
CoreSight components:
|
||||
ROMTbl 0 @ E00FF000
|
||||
ROMTbl 0 [0]: FFF0F000, CID: B105E00D, PID: 000BB00C SCS
|
||||
ROMTbl 0 [1]: FFF02000, CID: B105E00D, PID: 003BB002 DWT
|
||||
ROMTbl 0 [2]: FFF03000, CID: B105E00D, PID: 002BB003 FPB
|
||||
ROMTbl 0 [3]: FFF01000, CID: B105E00D, PID: 003BB001 ITM
|
||||
ROMTbl 0 [4]: FFF41000, CID: B105900D, PID: 000BB9A1 TPIU
|
||||
ROMTbl 0 [5]: FFF42000, CID: B105900D, PID: 000BB925 ETM
|
||||
ROMTbl 0 [6]: FFF43000, CID: B105900D, PID: 003BB907 ETB
|
||||
ROMTbl 0 [7]: FFF44000, CID: B105900D, PID: 001BB908 CSTF
|
||||
Cortex-M4 identified.
|
||||
J-Link>
|
||||
|
||||
* Now open SystemView. Select the option *Start Recording* from the
|
||||
*Target* menu (or press ``F5``), choose USB, the target device (in this
|
||||
case, ``MK64FN1M0XXX12``), and confirm that the target interface and speed
|
||||
matches the ones selected in J-Link Commander. The *RTT Control Block
|
||||
Detection* can be left on *Auto Detection*.
|
||||
* Once OK is clicked, information will be pulled from the device as usual:
|
||||
threads, interrupts, and other information will be populated
|
||||
automatically.
|
||||
|
||||
References
|
||||
**********
|
||||
|
||||
* `Segger SystemView: Realtime Analysis and Visualization for FreeRTOS <https://mcuoneclipse.com/2015/11/16/segger-systemview-realtime-analysis-and-visualization-for-freertos/>`_
|
||||
* `RTT Protocol <https://www.segger.com/jlink-rtt.html>`_
|
||||
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
CONFIG_RING_BUFFER=y
|
||||
CONFIG_KERNEL_EVENT_LOGGER=y
|
||||
CONFIG_KERNEL_EVENT_LOGGER_BUFFER_SIZE=16
|
||||
CONFIG_KERNEL_EVENT_LOGGER_CONTEXT_SWITCH=y
|
||||
CONFIG_KERNEL_EVENT_LOGGER_INTERRUPT=y
|
||||
CONFIG_KERNEL_EVENT_LOGGER_SLEEP=y
|
||||
CONFIG_KERNEL_EVENT_LOGGER_THREAD=y
|
||||
CONFIG_SEGGER_SYSTEMVIEW=y
|
||||
CONFIG_THREAD_MONITOR=y
|
||||
CONFIG_SYS_LOG=y
|
||||
CONFIG_SYS_LOG_DEFAULT_LEVEL=3
|
||||
CONFIG_SYS_LOG_EXT_HOOK=y
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
sample:
|
||||
name: Systemview Demo
|
||||
tests:
|
||||
test:
|
||||
filter: CONFIG_HAS_SEGGER_RTT
|
||||
tags: debug tracing
|
||||
min_ram: 18
|
||||
harness: console
|
||||
harness_config:
|
||||
type: one_line
|
||||
regex:
|
||||
- "RTT block address is.*"
|
||||
|
|
@ -1,268 +0,0 @@
|
|||
/*
|
||||
* Copyright (c) 2017 Intel Corporation
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include <kernel_structs.h>
|
||||
#include <logging/kernel_event_logger.h>
|
||||
#include <misc/printk.h>
|
||||
#include <misc/util.h>
|
||||
#include <zephyr.h>
|
||||
|
||||
#include <systemview/SEGGER_SYSVIEW.h>
|
||||
#include <rtt/SEGGER_RTT.h>
|
||||
|
||||
K_THREAD_STACK_DEFINE(printer_stack, 1024);
|
||||
K_THREAD_STACK_DEFINE(calc_stack, 1024);
|
||||
K_THREAD_STACK_DEFINE(sysview_stack, 1024);
|
||||
|
||||
static struct k_thread printer_thread_data;
|
||||
static struct k_thread calc_thread_data;
|
||||
static struct k_thread sysview_thread_data;
|
||||
|
||||
static u32_t timestamp, interrupt;
|
||||
|
||||
extern SEGGER_RTT_CB _SEGGER_RTT;
|
||||
|
||||
u32_t sysview_get_timestamp(void)
|
||||
{
|
||||
return timestamp;
|
||||
}
|
||||
|
||||
u32_t sysview_get_interrupt(void)
|
||||
{
|
||||
return interrupt;
|
||||
}
|
||||
|
||||
static void publish_context_switch(u32_t *event_data)
|
||||
{
|
||||
#if defined(CONFIG_KERNEL_EVENT_LOGGER_CONTEXT_SWITCH)
|
||||
SEGGER_SYSVIEW_OnTaskStartExec(event_data[1]);
|
||||
#endif
|
||||
}
|
||||
|
||||
static void publish_interrupt(u32_t *event_data)
|
||||
{
|
||||
#if defined(CONFIG_KERNEL_EVENT_LOGGER_INTERRUPT)
|
||||
interrupt = event_data[1];
|
||||
|
||||
/* FIXME: RecordEnter and RecordExit seem to be required to keep
|
||||
* SystemView happy; however, there's currently no way to measure
|
||||
* the time it takes for an ISR to execute.
|
||||
*/
|
||||
SEGGER_SYSVIEW_RecordEnterISR();
|
||||
SEGGER_SYSVIEW_RecordExitISR();
|
||||
#endif
|
||||
}
|
||||
|
||||
static void publish_sleep(u32_t *event_data)
|
||||
{
|
||||
#if defined(CONFIG_KERNEL_EVENT_LOGGER_SLEEP)
|
||||
SEGGER_SYSVIEW_OnIdle();
|
||||
#endif
|
||||
}
|
||||
|
||||
static void publish_task(u32_t *event_data)
|
||||
{
|
||||
#if defined(CONFIG_KERNEL_EVENT_LOGGER_THREAD)
|
||||
u32_t thread_id;
|
||||
|
||||
thread_id = event_data[1];
|
||||
|
||||
switch ((enum sys_k_event_logger_thread_event)event_data[2]) {
|
||||
case KERNEL_LOG_THREAD_EVENT_READYQ:
|
||||
SEGGER_SYSVIEW_OnTaskStartReady(thread_id);
|
||||
break;
|
||||
case KERNEL_LOG_THREAD_EVENT_PEND:
|
||||
SEGGER_SYSVIEW_OnTaskStopReady(thread_id, 3<<3);
|
||||
break;
|
||||
case KERNEL_LOG_THREAD_EVENT_EXIT:
|
||||
SEGGER_SYSVIEW_OnTaskTerminate(thread_id);
|
||||
break;
|
||||
}
|
||||
|
||||
/* FIXME: Maybe we need a KERNEL_LOG_THREAD_EVENT_CREATE? */
|
||||
#endif
|
||||
}
|
||||
|
||||
static void send_system_desc(void)
|
||||
{
|
||||
SEGGER_SYSVIEW_SendSysDesc("N=ZephyrSysViewSample");
|
||||
SEGGER_SYSVIEW_SendSysDesc("D=" CONFIG_BOARD " "
|
||||
CONFIG_SOC " " CONFIG_ARCH);
|
||||
SEGGER_SYSVIEW_SendSysDesc("O=Zephyr");
|
||||
}
|
||||
|
||||
static void sysview_api_send_task(const struct k_thread *thr, void *udata)
|
||||
{
|
||||
char name[20];
|
||||
|
||||
snprintk(name, sizeof(name), "T%xE%x",
|
||||
(uintptr_t)thr, (uintptr_t)(&thr->entry));
|
||||
|
||||
/* NOTE: struct k_thread is inside the stack on Zephyr 1.7.
|
||||
* This is not guaranteed by the API, and is likely to change
|
||||
* in the future. Hence, StackBase/StackSize are not set here;
|
||||
* these could be stored as part of the kernel event.
|
||||
*/
|
||||
SEGGER_SYSVIEW_SendTaskInfo(&(SEGGER_SYSVIEW_TASKINFO) {
|
||||
.TaskID = (u32_t)(uintptr_t)thr,
|
||||
.sName = name,
|
||||
.Prio = thr->base.prio,
|
||||
});
|
||||
|
||||
}
|
||||
|
||||
static void sysview_api_send_task_list(void)
|
||||
{
|
||||
k_thread_foreach(sysview_api_send_task, NULL);
|
||||
}
|
||||
|
||||
static u32_t zephyr_to_sysview(int event_type)
|
||||
{
|
||||
static const u32_t lut[] = {
|
||||
[KERNEL_EVENT_LOGGER_CONTEXT_SWITCH_EVENT_ID] =
|
||||
SYSVIEW_EVTMASK_TASK_START_EXEC,
|
||||
[KERNEL_EVENT_LOGGER_INTERRUPT_EVENT_ID] =
|
||||
SYSVIEW_EVTMASK_ISR_ENTER |
|
||||
SYSVIEW_EVTMASK_ISR_EXIT,
|
||||
[KERNEL_EVENT_LOGGER_SLEEP_EVENT_ID] =
|
||||
SYSVIEW_EVTMASK_IDLE,
|
||||
[KERNEL_EVENT_LOGGER_THREAD_EVENT_ID] =
|
||||
SYSVIEW_EVTMASK_TASK_CREATE |
|
||||
SYSVIEW_EVTMASK_TASK_START_READY |
|
||||
SYSVIEW_EVTMASK_TASK_STOP_READY |
|
||||
SYSVIEW_EVTMASK_TASK_STOP_EXEC,
|
||||
};
|
||||
|
||||
return lut[event_type];
|
||||
}
|
||||
|
||||
#define MUST_LOG(event) \
|
||||
(IS_ENABLED(CONFIG_ ## event) && \
|
||||
sys_k_must_log_event(event ## _EVENT_ID))
|
||||
|
||||
#define ENABLE_SYSVIEW_EVENT(event) \
|
||||
(MUST_LOG(event) ? zephyr_to_sysview(event ## _EVENT_ID) : 0)
|
||||
|
||||
static void sysview_setup(void)
|
||||
{
|
||||
static const SEGGER_SYSVIEW_OS_API api = {
|
||||
.pfGetTime = NULL, /* sysview_get_timestamp() used instead */
|
||||
.pfSendTaskList = sysview_api_send_task_list,
|
||||
};
|
||||
u32_t evs;
|
||||
|
||||
printk("RTT block address is %p\n", &_SEGGER_RTT);
|
||||
|
||||
/* NOTE: SysView does not support dynamic frequency scaling */
|
||||
SEGGER_SYSVIEW_Init(CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC,
|
||||
CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC,
|
||||
&api, send_system_desc);
|
||||
|
||||
#if defined(CONFIG_PHYS_RAM_ADDR) /* x86 */
|
||||
SEGGER_SYSVIEW_SetRAMBase(CONFIG_PHYS_RAM_ADDR);
|
||||
#elif defined(CONFIG_SRAM_BASE_ADDRESS) /* arm, default */
|
||||
SEGGER_SYSVIEW_SetRAMBase(CONFIG_SRAM_BASE_ADDRESS);
|
||||
#else
|
||||
/* Setting RAMBase is just an optimization: this value is subtracted
|
||||
* from all pointers in order to save bandwidth. It's not an error
|
||||
* if a platform does not set this value.
|
||||
*/
|
||||
#endif
|
||||
|
||||
evs = SYSVIEW_EVTMASK_PRINT_FORMATTED |
|
||||
ENABLE_SYSVIEW_EVENT(KERNEL_EVENT_LOGGER_SLEEP) |
|
||||
ENABLE_SYSVIEW_EVENT(KERNEL_EVENT_LOGGER_CONTEXT_SWITCH) |
|
||||
ENABLE_SYSVIEW_EVENT(KERNEL_EVENT_LOGGER_INTERRUPT) |
|
||||
ENABLE_SYSVIEW_EVENT(KERNEL_EVENT_LOGGER_THREAD);
|
||||
SEGGER_SYSVIEW_EnableEvents(evs);
|
||||
}
|
||||
|
||||
#undef ENABLE_SYSVIEW_EVENT
|
||||
#undef MUST_LOG
|
||||
|
||||
static void sysview_thread(void)
|
||||
{
|
||||
sysview_setup();
|
||||
|
||||
for (;;) {
|
||||
u32_t event_data[4];
|
||||
u16_t event_id;
|
||||
u8_t dropped;
|
||||
u8_t event_data_size = (u8_t)ARRAY_SIZE(event_data);
|
||||
int ret;
|
||||
|
||||
ret = sys_k_event_logger_get_wait(&event_id,
|
||||
&dropped,
|
||||
event_data,
|
||||
&event_data_size);
|
||||
if (ret < 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
timestamp = event_data[0];
|
||||
|
||||
switch (event_id) {
|
||||
case KERNEL_EVENT_LOGGER_CONTEXT_SWITCH_EVENT_ID:
|
||||
publish_context_switch(event_data);
|
||||
break;
|
||||
case KERNEL_EVENT_LOGGER_INTERRUPT_EVENT_ID:
|
||||
publish_interrupt(event_data);
|
||||
break;
|
||||
case KERNEL_EVENT_LOGGER_SLEEP_EVENT_ID:
|
||||
publish_sleep(event_data);
|
||||
break;
|
||||
case KERNEL_EVENT_LOGGER_THREAD_EVENT_ID:
|
||||
publish_task(event_data);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static void printer_thread(void)
|
||||
{
|
||||
for (;;) {
|
||||
SEGGER_SYSVIEW_Print("Printer thread says hello");
|
||||
k_sleep(MSEC_PER_SEC);
|
||||
}
|
||||
}
|
||||
|
||||
static void calc_thread(void)
|
||||
{
|
||||
int denom = 0;
|
||||
|
||||
for (;;) {
|
||||
const int val = 0xbebacafe;
|
||||
|
||||
denom = (denom + 1) % 16;
|
||||
|
||||
if (denom == 0) {
|
||||
SEGGER_SYSVIEW_Warn("Not calculating: denom is 0");
|
||||
} else {
|
||||
SEGGER_SYSVIEW_PrintfHost("Calculated: %d",
|
||||
val / denom);
|
||||
}
|
||||
|
||||
k_sleep(MSEC_PER_SEC);
|
||||
}
|
||||
}
|
||||
|
||||
void main(void)
|
||||
{
|
||||
k_thread_create(&sysview_thread_data, sysview_stack,
|
||||
K_THREAD_STACK_SIZEOF(sysview_stack),
|
||||
(k_thread_entry_t)sysview_thread,
|
||||
NULL, NULL, NULL, K_PRIO_COOP(1), 0, 0);
|
||||
|
||||
k_thread_create(&printer_thread_data, printer_stack,
|
||||
K_THREAD_STACK_SIZEOF(printer_stack),
|
||||
(k_thread_entry_t)printer_thread,
|
||||
NULL, NULL, NULL, K_PRIO_COOP(1), 0, 0);
|
||||
|
||||
k_thread_create(&calc_thread_data, calc_stack,
|
||||
K_THREAD_STACK_SIZEOF(calc_stack),
|
||||
(k_thread_entry_t)calc_thread,
|
||||
NULL, NULL, NULL, K_PRIO_COOP(1), 0, 0);
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue