1 /********************************************************************* 2 * SEGGER Microcontroller GmbH * 3 * The Embedded Experts * 4 ********************************************************************** 5 * * 6 * (c) 1995 - 2018 SEGGER Microcontroller GmbH * 7 * * 8 * www.segger.com Support: [email protected] * 9 * * 10 ********************************************************************** 11 * * 12 * SEGGER RTT * Real Time Transfer for embedded targets * 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 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 * conditions are met: * 25 * * 26 * o Redistributions of source code must retain the above copyright * 27 * notice, this list of conditions and the following disclaimer. * 28 * * 29 * o Redistributions in binary form must reproduce the above * 30 * copyright notice, this list of conditions and the following * 31 * disclaimer in the documentation and/or other materials provided * 32 * with the distribution. * 33 * * 34 * o Neither the name of SEGGER Microcontroller GmbH * 35 * nor the names of its contributors may be used to endorse or * 36 * promote products derived from this software without specific * 37 * prior written permission. * 38 * * 39 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND * 40 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, * 41 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * 42 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * 43 * DISCLAIMED. IN NO EVENT SHALL SEGGER Microcontroller BE LIABLE FOR * 44 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * 45 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT * 46 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * 47 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * 48 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * 49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE * 50 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH * 51 * DAMAGE. * 52 * * 53 ********************************************************************** 54 ---------------------------END-OF-HEADER------------------------------ 55 File : SEGGER_RTT_Conf.h 56 Purpose : Implementation of SEGGER real-time transfer (RTT) which 57 allows real-time communication on targets which support 58 debugger memory accesses while the CPU is running. 59 Revision: $Rev: 15929 $ 60 61 */ 62 63 #ifndef SEGGER_RTT_CONF_H 64 #define SEGGER_RTT_CONF_H 65 66 #ifdef __IAR_SYSTEMS_ICC__ 67 #include <intrinsics.h> 68 #endif 69 70 /********************************************************************* 71 * 72 * Defines, configurable 73 * 74 ********************************************************************** 75 */ 76 77 #define SEGGER_RTT_MAX_NUM_UP_BUFFERS (3) // Max. number of up-buffers (T->H) available on this target (Default: 3) 78 #define SEGGER_RTT_MAX_NUM_DOWN_BUFFERS (3) // Max. number of down-buffers (H->T) available on this target (Default: 3) 79 80 #define BUFFER_SIZE_UP (1024) // Size of the buffer for terminal output of target, up to host (Default: 1k) 81 #define BUFFER_SIZE_DOWN (16) // Size of the buffer for terminal input to target from host (Usually keyboard input) (Default: 16) 82 83 #define SEGGER_RTT_PRINTF_BUFFER_SIZE (64u) // Size of buffer for RTT printf to bulk-send chars via RTT (Default: 64) 84 85 #define SEGGER_RTT_MODE_DEFAULT SEGGER_RTT_MODE_NO_BLOCK_SKIP // Mode for pre-initialized terminal channel (buffer 0) 86 87 /********************************************************************* 88 * 89 * RTT memcpy configuration 90 * 91 * memcpy() is good for large amounts of data, 92 * but the overhead is big for small amounts, which are usually stored via RTT. 93 * With SEGGER_RTT_MEMCPY_USE_BYTELOOP a simple byte loop can be used instead. 94 * 95 * SEGGER_RTT_MEMCPY() can be used to replace standard memcpy() in RTT functions. 96 * This is may be required with memory access restrictions, 97 * such as on Cortex-A devices with MMU. 98 */ 99 #define SEGGER_RTT_MEMCPY_USE_BYTELOOP 0 // 0: Use memcpy/SEGGER_RTT_MEMCPY, 1: Use a simple byte-loop 100 // 101 // Example definition of SEGGER_RTT_MEMCPY to external memcpy with GCC toolchains and Cortex-A targets 102 // 103 //#if ((defined __SES_ARM) || (defined __CROSSWORKS_ARM) || (defined __GNUC__)) && (defined (__ARM_ARCH_7A__)) 104 // #define SEGGER_RTT_MEMCPY(pDest, pSrc, NumBytes) SEGGER_memcpy((pDest), (pSrc), (NumBytes)) 105 //#endif 106 107 // 108 // Target is not allowed to perform other RTT operations while string still has not been stored completely. 109 // Otherwise we would probably end up with a mixed string in the buffer. 110 // If using RTT from within interrupts, multiple tasks or multi processors, define the SEGGER_RTT_LOCK() and SEGGER_RTT_UNLOCK() function here. 111 // 112 // SEGGER_RTT_MAX_INTERRUPT_PRIORITY can be used in the sample lock routines on Cortex-M3/4. 113 // Make sure to mask all interrupts which can send RTT data, i.e. generate SystemView events, or cause task switches. 114 // When high-priority interrupts must not be masked while sending RTT data, SEGGER_RTT_MAX_INTERRUPT_PRIORITY needs to be adjusted accordingly. 115 // (Higher priority = lower priority number) 116 // Default value for embOS: 128u 117 // Default configuration in FreeRTOS: configMAX_SYSCALL_INTERRUPT_PRIORITY: ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) ) 118 // In case of doubt mask all interrupts: 1 << (8 - BASEPRI_PRIO_BITS) i.e. 1 << 5 when 3 bits are implemented in NVIC 119 // or define SEGGER_RTT_LOCK() to completely disable interrupts. 120 // 121 122 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) // Interrupt priority to lock on SEGGER_RTT_LOCK on Cortex-M3/4 (Default: 0x20) 123 124 /********************************************************************* 125 * 126 * RTT lock configuration for SEGGER Embedded Studio, 127 * Rowley CrossStudio and GCC 128 */ 129 #if (defined(__SES_ARM) || defined(__CROSSWORKS_ARM) || defined(__GNUC__) || defined(__clang__)) && !defined (__CC_ARM) 130 #if (defined(__ARM_ARCH_6M__) || defined(__ARM_ARCH_8M_BASE__)) 131 #define SEGGER_RTT_LOCK() { \ 132 unsigned int LockState; \ 133 __asm volatile ("mrs %0, primask \n\t" \ 134 "movs r1, $1 \n\t" \ 135 "msr primask, r1 \n\t" \ 136 : "=r" (LockState) \ 137 : \ 138 : "r1" \ 139 ); 140 141 #define SEGGER_RTT_UNLOCK() __asm volatile ("msr primask, %0 \n\t" \ 142 : \ 143 : "r" (LockState) \ 144 : \ 145 ); \ 146 } 147 #elif (defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7EM__) || defined(__ARM_ARCH_8M_MAIN__)) 148 #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY 149 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) 150 #endif 151 #define SEGGER_RTT_LOCK() { \ 152 unsigned int LockState; \ 153 __asm volatile ("mrs %0, basepri \n\t" \ 154 "mov r1, %1 \n\t" \ 155 "msr basepri, r1 \n\t" \ 156 : "=r" (LockState) \ 157 : "i"(SEGGER_RTT_MAX_INTERRUPT_PRIORITY) \ 158 : "r1" \ 159 ); 160 161 #define SEGGER_RTT_UNLOCK() __asm volatile ("msr basepri, %0 \n\t" \ 162 : \ 163 : "r" (LockState) \ 164 : \ 165 ); \ 166 } 167 168 #elif defined(__ARM_ARCH_7A__) 169 #define SEGGER_RTT_LOCK() { \ 170 unsigned int LockState; \ 171 __asm volatile ("mrs r1, CPSR \n\t" \ 172 "mov %0, r1 \n\t" \ 173 "orr r1, r1, #0xC0 \n\t" \ 174 "msr CPSR_c, r1 \n\t" \ 175 : "=r" (LockState) \ 176 : \ 177 : "r1" \ 178 ); 179 180 #define SEGGER_RTT_UNLOCK() __asm volatile ("mov r0, %0 \n\t" \ 181 "mrs r1, CPSR \n\t" \ 182 "bic r1, r1, #0xC0 \n\t" \ 183 "and r0, r0, #0xC0 \n\t" \ 184 "orr r1, r1, r0 \n\t" \ 185 "msr CPSR_c, r1 \n\t" \ 186 : \ 187 : "r" (LockState) \ 188 : "r0", "r1" \ 189 ); \ 190 } 191 #endif 192 #endif 193 194 /********************************************************************* 195 * 196 * RTT lock configuration for IAR EWARM 197 */ 198 #ifdef __ICCARM__ 199 #if (defined (__ARM6M__) && (__CORE__ == __ARM6M__)) 200 #define SEGGER_RTT_LOCK() { \ 201 unsigned int LockState; \ 202 LockState = __get_PRIMASK(); \ 203 __set_PRIMASK(1); 204 205 #define SEGGER_RTT_UNLOCK() __set_PRIMASK(LockState); \ 206 } 207 #elif ((defined (__ARM7EM__) && (__CORE__ == __ARM7EM__)) || (defined (__ARM7M__) && (__CORE__ == __ARM7M__))) 208 #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY 209 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) 210 #endif 211 #define SEGGER_RTT_LOCK() { \ 212 unsigned int LockState; \ 213 LockState = __get_BASEPRI(); \ 214 __set_BASEPRI(SEGGER_RTT_MAX_INTERRUPT_PRIORITY); 215 216 #define SEGGER_RTT_UNLOCK() __set_BASEPRI(LockState); \ 217 } 218 #endif 219 #endif 220 221 /********************************************************************* 222 * 223 * RTT lock configuration for IAR RX 224 */ 225 #ifdef __ICCRX__ 226 #define SEGGER_RTT_LOCK() { \ 227 unsigned long LockState; \ 228 LockState = __get_interrupt_state(); \ 229 __disable_interrupt(); 230 231 #define SEGGER_RTT_UNLOCK() __set_interrupt_state(LockState); \ 232 } 233 #endif 234 235 /********************************************************************* 236 * 237 * RTT lock configuration for IAR RL78 238 */ 239 #ifdef __ICCRL78__ 240 #define SEGGER_RTT_LOCK() { \ 241 __istate_t LockState; \ 242 LockState = __get_interrupt_state(); \ 243 __disable_interrupt(); 244 245 #define SEGGER_RTT_UNLOCK() __set_interrupt_state(LockState); \ 246 } 247 #endif 248 249 /********************************************************************* 250 * 251 * RTT lock configuration for KEIL ARM 252 */ 253 #ifdef __CC_ARM 254 #if (defined __TARGET_ARCH_6S_M) 255 #define SEGGER_RTT_LOCK() { \ 256 unsigned int LockState; \ 257 register unsigned char PRIMASK __asm( "primask"); \ 258 LockState = PRIMASK; \ 259 PRIMASK = 1u; \ 260 __schedule_barrier(); 261 262 #define SEGGER_RTT_UNLOCK() PRIMASK = LockState; \ 263 __schedule_barrier(); \ 264 } 265 #elif (defined(__TARGET_ARCH_7_M) || defined(__TARGET_ARCH_7E_M)) 266 #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY 267 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) 268 #endif 269 #define SEGGER_RTT_LOCK() { \ 270 unsigned int LockState; \ 271 register unsigned char BASEPRI __asm( "basepri"); \ 272 LockState = BASEPRI; \ 273 BASEPRI = SEGGER_RTT_MAX_INTERRUPT_PRIORITY; \ 274 __schedule_barrier(); 275 276 #define SEGGER_RTT_UNLOCK() BASEPRI = LockState; \ 277 __schedule_barrier(); \ 278 } 279 #endif 280 #endif 281 282 /********************************************************************* 283 * 284 * RTT lock configuration for TI ARM 285 */ 286 #ifdef __TI_ARM__ 287 #if defined (__TI_ARM_V6M0__) 288 #define SEGGER_RTT_LOCK() { \ 289 unsigned int LockState; \ 290 LockState = __get_PRIMASK(); \ 291 __set_PRIMASK(1); 292 293 #define SEGGER_RTT_UNLOCK() __set_PRIMASK(LockState); \ 294 } 295 #elif (defined (__TI_ARM_V7M3__) || defined (__TI_ARM_V7M4__)) 296 #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY 297 #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) 298 #endif 299 #define SEGGER_RTT_LOCK() { \ 300 unsigned int LockState; \ 301 LockState = _set_interrupt_priority(SEGGER_RTT_MAX_INTERRUPT_PRIORITY); 302 303 #define SEGGER_RTT_UNLOCK() _set_interrupt_priority(LockState); \ 304 } 305 #endif 306 #endif 307 308 /********************************************************************* 309 * 310 * RTT lock configuration for CCRX 311 */ 312 #ifdef __RX 313 #define SEGGER_RTT_LOCK() { \ 314 unsigned long LockState; \ 315 LockState = get_psw() & 0x010000; \ 316 clrpsw_i(); 317 318 #define SEGGER_RTT_UNLOCK() set_psw(get_psw() | LockState); \ 319 } 320 #endif 321 322 /********************************************************************* 323 * 324 * RTT lock configuration fallback 325 */ 326 #ifndef SEGGER_RTT_LOCK 327 #define SEGGER_RTT_LOCK() // Lock RTT (nestable) (i.e. disable interrupts) 328 #endif 329 330 #ifndef SEGGER_RTT_UNLOCK 331 #define SEGGER_RTT_UNLOCK() // Unlock RTT (nestable) (i.e. enable previous interrupt lock state) 332 #endif 333 334 #endif 335 /*************************** End of file ****************************/ 336