SEGGER_RTT_Conf.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435
  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.30 *
  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: 21386 $
  54. */
  55. #ifndef SEGGER_RTT_CONF_H
  56. #define SEGGER_RTT_CONF_H
  57. #ifdef __IAR_SYSTEMS_ICC__
  58. #include <intrinsics.h>
  59. #endif
  60. /*********************************************************************
  61. *
  62. * Defines, configurable
  63. *
  64. **********************************************************************
  65. */
  66. //
  67. // Take in and set to correct values for Cortex-A systems with CPU cache
  68. //
  69. //#define SEGGER_RTT_CPU_CACHE_LINE_SIZE (32) // Largest cache line size (in bytes) in the current system
  70. //#define SEGGER_RTT_UNCACHED_OFF (0xFB000000) // Address alias where RTT CB and buffers can be accessed uncached
  71. //
  72. // Most common case:
  73. // Up-channel 0: RTT
  74. // Up-channel 1: SystemView
  75. //
  76. #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)
  77. //
  78. // Most common case:
  79. // Down-channel 0: RTT
  80. // Down-channel 1: SystemView
  81. //
  82. #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)
  83. #define BUFFER_SIZE_UP CONFIG_SEGGER_RTT_BUFFER_SIZE_UP // Size of the buffer for terminal output of target, up to host (Default: 1k)
  84. #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)
  85. #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)
  86. #define SEGGER_RTT_MODE_DEFAULT CONFIG_SEGGER_RTT_MODE // Mode for pre-initialized terminal channel (buffer 0)
  87. #if defined(CONFIG_SEGGER_RTT_SECTION_DTCM)
  88. #define SEGGER_RTT_SECTION ".dtcm_data"
  89. #endif
  90. /*********************************************************************
  91. *
  92. * RTT memcpy configuration
  93. *
  94. * memcpy() is good for large amounts of data,
  95. * but the overhead is big for small amounts, which are usually stored via RTT.
  96. * With SEGGER_RTT_MEMCPY_USE_BYTELOOP a simple byte loop can be used instead.
  97. *
  98. * SEGGER_RTT_MEMCPY() can be used to replace standard memcpy() in RTT functions.
  99. * This is may be required with memory access restrictions,
  100. * such as on Cortex-A devices with MMU.
  101. */
  102. #if defined(CONFIG_SEGGER_RTT_MEMCPY_USE_BYTELOOP)
  103. #define SEGGER_RTT_MEMCPY_USE_BYTELOOP 1 // 1: Use a simple byte-loop
  104. #else
  105. #define SEGGER_RTT_MEMCPY_USE_BYTELOOP 0 // 0: Use memcpy/SEGGER_RTT_MEMCPY
  106. #endif
  107. //
  108. // Example definition of SEGGER_RTT_MEMCPY to external memcpy with GCC toolchains and Cortex-A targets
  109. //
  110. //#if ((defined __SES_ARM) || (defined __CROSSWORKS_ARM) || (defined __GNUC__)) && (defined (__ARM_ARCH_7A__))
  111. // #define SEGGER_RTT_MEMCPY(pDest, pSrc, NumBytes) SEGGER_memcpy((pDest), (pSrc), (NumBytes))
  112. //#endif
  113. //
  114. // Target is not allowed to perform other RTT operations while string still has not been stored completely.
  115. // Otherwise we would probably end up with a mixed string in the buffer.
  116. // If using RTT from within interrupts, multiple tasks or multi processors, define the SEGGER_RTT_LOCK() and SEGGER_RTT_UNLOCK() function here.
  117. //
  118. // SEGGER_RTT_MAX_INTERRUPT_PRIORITY can be used in the sample lock routines on Cortex-M3/4.
  119. // Make sure to mask all interrupts which can send RTT data, i.e. generate SystemView events, or cause task switches.
  120. // When high-priority interrupts must not be masked while sending RTT data, SEGGER_RTT_MAX_INTERRUPT_PRIORITY needs to be adjusted accordingly.
  121. // (Higher priority = lower priority number)
  122. // Default value for embOS: 128u
  123. // Default configuration in FreeRTOS: configMAX_SYSCALL_INTERRUPT_PRIORITY: ( configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY << (8 - configPRIO_BITS) )
  124. // In case of doubt mask all interrupts: 1 << (8 - BASEPRI_PRIO_BITS) i.e. 1 << 5 when 3 bits are implemented in NVIC
  125. // or define SEGGER_RTT_LOCK() to completely disable interrupts.
  126. //
  127. #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY
  128. #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20) // Interrupt priority to lock on SEGGER_RTT_LOCK on Cortex-M3/4 (Default: 0x20)
  129. #endif
  130. /*********************************************************************
  131. *
  132. * RTT lock configuration for SEGGER Embedded Studio,
  133. * Rowley CrossStudio and GCC
  134. */
  135. #if ((defined(__SES_ARM) || defined(__SES_RISCV) || defined(__CROSSWORKS_ARM) || defined(__GNUC__) || defined(__clang__)) && !defined (__CC_ARM) && !defined(WIN32))
  136. #if defined(__ZEPHYR__) && defined (CONFIG_SEGGER_RTT_CUSTOM_LOCKING)
  137. #include <kernel.h>
  138. #ifdef CONFIG_MULTITHREADING
  139. extern struct k_mutex rtt_term_mutex;
  140. #define SEGGER_RTT_LOCK() k_mutex_lock(&rtt_term_mutex, K_FOREVER);
  141. #define SEGGER_RTT_UNLOCK() k_mutex_unlock(&rtt_term_mutex);
  142. #else
  143. #define SEGGER_RTT_LOCK() { \
  144. unsigned int key = irq_lock()
  145. #define SEGGER_RTT_UNLOCK() irq_unlock(key); \
  146. }
  147. #endif
  148. #define RTT_USE_ASM 0
  149. #elif (defined(__ARM_ARCH_6M__) || defined(__ARM_ARCH_8M_BASE__))
  150. #define SEGGER_RTT_LOCK() { \
  151. unsigned int _SEGGER_RTT__LockState; \
  152. __asm volatile ("mrs %0, primask \n\t" \
  153. "movs r1, #1 \n\t" \
  154. "msr primask, r1 \n\t" \
  155. : "=r" (_SEGGER_RTT__LockState) \
  156. : \
  157. : "r1", "cc" \
  158. );
  159. #define SEGGER_RTT_UNLOCK() __asm volatile ("msr primask, %0 \n\t" \
  160. : \
  161. : "r" (_SEGGER_RTT__LockState) \
  162. : \
  163. ); \
  164. }
  165. #elif (defined(__ARM_ARCH_7M__) || defined(__ARM_ARCH_7EM__) || defined(__ARM_ARCH_8M_MAIN__))
  166. #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY
  167. #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20)
  168. #endif
  169. #define SEGGER_RTT_LOCK() { \
  170. unsigned int _SEGGER_RTT__LockState; \
  171. __asm volatile ("mrs %0, basepri \n\t" \
  172. "mov r1, %1 \n\t" \
  173. "msr basepri, r1 \n\t" \
  174. : "=r" (_SEGGER_RTT__LockState) \
  175. : "i"(SEGGER_RTT_MAX_INTERRUPT_PRIORITY) \
  176. : "r1", "cc" \
  177. );
  178. #define SEGGER_RTT_UNLOCK() __asm volatile ("msr basepri, %0 \n\t" \
  179. : \
  180. : "r" (_SEGGER_RTT__LockState) \
  181. : \
  182. ); \
  183. }
  184. #elif defined(__ARM_ARCH_7A__)
  185. #define SEGGER_RTT_LOCK() { \
  186. unsigned int _SEGGER_RTT__LockState; \
  187. __asm volatile ("mrs r1, CPSR \n\t" \
  188. "mov %0, r1 \n\t" \
  189. "orr r1, r1, #0xC0 \n\t" \
  190. "msr CPSR_c, r1 \n\t" \
  191. : "=r" (_SEGGER_RTT__LockState) \
  192. : \
  193. : "r1", "cc" \
  194. );
  195. #define SEGGER_RTT_UNLOCK() __asm volatile ("mov r0, %0 \n\t" \
  196. "mrs r1, CPSR \n\t" \
  197. "bic r1, r1, #0xC0 \n\t" \
  198. "and r0, r0, #0xC0 \n\t" \
  199. "orr r1, r1, r0 \n\t" \
  200. "msr CPSR_c, r1 \n\t" \
  201. : \
  202. : "r" (_SEGGER_RTT__LockState) \
  203. : "r0", "r1", "cc" \
  204. ); \
  205. }
  206. #elif defined(__riscv) || defined(__riscv_xlen)
  207. #define SEGGER_RTT_LOCK() { \
  208. unsigned int _SEGGER_RTT__LockState; \
  209. __asm volatile ("csrr %0, mstatus \n\t" \
  210. "csrci mstatus, 8 \n\t" \
  211. "andi %0, %0, 8 \n\t" \
  212. : "=r" (_SEGGER_RTT__LockState) \
  213. : \
  214. : \
  215. );
  216. #define SEGGER_RTT_UNLOCK() __asm volatile ("csrr a1, mstatus \n\t" \
  217. "or %0, %0, a1 \n\t" \
  218. "csrs mstatus, %0 \n\t" \
  219. : \
  220. : "r" (_SEGGER_RTT__LockState) \
  221. : "a1" \
  222. ); \
  223. }
  224. #else
  225. #define SEGGER_RTT_LOCK()
  226. #define SEGGER_RTT_UNLOCK()
  227. #endif
  228. #endif
  229. /*********************************************************************
  230. *
  231. * RTT lock configuration for IAR EWARM
  232. */
  233. #ifdef __ICCARM__
  234. #if (defined (__ARM6M__) && (__CORE__ == __ARM6M__)) || \
  235. (defined (__ARM8M_BASELINE__) && (__CORE__ == __ARM8M_BASELINE__))
  236. #define SEGGER_RTT_LOCK() { \
  237. unsigned int _SEGGER_RTT__LockState; \
  238. _SEGGER_RTT__LockState = __get_PRIMASK(); \
  239. __set_PRIMASK(1);
  240. #define SEGGER_RTT_UNLOCK() __set_PRIMASK(_SEGGER_RTT__LockState); \
  241. }
  242. #elif (defined (__ARM7EM__) && (__CORE__ == __ARM7EM__)) || \
  243. (defined (__ARM7M__) && (__CORE__ == __ARM7M__)) || \
  244. (defined (__ARM8M_MAINLINE__) && (__CORE__ == __ARM8M_MAINLINE__)) || \
  245. (defined (__ARM8M_MAINLINE__) && (__CORE__ == __ARM8M_MAINLINE__))
  246. #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY
  247. #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20)
  248. #endif
  249. #define SEGGER_RTT_LOCK() { \
  250. unsigned int _SEGGER_RTT__LockState; \
  251. _SEGGER_RTT__LockState = __get_BASEPRI(); \
  252. __set_BASEPRI(SEGGER_RTT_MAX_INTERRUPT_PRIORITY);
  253. #define SEGGER_RTT_UNLOCK() __set_BASEPRI(_SEGGER_RTT__LockState); \
  254. }
  255. #elif (defined (__ARM7A__) && (__CORE__ == __ARM7A__)) || \
  256. (defined (__ARM7R__) && (__CORE__ == __ARM7R__))
  257. #define SEGGER_RTT_LOCK() { \
  258. unsigned int _SEGGER_RTT__LockState; \
  259. __asm volatile ("mrs r1, CPSR \n\t" \
  260. "mov %0, r1 \n\t" \
  261. "orr r1, r1, #0xC0 \n\t" \
  262. "msr CPSR_c, r1 \n\t" \
  263. : "=r" (_SEGGER_RTT__LockState) \
  264. : \
  265. : "r1", "cc" \
  266. );
  267. #define SEGGER_RTT_UNLOCK() __asm volatile ("mov r0, %0 \n\t" \
  268. "mrs r1, CPSR \n\t" \
  269. "bic r1, r1, #0xC0 \n\t" \
  270. "and r0, r0, #0xC0 \n\t" \
  271. "orr r1, r1, r0 \n\t" \
  272. "msr CPSR_c, r1 \n\t" \
  273. : \
  274. : "r" (_SEGGER_RTT__LockState) \
  275. : "r0", "r1", "cc" \
  276. ); \
  277. }
  278. #endif
  279. #endif
  280. /*********************************************************************
  281. *
  282. * RTT lock configuration for IAR RX
  283. */
  284. #ifdef __ICCRX__
  285. #define SEGGER_RTT_LOCK() { \
  286. unsigned long _SEGGER_RTT__LockState; \
  287. _SEGGER_RTT__LockState = __get_interrupt_state(); \
  288. __disable_interrupt();
  289. #define SEGGER_RTT_UNLOCK() __set_interrupt_state(_SEGGER_RTT__LockState); \
  290. }
  291. #endif
  292. /*********************************************************************
  293. *
  294. * RTT lock configuration for IAR RL78
  295. */
  296. #ifdef __ICCRL78__
  297. #define SEGGER_RTT_LOCK() { \
  298. __istate_t _SEGGER_RTT__LockState; \
  299. _SEGGER_RTT__LockState = __get_interrupt_state(); \
  300. __disable_interrupt();
  301. #define SEGGER_RTT_UNLOCK() __set_interrupt_state(_SEGGER_RTT__LockState); \
  302. }
  303. #endif
  304. /*********************************************************************
  305. *
  306. * RTT lock configuration for KEIL ARM
  307. */
  308. #ifdef __CC_ARM
  309. #if (defined __TARGET_ARCH_6S_M)
  310. #define SEGGER_RTT_LOCK() { \
  311. unsigned int _SEGGER_RTT__LockState; \
  312. register unsigned char _SEGGER_RTT__PRIMASK __asm( "primask"); \
  313. _SEGGER_RTT__LockState = _SEGGER_RTT__PRIMASK; \
  314. _SEGGER_RTT__PRIMASK = 1u; \
  315. __schedule_barrier();
  316. #define SEGGER_RTT_UNLOCK() _SEGGER_RTT__PRIMASK = _SEGGER_RTT__LockState; \
  317. __schedule_barrier(); \
  318. }
  319. #elif (defined(__TARGET_ARCH_7_M) || defined(__TARGET_ARCH_7E_M))
  320. #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY
  321. #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20)
  322. #endif
  323. #define SEGGER_RTT_LOCK() { \
  324. unsigned int _SEGGER_RTT__LockState; \
  325. register unsigned char BASEPRI __asm( "basepri"); \
  326. _SEGGER_RTT__LockState = BASEPRI; \
  327. BASEPRI = SEGGER_RTT_MAX_INTERRUPT_PRIORITY; \
  328. __schedule_barrier();
  329. #define SEGGER_RTT_UNLOCK() BASEPRI = _SEGGER_RTT__LockState; \
  330. __schedule_barrier(); \
  331. }
  332. #endif
  333. #endif
  334. /*********************************************************************
  335. *
  336. * RTT lock configuration for TI ARM
  337. */
  338. #ifdef __TI_ARM__
  339. #if defined (__TI_ARM_V6M0__)
  340. #define SEGGER_RTT_LOCK() { \
  341. unsigned int _SEGGER_RTT__LockState; \
  342. _SEGGER_RTT__LockState = __get_PRIMASK(); \
  343. __set_PRIMASK(1);
  344. #define SEGGER_RTT_UNLOCK() __set_PRIMASK(_SEGGER_RTT__LockState); \
  345. }
  346. #elif (defined (__TI_ARM_V7M3__) || defined (__TI_ARM_V7M4__))
  347. #ifndef SEGGER_RTT_MAX_INTERRUPT_PRIORITY
  348. #define SEGGER_RTT_MAX_INTERRUPT_PRIORITY (0x20)
  349. #endif
  350. #define SEGGER_RTT_LOCK() { \
  351. unsigned int _SEGGER_RTT__LockState; \
  352. _SEGGER_RTT__LockState = _set_interrupt_priority(SEGGER_RTT_MAX_INTERRUPT_PRIORITY);
  353. #define SEGGER_RTT_UNLOCK() _set_interrupt_priority(_SEGGER_RTT__LockState); \
  354. }
  355. #endif
  356. #endif
  357. /*********************************************************************
  358. *
  359. * RTT lock configuration for CCRX
  360. */
  361. #ifdef __RX
  362. #include <machine.h>
  363. #define SEGGER_RTT_LOCK() { \
  364. unsigned long _SEGGER_RTT__LockState; \
  365. _SEGGER_RTT__LockState = get_psw() & 0x010000; \
  366. clrpsw_i();
  367. #define SEGGER_RTT_UNLOCK() set_psw(get_psw() | _SEGGER_RTT__LockState); \
  368. }
  369. #endif
  370. /*********************************************************************
  371. *
  372. * RTT lock configuration for embOS Simulation on Windows
  373. * (Can also be used for generic RTT locking with embOS)
  374. */
  375. #if defined(WIN32) || defined(SEGGER_RTT_LOCK_EMBOS)
  376. void OS_SIM_EnterCriticalSection(void);
  377. void OS_SIM_LeaveCriticalSection(void);
  378. #define SEGGER_RTT_LOCK() { \
  379. OS_SIM_EnterCriticalSection();
  380. #define SEGGER_RTT_UNLOCK() OS_SIM_LeaveCriticalSection(); \
  381. }
  382. #endif
  383. /*********************************************************************
  384. *
  385. * RTT lock configuration fallback
  386. */
  387. #ifndef SEGGER_RTT_LOCK
  388. #define SEGGER_RTT_LOCK() // Lock RTT (nestable) (i.e. disable interrupts)
  389. #endif
  390. #ifndef SEGGER_RTT_UNLOCK
  391. #define SEGGER_RTT_UNLOCK() // Unlock RTT (nestable) (i.e. enable previous interrupt lock state)
  392. #endif
  393. #endif
  394. /*************************** End of file ****************************/