1 /********************************************************************* 2 * SEGGER Microcontroller GmbH * 3 * The Embedded Experts * 4 ********************************************************************** 5 * * 6 * (c) 1995 - 2021 SEGGER Microcontroller GmbH * 7 * * 8 * www.segger.com Support: support@segger.com * 9 * * 10 ********************************************************************** 11 * * 12 * SEGGER SystemView * Real-time application analysis * 13 * * 14 ********************************************************************** 15 * * 16 * All rights reserved. * 17 * * 18 * SEGGER strongly recommends to not make any changes * 19 * to or modify the source code of this software in order to stay * 20 * compatible with the SystemView and RTT protocol, and J-Link. * 21 * * 22 * Redistribution and use in source and binary forms, with or * 23 * without modification, are permitted provided that the following * 24 * condition is met: * 25 * * 26 * o Redistributions of source code must retain the above copyright * 27 * notice, this condition and the following disclaimer. * 28 * * 29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * 30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * 31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * 32 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * 33 * DISCLAIMED. IN NO EVENT SHALL SEGGER Microcontroller BE LIABLE FOR * 34 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * 35 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT * 36 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * 37 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * 38 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * 39 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE * 40 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH * 41 * DAMAGE. * 42 * * 43 ********************************************************************** 44 * * 45 * SystemView version: 3.40 * 46 * * 47 ********************************************************************** 48 ---------------------------END-OF-HEADER------------------------------ 49 File : SEGGER_RTT_Conf.h 50 Purpose : Implementation of SEGGER real-time transfer (RTT) which 51 allows real-time communication on targets which support 52 debugger memory accesses while the CPU is running. 53 Revision: $Rev: 24316 $ 54 55 */ 56 57 #ifndef SEGGER_RTT_CONF_H 58 #define SEGGER_RTT_CONF_H 59 60 #ifdef __IAR_SYSTEMS_ICC__ 61 #include <intrinsics.h> 62 #endif 63 64 /********************************************************************* 65 * 66 * Defines, configurable 67 * 68 ********************************************************************** 69 */ 70 71 // 72 // Take in and set to correct values for Cortex-A systems with CPU cache 73 // 74 //#define SEGGER_RTT_CPU_CACHE_LINE_SIZE (32) // Largest cache line size (in bytes) in the current system 75 //#define SEGGER_RTT_UNCACHED_OFF (0xFB000000) // Address alias where RTT CB and buffers can be accessed uncached 76 // 77 // Most common case: 78 // Up-channel 0: RTT 79 // Up-channel 1: SystemView 80 // 81 #define SEGGER_RTT_MAX_NUM_UP_BUFFERS CONFIG_SEGGER_RTT_MAX_NUM_UP_BUFFERS // Max. number of up-buffers (T->H) available on this target (Default: 3) 82 // 83 // Most common case: 84 // Down-channel 0: RTT 85 // Down-channel 1: SystemView 86 // 87 #define SEGGER_RTT_MAX_NUM_DOWN_BUFFERS CONFIG_SEGGER_RTT_MAX_NUM_DOWN_BUFFERS // Max. number of down-buffers (H->T) available on this target (Default: 3) 88 89 #define BUFFER_SIZE_UP CONFIG_SEGGER_RTT_BUFFER_SIZE_UP // Size of the buffer for terminal output of target, up to host (Default: 1k) 90 91 #define BUFFER_SIZE_DOWN CONFIG_SEGGER_RTT_BUFFER_SIZE_DOWN // Size of the buffer for terminal input to target from host (Usually keyboard input) (Default: 16) 92 93 #define SEGGER_RTT_PRINTF_BUFFER_SIZE CONFIG_SEGGER_RTT_PRINTF_BUFFER_SIZE // Size of buffer for RTT printf to bulk-send chars via RTT (Default: 64) 94 95 #define SEGGER_RTT_MODE_DEFAULT CONFIG_SEGGER_RTT_MODE // Mode for pre-initialized terminal channel (buffer 0) 96 97 #if defined(CONFIG_SEGGER_RTT_SECTION_DTCM) 98 #define SEGGER_RTT_SECTION ".dtcm_data" 99 #elif defined(CONFIG_SEGGER_RTT_SECTION_CCM) 100 #define SEGGER_RTT_SECTION ".ccm_data" 101 #elif defined(CONFIG_SEGGER_RTT_SECTION_CUSTOM) 102 #define SEGGER_RTT_SECTION CONFIG_SEGGER_RTT_SECTION_CUSTOM_NAME 103 #endif 104 105 /********************************************************************* 106 * 107 * RTT memcpy configuration 108 * 109 * memcpy() is good for large amounts of data, 110 * but the overhead is big for small amounts, which are usually stored via RTT. 111 * With SEGGER_RTT_MEMCPY_USE_BYTELOOP a simple byte loop can be used instead. 112 * 113 * SEGGER_RTT_MEMCPY() can be used to replace standard memcpy() in RTT functions. 114 * This is may be required with memory access restrictions, 115 * such as on Cortex-A devices with MMU. 116 */ 117 #if defined(CONFIG_SEGGER_RTT_MEMCPY_USE_BYTELOOP) 118 #define SEGGER_RTT_MEMCPY_USE_BYTELOOP 1 // 1: Use a simple byte-loop 119 #else 120 #ifndef SEGGER_RTT_MEMCPY_USE_BYTELOOP 121 #define SEGGER_RTT_MEMCPY_USE_BYTELOOP 0 // 0: Use memcpy/SEGGER_RTT_MEMCPY 122 #endif 123 #endif 124 // 125 // Example definition of SEGGER_RTT_MEMCPY to external memcpy with GCC toolchains and Cortex-A targets 126 // 127 //#if ((defined __SES_ARM) || (defined __CROSSWORKS_ARM) || (defined __GNUC__)) && (defined (__ARM_ARCH_7A__)) 128 // #define SEGGER_RTT_MEMCPY(pDest, pSrc, NumBytes) SEGGER_memcpy((pDest), (pSrc), (NumBytes)) 129 //#endif 130 131 // 132 // Target is not allowed to perform other RTT operations while string still has not been stored completely. 133 // Otherwise we would probably end up with a mixed string in the buffer. 134 // If using RTT from within interrupts, multiple tasks or multi processors, define the SEGGER_RTT_LOCK() and SEGGER_RTT_UNLOCK() function here. 135 // 136 // SEGGER_RTT_MAX_INTERRUPT_PRIORITY can be used in the sample lock routines on Cortex-M3/4. 137 // Make sure to mask all interrupts which can send RTT data, i.e. generate SystemView events, or cause task switches. 138 // When high-priority interrupts must not be masked while sending RTT data, SEGGER_RTT_MAX_INTERRUPT_PRIORITY needs to be adjusted accordingly. 139 // (Higher priority = lower priority number) 140 // Default value for embOS: 128u 141 // Default configuration in FreeRTOS: configMAX_SYSCALL_INTERRUPT_PRIORITY: ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) ) 142 // In case of doubt mask all interrupts: 1 << (8 - BASEPRI_PRIO_BITS) i.e. 1 << 5 when 3 bits are implemented in NVIC 143 // or define SEGGER_RTT_LOCK() to completely disable interrupts. 144 // 145 #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY 146 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) // Interrupt priority to lock on SEGGER_RTT_LOCK on Cortex-M3/4 (Default: 0x20) 147 #endif 148 149 /********************************************************************* 150 * 151 * RTT lock configuration for SEGGER Embedded Studio, 152 * Rowley CrossStudio and GCC 153 */ 154 #if ((defined(__SES_ARM) || defined(__SES_RISCV) || defined(__CROSSWORKS_ARM) || defined(__GNUC__) || defined(__clang__)) && !defined (__CC_ARM) && !defined(WIN32)) 155 #if defined(__ZEPHYR__) && defined (CONFIG_SEGGER_RTT_CUSTOM_LOCKING) 156 #ifdef CONFIG_MULTITHREADING 157 extern void zephyr_rtt_mutex_lock(void); 158 extern void zephyr_rtt_mutex_unlock(void); 159 #define SEGGER_RTT_LOCK() zephyr_rtt_mutex_lock() 160 #define SEGGER_RTT_UNLOCK() zephyr_rtt_mutex_unlock() 161 #else 162 extern unsigned int zephyr_rtt_irq_lock(void); 163 extern void zephyr_rtt_irq_unlock(unsigned int key); 164 #define SEGGER_RTT_LOCK() { \ 165 unsigned int key = zephyr_rtt_irq_lock() 166 #define SEGGER_RTT_UNLOCK() zephyr_rtt_irq_unlock(key); \ 167 } 168 #endif 169 #define RTT_USE_ASM 0 170 #elif (defined(__ARM_ARCH_6M__) || defined(__ARM_ARCH_8M_BASE__)) 171 #define SEGGER_RTT_LOCK() { \ 172 unsigned int _SEGGER_RTT__LockState; \ 173 __asm volatile ("mrs %0, primask \n\t" \ 174 "movs r1, #1 \n\t" \ 175 "msr primask, r1 \n\t" \ 176 : "=r" (_SEGGER_RTT__LockState) \ 177 : \ 178 : "r1", "cc" \ 179 ); 180 181 #define SEGGER_RTT_UNLOCK() __asm volatile ("msr primask, %0 \n\t" \ 182 : \ 183 : "r" (_SEGGER_RTT__LockState) \ 184 : \ 185 ); \ 186 } 187 #elif (defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7EM__) || defined(__ARM_ARCH_8M_MAIN__)) 188 #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY 189 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) 190 #endif 191 #define SEGGER_RTT_LOCK() { \ 192 unsigned int _SEGGER_RTT__LockState; \ 193 __asm volatile ("mrs %0, basepri \n\t" \ 194 "mov r1, %1 \n\t" \ 195 "msr basepri, r1 \n\t" \ 196 : "=r" (_SEGGER_RTT__LockState) \ 197 : "i"(SEGGER_RTT_MAX_INTERRUPT_PRIORITY) \ 198 : "r1", "cc" \ 199 ); 200 201 #define SEGGER_RTT_UNLOCK() __asm volatile ("msr basepri, %0 \n\t" \ 202 : \ 203 : "r" (_SEGGER_RTT__LockState) \ 204 : \ 205 ); \ 206 } 207 208 #elif (defined(__ARM_ARCH_7A__) || defined(__ARM_ARCH_7R__)) 209 #define SEGGER_RTT_LOCK() { \ 210 unsigned int _SEGGER_RTT__LockState; \ 211 __asm volatile ("mrs r1, CPSR \n\t" \ 212 "mov %0, r1 \n\t" \ 213 "orr r1, r1, #0xC0 \n\t" \ 214 "msr CPSR_c, r1 \n\t" \ 215 : "=r" (_SEGGER_RTT__LockState) \ 216 : \ 217 : "r1", "cc" \ 218 ); 219 220 #define SEGGER_RTT_UNLOCK() __asm volatile ("mov r0, %0 \n\t" \ 221 "mrs r1, CPSR \n\t" \ 222 "bic r1, r1, #0xC0 \n\t" \ 223 "and r0, r0, #0xC0 \n\t" \ 224 "orr r1, r1, r0 \n\t" \ 225 "msr CPSR_c, r1 \n\t" \ 226 : \ 227 : "r" (_SEGGER_RTT__LockState) \ 228 : "r0", "r1", "cc" \ 229 ); \ 230 } 231 #elif defined(__riscv) || defined(__riscv_xlen) 232 #define SEGGER_RTT_LOCK() { \ 233 unsigned int _SEGGER_RTT__LockState; \ 234 __asm volatile ("csrr %0, mstatus \n\t" \ 235 "csrci mstatus, 8 \n\t" \ 236 "andi %0, %0, 8 \n\t" \ 237 : "=r" (_SEGGER_RTT__LockState) \ 238 : \ 239 : \ 240 ); 241 242 #define SEGGER_RTT_UNLOCK() __asm volatile ("csrr a1, mstatus \n\t" \ 243 "or %0, %0, a1 \n\t" \ 244 "csrs mstatus, %0 \n\t" \ 245 : \ 246 : "r" (_SEGGER_RTT__LockState) \ 247 : "a1" \ 248 ); \ 249 } 250 #else 251 #define SEGGER_RTT_LOCK() 252 #define SEGGER_RTT_UNLOCK() 253 #endif 254 #endif 255 256 /********************************************************************* 257 * 258 * RTT lock configuration for IAR EWARM 259 */ 260 #ifdef __ICCARM__ 261 #if (defined (__ARM6M__) && (__CORE__ == __ARM6M__)) || \ 262 (defined (__ARM8M_BASELINE__) && (__CORE__ == __ARM8M_BASELINE__)) 263 #define SEGGER_RTT_LOCK() { \ 264 unsigned int _SEGGER_RTT__LockState; \ 265 _SEGGER_RTT__LockState = __get_PRIMASK(); \ 266 __set_PRIMASK(1); 267 268 #define SEGGER_RTT_UNLOCK() __set_PRIMASK(_SEGGER_RTT__LockState); \ 269 } 270 #elif (defined (__ARM7EM__) && (__CORE__ == __ARM7EM__)) || \ 271 (defined (__ARM7M__) && (__CORE__ == __ARM7M__)) || \ 272 (defined (__ARM8M_MAINLINE__) && (__CORE__ == __ARM8M_MAINLINE__)) || \ 273 (defined (__ARM8M_MAINLINE__) && (__CORE__ == __ARM8M_MAINLINE__)) 274 #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY 275 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) 276 #endif 277 #define SEGGER_RTT_LOCK() { \ 278 unsigned int _SEGGER_RTT__LockState; \ 279 _SEGGER_RTT__LockState = __get_BASEPRI(); \ 280 __set_BASEPRI(SEGGER_RTT_MAX_INTERRUPT_PRIORITY); 281 282 #define SEGGER_RTT_UNLOCK() __set_BASEPRI(_SEGGER_RTT__LockState); \ 283 } 284 #elif (defined (__ARM7A__) && (__CORE__ == __ARM7A__)) || \ 285 (defined (__ARM7R__) && (__CORE__ == __ARM7R__)) 286 #define SEGGER_RTT_LOCK() { \ 287 unsigned int _SEGGER_RTT__LockState; \ 288 __asm volatile ("mrs r1, CPSR \n\t" \ 289 "mov %0, r1 \n\t" \ 290 "orr r1, r1, #0xC0 \n\t" \ 291 "msr CPSR_c, r1 \n\t" \ 292 : "=r" (_SEGGER_RTT__LockState) \ 293 : \ 294 : "r1", "cc" \ 295 ); 296 297 #define SEGGER_RTT_UNLOCK() __asm volatile ("mov r0, %0 \n\t" \ 298 "mrs r1, CPSR \n\t" \ 299 "bic r1, r1, #0xC0 \n\t" \ 300 "and r0, r0, #0xC0 \n\t" \ 301 "orr r1, r1, r0 \n\t" \ 302 "msr CPSR_c, r1 \n\t" \ 303 : \ 304 : "r" (_SEGGER_RTT__LockState) \ 305 : "r0", "r1", "cc" \ 306 ); \ 307 } 308 #endif 309 #endif 310 311 /********************************************************************* 312 * 313 * RTT lock configuration for IAR RX 314 */ 315 #ifdef __ICCRX__ 316 #define SEGGER_RTT_LOCK() { \ 317 unsigned long _SEGGER_RTT__LockState; \ 318 _SEGGER_RTT__LockState = __get_interrupt_state(); \ 319 __disable_interrupt(); 320 321 #define SEGGER_RTT_UNLOCK() __set_interrupt_state(_SEGGER_RTT__LockState); \ 322 } 323 #endif 324 325 /********************************************************************* 326 * 327 * RTT lock configuration for IAR RL78 328 */ 329 #ifdef __ICCRL78__ 330 #define SEGGER_RTT_LOCK() { \ 331 __istate_t _SEGGER_RTT__LockState; \ 332 _SEGGER_RTT__LockState = __get_interrupt_state(); \ 333 __disable_interrupt(); 334 335 #define SEGGER_RTT_UNLOCK() __set_interrupt_state(_SEGGER_RTT__LockState); \ 336 } 337 #endif 338 339 /********************************************************************* 340 * 341 * RTT lock configuration for KEIL ARM 342 */ 343 #ifdef __CC_ARM 344 #if (defined __TARGET_ARCH_6S_M) 345 #define SEGGER_RTT_LOCK() { \ 346 unsigned int _SEGGER_RTT__LockState; \ 347 register unsigned char _SEGGER_RTT__PRIMASK __asm( "primask"); \ 348 _SEGGER_RTT__LockState = _SEGGER_RTT__PRIMASK; \ 349 _SEGGER_RTT__PRIMASK = 1u; \ 350 __schedule_barrier(); 351 352 #define SEGGER_RTT_UNLOCK() _SEGGER_RTT__PRIMASK = _SEGGER_RTT__LockState; \ 353 __schedule_barrier(); \ 354 } 355 #elif (defined(__TARGET_ARCH_7_M) || defined(__TARGET_ARCH_7E_M)) 356 #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY 357 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) 358 #endif 359 #define SEGGER_RTT_LOCK() { \ 360 unsigned int _SEGGER_RTT__LockState; \ 361 register unsigned char BASEPRI __asm( "basepri"); \ 362 _SEGGER_RTT__LockState = BASEPRI; \ 363 BASEPRI = SEGGER_RTT_MAX_INTERRUPT_PRIORITY; \ 364 __schedule_barrier(); 365 366 #define SEGGER_RTT_UNLOCK() BASEPRI = _SEGGER_RTT__LockState; \ 367 __schedule_barrier(); \ 368 } 369 #endif 370 #endif 371 372 /********************************************************************* 373 * 374 * RTT lock configuration for TI ARM 375 */ 376 #ifdef __TI_ARM__ 377 #if defined (__TI_ARM_V6M0__) 378 #define SEGGER_RTT_LOCK() { \ 379 unsigned int _SEGGER_RTT__LockState; \ 380 _SEGGER_RTT__LockState = __get_PRIMASK(); \ 381 __set_PRIMASK(1); 382 383 #define SEGGER_RTT_UNLOCK() __set_PRIMASK(_SEGGER_RTT__LockState); \ 384 } 385 #elif (defined (__TI_ARM_V7M3__) || defined (__TI_ARM_V7M4__)) 386 #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY 387 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) 388 #endif 389 #define SEGGER_RTT_LOCK() { \ 390 unsigned int _SEGGER_RTT__LockState; \ 391 _SEGGER_RTT__LockState = _set_interrupt_priority(SEGGER_RTT_MAX_INTERRUPT_PRIORITY); 392 393 #define SEGGER_RTT_UNLOCK() _set_interrupt_priority(_SEGGER_RTT__LockState); \ 394 } 395 #endif 396 #endif 397 398 /********************************************************************* 399 * 400 * RTT lock configuration for CCRX 401 */ 402 #ifdef __RX 403 #include <machine.h> 404 #define SEGGER_RTT_LOCK() { \ 405 unsigned long _SEGGER_RTT__LockState; \ 406 _SEGGER_RTT__LockState = get_psw() & 0x010000; \ 407 clrpsw_i(); 408 409 #define SEGGER_RTT_UNLOCK() set_psw(get_psw() | _SEGGER_RTT__LockState); \ 410 } 411 #endif 412 413 /********************************************************************* 414 * 415 * RTT lock configuration for embOS Simulation on Windows 416 * (Can also be used for generic RTT locking with embOS) 417 */ 418 #if defined(WIN32) || defined(SEGGER_RTT_LOCK_EMBOS) 419 420 void OS_SIM_EnterCriticalSection(void); 421 void OS_SIM_LeaveCriticalSection(void); 422 423 #define SEGGER_RTT_LOCK() { \ 424 OS_SIM_EnterCriticalSection(); 425 426 #define SEGGER_RTT_UNLOCK() OS_SIM_LeaveCriticalSection(); \ 427 } 428 #endif 429 430 /********************************************************************* 431 * 432 * RTT lock configuration fallback 433 */ 434 #ifndef SEGGER_RTT_LOCK 435 #define SEGGER_RTT_LOCK() // Lock RTT (nestable) (i.e. disable interrupts) 436 #endif 437 438 #ifndef SEGGER_RTT_UNLOCK 439 #define SEGGER_RTT_UNLOCK() // Unlock RTT (nestable) (i.e. enable previous interrupt lock state) 440 #endif 441 442 #endif 443 /*************************** End of file ****************************/ 444
