begriffs open source - cmsis-freertos/blob - DoxyGen/General/src/freertos_evr.txt

   1
   2 /**
   3 \defgroup freertos_setup Event Recorder Setup
   4 \ingroup freertos_specific
   5 \brief Information about Event Recorder configuration and setup
   6 \details
   7 CMSIS-FreeRTOS interfaces to the
   8 <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/index.html" target="_blank"><b>Event Recorder</b></a>
   9 to provide event information which helps you to understand and analyze the operation.
  10
  11 To use the Event Recorder together with CMSIS-FreeRTOS, it is required to create an image that generates event information.
  12 The steps are described under \ref cre_freertos_proj.
  13 @{
  14 */
  15
  16 /**
  17 \fn void EvrFreeRTOSSetup (uint32_t reset)
  18 \details
  19 The function \b EvrFreeRTOSSetup initializes Event Recorder and configures recording level filter. It must be called before any event is sent to the Event Recorder.
  20
  21 The argument \a reset specifies if reset of previously applied configuration is performed in case if EvrFreeRTOSSetup was already called.
  22
  23 Behavior of this function execution is defined with Event Recorder Configuration (\ref cmsis_freertos_evr_config). Calling this function has
  24 no effect when Event Recorder component is not selected.
  25
  26 \note \b EvrFreeRTOSSetup is called by function \b osKernelInitialize when CMSIS-RTOS2 API is in use and should not be called explicitly.
  27
  28
  29
  30 */
  31
  32 /**
  33 @}
  34 */
  35
  36 /**
  37 \defgroup freertos_evr Event functions
  38 \ingroup freertos_specific
  39 \brief FreeRTOS Event Recorder functions
  40 \details
  41 CMSIS-FreeRTOS interfaces to the
  42 <a href="http://www.keil.com/pack/doc/compiler/EventRecorder/html/index.html" target="_blank"><b>Event Recorder</b></a>
  43 to provide event information which helps you to understand and analyze the operation.
  44
  45 To use the Event Recorder together with CMSIS-FreeRTOS, it is required to create an image that generates event information.
  46 The steps are:
  47   - <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>.
  48   - <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>.
  49   - <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.
  50   - Build the application code and download it to the debug hardware.
  51
  52 Once the target application generates event information, it can be viewed in the µVision debugger using the \b Event
  53  \b Recorder.
  54
  55 @{
  56 */
  57
  58 /**
  59 \defgroup freertos_evr_tasks Tasks Functions
  60 \brief Events generated by tasks functions
  61 \details
  62 @{
  63 */
  64
  65 /**
  66 \fn void EvrFreeRTOSTasks_TaskCreate (TCB_t pxNewTCB)
  67 \details
  68 The event \b TaskCreate is generated when task object is successfully created.
  69
  70 \b Value in the Event Recorder shows:
  71  - \b pxNewTCB : pointer to task object handle (control block address).
  72 */
  73
  74 /**
  75 \fn void EvrFreeRTOSTasks_TaskCreateFailed (void)
  76 \details
  77 The event \b TaskCreateFailed is generated when task object create fails due to insufficient heap memory.
  78 */
  79
  80 /**
  81 \fn void EvrFreeRTOSTasks_TaskDelete (TCB_t pxTCB)
  82 \details
  83 The event \b TaskDelete is generated when the task is successfully added into thread termination list.
  84
  85 \b Value in the Event Recorder shows:
  86  - \b pxTCB : pointer to task object handle (control block address).
  87 */
  88
  89 /**
  90 \fn void EvrFreeRTOSTasks_TaskDelayUntil (uint32_t xTimeToWake)
  91 \details
  92 The event \b TaskDelayUntil is generated before the current running task execution is delayed.
  93
  94 \b Value in the Event Recorder shows:
  95  - \b xTimeToWake : wake time in ticks.
  96 */
  97
  98 /**
  99 \fn void EvrFreeRTOSTasks_TaskDelay (uint32_t xTicksToDelay)
 100 \details
 101 The event \b TaskDelay is generated when the current running task execution is delayed.
 102
 103 \b Value in the Event Recorder shows:
 104  - \b xTicksToDelay : number of ticks to delay.
 105 */
 106
 107 /**
 108 \fn void EvrFreeRTOSTasks_TaskPrioritySet (TCB_t pxTCB, uint32_t uxNewPriority)
 109 \details
 110 The event \b TaskPrioritySet is generated when task priority is set.
 111
 112 \b Value in the Event Recorder shows:
 113  - \b pxTCB : pointer to task object handle (control block address).
 114  - \b uxNewPriority : task new priority .
 115 */
 116
 117 /**
 118 \fn void EvrFreeRTOSTasks_TaskSuspend (TCB_t pxTCB)
 119 \details
 120 The event \b TaskSuspend is generated when task execution is suspended.
 121
 122 \b Value in the Event Recorder shows:
 123  - \b pxTCB : pointer to task object handle (control block address).
 124 */
 125
 126 /**
 127 \fn void EvrFreeRTOSTasks_TaskResume (TCB_t pxTCB)
 128 \details
 129 The event \b TaskResume is generated when task execution is resumed.
 130
 131 \b Value in the Event Recorder shows:
 132  - \b pxTCB : pointer to task object handle (control block address).
 133 */
 134
 135 /**
 136 \fn void EvrFreeRTOSTasks_TaskResumeFromIsr (TCB_t pxTCB)
 137 \details
 138 The event \b TaskResumeFromIsr is generated when task execution is resumed from the ISR.
 139
 140 \b Value in the Event Recorder shows:
 141  - \b pxTCB : pointer to task object handle (control block address).
 142 */
 143
 144 /**
 145 \fn void EvrFreeRTOSTasks_TaskIncrementTick (uint32_t xTickCount)
 146 \details
 147 The event \b TaskIncrementTick is generated on every tick increment.
 148
 149 \b Value in the Event Recorder shows:
 150  - \b xTickCount : tick count before increment.
 151 */
 152
 153 /**
 154 \fn void EvrFreeRTOSTasks_IncreaseTickCount (uint32_t xTicksToJump)
 155 \details
 156 The event \b IncreaseTickCount is generated when tick count is increased by the number of ticks spent in low power mode.
 157
 158 \b Value in the Event Recorder shows:
 159  - \b xTicksToJump : number of ticks by which the tick count is increased.
 160 */
 161
 162 /**
 163 \fn void EvrFreeRTOSTasks_TaskSwitchedOut (TCB_t pxCurrentTCB)
 164 \details
 165 The event \b TaskSwitchedOut is generated before a new task is selected to run.
 166
 167 \b Value in the Event Recorder shows:
 168  - \b pxCurrentTCB : pointer to task object handle (control block address).
 169 */
 170
 171 /**
 172 \fn void EvrFreeRTOSTasks_TaskSwitchedIn  (TCB_t pxCurrentTCB, uint32_t uxTopPriority)
 173 \details
 174 The event \b TaskSwitchedIn is generated after a task has been selected to run.
 175
 176 \b Value in the Event Recorder shows:
 177  - \b pxCurrentTCB : pointer to task object handle (control block address).
 178  - \b uxTopPriority : task priority
 179 */
 180
 181 /**
 182 \fn void EvrFreeRTOSTasks_TaskPriorityInherit (TCB_t pxTCBOfMutexHolder, uint32_t uxInheritedPriority)
 183 \details
 184 The event \b TaskPriorityInherit is generated when task priority is inherited from the current running task.
 185
 186 \b Value in the Event Recorder shows:
 187  - \b pxTCBOfMutexHolder : pointer to task object handle (control block address).
 188  - \b uxInheritedPriority : inherited task priority
 189 */
 190
 191 /**
 192 \fn void EvrFreeRTOSTasks_TaskPriorityDisinherit (TCB_t pxTCBOfMutexHolder, uint32_t uxOriginalPriority)
 193 \details
 194 The event \b TaskPriorityDisinherit is generated when task priority is disinherited to its base priority.
 195
 196 \b Value in the Event Recorder shows:
 197  - \b pxTCBOfMutexHolder : pointer to task object handle (control block address).
 198  - \b uxOriginalPriority : task base priority
 199 */
 200
 201 /**
 202 \fn void EvrFreeRTOSTasks_MovedTaskToReadyState (TCB_t pxTCB)
 203 \details
 204 The event \b MovedTaskToReadyState is generated before the task is transitioned into the Ready state.
 205
 206 \b Value in the Event Recorder shows:
 207  - \b pxTCB : pointer to task object handle (control block address).
 208 */
 209
 210 /**
 211 \fn void EvrFreeRTOSTasks_PostMovedTaskToReadyState (TCB_t pxTCB)
 212 \details
 213 The event \b PostMovedTaskToReadyState is generated after the task is transitioned into the Ready state.
 214
 215 \b Value in the Event Recorder shows:
 216  - \b pxTCB : pointer to task object handle (control block address).
 217 */
 218
 219 /**
 220 \fn void EvrFreeRTOSTasks_LowPowerIdleBegin (uint32_t xExpectedIdleTime)
 221 \details
 222 The event \b LowPowerIdleBegin is generated when task scheduler enters the low power mode.
 223
 224 \b Value in the Event Recorder shows:
 225  - \b xExpectedIdleTime : expected idle time in ticks.
 226 */
 227
 228 /**
 229 \fn void EvrFreeRTOSTasks_LowPowerIdleEnd (void)
 230 \details
 231 The event \b LowPowerIdleEnd is generated when task scheduler exits from the low power mode.
 232 */
 233
 234 /**
 235 \fn void EvrFreeRTOSTasks_TaskNotifyTakeBlock (uint32_t uxIndexToWait, uint32_t xTicksToWait)
 236 \details
 237 The event \b TaskNotifyTakeBlock is generated when the current running task is about to block and wait to take notification.
 238
 239 \b Value in the Event Recorder shows:
 240  - \b uxIndexToWait : task notification index
 241  - \b xTicksToWait : wait timeout in ticks.
 242 */
 243
 244 /**
 245 \fn void EvrFreeRTOSTasks_TaskNotifyTake (uint32_t uxIndexToWait, uint32_t ulNotifiedValue)
 246 \details
 247 The event \b TaskNotifyTake is generated when task notify take is successfully executed.
 248
 249 \b Value in the Event Recorder shows:
 250  - \b uxIndexToWait : task notification index
 251  - \b ulNotifiedValue : current state of the notification value.
 252 */
 253
 254 /**
 255 \fn void EvrFreeRTOSTasks_TaskNotifyWaitBlock (uint32_t uxIndexToWait, uint32_t xTicksToWait)
 256 \details
 257 The event \b TaskNotifyWaitBlock is generated when the current running task is about to block and wait to receive notification.
 258
 259 \b Value in the Event Recorder shows:
 260  - \b uxIndexToWait : task notification index
 261  - \b xTicksToWait : wait timeout in ticks.
 262 */
 263
 264 /**
 265 \fn void EvrFreeRTOSTasks_TaskNotifyWait (uint32_t uxIndexToWait, uint32_t ulNotifiedValue)
 266 \details
 267 The event \b TaskNotifyWait is generated when task notify wait is completed.
 268
 269 \b Value in the Event Recorder shows:
 270  - \b uxIndexToWait : task notification index
 271  - \b ulNotifiedValue : current state of the notification value.
 272 */
 273
 274 /**
 275 \fn void EvrFreeRTOSTasks_TaskNotify (TCB_t xTaskToNotify, uint32_t uxIndexToWait, uint32_t eAction, uint32_t ulNotifiedValue)
 276 \details
 277 The event \b TaskNotify is generated when task notify is successfully executed.
 278
 279 \b Value in the Event Recorder shows:
 280  - \b xTaskToNotify : pointer to task object handle (control block address).
 281  - \b uxIndexToWait : task notification index
 282  - \b eAction : task notification action (eNotifyAction).
 283  - \b ulNotifiedValue : current state of the notification value.
 284 */
 285
 286 /**
 287 \fn void EvrFreeRTOSTasks_TaskNotifyFromIsr (TCB_t xTaskToNotify, uint32_t uxIndexToWait, uint32_t eAction, uint32_t ulNotifiedValue)
 288 \details
 289 The event \b TaskNotifyFromIsr is generated when task notify from ISR is successfully executed.
 290
 291 \b Value in the Event Recorder shows:
 292  - \b xTaskToNotify : pointer to task object handle (control block address).
 293  - \b uxIndexToWait : task notification index
 294  - \b eAction : task notification action (eNotifyAction).
 295  - \b ulNotifiedValue : current state of the notification value.
 296 */
 297
 298 /**
 299 \fn void EvrFreeRTOSTasks_TaskNotifyGiveFromIsr (TCB_t xTaskToNotify, uint32_t ulNotifiedValue)
 300 \details
 301 The event \b TaskNotifyGiveFromIsr is generated when task notify give from ISR is successfully executed.
 302
 303 \b Value in the Event Recorder shows:
 304  - \b xTaskToNotify : pointer to task object handle (control block address).
 305  - \b uxIndexToWait : task notification index
 306  - \b ulNotifiedValue : current state of the notification value.
 307 */
 308
 309 /**
 310 @}
 311 */
 312
 313
 314 /**
 315 \defgroup freertos_evr_queue Message Queue Functions
 316 \brief Events generated by message queue functions
 317 \details
 318 @{
 319 */
 320
 321 /**
 322 \fn void EvrFreeRTOSQueue_QueueCreate (Queue_t pxQueue)
 323 \details
 324 The event \b QueueCreate is generated when queue object is successfully created.
 325
 326 \b Value in the Event Recorder shows:
 327  - \b pxQueue : pointer to queue object handle (control block address).
 328 */
 329
 330 /**
 331 \fn void EvrFreeRTOSQueue_QueueCreateFailed (uint32_t ucQueueType)
 332 \details
 333 The event \b QueueCreateFailed is generated when queue object create fails due to insufficient heap memory.
 334
 335 \b Value in the Event Recorder shows:
 336  - \b ucQueueType : x
 337 */
 338
 339 /**
 340 \fn void EvrFreeRTOSQueue_CreateMutex (Queue_t pxNewQueue)
 341 \details
 342 The event \b CreateMutex is generated when mutex object is successfully created.
 343
 344 \b Value in the Event Recorder shows:
 345  - \b pxNewQueue : pointer to mutex (queue) object handle (control block address).
 346 */
 347
 348 /**
 349 \fn void EvrFreeRTOSQueue_CreateMutexFailed (void)
 350 \details
 351 The event \b CreateMutexFailed is generated when mutex object create fails due to insufficient heap memory.
 352 */
 353
 354 /**
 355 \fn void EvrFreeRTOSQueue_GiveMutexRecursive (Queue_t pxMutex)
 356 \details
 357 The event \b GiveMutexRecursive is generated when mutex give operation is successfully executed.
 358
 359 \b Value in the Event Recorder shows:
 360  - \b pxMutex : pointer to mutex (queue) object handle (control block address).
 361 */
 362
 363 /**
 364 \fn void EvrFreeRTOSQueue_GiveMutexRecursiveFailed (Queue_t pxMutex)
 365 \details
 366 The event \b GiveMutexRecursiveFailed is generated when recursive mutex give operation was not successful.
 367
 368 \b Value in the Event Recorder shows:
 369  - \b pxMutex : pointer to mutex (queue) object handle (control block address).
 370 */
 371
 372 /**
 373 \fn void EvrFreeRTOSQueue_TakeMutexRecursive (Queue_t pxMutex)
 374 \details
 375 The event \b TakeMutexRecursive is generated when recursive mutex take operation is successfully executed.
 376
 377 \b Value in the Event Recorder shows:
 378  - \b pxMutex : pointer to mutex (queue) object handle (control block address).
 379 */
 380
 381 /**
 382 \fn void EvrFreeRTOSQueue_TakeMutexRecursiveFailed (Queue_t pxMutex)
 383 \details
 384 The event \b TakeMutexRecursiveFailed is generated when recursive mutex take operation is not successful.
 385
 386 \b Value in the Event Recorder shows:
 387  - \b pxMutex : pointer to mutex (queue) object handle (control block address).
 388 */
 389
 390 /**
 391 \fn void EvrFreeRTOSQueue_CreateCountingSemaphore (Queue_t xHandle)
 392 \details
 393 The event \b CreateCountingSemaphore is generated when counting semaphore object is successfully created.
 394
 395 \b Value in the Event Recorder shows:
 396  - \b xHandle : pointer to semaphore (queue) object handle (control block address).
 397 */
 398
 399 /**
 400 \fn void EvrFreeRTOSQueue_CreateCountingSemaphoreFailed (void)
 401 \details
 402 The event \b CreateCountingSemaphoreFailed is generated when semaphore object create fails due to insufficient heap memory.
 403 */
 404
 405 /**
 406 \fn void EvrFreeRTOSQueue_QueueSend (Queue_t pxQueue)
 407 \details
 408 The event \b QueueSend is generated when the queue send operation was successful.
 409
 410 \b Value in the Event Recorder shows:
 411  - \b pxQueue : pointer to queue object handle (control block address).
 412 */
 413
 414 /**
 415 \fn void EvrFreeRTOSQueue_QueueSendFailed (Queue_t pxQueue)
 416 \details
 417 The event \b QueueSendFailed is generated when the queue send operation fails due to the queue being full.
 418
 419 \b Value in the Event Recorder shows:
 420  - \b pxQueue : pointer to queue object handle (control block address).
 421 */
 422
 423 /**
 424 \fn void EvrFreeRTOSQueue_QueueReceive (Queue_t pxQueue)
 425 \details
 426 The event \b QueueReceive is generated when the queue receive operation was successful.
 427
 428 \b Value in the Event Recorder shows:
 429  - \b pxQueue : pointer to queue object handle (control block address).
 430 */
 431
 432 /**
 433 \fn void EvrFreeRTOSQueue_QueuePeek (Queue_t pxQueue)
 434 \details
 435 The event \b QueuePeek is generated when the queue peek operation was successful.
 436
 437 \b Value in the Event Recorder shows:
 438  - \b pxQueue : pointer to queue object handle (control block address).
 439 */
 440
 441 /**
 442 \fn void EvrFreeRTOSQueue_QueuePeekFromIsr (Queue_t pxQueue)
 443 \details
 444 The event \b QueuePeekFromIsr is generated when the queue peek from ISR operation was successful.
 445
 446 \b Value in the Event Recorder shows:
 447  - \b pxQueue : pointer to queue object handle (control block address).
 448 */
 449
 450 /**
 451 \fn void EvrFreeRTOSQueue_QueueReceiveFailed (Queue_t pxQueue)
 452 \details
 453 The event \b QueueReceiveFailed is generated when the queue receive operation failed because the queue was empty.
 454
 455 \b Value in the Event Recorder shows:
 456  - \b pxQueue : pointer to queue object handle (control block address).
 457 */
 458
 459 /**
 460 \fn void EvrFreeRTOSQueue_QueueSendFromIsr (Queue_t pxQueue)
 461 \details
 462 The event \b QueueSendFromIsr is generated when the queue send from ISR operation was successful.
 463
 464 \b Value in the Event Recorder shows:
 465  - \b pxQueue : pointer to queue object handle (control block address).
 466 */
 467
 468 /**
 469 \fn void EvrFreeRTOSQueue_QueueSendFromIsrFailed (Queue_t pxQueue)
 470 \details
 471 The event \b QueueSendFromIsrFailed is generated when the queue send operation fails due to the queue already being full.
 472
 473 \b Value in the Event Recorder shows:
 474  - \b pxQueue : pointer to queue object handle (control block address).
 475 */
 476
 477 /**
 478 \fn void EvrFreeRTOSQueue_QueueReceiveFromIsr (Queue_t pxQueue)
 479 \details
 480 The event \b QueueReceiveFromIsr is generated when the queue receive from ISR operation was successful.
 481
 482 \b Value in the Event Recorder shows:
 483  - \b pxQueue : pointer to queue object handle (control block address).
 484 */
 485
 486 /**
 487 \fn void EvrFreeRTOSQueue_QueueReceiveFromIsrFailed (Queue_t pxQueue)
 488 \details
 489 The event \b QueueReceiveFromIsrFailed is generated when the queue receive operation fails due to the queue already being empty.
 490
 491 \b Value in the Event Recorder shows:
 492  - \b pxQueue : pointer to queue object handle (control block address).
 493 */
 494
 495 /**
 496 \fn void EvrFreeRTOSQueue_QueuePeekFromIsrFailed (Queue_t pxQueue)
 497 \details
 498 The event \b QueuePeekFromIsrFailed is generated when queue peek operation is executed from an ISR and the queue is empty.
 499
 500 \b Value in the Event Recorder shows:
 501  - \b pxQueue : pointer to queue object handle (control block address).
 502 */
 503
 504 /**
 505 \fn void EvrFreeRTOSQueue_QueueDelete (Queue_t pxQueue)
 506 \details
 507 The event \b QueueDelete is generated when the function vQueueDelete is called.
 508
 509 \b Value in the Event Recorder shows:
 510  - \b pxQueue : pointer to queue object handle (control block address).
 511 */
 512
 513 /**
 514 \fn void EvrFreeRTOSQueue_QueueRegistryAdd (Queue_t pxQueue, const char *pcQueueName)
 515 \details
 516 The event \b QueueRegistryAdd is generated when a human readable name is registered to the specified queue.
 517
 518 \b Value in the Event Recorder shows:
 519  - \b pxQueue : pointer to queue object handle (control block address).
 520  - \b pcQueueName : pointer to the ASCII string.
 521 */
 522
 523 /**
 524 \fn void EvrFreeRTOSQueue_BlockingOnQueueReceive (Queue_t pxQueue)
 525 \details
 526 The event \b BlockingOnQueueReceive is generated when the currently executing task is about to block following
 527 an attempt to read from an empty queue, or an attempt to 'take' an empty semaphore or mutex.
 528
 529 \b Value in the Event Recorder shows:
 530  - \b pxQueue : pointer to queue object handle (control block address).
 531 */
 532
 533 /**
 534 \fn void EvrFreeRTOSQueue_BlockingOnQueueSend (Queue_t pxQueue)
 535 \details
 536 The event \b BlockingOnQueueSend is generated when the currently executing task is about to block following
 537 an attempt to write to a full queue.
 538
 539 \b Value in the Event Recorder shows:
 540  - \b pxQueue : pointer to queue object handle (control block address).
 541 */
 542
 543 /**
 544 @}
 545 */
 546
 547
 548 /**
 549 \defgroup freertos_evr_timers Timer Functions
 550 \brief Events generated by timer functions
 551 \details
 552 @{
 553 */
 554
 555 /**
 556 \fn void EvrFreeRTOSTimers_TimerCreate (Timer_t pxNewTimer)
 557 \details
 558 The event \b TimerCreate is generated when timer object is successfully created.
 559
 560 \b Value in the Event Recorder shows:
 561  - \b pxNewTimer : pointer to timer object handle (control block address).
 562 */
 563
 564 /**
 565 \fn void EvrFreeRTOSTimers_TimerCreateFailed (void)
 566 \details
 567 The event \b TimerCreateFailed is generated when timer object create fails due to insufficient heap memory.
 568 */
 569
 570 /**
 571 \fn void EvrFreeRTOSTimers_TimerCommandSend (Timer_t pxTimer, uint32_t xCommandID, uint32_t xOptionalValue, uint32_t xReturn)
 572 \details
 573 The event \b TimerCommandSend is generated when a command is sent to the timer service task,
 574
 575 \b Value in the Event Recorder shows:
 576  - \b pxTimer : pointer to timer object handle (control block address).
 577  - \b xCommandID : timer command ID.
 578  - \b xOptionalValue : optional command value.
 579  - \b xReturn : execution status (0: failed, command was not sent to the timer command queue, 1: passed, command sent)
 580 */
 581
 582 /**
 583 \fn void EvrFreeRTOSTimers_TimerCommandReceived (Timer_t pxTimer, uint32_t xCommandID, uint32_t xOptionalValue)
 584 \details
 585 The event \b TimerCommandReceived is generated when the timer service task receives a command and before the command is actually processed.
 586
 587 \b Value in the Event Recorder shows:
 588  - \b pxTimer : pointer to timer object handle (control block address).
 589  - \b xCommandID : timer command ID.
 590  - \b xOptionalValue : optional command value.
 591 */
 592
 593 /**
 594 \fn void EvrFreeRTOSTimers_TimerExpired (Timer_t pxTimer)
 595 \details
 596 The event \b TimerExpired is generated when a software timer expires and before the timer callback is executed.
 597
 598 \b Value in the Event Recorder shows:
 599  - \b pxTimer : pointer to timer object handle (control block address).
 600 */
 601
 602 /**
 603 \fn void EvrFreeRTOSTimers_PendFuncCall (PendedFunction_t pxFunctionToPend, void *pvParameter1, uint32_t ulParameter2, uint32_t xReturn)
 604 \details
 605 The event \b PendFuncCall is generated before the function xTimerPendFunctionCall returns.
 606
 607 \b Value in the Event Recorder shows:
 608  - \b pxFunctionToPend : callback function to execute from the timer service/deamon task.
 609  - \b pvParameter1 : the value passed into the callback function as the first parameter.
 610  - \b ulParameter2 : the value passed into the callback function as the second parameter.
 611  - \b xReturn : execution status (1=callback passed to the timer sevice task, any other value: queue full, failed to register the callback execution)
 612 */
 613
 614 /**
 615 \fn void EvrFreeRTOSTimers_PendFuncCallFromIsr (PendedFunction_t pxFunctionToPend, void *pvParameter1, uint32_t ulParameter2, uint32_t xReturn)
 616 \details
 617 The event \b PendFuncCallFromIsr is generated before the function xTimerPendFunctionCallFromISR returns.
 618
 619 \b Value in the Event Recorder shows:
 620  - \b pxFunctionToPend : callback function to execute from the timer service/deamon task.
 621  - \b pvParameter1 : the value passed into the callback function as the first parameter.
 622  - \b ulParameter2 : the value passed into the callback function as the second parameter.
 623  - \b xReturn : execution status (1=callback passed to the timer sevice task, any other value: queue full, failed to register the callback execution)
 624 */
 625
 626 /**
 627 @}
 628 */
 629
 630
 631 /**
 632 \defgroup freertos_evr_event_groups Event Groups Functions
 633 \brief Events generated by event groups functions
 634 \details
 635 @{
 636 */
 637
 638 /**
 639 \fn void EvrFreeRTOSEventGroups_EventGroupCreate (EventGroup_t pxEventGroup)
 640 \details
 641 The event \b EventGroupCreate is generated when Event Groups object is successfully created.
 642
 643 \b Value in the Event Recorder shows:
 644  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 645 */
 646
 647 /**
 648 \fn void EvrFreeRTOSEventGroups_EventGroupCreateFailed (void)
 649 \details
 650 The event \b EventGroupCreateFailed is generated when Event Groups object create fails due to insufficient heap memory.
 651 */
 652
 653 /**
 654 \fn void EvrFreeRTOSEventGroups_EventGroupSyncBlock (EventGroup_t pxEventGroup, uint32_t uxBitsToSet, uint32_t uxBitsToWaitFor)
 655 \details
 656 The event \b EventGroupSyncBlock is generated before the function xEventGroupSync enters blocked state.
 657
 658 \b Value in the Event Recorder shows:
 659  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 660  - \b uxBitsToSet : event bits that shall be set.
 661  - \b uxBitsToWaitFor : event bits to wait for.
 662 */
 663
 664 /**
 665 \fn void EvrFreeRTOSEventGroups_EventGroupSyncEnd (EventGroup_t pxEventGroup, uint32_t uxBitsToSet, uint32_t uxBitsToWaitFor, uint32_t xTimeoutOccurred)
 666 \details
 667 The event \b EventGroupSyncEnd is generated before the function xEventGroupSync returns.
 668
 669 \b Value in the Event Recorder shows:
 670  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 671  - \b uxBitsToSet : event bits that shall be set.
 672  - \b uxBitsToWaitFor : event bits to wait for.
 673  - \b xTimeoutOccurred : timeout value (0=timeout occurred, 1=no timeout)
 674 */
 675
 676 /**
 677 \fn void EvrFreeRTOSEventGroups_EventGroupWaitBitsBlock (EventGroup_t pxEventGroup, uint32_t uxBitsToWaitFor)
 678 \details
 679 The event \b EventGroupWaitBitsBlock is generated before the function xEventGroupWaitBits enters blocked state.
 680
 681 \b Value in the Event Recorder shows:
 682  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 683  - \b uxBitsToWaitFor : event bits to wait for.
 684 */
 685
 686 /**
 687 \fn void EvrFreeRTOSEventGroups_EventGroupWaitBitsEnd (EventGroup_t pxEventGroup, uint32_t uxBitsToWaitFor, uint32_t xTimeoutOccurred)
 688 \details
 689 The event \b EventGroupWaitBitsEnd is generated before the function xEventGroupWaitBits returns.
 690
 691 \b Value in the Event Recorder shows:
 692  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 693  - \b uxBitsToWaitFor : event bits to wait for.
 694  - \b xTimeoutOccurred : timeout value (0=timeout occurred, 1=no timeout)
 695 */
 696
 697 /**
 698 \fn void EvrFreeRTOSEventGroups_EventGroupClearBits (EventGroup_t pxEventGroup, uint32_t uxBitsToClear)
 699 \details
 700 The event \b EventGroupClearBits is generated when the function xEventGroupClearBits is called.
 701
 702 \b Value in the Event Recorder shows:
 703  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 704  - \b uxBitsToClear : event bits that shall be cleared.
 705 */
 706
 707 /**
 708 \fn void EvrFreeRTOSEventGroups_EventGroupClearBitsFromIsr (EventGroup_t pxEventGroup, uint32_t uxBitsToClear)
 709 \details
 710 The event \b EventGroupClearBitsFromIsr is generated when the function xEventGroupClearBitsFromISR is called.
 711
 712 \b Value in the Event Recorder shows:
 713  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 714  - \b uxBitsToClear : event bits that shall be cleared.
 715 */
 716
 717 /**
 718 \fn void EvrFreeRTOSEventGroups_EventGroupSetBits (EventGroup_t pxEventGroup, uint32_t uxBitsToSet)
 719 \details
 720 The event \b EventGroupSetBits is generated when the function xEventGroupSetBits is called.
 721
 722 \b Value in the Event Recorder shows:
 723  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 724  - \b uxBitsToSet : event bits that shall be set.
 725 */
 726
 727 /**
 728 \fn void EvrFreeRTOSEventGroups_EventGroupSetBitsFromIsr (EventGroup_t pxEventGroup, uint32_t uxBitsToSet)
 729 \details
 730 The event \b EventGroupSetBitsFromIsr is generated when the function xEventGroupSetBitsFromISR is called.
 731
 732 \b Value in the Event Recorder shows:
 733  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 734  - \b uxBitsToSet : event bits that shall be set.
 735 */
 736
 737 /**
 738 \fn void EvrFreeRTOSEventGroups_EventGroupDelete (EventGroup_t pxEventGroup)
 739 \details
 740 The event \b EventGroupDelete is generated when Event Group object is successfully added to object delete queue.
 741
 742 \b Value in the Event Recorder shows:
 743  - \b pxEventGroup : pointer to Event Groups object handle (control block address)
 744 */
 745
 746 /**
 747 @}
 748 */
 749
 750
 751 /**
 752 \defgroup freertos_evr_streambuf Stream Buffer Functions
 753 \brief Events generated by Stream Buffer and Message Buffer functions
 754 \details
 755 @{
 756 */
 757
 758 /**
 759 \fn void EvrFreeRTOSStreamBuf_StreamBufferCreateFailed (uint32_t uxIsMessageBuffer)
 760 \details
 761 The event \b StreamBufferCreateFailed is generated when Stream Buffer or Message Buffer object create fails due to insufficient heap memory.
 762
 763 \b Value in the Event Recorder shows:
 764  - \b uxIsMessageBuffer : buffer type designator, 0 for stream buffer and 1 for message buffer.
 765 */
 766
 767 /**
 768 \fn void EvrFreeRTOSStreamBuf_StreamBufferCreateStaticFailed (StreamBuffer_t pxStreamBuffer, uint32_t uxIsMessageBuffer)
 769 \details
 770 The event \b StreamBufferCreateStaticFailed is generated when statically allocated Stream Buffer or Message Buffer object fails to initialize.
 771
 772 \b Value in the Event Recorder shows:
 773  - \b pxStreamBuffer : pointer to statically allocated Stream Buffer object handle.
 774  - \b uxIsMessageBuffer : buffer type designator, 0 for stream buffer and 1 for message buffer.
 775 */
 776
 777 /**
 778 \fn void EvrFreeRTOSStreamBuf_StreamBufferCreate (StreamBuffer_t pxStreamBuffer, uint32_t uxIsMessageBuffer)
 779 \details
 780 The event \b StreamBufferCreate is generated when Stream Buffer object was successfully created.
 781
 782 \b Value in the Event Recorder shows:
 783  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 784  - \b uxIsMessageBuffer : buffer type designator, 0 for stream buffer and 1 for message buffer.
 785 */
 786
 787 /**
 788 \fn void EvrFreeRTOSStreamBuf_StreamBufferDelete (StreamBuffer_t pxStreamBuffer)
 789 \details
 790 The event \b StreamBufferDelete is generated when Stream Buffer object is deallocated or cleared in case of static allocation.
 791
 792 \b Value in the Event Recorder shows:
 793  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 794 */
 795
 796 /**
 797 \fn void EvrFreeRTOSStreamBuf_StreamBufferReset (StreamBuffer_t pxStreamBuffer)
 798 \details
 799 The event \b StreamBufferReset is generated when Stream Buffer object is reset and re-initialized.
 800
 801 \b Value in the Event Recorder shows:
 802  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 803 */
 804
 805 /**
 806 \fn void EvrFreeRTOSStreamBuf_StreamBufferBlockingOnSend (StreamBuffer_t pxStreamBuffer)
 807 \details
 808 The event \b StreamBufferBlockingOnSend is generated when Stream Buffer send is blocked to wait for free space in the buffer.
 809
 810 \b Value in the Event Recorder shows:
 811  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 812 */
 813
 814 /**
 815 \fn void EvrFreeRTOSStreamBuf_StreamBufferSend (StreamBuffer_t pxStreamBuffer, uint32_t xBytesSent)
 816 \details
 817 The event \b StreamBufferSend is generated when Stream Buffer sends the data into the buffer.
 818
 819 \b Value in the Event Recorder shows:
 820  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 821  - \b xBytesSent : number of bytes copied into the stream buffer
 822 */
 823
 824 /**
 825 \fn void EvrFreeRTOSStreamBuf_StreamBufferSendFailed (StreamBuffer_t pxStreamBuffer)
 826 \details
 827 The event \b StreamBufferSendFailed is generated when Stream Buffer failed to send data into the buffer.
 828
 829 \b Value in the Event Recorder shows:
 830  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 831 */
 832
 833 /**
 834 \fn void EvrFreeRTOSStreamBuf_StreamBufferSendFromIsr (StreamBuffer_t pxStreamBuffer, uint32_t xBytesSent)
 835 \details
 836 The event \b StreamBufferSendFromIsr is generated when Stream Buffer send was called from the ISR.
 837
 838 \b Value in the Event Recorder shows:
 839  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 840  - \b xBytesSent : number of bytes copied into the stream buffer
 841 */
 842
 843 /**
 844 \fn void EvrFreeRTOSStreamBuf_StreamBufferBlockingOnReceive (StreamBuffer_t pxStreamBuffer)
 845 \details
 846 The event \b StreamBufferBlockingOnReceive is generated when Stream Buffer receive is blocked to wait for data to be available.
 847
 848 \b Value in the Event Recorder shows:
 849  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 850 */
 851
 852 /**
 853 \fn void EvrFreeRTOSStreamBuf_StreamBufferReceive (StreamBuffer_t pxStreamBuffer, uint32_t xReceivedLength)
 854 \details
 855 The event \b StreamBufferReceive is generated when Stream Buffer receive is called.
 856
 857 \b Value in the Event Recorder shows:
 858  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 859  - \b xReceivedLength : number of bytes copied from the stream buffer
 860 */
 861
 862 /**
 863 \fn void EvrFreeRTOSStreamBuf_StreamBufferReceiveFailed (StreamBuffer_t pxStreamBuffer)
 864 \details
 865 The event \b StreamBufferReceiveFailed is generated when Stream Buffer receive is called and there is no data to receive.
 866
 867 \b Value in the Event Recorder shows:
 868  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 869 */
 870
 871 /**
 872 \fn void EvrFreeRTOSStreamBuf_StreamBufferReceiveFromIsr (StreamBuffer_t pxStreamBuffer, uint32_t xReceivedLength)
 873 \details
 874 The event \b StreamBufferReceiveFromIsr is generated when Stream Buffer receive is called from the ISR.
 875
 876 \b Value in the Event Recorder shows:
 877  - \b pxStreamBuffer : pointer to Stream Buffer object handle.
 878  - \b xReceivedLength : number of bytes copied from the stream buffer
 879 */
 880
 881 /**
 882 @}
 883 */
 884
 885
 886 /**
 887 \defgroup freertos_evr_heap Heap Functions
 888 \brief Events generated by heap functions
 889 \details
 890 @{
 891 */
 892
 893 /**
 894 \fn void EvrFreeRTOSHeap_Malloc (void *pvAddress, uint32_t uiSize)
 895 \details
 896 The event \b Heap_Malloc is generated when a heap memory block is successfully allocated.
 897
 898 \b Value in the Event Recorder shows:
 899  - \b pvAddress : pointer to allocated memory block.
 900  - \b uiSize : memory block size in bytes.
 901 */
 902
 903 /**
 904 \fn void EvrFreeRTOSHeap_Free (void *pvAddress, uint32_t uiSize)
 905 \details
 906 The event \b Heap_Free is generated when a memory block previously allocated by malloc is deallocated.
 907
 908 \b Value in the Event Recorder shows:
 909  - \b pvAddress : pointer to deallocated memory block.
 910  - \b uiSize : memory block size in bytes.
 911 */
 912
 913 /**
 914 @}
 915 */
 916
 917 /**
 918 @}
 919 */
 920 // end group Event Recorder