From dd40877ab2ee693d5513614a811ed6b4ade12414 Mon Sep 17 00:00:00 2001 From: Alexey Lapshin Date: Mon, 28 Nov 2022 12:33:05 +0700 Subject: [PATCH 1/3] sys_view: upgrade to version 3.32 --- components/app_trace/CMakeLists.txt | 6 +- components/app_trace/sys_view/Config/Global.h | 53 +- .../sys_view/Config/SEGGER_RTT_Conf.h | 284 +++++--- .../sys_view/Config/SEGGER_SYSVIEW_Conf.h | 142 +--- components/app_trace/sys_view/SEGGER/SEGGER.h | 171 +++-- .../app_trace/sys_view/SEGGER/SEGGER_RTT.h | 381 +++++++++-- .../sys_view/SEGGER/SEGGER_SYSVIEW.c | 636 ++++++++++++++---- .../sys_view/SEGGER/SEGGER_SYSVIEW.h | 86 ++- .../SEGGER/SEGGER_SYSVIEW_ConfDefaults.h | 517 ++++++++++++-- .../sys_view/SEGGER/SEGGER_SYSVIEW_Int.h | 31 +- .../esp}/SEGGER_SYSVIEW_Config_FreeRTOS.c | 0 .../SEGGER_SYSVIEW_FreeRTOS.c | 134 ++-- .../SEGGER_SYSVIEW_FreeRTOS.h | 144 ++-- docs/en/COPYRIGHT.rst | 2 +- tools/ci/check_copyright_config.yaml | 1 + tools/esp_app_trace/SYSVIEW_FreeRTOS.txt | 7 + .../test/sysview/expected_output.json | 7 + .../test/sysview/expected_output_mcore.json | 7 + 18 files changed, 1885 insertions(+), 724 deletions(-) rename components/app_trace/sys_view/Sample/{Config => FreeRTOSV10.4/Config/esp}/SEGGER_SYSVIEW_Config_FreeRTOS.c (100%) rename components/app_trace/sys_view/Sample/{OS => FreeRTOSV10.4}/SEGGER_SYSVIEW_FreeRTOS.c (64%) rename components/app_trace/sys_view/Sample/{OS => FreeRTOSV10.4}/SEGGER_SYSVIEW_FreeRTOS.h (66%) diff --git a/components/app_trace/CMakeLists.txt b/components/app_trace/CMakeLists.txt index 9cb36c8f04d2..bc5e42547b1d 100644 --- a/components/app_trace/CMakeLists.txt +++ b/components/app_trace/CMakeLists.txt @@ -28,12 +28,12 @@ if(CONFIG_APPTRACE_SV_ENABLE) list(APPEND include_dirs sys_view/Config sys_view/SEGGER - sys_view/Sample/OS) + sys_view/Sample/FreeRTOSV10.4) list(APPEND srcs "sys_view/SEGGER/SEGGER_SYSVIEW.c" - "sys_view/Sample/Config/SEGGER_SYSVIEW_Config_FreeRTOS.c" - "sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.c" + "sys_view/Sample/FreeRTOSV10.4/Config/esp/SEGGER_SYSVIEW_Config_FreeRTOS.c" + "sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.c" "sys_view/esp/SEGGER_RTT_esp.c" "sys_view/ext/heap_trace_module.c" "sys_view/ext/logging.c") diff --git a/components/app_trace/sys_view/Config/Global.h b/components/app_trace/sys_view/Config/Global.h index 421af5e1c89d..5886cbfb6e57 100644 --- a/components/app_trace/sys_view/Config/Global.h +++ b/components/app_trace/sys_view/Config/Global.h @@ -1,14 +1,14 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +22,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,7 +47,7 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** ---------------------------------------------------------------------- @@ -67,6 +57,7 @@ Purpose : Global types merge the files. In order to use Segger code, the types U8, U16, U32, I8, I16, I32 need to be defined in Global.h; additional definitions do not hurt. +Revision: $Rev: 12501 $ ---------------------------END-OF-HEADER------------------------------ */ @@ -74,13 +65,26 @@ Purpose : Global types #define GLOBAL_H #define U8 unsigned char -#define U16 unsigned short -#define U32 unsigned long #define I8 signed char +#define U16 unsigned short #define I16 signed short +#ifdef __x86_64__ +#define U32 unsigned +#define I32 int +#else +#define U32 unsigned long #define I32 signed long +#endif -#ifdef _WIN32 +// +// CC_NO_LONG_SUPPORT can be defined to compile test +// without long support for compilers that do not +// support C99 and its long type. +// +#ifdef CC_NO_LONG_SUPPORT + #define PTR_ADDR U32 +#else // Supports long type. +#if defined(_WIN32) && !defined(__clang__) && !defined(__MINGW32__) // // Microsoft VC6 compiler related // @@ -102,6 +106,13 @@ Purpose : Global types #define U64_C(x) x##ULL #endif +#if (defined(_WIN64) || defined(__LP64__)) // 64-bit symbols used by Visual Studio and GCC, maybe others as well. + #define PTR_ADDR U64 +#else + #define PTR_ADDR U32 +#endif +#endif // Supports long type. + #endif // Avoid multiple inclusion /*************************** End of file ****************************/ diff --git a/components/app_trace/sys_view/Config/SEGGER_RTT_Conf.h b/components/app_trace/sys_view/Config/SEGGER_RTT_Conf.h index be61b5f7ba17..0e4dd04cb265 100644 --- a/components/app_trace/sys_view/Config/SEGGER_RTT_Conf.h +++ b/components/app_trace/sys_view/Config/SEGGER_RTT_Conf.h @@ -1,14 +1,14 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +22,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,7 +47,7 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** ---------------------------END-OF-HEADER------------------------------ @@ -65,7 +55,7 @@ File : SEGGER_RTT_Conf.h Purpose : Implementation of SEGGER real-time transfer (RTT) which allows real-time communication on targets which support debugger memory accesses while the CPU is running. -Revision: $Rev: 5626 $ +Revision: $Rev: 24316 $ */ @@ -83,15 +73,65 @@ Revision: $Rev: 5626 $ ********************************************************************** */ -#define SEGGER_RTT_MAX_NUM_UP_BUFFERS (3) // Max. number of up-buffers (T->H) available on this target (Default: 3) -#define SEGGER_RTT_MAX_NUM_DOWN_BUFFERS (3) // Max. number of down-buffers (H->T) available on this target (Default: 3) +// +// Take in and set to correct values for Cortex-A systems with CPU cache +// +//#define SEGGER_RTT_CPU_CACHE_LINE_SIZE (32) // Largest cache line size (in bytes) in the current system +//#define SEGGER_RTT_UNCACHED_OFF (0xFB000000) // Address alias where RTT CB and buffers can be accessed uncached +// +// Most common case: +// Up-channel 0: RTT +// Up-channel 1: SystemView +// +#ifndef SEGGER_RTT_MAX_NUM_UP_BUFFERS + #define SEGGER_RTT_MAX_NUM_UP_BUFFERS (3) // Max. number of up-buffers (T->H) available on this target (Default: 3) +#endif +// +// Most common case: +// Down-channel 0: RTT +// Down-channel 1: SystemView +// +#ifndef SEGGER_RTT_MAX_NUM_DOWN_BUFFERS + #define SEGGER_RTT_MAX_NUM_DOWN_BUFFERS (3) // Max. number of down-buffers (H->T) available on this target (Default: 3) +#endif + +#ifndef BUFFER_SIZE_UP + #define BUFFER_SIZE_UP (1024) // Size of the buffer for terminal output of target, up to host (Default: 1k) +#endif -#define BUFFER_SIZE_UP (1024) // Size of the buffer for terminal output of target, up to host (Default: 1k) -#define BUFFER_SIZE_DOWN (16) // Size of the buffer for terminal input to target from host (Usually keyboard input) (Default: 16) +#ifndef BUFFER_SIZE_DOWN + #define BUFFER_SIZE_DOWN (16) // Size of the buffer for terminal input to target from host (Usually keyboard input) (Default: 16) +#endif -#define SEGGER_RTT_PRINTF_BUFFER_SIZE (64u) // Size of buffer for RTT printf to bulk-send chars via RTT (Default: 64) +#ifndef SEGGER_RTT_PRINTF_BUFFER_SIZE + #define SEGGER_RTT_PRINTF_BUFFER_SIZE (64u) // Size of buffer for RTT printf to bulk-send chars via RTT (Default: 64) +#endif -#define SEGGER_RTT_MODE_DEFAULT SEGGER_RTT_MODE_NO_BLOCK_SKIP // Mode for pre-initialized terminal channel (buffer 0) +#ifndef SEGGER_RTT_MODE_DEFAULT + #define SEGGER_RTT_MODE_DEFAULT SEGGER_RTT_MODE_NO_BLOCK_SKIP // Mode for pre-initialized terminal channel (buffer 0) +#endif + +/********************************************************************* +* +* RTT memcpy configuration +* +* memcpy() is good for large amounts of data, +* but the overhead is big for small amounts, which are usually stored via RTT. +* With SEGGER_RTT_MEMCPY_USE_BYTELOOP a simple byte loop can be used instead. +* +* SEGGER_RTT_MEMCPY() can be used to replace standard memcpy() in RTT functions. +* This is may be required with memory access restrictions, +* such as on Cortex-A devices with MMU. +*/ +#ifndef SEGGER_RTT_MEMCPY_USE_BYTELOOP + #define SEGGER_RTT_MEMCPY_USE_BYTELOOP 0 // 0: Use memcpy/SEGGER_RTT_MEMCPY, 1: Use a simple byte-loop +#endif +// +// Example definition of SEGGER_RTT_MEMCPY to external memcpy with GCC toolchains and Cortex-A targets +// +//#if ((defined __SES_ARM) || (defined __CROSSWORKS_ARM) || (defined __GNUC__)) && (defined (__ARM_ARCH_7A__)) +// #define SEGGER_RTT_MEMCPY(pDest, pSrc, NumBytes) SEGGER_memcpy((pDest), (pSrc), (NumBytes)) +//#endif // // Target is not allowed to perform other RTT operations while string still has not been stored completely. @@ -107,64 +147,64 @@ Revision: $Rev: 5626 $ // In case of doubt mask all interrupts: 1 << (8 - BASEPRI_PRIO_BITS) i.e. 1 << 5 when 3 bits are implemented in NVIC // or define SEGGER_RTT_LOCK() to completely disable interrupts. // - -#define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) // Interrupt priority to lock on SEGGER_RTT_LOCK on Cortex-M3/4 (Default: 0x20) +#ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY + #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) // Interrupt priority to lock on SEGGER_RTT_LOCK on Cortex-M3/4 (Default: 0x20) +#endif /********************************************************************* * * RTT lock configuration for SEGGER Embedded Studio, * Rowley CrossStudio and GCC */ -#if (defined __SES_ARM) || (defined __CROSSWORKS_ARM) || (defined __GNUC__) - #ifdef __ARM_ARCH_6M__ +#if ((defined(__SES_ARM) || defined(__SES_RISCV) || defined(__CROSSWORKS_ARM) || defined(__GNUC__) || defined(__clang__)) && !defined (__CC_ARM) && !defined(WIN32)) + #if (defined(__ARM_ARCH_6M__) || defined(__ARM_ARCH_8M_BASE__)) #define SEGGER_RTT_LOCK() { \ - unsigned int LockState; \ + unsigned int _SEGGER_RTT__LockState; \ __asm volatile ("mrs %0, primask \n\t" \ - "mov r1, $1 \n\t" \ + "movs r1, #1 \n\t" \ "msr primask, r1 \n\t" \ - : "=r" (LockState) \ + : "=r" (_SEGGER_RTT__LockState) \ : \ - : "r1" \ + : "r1", "cc" \ ); #define SEGGER_RTT_UNLOCK() __asm volatile ("msr primask, %0 \n\t" \ : \ - : "r" (LockState) \ + : "r" (_SEGGER_RTT__LockState) \ : \ ); \ } - - #elif (defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7EM__)) + #elif (defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7EM__) || defined(__ARM_ARCH_8M_MAIN__)) #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) #endif #define SEGGER_RTT_LOCK() { \ - unsigned int LockState; \ + unsigned int _SEGGER_RTT__LockState; \ __asm volatile ("mrs %0, basepri \n\t" \ "mov r1, %1 \n\t" \ "msr basepri, r1 \n\t" \ - : "=r" (LockState) \ + : "=r" (_SEGGER_RTT__LockState) \ : "i"(SEGGER_RTT_MAX_INTERRUPT_PRIORITY) \ - : "r1" \ + : "r1", "cc" \ ); #define SEGGER_RTT_UNLOCK() __asm volatile ("msr basepri, %0 \n\t" \ : \ - : "r" (LockState) \ + : "r" (_SEGGER_RTT__LockState) \ : \ ); \ } - #elif defined(__ARM_ARCH_7A__) + #elif (defined(__ARM_ARCH_7A__) || defined(__ARM_ARCH_7R__)) #define SEGGER_RTT_LOCK() { \ - unsigned int LockState; \ + unsigned int _SEGGER_RTT__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) \ + : "=r" (_SEGGER_RTT__LockState) \ : \ - : "r1" \ + : "r1", "cc" \ ); #define SEGGER_RTT_UNLOCK() __asm volatile ("mov r0, %0 \n\t" \ @@ -174,11 +214,30 @@ Revision: $Rev: 5626 $ "orr r1, r1, r0 \n\t" \ "msr CPSR_c, r1 \n\t" \ : \ - : "r" (LockState) \ - : "r0", "r1" \ + : "r" (_SEGGER_RTT__LockState) \ + : "r0", "r1", "cc" \ ); \ } -#else + #elif defined(__riscv) || defined(__riscv_xlen) + #define SEGGER_RTT_LOCK() { \ + unsigned int _SEGGER_RTT__LockState; \ + __asm volatile ("csrr %0, mstatus \n\t" \ + "csrci mstatus, 8 \n\t" \ + "andi %0, %0, 8 \n\t" \ + : "=r" (_SEGGER_RTT__LockState) \ + : \ + : \ + ); + + #define SEGGER_RTT_UNLOCK() __asm volatile ("csrr a1, mstatus \n\t" \ + "or %0, %0, a1 \n\t" \ + "csrs mstatus, %0 \n\t" \ + : \ + : "r" (_SEGGER_RTT__LockState) \ + : "a1" \ + ); \ + } + #else #define SEGGER_RTT_LOCK() #define SEGGER_RTT_UNLOCK() #endif @@ -189,25 +248,53 @@ Revision: $Rev: 5626 $ * RTT lock configuration for IAR EWARM */ #ifdef __ICCARM__ - #if (defined (__ARM6M__) && (__CORE__ == __ARM6M__)) + #if (defined (__ARM6M__) && (__CORE__ == __ARM6M__)) || \ + (defined (__ARM8M_BASELINE__) && (__CORE__ == __ARM8M_BASELINE__)) #define SEGGER_RTT_LOCK() { \ - unsigned int LockState; \ - LockState = __get_PRIMASK(); \ + unsigned int _SEGGER_RTT__LockState; \ + _SEGGER_RTT__LockState = __get_PRIMASK(); \ __set_PRIMASK(1); - #define SEGGER_RTT_UNLOCK() __set_PRIMASK(LockState); \ + #define SEGGER_RTT_UNLOCK() __set_PRIMASK(_SEGGER_RTT__LockState); \ } - #elif ((defined (__ARM7EM__) && (__CORE__ == __ARM7EM__)) || (defined (__ARM7M__) && (__CORE__ == __ARM7M__))) + #elif (defined (__ARM7EM__) && (__CORE__ == __ARM7EM__)) || \ + (defined (__ARM7M__) && (__CORE__ == __ARM7M__)) || \ + (defined (__ARM8M_MAINLINE__) && (__CORE__ == __ARM8M_MAINLINE__)) || \ + (defined (__ARM8M_MAINLINE__) && (__CORE__ == __ARM8M_MAINLINE__)) #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) #endif #define SEGGER_RTT_LOCK() { \ - unsigned int LockState; \ - LockState = __get_BASEPRI(); \ + unsigned int _SEGGER_RTT__LockState; \ + _SEGGER_RTT__LockState = __get_BASEPRI(); \ __set_BASEPRI(SEGGER_RTT_MAX_INTERRUPT_PRIORITY); - #define SEGGER_RTT_UNLOCK() __set_BASEPRI(LockState); \ + #define SEGGER_RTT_UNLOCK() __set_BASEPRI(_SEGGER_RTT__LockState); \ } + #elif (defined (__ARM7A__) && (__CORE__ == __ARM7A__)) || \ + (defined (__ARM7R__) && (__CORE__ == __ARM7R__)) + #define SEGGER_RTT_LOCK() { \ + unsigned int _SEGGER_RTT__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" (_SEGGER_RTT__LockState) \ + : \ + : "r1", "cc" \ + ); + + #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" (_SEGGER_RTT__LockState) \ + : "r0", "r1", "cc" \ + ); \ + } #endif #endif @@ -217,11 +304,25 @@ Revision: $Rev: 5626 $ */ #ifdef __ICCRX__ #define SEGGER_RTT_LOCK() { \ - unsigned long LockState; \ - LockState = __get_interrupt_state(); \ + unsigned long _SEGGER_RTT__LockState; \ + _SEGGER_RTT__LockState = __get_interrupt_state(); \ __disable_interrupt(); - #define SEGGER_RTT_UNLOCK() __set_interrupt_state(LockState); \ + #define SEGGER_RTT_UNLOCK() __set_interrupt_state(_SEGGER_RTT__LockState); \ + } +#endif + +/********************************************************************* +* +* RTT lock configuration for IAR RL78 +*/ +#ifdef __ICCRL78__ + #define SEGGER_RTT_LOCK() { \ + __istate_t _SEGGER_RTT__LockState; \ + _SEGGER_RTT__LockState = __get_interrupt_state(); \ + __disable_interrupt(); + + #define SEGGER_RTT_UNLOCK() __set_interrupt_state(_SEGGER_RTT__LockState); \ } #endif @@ -232,13 +333,13 @@ Revision: $Rev: 5626 $ #ifdef __CC_ARM #if (defined __TARGET_ARCH_6S_M) #define SEGGER_RTT_LOCK() { \ - unsigned int LockState; \ - register unsigned char PRIMASK __asm( "primask"); \ - LockState = PRIMASK; \ - PRIMASK = 1u; \ + unsigned int _SEGGER_RTT__LockState; \ + register unsigned char _SEGGER_RTT__PRIMASK __asm( "primask"); \ + _SEGGER_RTT__LockState = _SEGGER_RTT__PRIMASK; \ + _SEGGER_RTT__PRIMASK = 1u; \ __schedule_barrier(); - #define SEGGER_RTT_UNLOCK() PRIMASK = LockState; \ + #define SEGGER_RTT_UNLOCK() _SEGGER_RTT__PRIMASK = _SEGGER_RTT__LockState; \ __schedule_barrier(); \ } #elif (defined(__TARGET_ARCH_7_M) || defined(__TARGET_ARCH_7E_M)) @@ -246,13 +347,13 @@ Revision: $Rev: 5626 $ #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) #endif #define SEGGER_RTT_LOCK() { \ - unsigned int LockState; \ + unsigned int _SEGGER_RTT__LockState; \ register unsigned char BASEPRI __asm( "basepri"); \ - LockState = BASEPRI; \ + _SEGGER_RTT__LockState = BASEPRI; \ BASEPRI = SEGGER_RTT_MAX_INTERRUPT_PRIORITY; \ __schedule_barrier(); - #define SEGGER_RTT_UNLOCK() BASEPRI = LockState; \ + #define SEGGER_RTT_UNLOCK() BASEPRI = _SEGGER_RTT__LockState; \ __schedule_barrier(); \ } #endif @@ -265,38 +366,67 @@ Revision: $Rev: 5626 $ #ifdef __TI_ARM__ #if defined (__TI_ARM_V6M0__) #define SEGGER_RTT_LOCK() { \ - unsigned int LockState; \ - LockState = __get_PRIMASK(); \ + unsigned int _SEGGER_RTT__LockState; \ + _SEGGER_RTT__LockState = __get_PRIMASK(); \ __set_PRIMASK(1); - #define SEGGER_RTT_UNLOCK() __set_PRIMASK(LockState); \ + #define SEGGER_RTT_UNLOCK() __set_PRIMASK(_SEGGER_RTT__LockState); \ } #elif (defined (__TI_ARM_V7M3__) || defined (__TI_ARM_V7M4__)) #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) #endif #define SEGGER_RTT_LOCK() { \ - unsigned int LockState; \ - LockState = OS_GetBASEPRI(); \ - OS_SetBASEPRI(SEGGER_RTT_MAX_INTERRUPT_PRIORITY); + unsigned int _SEGGER_RTT__LockState; \ + _SEGGER_RTT__LockState = _set_interrupt_priority(SEGGER_RTT_MAX_INTERRUPT_PRIORITY); - #define SEGGER_RTT_UNLOCK() OS_SetBASEPRI(LockState); \ + #define SEGGER_RTT_UNLOCK() _set_interrupt_priority(_SEGGER_RTT__LockState); \ } #endif #endif +/********************************************************************* +* +* RTT lock configuration for CCRX +*/ +#ifdef __RX + #include + #define SEGGER_RTT_LOCK() { \ + unsigned long _SEGGER_RTT__LockState; \ + _SEGGER_RTT__LockState = get_psw() & 0x010000; \ + clrpsw_i(); + + #define SEGGER_RTT_UNLOCK() set_psw(get_psw() | _SEGGER_RTT__LockState); \ + } +#endif + +/********************************************************************* +* +* RTT lock configuration for embOS Simulation on Windows +* (Can also be used for generic RTT locking with embOS) +*/ +#if defined(WIN32) || defined(SEGGER_RTT_LOCK_EMBOS) + +void OS_SIM_EnterCriticalSection(void); +void OS_SIM_LeaveCriticalSection(void); + +#define SEGGER_RTT_LOCK() { \ + OS_SIM_EnterCriticalSection(); + +#define SEGGER_RTT_UNLOCK() OS_SIM_LeaveCriticalSection(); \ + } +#endif + /********************************************************************* * * RTT lock configuration fallback */ #ifndef SEGGER_RTT_LOCK - void SEGGER_SYSVIEW_X_RTT_Lock(void); - #define SEGGER_RTT_LOCK() SEGGER_SYSVIEW_X_RTT_Lock() // Lock RTT (nestable) (i.e. disable interrupts) + #define SEGGER_RTT_LOCK() // Lock RTT (nestable) (i.e. disable interrupts) #endif #ifndef SEGGER_RTT_UNLOCK - void SEGGER_SYSVIEW_X_RTT_Unlock(void); - #define SEGGER_RTT_UNLOCK() SEGGER_SYSVIEW_X_RTT_Unlock() // Unlock RTT (nestable) (i.e. enable previous interrupt lock state) + #define SEGGER_RTT_UNLOCK() // Unlock RTT (nestable) (i.e. enable previous interrupt lock state) #endif #endif diff --git a/components/app_trace/sys_view/Config/SEGGER_SYSVIEW_Conf.h b/components/app_trace/sys_view/Config/SEGGER_SYSVIEW_Conf.h index d24753121586..0ff72730349c 100644 --- a/components/app_trace/sys_view/Config/SEGGER_SYSVIEW_Conf.h +++ b/components/app_trace/sys_view/Config/SEGGER_SYSVIEW_Conf.h @@ -1,14 +1,14 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +22,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,68 +47,30 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW_Conf.h -Purpose : SEGGER SystemView configuration. -Revision: $Rev: 5927 $ -*/ +Purpose : SEGGER SystemView configuration file. + Set defines which deviate from the defaults (see SEGGER_SYSVIEW_ConfDefaults.h) here. +Revision: $Rev: 21292 $ -#ifndef SEGGER_SYSVIEW_CONF_H -#define SEGGER_SYSVIEW_CONF_H - -#include "soc/soc.h" +Additional information: + Required defines which must be set are: + SEGGER_SYSVIEW_GET_TIMESTAMP + SEGGER_SYSVIEW_GET_INTERRUPT_ID + For known compilers and cores, these might be set to good defaults + in SEGGER_SYSVIEW_ConfDefaults.h. -/********************************************************************* -* -* Defines, fixed -* -********************************************************************** + SystemView needs a (nestable) locking mechanism. + If not defined, the RTT locking mechanism is used, + which then needs to be properly configured. */ -// -// Constants for known core configuration -// -#define SEGGER_SYSVIEW_CORE_OTHER 0 -#define SEGGER_SYSVIEW_CORE_CM0 1 // Cortex-M0/M0+/M1 -#define SEGGER_SYSVIEW_CORE_CM3 2 // Cortex-M3/M4/M7 -#define SEGGER_SYSVIEW_CORE_RX 3 // Renesas RX - -#if (defined __SES_ARM) || (defined __CROSSWORKS_ARM) || (defined __GNUC__) - #ifdef __ARM_ARCH_6M__ - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM0 - #elif (defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7EM__)) - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM3 - #endif -#elif defined(__ICCARM__) - #if (defined (__ARM6M__) && (__CORE__ == __ARM6M__)) - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM0 - #elif ((defined (__ARM7M__) && (__CORE__ == __ARM7M__)) || (defined (__ARM7EM__) && (__CORE__ == __ARM7EM__))) - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM3 - #endif -#elif defined(__CC_ARM) - #if (defined(__TARGET_ARCH_6S_M)) - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM0 - #elif (defined(__TARGET_ARCH_7_M) || defined(__TARGET_ARCH_7E_M)) - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM3 - #endif -#elif defined(__TI_ARM__) - #ifdef __TI_ARM_V6M0__ - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM0 - #elif (defined(__TI_ARM_V7M3__) || defined(__TI_ARM_V7M4__)) - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM3 - #endif -#elif defined(__ICCRX__) - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_RX -#elif defined(__RX) - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_RX -#endif -#ifndef SEGGER_SYSVIEW_CORE - #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_OTHER -#endif +#ifndef SEGGER_SYSVIEW_CONF_H +#define SEGGER_SYSVIEW_CONF_H /********************************************************************* * @@ -126,58 +78,12 @@ Revision: $Rev: 5927 $ * ********************************************************************** */ -/********************************************************************* -* -* SystemView buffer configuration -*/ -#define SEGGER_SYSVIEW_RTT_BUFFER_SIZE 1024 // Number of bytes that SystemView uses for the buffer. -#define SEGGER_SYSVIEW_RTT_CHANNEL 1 // The RTT channel that SystemView will use. 0: Auto selection - -#define SEGGER_SYSVIEW_USE_STATIC_BUFFER 1 // Use a static buffer to generate events instead of a buffer on the stack - -#define SEGGER_SYSVIEW_POST_MORTEM_MODE 0 // 1: Enable post mortem analysis mode - -/********************************************************************* -* -* SystemView timestamp configuration -*/ -#if SEGGER_SYSVIEW_CORE == SEGGER_SYSVIEW_CORE_CM3 - #define SEGGER_SYSVIEW_GET_TIMESTAMP() (*(U32 *)(0xE0001004)) // Retrieve a system timestamp. Cortex-M cycle counter. - #define SEGGER_SYSVIEW_TIMESTAMP_BITS 32 // Define number of valid bits low-order delivered by clock source -#else - #define SEGGER_SYSVIEW_GET_TIMESTAMP() SEGGER_SYSVIEW_X_GetTimestamp() // Retrieve a system timestamp via user-defined function - #define SEGGER_SYSVIEW_TIMESTAMP_BITS 32 // Define number of valid bits low-order delivered by SEGGER_SYSVIEW_X_GetTimestamp() -#endif /********************************************************************* -* -* SystemView Id configuration -*/ -//TODO: optimise it -#define SEGGER_SYSVIEW_ID_BASE SOC_DROM_LOW // Default value for the lowest Id reported by the application. Can be overridden by the application via SEGGER_SYSVIEW_SetRAMBase(). (i.e. 0x20000000 when all Ids are an address in this RAM) -#define SEGGER_SYSVIEW_ID_SHIFT 0 // Number of bits to shift the Id to save bandwidth. (i.e. 2 when Ids are 4 byte aligned) - -/********************************************************************* -* -* SystemView interrupt configuration +* TODO: Add your defines here. * +********************************************************************** */ -#if SEGGER_SYSVIEW_CORE == SEGGER_SYSVIEW_CORE_CM3 - #define SEGGER_SYSVIEW_GET_INTERRUPT_ID() ((*(U32 *)(0xE000ED04)) & 0x1FF) // Get the currently active interrupt Id. (i.e. read Cortex-M ICSR[8:0] = active vector) -#elif SEGGER_SYSVIEW_CORE == SEGGER_SYSVIEW_CORE_CM0 - #if defined(__ICCARM__) - #define SEGGER_SYSVIEW_GET_INTERRUPT_ID() (__get_IPSR()) // Workaround for IAR, which might do a byte-access to 0xE000ED04. Read IPSR instead. - #else - #define SEGGER_SYSVIEW_GET_INTERRUPT_ID() ((*(U32 *)(0xE000ED04)) & 0x3F) // Get the currently active interrupt Id. (i.e. read Cortex-M ICSR[5:0] = active vector) - #endif -#else - #define SEGGER_SYSVIEW_GET_INTERRUPT_ID() SEGGER_SYSVIEW_X_GetInterruptId() // Get the currently active interrupt Id from the user-provided function. -#endif -unsigned SEGGER_SYSVIEW_X_SysView_Lock(void); -void SEGGER_SYSVIEW_X_SysView_Unlock(unsigned int_state); -// to be recursive save IRQ status on the stack of the caller -#define SEGGER_SYSVIEW_LOCK() unsigned _SYSVIEW_int_state = SEGGER_SYSVIEW_X_SysView_Lock() -#define SEGGER_SYSVIEW_UNLOCK() SEGGER_SYSVIEW_X_SysView_Unlock(_SYSVIEW_int_state) #endif // SEGGER_SYSVIEW_CONF_H diff --git a/components/app_trace/sys_view/SEGGER/SEGGER.h b/components/app_trace/sys_view/SEGGER/SEGGER.h index e007b85a014f..bbabce812fc7 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER.h @@ -1,14 +1,16 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause + * + * SPDX-FileContributor: 2023 Espressif Systems (Shanghai) CO LTD */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +24,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,18 +49,20 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** ---------------------------------------------------------------------- File : SEGGER.h Purpose : Global types etc & general purpose utility functions +Revision: $Rev: 18102 $ ---------------------------END-OF-HEADER------------------------------ */ #ifndef SEGGER_H // Guard against multiple inclusion #define SEGGER_H +#include // For va_list. #include "Global.h" // Type definitions: U8, U16, U32, I8, I16, I32 #if defined(__cplusplus) @@ -83,18 +77,28 @@ extern "C" { /* Make sure we have C-declarations in C++ programs */ */ #ifndef INLINE - #ifdef _WIN32 + #if (defined(__ICCARM__) || defined(__RX) || defined(__ICCRX__)) // - // Microsoft VC6 and newer. - // Force inlining without cost checking. + // Other known compilers. // - #define INLINE __forceinline + #define INLINE inline #else - #if (defined(__ICCARM__) || defined(__CC_ARM) || defined(__GNUC__) || defined(__RX) || defined(__ICCRX__)) + #if (defined(_WIN32) && !defined(__clang__)) + // + // Microsoft VC6 and newer. + // Force inlining without cost checking. + // + #define INLINE __forceinline + #elif defined(__GNUC__) || defined(__clang__) + // + // Force inlining with GCC + clang + // + #define INLINE inline __attribute__((always_inline)) + #elif (defined(__CC_ARM)) // - // Other known compilers. + // Force inlining with ARMCC (Keil) // - #define INLINE inline + #define INLINE __inline #else // // Unknown compilers. @@ -115,6 +119,29 @@ extern "C" { /* Make sure we have C-declarations in C++ programs */ #define SEGGER_MIN(a,b) (((a) < (b)) ? (a) : (b)) #define SEGGER_MAX(a,b) (((a) > (b)) ? (a) : (b)) +#ifndef SEGGER_USE_PARA // Some compiler complain about unused parameters. + #define SEGGER_USE_PARA(Para) (void)Para // This works for most compilers. +#endif + +#define SEGGER_ADDR2PTR(Type, Addr) (/*lint -e(923) -e(9078)*/((Type*)((PTR_ADDR)(Addr)))) // Allow cast from address to pointer. +#define SEGGER_PTR2ADDR(p) (/*lint -e(923) -e(9078)*/((PTR_ADDR)(p))) // Allow cast from pointer to address. +#define SEGGER_PTR2PTR(Type, p) (/*lint -e(740) -e(826) -e(9079) -e(9087)*/((Type*)(p))) // Allow cast from one pointer type to another (ignore different size). +#define SEGGER_PTR_DISTANCE(p0, p1) (SEGGER_PTR2ADDR(p0) - SEGGER_PTR2ADDR(p1)) + +/********************************************************************* +* +* Defines +* +********************************************************************** +*/ + +#define SEGGER_PRINTF_FLAG_ADJLEFT (1 << 0) +#define SEGGER_PRINTF_FLAG_SIGNFORCE (1 << 1) +#define SEGGER_PRINTF_FLAG_SIGNSPACE (1 << 2) +#define SEGGER_PRINTF_FLAG_PRECEED (1 << 3) +#define SEGGER_PRINTF_FLAG_ZEROPAD (1 << 4) +#define SEGGER_PRINTF_FLAG_NEGATIVE (1 << 5) + /********************************************************************* * * Types @@ -123,18 +150,45 @@ extern "C" { /* Make sure we have C-declarations in C++ programs */ */ typedef struct { - char *pBuffer; + char* pBuffer; int BufferSize; int Cnt; } SEGGER_BUFFER_DESC; typedef struct { - int CacheLineSize; // 0: No Cache. Most Systems such as ARM9 use a 32 bytes cache line size. - void (*pfDMB) (void); // Optional DMB function for Data Memory Barrier to make sure all memory operations are completed. - void (*pfClean) (void *p, unsigned NumBytes); // Optional clean function for cached memory. - void (*pfInvalidate)(void *p, unsigned NumBytes); // Optional invalidate function for cached memory. + unsigned int CacheLineSize; // 0: No Cache. Most Systems such as ARM9 use a 32 bytes cache line size. + void (*pfDMB) (void); // Optional DMB function for Data Memory Barrier to make sure all memory operations are completed. + void (*pfClean) (void *p, unsigned long NumBytes); // Optional clean function for cached memory. + void (*pfInvalidate)(void *p, unsigned long NumBytes); // Optional invalidate function for cached memory. } SEGGER_CACHE_CONFIG; +typedef struct SEGGER_SNPRINTF_CONTEXT_struct SEGGER_SNPRINTF_CONTEXT; + +struct SEGGER_SNPRINTF_CONTEXT_struct { + void* pContext; // Application specific context. + SEGGER_BUFFER_DESC* pBufferDesc; // Buffer descriptor to use for output. + void (*pfFlush)(SEGGER_SNPRINTF_CONTEXT* pContext); // Callback executed once the buffer is full. Callback decides if the buffer gets cleared to store more or not. +}; + +typedef struct { + void (*pfStoreChar) (SEGGER_BUFFER_DESC* pBufferDesc, SEGGER_SNPRINTF_CONTEXT* pContext, char c); + int (*pfPrintUnsigned) (SEGGER_BUFFER_DESC* pBufferDesc, SEGGER_SNPRINTF_CONTEXT* pContext, U32 v, unsigned Base, char Flags, int Width, int Precision); + int (*pfPrintInt) (SEGGER_BUFFER_DESC* pBufferDesc, SEGGER_SNPRINTF_CONTEXT* pContext, I32 v, unsigned Base, char Flags, int Width, int Precision); +} SEGGER_PRINTF_API; + +typedef void (*SEGGER_pFormatter)(SEGGER_BUFFER_DESC* pBufferDesc, SEGGER_SNPRINTF_CONTEXT* pContext, const SEGGER_PRINTF_API* pApi, va_list* pParamList, char Lead, int Width, int Precision); + +typedef struct SEGGER_PRINTF_FORMATTER { + struct SEGGER_PRINTF_FORMATTER* pNext; // Pointer to next formatter. + SEGGER_pFormatter pfFormatter; // Formatter function. + char Specifier; // Format specifier. +} SEGGER_PRINTF_FORMATTER; + +typedef struct { + U32 (*pfGetHPTimestamp)(void); // Mandatory, pfGetHPTimestamp + int (*pfGetUID) (U8 abUID[16]); // Optional, pfGetUID +} SEGGER_BSP_API; + /********************************************************************* * * Utility functions @@ -142,14 +196,55 @@ typedef struct { ********************************************************************** */ -void SEGGER_ARM_memcpy (void *pDest, const void *pSrc, int NumBytes); -void SEGGER_memcpy (void *pDest, const void *pSrc, int NumBytes); -void SEGGER_memxor (void *pDest, const void *pSrc, unsigned NumBytes); -void SEGGER_StoreChar (SEGGER_BUFFER_DESC *p, char c); -void SEGGER_PrintUnsigned(SEGGER_BUFFER_DESC *pBufferDesc, U32 v, unsigned Base, int NumDigits); -void SEGGER_PrintInt (SEGGER_BUFFER_DESC *pBufferDesc, I32 v, unsigned Base, unsigned NumDigits); -int SEGGER_snprintf (char *pBuffer, int BufferSize, const char *sFormat, ...); - +// +// Memory operations. +// +void SEGGER_ARM_memcpy(void* pDest, const void* pSrc, int NumBytes); +void SEGGER_memcpy (void* pDest, const void* pSrc, unsigned NumBytes); +void SEGGER_memxor (void* pDest, const void* pSrc, unsigned NumBytes); + +// +// String functions. +// +int SEGGER_atoi (const char* s); +int SEGGER_isalnum (int c); +int SEGGER_isalpha (int c); +unsigned SEGGER_strlen (const char* s); +int SEGGER_tolower (int c); +int SEGGER_strcasecmp (const char* sText1, const char* sText2); +int SEGGER_strncasecmp(const char *sText1, const char *sText2, unsigned Count); + +// +// Buffer/printf related. +// +void SEGGER_StoreChar (SEGGER_BUFFER_DESC* pBufferDesc, char c); +void SEGGER_PrintUnsigned(SEGGER_BUFFER_DESC* pBufferDesc, U32 v, unsigned Base, int Precision); +void SEGGER_PrintInt (SEGGER_BUFFER_DESC* pBufferDesc, I32 v, unsigned Base, int Precision); +int SEGGER_snprintf (char* pBuffer, int BufferSize, const char* sFormat, ...); +int SEGGER_vsnprintf (char* pBuffer, int BufferSize, const char* sFormat, va_list ParamList); +int SEGGER_vsnprintfEx (SEGGER_SNPRINTF_CONTEXT* pContext, const char* sFormat, va_list ParamList); + +int SEGGER_PRINTF_AddFormatter (SEGGER_PRINTF_FORMATTER* pFormatter, SEGGER_pFormatter pfFormatter, char c); +void SEGGER_PRINTF_AddDoubleFormatter (void); +void SEGGER_PRINTF_AddIPFormatter (void); +void SEGGER_PRINTF_AddBLUEFormatter (void); +void SEGGER_PRINTF_AddCONNECTFormatter(void); +void SEGGER_PRINTF_AddSSLFormatter (void); +void SEGGER_PRINTF_AddSSHFormatter (void); +void SEGGER_PRINTF_AddHTMLFormatter (void); + +// +// BSP abstraction API. +// +int SEGGER_BSP_GetUID (U8 abUID[16]); +int SEGGER_BSP_GetUID32(U32* pUID); +void SEGGER_BSP_SetAPI (const SEGGER_BSP_API* pAPI); +void SEGGER_BSP_SeedUID (void); + +// +// Other API. +// +void SEGGER_VERSION_GetString(char acText[8], unsigned Version); #if defined(__cplusplus) } /* Make sure we have C-declarations in C++ programs */ diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_RTT.h b/components/app_trace/sys_view/SEGGER/SEGGER_RTT.h index 3e0fdf9af2b2..5d27d6984756 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_RTT.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER_RTT.h @@ -1,14 +1,14 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +22,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,7 +47,7 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** ---------------------------END-OF-HEADER------------------------------ @@ -65,14 +55,222 @@ File : SEGGER_RTT.h Purpose : Implementation of SEGGER real-time transfer which allows real-time communication on targets which support debugger memory accesses while the CPU is running. -Revision: $Rev: 5626 $ +Revision: $Rev: 25842 $ ---------------------------------------------------------------------- */ #ifndef SEGGER_RTT_H #define SEGGER_RTT_H -#include "SEGGER_RTT_Conf.h" +#include "../Config/SEGGER_RTT_Conf.h" + +/********************************************************************* +* +* Defines, defaults +* +********************************************************************** +*/ + +#ifndef RTT_USE_ASM + // + // Some cores support out-of-order memory accesses (reordering of memory accesses in the core) + // For such cores, we need to define a memory barrier to guarantee the order of certain accesses to the RTT ring buffers. + // Needed for: + // Cortex-M7 (ARMv7-M) + // Cortex-M23 (ARM-v8M) + // Cortex-M33 (ARM-v8M) + // Cortex-A/R (ARM-v7A/R) + // + // We do not explicitly check for "Embedded Studio" as the compiler in use determines what we support. + // You can use an external toolchain like IAR inside ES. So there is no point in checking for "Embedded Studio" + // + #if (defined __CROSSWORKS_ARM) // Rowley Crossworks + #define _CC_HAS_RTT_ASM_SUPPORT 1 + #if (defined __ARM_ARCH_7M__) // Cortex-M3 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #elif (defined __ARM_ARCH_7EM__) // Cortex-M4/M7 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #elif (defined __ARM_ARCH_8M_BASE__) // Cortex-M23 + #define _CORE_HAS_RTT_ASM_SUPPORT 0 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #elif (defined __ARM_ARCH_8M_MAIN__) // Cortex-M33 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #else + #define _CORE_HAS_RTT_ASM_SUPPORT 0 + #endif + #elif (defined __ARMCC_VERSION) + // + // ARM compiler + // ARM compiler V6.0 and later is clang based. + // Our ASM part is compatible to clang. + // + #if (__ARMCC_VERSION >= 6000000) + #define _CC_HAS_RTT_ASM_SUPPORT 1 + #else + #define _CC_HAS_RTT_ASM_SUPPORT 0 + #endif + #if (defined __ARM_ARCH_6M__) // Cortex-M0 / M1 + #define _CORE_HAS_RTT_ASM_SUPPORT 0 // No ASM support for this architecture + #elif (defined __ARM_ARCH_7M__) // Cortex-M3 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #elif (defined __ARM_ARCH_7EM__) // Cortex-M4/M7 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #elif (defined __ARM_ARCH_8M_BASE__) // Cortex-M23 + #define _CORE_HAS_RTT_ASM_SUPPORT 0 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #elif (defined __ARM_ARCH_8M_MAIN__) // Cortex-M33 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #elif ((defined __ARM_ARCH_7A__) || (defined __ARM_ARCH_7R__)) // Cortex-A/R 32-bit ARMv7-A/R + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #else + #define _CORE_HAS_RTT_ASM_SUPPORT 0 + #endif + #elif ((defined __GNUC__) || (defined __clang__)) + // + // GCC / Clang + // + #define _CC_HAS_RTT_ASM_SUPPORT 1 + // ARM 7/9: __ARM_ARCH_5__ / __ARM_ARCH_5E__ / __ARM_ARCH_5T__ / __ARM_ARCH_5T__ / __ARM_ARCH_5TE__ + #if (defined __ARM_ARCH_7M__) // Cortex-M3 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #elif (defined __ARM_ARCH_7EM__) // Cortex-M4/M7 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #define _CORE_NEEDS_DMB 1 // Only Cortex-M7 needs a DMB but we cannot distinguish M4 and M7 here... + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #elif (defined __ARM_ARCH_8M_BASE__) // Cortex-M23 + #define _CORE_HAS_RTT_ASM_SUPPORT 0 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #elif (defined __ARM_ARCH_8M_MAIN__) // Cortex-M33 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #elif ((defined __ARM_ARCH_7A__) || (defined __ARM_ARCH_7R__)) // Cortex-A/R 32-bit ARMv7-A/R + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() __asm volatile ("dmb\n" : : :); + #else + #define _CORE_HAS_RTT_ASM_SUPPORT 0 + #endif + #elif ((defined __IASMARM__) || (defined __ICCARM__)) + // + // IAR assembler/compiler + // + #define _CC_HAS_RTT_ASM_SUPPORT 1 + #if (__VER__ < 6300000) + #define VOLATILE + #else + #define VOLATILE volatile + #endif + #if (defined __ARM7M__) // Needed for old versions that do not know the define yet + #if (__CORE__ == __ARM7M__) // Cortex-M3 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #endif + #endif + #if (defined __ARM7EM__) + #if (__CORE__ == __ARM7EM__) // Cortex-M4/M7 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() asm VOLATILE ("DMB"); + #endif + #endif + #if (defined __ARM8M_BASELINE__) + #if (__CORE__ == __ARM8M_BASELINE__) // Cortex-M23 + #define _CORE_HAS_RTT_ASM_SUPPORT 0 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() asm VOLATILE ("DMB"); + #endif + #endif + #if (defined __ARM8M_MAINLINE__) + #if (__CORE__ == __ARM8M_MAINLINE__) // Cortex-M33 + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() asm VOLATILE ("DMB"); + #endif + #endif + #if (defined __ARM8EM_MAINLINE__) + #if (__CORE__ == __ARM8EM_MAINLINE__) // Cortex-??? + #define _CORE_HAS_RTT_ASM_SUPPORT 1 + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() asm VOLATILE ("DMB"); + #endif + #endif + #if (defined __ARM7A__) + #if (__CORE__ == __ARM7A__) // Cortex-A 32-bit ARMv7-A + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() asm VOLATILE ("DMB"); + #endif + #endif + #if (defined __ARM7R__) + #if (__CORE__ == __ARM7R__) // Cortex-R 32-bit ARMv7-R + #define _CORE_NEEDS_DMB 1 + #define RTT__DMB() asm VOLATILE ("DMB"); + #endif + #endif +// TBD: __ARM8A__ => Cortex-A 64-bit ARMv8-A +// TBD: __ARM8R__ => Cortex-R 64-bit ARMv8-R + #else + // + // Other compilers + // + #define _CC_HAS_RTT_ASM_SUPPORT 0 + #define _CORE_HAS_RTT_ASM_SUPPORT 0 + #endif + // + // If IDE and core support the ASM version, enable ASM version by default + // + #ifndef _CORE_HAS_RTT_ASM_SUPPORT + #define _CORE_HAS_RTT_ASM_SUPPORT 0 // Default for unknown cores + #endif + #if (_CC_HAS_RTT_ASM_SUPPORT && _CORE_HAS_RTT_ASM_SUPPORT) + #define RTT_USE_ASM (1) + #else + #define RTT_USE_ASM (0) + #endif +#endif + +#ifndef _CORE_NEEDS_DMB + #define _CORE_NEEDS_DMB 0 +#endif + +#ifndef RTT__DMB + #if _CORE_NEEDS_DMB + #error "Don't know how to place inline assembly for DMB" + #else + #define RTT__DMB() + #endif +#endif + +#ifndef SEGGER_RTT_CPU_CACHE_LINE_SIZE + #define SEGGER_RTT_CPU_CACHE_LINE_SIZE (0) // On most target systems where RTT is used, we do not have a CPU cache, therefore 0 is a good default here +#endif + +#ifndef SEGGER_RTT_UNCACHED_OFF + #if SEGGER_RTT_CPU_CACHE_LINE_SIZE + #error "SEGGER_RTT_UNCACHED_OFF must be defined when setting SEGGER_RTT_CPU_CACHE_LINE_SIZE != 0" + #else + #define SEGGER_RTT_UNCACHED_OFF (0) + #endif +#endif +#if RTT_USE_ASM + #if SEGGER_RTT_CPU_CACHE_LINE_SIZE + #error "RTT_USE_ASM is not available if SEGGER_RTT_CPU_CACHE_LINE_SIZE != 0" + #endif +#endif + +#ifndef SEGGER_RTT_ASM // defined when SEGGER_RTT.h is included from assembly file +#include +#include /********************************************************************* * @@ -81,6 +279,21 @@ Revision: $Rev: 5626 $ ********************************************************************** */ +// +// Determine how much we must pad the control block to make it a multiple of a cache line in size +// Assuming: U8 = 1B +// U16 = 2B +// U32 = 4B +// U8/U16/U32* = 4B +// +#if SEGGER_RTT_CPU_CACHE_LINE_SIZE // Avoid division by zero in case we do not have any cache + #define SEGGER_RTT__ROUND_UP_2_CACHE_LINE_SIZE(NumBytes) (((NumBytes + SEGGER_RTT_CPU_CACHE_LINE_SIZE - 1) / SEGGER_RTT_CPU_CACHE_LINE_SIZE) * SEGGER_RTT_CPU_CACHE_LINE_SIZE) +#else + #define SEGGER_RTT__ROUND_UP_2_CACHE_LINE_SIZE(NumBytes) (NumBytes) +#endif +#define SEGGER_RTT__CB_SIZE (16 + 4 + 4 + (SEGGER_RTT_MAX_NUM_UP_BUFFERS * 24) + (SEGGER_RTT_MAX_NUM_DOWN_BUFFERS * 24)) +#define SEGGER_RTT__CB_PADDING (SEGGER_RTT__ROUND_UP_2_CACHE_LINE_SIZE(SEGGER_RTT__CB_SIZE) - SEGGER_RTT__CB_SIZE) + /********************************************************************* * * Types @@ -98,7 +311,7 @@ typedef struct { unsigned SizeOfBuffer; // Buffer size in bytes. Note that one byte is lost, as this implementation does not fill up the buffer in order to avoid the problem of being unable to distinguish between full and empty. unsigned WrOff; // Position of next item to be written by either target. volatile unsigned RdOff; // Position of next item to be read by host. Must be volatile since it may be modified by host. - unsigned Flags; // Contains configuration flags + unsigned Flags; // Contains configuration flags. Flags[31:24] are used for validity check and must be zero. Flags[23:2] are reserved for future use. Flags[1:0] = RTT operating mode. } SEGGER_RTT_BUFFER_UP; // @@ -111,7 +324,7 @@ typedef struct { unsigned SizeOfBuffer; // Buffer size in bytes. Note that one byte is lost, as this implementation does not fill up the buffer in order to avoid the problem of being unable to distinguish between full and empty. volatile unsigned WrOff; // Position of next item to be written by host. Must be volatile since it may be modified by host. unsigned RdOff; // Position of next item to be read by target (down-buffer). - unsigned Flags; // Contains configuration flags + unsigned Flags; // Contains configuration flags. Flags[31:24] are used for validity check and must be zero. Flags[23:2] are reserved for future use. Flags[1:0] = RTT operating mode. } SEGGER_RTT_BUFFER_DOWN; // @@ -125,6 +338,9 @@ typedef struct { int MaxNumDownBuffers; // Initialized to SEGGER_RTT_MAX_NUM_DOWN_BUFFERS (type. 2) SEGGER_RTT_BUFFER_UP aUp[SEGGER_RTT_MAX_NUM_UP_BUFFERS]; // Up buffers, transferring information up from target via debug probe to host SEGGER_RTT_BUFFER_DOWN aDown[SEGGER_RTT_MAX_NUM_DOWN_BUFFERS]; // Down buffers, transferring information down from host via debug probe to target +#if SEGGER_RTT__CB_PADDING + unsigned char aDummy[SEGGER_RTT__CB_PADDING]; +#endif } SEGGER_RTT_CB; /********************************************************************* @@ -151,6 +367,7 @@ int SEGGER_RTT_ConfigDownBuffer (unsigned BufferIndex, const cha int SEGGER_RTT_GetKey (void); unsigned SEGGER_RTT_HasData (unsigned BufferIndex); int SEGGER_RTT_HasKey (void); +unsigned SEGGER_RTT_HasDataUp (unsigned BufferIndex); void SEGGER_RTT_Init (void); unsigned SEGGER_RTT_Read (unsigned BufferIndex, void* pBuffer, unsigned BufferSize); unsigned SEGGER_RTT_ReadNoLock (unsigned BufferIndex, void* pData, unsigned BufferSize); @@ -162,10 +379,17 @@ int SEGGER_RTT_WaitKey (void); unsigned SEGGER_RTT_Write (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes); unsigned SEGGER_RTT_WriteNoLock (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes); unsigned SEGGER_RTT_WriteSkipNoLock (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes); +unsigned SEGGER_RTT_ASM_WriteSkipNoLock (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes); unsigned SEGGER_RTT_WriteString (unsigned BufferIndex, const char* s); void SEGGER_RTT_WriteWithOverwriteNoLock(unsigned BufferIndex, const void* pBuffer, unsigned NumBytes); -void SEGGER_RTT_ESP_FlushNoLock (unsigned long min_sz, unsigned long tmo); -void SEGGER_RTT_ESP_Flush (unsigned long min_sz, unsigned long tmo); +unsigned SEGGER_RTT_PutChar (unsigned BufferIndex, char c); +unsigned SEGGER_RTT_PutCharSkip (unsigned BufferIndex, char c); +unsigned SEGGER_RTT_PutCharSkipNoLock (unsigned BufferIndex, char c); +unsigned SEGGER_RTT_GetAvailWriteSpace (unsigned BufferIndex); +unsigned SEGGER_RTT_GetBytesInBuffer (unsigned BufferIndex); + +void SEGGER_RTT_ESP_FlushNoLock (unsigned long min_sz, unsigned long tmo); +void SEGGER_RTT_ESP_Flush (unsigned long min_sz, unsigned long tmo); // // Function macro for performance optimization // @@ -173,14 +397,31 @@ void SEGGER_RTT_ESP_Flush (unsigned long min_sz, unsigned lo // For ESP32 we use our own implementation of RTT, so this macro should not check SEGGER's RTT buffer state. #define SEGGER_RTT_HASDATA(n) (1) +#if RTT_USE_ASM + #define SEGGER_RTT_WriteSkipNoLock SEGGER_RTT_ASM_WriteSkipNoLock +#endif + +/********************************************************************* +* +* RTT transfer functions to send RTT data via other channels. +* +********************************************************************** +*/ +unsigned SEGGER_RTT_ReadUpBuffer (unsigned BufferIndex, void* pBuffer, unsigned BufferSize); +unsigned SEGGER_RTT_ReadUpBufferNoLock (unsigned BufferIndex, void* pData, unsigned BufferSize); +unsigned SEGGER_RTT_WriteDownBuffer (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes); +unsigned SEGGER_RTT_WriteDownBufferNoLock (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes); + +#define SEGGER_RTT_HASDATA_UP(n) (((SEGGER_RTT_BUFFER_UP*)((char*)&_SEGGER_RTT.aUp[n] + SEGGER_RTT_UNCACHED_OFF))->WrOff - ((SEGGER_RTT_BUFFER_UP*)((char*)&_SEGGER_RTT.aUp[n] + SEGGER_RTT_UNCACHED_OFF))->RdOff) // Access uncached to make sure we see changes made by the J-Link side and all of our changes go into HW directly + /********************************************************************* * * RTT "Terminal" API functions * ********************************************************************** */ -int SEGGER_RTT_SetTerminal (char TerminalId); -int SEGGER_RTT_TerminalOut (char TerminalId, const char* s); +int SEGGER_RTT_SetTerminal (unsigned char TerminalId); +int SEGGER_RTT_TerminalOut (unsigned char TerminalId, const char* s); /********************************************************************* * @@ -189,10 +430,14 @@ int SEGGER_RTT_TerminalOut (char TerminalId, const char* s); ********************************************************************** */ int SEGGER_RTT_printf(unsigned BufferIndex, const char * sFormat, ...); +int SEGGER_RTT_vprintf(unsigned BufferIndex, const char * sFormat, va_list * pParamList); + #ifdef __cplusplus } #endif +#endif // ifndef(SEGGER_RTT_ASM) + /********************************************************************* * * Defines @@ -203,53 +448,53 @@ int SEGGER_RTT_printf(unsigned BufferIndex, const char * sFormat, ...); // // Operating modes. Define behavior if buffer is full (not enough space for entire message) // -#define SEGGER_RTT_MODE_NO_BLOCK_SKIP (0U) // Skip. Do not block, output nothing. (Default) -#define SEGGER_RTT_MODE_NO_BLOCK_TRIM (1U) // Trim: Do not block, output as much as fits. -#define SEGGER_RTT_MODE_BLOCK_IF_FIFO_FULL (2U) // Block: Wait until there is space in the buffer. -#define SEGGER_RTT_MODE_MASK (3U) +#define SEGGER_RTT_MODE_NO_BLOCK_SKIP (0) // Skip. Do not block, output nothing. (Default) +#define SEGGER_RTT_MODE_NO_BLOCK_TRIM (1) // Trim: Do not block, output as much as fits. +#define SEGGER_RTT_MODE_BLOCK_IF_FIFO_FULL (2) // Block: Wait until there is space in the buffer. +#define SEGGER_RTT_MODE_MASK (3) // // Control sequences, based on ANSI. // Can be used to control color, and clear the screen // -#define RTT_CTRL_RESET "" // Reset to default colors -#define RTT_CTRL_CLEAR "" // Clear screen, reposition cursor to top left - -#define RTT_CTRL_TEXT_BLACK "" -#define RTT_CTRL_TEXT_RED "" -#define RTT_CTRL_TEXT_GREEN "" -#define RTT_CTRL_TEXT_YELLOW "" -#define RTT_CTRL_TEXT_BLUE "" -#define RTT_CTRL_TEXT_MAGENTA "" -#define RTT_CTRL_TEXT_CYAN "" -#define RTT_CTRL_TEXT_WHITE "" - -#define RTT_CTRL_TEXT_BRIGHT_BLACK "" -#define RTT_CTRL_TEXT_BRIGHT_RED "" -#define RTT_CTRL_TEXT_BRIGHT_GREEN "" -#define RTT_CTRL_TEXT_BRIGHT_YELLOW "" -#define RTT_CTRL_TEXT_BRIGHT_BLUE "" -#define RTT_CTRL_TEXT_BRIGHT_MAGENTA "" -#define RTT_CTRL_TEXT_BRIGHT_CYAN "" -#define RTT_CTRL_TEXT_BRIGHT_WHITE "" - -#define RTT_CTRL_BG_BLACK "" -#define RTT_CTRL_BG_RED "" -#define RTT_CTRL_BG_GREEN "" -#define RTT_CTRL_BG_YELLOW "" -#define RTT_CTRL_BG_BLUE "" -#define RTT_CTRL_BG_MAGENTA "" -#define RTT_CTRL_BG_CYAN "" -#define RTT_CTRL_BG_WHITE "" - -#define RTT_CTRL_BG_BRIGHT_BLACK "" -#define RTT_CTRL_BG_BRIGHT_RED "" -#define RTT_CTRL_BG_BRIGHT_GREEN "" -#define RTT_CTRL_BG_BRIGHT_YELLOW "" -#define RTT_CTRL_BG_BRIGHT_BLUE "" -#define RTT_CTRL_BG_BRIGHT_MAGENTA "" -#define RTT_CTRL_BG_BRIGHT_CYAN "" -#define RTT_CTRL_BG_BRIGHT_WHITE "" +#define RTT_CTRL_RESET "\x1B[0m" // Reset to default colors +#define RTT_CTRL_CLEAR "\x1B[2J" // Clear screen, reposition cursor to top left + +#define RTT_CTRL_TEXT_BLACK "\x1B[2;30m" +#define RTT_CTRL_TEXT_RED "\x1B[2;31m" +#define RTT_CTRL_TEXT_GREEN "\x1B[2;32m" +#define RTT_CTRL_TEXT_YELLOW "\x1B[2;33m" +#define RTT_CTRL_TEXT_BLUE "\x1B[2;34m" +#define RTT_CTRL_TEXT_MAGENTA "\x1B[2;35m" +#define RTT_CTRL_TEXT_CYAN "\x1B[2;36m" +#define RTT_CTRL_TEXT_WHITE "\x1B[2;37m" + +#define RTT_CTRL_TEXT_BRIGHT_BLACK "\x1B[1;30m" +#define RTT_CTRL_TEXT_BRIGHT_RED "\x1B[1;31m" +#define RTT_CTRL_TEXT_BRIGHT_GREEN "\x1B[1;32m" +#define RTT_CTRL_TEXT_BRIGHT_YELLOW "\x1B[1;33m" +#define RTT_CTRL_TEXT_BRIGHT_BLUE "\x1B[1;34m" +#define RTT_CTRL_TEXT_BRIGHT_MAGENTA "\x1B[1;35m" +#define RTT_CTRL_TEXT_BRIGHT_CYAN "\x1B[1;36m" +#define RTT_CTRL_TEXT_BRIGHT_WHITE "\x1B[1;37m" + +#define RTT_CTRL_BG_BLACK "\x1B[24;40m" +#define RTT_CTRL_BG_RED "\x1B[24;41m" +#define RTT_CTRL_BG_GREEN "\x1B[24;42m" +#define RTT_CTRL_BG_YELLOW "\x1B[24;43m" +#define RTT_CTRL_BG_BLUE "\x1B[24;44m" +#define RTT_CTRL_BG_MAGENTA "\x1B[24;45m" +#define RTT_CTRL_BG_CYAN "\x1B[24;46m" +#define RTT_CTRL_BG_WHITE "\x1B[24;47m" + +#define RTT_CTRL_BG_BRIGHT_BLACK "\x1B[4;40m" +#define RTT_CTRL_BG_BRIGHT_RED "\x1B[4;41m" +#define RTT_CTRL_BG_BRIGHT_GREEN "\x1B[4;42m" +#define RTT_CTRL_BG_BRIGHT_YELLOW "\x1B[4;43m" +#define RTT_CTRL_BG_BRIGHT_BLUE "\x1B[4;44m" +#define RTT_CTRL_BG_BRIGHT_MAGENTA "\x1B[4;45m" +#define RTT_CTRL_BG_BRIGHT_CYAN "\x1B[4;46m" +#define RTT_CTRL_BG_BRIGHT_WHITE "\x1B[4;47m" #endif diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.c b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.c index a6659929eb49..669c7b54519f 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.c +++ b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.c @@ -1,14 +1,16 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause + * + * SPDX-FileContributor: 2023 Espressif Systems (Shanghai) CO LTD */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +24,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,14 +49,14 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW.c Purpose : System visualization API implementation. -Revision: $Rev: 5927 $ +Revision: $Rev: 26232 $ Additional information: Packet format: @@ -74,13 +66,16 @@ Additional information: Packets with IDs 24..31 are standard packets with extendible structure and contain a length field. - + + + Packet ID 31 is used for SystemView extended events. + Packets with IDs >= 32 always contain a length field. Packet IDs: - 0.. 31 : Standard packets, known by SystemViewer. + 0.. 31 : Standard packets, known by SystemView. 32..1023 : OS-definable packets, described in a SystemView description file. 1024..2047 : User-definable packets, described in a SystemView description file. 2048..32767: Undefined. @@ -150,11 +145,13 @@ Additional information: ********************************************************************** */ -#include "SEGGER_SYSVIEW_Int.h" -#include "SEGGER_RTT.h" +#define SEGGER_SYSVIEW_C // For EXTERN statements in SEGGER_SYSVIEW.h + #include #include #include +#include "SEGGER_SYSVIEW_Int.h" +#include "SEGGER_RTT.h" /********************************************************************* * @@ -176,6 +173,12 @@ Additional information: #define CHANNEL_ID_DOWN _SYSVIEW_Globals.DownChannel #endif +#if SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE + #if (SEGGER_SYSVIEW_RTT_BUFFER_SIZE % SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE) + #error "SEGGER_SYSVIEW_RTT_BUFFER_SIZE must be a multiple of SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE" + #endif +#endif + /********************************************************************* * * Defines, configurable @@ -194,6 +197,17 @@ Additional information: #define MAKE_DELTA_32BIT(Delta) #endif +#if SEGGER_SYSVIEW_SUPPORT_LONG_ID + #define _MAX_ID_BYTES 5u +#else + #define _MAX_ID_BYTES 2u +#endif + +#if SEGGER_SYSVIEW_SUPPORT_LONG_DATA + #define _MAX_DATA_BYTES 5u +#else + #define _MAX_DATA_BYTES 2u +#endif /********************************************************************* * @@ -261,33 +275,92 @@ static void _SendPacket(U8* pStartPacket, U8* pEndPacket, unsigned int EventId); */ static const U8 _abSync[10] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; -#ifdef SEGGER_SYSVIEW_SECTION - #if (defined __GNUC__) - __attribute__ ((section (SEGGER_SYSVIEW_SECTION))) static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; - #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) - __attribute__ ((section (SEGGER_SYSVIEW_SECTION))) static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms - #endif - #elif (defined __ICCARM__) || (defined __ICCRX__) - #pragma location=SEGGER_SYSVIEW_SECTION - static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; - #pragma location=SEGGER_SYSVIEW_SECTION - static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms - #elif (defined __CC_ARM) - __attribute__ ((section (SEGGER_SYSVIEW_SECTION), zero_init)) static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; - #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) - __attribute__ ((section (SEGGER_SYSVIEW_SECTION), zero_init)) static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms +#if SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE + #ifdef SEGGER_SYSVIEW_SECTION + // + // Alignment + special section required + // + #if (defined __GNUC__) + __attribute__ ((section (SEGGER_SYSVIEW_SECTION), aligned (SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE))) static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; + #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + __attribute__ ((section (SEGGER_SYSVIEW_SECTION), aligned (SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE))) static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + #endif + #elif (defined __ICCARM__) || (defined __ICCRX__) + #pragma location=SEGGER_SYSVIEW_SECTION + #pragma data_alignment=SEGGER_RTT_CPU_CACHE_LINE_SIZE + static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; + #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + #pragma location=SEGGER_SYSVIEW_SECTION + #pragma data_alignment=SEGGER_RTT_CPU_CACHE_LINE_SIZE + static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + #endif + #elif (defined __CC_ARM) + __attribute__ ((section (SEGGER_SYSVIEW_SECTION), aligned (SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE), zero_init)) static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; + #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + __attribute__ ((section (SEGGER_SYSVIEW_SECTION), aligned (SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE), zero_init)) static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + #endif + #else + #error "Do not know how to place SystemView buffers in specific section" #endif #else - static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; - #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) - static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + // + // Only alignment required + // + #if (defined __GNUC__) + __attribute__ ((aligned (SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE))) static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; + #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + __attribute__ ((aligned (SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE))) static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + #endif + #elif (defined __ICCARM__) || (defined __ICCRX__) + #pragma data_alignment=SEGGER_RTT_CPU_CACHE_LINE_SIZE + static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; + #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + #pragma data_alignment=SEGGER_RTT_CPU_CACHE_LINE_SIZE + static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + #endif + #elif (defined __CC_ARM) + __attribute__ ((aligned (SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE), zero_init)) static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; + #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + __attribute__ ((aligned (SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE), zero_init)) static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + #endif + #else + #error "Do not know how to align SystemView buffers to cache line size" #endif #endif #else + #ifdef SEGGER_SYSVIEW_SECTION + // + // Only special section required + // + #if (defined __GNUC__) + __attribute__ ((section (SEGGER_SYSVIEW_SECTION))) static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; + #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + __attribute__ ((section (SEGGER_SYSVIEW_SECTION))) static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + #endif + #elif (defined __ICCARM__) || (defined __ICCRX__) + #pragma location=SEGGER_SYSVIEW_SECTION + static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; + #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + #pragma location=SEGGER_SYSVIEW_SECTION + static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + #endif + #elif (defined __CC_ARM) + __attribute__ ((section (SEGGER_SYSVIEW_SECTION), zero_init)) static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; + #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + __attribute__ ((section (SEGGER_SYSVIEW_SECTION), zero_init)) static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + #endif + #else + #error "Do not know how to place SystemView buffers in specific section" + #endif + #else + // + // Neither special section nor alignment required + // static char _UpBuffer [SEGGER_SYSVIEW_RTT_BUFFER_SIZE]; #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) - static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms + static char _DownBuffer[8]; // Small, fixed-size buffer, for back-channel comms #endif + #endif #endif static SEGGER_SYSVIEW_GLOBALS _SYSVIEW_Globals; @@ -357,12 +430,23 @@ static U8 _aPacket[SEGGER_SYSVIEW_MAX_PACKET_SIZE]; * Make sure NumBytes + 1 bytes are free for the payload. */ static U8* _EncodeData(U8* pPayload, const char* pSrc, unsigned int NumBytes) { - unsigned int n; + unsigned int n; + const U8* p; // n = 0; - *pPayload++ = NumBytes; + p = (const U8*)pSrc; + // + // Write Len + // + if (NumBytes < 255) { + *pPayload++ = (U8)NumBytes; + } else { + *pPayload++ = 255; + *pPayload++ = (NumBytes & 255); + *pPayload++ = ((NumBytes >> 8) & 255); + } while (n < NumBytes) { - *pPayload++ = *pSrc++; + *pPayload++ = *p++; n++; } return pPayload; @@ -397,17 +481,19 @@ static U8 *_EncodeStr(U8 *pPayload, const char *pText, unsigned int Limit) { // Compute string len // Len = 0; - while(*(pText + Len) != 0) { - Len++; - } - if (Len > Limit) { - Len = Limit; + if (pText != NULL) { + while(*(pText + Len) != 0) { + Len++; + } + if (Len > Limit) { + Len = Limit; + } } // // Write Len // if (Len < 255) { - *pPayload++ = Len; + *pPayload++ = (U8)Len; } else { *pPayload++ = 255; *pPayload++ = (Len & 255); @@ -443,7 +529,7 @@ static U8 *_EncodeStr(U8 *pPayload, const char *pText, unsigned int Limit) { * computed and filled in by the sending function. */ static U8* _PreparePacket(U8* pPacket) { - return pPacket + 4; + return pPacket + _MAX_ID_BYTES + _MAX_DATA_BYTES; } /********************************************************************* @@ -461,7 +547,7 @@ static U8* _PreparePacket(U8* pPacket) { #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) static void _HandleIncomingPacket(void) { U8 Cmd; - int Status; + unsigned int Status; // Status = SEGGER_RTT_ReadNoLock(CHANNEL_ID_DOWN, &Cmd, 1); if (Status > 0) { @@ -493,6 +579,8 @@ static void _HandleIncomingPacket(void) { SEGGER_SYSVIEW_SendModule(Cmd); } break; + case SEGGER_SYSVIEW_COMMAND_ID_HEARTBEAT: + break; default: if (Cmd >= 128) { // Unknown extended command. Dummy read its parameter. SEGGER_RTT_ReadNoLock(CHANNEL_ID_DOWN, &Cmd, 1); @@ -544,7 +632,8 @@ static int _TrySendOverflowPacket(void) { // // Try to store packet in RTT buffer and update time stamp when this was successful // - Status = SEGGER_RTT_WriteSkipNoLock(CHANNEL_ID_UP, aPacket, pPayload - aPacket); + Status = (int)SEGGER_RTT_WriteSkipNoLock(CHANNEL_ID_UP, aPacket, (unsigned int)(pPayload - aPacket)); + SEGGER_SYSVIEW_ON_EVENT_RECORDED(pPayload - aPacket); if (Status) { _SYSVIEW_Globals.LastTxTimeStamp = TimeStamp; _SYSVIEW_Globals.EnableState--; // EnableState has been 2, will be 1. Always. @@ -578,6 +667,7 @@ static void _SendSyncInfo(void) { // Send module information // SEGGER_RTT_WriteWithOverwriteNoLock(CHANNEL_ID_UP, _abSync, 10); + SEGGER_SYSVIEW_ON_EVENT_RECORDED(10); SEGGER_SYSVIEW_RecordVoid(SYSVIEW_EVTID_TRACE_START); { U8* pPayload; @@ -598,8 +688,9 @@ static void _SendSyncInfo(void) { SEGGER_SYSVIEW_RecordSystime(); SEGGER_SYSVIEW_SendTaskList(); if (_NumModules > 0) { + int n; SEGGER_SYSVIEW_SendNumModules(); - for (int n = 0; n < _NumModules; n++) { + for (n = 0; n < _NumModules; n++) { SEGGER_SYSVIEW_SendModule(n); } SEGGER_SYSVIEW_SendModuleDescription(); @@ -631,7 +722,7 @@ static void _SendPacket(U8* pStartPacket, U8* pEndPacket, unsigned int EventId) U32 TimeStamp; U32 Delta; #if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) - int Status; + unsigned int Status; #endif #if (SEGGER_SYSVIEW_USE_STATIC_BUFFER == 0) @@ -676,21 +767,86 @@ static void _SendPacket(U8* pStartPacket, U8* pEndPacket, unsigned int EventId) // otherwise prepend packet length and eventId. // if (EventId < 24) { - *--pStartPacket = EventId; + *--pStartPacket = (U8)EventId; } else { - NumBytes = pEndPacket - pStartPacket; + // + // Get data length and prepend it. + // + NumBytes = (unsigned int)(pEndPacket - pStartPacket); +#if SEGGER_SYSVIEW_SUPPORT_LONG_DATA + if (NumBytes < 127) { + #error "Seems EventId should be changed to NumBytes in the next line. Please check." + *--pStartPacket = EventId; + } else { + // + // Backwards U32 encode EventId. + // + if (NumBytes < (1u << 14)) { // Encodes in 2 bytes + *--pStartPacket = (U8)(NumBytes >> 7); + *--pStartPacket = (U8)(NumBytes | 0x80); + } else if (NumBytes < (1u << 21)) { // Encodes in 3 bytes + *--pStartPacket = (U8)(NumBytes >> 14); + *--pStartPacket = (U8)((NumBytes >> 7) | 0x80); + *--pStartPacket = (U8)(NumBytes | 0x80); + } else if (NumBytes < (1u << 28)) { // Encodes in 4 bytes + *--pStartPacket = (U8)(NumBytes >> 21); + *--pStartPacket = (U8)((NumBytes >> 14) | 0x80); + *--pStartPacket = (U8)((NumBytes >> 7) | 0x80); + *--pStartPacket = (U8)(NumBytes | 0x80); + } else { // Encodes in 5 bytes + *--pStartPacket = (U8)(NumBytes >> 28); + *--pStartPacket = (U8)((NumBytes >> 21) | 0x80); + *--pStartPacket = (U8)((NumBytes >> 14) | 0x80); + *--pStartPacket = (U8)((NumBytes >> 7) | 0x80); + *--pStartPacket = (U8)(NumBytes | 0x80); + } + } +#else if (NumBytes > 127) { - *--pStartPacket = (NumBytes >> 7); - *--pStartPacket = NumBytes | 0x80; + *--pStartPacket = (U8)(NumBytes >> 7); + *--pStartPacket = (U8)(NumBytes | 0x80); } else { - *--pStartPacket = NumBytes; + *--pStartPacket = (U8)NumBytes; } +#endif + // + // Prepend EventId. + // +#if SEGGER_SYSVIEW_SUPPORT_LONG_ID + if (EventId < 127) { + *--pStartPacket = (U8)EventId; + } else { + // + // Backwards U32 encode EventId. + // + if (EventId < (1u << 14)) { // Encodes in 2 bytes + *--pStartPacket = (U8)(EventId >> 7); + *--pStartPacket = (U8)(EventId | 0x80); + } else if (EventId < (1u << 21)) { // Encodes in 3 bytes + *--pStartPacket = (U8)(EventId >> 14); + *--pStartPacket = (U8)((EventId >> 7) | 0x80); + *--pStartPacket = (U8)(EventId | 0x80); + } else if (EventId < (1u << 28)) { // Encodes in 4 bytes + *--pStartPacket = (U8)(EventId >> 21); + *--pStartPacket = (U8)((EventId >> 14) | 0x80); + *--pStartPacket = (U8)((EventId >> 7) | 0x80); + *--pStartPacket = (U8)(EventId | 0x80); + } else { // Encodes in 5 bytes + *--pStartPacket = (U8)(EventId >> 28); + *--pStartPacket = (U8)((EventId >> 21) | 0x80); + *--pStartPacket = (U8)((EventId >> 14) | 0x80); + *--pStartPacket = (U8)((EventId >> 7) | 0x80); + *--pStartPacket = (U8)(EventId | 0x80); + } + } +#else if (EventId > 127) { - *--pStartPacket = (EventId >> 7); - *--pStartPacket = EventId | 0x80; + *--pStartPacket = (U8)(EventId >> 7); + *--pStartPacket = (U8)(EventId | 0x80); } else { - *--pStartPacket = EventId; + *--pStartPacket = (U8)EventId; } +#endif } // // Compute time stamp delta and append it to packet. @@ -704,12 +860,14 @@ static void _SendPacket(U8* pStartPacket, U8* pEndPacket, unsigned int EventId) // Store packet in RTT buffer by overwriting old data and update time stamp // SEGGER_RTT_WriteWithOverwriteNoLock(CHANNEL_ID_UP, pStartPacket, pEndPacket - pStartPacket); + SEGGER_SYSVIEW_ON_EVENT_RECORDED(pEndPacket - pStartPacket); _SYSVIEW_Globals.LastTxTimeStamp = TimeStamp; #else // // Try to store packet in RTT buffer and update time stamp when this was successful // - Status = SEGGER_RTT_WriteSkipNoLock(CHANNEL_ID_UP, pStartPacket, pEndPacket - pStartPacket); + Status = SEGGER_RTT_WriteSkipNoLock(CHANNEL_ID_UP, pStartPacket, (unsigned int)(pEndPacket - pStartPacket)); + SEGGER_SYSVIEW_ON_EVENT_RECORDED(pEndPacket - pStartPacket); if (Status) { _SYSVIEW_Globals.LastTxTimeStamp = TimeStamp; } else { @@ -753,63 +911,85 @@ static void _SendPacket(U8* pStartPacket, U8* pEndPacket, unsigned int EventId) } #ifndef SEGGER_SYSVIEW_EXCLUDE_PRINTF // Define in project to avoid warnings about variable parameter list -/********************************************************************* -* -* _APrintHost() -* -* Function description -* Prepares a string and its parameters to be formatted on the host. -* -* Parameters -* s Pointer to format string. -* Options Options to be sent to the host. -* pArguments Pointer to array of arguments for the format string. -* NumArguments Number of arguments in the array. -*/ -static void _APrintHost(const char* s, U32 Options, U32* pArguments, U32 NumArguments) { - U8* pPayload; - U8* pPayloadStart; - - RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + SEGGER_SYSVIEW_MAX_STRING_LEN + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_ARGUMENTS * SEGGER_SYSVIEW_QUANTA_U32); - pPayload = _EncodeStr(pPayloadStart, s, SEGGER_SYSVIEW_MAX_STRING_LEN); - ENCODE_U32(pPayload, Options); - ENCODE_U32(pPayload, NumArguments); - while (NumArguments--) { - ENCODE_U32(pPayload, (*pArguments++)); - } - _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_PRINT_FORMATTED); - RECORD_END(); -} - /********************************************************************* * * _VPrintHost() * * Function description -* Prepares a string and its parameters to be formatted on the host. +* Send a format string and its parameters to the host. * * Parameters * s Pointer to format string. * Options Options to be sent to the host. * pParamList Pointer to the list of arguments for the format string. */ -static void _VPrintHost(const char* s, U32 Options, va_list* pParamList) { - U32 aParas[SEGGER_SYSVIEW_MAX_ARGUMENTS]; - U32 NumArguments; +static int _VPrintHost(const char* s, U32 Options, va_list* pParamList) { + U32 aParas[SEGGER_SYSVIEW_MAX_ARGUMENTS]; + U32* pParas; + U32 NumArguments; const char* p; + char c; + U8* pPayload; + U8* pPayloadStart; +#if SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT + U8 HasNonScalar; + HasNonScalar = 0; +#endif + // + // Count number of arguments by counting '%' characters in string. + // If enabled, check for non-scalar modifier flags to format string on the target. + // p = s; NumArguments = 0; - while (*p) { - if (*p == '%') { - aParas[NumArguments++] = va_arg(*pParamList, int); + for (;;) { + c = *p++; + if (c == 0) { + break; + } + if (c == '%') { + c = *p; +#if SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT == 0 + aParas[NumArguments++] = (U32)(va_arg(*pParamList, int)); if (NumArguments == SEGGER_SYSVIEW_MAX_ARGUMENTS) { break; } +#else + if (c == 's') { + HasNonScalar = 1; + break; + } else { + aParas[NumArguments++] = (U32)(va_arg(*pParamList, int)); + if (NumArguments == SEGGER_SYSVIEW_MAX_ARGUMENTS) { + break; + } + } +#endif } - p++; } - _APrintHost(s, Options, aParas, NumArguments); + +#if SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT + if (HasNonScalar) { + return -1; + } +#endif + // + // Send string and parameters to host + // + { + RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + SEGGER_SYSVIEW_MAX_STRING_LEN + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_ARGUMENTS * SEGGER_SYSVIEW_QUANTA_U32); + pPayload = _EncodeStr(pPayloadStart, s, SEGGER_SYSVIEW_MAX_STRING_LEN); + ENCODE_U32(pPayload, Options); + ENCODE_U32(pPayload, NumArguments); + pParas = aParas; + while (NumArguments--) { + ENCODE_U32(pPayload, (*pParas)); + pParas++; + } + _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_PRINT_FORMATTED); + RECORD_END(); + } + return 0; } /********************************************************************* @@ -831,14 +1011,14 @@ static void _StoreChar(SEGGER_SYSVIEW_PRINTF_DESC * p, char c) { Cnt = p->Cnt; if ((Cnt + 1u) <= SEGGER_SYSVIEW_MAX_STRING_LEN) { - *(p->pPayload++) = c; + *(p->pPayload++) = (U8)c; p->Cnt = Cnt + 1u; } // // Write part of string, when the buffer is full // if (p->Cnt == SEGGER_SYSVIEW_MAX_STRING_LEN) { - *(p->pPayloadStart) = p->Cnt; + *(p->pPayloadStart) = (U8)p->Cnt; pPayload = p->pPayload; Options = p->Options; ENCODE_U32(pPayload, Options); @@ -1162,7 +1342,7 @@ static void _VPrintTarget(const char* sFormat, U32 Options, va_list* pParamList) // Write remaining data, if any // if (BufferDesc.Cnt != 0u) { - *(BufferDesc.pPayloadStart) = BufferDesc.Cnt; + *(BufferDesc.pPayloadStart) = (U8)BufferDesc.Cnt; ENCODE_U32(BufferDesc.pPayload, BufferDesc.Options); ENCODE_U32(BufferDesc.pPayload, 0); _SendPacket(BufferDesc.pPayloadStart, BufferDesc.pPayload, SYSVIEW_EVTID_PRINT_FORMATTED); @@ -1178,7 +1358,7 @@ static void _VPrintTarget(const char* sFormat, U32 Options, va_list* pParamList) /********************************************************************* * -* Public functions +* Public code * ********************************************************************** */ @@ -1189,13 +1369,14 @@ static void _VPrintTarget(const char* sFormat, U32 Options, va_list* pParamList) * * Function description * Initializes the SYSVIEW module. -* Must be called before SystemViewer attaches to the system. +* Must be called before the Systemview Application connects to +* the system. * * Parameters -* SysFreq - Frequency of timestamp, i.e. CPU core clock frequency. +* 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 SendSysDesc callback function. +* pfSendSysDesc - Pointer to record system description callback function. * * Additional information * This function initializes the RTT channel used to transport @@ -1203,8 +1384,7 @@ static void _VPrintTarget(const char* sFormat, U32 Options, va_list* pParamList) * The channel is assigned the label "SysView" for client software * to identify the SystemView channel. * -* Notes -* The channel is configured by the macro SEGGER_SYSVIEW_RTT_CHANNEL. +* The channel is configured with the macro SEGGER_SYSVIEW_RTT_CHANNEL. */ void SEGGER_SYSVIEW_Init(U32 SysFreq, U32 CPUFreq, const SEGGER_SYSVIEW_OS_API *pOSAPI, SEGGER_SYSVIEW_SEND_SYS_DESC_FUNC pfSendSysDesc) { #ifdef SEGGER_RTT_SECTION @@ -1217,7 +1397,7 @@ void SEGGER_SYSVIEW_Init(U32 SysFreq, U32 CPUFreq, const SEGGER_SYSVIEW_OS_API * #if SEGGER_SYSVIEW_RTT_CHANNEL > 0 SEGGER_RTT_ConfigUpBuffer(SEGGER_SYSVIEW_RTT_CHANNEL, "SysView", &_UpBuffer[0], sizeof(_UpBuffer), SEGGER_RTT_MODE_NO_BLOCK_SKIP); #else - _SYSVIEW_Globals.UpChannel = SEGGER_RTT_AllocUpBuffer ("SysView", &_UpBuffer[0], sizeof(_UpBuffer), SEGGER_RTT_MODE_NO_BLOCK_SKIP); + _SYSVIEW_Globals.UpChannel = (U8)SEGGER_RTT_AllocUpBuffer ("SysView", &_UpBuffer[0], sizeof(_UpBuffer), SEGGER_RTT_MODE_NO_BLOCK_SKIP); #endif _SYSVIEW_Globals.RAMBaseAddress = SEGGER_SYSVIEW_ID_BASE; _SYSVIEW_Globals.LastTxTimeStamp = SEGGER_SYSVIEW_GET_TIMESTAMP(); @@ -1232,10 +1412,7 @@ void SEGGER_SYSVIEW_Init(U32 SysFreq, U32 CPUFreq, const SEGGER_SYSVIEW_OS_API * SEGGER_RTT_ConfigUpBuffer (SEGGER_SYSVIEW_RTT_CHANNEL, "SysView", &_UpBuffer[0], sizeof(_UpBuffer), SEGGER_RTT_MODE_NO_BLOCK_SKIP); SEGGER_RTT_ConfigDownBuffer (SEGGER_SYSVIEW_RTT_CHANNEL, "SysView", &_DownBuffer[0], sizeof(_DownBuffer), SEGGER_RTT_MODE_NO_BLOCK_SKIP); #else - _SYSVIEW_Globals.UpChannel = SEGGER_RTT_AllocUpBuffer ("SysView", &_UpBuffer[0], sizeof(_UpBuffer), SEGGER_RTT_MODE_NO_BLOCK_SKIP); - // - // TODO: Use SEGGER_RTT_AllocDownBuffer when SystemViewer is able to handle another Down Channel than Up Channel. - // + _SYSVIEW_Globals.UpChannel = (U8)SEGGER_RTT_AllocUpBuffer ("SysView", &_UpBuffer[0], sizeof(_UpBuffer), SEGGER_RTT_MODE_NO_BLOCK_SKIP); _SYSVIEW_Globals.DownChannel = _SYSVIEW_Globals.UpChannel; SEGGER_RTT_ConfigDownBuffer (_SYSVIEW_Globals.DownChannel, "SysView", &_DownBuffer[0], sizeof(_DownBuffer), SEGGER_RTT_MODE_NO_BLOCK_SKIP); #endif @@ -1624,7 +1801,10 @@ void SEGGER_SYSVIEW_RecordString(unsigned int EventID, const char* pString) { * * Function description * Start recording SystemView events. -* This function is triggered by the host application. +* +* 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. * * Additional information * This function enables transmission of SystemView packets recorded @@ -1636,9 +1816,15 @@ void SEGGER_SYSVIEW_RecordString(unsigned int EventID, const char* pString) { * * Notes * SEGGER_SYSVIEW_Start and SEGGER_SYSVIEW_Stop do not nest. +* When SEGGER_SYSVIEW_CAN_RESTART is 1, each received start command +* records the system information. This is required to enable restart +* of recordings when SystemView unexpectedly disconnects without sending +* a stop command before. */ void SEGGER_SYSVIEW_Start(void) { +#if (SEGGER_SYSVIEW_CAN_RESTART == 0) if (_SYSVIEW_Globals.EnableState == 0) { +#endif _SYSVIEW_Globals.EnableState = 1; #if (SEGGER_SYSVIEW_POST_MORTEM_MODE == 1) _SendSyncInfo(); @@ -1646,6 +1832,7 @@ void SEGGER_SYSVIEW_Start(void) { SEGGER_SYSVIEW_LOCK(); SEGGER_RTT_WriteSkipNoLock(CHANNEL_ID_UP, _abSync, 10); SEGGER_SYSVIEW_UNLOCK(); + SEGGER_SYSVIEW_ON_EVENT_RECORDED(10); SEGGER_SYSVIEW_RecordVoid(SYSVIEW_EVTID_TRACE_START); { U8* pPayload; @@ -1667,7 +1854,9 @@ void SEGGER_SYSVIEW_Start(void) { SEGGER_SYSVIEW_SendTaskList(); SEGGER_SYSVIEW_SendNumModules(); #endif +#if (SEGGER_SYSVIEW_CAN_RESTART == 0) } +#endif } /********************************************************************* @@ -1677,6 +1866,10 @@ void SEGGER_SYSVIEW_Start(void) { * Function description * Stop recording SystemView events. * +* This function is triggered by the SystemView Application on disconnect. +* For single-shot or post-mortem mode recording, it can be called +* by the application. +* * Additional information * This function disables transmission of SystemView packets recorded * by subsequent trace calls. If transmission is enabled when @@ -1699,6 +1892,17 @@ U8 SEGGER_SYSVIEW_Started(void) { return _SYSVIEW_Globals.EnableState; } +/********************************************************************* +* +* SEGGER_SYSVIEW_GetChannelID() +* +* Function description +* Returns the RTT / channel ID used by SystemView. +*/ +int SEGGER_SYSVIEW_GetChannelID(void) { + return CHANNEL_ID_UP; +} + /********************************************************************* * * SEGGER_SYSVIEW_GetSysDesc() @@ -1710,7 +1914,7 @@ U8 SEGGER_SYSVIEW_Started(void) { void SEGGER_SYSVIEW_GetSysDesc(void) { U8* pPayload; U8* pPayloadStart; - RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 4 * SEGGER_SYSVIEW_QUANTA_U32); + RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_STRING_LEN + 3/*1 or 3 bytes for string length*/); // pPayload = pPayloadStart; ENCODE_U32(pPayload, _SYSVIEW_Globals.SysFreq); @@ -1774,14 +1978,19 @@ void SEGGER_SYSVIEW_SendTaskList(void) { * * Function description * Send the system description string to the host. -* The system description is used by SystemViewer to identify the -* current application and handle events accordingly. +* 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. * * Parameters * sSysDesc - Pointer to the 0-terminated system description string. * * Additional information * One system description string may not exceed SEGGER_SYSVIEW_MAX_STRING_LEN characters. +* 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. @@ -1807,10 +2016,10 @@ void SEGGER_SYSVIEW_SendSysDesc(const char *sSysDesc) { */ void SEGGER_SYSVIEW_RecordSystime(void) { U64 Systime; - // This code requeued because SystemView expect the answer from the device. - // If there is no answer, then communication will be broken. - U8 old_en = _SYSVIEW_Globals.EnableState; - _SYSVIEW_Globals.EnableState = 1; + // This code requeued because SystemView expect the answer from the device. + // If there is no answer, then communication will be broken. + U8 old_en = _SYSVIEW_Globals.EnableState; + _SYSVIEW_Globals.EnableState = 1; if (_SYSVIEW_Globals.pOSAPI && _SYSVIEW_Globals.pOSAPI->pfGetTime) { Systime = _SYSVIEW_Globals.pOSAPI->pfGetTime(); @@ -1820,7 +2029,7 @@ void SEGGER_SYSVIEW_RecordSystime(void) { } else { SEGGER_SYSVIEW_RecordU32(SYSVIEW_EVTID_SYSTIME_CYCLES, SEGGER_SYSVIEW_GET_TIMESTAMP()); } - _SYSVIEW_Globals.EnableState = old_en; + _SYSVIEW_Globals.EnableState = old_en; } /********************************************************************* @@ -1841,7 +2050,7 @@ void SEGGER_SYSVIEW_RecordEnterISR(U32 IrqId) { RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + SEGGER_SYSVIEW_QUANTA_U32); // pPayload = pPayloadStart; - v = IrqId;//SEGGER_SYSVIEW_GET_INTERRUPT_ID(); + v = IrqId; // SEGGER_SYSVIEW_GET_INTERRUPT_ID(); ENCODE_U32(pPayload, v); _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_ISR_ENTER); RECORD_END(); @@ -2122,43 +2331,93 @@ void SEGGER_SYSVIEW_OnTaskStopReady(U32 TaskId, unsigned int Cause) { /********************************************************************* * -* SEGGER_SYSVIEW_OnUserStart() +* SEGGER_SYSVIEW_MarkStart() * * Function description -* Send a user event start, such as start of a subroutine for profiling. +* Record a Performance Marker Start event to start measuring runtime. * * Parameters -* UserId - User defined ID for the event. +* MarkerId - User defined ID for the marker. */ -void SEGGER_SYSVIEW_OnUserStart(unsigned UserId) { +void SEGGER_SYSVIEW_MarkStart(unsigned MarkerId) { U8* pPayload; U8* pPayloadStart; RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + SEGGER_SYSVIEW_QUANTA_U32); // pPayload = pPayloadStart; - ENCODE_U32(pPayload, UserId); - _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_USER_START); + ENCODE_U32(pPayload, MarkerId); + _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_MARK_START); RECORD_END(); } /********************************************************************* * -* SEGGER_SYSVIEW_OnUserStop() +* SEGGER_SYSVIEW_MarkStop() * * Function description -* Send a user event stop, such as return of a subroutine for profiling. +* Record a Performance Marker Stop event to stop measuring runtime. * * Parameters -* UserId - User defined ID for the event. +* MarkerId - User defined ID for the marker. */ -void SEGGER_SYSVIEW_OnUserStop(unsigned UserId) { +void SEGGER_SYSVIEW_MarkStop(unsigned MarkerId) { U8 * pPayload; U8 * pPayloadStart; RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + SEGGER_SYSVIEW_QUANTA_U32); // pPayload = pPayloadStart; - ENCODE_U32(pPayload, UserId); - _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_USER_STOP); + ENCODE_U32(pPayload, MarkerId); + _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_MARK_STOP); + RECORD_END(); +} + +/********************************************************************* +* +* SEGGER_SYSVIEW_Mark() +* +* Function description +* Record a Performance Marker intermediate event. +* +* Parameters +* MarkerId - User defined ID for the marker. +*/ +void SEGGER_SYSVIEW_Mark(unsigned int MarkerId) { + U8* pPayload; + U8* pPayloadStart; + RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 2 * SEGGER_SYSVIEW_QUANTA_U32); + // + pPayload = pPayloadStart; + ENCODE_U32(pPayload, SYSVIEW_EVTID_EX_MARK); + ENCODE_U32(pPayload, MarkerId); + _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_EX); + RECORD_END(); +} + +/********************************************************************* +* +* SEGGER_SYSVIEW_NameMarker() +* +* Function 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. +* +* Parameters +* MarkerId - User defined ID for the marker. +* sName - Pointer to the marker name. (Max. SEGGER_SYSVIEW_MAX_STRING_LEN Bytes) +*/ +void SEGGER_SYSVIEW_NameMarker(unsigned int MarkerId, const char* sName) { + U8* pPayload; + U8* pPayloadStart; + RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 2 * SEGGER_SYSVIEW_QUANTA_U32 + 1 + SEGGER_SYSVIEW_MAX_STRING_LEN); + // + pPayload = pPayloadStart; + ENCODE_U32(pPayload, SYSVIEW_EVTID_EX_NAME_MARKER); + ENCODE_U32(pPayload, MarkerId); + pPayload = _EncodeStr(pPayload, sName, SEGGER_SYSVIEW_MAX_STRING_LEN); + _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_EX); RECORD_END(); } @@ -2167,7 +2426,11 @@ void SEGGER_SYSVIEW_OnUserStop(unsigned UserId) { * SEGGER_SYSVIEW_NameResource() * * Function description -* Send the name of a resource to be displayed in SystemViewer. +* 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. * * Parameters * ResourceId - Id of the resource to be named. i.e. its address. @@ -2357,7 +2620,7 @@ U32 SEGGER_SYSVIEW_ShrinkId(U32 Id) { * 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 SystemViewer. +* 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. */ void SEGGER_SYSVIEW_RegisterModule(SEGGER_SYSVIEW_MODULE* pModule) { @@ -2383,7 +2646,7 @@ void SEGGER_SYSVIEW_RegisterModule(SEGGER_SYSVIEW_MODULE* pModule) { _pFirstModule = pModule; _NumModules++; } - SEGGER_SYSVIEW_SendModule(_NumModules-1); + SEGGER_SYSVIEW_SendModule(0); if (pModule->pfSendModuleDesc) { pModule->pfSendModuleDesc(); } @@ -2519,7 +2782,7 @@ void SEGGER_SYSVIEW_SendNumModules(void) { * SEGGER_SYSVIEW_PrintfHostEx() * * Function description -* Print a string which is formatted on the host by SystemViewer +* Print a string which is formatted on the host by the SystemView Application * with Additional information. * * Parameters @@ -2531,10 +2794,23 @@ void SEGGER_SYSVIEW_SendNumModules(void) { */ void SEGGER_SYSVIEW_PrintfHostEx(const char* s, U32 Options, ...) { va_list ParamList; +#if SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT + int r; + va_start(ParamList, Options); + r = _VPrintHost(s, Options, &ParamList); + va_end(ParamList); + + if (r == -1) { + va_start(ParamList, Options); + _VPrintTarget(s, Options, &ParamList); + va_end(ParamList); + } +#else va_start(ParamList, Options); _VPrintHost(s, Options, &ParamList); va_end(ParamList); +#endif } /********************************************************************* @@ -2542,7 +2818,7 @@ void SEGGER_SYSVIEW_PrintfHostEx(const char* s, U32 Options, ...) { * SEGGER_SYSVIEW_PrintfHost() * * Function description -* Print a string which is formatted on the host by SystemViewer. +* Print a string which is formatted on the host by the SystemView Application. * * Parameters * s - String to be formatted. @@ -2552,10 +2828,23 @@ void SEGGER_SYSVIEW_PrintfHostEx(const char* s, U32 Options, ...) { */ void SEGGER_SYSVIEW_PrintfHost(const char* s, ...) { va_list ParamList; +#if SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT + int r; + + va_start(ParamList, s); + r = _VPrintHost(s, SEGGER_SYSVIEW_LOG, &ParamList); + va_end(ParamList); + if (r == -1) { + va_start(ParamList, s); + _VPrintTarget(s, SEGGER_SYSVIEW_LOG, &ParamList); + va_end(ParamList); + } +#else va_start(ParamList, s); _VPrintHost(s, SEGGER_SYSVIEW_LOG, &ParamList); va_end(ParamList); +#endif } /********************************************************************* @@ -2563,8 +2852,8 @@ void SEGGER_SYSVIEW_PrintfHost(const char* s, ...) { * SEGGER_SYSVIEW_WarnfHost() * * Function description -* Print a warnin string which is formatted on the host by -* SystemViewer. +* Print a warning string which is formatted on the host by +* the SystemView Application. * * Parameters * s - String to be formatted. @@ -2574,10 +2863,23 @@ void SEGGER_SYSVIEW_PrintfHost(const char* s, ...) { */ void SEGGER_SYSVIEW_WarnfHost(const char* s, ...) { va_list ParamList; +#if SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT + int r; + va_start(ParamList, s); + r = _VPrintHost(s, SEGGER_SYSVIEW_WARNING, &ParamList); + va_end(ParamList); + + if (r == -1) { + va_start(ParamList, s); + _VPrintTarget(s, SEGGER_SYSVIEW_WARNING, &ParamList); + va_end(ParamList); + } +#else va_start(ParamList, s); _VPrintHost(s, SEGGER_SYSVIEW_WARNING, &ParamList); va_end(ParamList); +#endif } /********************************************************************* @@ -2586,7 +2888,7 @@ void SEGGER_SYSVIEW_WarnfHost(const char* s, ...) { * * Function description * Print an error string which is formatted on the host by -* SystemViewer. +* the SystemView Application. * * Parameters * s - String to be formatted. @@ -2596,10 +2898,23 @@ void SEGGER_SYSVIEW_WarnfHost(const char* s, ...) { */ void SEGGER_SYSVIEW_ErrorfHost(const char* s, ...) { va_list ParamList; +#if SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT + int r; + va_start(ParamList, s); + r = _VPrintHost(s, SEGGER_SYSVIEW_ERROR, &ParamList); + va_end(ParamList); + + if (r == -1) { + va_start(ParamList, s); + _VPrintTarget(s, SEGGER_SYSVIEW_ERROR, &ParamList); + va_end(ParamList); + } +#else va_start(ParamList, s); _VPrintHost(s, SEGGER_SYSVIEW_ERROR, &ParamList); va_end(ParamList); +#endif } /********************************************************************* @@ -2693,7 +3008,7 @@ void SEGGER_SYSVIEW_ErrorfTarget(const char* s, ...) { void SEGGER_SYSVIEW_Print(const char* s) { U8* pPayload; U8* pPayloadStart; - RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_STRING_LEN + 3/*1 or 3 bytes for string length*/); + RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_STRING_LEN); // pPayload = _EncodeStr(pPayloadStart, s, SEGGER_SYSVIEW_MAX_STRING_LEN); ENCODE_U32(pPayload, SEGGER_SYSVIEW_LOG); @@ -2774,5 +3089,32 @@ void SEGGER_SYSVIEW_DisableEvents(U32 DisableMask) { _SYSVIEW_Globals.DisabledEvents |= DisableMask; } +/********************************************************************* +* +* SEGGER_SYSVIEW_IsStarted() +* +* Function description +* Handle incoming packets if any and check if recording is started. +* +* Return value +* 0: Recording not started. +* > 0: Recording started. +*/ +int SEGGER_SYSVIEW_IsStarted(void) { +#if (SEGGER_SYSVIEW_POST_MORTEM_MODE != 1) + // + // Check if host is sending data which needs to be processed. + // + if (SEGGER_RTT_HASDATA(CHANNEL_ID_DOWN)) { + if (_SYSVIEW_Globals.RecursionCnt == 0) { // Avoid uncontrolled nesting. This way, this routine can call itself once, but no more often than that. + _SYSVIEW_Globals.RecursionCnt = 1; + _HandleIncomingPacket(); + _SYSVIEW_Globals.RecursionCnt = 0; + } + } +#endif + return _SYSVIEW_Globals.EnableState; +} + /*************************** End of file ****************************/ diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.h b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.h index eb4cfc583f38..34f8a2360d22 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.h @@ -1,14 +1,16 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause + * + * SPDX-FileContributor: 2023 Espressif Systems (Shanghai) CO LTD */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +24,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,13 +49,13 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW.h Purpose : System visualization API. -Revision: $Rev: 5626 $ +Revision: $Rev: 26226 $ */ #ifndef SEGGER_SYSVIEW_H @@ -77,6 +69,7 @@ Revision: $Rev: 5626 $ */ #include "SEGGER.h" +#include "SEGGER_SYSVIEW_ConfDefaults.h" #ifdef __cplusplus extern "C" { @@ -90,7 +83,10 @@ extern "C" { ********************************************************************** */ -#define SEGGER_SYSVIEW_VERSION 21000 +#define SEGGER_SYSVIEW_MAJOR 3 +#define SEGGER_SYSVIEW_MINOR 32 +#define SEGGER_SYSVIEW_REV 0 +#define SEGGER_SYSVIEW_VERSION ((SEGGER_SYSVIEW_MAJOR * 10000) + (SEGGER_SYSVIEW_MINOR * 100) + SEGGER_SYSVIEW_REV) #define SEGGER_SYSVIEW_INFO_SIZE 9 // Minimum size, which has to be reserved for a packet. 1-2 byte of message type, 0-2 byte of payload length, 1-5 bytes of timestamp. #define SEGGER_SYSVIEW_QUANTA_U32 5 // Maximum number of bytes to encode a U32, should be reserved for each 32-bit value in a packet. @@ -119,8 +115,8 @@ extern "C" { #define SYSVIEW_EVTID_SYSTIME_CYCLES 12 #define SYSVIEW_EVTID_SYSTIME_US 13 #define SYSVIEW_EVTID_SYSDESC 14 -#define SYSVIEW_EVTID_USER_START 15 -#define SYSVIEW_EVTID_USER_STOP 16 +#define SYSVIEW_EVTID_MARK_START 15 +#define SYSVIEW_EVTID_MARK_STOP 16 #define SYSVIEW_EVTID_IDLE 17 #define SYSVIEW_EVTID_ISR_TO_SCHEDULER 18 #define SYSVIEW_EVTID_TIMER_ENTER 19 @@ -137,6 +133,11 @@ extern "C" { #define SYSVIEW_EVTID_EX 31 // +// SystemView extended events. Sent with ID 31. +// +#define SYSVIEW_EVTID_EX_MARK 0 +#define SYSVIEW_EVTID_EX_NAME_MARKER 1 +// // Event masks to disable/enable events // #define SYSVIEW_EVTMASK_NOP (1 << SYSVIEW_EVTID_NOP) @@ -211,6 +212,29 @@ struct SEGGER_SYSVIEW_MODULE_STRUCT { typedef void (SEGGER_SYSVIEW_SEND_SYS_DESC_FUNC)(void); + +/********************************************************************* +* +* Global data +* +********************************************************************** +*/ + +#ifdef EXTERN + #undef EXTERN +#endif + +#ifndef SEGGER_SYSVIEW_C // Defined in SEGGER_SYSVIEW.c which includes this header beside other C-files + #define EXTERN extern +#else + #define EXTERN +#endif + +EXTERN unsigned int SEGGER_SYSVIEW_TickCnt; +EXTERN unsigned int SEGGER_SYSVIEW_InterruptId; + +#undef EXTERN + /********************************************************************* * * API functions @@ -235,6 +259,8 @@ void SEGGER_SYSVIEW_GetSysDesc (void); void SEGGER_SYSVIEW_SendTaskList (void); void SEGGER_SYSVIEW_SendTaskInfo (const SEGGER_SYSVIEW_TASKINFO* pInfo); void SEGGER_SYSVIEW_SendSysDesc (const char* sSysDesc); +int SEGGER_SYSVIEW_IsStarted (void); +int SEGGER_SYSVIEW_GetChannelID (void); // Checks whether tracing has been started U8 SEGGER_SYSVIEW_Started(void); @@ -270,8 +296,10 @@ void SEGGER_SYSVIEW_OnTaskStartExec (U32 TaskId); void SEGGER_SYSVIEW_OnTaskStopExec (void); void SEGGER_SYSVIEW_OnTaskStartReady (U32 TaskId); void SEGGER_SYSVIEW_OnTaskStopReady (U32 TaskId, unsigned int Cause); -void SEGGER_SYSVIEW_OnUserStart (unsigned int UserId); // Start of user defined event (such as a subroutine to profile) -void SEGGER_SYSVIEW_OnUserStop (unsigned int UserId); // Start of user defined event +void SEGGER_SYSVIEW_MarkStart (unsigned int MarkerId); +void SEGGER_SYSVIEW_MarkStop (unsigned int MarkerId); +void SEGGER_SYSVIEW_Mark (unsigned int MarkerId); +void SEGGER_SYSVIEW_NameMarker (unsigned int MarkerId, const char* sName); void SEGGER_SYSVIEW_NameResource (U32 ResourceId, const char* sName); @@ -332,10 +360,20 @@ void SEGGER_SYSVIEW_Conf (void); U32 SEGGER_SYSVIEW_X_GetTimestamp (void); U32 SEGGER_SYSVIEW_X_GetInterruptId (void); +void SEGGER_SYSVIEW_X_StartComm (void); +void SEGGER_SYSVIEW_X_OnEventRecorded (unsigned NumBytes); + #ifdef __cplusplus } #endif +/********************************************************************* +* +* Compatibility API defines +*/ +#define SEGGER_SYSVIEW_OnUserStart SEGGER_SYSVIEW_MarkStart +#define SEGGER_SYSVIEW_OnUserStop SEGGER_SYSVIEW_MarkStop + #endif /*************************** End of file ****************************/ diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h index a741f89e2ac5..e2364f70dbf7 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h @@ -1,14 +1,16 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause + * + * SPDX-FileContributor: 2023 Espressif Systems (Shanghai) CO LTD */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +24,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,14 +49,14 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW_ConfDefaults.h Purpose : Defines defaults for configurable defines used in SEGGER SystemView. -Revision: $Rev: 3734 $ +Revision: $Rev: 26230 $ */ #ifndef SEGGER_SYSVIEW_CONFDEFAULTS_H @@ -86,19 +78,182 @@ extern "C" { /********************************************************************* * -* Configuration defaults +* Defines, fixed * ********************************************************************** */ +// +// Use auto-detection for SEGGER_SYSVIEW_CORE define +// based on compiler-/toolchain-specific defines +// to define SEGGER_SYSVIEW_GET_INTERRUPT_ID and SEGGER_SYSVIEW_GET_TIMESTAMP +// +#define SEGGER_SYSVIEW_CORE_OTHER 0 +#define SEGGER_SYSVIEW_CORE_CM0 1 // Cortex-M0/M0+/M1 +#define SEGGER_SYSVIEW_CORE_CM3 2 // Cortex-M3/M4/M7 +#define SEGGER_SYSVIEW_CORE_RX 3 // Renesas RX +#ifndef SEGGER_SYSVIEW_CORE + #if (defined __SES_ARM) || (defined __CROSSWORKS_ARM) || (defined __SEGGER_CC__) || (defined __GNUC__) || (defined __clang__) + #if (defined __ARM_ARCH_6M__) || (defined __ARM_ARCH_8M_BASE__) + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM0 + #elif (defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7EM__) || defined(__ARM_ARCH_8M_MAIN__)) + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM3 + #endif + #elif defined(__ICCARM__) + #if (defined (__ARM6M__) && (__CORE__ == __ARM6M__)) \ + || (defined (__ARM8M_BASELINE__) && (__CORE__ == __ARM8M_BASELINE__)) + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM0 + #elif (defined (__ARM7EM__) && (__CORE__ == __ARM7EM__)) \ + || (defined (__ARM7M__) && (__CORE__ == __ARM7M__)) \ + || (defined (__ARM8M_MAINLINE__) && (__CORE__ == __ARM8M_MAINLINE__)) \ + || (defined (__ARM8M_MAINLINE__) && (__CORE__ == __ARM8M_MAINLINE__)) + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM3 + #endif + #elif defined(__CC_ARM) + #if (defined(__TARGET_ARCH_6S_M)) + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM0 + #elif (defined(__TARGET_ARCH_7_M) || defined(__TARGET_ARCH_7E_M)) + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM3 + #endif + #elif defined(__TI_ARM__) + #ifdef __TI_ARM_V6M0__ + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM0 + #elif (defined(__TI_ARM_V7M3__) || defined(__TI_ARM_V7M4__)) + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_CM3 + #endif + #elif defined(__ICCRX__) + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_RX + #elif defined(__RX) + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_RX + #endif -// Number of bytes that SystemView uses for a buffer. -#ifndef SEGGER_SYSVIEW_RTT_BUFFER_SIZE - #define SEGGER_SYSVIEW_RTT_BUFFER_SIZE 1024 + #ifndef SEGGER_SYSVIEW_CORE + #define SEGGER_SYSVIEW_CORE SEGGER_SYSVIEW_CORE_OTHER + #endif #endif -// The RTT channel that SystemView will use. + +/********************************************************************* +* +* Defines, defaults +* +********************************************************************** +*/ +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_APP_NAME +* +* Description +* The application name to be displayed in SystemView. +* Default +* "SystemView-enabled Application" +* Notes +* Convenience define to be used for SEGGER_SYSVIEW_SendSysDesc(). +*/ +#ifndef SEGGER_SYSVIEW_APP_NAME + #define SEGGER_SYSVIEW_APP_NAME "SystemView-enabled Application" +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_DEVICE_NAME +* +* Description +* The target device name to be displayed in SystemView. +* Default +* "undefined device" +* Notes +* Convenience define to be used for SEGGER_SYSVIEW_SendSysDesc(). +*/ +#ifndef SEGGER_SYSVIEW_DEVICE_NAME + #define SEGGER_SYSVIEW_DEVICE_NAME "undefined device" +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_GET_INTERRUPT_ID() +* +* Description +* Function macro to retrieve the Id of the currently active +* interrupt. +* Default +* Call user-supplied function SEGGER_SYSVIEW_X_GetInterruptId(). +* Notes +* For some known compilers and cores, a ready-to-use, core-specific +* default is set. +* ARMv7M: Read ICSR[8:0] (active vector) +* ARMv6M: Read ICSR[5:0] (active vector) +*/ +#ifndef SEGGER_SYSVIEW_GET_INTERRUPT_ID + #if SEGGER_SYSVIEW_CORE == SEGGER_SYSVIEW_CORE_CM3 + #define SEGGER_SYSVIEW_GET_INTERRUPT_ID() ((*(U32*)(0xE000ED04)) & 0x1FF) // Get the currently active interrupt Id. (i.e. read Cortex-M ICSR[8:0] = active vector) + #elif SEGGER_SYSVIEW_CORE == SEGGER_SYSVIEW_CORE_CM0 + #if defined(__ICCARM__) + #if (__VER__ > 6010000) + #define SEGGER_SYSVIEW_GET_INTERRUPT_ID() (__get_IPSR()) // Workaround for IAR, which might do a byte-access to 0xE000ED04. Read IPSR instead. + #else + #define SEGGER_SYSVIEW_GET_INTERRUPT_ID() ((*(U32*)(0xE000ED04)) & 0x3F) // Older versions of IAR do not include __get_IPSR, but might also not optimize to byte-access. + #endif + #else + #define SEGGER_SYSVIEW_GET_INTERRUPT_ID() ((*(U32*)(0xE000ED04)) & 0x3F) // Get the currently active interrupt Id. (i.e. read Cortex-M ICSR[5:0] = active vector) + #endif + #else + #define SEGGER_SYSVIEW_GET_INTERRUPT_ID() SEGGER_SYSVIEW_X_GetInterruptId() // Get the currently active interrupt Id from the user-provided function. + #endif +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_GET_TIMESTAMP() +* +* Description +* Function macro to retrieve a system timestamp for SYSVIEW events. +* Default +* Call user-supplied function SEGGER_SYSVIEW_X_GetTimestamp(). +* Notes +* For some known compilers and cores, a ready-to-use, core-specific +* default is set. +* ARMv7M: Read Cortex-M Cycle Count register. +* +* The system timestamp clock frequency has to be passed in +* SEGGER_SYSVIEW_Init(). +*/ +#ifndef SEGGER_SYSVIEW_GET_TIMESTAMP + #if defined (SEGGER_SYSVIEW_CORE) && (SEGGER_SYSVIEW_CORE == SEGGER_SYSVIEW_CORE_CM3) + #define SEGGER_SYSVIEW_GET_TIMESTAMP() (*(U32 *)(0xE0001004)) // Retrieve a system timestamp. Cortex-M cycle counter. + #else + #define SEGGER_SYSVIEW_GET_TIMESTAMP() SEGGER_SYSVIEW_X_GetTimestamp() // Retrieve a system timestamp via user-defined function + #endif +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_TIMESTAMP_BITS +* +* Description +* Number of valid (low-order) bits delivered in system timestamp. +* Default +* 32 +* Notes +* Value has to match system timestamp clock source. +*/ +// Define number of valid bits low-order delivered by clock source. +#ifndef SEGGER_SYSVIEW_TIMESTAMP_BITS + #define SEGGER_SYSVIEW_TIMESTAMP_BITS 32 +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_RTT_CHANNEL +* +* Description +* The RTT channel that SystemView will use. +* Default +* 0: Auto selection. +* Notes +* Value has to be lower than SEGGER_RTT_MAX_NUM_UP_BUFFERS. +*/ #ifndef SEGGER_SYSVIEW_RTT_CHANNEL - #define SEGGER_SYSVIEW_RTT_CHANNEL 0 + #define SEGGER_SYSVIEW_RTT_CHANNEL 1 #endif // Sanity check of RTT channel #if (SEGGER_SYSVIEW_RTT_CHANNEL == 0) && (SEGGER_RTT_MAX_NUM_UP_BUFFERS < 2) @@ -107,71 +262,321 @@ extern "C" { #error "SEGGER_RTT_MAX_NUM_UP_BUFFERS in SEGGER_RTT_Conf.h has to be > SEGGER_SYSVIEW_RTT_CHANNEL!" #endif -// Place the SystemView buffer into its own/the RTT section -#if !(defined SEGGER_SYSVIEW_BUFFER_SECTION) && (defined SEGGER_RTT_SECTION) - #define SEGGER_SYSVIEW_BUFFER_SECTION SEGGER_RTT_SECTION +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_RTT_BUFFER_SIZE +* +* Description +* Number of bytes that SystemView uses for the RTT buffer. +* Default +* 1024 +*/ +#ifndef SEGGER_SYSVIEW_RTT_BUFFER_SIZE + #define SEGGER_SYSVIEW_RTT_BUFFER_SIZE 1024 #endif -// Retrieve a system timestamp. This gets the Cortex-M cycle counter. -#ifndef SEGGER_SYSVIEW_GET_TIMESTAMP - #error "SEGGER_SYSVIEW_GET_TIMESTAMP has to be defined in SEGGER_SYSVIEW_Conf.h!" +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_SECTION +* +* Description +* Section to place the SystemView RTT Buffer into. +* Default +* undefined: Do not place into a specific section. +* Notes +* If SEGGER_RTT_SECTION is defined, the default changes to use +* this section for the SystemView RTT Buffer, too. +*/ +#if !(defined SEGGER_SYSVIEW_SECTION) && (defined SEGGER_RTT_SECTION) + #define SEGGER_SYSVIEW_SECTION SEGGER_RTT_SECTION #endif -// Define number of valid bits low-order delivered by clock source. -#ifndef SEGGER_SYSVIEW_TIMESTAMP_BITS - #define SEGGER_SYSVIEW_TIMESTAMP_BITS 32 +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE +* +* Description +* Largest cache line size (in bytes) in the target system. +* Default +* 0 +* Notes +* Required in systems with caches to make sure that the SystemView +* RTT buffer can be aligned accordingly. +*/ +#ifndef SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE + #define SEGGER_SYSVIEW_CPU_CACHE_LINE_SIZE 0 #endif -// Lowest Id reported by the Application. +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_ID_BASE +* +* Description +* Lowest Id reported by the application. +* Default +* 0 +* Notes +* Value is usually subtracted from mailboxes, semaphores, tasks, +* .... addresses, to compress event parameters. +* Should be the lowest RAM address of the system. +*/ #ifndef SEGGER_SYSVIEW_ID_BASE - #define SEGGER_SYSVIEW_ID_BASE 0 + #define SEGGER_SYSVIEW_ID_BASE 0 #endif -// Number of bits to shift Ids to save bandwidth +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_ID_SHIFT +* +* Description +* Number of bits to shift Ids. +* Default +* 0 +* Notes +* Ids are shifted to compress event parameters. +* Should match the alignment of Ids (addresses), +* e.g. 2 when Ids are 4 byte aligned. +*/ #ifndef SEGGER_SYSVIEW_ID_SHIFT - #define SEGGER_SYSVIEW_ID_SHIFT 0 -#endif - -#ifndef SEGGER_SYSVIEW_GET_INTERRUPT_ID - #error "SEGGER_SYSVIEW_GET_INTERRUPT_ID has to be defined in SEGGER_SYSVIEW_Conf.h!" + #define SEGGER_SYSVIEW_ID_SHIFT 0 #endif +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_MAX_ARGUMENTS +* +* Description +* Maximum number of arguments which are handled with SystemView +* print routines or may be encoded in one recording function. +* routines. +* Default +* 16 +*/ #ifndef SEGGER_SYSVIEW_MAX_ARGUMENTS - #define SEGGER_SYSVIEW_MAX_ARGUMENTS 16 + #define SEGGER_SYSVIEW_MAX_ARGUMENTS 16 #endif +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_MAX_STRING_LEN +* +* Description +* Maximum string length which can be used in SystemView print and +* system description routines. +* Default +* 128 +*/ #ifndef SEGGER_SYSVIEW_MAX_STRING_LEN - #define SEGGER_SYSVIEW_MAX_STRING_LEN 128 + #define SEGGER_SYSVIEW_MAX_STRING_LEN 128 +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_SUPPORT_LONG_ID +* +* Description +* It set, support enconding Evend Ids longer than 14 bit. +* Default +* 1 +*/ +#ifndef SEGGER_SYSVIEW_SUPPORT_LONG_ID + #define SEGGER_SYSVIEW_SUPPORT_LONG_ID 1 +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_SUPPORT_LONG_DATA +* +* Description +* It set, support enconding event data longer than 14 bit. +* Default +* 0 +*/ +#ifndef SEGGER_SYSVIEW_SUPPORT_LONG_DATA + #define SEGGER_SYSVIEW_SUPPORT_LONG_DATA 0 +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT +* +* Description +* If enabled, on SEGGER_SYSVIEW_PrintHost, check the format string +* and if it includes unsupported formatters, use formatting on the +* target instead. +* Default +* 0: Disabled. +*/ +#ifndef SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT + #define SEGGER_SYSVIEW_PRINTF_IMPLICIT_FORMAT 0 +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_USE_INTERNAL_RECORDER +* +* Description +* If set, an internal recorder, such as UART or IP is used. +* Default +* 0: Disabled. +* Notes +* Convenience define to be used by SEGGER_SYSVIEW_Conf(), +* such as in embOS configuration to enable Cortex-M cycle counter. +*/ +#ifndef SEGGER_SYSVIEW_USE_INTERNAL_RECORDER + #define SEGGER_SYSVIEW_USE_INTERNAL_RECORDER 0 +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_CAN_RESTART +* +* Description +* If enabled, send the SystemView start sequence on every start +* command, not just on the first one. +* Enables restart when SystemView disconnected unexpectedly. +* Default +* 1: Enabled +*/ +#ifndef SEGGER_SYSVIEW_CAN_RESTART + #define SEGGER_SYSVIEW_CAN_RESTART 1 #endif -// Use a static buffer instead of a buffer on the stack for packets +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_START_ON_INIT +* +* Description +* Enable calling SEGGER_SYSVIEW_Start() after initialization. +* Default +* 0: Disabled. +* Notes +* Convenience define to be used by SEGGER_SYSVIEW_Conf(), +* such as in embOS configuration. +*/ +#ifndef SEGGER_SYSVIEW_START_ON_INIT + #define SEGGER_SYSVIEW_START_ON_INIT 0 +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_USE_STATIC_BUFFER +* +* Description +* If enabled, use a static buffer instead of a buffer on the stack +* for SystemView event packets. +* Default +* 1: Enabled. +* Notes +* If enabled, the static memory use by SystemView is increased by +* the maximum packet size. SystemView is locked on entry of a +* recording function. +* If disabled, the stack usage by SystemView recording functions +* might be increased by up to the maximum packet size. SystemView +* is locked when writing the packet to the RTT buffer. +*/ #ifndef SEGGER_SYSVIEW_USE_STATIC_BUFFER - #define SEGGER_SYSVIEW_USE_STATIC_BUFFER 1 + #define SEGGER_SYSVIEW_USE_STATIC_BUFFER 1 #endif -// Maximum packet size used by SystemView for the static buffer +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_MAX_PACKET_SIZE +* +* Description +* Maximum packet size for a SystemView event. +* Default +* Automatically calculated. +* Notes +* The maximum packet size is mainly defined by the maximum string +* length and the maximum number of arguments. +*/ #ifndef SEGGER_SYSVIEW_MAX_PACKET_SIZE - #define SEGGER_SYSVIEW_MAX_PACKET_SIZE SEGGER_SYSVIEW_INFO_SIZE + SEGGER_SYSVIEW_MAX_STRING_LEN + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_ARGUMENTS * SEGGER_SYSVIEW_QUANTA_U32 + #define SEGGER_SYSVIEW_MAX_PACKET_SIZE (SEGGER_SYSVIEW_INFO_SIZE + SEGGER_SYSVIEW_MAX_STRING_LEN + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_ARGUMENTS * SEGGER_SYSVIEW_QUANTA_U32) #endif -// Use post-mortem analysis instead of real-time analysis +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_POST_MORTEM_MODE +* +* Description +* If enabled, SystemView records for post-mortem analysis instead +* of real-time analysis. +* Default +* 0: Disabled. +* Notes +* For more information refer to +* https://www.segger.com/products/development-tools/systemview/technology/post-mortem-mode +*/ #ifndef SEGGER_SYSVIEW_POST_MORTEM_MODE - #define SEGGER_SYSVIEW_POST_MORTEM_MODE 0 + #define SEGGER_SYSVIEW_POST_MORTEM_MODE 0 #endif -// Configure how frequently syncronization is sent +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_SYNC_PERIOD_SHIFT +* +* Description +* Configure how frequently syncronization is sent in post-mortem +* mode. +* Default +* 8: (1 << 8) = Every 256 Events. +* Notes +* In post-mortem mode, at least one sync has to be in the RTT buffer. +* Recommended sync frequency: Buffer Size / 16 +* For more information refer to +* https://www.segger.com/products/development-tools/systemview/technology/post-mortem-mode +*/ #ifndef SEGGER_SYSVIEW_SYNC_PERIOD_SHIFT - #define SEGGER_SYSVIEW_SYNC_PERIOD_SHIFT 8 + #define SEGGER_SYSVIEW_SYNC_PERIOD_SHIFT 8 +#endif + +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_ON_EVENT_RECORDED() +* +* Description +* Function macro to notify recorder about a new event in buffer. +* Default +* undefined: Do not notify recorder. +* Notes +* Used for non-J-Link recorder, +* such as to enable transmission via UART or notify IP task. +*/ +#ifndef SEGGER_SYSVIEW_ON_EVENT_RECORDED + #define SEGGER_SYSVIEW_ON_EVENT_RECORDED(NumBytes) #endif -// Lock SystemView (nestable) +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_LOCK() +* +* Description +* Function macro to (nestable) lock SystemView recording. +* Default +* Use RTT Locking mechanism (defined by SEGGER_RTT_LOCK()). +* Notes +* If SystemView recording is not locked, recording events from +* interrupts and tasks may lead to unpredictable, undefined, event +* data. +*/ #ifndef SEGGER_SYSVIEW_LOCK - #define SEGGER_SYSVIEW_LOCK() SEGGER_RTT_LOCK() + unsigned SEGGER_SYSVIEW_X_SysView_Lock(void); + #define SEGGER_SYSVIEW_LOCK() unsigned _SYSVIEW_int_state = SEGGER_SYSVIEW_X_SysView_Lock() #endif -// Unlock SystemView (nestable) +/********************************************************************* +* +* Define: SEGGER_SYSVIEW_UNLOCK +* +* Description +* Function macro to unlock SystemView recording. +* Default +* Use RTT Unlocking mechanism (defined by SEGGER_RTT_UNLOCK()). +*/ #ifndef SEGGER_SYSVIEW_UNLOCK - #define SEGGER_SYSVIEW_UNLOCK() SEGGER_RTT_UNLOCK() + void SEGGER_SYSVIEW_X_SysView_Unlock(unsigned int_state); + #define SEGGER_SYSVIEW_UNLOCK() SEGGER_SYSVIEW_X_SysView_Unlock(_SYSVIEW_int_state) #endif #ifdef __cplusplus diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_Int.h b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_Int.h index 1614e378e382..40c4e240fac7 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_Int.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_Int.h @@ -1,14 +1,14 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +22,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,13 +47,13 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW_Int.h Purpose : SEGGER SystemView internal header. -Revision: $Rev: 5626 $ +Revision: $Rev: 21281 $ */ #ifndef SEGGER_SYSVIEW_INT_H @@ -77,8 +67,6 @@ Revision: $Rev: 5626 $ */ #include "SEGGER_SYSVIEW.h" -#include "SEGGER_SYSVIEW_Conf.h" -#include "SEGGER_SYSVIEW_ConfDefaults.h" #ifdef __cplusplus extern "C" { @@ -102,6 +90,7 @@ typedef enum { SEGGER_SYSVIEW_COMMAND_ID_GET_SYSDESC, SEGGER_SYSVIEW_COMMAND_ID_GET_NUMMODULES, SEGGER_SYSVIEW_COMMAND_ID_GET_MODULEDESC, + SEGGER_SYSVIEW_COMMAND_ID_HEARTBEAT = 127, // Extended commands: Commands >= 128 have a second parameter SEGGER_SYSVIEW_COMMAND_ID_GET_MODULE = 128 } SEGGER_SYSVIEW_COMMAND_ID; diff --git a/components/app_trace/sys_view/Sample/Config/SEGGER_SYSVIEW_Config_FreeRTOS.c b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/Config/esp/SEGGER_SYSVIEW_Config_FreeRTOS.c similarity index 100% rename from components/app_trace/sys_view/Sample/Config/SEGGER_SYSVIEW_Config_FreeRTOS.c rename to components/app_trace/sys_view/Sample/FreeRTOSV10.4/Config/esp/SEGGER_SYSVIEW_Config_FreeRTOS.c diff --git a/components/app_trace/sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.c b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.c similarity index 64% rename from components/app_trace/sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.c rename to components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.c index 43625d3d4b4a..e1dccb7e1ea1 100644 --- a/components/app_trace/sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.c +++ b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.c @@ -1,14 +1,16 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause + * + * SPDX-FileContributor: 2023 Espressif Systems (Shanghai) CO LTD */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +24,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,14 +49,14 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW_FreeRTOS.c Purpose : Interface between FreeRTOS and SystemView. -Revision: $Rev: 3734 $ +Revision: $Rev: 7947 $ */ #include "freertos/FreeRTOS.h" #include "freertos/task.h" @@ -85,6 +77,7 @@ struct SYSVIEW_FREERTOS_TASK_STATUS { }; static SYSVIEW_FREERTOS_TASK_STATUS _aTasks[SYSVIEW_FREERTOS_MAX_NOF_TASKS]; +static unsigned _NumTasks; /********************************************************************* * @@ -98,13 +91,11 @@ static SYSVIEW_FREERTOS_TASK_STATUS _aTasks[SYSVIEW_FREERTOS_MAX_NOF_TASKS]; static void _cbSendTaskList(void) { unsigned n; - for (n = 0; n < SYSVIEW_FREERTOS_MAX_NOF_TASKS; n++) { - if (_aTasks[n].xHandle) { + for (n = 0; n < _NumTasks; n++) { #if INCLUDE_uxTaskGetStackHighWaterMark // Report Task Stack High Watermark - _aTasks[n].uStackHighWaterMark = uxTaskGetStackHighWaterMark((TaskHandle_t)_aTasks[n].xHandle); + _aTasks[n].uStackHighWaterMark = uxTaskGetStackHighWaterMark((TaskHandle_t)_aTasks[n].xHandle); #endif - SYSVIEW_SendTaskInfo((U32)_aTasks[n].xHandle, _aTasks[n].pcTaskName, (unsigned)_aTasks[n].uxCurrentPriority, (U32)_aTasks[n].pxStack, (unsigned)_aTasks[n].uStackHighWaterMark); - } + SYSVIEW_SendTaskInfo((U32)_aTasks[n].xHandle, _aTasks[n].pcTaskName, (unsigned)_aTasks[n].uxCurrentPriority, (U32)_aTasks[n].pxStack, (unsigned)_aTasks[n].uStackHighWaterMark); } } @@ -140,7 +131,6 @@ static U64 _cbGetTime(void) { * Add a task to the internal list and record its information. */ void SYSVIEW_AddTask(U32 xHandle, const char* pcTaskName, unsigned uxCurrentPriority, U32 pxStack, unsigned uStackHighWaterMark) { - unsigned n; /* On multi-core we have several idle tasks with 'IDLEx' names Not best solution, because we can filter out user tasks starting with 'IDLE'. @@ -150,21 +140,18 @@ void SYSVIEW_AddTask(U32 xHandle, const char* pcTaskName, unsigned uxCurrentPrio return; } - for (n = 0; n < SYSVIEW_FREERTOS_MAX_NOF_TASKS; n++) { - if (_aTasks[n].xHandle == 0) { - break; - } - } - if (n == SYSVIEW_FREERTOS_MAX_NOF_TASKS) { + if (_NumTasks >= SYSVIEW_FREERTOS_MAX_NOF_TASKS) { SEGGER_SYSVIEW_Warn("SYSTEMVIEW: Could not record task information. Maximum number of tasks reached."); return; } - _aTasks[n].xHandle = xHandle; - _aTasks[n].pcTaskName = pcTaskName; - _aTasks[n].uxCurrentPriority = uxCurrentPriority; - _aTasks[n].pxStack = pxStack; - _aTasks[n].uStackHighWaterMark = uStackHighWaterMark; + _aTasks[_NumTasks].xHandle = xHandle; + _aTasks[_NumTasks].pcTaskName = pcTaskName; + _aTasks[_NumTasks].uxCurrentPriority = uxCurrentPriority; + _aTasks[_NumTasks].pxStack = pxStack; + _aTasks[_NumTasks].uStackHighWaterMark = uStackHighWaterMark; + + _NumTasks++; SYSVIEW_SendTaskInfo(xHandle, pcTaskName,uxCurrentPriority, pxStack, uStackHighWaterMark); @@ -188,12 +175,12 @@ void SYSVIEW_UpdateTask(U32 xHandle, const char* pcTaskName, unsigned uxCurrentP return; } - for (n = 0; n < SYSVIEW_FREERTOS_MAX_NOF_TASKS; n++) { + for (n = 0; n < _NumTasks; n++) { if (_aTasks[n].xHandle == xHandle) { break; } } - if (n < SYSVIEW_FREERTOS_MAX_NOF_TASKS) { + if (n < _NumTasks) { _aTasks[n].pcTaskName = pcTaskName; _aTasks[n].uxCurrentPriority = uxCurrentPriority; _aTasks[n].pxStack = pxStack; @@ -215,17 +202,35 @@ void SYSVIEW_UpdateTask(U32 xHandle, const char* pcTaskName, unsigned uxCurrentP void SYSVIEW_DeleteTask(U32 xHandle) { unsigned n; - for (n = 0; n < SYSVIEW_FREERTOS_MAX_NOF_TASKS; n++) { + if (_NumTasks == 0) { + return; // Early out + } + for (n = 0; n < _NumTasks; n++) { if (_aTasks[n].xHandle == xHandle) { break; } } - if (n == SYSVIEW_FREERTOS_MAX_NOF_TASKS) { - SEGGER_SYSVIEW_Warn("SYSTEMVIEW: Could not find task information. Cannot delete task."); - return; + if (n == (_NumTasks - 1)) { + // + // Task is last item in list. + // Simply zero the item and decrement number of tasks. + // + memset(&_aTasks[n], 0, sizeof(_aTasks[n])); + _NumTasks--; + } else if (n < _NumTasks) { + // + // Task is in the middle of the list. + // Move last item to current position and decrement number of tasks. + // Order of tasks does not really matter, so no need to move all following items. + // + _aTasks[n].xHandle = _aTasks[_NumTasks - 1].xHandle; + _aTasks[n].pcTaskName = _aTasks[_NumTasks - 1].pcTaskName; + _aTasks[n].uxCurrentPriority = _aTasks[_NumTasks - 1].uxCurrentPriority; + _aTasks[n].pxStack = _aTasks[_NumTasks - 1].pxStack; + _aTasks[n].uStackHighWaterMark = _aTasks[_NumTasks - 1].uStackHighWaterMark; + memset(&_aTasks[_NumTasks - 1], 0, sizeof(_aTasks[_NumTasks - 1])); + _NumTasks--; } - - _aTasks[n].xHandle = 0; } /********************************************************************* @@ -247,47 +252,6 @@ void SYSVIEW_SendTaskInfo(U32 TaskID, const char* sName, unsigned Prio, U32 Stac SEGGER_SYSVIEW_SendTaskInfo(&TaskInfo); } -/********************************************************************* -* -* SYSVIEW_RecordU32x4() -* -* Function description -* Record an event with 4 parameters -*/ -void SYSVIEW_RecordU32x4(unsigned Id, U32 Para0, U32 Para1, U32 Para2, U32 Para3) { - U8 aPacket[SEGGER_SYSVIEW_INFO_SIZE + 4 * SEGGER_SYSVIEW_QUANTA_U32]; - U8* pPayload; - // - pPayload = SEGGER_SYSVIEW_PREPARE_PACKET(aPacket); // Prepare the packet for SystemView - pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, Para0); // Add the first parameter to the packet - pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, Para1); // Add the second parameter to the packet - pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, Para2); // Add the third parameter to the packet - pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, Para3); // Add the fourth parameter to the packet - // - SEGGER_SYSVIEW_SendPacket(&aPacket[0], pPayload, Id); // Send the packet -} - -/********************************************************************* -* -* SYSVIEW_RecordU32x5() -* -* Function description -* Record an event with 5 parameters -*/ -void SYSVIEW_RecordU32x5(unsigned Id, U32 Para0, U32 Para1, U32 Para2, U32 Para3, U32 Para4) { - U8 aPacket[SEGGER_SYSVIEW_INFO_SIZE + 5 * SEGGER_SYSVIEW_QUANTA_U32]; - U8* pPayload; - // - pPayload = SEGGER_SYSVIEW_PREPARE_PACKET(aPacket); // Prepare the packet for SystemView - pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, Para0); // Add the first parameter to the packet - pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, Para1); // Add the second parameter to the packet - pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, Para2); // Add the third parameter to the packet - pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, Para3); // Add the fourth parameter to the packet - pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, Para4); // Add the fifth parameter to the packet - // - SEGGER_SYSVIEW_SendPacket(&aPacket[0], pPayload, Id); // Send the packet -} - /********************************************************************* * * Public API structures diff --git a/components/app_trace/sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.h b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.h similarity index 66% rename from components/app_trace/sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.h rename to components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.h index b03fba82cd19..b9066a8fe4c1 100644 --- a/components/app_trace/sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.h +++ b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.h @@ -1,14 +1,16 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause + * + * SPDX-FileContributor: 2023 Espressif Systems (Shanghai) CO LTD */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -22,24 +24,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -57,14 +49,15 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.32 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW_FreeRTOS.h Purpose : Interface between FreeRTOS and SystemView. -Revision: $Rev: 3734 $ + Tested with FreeRTOS V10.4.3 +Revision: $Rev: 7745 $ Notes: (1) Include this file at the end of FreeRTOSConfig.h @@ -90,7 +83,6 @@ Revision: $Rev: 3734 $ * ********************************************************************** */ - // for dual-core targets we use event ID to keep core ID bit (0 or 1) // use the highest - 1 bit of event ID to indicate core ID // the highest bit can not be used due to event ID encoding method @@ -210,56 +202,78 @@ Revision: $Rev: 3734 $ #define apiID_XEVENTGROUPSYNC (71u) #define apiID_VEVENTGROUPDELETE (72u) #define apiID_UXEVENTGROUPGETNUMBER (73u) +#define apiID_XSTREAMBUFFERCREATE (74u) +#define apiID_VSTREAMBUFFERDELETE (75u) +#define apiID_XSTREAMBUFFERRESET (76u) +#define apiID_XSTREAMBUFFERSEND (77u) +#define apiID_XSTREAMBUFFERSENDFROMISR (78u) +#define apiID_XSTREAMBUFFERRECEIVE (79u) +#define apiID_XSTREAMBUFFERRECEIVEFROMISR (80u) #ifdef CONFIG_FREERTOS_SMP -#define traceQUEUE_SEND( pxQueue ) SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), 0, 0, 0) +#define traceQUEUE_SEND( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), 0u, 0u, 0u) #else // CONFIG_FREERTOS_SMP #if ( configUSE_QUEUE_SETS != 1 ) - #define traceQUEUE_SEND( pxQueue ) SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, xTicksToWait, xCopyPosition) + #define traceQUEUE_SEND( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, xTicksToWait, xCopyPosition) #else - #define traceQUEUE_SEND( pxQueue ) SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), 0, 0, 0) + #define traceQUEUE_SEND( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), 0u, 0u, 0u) #endif #endif // CONFIG_FREERTOS_SMP -#define traceTASK_NOTIFY_TAKE( uxIndexToWait ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_ULTASKNOTIFYTAKE, xClearCountOnExit, xTicksToWait) -#define traceTASK_DELAY() SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_VTASKDELAY, xTicksToDelay) -#define traceTASK_DELAY_UNTIL( xTimeToWake ) SEGGER_SYSVIEW_RecordVoid(apiFastID_OFFSET + apiID_VTASKDELAYUNTIL) -#define traceTASK_DELETE( pxTCB ) do { \ - SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_VTASKDELETE, \ - SEGGER_SYSVIEW_ShrinkId((U32)pxTCB)); \ - SYSVIEW_DeleteTask((U32)pxTCB); \ - } while(0) -#define traceTASK_NOTIFY_GIVE_FROM_ISR( uxIndexToNotify ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_VTASKNOTIFYGIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB), (U32)pxHigherPriorityTaskWoken) -#define traceTASK_PRIORITY_INHERIT( pxTCB, uxPriority ) SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_VTASKPRIORITYINHERIT, (U32)pxMutexHolder) -#define traceTASK_RESUME( pxTCB ) SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_VTASKRESUME, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB)) -#define traceINCREASE_TICK_COUNT( xTicksToJump ) SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_VTASKSTEPTICK, xTicksToJump) -#define traceTASK_SUSPEND( pxTCB ) SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_VTASKSUSPEND, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB)) -#define traceTASK_PRIORITY_DISINHERIT( pxTCB, uxBasePriority ) SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_XTASKPRIORITYDISINHERIT, (U32)pxMutexHolder) -#define traceTASK_RESUME_FROM_ISR( pxTCB ) SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_XTASKRESUMEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB)) -#define traceTASK_NOTIFY( uxIndexToNotify ) SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XTASKGENERICNOTIFY, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB), ulValue, eAction, (U32)pulPreviousNotificationValue) -#define traceTASK_NOTIFY_FROM_ISR( uxIndexToNotify ) SYSVIEW_RecordU32x5(apiFastID_OFFSET + apiID_XTASKGENERICNOTIFYFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB), ulValue, eAction, (U32)pulPreviousNotificationValue, (U32)pxHigherPriorityTaskWoken) -#define traceTASK_NOTIFY_WAIT( uxIndexToWait ) SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XTASKNOTIFYWAIT, ulBitsToClearOnEntry, ulBitsToClearOnExit, (U32)pulNotificationValue, xTicksToWait) - -#define traceQUEUE_CREATE( pxNewQueue ) SEGGER_SYSVIEW_RecordU32x3(apiFastID_OFFSET + apiID_XQUEUEGENERICCREATE, uxQueueLength, uxItemSize, ucQueueType) -#define traceQUEUE_DELETE( pxQueue ) SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_VQUEUEDELETE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue)) -#define traceQUEUE_PEEK( pxQueue ) SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), xTicksToWait, 0) -#define traceQUEUE_PEEK_FROM_ISR( pxQueue ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEPEEKFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer)) -#define traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEPEEKFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer)) -#define traceQUEUE_RECEIVE( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)0), xTicksToWait, 1) -#define traceQUEUE_RECEIVE_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)0), xTicksToWait, 1) -#define traceQUEUE_SEMAPHORE_RECEIVE( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)0), xTicksToWait, 0) -#define traceQUEUE_RECEIVE_FROM_ISR( pxQueue ) SEGGER_SYSVIEW_RecordU32x3(apiFastID_OFFSET + apiID_XQUEUERECEIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), (U32)pxHigherPriorityTaskWoken) -#define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x3(apiFastID_OFFSET + apiID_XQUEUERECEIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), (U32)pxHigherPriorityTaskWoken) -#define traceQUEUE_REGISTRY_ADD( xQueue, pcQueueName ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_VQUEUEADDTOREGISTRY, SEGGER_SYSVIEW_ShrinkId((U32)xQueue), (U32)pcQueueName) -#define traceQUEUE_SEND_FAILED( pxQueue ) SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, xTicksToWait, xCopyPosition) -#define traceQUEUE_SEND_FROM_ISR( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSENDFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, (U32)pxHigherPriorityTaskWoken, xCopyPosition) -#define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSENDFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, (U32)pxHigherPriorityTaskWoken, xCopyPosition) -#define traceQUEUE_GIVE_FROM_ISR( pxQueue ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEGIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pxHigherPriorityTaskWoken) -#define traceQUEUE_GIVE_FROM_ISR_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEGIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pxHigherPriorityTaskWoken) + +#define traceSTART() SEGGER_SYSVIEW_Conf() + +#define traceTASK_NOTIFY_TAKE(uxIndexToWait) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_ULTASKNOTIFYTAKE, xClearCountOnExit, xTicksToWait) +#define traceTASK_DELAY() SEGGER_SYSVIEW_RecordU32 (apiFastID_OFFSET + apiID_VTASKDELAY, xTicksToDelay) +#define traceTASK_DELAY_UNTIL(xTimeToWake) SEGGER_SYSVIEW_RecordVoid (apiFastID_OFFSET + apiID_VTASKDELAYUNTIL) +#define traceTASK_NOTIFY_GIVE_FROM_ISR(uxIndexToNotify) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_VTASKNOTIFYGIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB), (U32)pxHigherPriorityTaskWoken) + +#define traceTASK_PRIORITY_INHERIT( pxTCB, uxPriority ) SEGGER_SYSVIEW_RecordU32 (apiFastID_OFFSET + apiID_VTASKPRIORITYINHERIT, (U32)pxMutexHolder) +#define traceTASK_RESUME( pxTCB ) SEGGER_SYSVIEW_RecordU32 (apiFastID_OFFSET + apiID_VTASKRESUME, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB)) +#define traceINCREASE_TICK_COUNT( xTicksToJump ) SEGGER_SYSVIEW_RecordU32 (apiFastID_OFFSET + apiID_VTASKSTEPTICK, xTicksToJump) +#define traceTASK_SUSPEND( pxTCB ) SEGGER_SYSVIEW_RecordU32 (apiFastID_OFFSET + apiID_VTASKSUSPEND, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB)) +#define traceTASK_PRIORITY_DISINHERIT( pxTCB, uxBasePriority ) SEGGER_SYSVIEW_RecordU32 (apiFastID_OFFSET + apiID_XTASKPRIORITYDISINHERIT, (U32)pxMutexHolder) +#define traceTASK_RESUME_FROM_ISR( pxTCB ) SEGGER_SYSVIEW_RecordU32 (apiFastID_OFFSET + apiID_XTASKRESUMEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB)) +#define traceTASK_NOTIFY(uxIndexToNotify) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XTASKGENERICNOTIFY, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB), ulValue, eAction, (U32)pulPreviousNotificationValue) +#define traceTASK_NOTIFY_FROM_ISR(uxIndexToWait) SEGGER_SYSVIEW_RecordU32x5(apiFastID_OFFSET + apiID_XTASKGENERICNOTIFYFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB), ulValue, eAction, (U32)pulPreviousNotificationValue, (U32)pxHigherPriorityTaskWoken) +#define traceTASK_NOTIFY_WAIT(uxIndexToWait) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XTASKNOTIFYWAIT, ulBitsToClearOnEntry, ulBitsToClearOnExit, (U32)pulNotificationValue, xTicksToWait) + +#define traceQUEUE_CREATE( pxNewQueue ) SEGGER_SYSVIEW_RecordU32x3(apiFastID_OFFSET + apiID_XQUEUEGENERICCREATE, uxQueueLength, uxItemSize, ucQueueType) +#define traceQUEUE_DELETE( pxQueue ) SEGGER_SYSVIEW_RecordU32 (apiFastID_OFFSET + apiID_VQUEUEDELETE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue)) +#define traceQUEUE_PEEK( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), xTicksToWait, 1) +#define traceQUEUE_PEEK_FROM_ISR( pxQueue ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEPEEKFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer)) +#define traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEPEEKFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer)) +#define traceQUEUE_RECEIVE( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)0), xTicksToWait, 1) +#define traceQUEUE_RECEIVE_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)0), xTicksToWait, 1) +#define traceQUEUE_SEMAPHORE_RECEIVE( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)0), xTicksToWait, 0) +#define traceQUEUE_RECEIVE_FROM_ISR( pxQueue ) SEGGER_SYSVIEW_RecordU32x3(apiFastID_OFFSET + apiID_XQUEUERECEIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), (U32)pxHigherPriorityTaskWoken) +#define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x3(apiFastID_OFFSET + apiID_XQUEUERECEIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), (U32)pxHigherPriorityTaskWoken) +#define traceQUEUE_REGISTRY_ADD( xQueue, pcQueueName ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_VQUEUEADDTOREGISTRY, SEGGER_SYSVIEW_ShrinkId((U32)xQueue), (U32)pcQueueName) +#define traceQUEUE_SEND_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, xTicksToWait, xCopyPosition) +#define traceQUEUE_SEND_FROM_ISR( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSENDFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, (U32)pxHigherPriorityTaskWoken, xCopyPosition) +#define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSENDFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, (U32)pxHigherPriorityTaskWoken, xCopyPosition) +#define traceQUEUE_GIVE_FROM_ISR( pxQueue ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEGIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pxHigherPriorityTaskWoken) +#define traceQUEUE_GIVE_FROM_ISR_FAILED( pxQueue ) SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEGIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pxHigherPriorityTaskWoken) +#define traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer ) SEGGER_SYSVIEW_RecordU32x2(apiSlowID_OFFSET + apiID_XSTREAMBUFFERCREATE, (U32)xIsMessageBuffer, (U32)pxStreamBuffer) +#define traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer ) SEGGER_SYSVIEW_RecordU32x2(apiSlowID_OFFSET + apiID_XSTREAMBUFFERCREATE, (U32)xIsMessageBuffer, 0u) +#define traceSTREAM_BUFFER_DELETE( xStreamBuffer ) SEGGER_SYSVIEW_RecordU32 (apiSlowID_OFFSET + apiID_VSTREAMBUFFERDELETE, (U32)xStreamBuffer) +#define traceSTREAM_BUFFER_RESET( xStreamBuffer ) SEGGER_SYSVIEW_RecordU32 (apiSlowID_OFFSET + apiID_XSTREAMBUFFERRESET, (U32)xStreamBuffer) +#define traceSTREAM_BUFFER_SEND( xStreamBuffer, xBytesSent ) SEGGER_SYSVIEW_RecordU32x2(apiSlowID_OFFSET + apiID_XSTREAMBUFFERSEND, (U32)xStreamBuffer, (U32)xBytesSent) +#define traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer ) SEGGER_SYSVIEW_RecordU32x2(apiSlowID_OFFSET + apiID_XSTREAMBUFFERSEND, (U32)xStreamBuffer, 0u) +#define traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xBytesSent ) SEGGER_SYSVIEW_RecordU32x2(apiSlowID_OFFSET + apiID_XSTREAMBUFFERSENDFROMISR, (U32)xStreamBuffer, (U32)xBytesSent) +#define traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength ) SEGGER_SYSVIEW_RecordU32x2(apiSlowID_OFFSET + apiID_XSTREAMBUFFERRECEIVE, (U32)xStreamBuffer, (U32)xReceivedLength) +#define traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer ) SEGGER_SYSVIEW_RecordU32x2(apiSlowID_OFFSET + apiID_XSTREAMBUFFERRECEIVE, (U32)xStreamBuffer, 0u) +#define traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength ) SEGGER_SYSVIEW_RecordU32x2(apiSlowID_OFFSET + apiID_XSTREAMBUFFERRECEIVEFROMISR, (U32)xStreamBuffer, (U32)xReceivedLength) + +#define traceTASK_DELETE( pxTCB ) do { \ + SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_VTASKDELETE, SEGGER_SYSVIEW_ShrinkId((U32)pxTCB)); \ + SYSVIEW_DeleteTask((U32)pxTCB); \ + } while(0) + #if( portSTACK_GROWTH < 0 ) #define traceTASK_CREATE(pxNewTCB) if (pxNewTCB != NULL) { \ @@ -303,10 +317,10 @@ Revision: $Rev: 3734 $ // but it deos not seem to be efficient enough to be worth of making code more complex and less readabl. // So always use task name comparison mechanism for SMP kernel. #if ( INCLUDE_xTaskGetIdleTaskHandle == 1 && !defined(CONFIG_FREERTOS_SMP)) - #define traceTASK_SWITCHED_IN() if(prvGetTCBFromHandle(NULL) == xTaskGetIdleTaskHandle()) { \ + #define traceTASK_SWITCHED_IN() if(prvGetTCBFromHandle(NULL) == xTaskGetIdleTaskHandle()) { \ SEGGER_SYSVIEW_OnIdle(); \ } else { \ - SEGGER_SYSVIEW_OnTaskStartExec((U32)prvGetTCBFromHandle(NULL)); \ + SEGGER_SYSVIEW_OnTaskStartExec((U32)prvGetTCBFromHandle(NULL)); \ } #else #define traceTASK_SWITCHED_IN() { \ @@ -317,16 +331,18 @@ Revision: $Rev: 3734 $ } \ } #endif + #define traceMOVED_TASK_TO_READY_STATE(pxTCB) SEGGER_SYSVIEW_OnTaskStartReady((U32)pxTCB) #define traceREADDED_TASK_TO_READY_STATE(pxTCB) -#define traceMOVED_TASK_TO_DELAYED_LIST() SEGGER_SYSVIEW_OnTaskStopReady((U32)prvGetTCBFromHandle(NULL)], (1u << 2)) -#define traceMOVED_TASK_TO_OVERFLOW_DELAYED_LIST() SEGGER_SYSVIEW_OnTaskStopReady((U32)prvGetTCBFromHandle(NULL)], (1u << 2)) +#define traceMOVED_TASK_TO_DELAYED_LIST() SEGGER_SYSVIEW_OnTaskStopReady((U32)prvGetTCBFromHandle(NULL), (1u << 2)) +#define traceMOVED_TASK_TO_OVERFLOW_DELAYED_LIST() SEGGER_SYSVIEW_OnTaskStopReady((U32)prvGetTCBFromHandle(NULL), (1u << 2)) #define traceMOVED_TASK_TO_SUSPENDED_LIST(pxTCB) SEGGER_SYSVIEW_OnTaskStopReady((U32)pxTCB, ((3u << 3) | 3)) + #define traceISR_EXIT_TO_SCHEDULER() SEGGER_SYSVIEW_RecordExitISRToScheduler() #define traceISR_EXIT() SEGGER_SYSVIEW_RecordExitISR() -#define traceISR_ENTER(_n_) SEGGER_SYSVIEW_RecordEnterISR(_n_) +#define traceISR_ENTER(n) SEGGER_SYSVIEW_RecordEnterISR(n) /********************************************************************* * @@ -341,8 +357,6 @@ void SYSVIEW_AddTask (U32 xHandle, const char* pcTaskName, unsigned uxCurre void SYSVIEW_UpdateTask (U32 xHandle, const char* pcTaskName, unsigned uxCurrentPriority, U32 pxStack, unsigned uStackHighWaterMark); void SYSVIEW_DeleteTask (U32 xHandle); void SYSVIEW_SendTaskInfo (U32 TaskID, const char* sName, unsigned Prio, U32 StackBase, unsigned StackSize); -void SYSVIEW_RecordU32x4 (unsigned Id, U32 Para0, U32 Para1, U32 Para2, U32 Para3); -void SYSVIEW_RecordU32x5 (unsigned Id, U32 Para0, U32 Para1, U32 Para2, U32 Para3, U32 Para4); #ifdef __cplusplus } diff --git a/docs/en/COPYRIGHT.rst b/docs/en/COPYRIGHT.rst index 329d295bbc0c..97eee7290776 100644 --- a/docs/en/COPYRIGHT.rst +++ b/docs/en/COPYRIGHT.rst @@ -63,7 +63,7 @@ These third party libraries can be included into the application (firmware) prod * :component:`HTTP Parser ` Based on src/http/ngx_http_parse.c from NGINX copyright Igor Sysoev. Additional changes are licensed under the same terms as NGINX and Joyent, Inc. and other Node contributors. For details please check :component_file:`LICENSE file`. -* `SEGGER SystemView`_ target-side library, Copyright (c) 2015-2017 SEGGER Microcontroller GmbH & Co. KG, is licensed under BSD 3-clause license. +* `SEGGER SystemView`_ target-side library, Copyright (c) 1995-2021 SEGGER Microcontroller GmbH, is licensed under BSD 1-clause license. Documentation ------------- diff --git a/tools/ci/check_copyright_config.yaml b/tools/ci/check_copyright_config.yaml index ff6709e25be6..8a63073a18cc 100644 --- a/tools/ci/check_copyright_config.yaml +++ b/tools/ci/check_copyright_config.yaml @@ -108,6 +108,7 @@ systemview: - 'components/app_trace/sys_view' allowed_licenses: - Apache-2.0 + - BSD-1-Clause - BSD-3-Clause license_for_new_files: Apache-2.0 diff --git a/tools/esp_app_trace/SYSVIEW_FreeRTOS.txt b/tools/esp_app_trace/SYSVIEW_FreeRTOS.txt index 3d5177124176..3053610012fe 100644 --- a/tools/esp_app_trace/SYSVIEW_FreeRTOS.txt +++ b/tools/esp_app_trace/SYSVIEW_FreeRTOS.txt @@ -102,6 +102,13 @@ 60 xEventGroupGetBitsFromISR xEventGroup=%u 199 vEventGroupDelete xEventGroup=%u 200 uxEventGroupGetNumber xEventGroup=%u +201 xStreamBufferCreate xIsMessageBuffer=%u pxStreamBuffer=%p +202 vStreamBufferDelete xStreamBuffer=%p +203 xStreamBufferReset xStreamBuffer=%p +204 xStreamBufferSend xStreamBuffer=%p xBytesSent=%u +205 xStreamBufferSendFromISR xStreamBuffer=%p xBytesSent=%u +206 xStreamBufferReceive xStreamBuffer=%p xReceivedLength=%u +207 xStreamBufferReceiveFromISR xStreamBuffer=%p xReceivedLength=%u 512 esp_sysview_heap_trace_alloc addr=%p size=%u callers=%x 513 esp_sysview_heap_trace_free addr=%p callers=%x diff --git a/tools/esp_app_trace/test/sysview/expected_output.json b/tools/esp_app_trace/test/sysview/expected_output.json index 15363b2aeda6..ea5ab64374ba 100644 --- a/tools/esp_app_trace/test/sysview/expected_output.json +++ b/tools/esp_app_trace/test/sysview/expected_output.json @@ -3847,6 +3847,7 @@ "vQueueAddToRegistry": 52, "vQueueDelete": 48, "vQueueUnregisterQueue": 182, + "vStreamBufferDelete": 202, "vTaskAllocateMPURegions": 128, "vTaskDelay": 34, "vTaskDelayUntil": 35, @@ -3902,6 +3903,12 @@ "xQueueSelectFromSet": 186, "xQueueSelectFromSetFromISR": 187, "xQueueTakeMutexRecursive": 180, + "xStreamBufferCreate": 201, + "xStreamBufferReceive": 206, + "xStreamBufferReceiveFromISR": 207, + "xStreamBufferReset": 203, + "xStreamBufferSend": 204, + "xStreamBufferSendFromISR": 205, "xTaskCallApplicationTaskHook": 143, "xTaskCheckForTimeOut": 151, "xTaskGenericCreate": 154, diff --git a/tools/esp_app_trace/test/sysview/expected_output_mcore.json b/tools/esp_app_trace/test/sysview/expected_output_mcore.json index ef40bf85421d..c6c03e982a12 100644 --- a/tools/esp_app_trace/test/sysview/expected_output_mcore.json +++ b/tools/esp_app_trace/test/sysview/expected_output_mcore.json @@ -243336,6 +243336,7 @@ "vQueueAddToRegistry": 52, "vQueueDelete": 48, "vQueueUnregisterQueue": 182, + "vStreamBufferDelete": 202, "vTaskAllocateMPURegions": 128, "vTaskDelay": 34, "vTaskDelayUntil": 35, @@ -243391,6 +243392,12 @@ "xQueueSelectFromSet": 186, "xQueueSelectFromSetFromISR": 187, "xQueueTakeMutexRecursive": 180, + "xStreamBufferCreate": 201, + "xStreamBufferReceive": 206, + "xStreamBufferReceiveFromISR": 207, + "xStreamBufferReset": 203, + "xStreamBufferSend": 204, + "xStreamBufferSendFromISR": 205, "xTaskCallApplicationTaskHook": 143, "xTaskCheckForTimeOut": 151, "xTaskGenericCreate": 154, From 8b824d4f7928b39ee6b2789bfa4cbd35b4e5f5ed Mon Sep 17 00:00:00 2001 From: Alexey Lapshin Date: Fri, 20 Jan 2023 17:43:12 +0700 Subject: [PATCH 2/3] apptrace: fix SystemView example test add trace svdat file to artifacts --- .../pytest_sysview_tracing_heap_log.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py b/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py index 0e9eff9f450b..55355e5e8716 100644 --- a/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py +++ b/examples/system/sysview_tracing_heap_log/pytest_sysview_tracing_heap_log.py @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD +# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD # SPDX-License-Identifier: Unlicense OR CC0-1.0 import os.path import time @@ -7,8 +7,6 @@ import pytest from pytest_embedded_idf import IdfDut -TEMP_FILE = os.path.join(os.path.dirname(__file__), 'heap_log.svdat') - @pytest.mark.esp32 @pytest.mark.jtag @@ -16,12 +14,14 @@ 'esp,idf,jtag', ], indirect=True) def test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: + trace_log = os.path.join(os.path.dirname(dut.gdb._logfile), 'heap_log.svdat') # pylint: disable=protected-access + dut.gdb.write('mon reset halt') dut.gdb.write('flushregs') dut.gdb.write('tb heap_trace_start') dut.gdb.write('commands', non_blocking=True) - dut.gdb.write(f'mon esp sysview start file://{TEMP_FILE}', non_blocking=True) + dut.gdb.write(f'mon esp sysview start file://{trace_log}', non_blocking=True) dut.gdb.write('c', non_blocking=True) dut.gdb.write('end') @@ -30,14 +30,14 @@ def test_examples_sysview_tracing_heap_log(idf_path: str, dut: IdfDut) -> None: dut.gdb.write('mon esp sysview stop', non_blocking=True) dut.gdb.write('end') - dut.gdb.write('c', non_blocking=True) + dut.gdb.write('c') dut.expect('esp_apptrace: Initialized TRAX on CPU0') time.sleep(1) # make sure that the sysview file has been generated with pexpect.spawn(' '.join([os.path.join(idf_path, 'tools', 'esp_app_trace', 'sysviewtrace_proc.py'), '-p', '-b', dut.app.elf_file, - TEMP_FILE])) as sysviewtrace: + trace_log])) as sysviewtrace: sysviewtrace.expect(r'Found \d+ leaked bytes in \d+ blocks.', timeout=120) with open(dut.gdb._logfile) as fr: # pylint: disable=protected-access From 18e5627a865fae892d7332f9cac77dc01424b58e Mon Sep 17 00:00:00 2001 From: Alexey Lapshin Date: Tue, 24 Jan 2023 17:48:40 +0700 Subject: [PATCH 3/3] sys_view: upgrade to version 3.42 --- components/app_trace/sys_view/Config/Global.h | 2 +- .../sys_view/Config/SEGGER_RTT_Conf.h | 2 +- .../sys_view/Config/SEGGER_SYSVIEW_Conf.h | 2 +- components/app_trace/sys_view/SEGGER/SEGGER.h | 2 +- .../app_trace/sys_view/SEGGER/SEGGER_RTT.h | 2 +- .../sys_view/SEGGER/SEGGER_SYSVIEW.c | 193 +++++++++++++++++- .../sys_view/SEGGER/SEGGER_SYSVIEW.h | 13 +- .../SEGGER/SEGGER_SYSVIEW_ConfDefaults.h | 2 +- .../sys_view/SEGGER/SEGGER_SYSVIEW_Int.h | 2 +- .../esp/SEGGER_SYSVIEW_Config_FreeRTOS.c | 28 +-- .../FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.c | 2 +- .../FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.h | 2 +- tools/ci/check_copyright_config.yaml | 1 - 13 files changed, 212 insertions(+), 41 deletions(-) diff --git a/components/app_trace/sys_view/Config/Global.h b/components/app_trace/sys_view/Config/Global.h index 5886cbfb6e57..ed2de5c3e9a6 100644 --- a/components/app_trace/sys_view/Config/Global.h +++ b/components/app_trace/sys_view/Config/Global.h @@ -47,7 +47,7 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** ---------------------------------------------------------------------- diff --git a/components/app_trace/sys_view/Config/SEGGER_RTT_Conf.h b/components/app_trace/sys_view/Config/SEGGER_RTT_Conf.h index 0e4dd04cb265..2049b18d5b41 100644 --- a/components/app_trace/sys_view/Config/SEGGER_RTT_Conf.h +++ b/components/app_trace/sys_view/Config/SEGGER_RTT_Conf.h @@ -47,7 +47,7 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** ---------------------------END-OF-HEADER------------------------------ diff --git a/components/app_trace/sys_view/Config/SEGGER_SYSVIEW_Conf.h b/components/app_trace/sys_view/Config/SEGGER_SYSVIEW_Conf.h index 0ff72730349c..b4bc13515d9f 100644 --- a/components/app_trace/sys_view/Config/SEGGER_SYSVIEW_Conf.h +++ b/components/app_trace/sys_view/Config/SEGGER_SYSVIEW_Conf.h @@ -47,7 +47,7 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- diff --git a/components/app_trace/sys_view/SEGGER/SEGGER.h b/components/app_trace/sys_view/SEGGER/SEGGER.h index bbabce812fc7..be33c34ca0e6 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER.h @@ -49,7 +49,7 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** ---------------------------------------------------------------------- diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_RTT.h b/components/app_trace/sys_view/SEGGER/SEGGER_RTT.h index 5d27d6984756..0fdb2f7177fb 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_RTT.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER_RTT.h @@ -47,7 +47,7 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** ---------------------------END-OF-HEADER------------------------------ diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.c b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.c index 669c7b54519f..10599986c87c 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.c +++ b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.c @@ -49,14 +49,14 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW.c Purpose : System visualization API implementation. -Revision: $Rev: 26232 $ +Revision: $Rev: 28341 $ Additional information: Packet format: @@ -781,14 +781,14 @@ static void _SendPacket(U8* pStartPacket, U8* pEndPacket, unsigned int EventId) // // Backwards U32 encode EventId. // - if (NumBytes < (1u << 14)) { // Encodes in 2 bytes + if (NumBytes < (1ul << 14)) { // Encodes in 2 bytes *--pStartPacket = (U8)(NumBytes >> 7); *--pStartPacket = (U8)(NumBytes | 0x80); - } else if (NumBytes < (1u << 21)) { // Encodes in 3 bytes + } else if (NumBytes < (1ul << 21)) { // Encodes in 3 bytes *--pStartPacket = (U8)(NumBytes >> 14); *--pStartPacket = (U8)((NumBytes >> 7) | 0x80); *--pStartPacket = (U8)(NumBytes | 0x80); - } else if (NumBytes < (1u << 28)) { // Encodes in 4 bytes + } else if (NumBytes < (1ul << 28)) { // Encodes in 4 bytes *--pStartPacket = (U8)(NumBytes >> 21); *--pStartPacket = (U8)((NumBytes >> 14) | 0x80); *--pStartPacket = (U8)((NumBytes >> 7) | 0x80); @@ -822,11 +822,11 @@ static void _SendPacket(U8* pStartPacket, U8* pEndPacket, unsigned int EventId) if (EventId < (1u << 14)) { // Encodes in 2 bytes *--pStartPacket = (U8)(EventId >> 7); *--pStartPacket = (U8)(EventId | 0x80); - } else if (EventId < (1u << 21)) { // Encodes in 3 bytes + } else if (EventId < (1ul << 21)) { // Encodes in 3 bytes *--pStartPacket = (U8)(EventId >> 14); *--pStartPacket = (U8)((EventId >> 7) | 0x80); *--pStartPacket = (U8)(EventId | 0x80); - } else if (EventId < (1u << 28)) { // Encodes in 4 bytes + } else if (EventId < (1ul << 28)) { // Encodes in 4 bytes *--pStartPacket = (U8)(EventId >> 21); *--pStartPacket = (U8)((EventId >> 14) | 0x80); *--pStartPacket = (U8)((EventId >> 7) | 0x80); @@ -1369,7 +1369,7 @@ static void _VPrintTarget(const char* sFormat, U32 Options, va_list* pParamList) * * Function description * Initializes the SYSVIEW module. -* Must be called before the Systemview Application connects to +* Must be called before the SystemView Application connects to * the system. * * Parameters @@ -1867,7 +1867,7 @@ void SEGGER_SYSVIEW_Start(void) { * Stop recording SystemView events. * * This function is triggered by the SystemView Application on disconnect. -* For single-shot or post-mortem mode recording, it can be called +* For single-shot or postmortem mode recording, it can be called * by the application. * * Additional information @@ -1978,7 +1978,7 @@ void SEGGER_SYSVIEW_SendTaskList(void) { * * Function description * Send the system description string to the host. -* The system description is used by the Systemview Application +* 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 @@ -2448,6 +2448,179 @@ void SEGGER_SYSVIEW_NameResource(U32 ResourceId, const char* sName) { RECORD_END(); } +/********************************************************************* +* +* SEGGER_SYSVIEW_HeapDefine() +* +* Function description +* Define heap. +* +* Parameters +* 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 implementations, 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); + ENCODE_U32(pPayload, MetadataSize); + _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_EX); + RECORD_END(); +} + +/********************************************************************* +* +* SEGGER_SYSVIEW_HeapAlloc() +* +* Function description +* Record a system-heap allocation event. +* +* Parameters +* pHeap - Pointer to heap where allocation was made. +* pUserData - Pointer to allocated user data. +* UserDataLen - Size of block allocated to hold user data, excluding any 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 SEGGER_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 SEGGER_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 SEGGER_SYSVIEW_ID_SHIFT, and describes the number of bytes that are +* consumed from managed memory from which SystemView can calculate +* accurate heap metrics. +*/ +void SEGGER_SYSVIEW_HeapAlloc(void *pHeap, void* pUserData, unsigned int UserDataLen) { + U8* pPayload; + U8* pPayloadStart; + RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 3 * SEGGER_SYSVIEW_QUANTA_U32); + // + pPayload = pPayloadStart; + ENCODE_U32(pPayload, SYSVIEW_EVTID_EX_HEAP_ALLOC); + ENCODE_U32(pPayload, SHRINK_ID((U32)pHeap)); + ENCODE_U32(pPayload, SHRINK_ID((U32)pUserData)); + ENCODE_U32(pPayload, UserDataLen >> SEGGER_SYSVIEW_ID_SHIFT); + _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_EX); + RECORD_END(); +} + +/********************************************************************* +* +* SEGGER_SYSVIEW_HeapAllocEx() +* +* Function description +* Record a per-heap allocation event. +* +* Parameters +* pHeap - Pointer to heap where allocation was made. +* pUserData - Pointer to allocated user data. +* UserDataLen - Size of block allocated to hold user data, excluding any 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 SEGGER_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 SEGGER_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 SEGGER_SYSVIEW_ID_SHIFT, and describes the number of bytes that are +* consumed from managed memory from which SystemView can calculate +* accurate heap metrics. +* +* See also +* SEGGER_SYSVIEW_HeapAlloc(). +*/ +void SEGGER_SYSVIEW_HeapAllocEx(void *pHeap, void* pUserData, unsigned int UserDataLen, unsigned int Tag) { + U8* pPayload; + U8* pPayloadStart; + RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 5 * SEGGER_SYSVIEW_QUANTA_U32); + // + pPayload = pPayloadStart; + ENCODE_U32(pPayload, SYSVIEW_EVTID_EX_HEAP_ALLOC_EX); + ENCODE_U32(pPayload, SHRINK_ID((U32)pHeap)); + ENCODE_U32(pPayload, SHRINK_ID((U32)pUserData)); + ENCODE_U32(pPayload, UserDataLen >> SEGGER_SYSVIEW_ID_SHIFT); + ENCODE_U32(pPayload, Tag); + _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_EX); + RECORD_END(); +} + +/********************************************************************* +* +* SEGGER_SYSVIEW_HeapFree() +* +* Function description +* Record a heap deallocation event. +* +* Parameters +* 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. +*/ +void SEGGER_SYSVIEW_HeapFree(void* pHeap, void* pUserData) { + U8* pPayload; + U8* pPayloadStart; + RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 2 * SEGGER_SYSVIEW_QUANTA_U32); + // + pPayload = pPayloadStart; + ENCODE_U32(pPayload, SYSVIEW_EVTID_EX_HEAP_FREE); + ENCODE_U32(pPayload, SHRINK_ID((U32)pHeap)); + ENCODE_U32(pPayload, SHRINK_ID((U32)pUserData)); + _SendPacket(pPayloadStart, pPayload, SYSVIEW_EVTID_EX); + RECORD_END(); +} + /********************************************************************* * * SEGGER_SYSVIEW_SendPacket() diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.h b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.h index 34f8a2360d22..b9cbac605bad 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.h @@ -49,13 +49,13 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW.h Purpose : System visualization API. -Revision: $Rev: 26226 $ +Revision: $Rev: 28237 $ */ #ifndef SEGGER_SYSVIEW_H @@ -137,6 +137,10 @@ extern "C" { // #define SYSVIEW_EVTID_EX_MARK 0 #define SYSVIEW_EVTID_EX_NAME_MARKER 1 +#define SYSVIEW_EVTID_EX_HEAP_DEFINE 2 +#define SYSVIEW_EVTID_EX_HEAP_ALLOC 3 +#define SYSVIEW_EVTID_EX_HEAP_ALLOC_EX 4 +#define SYSVIEW_EVTID_EX_HEAP_FREE 5 // // Event masks to disable/enable events // @@ -301,6 +305,11 @@ void SEGGER_SYSVIEW_MarkStop (unsigned int MarkerId); void SEGGER_SYSVIEW_Mark (unsigned int MarkerId); void SEGGER_SYSVIEW_NameMarker (unsigned int MarkerId, const char* sName); +void SEGGER_SYSVIEW_HeapDefine (void* pHeap, void* pBase, unsigned int HeapSize, unsigned int MetadataSize); +void SEGGER_SYSVIEW_HeapAlloc (void* pHeap, void* pUserData, unsigned int UserDataLen); +void SEGGER_SYSVIEW_HeapAllocEx (void* pHeap, void* pUserData, unsigned int UserDataLen, unsigned int Tag); +void SEGGER_SYSVIEW_HeapFree (void* pHeap, void* pUserData); + void SEGGER_SYSVIEW_NameResource (U32 ResourceId, const char* sName); int SEGGER_SYSVIEW_SendPacket (U8* pPacket, U8* pPayloadEnd, unsigned int EventId); diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h index e2364f70dbf7..c617e0db81e4 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h @@ -49,7 +49,7 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- diff --git a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_Int.h b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_Int.h index 40c4e240fac7..ded0b96b567d 100644 --- a/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_Int.h +++ b/components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_Int.h @@ -47,7 +47,7 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- diff --git a/components/app_trace/sys_view/Sample/FreeRTOSV10.4/Config/esp/SEGGER_SYSVIEW_Config_FreeRTOS.c b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/Config/esp/SEGGER_SYSVIEW_Config_FreeRTOS.c index 9e7a4aed4748..5dfbc869cea0 100644 --- a/components/app_trace/sys_view/Sample/FreeRTOSV10.4/Config/esp/SEGGER_SYSVIEW_Config_FreeRTOS.c +++ b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/Config/esp/SEGGER_SYSVIEW_Config_FreeRTOS.c @@ -1,16 +1,16 @@ /* - * SPDX-FileCopyrightText: 2015-2017 SEGGER Microcontroller GmbH & Co. KG + * SPDX-FileCopyrightText: 1995-2021 SEGGER Microcontroller GmbH * - * SPDX-License-Identifier: BSD-3-Clause + * SPDX-License-Identifier: BSD-1-Clause * * SPDX-FileContributor: 2017-2022 Espressif Systems (Shanghai) CO LTD */ /********************************************************************* -* SEGGER Microcontroller GmbH & Co. KG * +* SEGGER Microcontroller GmbH * * The Embedded Experts * ********************************************************************** * * -* (c) 2015 - 2017 SEGGER Microcontroller GmbH & Co. KG * +* (c) 1995 - 2021 SEGGER Microcontroller GmbH * * * * www.segger.com Support: support@segger.com * * * @@ -24,24 +24,14 @@ * * * SEGGER strongly recommends to not make any changes * * to or modify the source code of this software in order to stay * -* compatible with the RTT protocol and J-Link. * +* compatible with the SystemView and RTT protocol, and J-Link. * * * * Redistribution and use in source and binary forms, with or * * without modification, are permitted provided that the following * -* conditions are met: * +* condition is met: * * * * o Redistributions of source code must retain the above copyright * -* notice, this list of conditions and the following disclaimer. * -* * -* o Redistributions in binary form must reproduce the above * -* copyright notice, this list of conditions and the following * -* disclaimer in the documentation and/or other materials provided * -* with the distribution. * -* * -* o Neither the name of SEGGER Microcontroller GmbH & Co. KG * -* nor the names of its contributors may be used to endorse or * -* promote products derived from this software without specific * -* prior written permission. * +* notice, this condition and the following disclaimer. * * * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * @@ -59,14 +49,14 @@ * * ********************************************************************** * * -* SystemView version: V2.42 * +* SystemView version: 3.42 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : SEGGER_SYSVIEW_Config_FreeRTOS.c Purpose : Sample setup configuration of SystemView with FreeRTOS. -Revision: $Rev: 3734 $ +Revision: $Rev: 7745 $ */ #include "sdkconfig.h" #include "freertos/FreeRTOS.h" diff --git a/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.c b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.c index e1dccb7e1ea1..6754a322c881 100644 --- a/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.c +++ b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.c @@ -49,7 +49,7 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- diff --git a/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.h b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.h index b9066a8fe4c1..9bfa9b0a92a0 100644 --- a/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.h +++ b/components/app_trace/sys_view/Sample/FreeRTOSV10.4/SEGGER_SYSVIEW_FreeRTOS.h @@ -49,7 +49,7 @@ * * ********************************************************************** * * -* SystemView version: 3.32 * +* SystemView version: 3.42 * * * ********************************************************************** -------------------------- END-OF-HEADER ----------------------------- diff --git a/tools/ci/check_copyright_config.yaml b/tools/ci/check_copyright_config.yaml index 8a63073a18cc..4569bd455ad8 100644 --- a/tools/ci/check_copyright_config.yaml +++ b/tools/ci/check_copyright_config.yaml @@ -109,7 +109,6 @@ systemview: allowed_licenses: - Apache-2.0 - BSD-1-Clause - - BSD-3-Clause license_for_new_files: Apache-2.0 spiffs: