os_trace.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476
  1. /*
  2. *********************************************************************************************************
  3. * uC/OS-III
  4. * The Real-Time Kernel
  5. *
  6. * Copyright 2009-2022 Silicon Laboratories Inc. www.silabs.com
  7. *
  8. * SPDX-License-Identifier: APACHE-2.0
  9. *
  10. * This software is subject to an open source license and is distributed by
  11. * Silicon Laboratories Inc. pursuant to the terms of the Apache License,
  12. * Version 2.0 available at www.apache.org/licenses/LICENSE-2.0.
  13. *
  14. *********************************************************************************************************
  15. */
  16. /*
  17. *********************************************************************************************************
  18. * File : os_trace.h
  19. * Version : V3.08.02
  20. *********************************************************************************************************
  21. * Note(s) : (1) The header file os_trace_events.h is the interface between uC/OS-III and your
  22. * trace recorder of choice. To support trace recording, include one of the sub-folders
  23. * at uCOS-III/Trace/ into your project.
  24. *********************************************************************************************************
  25. */
  26. #ifndef OS_TRACE_H
  27. #define OS_TRACE_H
  28. #include <os_cfg.h>
  29. #if (defined(OS_CFG_TRACE_EN) && (OS_CFG_TRACE_EN > 0u))
  30. #include <os_trace_events.h> /* See Note #1. */
  31. #endif
  32. /*
  33. **************************************************************************************************************************
  34. * uC/OS-III Trace Default Macros (Empty)
  35. **************************************************************************************************************************
  36. */
  37. #ifndef OS_TRACE_INIT
  38. #define OS_TRACE_INIT()
  39. #endif
  40. #ifndef OS_TRACE_START
  41. #define OS_TRACE_START()
  42. #endif
  43. #ifndef OS_TRACE_STOP
  44. #define OS_TRACE_STOP()
  45. #endif
  46. #ifndef OS_TRACE_CLEAR
  47. #define OS_TRACE_CLEAR()
  48. #endif
  49. #ifndef OS_TRACE_ISR_ENTER
  50. #define OS_TRACE_ISR_ENTER()
  51. #endif
  52. #ifndef OS_TRACE_ISR_EXIT
  53. #define OS_TRACE_ISR_EXIT()
  54. #endif
  55. #ifndef OS_TRACE_ISR_EXIT_TO_SCHEDULER
  56. #define OS_TRACE_ISR_EXIT_TO_SCHEDULER()
  57. #endif
  58. #ifndef OS_TRACE_TICK_INCREMENT
  59. #define OS_TRACE_TICK_INCREMENT(OSTickCtr)
  60. #endif
  61. #ifndef OS_TRACE_TASK_CREATE
  62. #define OS_TRACE_TASK_CREATE(p_tcb)
  63. #endif
  64. #ifndef OS_TRACE_TASK_CREATE_FAILED
  65. #define OS_TRACE_TASK_CREATE_FAILED(p_tcb)
  66. #endif
  67. #ifndef OS_TRACE_TASK_DEL
  68. #define OS_TRACE_TASK_DEL(p_tcb)
  69. #endif
  70. #ifndef OS_TRACE_TASK_READY
  71. #define OS_TRACE_TASK_READY(p_tcb)
  72. #endif
  73. #ifndef OS_TRACE_TASK_SWITCHED_IN
  74. #define OS_TRACE_TASK_SWITCHED_IN(p_tcb)
  75. #endif
  76. #ifndef OS_TRACE_TASK_DLY
  77. #define OS_TRACE_TASK_DLY(dly_ticks)
  78. #endif
  79. #ifndef OS_TRACE_TASK_SUSPEND
  80. #define OS_TRACE_TASK_SUSPEND(p_tcb)
  81. #endif
  82. #ifndef OS_TRACE_TASK_SUSPENDED
  83. #define OS_TRACE_TASK_SUSPENDED(p_tcb)
  84. #endif
  85. #ifndef OS_TRACE_TASK_RESUME
  86. #define OS_TRACE_TASK_RESUME(p_tcb)
  87. #endif
  88. #ifndef OS_TRACE_TASK_PREEMPT
  89. #define OS_TRACE_TASK_PREEMPT(p_tcb)
  90. #endif
  91. #ifndef OS_TRACE_TASK_PRIO_CHANGE
  92. #define OS_TRACE_TASK_PRIO_CHANGE(p_tcb, prio)
  93. #endif
  94. #ifndef OS_TRACE_ISR_REGISTER
  95. #define OS_TRACE_ISR_REGISTER(isr_id, isr_name, isr_prio)
  96. #endif
  97. #ifndef OS_TRACE_ISR_BEGIN
  98. #define OS_TRACE_ISR_BEGIN(isr_id)
  99. #endif
  100. #ifndef OS_TRACE_ISR_END
  101. #define OS_TRACE_ISR_END()
  102. #endif
  103. #ifndef OS_TRACE_TASK_MSG_Q_CREATE
  104. #define OS_TRACE_TASK_MSG_Q_CREATE(p_msg_q, p_name)
  105. #endif
  106. #ifndef OS_TRACE_TASK_MSG_Q_POST
  107. #define OS_TRACE_TASK_MSG_Q_POST(p_msg_q)
  108. #endif
  109. #ifndef OS_TRACE_TASK_MSG_Q_POST_FAILED
  110. #define OS_TRACE_TASK_MSG_Q_POST_FAILED(p_msg_q)
  111. #endif
  112. #ifndef OS_TRACE_TASK_MSG_Q_PEND
  113. #define OS_TRACE_TASK_MSG_Q_PEND(p_msg_q)
  114. #endif
  115. #ifndef OS_TRACE_TASK_MSG_Q_PEND_FAILED
  116. #define OS_TRACE_TASK_MSG_Q_PEND_FAILED(p_msg_q)
  117. #endif
  118. #ifndef OS_TRACE_TASK_MSG_Q_PEND_BLOCK
  119. #define OS_TRACE_TASK_MSG_Q_PEND_BLOCK(p_msg_q)
  120. #endif
  121. #ifndef OS_TRACE_TASK_SEM_CREATE
  122. #define OS_TRACE_TASK_SEM_CREATE(p_tcb, p_name)
  123. #endif
  124. #ifndef OS_TRACE_TASK_SEM_POST
  125. #define OS_TRACE_TASK_SEM_POST(p_tcb)
  126. #endif
  127. #ifndef OS_TRACE_TASK_SEM_POST_FAILED
  128. #define OS_TRACE_TASK_SEM_POST_FAILED(p_tcb)
  129. #endif
  130. #ifndef OS_TRACE_TASK_SEM_PEND
  131. #define OS_TRACE_TASK_SEM_PEND(p_tcb)
  132. #endif
  133. #ifndef OS_TRACE_TASK_SEM_PEND_FAILED
  134. #define OS_TRACE_TASK_SEM_PEND_FAILED(p_tcb)
  135. #endif
  136. #ifndef OS_TRACE_TASK_SEM_PEND_BLOCK
  137. #define OS_TRACE_TASK_SEM_PEND_BLOCK(p_tcb)
  138. #endif
  139. #ifndef OS_TRACE_MUTEX_CREATE
  140. #define OS_TRACE_MUTEX_CREATE(p_mutex, p_name)
  141. #endif
  142. #ifndef OS_TRACE_MUTEX_DEL
  143. #define OS_TRACE_MUTEX_DEL(p_mutex)
  144. #endif
  145. #ifndef OS_TRACE_MUTEX_POST
  146. #define OS_TRACE_MUTEX_POST(p_mutex)
  147. #endif
  148. #ifndef OS_TRACE_MUTEX_POST_FAILED
  149. #define OS_TRACE_MUTEX_POST_FAILED(p_mutex)
  150. #endif
  151. #ifndef OS_TRACE_MUTEX_PEND
  152. #define OS_TRACE_MUTEX_PEND(p_mutex)
  153. #endif
  154. #ifndef OS_TRACE_MUTEX_PEND_FAILED
  155. #define OS_TRACE_MUTEX_PEND_FAILED(p_mutex)
  156. #endif
  157. #ifndef OS_TRACE_MUTEX_PEND_BLOCK
  158. #define OS_TRACE_MUTEX_PEND_BLOCK(p_mutex)
  159. #endif
  160. #ifndef OS_TRACE_MUTEX_TASK_PRIO_INHERIT
  161. #define OS_TRACE_MUTEX_TASK_PRIO_INHERIT(p_tcb, prio)
  162. #endif
  163. #ifndef OS_TRACE_MUTEX_TASK_PRIO_DISINHERIT
  164. #define OS_TRACE_MUTEX_TASK_PRIO_DISINHERIT(p_tcb, prio)
  165. #endif
  166. #ifndef OS_TRACE_SEM_CREATE
  167. #define OS_TRACE_SEM_CREATE(p_sem, p_name)
  168. #endif
  169. #ifndef OS_TRACE_SEM_DEL
  170. #define OS_TRACE_SEM_DEL(p_sem)
  171. #endif
  172. #ifndef OS_TRACE_SEM_POST
  173. #define OS_TRACE_SEM_POST(p_sem)
  174. #endif
  175. #ifndef OS_TRACE_SEM_POST_FAILED
  176. #define OS_TRACE_SEM_POST_FAILED(p_sem)
  177. #endif
  178. #ifndef OS_TRACE_SEM_PEND
  179. #define OS_TRACE_SEM_PEND(p_sem)
  180. #endif
  181. #ifndef OS_TRACE_SEM_PEND_FAILED
  182. #define OS_TRACE_SEM_PEND_FAILED(p_sem)
  183. #endif
  184. #ifndef OS_TRACE_SEM_PEND_BLOCK
  185. #define OS_TRACE_SEM_PEND_BLOCK(p_sem)
  186. #endif
  187. #ifndef OS_TRACE_Q_CREATE
  188. #define OS_TRACE_Q_CREATE(p_q, p_name)
  189. #endif
  190. #ifndef OS_TRACE_Q_DEL
  191. #define OS_TRACE_Q_DEL(p_q)
  192. #endif
  193. #ifndef OS_TRACE_Q_POST
  194. #define OS_TRACE_Q_POST(p_q)
  195. #endif
  196. #ifndef OS_TRACE_Q_POST_FAILED
  197. #define OS_TRACE_Q_POST_FAILED(p_q)
  198. #endif
  199. #ifndef OS_TRACE_Q_PEND
  200. #define OS_TRACE_Q_PEND(p_q)
  201. #endif
  202. #ifndef OS_TRACE_Q_PEND_FAILED
  203. #define OS_TRACE_Q_PEND_FAILED(p_q)
  204. #endif
  205. #ifndef OS_TRACE_Q_PEND_BLOCK
  206. #define OS_TRACE_Q_PEND_BLOCK(p_q)
  207. #endif
  208. #ifndef OS_TRACE_FLAG_CREATE
  209. #define OS_TRACE_FLAG_CREATE(p_grp, p_name)
  210. #endif
  211. #ifndef OS_TRACE_FLAG_DEL
  212. #define OS_TRACE_FLAG_DEL(p_grp)
  213. #endif
  214. #ifndef OS_TRACE_FLAG_POST
  215. #define OS_TRACE_FLAG_POST(p_grp)
  216. #endif
  217. #ifndef OS_TRACE_FLAG_POST_FAILED
  218. #define OS_TRACE_FLAG_POST_FAILED(p_grp)
  219. #endif
  220. #ifndef OS_TRACE_FLAG_PEND
  221. #define OS_TRACE_FLAG_PEND(p_grp)
  222. #endif
  223. #ifndef OS_TRACE_FLAG_PEND_FAILED
  224. #define OS_TRACE_FLAG_PEND_FAILED(p_grp)
  225. #endif
  226. #ifndef OS_TRACE_FLAG_PEND_BLOCK
  227. #define OS_TRACE_FLAG_PEND_BLOCK(p_grp)
  228. #endif
  229. #ifndef OS_TRACE_MEM_CREATE
  230. #define OS_TRACE_MEM_CREATE(p_mem, p_name)
  231. #endif
  232. #ifndef OS_TRACE_MEM_PUT
  233. #define OS_TRACE_MEM_PUT(p_mem)
  234. #endif
  235. #ifndef OS_TRACE_MEM_PUT_FAILED
  236. #define OS_TRACE_MEM_PUT_FAILED(p_mem)
  237. #endif
  238. #ifndef OS_TRACE_MEM_GET
  239. #define OS_TRACE_MEM_GET(p_mem)
  240. #endif
  241. #ifndef OS_TRACE_MEM_GET_FAILED
  242. #define OS_TRACE_MEM_GET_FAILED(p_mem)
  243. #endif
  244. #ifndef OS_TRACE_MUTEX_DEL_ENTER
  245. #define OS_TRACE_MUTEX_DEL_ENTER(p_mutex, opt)
  246. #endif
  247. #ifndef OS_TRACE_MUTEX_POST_ENTER
  248. #define OS_TRACE_MUTEX_POST_ENTER(p_mutex, opt)
  249. #endif
  250. #ifndef OS_TRACE_MUTEX_PEND_ENTER
  251. #define OS_TRACE_MUTEX_PEND_ENTER(p_mutex, timeout, opt, p_ts)
  252. #endif
  253. #ifndef OS_TRACE_TASK_MSG_Q_POST_ENTER
  254. #define OS_TRACE_TASK_MSG_Q_POST_ENTER(p_msg_q, p_void, msg_size, opt)
  255. #endif
  256. #ifndef OS_TRACE_TASK_MSG_Q_PEND_ENTER
  257. #define OS_TRACE_TASK_MSG_Q_PEND_ENTER(p_msg_q, timeout, opt, p_msg_size, p_ts)
  258. #endif
  259. #ifndef OS_TRACE_TASK_SEM_POST_ENTER
  260. #define OS_TRACE_TASK_SEM_POST_ENTER(p_tcb, opt)
  261. #endif
  262. #ifndef OS_TRACE_TASK_SEM_PEND_ENTER
  263. #define OS_TRACE_TASK_SEM_PEND_ENTER(p_tcb, timeout, opt, p_ts)
  264. #endif
  265. #ifndef OS_TRACE_TASK_RESUME_ENTER
  266. #define OS_TRACE_TASK_RESUME_ENTER(p_tcb)
  267. #endif
  268. #ifndef OS_TRACE_TASK_SUSPEND_ENTER
  269. #define OS_TRACE_TASK_SUSPEND_ENTER(p_tcb)
  270. #endif
  271. #ifndef OS_TRACE_SEM_DEL_ENTER
  272. #define OS_TRACE_SEM_DEL_ENTER(p_sem, opt)
  273. #endif
  274. #ifndef OS_TRACE_SEM_POST_ENTER
  275. #define OS_TRACE_SEM_POST_ENTER(p_sem, opt)
  276. #endif
  277. #ifndef OS_TRACE_SEM_PEND_ENTER
  278. #define OS_TRACE_SEM_PEND_ENTER(p_sem, timeout, opt, p_ts)
  279. #endif
  280. #ifndef OS_TRACE_Q_DEL_ENTER
  281. #define OS_TRACE_Q_DEL_ENTER(p_q, opt)
  282. #endif
  283. #ifndef OS_TRACE_Q_POST_ENTER
  284. #define OS_TRACE_Q_POST_ENTER(p_q, p_void, msg_size, opt)
  285. #endif
  286. #ifndef OS_TRACE_Q_PEND_ENTER
  287. #define OS_TRACE_Q_PEND_ENTER(p_q, timeout, opt, p_msg_size, p_ts)
  288. #endif
  289. #ifndef OS_TRACE_FLAG_DEL_ENTER
  290. #define OS_TRACE_FLAG_DEL_ENTER(p_grp, opt)
  291. #endif
  292. #ifndef OS_TRACE_FLAG_POST_ENTER
  293. #define OS_TRACE_FLAG_POST_ENTER(p_grp, flags, opt)
  294. #endif
  295. #ifndef OS_TRACE_FLAG_PEND_ENTER
  296. #define OS_TRACE_FLAG_PEND_ENTER(p_grp, flags, timeout, opt, p_ts)
  297. #endif
  298. #ifndef OS_TRACE_MEM_PUT_ENTER
  299. #define OS_TRACE_MEM_PUT_ENTER(p_mem, p_blk)
  300. #endif
  301. #ifndef OS_TRACE_MEM_GET_ENTER
  302. #define OS_TRACE_MEM_GET_ENTER(p_mem)
  303. #endif
  304. #ifndef OS_TRACE_MUTEX_DEL_EXIT
  305. #define OS_TRACE_MUTEX_DEL_EXIT(RetVal)
  306. #endif
  307. #ifndef OS_TRACE_MUTEX_POST_EXIT
  308. #define OS_TRACE_MUTEX_POST_EXIT(RetVal)
  309. #endif
  310. #ifndef OS_TRACE_MUTEX_PEND_EXIT
  311. #define OS_TRACE_MUTEX_PEND_EXIT(RetVal)
  312. #endif
  313. #ifndef OS_TRACE_TASK_MSG_Q_POST_EXIT
  314. #define OS_TRACE_TASK_MSG_Q_POST_EXIT(RetVal)
  315. #endif
  316. #ifndef OS_TRACE_TASK_MSG_Q_PEND_EXIT
  317. #define OS_TRACE_TASK_MSG_Q_PEND_EXIT(RetVal)
  318. #endif
  319. #ifndef OS_TRACE_TASK_SEM_POST_EXIT
  320. #define OS_TRACE_TASK_SEM_POST_EXIT(RetVal)
  321. #endif
  322. #ifndef OS_TRACE_TASK_SEM_PEND_EXIT
  323. #define OS_TRACE_TASK_SEM_PEND_EXIT(RetVal)
  324. #endif
  325. #ifndef OS_TRACE_TASK_RESUME_EXIT
  326. #define OS_TRACE_TASK_RESUME_EXIT(RetVal)
  327. #endif
  328. #ifndef OS_TRACE_TASK_SUSPEND_EXIT
  329. #define OS_TRACE_TASK_SUSPEND_EXIT(RetVal)
  330. #endif
  331. #ifndef OS_TRACE_SEM_DEL_EXIT
  332. #define OS_TRACE_SEM_DEL_EXIT(RetVal)
  333. #endif
  334. #ifndef OS_TRACE_SEM_POST_EXIT
  335. #define OS_TRACE_SEM_POST_EXIT(RetVal)
  336. #endif
  337. #ifndef OS_TRACE_SEM_PEND_EXIT
  338. #define OS_TRACE_SEM_PEND_EXIT(RetVal)
  339. #endif
  340. #ifndef OS_TRACE_Q_DEL_EXIT
  341. #define OS_TRACE_Q_DEL_EXIT(RetVal)
  342. #endif
  343. #ifndef OS_TRACE_Q_POST_EXIT
  344. #define OS_TRACE_Q_POST_EXIT(RetVal)
  345. #endif
  346. #ifndef OS_TRACE_Q_PEND_EXIT
  347. #define OS_TRACE_Q_PEND_EXIT(RetVal)
  348. #endif
  349. #ifndef OS_TRACE_FLAG_DEL_EXIT
  350. #define OS_TRACE_FLAG_DEL_EXIT(RetVal)
  351. #endif
  352. #ifndef OS_TRACE_FLAG_POST_EXIT
  353. #define OS_TRACE_FLAG_POST_EXIT(RetVal)
  354. #endif
  355. #ifndef OS_TRACE_FLAG_PEND_EXIT
  356. #define OS_TRACE_FLAG_PEND_EXIT(RetVal)
  357. #endif
  358. #ifndef OS_TRACE_MEM_PUT_EXIT
  359. #define OS_TRACE_MEM_PUT_EXIT(RetVal)
  360. #endif
  361. #ifndef OS_TRACE_MEM_GET_EXIT
  362. #define OS_TRACE_MEM_GET_EXIT(RetVal)
  363. #endif
  364. #endif