2 \defgroup rtx_evr Event functions
4 \brief RTX5 Event Recorder functions
6 RTX5 interfaces to the <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/index.html" target="_blank"><b>Event Recorder</b></a>
7 to provide event information which helps you to understand and analyze the operation.
9 To use the Event Recorder together with RTX5, it is required to create an image that generates event information. The steps are:
10 - <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/UseDebugViews.html#Add_Event_Recorder" target="_blank"><b>Add Event Recorder</b></a>: Select in the RTE management dialog the software component <b>Compiler:Event Recorder</b>.
11 - <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/UseDebugViews.html#Debug_Variants" target="_blank"><b>Select Debug Variant</b></a>: Select in the RTE management dialog the \b Source variant for the software component <b>CMSIS:RTOS2 (API):Keil RTX5</b>.
12 - <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/group__EventRecorder__Setup.htm" target="_blank"><b>Add Initialization Code</b></a>: Call the function <b>EventRecorderInitialize</b> in your application code.
13 - Build the application code and download it to the debug hardware.
15 Once the target application generates event information, it can be viewed in the µVision debugger using the \b Event
22 \defgroup rtx_evr_memory Memory Functions
23 \brief Events generated memory functions
29 \fn void EvrRtxMemoryInit (void *mem, uint32_t size, uint32_t result)
35 \fn void EvrRtxMemoryAlloc (void *mem, uint32_t size, uint32_t type, void *block)
41 \fn void EvrRtxMemoryFree (void *mem, void *block, uint32_t result)
47 \fn void EvrRtxMemoryBlockInit (osRtxMpInfo_t *mp_info, uint32_t block_count, uint32_t block_size, void *block_mem)
53 \fn void EvrRtxMemoryBlockAlloc (osRtxMpInfo_t *mp_info, void *block)
59 \fn void EvrRtxMemoryBlockFree (osRtxMpInfo_t *mp_info, void *block, int32_t status)
69 \defgroup rtx_evr_kernel Kernel Functions
70 \brief Events generated by kernel functions
76 \fn void EvrRtxKernelError (int32_t status)
82 \fn void EvrRtxKernelInitialize (void)
88 \fn void EvrRtxKernelInitializeCompleted (void)
94 \fn void EvrRtxKernelGetInfo (osVersion_t *version, char *id_buf, uint32_t id_size)
100 \fn void EvrRtxKernelInfoRetrieved (osVersion_t *version, char *id_buf)
106 \fn void EvrRtxKernelGetState (osKernelState_t state)
112 \fn void EvrRtxKernelStart (void)
118 \fn void EvrRtxKernelStarted (void)
124 \fn void EvrRtxKernelLock (void)
130 \fn void EvrRtxKernelLocked (int32_t lock)
136 \fn void EvrRtxKernelUnlock (void)
142 \fn void EvrRtxKernelUnlocked (int32_t lock)
148 \fn void EvrRtxKernelRestoreLock (int32_t lock)
154 \fn void EvrRtxKernelLockRestored (int32_t lock)
160 \fn void EvrRtxKernelSuspend (void)
166 \fn void EvrRtxKernelSuspended (uint32_t sleep_ticks)
172 \fn void EvrRtxKernelResume (uint32_t sleep_ticks)
178 \fn void EvrRtxKernelResumed (void)
184 \fn void EvrRtxKernelGetTickCount (uint64_t count)
190 \fn void EvrRtxKernelGetTickFreq (uint32_t freq)
196 \fn void EvrRtxKernelGetSysTimerCount (uint32_t count)
202 \fn void EvrRtxKernelGetSysTimerFreq (uint32_t freq)
212 \defgroup rtx_evr_thread Thread Functions
213 \brief Events generated by thread functions
219 \fn void EvrRtxThreadError (osThreadId_t thread_id, int32_t status)
225 \fn void EvrRtxThreadNew (osThreadFunc_t func, void *argument, const osThreadAttr_t *attr)
231 \fn void EvrRtxThreadCreated (osThreadId_t thread_id)
237 \fn void EvrRtxThreadGetName (osThreadId_t thread_id, const char *name)
243 \fn void EvrRtxThreadGetId (osThreadId_t thread_id)
249 \fn void EvrRtxThreadGetState (osThreadId_t thread_id, osThreadState_t state)
255 \fn void EvrRtxThreadGetStackSize (osThreadId_t thread_id, uint32_t stack_size)
261 \fn void EvrRtxThreadGetStackSpace (osThreadId_t thread_id, uint32_t stack_space)
267 \fn void EvrRtxThreadSetPriority (osThreadId_t thread_id, osPriority_t priority)
273 \fn void EvrRtxThreadGetPriority (osThreadId_t thread_id, osPriority_t priority)
279 \fn void EvrRtxThreadYield (void)
285 \fn void EvrRtxThreadSuspend (osThreadId_t thread_id)
291 \fn void EvrRtxThreadSuspended (osThreadId_t thread_id)
297 \fn void EvrRtxThreadResume (osThreadId_t thread_id)
303 \fn void EvrRtxThreadResumed (osThreadId_t thread_id)
309 \fn void EvrRtxThreadDetach (osThreadId_t thread_id)
315 \fn void EvrRtxThreadDetached (osThreadId_t thread_id)
321 \fn void EvrRtxThreadJoin (osThreadId_t thread_id)
327 \fn void EvrRtxThreadJoinPending (osThreadId_t thread_id)
333 \fn void EvrRtxThreadJoined (osThreadId_t thread_id)
339 \fn void EvrRtxThreadBlocked (osThreadId_t thread_id, uint32_t timeout)
345 \fn void EvrRtxThreadUnblocked (osThreadId_t thread_id, uint32_t ret_val)
351 \fn void EvrRtxThreadSwitch (osThreadId_t thread_id)
357 \fn void EvrRtxThreadExit (void)
363 \fn void EvrRtxThreadTerminate (osThreadId_t thread_id)
369 \fn void EvrRtxThreadDestroyed (osThreadId_t thread_id)
375 \fn void EvrRtxThreadGetCount (uint32_t count)
381 \fn void EvrRtxThreadEnumerate (osThreadId_t *thread_array, uint32_t array_items, uint32_t count)
387 \fn void EvrRtxThreadFlagsSet (osThreadId_t thread_id, int32_t flags)
393 \fn void EvrRtxThreadFlagsSetDone (osThreadId_t thread_id, int32_t thread_flags)
399 \fn void EvrRtxThreadFlagsClear (int32_t flags)
405 \fn void EvrRtxThreadFlagsClearDone (int32_t thread_flags)
411 \fn void EvrRtxThreadFlagsGet (int32_t thread_flags)
417 \fn void EvrRtxThreadFlagsWait (int32_t flags, uint32_t options, uint32_t timeout)
423 \fn void EvrRtxThreadFlagsWaitPending (int32_t flags, uint32_t options, uint32_t timeout)
429 \fn void EvrRtxThreadFlagsWaitTimeout (void)
435 \fn void EvrRtxThreadFlagsWaitCompleted (int32_t flags, uint32_t options, int32_t thread_flags)
441 \fn void EvrRtxThreadFlagsWaitNotCompleted (int32_t flags, uint32_t options)
447 \fn void EvrRtxThreadDelay (uint32_t ticks)
453 \fn void EvrRtxThreadDelayUntil (uint64_t ticks)
459 \fn void EvrRtxThreadDelayCompleted (void)
469 \defgroup rtx_evr_timer Timer Functions
470 \brief Events generated by timer functions
476 \fn void EvrRtxTimerError (osTimerId_t timer_id, int32_t status)
482 \fn void EvrRtxTimerCallback (osTimerFunc_t func, void *argument)
488 \fn void EvrRtxTimerNew (osTimerFunc_t func, osTimerType_t type, void *argument, const osTimerAttr_t *attr)
494 \fn void EvrRtxTimerCreated (osTimerId_t timer_id)
500 \fn void EvrRtxTimerGetName (osTimerId_t timer_id, const char *name)
506 \fn void EvrRtxTimerStart (osTimerId_t timer_id, uint32_t ticks)
512 \fn void EvrRtxTimerStarted (osTimerId_t timer_id)
518 \fn void EvrRtxTimerStop (osTimerId_t timer_id)
524 \fn void EvrRtxTimerStopped (osTimerId_t timer_id)
530 \fn void EvrRtxTimerIsRunning (osTimerId_t timer_id, uint32_t running)
536 \fn void EvrRtxTimerDelete (osTimerId_t timer_id)
542 \fn void EvrRtxTimerDestroyed (osTimerId_t timer_id)
552 \defgroup rtx_evr_event_flasg Event Flags Functions
553 \brief Events generated by event flag functions
559 \fn void EvrRtxEventFlagsError (osEventFlagsId_t ef_id, int32_t status)
565 \fn void EvrRtxEventFlagsNew (const osEventFlagsAttr_t *attr)
571 \fn void EvrRtxEventFlagsCreated (osEventFlagsId_t ef_id)
577 \fn void EvrRtxEventFlagsGetName (osEventFlagsId_t ef_id, const char *name)
583 \fn void EvrRtxEventFlagsSet (osEventFlagsId_t ef_id, int32_t flags)
589 \fn void EvrRtxEventFlagsSetDone (osEventFlagsId_t ef_id, int32_t event_flags)
595 \fn void EvrRtxEventFlagsClear (osEventFlagsId_t ef_id, int32_t flags)
601 \fn void EvrRtxEventFlagsClearDone (osEventFlagsId_t ef_id, int32_t event_flags)
607 \fn void EvrRtxEventFlagsGet (osEventFlagsId_t ef_id, int32_t event_flags)
613 \fn void EvrRtxEventFlagsWait (osEventFlagsId_t ef_id, int32_t flags, uint32_t options, uint32_t timeout)
619 \fn void EvrRtxEventFlagsWaitPending (osEventFlagsId_t ef_id, int32_t flags, uint32_t options, uint32_t timeout)
625 \fn void EvrRtxEventFlagsWaitTimeout (osEventFlagsId_t ef_id);
631 \fn void EvrRtxEventFlagsWaitCompleted (osEventFlagsId_t ef_id, int32_t flags, uint32_t options, int32_t event_flags)
637 \fn void EvrRtxEventFlagsWaitNotCompleted (osEventFlagsId_t ef_id, int32_t flags, uint32_t options)
643 \fn void EvrRtxEventFlagsDelete (osEventFlagsId_t ef_id)
649 \fn void EvrRtxEventFlagsDestroyed (osEventFlagsId_t ef_id)
659 \defgroup rtx_evr_mutex Mutex Functions
660 \brief Events generated by mutex functions
666 \fn void EvrRtxMutexError (osMutexId_t mutex_id, int32_t status)
672 \fn void EvrRtxMutexNew (const osMutexAttr_t *attr)
678 \fn void EvrRtxMutexCreated (osMutexId_t mutex_id)
684 \fn void EvrRtxMutexGetName (osMutexId_t mutex_id, const char *name)
690 \fn void EvrRtxMutexAcquire (osMutexId_t mutex_id, uint32_t timeout)
696 \fn void EvrRtxMutexAcquirePending (osMutexId_t mutex_id, uint32_t timeout)
702 \fn void EvrRtxMutexAcquireTimeout (osMutexId_t mutex_id)
708 \fn void EvrRtxMutexAcquired (osMutexId_t mutex_id, uint32_t lock)
714 \fn void EvrRtxMutexNotAcquired (osMutexId_t mutex_id)
720 \fn void EvrRtxMutexRelease (osMutexId_t mutex_id)
726 \fn void EvrRtxMutexReleased (osMutexId_t mutex_id, uint32_t lock)
732 \fn void EvrRtxMutexGetOwner (osMutexId_t mutex_id, osThreadId_t thread_id)
738 \fn void EvrRtxMutexDelete (osMutexId_t mutex_id)
744 \fn void EvrRtxMutexDestroyed (osMutexId_t mutex_id)
754 \defgroup rtx_evr_semaphore Semaphore Functions
755 \brief Events generated by semaphore functions
761 \fn void EvrRtxSemaphoreError (osSemaphoreId_t semaphore_id, int32_t status)
767 \fn void EvrRtxSemaphoreNew (uint32_t max_count, uint32_t initial_count, const osSemaphoreAttr_t *attr)
773 \fn void EvrRtxSemaphoreCreated (osSemaphoreId_t semaphore_id)
779 \fn void EvrRtxSemaphoreGetName (osSemaphoreId_t semaphore_id, const char *name)
785 \fn void EvrRtxSemaphoreAcquire (osSemaphoreId_t semaphore_id, uint32_t timeout)
791 \fn void EvrRtxSemaphoreAcquirePending (osSemaphoreId_t semaphore_id, uint32_t timeout)
797 \fn void EvrRtxSemaphoreAcquireTimeout (osSemaphoreId_t semaphore_id)
803 \fn void EvrRtxSemaphoreAcquired (osSemaphoreId_t semaphore_id)
809 \fn void EvrRtxSemaphoreNotAcquired (osSemaphoreId_t semaphore_id)
815 \fn void EvrRtxSemaphoreRelease (osSemaphoreId_t semaphore_id)
821 \fn void EvrRtxSemaphoreReleased (osSemaphoreId_t semaphore_id)
827 \fn void EvrRtxSemaphoreGetCount (osSemaphoreId_t semaphore_id, uint32_t count)
833 \fn void EvrRtxSemaphoreDelete (osSemaphoreId_t semaphore_id)
839 \fn void EvrRtxSemaphoreDestroyed (osSemaphoreId_t semaphore_id)
849 \defgroup rtx_evr_memory_pool Memory Pool Functions
850 \brief Events generated by memory pool functions
856 \fn void EvrRtxMemoryPoolError (osMemoryPoolId_t mp_id, int32_t status)
862 \fn void EvrRtxMemoryPoolNew (uint32_t block_count, uint32_t block_size, const osMemoryPoolAttr_t *attr)
868 \fn void EvrRtxMemoryPoolCreated (osMemoryPoolId_t mp_id)
874 \fn void EvrRtxMemoryPoolGetName (osMemoryPoolId_t mp_id, const char *name)
880 \fn void EvrRtxMemoryPoolAlloc (osMemoryPoolId_t mp_id, uint32_t timeout)
886 \fn void EvrRtxMemoryPoolAllocPending (osMemoryPoolId_t mp_id, uint32_t timeout)
892 \fn void EvrRtxMemoryPoolAllocTimeout (osMemoryPoolId_t mp_id)
898 \fn void EvrRtxMemoryPoolAllocated (osMemoryPoolId_t mp_id, void *block)
904 \fn void EvrRtxMemoryPoolAllocFailed (osMemoryPoolId_t mp_id)
910 \fn void EvrRtxMemoryPoolFree (osMemoryPoolId_t mp_id, void *block)
916 \fn void EvrRtxMemoryPoolDeallocated (osMemoryPoolId_t mp_id, void *block)
922 \fn void EvrRtxMemoryPoolFreeFailed (osMemoryPoolId_t mp_id, void *block)
928 \fn void EvrRtxMemoryPoolGetCapacity (osMemoryPoolId_t mp_id, uint32_t capacity)
934 \fn void EvrRtxMemoryPoolGetBlockSize (osMemoryPoolId_t mp_id, uint32_t block_size)
940 \fn void EvrRtxMemoryPoolGetCount (osMemoryPoolId_t mp_id, uint32_t count)
946 \fn void EvrRtxMemoryPoolGetSpace (osMemoryPoolId_t mp_id, uint32_t space)
952 \fn void EvrRtxMemoryPoolDelete (osMemoryPoolId_t mp_id)
958 \fn void EvrRtxMemoryPoolDestroyed (osMemoryPoolId_t mp_id)
968 \defgroup rtx_evr_message_queue Message Queue Functions
969 \brief Events generated by message queue functions
975 \fn void EvrRtxMessageQueueError (osMessageQueueId_t mq_id, int32_t status)
981 \fn void EvrRtxMessageQueueNew (uint32_t msg_count, uint32_t msg_size, const osMessageQueueAttr_t *attr)
987 \fn void EvrRtxMessageQueueCreated (osMessageQueueId_t mq_id)
993 \fn void EvrRtxMessageQueueGetName (osMessageQueueId_t mq_id, const char *name)
999 \fn void EvrRtxMessageQueuePut (osMessageQueueId_t mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t timeout)
1005 \fn void EvrRtxMessageQueuePutPending (osMessageQueueId_t mq_id, const void *msg_ptr, uint32_t timeout)
1011 \fn void EvrRtxMessageQueuePutTimeout (osMessageQueueId_t mq_id)
1017 \fn void EvrRtxMessageQueueInsertPending (osMessageQueueId_t mq_id, const void *msg_ptr)
1023 \fn void EvrRtxMessageQueueInserted (osMessageQueueId_t mq_id, const void *msg_ptr)
1029 \fn void EvrRtxMessageQueueNotInserted (osMessageQueueId_t mq_id, const void *msg_ptr)
1035 \fn void EvrRtxMessageQueueGet (osMessageQueueId_t mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t timeout)
1041 \fn void EvrRtxMessageQueueGetPending (osMessageQueueId_t mq_id, void *msg_ptr, uint32_t timeout)
1047 \fn void EvrRtxMessageQueueGetPending (osMessageQueueId_t mq_id, void *msg_ptr, uint32_t timeout)
1053 \fn void EvrRtxMessageQueueRetrieved (osMessageQueueId_t mq_id, void *msg_ptr)
1059 \fn void EvrRtxMessageQueueNotRetrieved (osMessageQueueId_t mq_id, void *msg_ptr)
1065 \fn void EvrRtxMessageQueueGetCapacity (osMessageQueueId_t mq_id, uint32_t capacity)
1071 \fn void EvrRtxMessageQueueGetMsgSize (osMessageQueueId_t mq_id, uint32_t msg_size)
1077 \fn void EvrRtxMessageQueueGetCount (osMessageQueueId_t mq_id, uint32_t count)
1083 \fn void EvrRtxMessageQueueGetSpace (osMessageQueueId_t mq_id, uint32_t space)
1089 \fn void EvrRtxMessageQueueReset (osMessageQueueId_t mq_id)
1095 \fn void EvrRtxMessageQueueResetDone (osMessageQueueId_t mq_id)
1101 \fn void EvrRtxMessageQueueDelete (osMessageQueueId_t mq_id)
1107 \fn void EvrRtxMessageQueueDestroyed (osMessageQueueId_t mq_id)
1119 // end group Event Recorder