begriffs open source - cmsis-freertos/blob - Source/include/FreeRTOS.h

   1 /*
   2  * FreeRTOS Kernel V10.2.1
   3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
   6  * this software and associated documentation files (the "Software"), to deal in
   7  * the Software without restriction, including without limitation the rights to
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
   9  * the Software, and to permit persons to whom the Software is furnished to do so,
  10  * subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in all
  13  * copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * http://www.FreeRTOS.org
  23  * http://aws.amazon.com/freertos
  24  *
  25  * 1 tab == 4 spaces!
  26  */
  27
  28 #ifndef INC_FREERTOS_H
  29 #define INC_FREERTOS_H
  30
  31 /*
  32  * Include the generic headers required for the FreeRTOS port being used.
  33  */
  34 #include <stddef.h>
  35
  36 /*
  37  * If stdint.h cannot be located then:
  38  *   + If using GCC ensure the -nostdint options is *not* being used.
  39  *   + Ensure the project's include path includes the directory in which your
  40  *     compiler stores stdint.h.
  41  *   + Set any compiler options necessary for it to support C99, as technically
  42  *     stdint.h is only mandatory with C99 (FreeRTOS does not require C99 in any
  43  *     other way).
  44  *   + The FreeRTOS download includes a simple stdint.h definition that can be
  45  *     used in cases where none is provided by the compiler.  The files only
  46  *     contains the typedefs required to build FreeRTOS.  Read the instructions
  47  *     in FreeRTOS/source/stdint.readme for more information.
  48  */
  49 #include <stdint.h> /* READ COMMENT ABOVE. */
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 /* Application specific configuration options. */
  56 #include "FreeRTOSConfig.h"
  57
  58 /* Basic FreeRTOS definitions. */
  59 #include "projdefs.h"
  60
  61 /* Definitions specific to the port being used. */
  62 #include "portable.h"
  63
  64 /* Must be defaulted before configUSE_NEWLIB_REENTRANT is used below. */
  65 #ifndef configUSE_NEWLIB_REENTRANT
  66         #define configUSE_NEWLIB_REENTRANT 0
  67 #endif
  68
  69 /* Required if struct _reent is used. */
  70 #if ( configUSE_NEWLIB_REENTRANT == 1 )
  71         #include <reent.h>
  72 #endif
  73 /*
  74  * Check all the required application specific macros have been defined.
  75  * These macros are application specific and (as downloaded) are defined
  76  * within FreeRTOSConfig.h.
  77  */
  78
  79 #ifndef configMINIMAL_STACK_SIZE
  80         #error Missing definition:  configMINIMAL_STACK_SIZE must be defined in FreeRTOSConfig.h.  configMINIMAL_STACK_SIZE defines the size (in words) of the stack allocated to the idle task.  Refer to the demo project provided for your port for a suitable value.
  81 #endif
  82
  83 #ifndef configMAX_PRIORITIES
  84         #error Missing definition:  configMAX_PRIORITIES must be defined in FreeRTOSConfig.h.  See the Configuration section of the FreeRTOS API documentation for details.
  85 #endif
  86
  87 #if configMAX_PRIORITIES < 1
  88         #error configMAX_PRIORITIES must be defined to be greater than or equal to 1.
  89 #endif
  90
  91 #ifndef configUSE_PREEMPTION
  92         #error Missing definition:  configUSE_PREEMPTION must be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.
  93 #endif
  94
  95 #ifndef configUSE_IDLE_HOOK
  96         #error Missing definition:  configUSE_IDLE_HOOK must be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.
  97 #endif
  98
  99 #ifndef configUSE_TICK_HOOK
 100         #error Missing definition:  configUSE_TICK_HOOK must be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.
 101 #endif
 102
 103 #ifndef configUSE_16_BIT_TICKS
 104         #error Missing definition:  configUSE_16_BIT_TICKS must be defined in FreeRTOSConfig.h as either 1 or 0.  See the Configuration section of the FreeRTOS API documentation for details.
 105 #endif
 106
 107 #ifndef configUSE_CO_ROUTINES
 108         #define configUSE_CO_ROUTINES 0
 109 #endif
 110
 111 #ifndef INCLUDE_vTaskPrioritySet
 112         #define INCLUDE_vTaskPrioritySet 0
 113 #endif
 114
 115 #ifndef INCLUDE_uxTaskPriorityGet
 116         #define INCLUDE_uxTaskPriorityGet 0
 117 #endif
 118
 119 #ifndef INCLUDE_vTaskDelete
 120         #define INCLUDE_vTaskDelete 0
 121 #endif
 122
 123 #ifndef INCLUDE_vTaskSuspend
 124         #define INCLUDE_vTaskSuspend 0
 125 #endif
 126
 127 #ifndef INCLUDE_vTaskDelayUntil
 128         #define INCLUDE_vTaskDelayUntil 0
 129 #endif
 130
 131 #ifndef INCLUDE_vTaskDelay
 132         #define INCLUDE_vTaskDelay 0
 133 #endif
 134
 135 #ifndef INCLUDE_xTaskGetIdleTaskHandle
 136         #define INCLUDE_xTaskGetIdleTaskHandle 0
 137 #endif
 138
 139 #ifndef INCLUDE_xTaskAbortDelay
 140         #define INCLUDE_xTaskAbortDelay 0
 141 #endif
 142
 143 #ifndef INCLUDE_xQueueGetMutexHolder
 144         #define INCLUDE_xQueueGetMutexHolder 0
 145 #endif
 146
 147 #ifndef INCLUDE_xSemaphoreGetMutexHolder
 148         #define INCLUDE_xSemaphoreGetMutexHolder INCLUDE_xQueueGetMutexHolder
 149 #endif
 150
 151 #ifndef INCLUDE_xTaskGetHandle
 152         #define INCLUDE_xTaskGetHandle 0
 153 #endif
 154
 155 #ifndef INCLUDE_uxTaskGetStackHighWaterMark
 156         #define INCLUDE_uxTaskGetStackHighWaterMark 0
 157 #endif
 158
 159 #ifndef INCLUDE_uxTaskGetStackHighWaterMark2
 160         #define INCLUDE_uxTaskGetStackHighWaterMark2 0
 161 #endif
 162
 163 #ifndef INCLUDE_eTaskGetState
 164         #define INCLUDE_eTaskGetState 0
 165 #endif
 166
 167 #ifndef INCLUDE_xTaskResumeFromISR
 168         #define INCLUDE_xTaskResumeFromISR 1
 169 #endif
 170
 171 #ifndef INCLUDE_xTimerPendFunctionCall
 172         #define INCLUDE_xTimerPendFunctionCall 0
 173 #endif
 174
 175 #ifndef INCLUDE_xTaskGetSchedulerState
 176         #define INCLUDE_xTaskGetSchedulerState 0
 177 #endif
 178
 179 #ifndef INCLUDE_xTaskGetCurrentTaskHandle
 180         #define INCLUDE_xTaskGetCurrentTaskHandle 0
 181 #endif
 182
 183 #if configUSE_CO_ROUTINES != 0
 184         #ifndef configMAX_CO_ROUTINE_PRIORITIES
 185                 #error configMAX_CO_ROUTINE_PRIORITIES must be greater than or equal to 1.
 186         #endif
 187 #endif
 188
 189 #ifndef configUSE_DAEMON_TASK_STARTUP_HOOK
 190         #define configUSE_DAEMON_TASK_STARTUP_HOOK 0
 191 #endif
 192
 193 #ifndef configUSE_APPLICATION_TASK_TAG
 194         #define configUSE_APPLICATION_TASK_TAG 0
 195 #endif
 196
 197 #ifndef configNUM_THREAD_LOCAL_STORAGE_POINTERS
 198         #define configNUM_THREAD_LOCAL_STORAGE_POINTERS 0
 199 #endif
 200
 201 #ifndef configUSE_RECURSIVE_MUTEXES
 202         #define configUSE_RECURSIVE_MUTEXES 0
 203 #endif
 204
 205 #ifndef configUSE_MUTEXES
 206         #define configUSE_MUTEXES 0
 207 #endif
 208
 209 #ifndef configUSE_TIMERS
 210         #define configUSE_TIMERS 0
 211 #endif
 212
 213 #ifndef configUSE_COUNTING_SEMAPHORES
 214         #define configUSE_COUNTING_SEMAPHORES 0
 215 #endif
 216
 217 #ifndef configUSE_ALTERNATIVE_API
 218         #define configUSE_ALTERNATIVE_API 0
 219 #endif
 220
 221 #ifndef portCRITICAL_NESTING_IN_TCB
 222         #define portCRITICAL_NESTING_IN_TCB 0
 223 #endif
 224
 225 #ifndef configMAX_TASK_NAME_LEN
 226         #define configMAX_TASK_NAME_LEN 16
 227 #endif
 228
 229 #ifndef configIDLE_SHOULD_YIELD
 230         #define configIDLE_SHOULD_YIELD         1
 231 #endif
 232
 233 #if configMAX_TASK_NAME_LEN < 1
 234         #error configMAX_TASK_NAME_LEN must be set to a minimum of 1 in FreeRTOSConfig.h
 235 #endif
 236
 237 #ifndef configASSERT
 238         #define configASSERT( x )
 239         #define configASSERT_DEFINED 0
 240 #else
 241         #define configASSERT_DEFINED 1
 242 #endif
 243
 244 #ifndef portMEMORY_BARRIER
 245         #define portMEMORY_BARRIER()
 246 #endif
 247
 248 /* The timers module relies on xTaskGetSchedulerState(). */
 249 #if configUSE_TIMERS == 1
 250
 251         #ifndef configTIMER_TASK_PRIORITY
 252                 #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_PRIORITY must also be defined.
 253         #endif /* configTIMER_TASK_PRIORITY */
 254
 255         #ifndef configTIMER_QUEUE_LENGTH
 256                 #error If configUSE_TIMERS is set to 1 then configTIMER_QUEUE_LENGTH must also be defined.
 257         #endif /* configTIMER_QUEUE_LENGTH */
 258
 259         #ifndef configTIMER_TASK_STACK_DEPTH
 260                 #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_STACK_DEPTH must also be defined.
 261         #endif /* configTIMER_TASK_STACK_DEPTH */
 262
 263 #endif /* configUSE_TIMERS */
 264
 265 #ifndef portSET_INTERRUPT_MASK_FROM_ISR
 266         #define portSET_INTERRUPT_MASK_FROM_ISR() 0
 267 #endif
 268
 269 #ifndef portCLEAR_INTERRUPT_MASK_FROM_ISR
 270         #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusValue ) ( void ) uxSavedStatusValue
 271 #endif
 272
 273 #ifndef portCLEAN_UP_TCB
 274         #define portCLEAN_UP_TCB( pxTCB ) ( void ) pxTCB
 275 #endif
 276
 277 #ifndef portPRE_TASK_DELETE_HOOK
 278         #define portPRE_TASK_DELETE_HOOK( pvTaskToDelete, pxYieldPending )
 279 #endif
 280
 281 #ifndef portSETUP_TCB
 282         #define portSETUP_TCB( pxTCB ) ( void ) pxTCB
 283 #endif
 284
 285 #ifndef configQUEUE_REGISTRY_SIZE
 286         #define configQUEUE_REGISTRY_SIZE 0U
 287 #endif
 288
 289 #if ( configQUEUE_REGISTRY_SIZE < 1 )
 290         #define vQueueAddToRegistry( xQueue, pcName )
 291         #define vQueueUnregisterQueue( xQueue )
 292         #define pcQueueGetName( xQueue )
 293 #endif
 294
 295 #ifndef portPOINTER_SIZE_TYPE
 296         #define portPOINTER_SIZE_TYPE uint32_t
 297 #endif
 298
 299 /* Remove any unused trace macros. */
 300 #ifndef traceSTART
 301         /* Used to perform any necessary initialisation - for example, open a file
 302         into which trace is to be written. */
 303         #define traceSTART()
 304 #endif
 305
 306 #ifndef traceEND
 307         /* Use to close a trace, for example close a file into which trace has been
 308         written. */
 309         #define traceEND()
 310 #endif
 311
 312 #ifndef traceTASK_SWITCHED_IN
 313         /* Called after a task has been selected to run.  pxCurrentTCB holds a pointer
 314         to the task control block of the selected task. */
 315         #define traceTASK_SWITCHED_IN()
 316 #endif
 317
 318 #ifndef traceINCREASE_TICK_COUNT
 319         /* Called before stepping the tick count after waking from tickless idle
 320         sleep. */
 321         #define traceINCREASE_TICK_COUNT( x )
 322 #endif
 323
 324 #ifndef traceLOW_POWER_IDLE_BEGIN
 325         /* Called immediately before entering tickless idle. */
 326         #define traceLOW_POWER_IDLE_BEGIN()
 327 #endif
 328
 329 #ifndef traceLOW_POWER_IDLE_END
 330         /* Called when returning to the Idle task after a tickless idle. */
 331         #define traceLOW_POWER_IDLE_END()
 332 #endif
 333
 334 #ifndef traceTASK_SWITCHED_OUT
 335         /* Called before a task has been selected to run.  pxCurrentTCB holds a pointer
 336         to the task control block of the task being switched out. */
 337         #define traceTASK_SWITCHED_OUT()
 338 #endif
 339
 340 #ifndef traceTASK_PRIORITY_INHERIT
 341         /* Called when a task attempts to take a mutex that is already held by a
 342         lower priority task.  pxTCBOfMutexHolder is a pointer to the TCB of the task
 343         that holds the mutex.  uxInheritedPriority is the priority the mutex holder
 344         will inherit (the priority of the task that is attempting to obtain the
 345         muted. */
 346         #define traceTASK_PRIORITY_INHERIT( pxTCBOfMutexHolder, uxInheritedPriority )
 347 #endif
 348
 349 #ifndef traceTASK_PRIORITY_DISINHERIT
 350         /* Called when a task releases a mutex, the holding of which had resulted in
 351         the task inheriting the priority of a higher priority task.
 352         pxTCBOfMutexHolder is a pointer to the TCB of the task that is releasing the
 353         mutex.  uxOriginalPriority is the task's configured (base) priority. */
 354         #define traceTASK_PRIORITY_DISINHERIT( pxTCBOfMutexHolder, uxOriginalPriority )
 355 #endif
 356
 357 #ifndef traceBLOCKING_ON_QUEUE_RECEIVE
 358         /* Task is about to block because it cannot read from a
 359         queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore
 360         upon which the read was attempted.  pxCurrentTCB points to the TCB of the
 361         task that attempted the read. */
 362         #define traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue )
 363 #endif
 364
 365 #ifndef traceBLOCKING_ON_QUEUE_PEEK
 366         /* Task is about to block because it cannot read from a
 367         queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore
 368         upon which the read was attempted.  pxCurrentTCB points to the TCB of the
 369         task that attempted the read. */
 370         #define traceBLOCKING_ON_QUEUE_PEEK( pxQueue )
 371 #endif
 372
 373 #ifndef traceBLOCKING_ON_QUEUE_SEND
 374         /* Task is about to block because it cannot write to a
 375         queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore
 376         upon which the write was attempted.  pxCurrentTCB points to the TCB of the
 377         task that attempted the write. */
 378         #define traceBLOCKING_ON_QUEUE_SEND( pxQueue )
 379 #endif
 380
 381 #ifndef configCHECK_FOR_STACK_OVERFLOW
 382         #define configCHECK_FOR_STACK_OVERFLOW 0
 383 #endif
 384
 385 #ifndef configRECORD_STACK_HIGH_ADDRESS
 386         #define configRECORD_STACK_HIGH_ADDRESS 0
 387 #endif
 388
 389 #ifndef configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H
 390         #define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H 0
 391 #endif
 392
 393 /* The following event macros are embedded in the kernel API calls. */
 394
 395 #ifndef traceMOVED_TASK_TO_READY_STATE
 396         #define traceMOVED_TASK_TO_READY_STATE( pxTCB )
 397 #endif
 398
 399 #ifndef tracePOST_MOVED_TASK_TO_READY_STATE
 400         #define tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )
 401 #endif
 402
 403 #ifndef traceQUEUE_CREATE
 404         #define traceQUEUE_CREATE( pxNewQueue )
 405 #endif
 406
 407 #ifndef traceQUEUE_CREATE_FAILED
 408         #define traceQUEUE_CREATE_FAILED( ucQueueType )
 409 #endif
 410
 411 #ifndef traceCREATE_MUTEX
 412         #define traceCREATE_MUTEX( pxNewQueue )
 413 #endif
 414
 415 #ifndef traceCREATE_MUTEX_FAILED
 416         #define traceCREATE_MUTEX_FAILED()
 417 #endif
 418
 419 #ifndef traceGIVE_MUTEX_RECURSIVE
 420         #define traceGIVE_MUTEX_RECURSIVE( pxMutex )
 421 #endif
 422
 423 #ifndef traceGIVE_MUTEX_RECURSIVE_FAILED
 424         #define traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex )
 425 #endif
 426
 427 #ifndef traceTAKE_MUTEX_RECURSIVE
 428         #define traceTAKE_MUTEX_RECURSIVE( pxMutex )
 429 #endif
 430
 431 #ifndef traceTAKE_MUTEX_RECURSIVE_FAILED
 432         #define traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex )
 433 #endif
 434
 435 #ifndef traceCREATE_COUNTING_SEMAPHORE
 436         #define traceCREATE_COUNTING_SEMAPHORE()
 437 #endif
 438
 439 #ifndef traceCREATE_COUNTING_SEMAPHORE_FAILED
 440         #define traceCREATE_COUNTING_SEMAPHORE_FAILED()
 441 #endif
 442
 443 #ifndef traceQUEUE_SEND
 444         #define traceQUEUE_SEND( pxQueue )
 445 #endif
 446
 447 #ifndef traceQUEUE_SEND_FAILED
 448         #define traceQUEUE_SEND_FAILED( pxQueue )
 449 #endif
 450
 451 #ifndef traceQUEUE_RECEIVE
 452         #define traceQUEUE_RECEIVE( pxQueue )
 453 #endif
 454
 455 #ifndef traceQUEUE_PEEK
 456         #define traceQUEUE_PEEK( pxQueue )
 457 #endif
 458
 459 #ifndef traceQUEUE_PEEK_FAILED
 460         #define traceQUEUE_PEEK_FAILED( pxQueue )
 461 #endif
 462
 463 #ifndef traceQUEUE_PEEK_FROM_ISR
 464         #define traceQUEUE_PEEK_FROM_ISR( pxQueue )
 465 #endif
 466
 467 #ifndef traceQUEUE_RECEIVE_FAILED
 468         #define traceQUEUE_RECEIVE_FAILED( pxQueue )
 469 #endif
 470
 471 #ifndef traceQUEUE_SEND_FROM_ISR
 472         #define traceQUEUE_SEND_FROM_ISR( pxQueue )
 473 #endif
 474
 475 #ifndef traceQUEUE_SEND_FROM_ISR_FAILED
 476         #define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue )
 477 #endif
 478
 479 #ifndef traceQUEUE_RECEIVE_FROM_ISR
 480         #define traceQUEUE_RECEIVE_FROM_ISR( pxQueue )
 481 #endif
 482
 483 #ifndef traceQUEUE_RECEIVE_FROM_ISR_FAILED
 484         #define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue )
 485 #endif
 486
 487 #ifndef traceQUEUE_PEEK_FROM_ISR_FAILED
 488         #define traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue )
 489 #endif
 490
 491 #ifndef traceQUEUE_DELETE
 492         #define traceQUEUE_DELETE( pxQueue )
 493 #endif
 494
 495 #ifndef traceTASK_CREATE
 496         #define traceTASK_CREATE( pxNewTCB )
 497 #endif
 498
 499 #ifndef traceTASK_CREATE_FAILED
 500         #define traceTASK_CREATE_FAILED()
 501 #endif
 502
 503 #ifndef traceTASK_DELETE
 504         #define traceTASK_DELETE( pxTaskToDelete )
 505 #endif
 506
 507 #ifndef traceTASK_DELAY_UNTIL
 508         #define traceTASK_DELAY_UNTIL( x )
 509 #endif
 510
 511 #ifndef traceTASK_DELAY
 512         #define traceTASK_DELAY()
 513 #endif
 514
 515 #ifndef traceTASK_PRIORITY_SET
 516         #define traceTASK_PRIORITY_SET( pxTask, uxNewPriority )
 517 #endif
 518
 519 #ifndef traceTASK_SUSPEND
 520         #define traceTASK_SUSPEND( pxTaskToSuspend )
 521 #endif
 522
 523 #ifndef traceTASK_RESUME
 524         #define traceTASK_RESUME( pxTaskToResume )
 525 #endif
 526
 527 #ifndef traceTASK_RESUME_FROM_ISR
 528         #define traceTASK_RESUME_FROM_ISR( pxTaskToResume )
 529 #endif
 530
 531 #ifndef traceTASK_INCREMENT_TICK
 532         #define traceTASK_INCREMENT_TICK( xTickCount )
 533 #endif
 534
 535 #ifndef traceTIMER_CREATE
 536         #define traceTIMER_CREATE( pxNewTimer )
 537 #endif
 538
 539 #ifndef traceTIMER_CREATE_FAILED
 540         #define traceTIMER_CREATE_FAILED()
 541 #endif
 542
 543 #ifndef traceTIMER_COMMAND_SEND
 544         #define traceTIMER_COMMAND_SEND( xTimer, xMessageID, xMessageValueValue, xReturn )
 545 #endif
 546
 547 #ifndef traceTIMER_EXPIRED
 548         #define traceTIMER_EXPIRED( pxTimer )
 549 #endif
 550
 551 #ifndef traceTIMER_COMMAND_RECEIVED
 552         #define traceTIMER_COMMAND_RECEIVED( pxTimer, xMessageID, xMessageValue )
 553 #endif
 554
 555 #ifndef traceMALLOC
 556     #define traceMALLOC( pvAddress, uiSize )
 557 #endif
 558
 559 #ifndef traceFREE
 560     #define traceFREE( pvAddress, uiSize )
 561 #endif
 562
 563 #ifndef traceEVENT_GROUP_CREATE
 564         #define traceEVENT_GROUP_CREATE( xEventGroup )
 565 #endif
 566
 567 #ifndef traceEVENT_GROUP_CREATE_FAILED
 568         #define traceEVENT_GROUP_CREATE_FAILED()
 569 #endif
 570
 571 #ifndef traceEVENT_GROUP_SYNC_BLOCK
 572         #define traceEVENT_GROUP_SYNC_BLOCK( xEventGroup, uxBitsToSet, uxBitsToWaitFor )
 573 #endif
 574
 575 #ifndef traceEVENT_GROUP_SYNC_END
 576         #define traceEVENT_GROUP_SYNC_END( xEventGroup, uxBitsToSet, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred
 577 #endif
 578
 579 #ifndef traceEVENT_GROUP_WAIT_BITS_BLOCK
 580         #define traceEVENT_GROUP_WAIT_BITS_BLOCK( xEventGroup, uxBitsToWaitFor )
 581 #endif
 582
 583 #ifndef traceEVENT_GROUP_WAIT_BITS_END
 584         #define traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred
 585 #endif
 586
 587 #ifndef traceEVENT_GROUP_CLEAR_BITS
 588         #define traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear )
 589 #endif
 590
 591 #ifndef traceEVENT_GROUP_CLEAR_BITS_FROM_ISR
 592         #define traceEVENT_GROUP_CLEAR_BITS_FROM_ISR( xEventGroup, uxBitsToClear )
 593 #endif
 594
 595 #ifndef traceEVENT_GROUP_SET_BITS
 596         #define traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet )
 597 #endif
 598
 599 #ifndef traceEVENT_GROUP_SET_BITS_FROM_ISR
 600         #define traceEVENT_GROUP_SET_BITS_FROM_ISR( xEventGroup, uxBitsToSet )
 601 #endif
 602
 603 #ifndef traceEVENT_GROUP_DELETE
 604         #define traceEVENT_GROUP_DELETE( xEventGroup )
 605 #endif
 606
 607 #ifndef tracePEND_FUNC_CALL
 608         #define tracePEND_FUNC_CALL(xFunctionToPend, pvParameter1, ulParameter2, ret)
 609 #endif
 610
 611 #ifndef tracePEND_FUNC_CALL_FROM_ISR
 612         #define tracePEND_FUNC_CALL_FROM_ISR(xFunctionToPend, pvParameter1, ulParameter2, ret)
 613 #endif
 614
 615 #ifndef traceQUEUE_REGISTRY_ADD
 616         #define traceQUEUE_REGISTRY_ADD(xQueue, pcQueueName)
 617 #endif
 618
 619 #ifndef traceTASK_NOTIFY_TAKE_BLOCK
 620         #define traceTASK_NOTIFY_TAKE_BLOCK()
 621 #endif
 622
 623 #ifndef traceTASK_NOTIFY_TAKE
 624         #define traceTASK_NOTIFY_TAKE()
 625 #endif
 626
 627 #ifndef traceTASK_NOTIFY_WAIT_BLOCK
 628         #define traceTASK_NOTIFY_WAIT_BLOCK()
 629 #endif
 630
 631 #ifndef traceTASK_NOTIFY_WAIT
 632         #define traceTASK_NOTIFY_WAIT()
 633 #endif
 634
 635 #ifndef traceTASK_NOTIFY
 636         #define traceTASK_NOTIFY()
 637 #endif
 638
 639 #ifndef traceTASK_NOTIFY_FROM_ISR
 640         #define traceTASK_NOTIFY_FROM_ISR()
 641 #endif
 642
 643 #ifndef traceTASK_NOTIFY_GIVE_FROM_ISR
 644         #define traceTASK_NOTIFY_GIVE_FROM_ISR()
 645 #endif
 646
 647 #ifndef traceSTREAM_BUFFER_CREATE_FAILED
 648         #define traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer )
 649 #endif
 650
 651 #ifndef traceSTREAM_BUFFER_CREATE_STATIC_FAILED
 652         #define traceSTREAM_BUFFER_CREATE_STATIC_FAILED( xReturn, xIsMessageBuffer )
 653 #endif
 654
 655 #ifndef traceSTREAM_BUFFER_CREATE
 656         #define traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer )
 657 #endif
 658
 659 #ifndef traceSTREAM_BUFFER_DELETE
 660         #define traceSTREAM_BUFFER_DELETE( xStreamBuffer )
 661 #endif
 662
 663 #ifndef traceSTREAM_BUFFER_RESET
 664         #define traceSTREAM_BUFFER_RESET( xStreamBuffer )
 665 #endif
 666
 667 #ifndef traceBLOCKING_ON_STREAM_BUFFER_SEND
 668         #define traceBLOCKING_ON_STREAM_BUFFER_SEND( xStreamBuffer )
 669 #endif
 670
 671 #ifndef traceSTREAM_BUFFER_SEND
 672         #define traceSTREAM_BUFFER_SEND( xStreamBuffer, xBytesSent )
 673 #endif
 674
 675 #ifndef traceSTREAM_BUFFER_SEND_FAILED
 676         #define traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer )
 677 #endif
 678
 679 #ifndef traceSTREAM_BUFFER_SEND_FROM_ISR
 680         #define traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xBytesSent )
 681 #endif
 682
 683 #ifndef traceBLOCKING_ON_STREAM_BUFFER_RECEIVE
 684         #define traceBLOCKING_ON_STREAM_BUFFER_RECEIVE( xStreamBuffer )
 685 #endif
 686
 687 #ifndef traceSTREAM_BUFFER_RECEIVE
 688         #define traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength )
 689 #endif
 690
 691 #ifndef traceSTREAM_BUFFER_RECEIVE_FAILED
 692         #define traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer )
 693 #endif
 694
 695 #ifndef traceSTREAM_BUFFER_RECEIVE_FROM_ISR
 696         #define traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength )
 697 #endif
 698
 699 #ifndef configGENERATE_RUN_TIME_STATS
 700         #define configGENERATE_RUN_TIME_STATS 0
 701 #endif
 702
 703 #if ( configGENERATE_RUN_TIME_STATS == 1 )
 704
 705         #ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS
 706                 #error If configGENERATE_RUN_TIME_STATS is defined then portCONFIGURE_TIMER_FOR_RUN_TIME_STATS must also be defined.  portCONFIGURE_TIMER_FOR_RUN_TIME_STATS should call a port layer function to setup a peripheral timer/counter that can then be used as the run time counter time base.
 707         #endif /* portCONFIGURE_TIMER_FOR_RUN_TIME_STATS */
 708
 709         #ifndef portGET_RUN_TIME_COUNTER_VALUE
 710                 #ifndef portALT_GET_RUN_TIME_COUNTER_VALUE
 711                         #error If configGENERATE_RUN_TIME_STATS is defined then either portGET_RUN_TIME_COUNTER_VALUE or portALT_GET_RUN_TIME_COUNTER_VALUE must also be defined.  See the examples provided and the FreeRTOS web site for more information.
 712                 #endif /* portALT_GET_RUN_TIME_COUNTER_VALUE */
 713         #endif /* portGET_RUN_TIME_COUNTER_VALUE */
 714
 715 #endif /* configGENERATE_RUN_TIME_STATS */
 716
 717 #ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS
 718         #define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS()
 719 #endif
 720
 721 #ifndef configUSE_MALLOC_FAILED_HOOK
 722         #define configUSE_MALLOC_FAILED_HOOK 0
 723 #endif
 724
 725 #ifndef portPRIVILEGE_BIT
 726         #define portPRIVILEGE_BIT ( ( UBaseType_t ) 0x00 )
 727 #endif
 728
 729 #ifndef portYIELD_WITHIN_API
 730         #define portYIELD_WITHIN_API portYIELD
 731 #endif
 732
 733 #ifndef portSUPPRESS_TICKS_AND_SLEEP
 734         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )
 735 #endif
 736
 737 #ifndef configEXPECTED_IDLE_TIME_BEFORE_SLEEP
 738         #define configEXPECTED_IDLE_TIME_BEFORE_SLEEP 2
 739 #endif
 740
 741 #if configEXPECTED_IDLE_TIME_BEFORE_SLEEP < 2
 742         #error configEXPECTED_IDLE_TIME_BEFORE_SLEEP must not be less than 2
 743 #endif
 744
 745 #ifndef configUSE_TICKLESS_IDLE
 746         #define configUSE_TICKLESS_IDLE 0
 747 #endif
 748
 749 #ifndef configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING
 750         #define configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( x )
 751 #endif
 752
 753 #ifndef configPRE_SLEEP_PROCESSING
 754         #define configPRE_SLEEP_PROCESSING( x )
 755 #endif
 756
 757 #ifndef configPOST_SLEEP_PROCESSING
 758         #define configPOST_SLEEP_PROCESSING( x )
 759 #endif
 760
 761 #ifndef configUSE_QUEUE_SETS
 762         #define configUSE_QUEUE_SETS 0
 763 #endif
 764
 765 #ifndef portTASK_USES_FLOATING_POINT
 766         #define portTASK_USES_FLOATING_POINT()
 767 #endif
 768
 769 #ifndef portALLOCATE_SECURE_CONTEXT
 770         #define portALLOCATE_SECURE_CONTEXT( ulSecureStackSize )
 771 #endif
 772
 773 #ifndef portDONT_DISCARD
 774         #define portDONT_DISCARD
 775 #endif
 776
 777 #ifndef configUSE_TIME_SLICING
 778         #define configUSE_TIME_SLICING 1
 779 #endif
 780
 781 #ifndef configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS
 782         #define configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 0
 783 #endif
 784
 785 #ifndef configUSE_STATS_FORMATTING_FUNCTIONS
 786         #define configUSE_STATS_FORMATTING_FUNCTIONS 0
 787 #endif
 788
 789 #ifndef portASSERT_IF_INTERRUPT_PRIORITY_INVALID
 790         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()
 791 #endif
 792
 793 #ifndef configUSE_TRACE_FACILITY
 794         #define configUSE_TRACE_FACILITY 0
 795 #endif
 796
 797 #ifndef mtCOVERAGE_TEST_MARKER
 798         #define mtCOVERAGE_TEST_MARKER()
 799 #endif
 800
 801 #ifndef mtCOVERAGE_TEST_DELAY
 802         #define mtCOVERAGE_TEST_DELAY()
 803 #endif
 804
 805 #ifndef portASSERT_IF_IN_ISR
 806         #define portASSERT_IF_IN_ISR()
 807 #endif
 808
 809 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
 810         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
 811 #endif
 812
 813 #ifndef configAPPLICATION_ALLOCATED_HEAP
 814         #define configAPPLICATION_ALLOCATED_HEAP 0
 815 #endif
 816
 817 #ifndef configUSE_TASK_NOTIFICATIONS
 818         #define configUSE_TASK_NOTIFICATIONS 1
 819 #endif
 820
 821 #ifndef configUSE_POSIX_ERRNO
 822         #define configUSE_POSIX_ERRNO 0
 823 #endif
 824
 825 #ifndef portTICK_TYPE_IS_ATOMIC
 826         #define portTICK_TYPE_IS_ATOMIC 0
 827 #endif
 828
 829 #ifndef configSUPPORT_STATIC_ALLOCATION
 830         /* Defaults to 0 for backward compatibility. */
 831         #define configSUPPORT_STATIC_ALLOCATION 0
 832 #endif
 833
 834 #ifndef configSUPPORT_DYNAMIC_ALLOCATION
 835         /* Defaults to 1 for backward compatibility. */
 836         #define configSUPPORT_DYNAMIC_ALLOCATION 1
 837 #endif
 838
 839 #ifndef configSTACK_DEPTH_TYPE
 840         /* Defaults to uint16_t for backward compatibility, but can be overridden
 841         in FreeRTOSConfig.h if uint16_t is too restrictive. */
 842         #define configSTACK_DEPTH_TYPE uint16_t
 843 #endif
 844
 845 #ifndef configMESSAGE_BUFFER_LENGTH_TYPE
 846         /* Defaults to size_t for backward compatibility, but can be overridden
 847         in FreeRTOSConfig.h if lengths will always be less than the number of bytes
 848         in a size_t. */
 849         #define configMESSAGE_BUFFER_LENGTH_TYPE size_t
 850 #endif
 851
 852 /* Sanity check the configuration. */
 853 #if( configUSE_TICKLESS_IDLE != 0 )
 854         #if( INCLUDE_vTaskSuspend != 1 )
 855                 #error INCLUDE_vTaskSuspend must be set to 1 if configUSE_TICKLESS_IDLE is not set to 0
 856         #endif /* INCLUDE_vTaskSuspend */
 857 #endif /* configUSE_TICKLESS_IDLE */
 858
 859 #if( ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 0 ) )
 860         #error configSUPPORT_STATIC_ALLOCATION and configSUPPORT_DYNAMIC_ALLOCATION cannot both be 0, but can both be 1.
 861 #endif
 862
 863 #if( ( configUSE_RECURSIVE_MUTEXES == 1 ) && ( configUSE_MUTEXES != 1 ) )
 864         #error configUSE_MUTEXES must be set to 1 to use recursive mutexes
 865 #endif
 866
 867 #ifndef configINITIAL_TICK_COUNT
 868         #define configINITIAL_TICK_COUNT 0
 869 #endif
 870
 871 #if( portTICK_TYPE_IS_ATOMIC == 0 )
 872         /* Either variables of tick type cannot be read atomically, or
 873         portTICK_TYPE_IS_ATOMIC was not set - map the critical sections used when
 874         the tick count is returned to the standard critical section macros. */
 875         #define portTICK_TYPE_ENTER_CRITICAL() portENTER_CRITICAL()
 876         #define portTICK_TYPE_EXIT_CRITICAL() portEXIT_CRITICAL()
 877         #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() portSET_INTERRUPT_MASK_FROM_ISR()
 878         #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) portCLEAR_INTERRUPT_MASK_FROM_ISR( ( x ) )
 879 #else
 880         /* The tick type can be read atomically, so critical sections used when the
 881         tick count is returned can be defined away. */
 882         #define portTICK_TYPE_ENTER_CRITICAL()
 883         #define portTICK_TYPE_EXIT_CRITICAL()
 884         #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() 0
 885         #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) ( void ) x
 886 #endif
 887
 888 /* Definitions to allow backward compatibility with FreeRTOS versions prior to
 889 V8 if desired. */
 890 #ifndef configENABLE_BACKWARD_COMPATIBILITY
 891         #define configENABLE_BACKWARD_COMPATIBILITY 1
 892 #endif
 893
 894 #ifndef configPRINTF
 895         /* configPRINTF() was not defined, so define it away to nothing.  To use
 896         configPRINTF() then define it as follows (where MyPrintFunction() is
 897         provided by the application writer):
 898
 899         void MyPrintFunction(const char *pcFormat, ... );
 900         #define configPRINTF( X )   MyPrintFunction X
 901
 902         Then call like a standard printf() function, but placing brackets around
 903         all parameters so they are passed as a single parameter.  For example:
 904         configPRINTF( ("Value = %d", MyVariable) ); */
 905         #define configPRINTF( X )
 906 #endif
 907
 908 #ifndef configMAX
 909         /* The application writer has not provided their own MAX macro, so define
 910         the following generic implementation. */
 911         #define configMAX( a, b ) ( ( ( a ) > ( b ) ) ? ( a ) : ( b ) )
 912 #endif
 913
 914 #ifndef configMIN
 915         /* The application writer has not provided their own MAX macro, so define
 916         the following generic implementation. */
 917         #define configMIN( a, b ) ( ( ( a ) < ( b ) ) ? ( a ) : ( b ) )
 918 #endif
 919
 920 #if configENABLE_BACKWARD_COMPATIBILITY == 1
 921         #define eTaskStateGet eTaskGetState
 922         #define portTickType TickType_t
 923         #define xTaskHandle TaskHandle_t
 924         #define xQueueHandle QueueHandle_t
 925         #define xSemaphoreHandle SemaphoreHandle_t
 926         #define xQueueSetHandle QueueSetHandle_t
 927         #define xQueueSetMemberHandle QueueSetMemberHandle_t
 928         #define xTimeOutType TimeOut_t
 929         #define xMemoryRegion MemoryRegion_t
 930         #define xTaskParameters TaskParameters_t
 931         #define xTaskStatusType TaskStatus_t
 932         #define xTimerHandle TimerHandle_t
 933         #define xCoRoutineHandle CoRoutineHandle_t
 934         #define pdTASK_HOOK_CODE TaskHookFunction_t
 935         #define portTICK_RATE_MS portTICK_PERIOD_MS
 936         #define pcTaskGetTaskName pcTaskGetName
 937         #define pcTimerGetTimerName pcTimerGetName
 938         #define pcQueueGetQueueName pcQueueGetName
 939         #define vTaskGetTaskInfo vTaskGetInfo
 940
 941         /* Backward compatibility within the scheduler code only - these definitions
 942         are not really required but are included for completeness. */
 943         #define tmrTIMER_CALLBACK TimerCallbackFunction_t
 944         #define pdTASK_CODE TaskFunction_t
 945         #define xListItem ListItem_t
 946         #define xList List_t
 947
 948         /* For libraries that break the list data hiding, and access list structure
 949         members directly (which is not supposed to be done). */
 950         #define pxContainer pvContainer
 951 #endif /* configENABLE_BACKWARD_COMPATIBILITY */
 952
 953 #if( configUSE_ALTERNATIVE_API != 0 )
 954         #error The alternative API was deprecated some time ago, and was removed in FreeRTOS V9.0 0
 955 #endif
 956
 957 /* Set configUSE_TASK_FPU_SUPPORT to 0 to omit floating point support even
 958 if floating point hardware is otherwise supported by the FreeRTOS port in use.
 959 This constant is not supported by all FreeRTOS ports that include floating
 960 point support. */
 961 #ifndef configUSE_TASK_FPU_SUPPORT
 962         #define configUSE_TASK_FPU_SUPPORT 1
 963 #endif
 964
 965 /* Set configENABLE_MPU to 1 to enable MPU support and 0 to disable it. This is
 966 currently used in ARMv8M ports. */
 967 #ifndef configENABLE_MPU
 968         #define configENABLE_MPU 0
 969 #endif
 970
 971 /* Set configENABLE_FPU to 1 to enable FPU support and 0 to disable it. This is
 972 currently used in ARMv8M ports. */
 973 #ifndef configENABLE_FPU
 974         #define configENABLE_FPU 1
 975 #endif
 976
 977 /* Set configENABLE_TRUSTZONE to 1 enable TrustZone support and 0 to disable it.
 978 This is currently used in ARMv8M ports. */
 979 #ifndef configENABLE_TRUSTZONE
 980         #define configENABLE_TRUSTZONE 1
 981 #endif
 982
 983 /* Set configRUN_FREERTOS_SECURE_ONLY to 1 to run the FreeRTOS ARMv8M port on
 984 the Secure Side only. */
 985 #ifndef configRUN_FREERTOS_SECURE_ONLY
 986         #define configRUN_FREERTOS_SECURE_ONLY 0
 987 #endif
 988
 989 /* Sometimes the FreeRTOSConfig.h settings only allow a task to be created using
 990  * dynamically allocated RAM, in which case when any task is deleted it is known
 991  * that both the task's stack and TCB need to be freed.  Sometimes the
 992  * FreeRTOSConfig.h settings only allow a task to be created using statically
 993  * allocated RAM, in which case when any task is deleted it is known that neither
 994  * the task's stack or TCB should be freed.  Sometimes the FreeRTOSConfig.h
 995  * settings allow a task to be created using either statically or dynamically
 996  * allocated RAM, in which case a member of the TCB is used to record whether the
 997  * stack and/or TCB were allocated statically or dynamically, so when a task is
 998  * deleted the RAM that was allocated dynamically is freed again and no attempt is
 999  * made to free the RAM that was allocated statically.
1000  * tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is only true if it is possible for a
1001  * task to be created using either statically or dynamically allocated RAM.  Note
1002  * that if portUSING_MPU_WRAPPERS is 1 then a protected task can be created with
1003  * a statically allocated stack and a dynamically allocated TCB.
1004  *
1005  * The following table lists various combinations of portUSING_MPU_WRAPPERS,
1006  * configSUPPORT_DYNAMIC_ALLOCATION and configSUPPORT_STATIC_ALLOCATION and
1007  * when it is possible to have both static and dynamic allocation:
1008  *  +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+
1009  * | MPU | Dynamic | Static |     Available Functions     |       Possible Allocations        | Both Dynamic and | Need Free |
1010  * |     |         |        |                             |                                   | Static Possible  |           |
1011  * +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+
1012  * | 0   | 0       | 1      | xTaskCreateStatic           | TCB - Static, Stack - Static      | No               | No        |
1013  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1014  * | 0   | 1       | 0      | xTaskCreate                 | TCB - Dynamic, Stack - Dynamic    | No               | Yes       |
1015  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1016  * | 0   | 1       | 1      | xTaskCreate,                | 1. TCB - Dynamic, Stack - Dynamic | Yes              | Yes       |
1017  * |     |         |        | xTaskCreateStatic           | 2. TCB - Static, Stack - Static   |                  |           |
1018  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1019  * | 1   | 0       | 1      | xTaskCreateStatic,          | TCB - Static, Stack - Static      | No               | No        |
1020  * |     |         |        | xTaskCreateRestrictedStatic |                                   |                  |           |
1021  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1022  * | 1   | 1       | 0      | xTaskCreate,                | 1. TCB - Dynamic, Stack - Dynamic | Yes              | Yes       |
1023  * |     |         |        | xTaskCreateRestricted       | 2. TCB - Dynamic, Stack - Static  |                  |           |
1024  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1025  * | 1   | 1       | 1      | xTaskCreate,                | 1. TCB - Dynamic, Stack - Dynamic | Yes              | Yes       |
1026  * |     |         |        | xTaskCreateStatic,          | 2. TCB - Dynamic, Stack - Static  |                  |           |
1027  * |     |         |        | xTaskCreateRestricted,      | 3. TCB - Static, Stack - Static   |                  |           |
1028  * |     |         |        | xTaskCreateRestrictedStatic |                                   |                  |           |
1029  * +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+
1030  */
1031 #define tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE       ( ( ( portUSING_MPU_WRAPPERS == 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) || \
1032                                                                                                           ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) )
1033
1034 /*
1035  * In line with software engineering best practice, FreeRTOS implements a strict
1036  * data hiding policy, so the real structures used by FreeRTOS to maintain the
1037  * state of tasks, queues, semaphores, etc. are not accessible to the application
1038  * code.  However, if the application writer wants to statically allocate such
1039  * an object then the size of the object needs to be know.  Dummy structures
1040  * that are guaranteed to have the same size and alignment requirements of the
1041  * real objects are used for this purpose.  The dummy list and list item
1042  * structures below are used for inclusion in such a dummy structure.
1043  */
1044 struct xSTATIC_LIST_ITEM
1045 {
1046         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1047                 TickType_t xDummy1;
1048         #endif
1049         TickType_t xDummy2;
1050         void *pvDummy3[ 4 ];
1051         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1052                 TickType_t xDummy4;
1053         #endif
1054 };
1055 typedef struct xSTATIC_LIST_ITEM StaticListItem_t;
1056
1057 /* See the comments above the struct xSTATIC_LIST_ITEM definition. */
1058 struct xSTATIC_MINI_LIST_ITEM
1059 {
1060         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1061                 TickType_t xDummy1;
1062         #endif
1063         TickType_t xDummy2;
1064         void *pvDummy3[ 2 ];
1065 };
1066 typedef struct xSTATIC_MINI_LIST_ITEM StaticMiniListItem_t;
1067
1068 /* See the comments above the struct xSTATIC_LIST_ITEM definition. */
1069 typedef struct xSTATIC_LIST
1070 {
1071         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1072                 TickType_t xDummy1;
1073         #endif
1074         UBaseType_t uxDummy2;
1075         void *pvDummy3;
1076         StaticMiniListItem_t xDummy4;
1077         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1078                 TickType_t xDummy5;
1079         #endif
1080 } StaticList_t;
1081
1082 /*
1083  * In line with software engineering best practice, especially when supplying a
1084  * library that is likely to change in future versions, FreeRTOS implements a
1085  * strict data hiding policy.  This means the Task structure used internally by
1086  * FreeRTOS is not accessible to application code.  However, if the application
1087  * writer wants to statically allocate the memory required to create a task then
1088  * the size of the task object needs to be know.  The StaticTask_t structure
1089  * below is provided for this purpose.  Its sizes and alignment requirements are
1090  * guaranteed to match those of the genuine structure, no matter which
1091  * architecture is being used, and no matter how the values in FreeRTOSConfig.h
1092  * are set.  Its contents are somewhat obfuscated in the hope users will
1093  * recognise that it would be unwise to make direct use of the structure members.
1094  */
1095 typedef struct xSTATIC_TCB
1096 {
1097         void                            *pxDummy1;
1098         #if ( portUSING_MPU_WRAPPERS == 1 )
1099                 xMPU_SETTINGS   xDummy2;
1100         #endif
1101         StaticListItem_t        xDummy3[ 2 ];
1102         UBaseType_t                     uxDummy5;
1103         void                            *pxDummy6;
1104         uint8_t                         ucDummy7[ configMAX_TASK_NAME_LEN ];
1105         #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )
1106                 void                    *pxDummy8;
1107         #endif
1108         #if ( portCRITICAL_NESTING_IN_TCB == 1 )
1109                 UBaseType_t             uxDummy9;
1110         #endif
1111         #if ( configUSE_TRACE_FACILITY == 1 )
1112                 UBaseType_t             uxDummy10[ 2 ];
1113         #endif
1114         #if ( configUSE_MUTEXES == 1 )
1115                 UBaseType_t             uxDummy12[ 2 ];
1116         #endif
1117         #if ( configUSE_APPLICATION_TASK_TAG == 1 )
1118                 void                    *pxDummy14;
1119         #endif
1120         #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )
1121                 void                    *pvDummy15[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];
1122         #endif
1123         #if ( configGENERATE_RUN_TIME_STATS == 1 )
1124                 uint32_t                ulDummy16;
1125         #endif
1126         #if ( configUSE_NEWLIB_REENTRANT == 1 )
1127                 struct  _reent  xDummy17;
1128         #endif
1129         #if ( configUSE_TASK_NOTIFICATIONS == 1 )
1130                 uint32_t                ulDummy18;
1131                 uint8_t                 ucDummy19;
1132         #endif
1133         #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )
1134                 uint8_t                 uxDummy20;
1135         #endif
1136
1137         #if( INCLUDE_xTaskAbortDelay == 1 )
1138                 uint8_t ucDummy21;
1139         #endif
1140         #if ( configUSE_POSIX_ERRNO == 1 )
1141                 int                             iDummy22;
1142         #endif
1143 } StaticTask_t;
1144
1145 /*
1146  * In line with software engineering best practice, especially when supplying a
1147  * library that is likely to change in future versions, FreeRTOS implements a
1148  * strict data hiding policy.  This means the Queue structure used internally by
1149  * FreeRTOS is not accessible to application code.  However, if the application
1150  * writer wants to statically allocate the memory required to create a queue
1151  * then the size of the queue object needs to be know.  The StaticQueue_t
1152  * structure below is provided for this purpose.  Its sizes and alignment
1153  * requirements are guaranteed to match those of the genuine structure, no
1154  * matter which architecture is being used, and no matter how the values in
1155  * FreeRTOSConfig.h are set.  Its contents are somewhat obfuscated in the hope
1156  * users will recognise that it would be unwise to make direct use of the
1157  * structure members.
1158  */
1159 typedef struct xSTATIC_QUEUE
1160 {
1161         void *pvDummy1[ 3 ];
1162
1163         union
1164         {
1165                 void *pvDummy2;
1166                 UBaseType_t uxDummy2;
1167         } u;
1168
1169         StaticList_t xDummy3[ 2 ];
1170         UBaseType_t uxDummy4[ 3 ];
1171         uint8_t ucDummy5[ 2 ];
1172
1173         #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
1174                 uint8_t ucDummy6;
1175         #endif
1176
1177         #if ( configUSE_QUEUE_SETS == 1 )
1178                 void *pvDummy7;
1179         #endif
1180
1181         #if ( configUSE_TRACE_FACILITY == 1 )
1182                 UBaseType_t uxDummy8;
1183                 uint8_t ucDummy9;
1184         #endif
1185
1186 } StaticQueue_t;
1187 typedef StaticQueue_t StaticSemaphore_t;
1188
1189 /*
1190  * In line with software engineering best practice, especially when supplying a
1191  * library that is likely to change in future versions, FreeRTOS implements a
1192  * strict data hiding policy.  This means the event group structure used
1193  * internally by FreeRTOS is not accessible to application code.  However, if
1194  * the application writer wants to statically allocate the memory required to
1195  * create an event group then the size of the event group object needs to be
1196  * know.  The StaticEventGroup_t structure below is provided for this purpose.
1197  * Its sizes and alignment requirements are guaranteed to match those of the
1198  * genuine structure, no matter which architecture is being used, and no matter
1199  * how the values in FreeRTOSConfig.h are set.  Its contents are somewhat
1200  * obfuscated in the hope users will recognise that it would be unwise to make
1201  * direct use of the structure members.
1202  */
1203 typedef struct xSTATIC_EVENT_GROUP
1204 {
1205         TickType_t xDummy1;
1206         StaticList_t xDummy2;
1207
1208         #if( configUSE_TRACE_FACILITY == 1 )
1209                 UBaseType_t uxDummy3;
1210         #endif
1211
1212         #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
1213                         uint8_t ucDummy4;
1214         #endif
1215
1216 } StaticEventGroup_t;
1217
1218 /*
1219  * In line with software engineering best practice, especially when supplying a
1220  * library that is likely to change in future versions, FreeRTOS implements a
1221  * strict data hiding policy.  This means the software timer structure used
1222  * internally by FreeRTOS is not accessible to application code.  However, if
1223  * the application writer wants to statically allocate the memory required to
1224  * create a software timer then the size of the queue object needs to be know.
1225  * The StaticTimer_t structure below is provided for this purpose.  Its sizes
1226  * and alignment requirements are guaranteed to match those of the genuine
1227  * structure, no matter which architecture is being used, and no matter how the
1228  * values in FreeRTOSConfig.h are set.  Its contents are somewhat obfuscated in
1229  * the hope users will recognise that it would be unwise to make direct use of
1230  * the structure members.
1231  */
1232 typedef struct xSTATIC_TIMER
1233 {
1234         void                            *pvDummy1;
1235         StaticListItem_t        xDummy2;
1236         TickType_t                      xDummy3;
1237         void                            *pvDummy5;
1238         TaskFunction_t          pvDummy6;
1239         #if( configUSE_TRACE_FACILITY == 1 )
1240                 UBaseType_t             uxDummy7;
1241         #endif
1242         uint8_t                         ucDummy8;
1243
1244 } StaticTimer_t;
1245
1246 /*
1247 * In line with software engineering best practice, especially when supplying a
1248 * library that is likely to change in future versions, FreeRTOS implements a
1249 * strict data hiding policy.  This means the stream buffer structure used
1250 * internally by FreeRTOS is not accessible to application code.  However, if
1251 * the application writer wants to statically allocate the memory required to
1252 * create a stream buffer then the size of the stream buffer object needs to be
1253 * know.  The StaticStreamBuffer_t structure below is provided for this purpose.
1254 * Its size and alignment requirements are guaranteed to match those of the
1255 * genuine structure, no matter which architecture is being used, and no matter
1256 * how the values in FreeRTOSConfig.h are set.  Its contents are somewhat
1257 * obfuscated in the hope users will recognise that it would be unwise to make
1258 * direct use of the structure members.
1259 */
1260 typedef struct xSTATIC_STREAM_BUFFER
1261 {
1262         size_t uxDummy1[ 4 ];
1263         void * pvDummy2[ 3 ];
1264         uint8_t ucDummy3;
1265         #if ( configUSE_TRACE_FACILITY == 1 )
1266                 UBaseType_t uxDummy4;
1267         #endif
1268 } StaticStreamBuffer_t;
1269
1270 /* Message buffers are built on stream buffers. */
1271 typedef StaticStreamBuffer_t StaticMessageBuffer_t;
1272
1273 #ifdef __cplusplus
1274 }
1275 #endif
1276
1277 #endif /* INC_FREERTOS_H */
1278