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

   1 /*
   2  * FreeRTOS Kernel V10.2.0
   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 /* The timers module relies on xTaskGetSchedulerState(). */
 245 #if configUSE_TIMERS == 1
 246
 247         #ifndef configTIMER_TASK_PRIORITY
 248                 #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_PRIORITY must also be defined.
 249         #endif /* configTIMER_TASK_PRIORITY */
 250
 251         #ifndef configTIMER_QUEUE_LENGTH
 252                 #error If configUSE_TIMERS is set to 1 then configTIMER_QUEUE_LENGTH must also be defined.
 253         #endif /* configTIMER_QUEUE_LENGTH */
 254
 255         #ifndef configTIMER_TASK_STACK_DEPTH
 256                 #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_STACK_DEPTH must also be defined.
 257         #endif /* configTIMER_TASK_STACK_DEPTH */
 258
 259 #endif /* configUSE_TIMERS */
 260
 261 #ifndef portSET_INTERRUPT_MASK_FROM_ISR
 262         #define portSET_INTERRUPT_MASK_FROM_ISR() 0
 263 #endif
 264
 265 #ifndef portCLEAR_INTERRUPT_MASK_FROM_ISR
 266         #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusValue ) ( void ) uxSavedStatusValue
 267 #endif
 268
 269 #ifndef portCLEAN_UP_TCB
 270         #define portCLEAN_UP_TCB( pxTCB ) ( void ) pxTCB
 271 #endif
 272
 273 #ifndef portPRE_TASK_DELETE_HOOK
 274         #define portPRE_TASK_DELETE_HOOK( pvTaskToDelete, pxYieldPending )
 275 #endif
 276
 277 #ifndef portSETUP_TCB
 278         #define portSETUP_TCB( pxTCB ) ( void ) pxTCB
 279 #endif
 280
 281 #ifndef configQUEUE_REGISTRY_SIZE
 282         #define configQUEUE_REGISTRY_SIZE 0U
 283 #endif
 284
 285 #if ( configQUEUE_REGISTRY_SIZE < 1 )
 286         #define vQueueAddToRegistry( xQueue, pcName )
 287         #define vQueueUnregisterQueue( xQueue )
 288         #define pcQueueGetName( xQueue )
 289 #endif
 290
 291 #ifndef portPOINTER_SIZE_TYPE
 292         #define portPOINTER_SIZE_TYPE uint32_t
 293 #endif
 294
 295 /* Remove any unused trace macros. */
 296 #ifndef traceSTART
 297         /* Used to perform any necessary initialisation - for example, open a file
 298         into which trace is to be written. */
 299         #define traceSTART()
 300 #endif
 301
 302 #ifndef traceEND
 303         /* Use to close a trace, for example close a file into which trace has been
 304         written. */
 305         #define traceEND()
 306 #endif
 307
 308 #ifndef traceTASK_SWITCHED_IN
 309         /* Called after a task has been selected to run.  pxCurrentTCB holds a pointer
 310         to the task control block of the selected task. */
 311         #define traceTASK_SWITCHED_IN()
 312 #endif
 313
 314 #ifndef traceINCREASE_TICK_COUNT
 315         /* Called before stepping the tick count after waking from tickless idle
 316         sleep. */
 317         #define traceINCREASE_TICK_COUNT( x )
 318 #endif
 319
 320 #ifndef traceLOW_POWER_IDLE_BEGIN
 321         /* Called immediately before entering tickless idle. */
 322         #define traceLOW_POWER_IDLE_BEGIN()
 323 #endif
 324
 325 #ifndef traceLOW_POWER_IDLE_END
 326         /* Called when returning to the Idle task after a tickless idle. */
 327         #define traceLOW_POWER_IDLE_END()
 328 #endif
 329
 330 #ifndef traceTASK_SWITCHED_OUT
 331         /* Called before a task has been selected to run.  pxCurrentTCB holds a pointer
 332         to the task control block of the task being switched out. */
 333         #define traceTASK_SWITCHED_OUT()
 334 #endif
 335
 336 #ifndef traceTASK_PRIORITY_INHERIT
 337         /* Called when a task attempts to take a mutex that is already held by a
 338         lower priority task.  pxTCBOfMutexHolder is a pointer to the TCB of the task
 339         that holds the mutex.  uxInheritedPriority is the priority the mutex holder
 340         will inherit (the priority of the task that is attempting to obtain the
 341         muted. */
 342         #define traceTASK_PRIORITY_INHERIT( pxTCBOfMutexHolder, uxInheritedPriority )
 343 #endif
 344
 345 #ifndef traceTASK_PRIORITY_DISINHERIT
 346         /* Called when a task releases a mutex, the holding of which had resulted in
 347         the task inheriting the priority of a higher priority task.
 348         pxTCBOfMutexHolder is a pointer to the TCB of the task that is releasing the
 349         mutex.  uxOriginalPriority is the task's configured (base) priority. */
 350         #define traceTASK_PRIORITY_DISINHERIT( pxTCBOfMutexHolder, uxOriginalPriority )
 351 #endif
 352
 353 #ifndef traceBLOCKING_ON_QUEUE_RECEIVE
 354         /* Task is about to block because it cannot read from a
 355         queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore
 356         upon which the read was attempted.  pxCurrentTCB points to the TCB of the
 357         task that attempted the read. */
 358         #define traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue )
 359 #endif
 360
 361 #ifndef traceBLOCKING_ON_QUEUE_PEEK
 362         /* Task is about to block because it cannot read from a
 363         queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore
 364         upon which the read was attempted.  pxCurrentTCB points to the TCB of the
 365         task that attempted the read. */
 366         #define traceBLOCKING_ON_QUEUE_PEEK( pxQueue )
 367 #endif
 368
 369 #ifndef traceBLOCKING_ON_QUEUE_SEND
 370         /* Task is about to block because it cannot write to a
 371         queue/mutex/semaphore.  pxQueue is a pointer to the queue/mutex/semaphore
 372         upon which the write was attempted.  pxCurrentTCB points to the TCB of the
 373         task that attempted the write. */
 374         #define traceBLOCKING_ON_QUEUE_SEND( pxQueue )
 375 #endif
 376
 377 #ifndef configCHECK_FOR_STACK_OVERFLOW
 378         #define configCHECK_FOR_STACK_OVERFLOW 0
 379 #endif
 380
 381 #ifndef configRECORD_STACK_HIGH_ADDRESS
 382         #define configRECORD_STACK_HIGH_ADDRESS 0
 383 #endif
 384
 385 #ifndef configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H
 386         #define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H 0
 387 #endif
 388
 389 /* The following event macros are embedded in the kernel API calls. */
 390
 391 #ifndef traceMOVED_TASK_TO_READY_STATE
 392         #define traceMOVED_TASK_TO_READY_STATE( pxTCB )
 393 #endif
 394
 395 #ifndef tracePOST_MOVED_TASK_TO_READY_STATE
 396         #define tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )
 397 #endif
 398
 399 #ifndef traceQUEUE_CREATE
 400         #define traceQUEUE_CREATE( pxNewQueue )
 401 #endif
 402
 403 #ifndef traceQUEUE_CREATE_FAILED
 404         #define traceQUEUE_CREATE_FAILED( ucQueueType )
 405 #endif
 406
 407 #ifndef traceCREATE_MUTEX
 408         #define traceCREATE_MUTEX( pxNewQueue )
 409 #endif
 410
 411 #ifndef traceCREATE_MUTEX_FAILED
 412         #define traceCREATE_MUTEX_FAILED()
 413 #endif
 414
 415 #ifndef traceGIVE_MUTEX_RECURSIVE
 416         #define traceGIVE_MUTEX_RECURSIVE( pxMutex )
 417 #endif
 418
 419 #ifndef traceGIVE_MUTEX_RECURSIVE_FAILED
 420         #define traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex )
 421 #endif
 422
 423 #ifndef traceTAKE_MUTEX_RECURSIVE
 424         #define traceTAKE_MUTEX_RECURSIVE( pxMutex )
 425 #endif
 426
 427 #ifndef traceTAKE_MUTEX_RECURSIVE_FAILED
 428         #define traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex )
 429 #endif
 430
 431 #ifndef traceCREATE_COUNTING_SEMAPHORE
 432         #define traceCREATE_COUNTING_SEMAPHORE()
 433 #endif
 434
 435 #ifndef traceCREATE_COUNTING_SEMAPHORE_FAILED
 436         #define traceCREATE_COUNTING_SEMAPHORE_FAILED()
 437 #endif
 438
 439 #ifndef traceQUEUE_SEND
 440         #define traceQUEUE_SEND( pxQueue )
 441 #endif
 442
 443 #ifndef traceQUEUE_SEND_FAILED
 444         #define traceQUEUE_SEND_FAILED( pxQueue )
 445 #endif
 446
 447 #ifndef traceQUEUE_RECEIVE
 448         #define traceQUEUE_RECEIVE( pxQueue )
 449 #endif
 450
 451 #ifndef traceQUEUE_PEEK
 452         #define traceQUEUE_PEEK( pxQueue )
 453 #endif
 454
 455 #ifndef traceQUEUE_PEEK_FAILED
 456         #define traceQUEUE_PEEK_FAILED( pxQueue )
 457 #endif
 458
 459 #ifndef traceQUEUE_PEEK_FROM_ISR
 460         #define traceQUEUE_PEEK_FROM_ISR( pxQueue )
 461 #endif
 462
 463 #ifndef traceQUEUE_RECEIVE_FAILED
 464         #define traceQUEUE_RECEIVE_FAILED( pxQueue )
 465 #endif
 466
 467 #ifndef traceQUEUE_SEND_FROM_ISR
 468         #define traceQUEUE_SEND_FROM_ISR( pxQueue )
 469 #endif
 470
 471 #ifndef traceQUEUE_SEND_FROM_ISR_FAILED
 472         #define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue )
 473 #endif
 474
 475 #ifndef traceQUEUE_RECEIVE_FROM_ISR
 476         #define traceQUEUE_RECEIVE_FROM_ISR( pxQueue )
 477 #endif
 478
 479 #ifndef traceQUEUE_RECEIVE_FROM_ISR_FAILED
 480         #define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue )
 481 #endif
 482
 483 #ifndef traceQUEUE_PEEK_FROM_ISR_FAILED
 484         #define traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue )
 485 #endif
 486
 487 #ifndef traceQUEUE_DELETE
 488         #define traceQUEUE_DELETE( pxQueue )
 489 #endif
 490
 491 #ifndef traceTASK_CREATE
 492         #define traceTASK_CREATE( pxNewTCB )
 493 #endif
 494
 495 #ifndef traceTASK_CREATE_FAILED
 496         #define traceTASK_CREATE_FAILED()
 497 #endif
 498
 499 #ifndef traceTASK_DELETE
 500         #define traceTASK_DELETE( pxTaskToDelete )
 501 #endif
 502
 503 #ifndef traceTASK_DELAY_UNTIL
 504         #define traceTASK_DELAY_UNTIL( x )
 505 #endif
 506
 507 #ifndef traceTASK_DELAY
 508         #define traceTASK_DELAY()
 509 #endif
 510
 511 #ifndef traceTASK_PRIORITY_SET
 512         #define traceTASK_PRIORITY_SET( pxTask, uxNewPriority )
 513 #endif
 514
 515 #ifndef traceTASK_SUSPEND
 516         #define traceTASK_SUSPEND( pxTaskToSuspend )
 517 #endif
 518
 519 #ifndef traceTASK_RESUME
 520         #define traceTASK_RESUME( pxTaskToResume )
 521 #endif
 522
 523 #ifndef traceTASK_RESUME_FROM_ISR
 524         #define traceTASK_RESUME_FROM_ISR( pxTaskToResume )
 525 #endif
 526
 527 #ifndef traceTASK_INCREMENT_TICK
 528         #define traceTASK_INCREMENT_TICK( xTickCount )
 529 #endif
 530
 531 #ifndef traceTIMER_CREATE
 532         #define traceTIMER_CREATE( pxNewTimer )
 533 #endif
 534
 535 #ifndef traceTIMER_CREATE_FAILED
 536         #define traceTIMER_CREATE_FAILED()
 537 #endif
 538
 539 #ifndef traceTIMER_COMMAND_SEND
 540         #define traceTIMER_COMMAND_SEND( xTimer, xMessageID, xMessageValueValue, xReturn )
 541 #endif
 542
 543 #ifndef traceTIMER_EXPIRED
 544         #define traceTIMER_EXPIRED( pxTimer )
 545 #endif
 546
 547 #ifndef traceTIMER_COMMAND_RECEIVED
 548         #define traceTIMER_COMMAND_RECEIVED( pxTimer, xMessageID, xMessageValue )
 549 #endif
 550
 551 #ifndef traceMALLOC
 552     #define traceMALLOC( pvAddress, uiSize )
 553 #endif
 554
 555 #ifndef traceFREE
 556     #define traceFREE( pvAddress, uiSize )
 557 #endif
 558
 559 #ifndef traceEVENT_GROUP_CREATE
 560         #define traceEVENT_GROUP_CREATE( xEventGroup )
 561 #endif
 562
 563 #ifndef traceEVENT_GROUP_CREATE_FAILED
 564         #define traceEVENT_GROUP_CREATE_FAILED()
 565 #endif
 566
 567 #ifndef traceEVENT_GROUP_SYNC_BLOCK
 568         #define traceEVENT_GROUP_SYNC_BLOCK( xEventGroup, uxBitsToSet, uxBitsToWaitFor )
 569 #endif
 570
 571 #ifndef traceEVENT_GROUP_SYNC_END
 572         #define traceEVENT_GROUP_SYNC_END( xEventGroup, uxBitsToSet, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred
 573 #endif
 574
 575 #ifndef traceEVENT_GROUP_WAIT_BITS_BLOCK
 576         #define traceEVENT_GROUP_WAIT_BITS_BLOCK( xEventGroup, uxBitsToWaitFor )
 577 #endif
 578
 579 #ifndef traceEVENT_GROUP_WAIT_BITS_END
 580         #define traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred
 581 #endif
 582
 583 #ifndef traceEVENT_GROUP_CLEAR_BITS
 584         #define traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear )
 585 #endif
 586
 587 #ifndef traceEVENT_GROUP_CLEAR_BITS_FROM_ISR
 588         #define traceEVENT_GROUP_CLEAR_BITS_FROM_ISR( xEventGroup, uxBitsToClear )
 589 #endif
 590
 591 #ifndef traceEVENT_GROUP_SET_BITS
 592         #define traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet )
 593 #endif
 594
 595 #ifndef traceEVENT_GROUP_SET_BITS_FROM_ISR
 596         #define traceEVENT_GROUP_SET_BITS_FROM_ISR( xEventGroup, uxBitsToSet )
 597 #endif
 598
 599 #ifndef traceEVENT_GROUP_DELETE
 600         #define traceEVENT_GROUP_DELETE( xEventGroup )
 601 #endif
 602
 603 #ifndef tracePEND_FUNC_CALL
 604         #define tracePEND_FUNC_CALL(xFunctionToPend, pvParameter1, ulParameter2, ret)
 605 #endif
 606
 607 #ifndef tracePEND_FUNC_CALL_FROM_ISR
 608         #define tracePEND_FUNC_CALL_FROM_ISR(xFunctionToPend, pvParameter1, ulParameter2, ret)
 609 #endif
 610
 611 #ifndef traceQUEUE_REGISTRY_ADD
 612         #define traceQUEUE_REGISTRY_ADD(xQueue, pcQueueName)
 613 #endif
 614
 615 #ifndef traceTASK_NOTIFY_TAKE_BLOCK
 616         #define traceTASK_NOTIFY_TAKE_BLOCK()
 617 #endif
 618
 619 #ifndef traceTASK_NOTIFY_TAKE
 620         #define traceTASK_NOTIFY_TAKE()
 621 #endif
 622
 623 #ifndef traceTASK_NOTIFY_WAIT_BLOCK
 624         #define traceTASK_NOTIFY_WAIT_BLOCK()
 625 #endif
 626
 627 #ifndef traceTASK_NOTIFY_WAIT
 628         #define traceTASK_NOTIFY_WAIT()
 629 #endif
 630
 631 #ifndef traceTASK_NOTIFY
 632         #define traceTASK_NOTIFY()
 633 #endif
 634
 635 #ifndef traceTASK_NOTIFY_FROM_ISR
 636         #define traceTASK_NOTIFY_FROM_ISR()
 637 #endif
 638
 639 #ifndef traceTASK_NOTIFY_GIVE_FROM_ISR
 640         #define traceTASK_NOTIFY_GIVE_FROM_ISR()
 641 #endif
 642
 643 #ifndef traceSTREAM_BUFFER_CREATE_FAILED
 644         #define traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer )
 645 #endif
 646
 647 #ifndef traceSTREAM_BUFFER_CREATE_STATIC_FAILED
 648         #define traceSTREAM_BUFFER_CREATE_STATIC_FAILED( xReturn, xIsMessageBuffer )
 649 #endif
 650
 651 #ifndef traceSTREAM_BUFFER_CREATE
 652         #define traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer )
 653 #endif
 654
 655 #ifndef traceSTREAM_BUFFER_DELETE
 656         #define traceSTREAM_BUFFER_DELETE( xStreamBuffer )
 657 #endif
 658
 659 #ifndef traceSTREAM_BUFFER_RESET
 660         #define traceSTREAM_BUFFER_RESET( xStreamBuffer )
 661 #endif
 662
 663 #ifndef traceBLOCKING_ON_STREAM_BUFFER_SEND
 664         #define traceBLOCKING_ON_STREAM_BUFFER_SEND( xStreamBuffer )
 665 #endif
 666
 667 #ifndef traceSTREAM_BUFFER_SEND
 668         #define traceSTREAM_BUFFER_SEND( xStreamBuffer, xBytesSent )
 669 #endif
 670
 671 #ifndef traceSTREAM_BUFFER_SEND_FAILED
 672         #define traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer )
 673 #endif
 674
 675 #ifndef traceSTREAM_BUFFER_SEND_FROM_ISR
 676         #define traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xBytesSent )
 677 #endif
 678
 679 #ifndef traceBLOCKING_ON_STREAM_BUFFER_RECEIVE
 680         #define traceBLOCKING_ON_STREAM_BUFFER_RECEIVE( xStreamBuffer )
 681 #endif
 682
 683 #ifndef traceSTREAM_BUFFER_RECEIVE
 684         #define traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength )
 685 #endif
 686
 687 #ifndef traceSTREAM_BUFFER_RECEIVE_FAILED
 688         #define traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer )
 689 #endif
 690
 691 #ifndef traceSTREAM_BUFFER_RECEIVE_FROM_ISR
 692         #define traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength )
 693 #endif
 694
 695 #ifndef configGENERATE_RUN_TIME_STATS
 696         #define configGENERATE_RUN_TIME_STATS 0
 697 #endif
 698
 699 #if ( configGENERATE_RUN_TIME_STATS == 1 )
 700
 701         #ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS
 702                 #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.
 703         #endif /* portCONFIGURE_TIMER_FOR_RUN_TIME_STATS */
 704
 705         #ifndef portGET_RUN_TIME_COUNTER_VALUE
 706                 #ifndef portALT_GET_RUN_TIME_COUNTER_VALUE
 707                         #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.
 708                 #endif /* portALT_GET_RUN_TIME_COUNTER_VALUE */
 709         #endif /* portGET_RUN_TIME_COUNTER_VALUE */
 710
 711 #endif /* configGENERATE_RUN_TIME_STATS */
 712
 713 #ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS
 714         #define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS()
 715 #endif
 716
 717 #ifndef configUSE_MALLOC_FAILED_HOOK
 718         #define configUSE_MALLOC_FAILED_HOOK 0
 719 #endif
 720
 721 #ifndef portPRIVILEGE_BIT
 722         #define portPRIVILEGE_BIT ( ( UBaseType_t ) 0x00 )
 723 #endif
 724
 725 #ifndef portYIELD_WITHIN_API
 726         #define portYIELD_WITHIN_API portYIELD
 727 #endif
 728
 729 #ifndef portSUPPRESS_TICKS_AND_SLEEP
 730         #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )
 731 #endif
 732
 733 #ifndef configEXPECTED_IDLE_TIME_BEFORE_SLEEP
 734         #define configEXPECTED_IDLE_TIME_BEFORE_SLEEP 2
 735 #endif
 736
 737 #if configEXPECTED_IDLE_TIME_BEFORE_SLEEP < 2
 738         #error configEXPECTED_IDLE_TIME_BEFORE_SLEEP must not be less than 2
 739 #endif
 740
 741 #ifndef configUSE_TICKLESS_IDLE
 742         #define configUSE_TICKLESS_IDLE 0
 743 #endif
 744
 745 #ifndef configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING
 746         #define configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( x )
 747 #endif
 748
 749 #ifndef configPRE_SLEEP_PROCESSING
 750         #define configPRE_SLEEP_PROCESSING( x )
 751 #endif
 752
 753 #ifndef configPOST_SLEEP_PROCESSING
 754         #define configPOST_SLEEP_PROCESSING( x )
 755 #endif
 756
 757 #ifndef configUSE_QUEUE_SETS
 758         #define configUSE_QUEUE_SETS 0
 759 #endif
 760
 761 #ifndef portTASK_USES_FLOATING_POINT
 762         #define portTASK_USES_FLOATING_POINT()
 763 #endif
 764
 765 #ifndef portALLOCATE_SECURE_CONTEXT
 766         #define portALLOCATE_SECURE_CONTEXT( ulSecureStackSize )
 767 #endif
 768
 769 #ifndef portHAS_STACK_OVERFLOW_CHECKING
 770         #define portHAS_STACK_OVERFLOW_CHECKING 0
 771 #endif
 772
 773 #ifndef configUSE_TIME_SLICING
 774         #define configUSE_TIME_SLICING 1
 775 #endif
 776
 777 #ifndef configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS
 778         #define configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 0
 779 #endif
 780
 781 #ifndef configUSE_STATS_FORMATTING_FUNCTIONS
 782         #define configUSE_STATS_FORMATTING_FUNCTIONS 0
 783 #endif
 784
 785 #ifndef portASSERT_IF_INTERRUPT_PRIORITY_INVALID
 786         #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()
 787 #endif
 788
 789 #ifndef configUSE_TRACE_FACILITY
 790         #define configUSE_TRACE_FACILITY 0
 791 #endif
 792
 793 #ifndef mtCOVERAGE_TEST_MARKER
 794         #define mtCOVERAGE_TEST_MARKER()
 795 #endif
 796
 797 #ifndef mtCOVERAGE_TEST_DELAY
 798         #define mtCOVERAGE_TEST_DELAY()
 799 #endif
 800
 801 #ifndef portASSERT_IF_IN_ISR
 802         #define portASSERT_IF_IN_ISR()
 803 #endif
 804
 805 #ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
 806         #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
 807 #endif
 808
 809 #ifndef configAPPLICATION_ALLOCATED_HEAP
 810         #define configAPPLICATION_ALLOCATED_HEAP 0
 811 #endif
 812
 813 #ifndef configUSE_TASK_NOTIFICATIONS
 814         #define configUSE_TASK_NOTIFICATIONS 1
 815 #endif
 816
 817 #ifndef configUSE_POSIX_ERRNO
 818         #define configUSE_POSIX_ERRNO 0
 819 #endif
 820
 821 #ifndef portTICK_TYPE_IS_ATOMIC
 822         #define portTICK_TYPE_IS_ATOMIC 0
 823 #endif
 824
 825 #ifndef configSUPPORT_STATIC_ALLOCATION
 826         /* Defaults to 0 for backward compatibility. */
 827         #define configSUPPORT_STATIC_ALLOCATION 0
 828 #endif
 829
 830 #ifndef configSUPPORT_DYNAMIC_ALLOCATION
 831         /* Defaults to 1 for backward compatibility. */
 832         #define configSUPPORT_DYNAMIC_ALLOCATION 1
 833 #endif
 834
 835 #ifndef configSTACK_DEPTH_TYPE
 836         /* Defaults to uint16_t for backward compatibility, but can be overridden
 837         in FreeRTOSConfig.h if uint16_t is too restrictive. */
 838         #define configSTACK_DEPTH_TYPE uint16_t
 839 #endif
 840
 841 #ifndef configMESSAGE_BUFFER_LENGTH_TYPE
 842         /* Defaults to size_t for backward compatibility, but can be overridden
 843         in FreeRTOSConfig.h if lengths will always be less than the number of bytes
 844         in a size_t. */
 845         #define configMESSAGE_BUFFER_LENGTH_TYPE size_t
 846 #endif
 847
 848 /* Sanity check the configuration. */
 849 #if( configUSE_TICKLESS_IDLE != 0 )
 850         #if( INCLUDE_vTaskSuspend != 1 )
 851                 #error INCLUDE_vTaskSuspend must be set to 1 if configUSE_TICKLESS_IDLE is not set to 0
 852         #endif /* INCLUDE_vTaskSuspend */
 853 #endif /* configUSE_TICKLESS_IDLE */
 854
 855 #if( ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 0 ) )
 856         #error configSUPPORT_STATIC_ALLOCATION and configSUPPORT_DYNAMIC_ALLOCATION cannot both be 0, but can both be 1.
 857 #endif
 858
 859 #if( ( configUSE_RECURSIVE_MUTEXES == 1 ) && ( configUSE_MUTEXES != 1 ) )
 860         #error configUSE_MUTEXES must be set to 1 to use recursive mutexes
 861 #endif
 862
 863 #ifndef configINITIAL_TICK_COUNT
 864         #define configINITIAL_TICK_COUNT 0
 865 #endif
 866
 867 #if( portTICK_TYPE_IS_ATOMIC == 0 )
 868         /* Either variables of tick type cannot be read atomically, or
 869         portTICK_TYPE_IS_ATOMIC was not set - map the critical sections used when
 870         the tick count is returned to the standard critical section macros. */
 871         #define portTICK_TYPE_ENTER_CRITICAL() portENTER_CRITICAL()
 872         #define portTICK_TYPE_EXIT_CRITICAL() portEXIT_CRITICAL()
 873         #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() portSET_INTERRUPT_MASK_FROM_ISR()
 874         #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) portCLEAR_INTERRUPT_MASK_FROM_ISR( ( x ) )
 875 #else
 876         /* The tick type can be read atomically, so critical sections used when the
 877         tick count is returned can be defined away. */
 878         #define portTICK_TYPE_ENTER_CRITICAL()
 879         #define portTICK_TYPE_EXIT_CRITICAL()
 880         #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() 0
 881         #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) ( void ) x
 882 #endif
 883
 884 /* Definitions to allow backward compatibility with FreeRTOS versions prior to
 885 V8 if desired. */
 886 #ifndef configENABLE_BACKWARD_COMPATIBILITY
 887         #define configENABLE_BACKWARD_COMPATIBILITY 1
 888 #endif
 889
 890 #ifndef configPRINTF
 891         /* configPRINTF() was not defined, so define it away to nothing.  To use
 892         configPRINTF() then define it as follows (where MyPrintFunction() is
 893         provided by the application writer):
 894
 895         void MyPrintFunction(const char *pcFormat, ... );
 896         #define configPRINTF( X )   MyPrintFunction X
 897
 898         Then call like a standard printf() function, but placing brackets around
 899         all parameters so they are passed as a single parameter.  For example:
 900         configPRINTF( ("Value = %d", MyVariable) ); */
 901         #define configPRINTF( X )
 902 #endif
 903
 904 #ifndef configMAX
 905         /* The application writer has not provided their own MAX macro, so define
 906         the following generic implementation. */
 907         #define configMAX( a, b ) ( ( ( a ) > ( b ) ) ? ( a ) : ( b ) )
 908 #endif
 909
 910 #ifndef configMIN
 911         /* The application writer has not provided their own MAX macro, so define
 912         the following generic implementation. */
 913         #define configMIN( a, b ) ( ( ( a ) < ( b ) ) ? ( a ) : ( b ) )
 914 #endif
 915
 916 #if configENABLE_BACKWARD_COMPATIBILITY == 1
 917         #define eTaskStateGet eTaskGetState
 918         #define portTickType TickType_t
 919         #define xTaskHandle TaskHandle_t
 920         #define xQueueHandle QueueHandle_t
 921         #define xSemaphoreHandle SemaphoreHandle_t
 922         #define xQueueSetHandle QueueSetHandle_t
 923         #define xQueueSetMemberHandle QueueSetMemberHandle_t
 924         #define xTimeOutType TimeOut_t
 925         #define xMemoryRegion MemoryRegion_t
 926         #define xTaskParameters TaskParameters_t
 927         #define xTaskStatusType TaskStatus_t
 928         #define xTimerHandle TimerHandle_t
 929         #define xCoRoutineHandle CoRoutineHandle_t
 930         #define pdTASK_HOOK_CODE TaskHookFunction_t
 931         #define portTICK_RATE_MS portTICK_PERIOD_MS
 932         #define pcTaskGetTaskName pcTaskGetName
 933         #define pcTimerGetTimerName pcTimerGetName
 934         #define pcQueueGetQueueName pcQueueGetName
 935         #define vTaskGetTaskInfo vTaskGetInfo
 936
 937         /* Backward compatibility within the scheduler code only - these definitions
 938         are not really required but are included for completeness. */
 939         #define tmrTIMER_CALLBACK TimerCallbackFunction_t
 940         #define pdTASK_CODE TaskFunction_t
 941         #define xListItem ListItem_t
 942         #define xList List_t
 943
 944         /* For libraries that break the list data hiding, and access list structure
 945         members directly (which is not supposed to be done). */
 946         #define pxContainer pvContainer
 947 #endif /* configENABLE_BACKWARD_COMPATIBILITY */
 948
 949 #if( configUSE_ALTERNATIVE_API != 0 )
 950         #error The alternative API was deprecated some time ago, and was removed in FreeRTOS V9.0 0
 951 #endif
 952
 953 /* Set configUSE_TASK_FPU_SUPPORT to 0 to omit floating point support even
 954 if floating point hardware is otherwise supported by the FreeRTOS port in use.
 955 This constant is not supported by all FreeRTOS ports that include floating
 956 point support. */
 957 #ifndef configUSE_TASK_FPU_SUPPORT
 958         #define configUSE_TASK_FPU_SUPPORT 1
 959 #endif
 960
 961 /* Set configENABLE_MPU to 1 to enable MPU support and 0 to disable it. This is
 962 currently used in ARMv8M ports. */
 963 #ifndef configENABLE_MPU
 964         #define configENABLE_MPU 0
 965 #endif
 966
 967 /* Set configENABLE_FPU to 1 to enable FPU support and 0 to disable it. This is
 968 currently used in ARMv8M ports. */
 969 #ifndef configENABLE_FPU
 970         #define configENABLE_FPU 1
 971 #endif
 972
 973 /* Set configENABLE_TRUSTZONE to 1 enable TrustZone support and 0 to disable it.
 974 This is currently used in ARMv8M ports. */
 975 #ifndef configENABLE_TRUSTZONE
 976         #define configENABLE_TRUSTZONE 1
 977 #endif
 978
 979 /* Set configRUN_FREERTOS_SECURE_ONLY to 1 to run the FreeRTOS ARMv8M port on
 980 the Secure Side only. */
 981 #ifndef configRUN_FREERTOS_SECURE_ONLY
 982         #define configRUN_FREERTOS_SECURE_ONLY 0
 983 #endif
 984
 985 /* Sometimes the FreeRTOSConfig.h settings only allow a task to be created using
 986  * dynamically allocated RAM, in which case when any task is deleted it is known
 987  * that both the task's stack and TCB need to be freed.  Sometimes the
 988  * FreeRTOSConfig.h settings only allow a task to be created using statically
 989  * allocated RAM, in which case when any task is deleted it is known that neither
 990  * the task's stack or TCB should be freed.  Sometimes the FreeRTOSConfig.h
 991  * settings allow a task to be created using either statically or dynamically
 992  * allocated RAM, in which case a member of the TCB is used to record whether the
 993  * stack and/or TCB were allocated statically or dynamically, so when a task is
 994  * deleted the RAM that was allocated dynamically is freed again and no attempt is
 995  * made to free the RAM that was allocated statically.
 996  * tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is only true if it is possible for a
 997  * task to be created using either statically or dynamically allocated RAM.  Note
 998  * that if portUSING_MPU_WRAPPERS is 1 then a protected task can be created with
 999  * a statically allocated stack and a dynamically allocated TCB.
1000  *
1001  * The following table lists various combinations of portUSING_MPU_WRAPPERS,
1002  * configSUPPORT_DYNAMIC_ALLOCATION and configSUPPORT_STATIC_ALLOCATION and
1003  * when it is possible to have both static and dynamic allocation:
1004  *  +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+
1005  * | MPU | Dynamic | Static |     Available Functions     |       Possible Allocations        | Both Dynamic and | Need Free |
1006  * |     |         |        |                             |                                   | Static Possible  |           |
1007  * +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+
1008  * | 0   | 0       | 1      | xTaskCreateStatic           | TCB - Static, Stack - Static      | No               | No        |
1009  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1010  * | 0   | 1       | 0      | xTaskCreate                 | TCB - Dynamic, Stack - Dynamic    | No               | Yes       |
1011  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1012  * | 0   | 1       | 1      | xTaskCreate,                | 1. TCB - Dynamic, Stack - Dynamic | Yes              | Yes       |
1013  * |     |         |        | xTaskCreateStatic           | 2. TCB - Static, Stack - Static   |                  |           |
1014  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1015  * | 1   | 0       | 1      | xTaskCreateStatic,          | TCB - Static, Stack - Static      | No               | No        |
1016  * |     |         |        | xTaskCreateRestrictedStatic |                                   |                  |           |
1017  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1018  * | 1   | 1       | 0      | xTaskCreate,                | 1. TCB - Dynamic, Stack - Dynamic | Yes              | Yes       |
1019  * |     |         |        | xTaskCreateRestricted       | 2. TCB - Dynamic, Stack - Static  |                  |           |
1020  * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1021  * | 1   | 1       | 1      | xTaskCreate,                | 1. TCB - Dynamic, Stack - Dynamic | Yes              | Yes       |
1022  * |     |         |        | xTaskCreateStatic,          | 2. TCB - Dynamic, Stack - Static  |                  |           |
1023  * |     |         |        | xTaskCreateRestricted,      | 3. TCB - Static, Stack - Static   |                  |           |
1024  * |     |         |        | xTaskCreateRestrictedStatic |                                   |                  |           |
1025  * +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+
1026  */
1027 #define tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE       ( ( ( portUSING_MPU_WRAPPERS == 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) || \
1028                                                                                                           ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) )
1029
1030 /*
1031  * In line with software engineering best practice, FreeRTOS implements a strict
1032  * data hiding policy, so the real structures used by FreeRTOS to maintain the
1033  * state of tasks, queues, semaphores, etc. are not accessible to the application
1034  * code.  However, if the application writer wants to statically allocate such
1035  * an object then the size of the object needs to be know.  Dummy structures
1036  * that are guaranteed to have the same size and alignment requirements of the
1037  * real objects are used for this purpose.  The dummy list and list item
1038  * structures below are used for inclusion in such a dummy structure.
1039  */
1040 struct xSTATIC_LIST_ITEM
1041 {
1042         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1043                 TickType_t xDummy1;
1044         #endif
1045         TickType_t xDummy2;
1046         void *pvDummy3[ 4 ];
1047         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1048                 TickType_t xDummy4;
1049         #endif
1050 };
1051 typedef struct xSTATIC_LIST_ITEM StaticListItem_t;
1052
1053 /* See the comments above the struct xSTATIC_LIST_ITEM definition. */
1054 struct xSTATIC_MINI_LIST_ITEM
1055 {
1056         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1057                 TickType_t xDummy1;
1058         #endif
1059         TickType_t xDummy2;
1060         void *pvDummy3[ 2 ];
1061 };
1062 typedef struct xSTATIC_MINI_LIST_ITEM StaticMiniListItem_t;
1063
1064 /* See the comments above the struct xSTATIC_LIST_ITEM definition. */
1065 typedef struct xSTATIC_LIST
1066 {
1067         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1068                 TickType_t xDummy1;
1069         #endif
1070         UBaseType_t uxDummy2;
1071         void *pvDummy3;
1072         StaticMiniListItem_t xDummy4;
1073         #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1074                 TickType_t xDummy5;
1075         #endif
1076 } StaticList_t;
1077
1078 /*
1079  * In line with software engineering best practice, especially when supplying a
1080  * library that is likely to change in future versions, FreeRTOS implements a
1081  * strict data hiding policy.  This means the Task structure used internally by
1082  * FreeRTOS is not accessible to application code.  However, if the application
1083  * writer wants to statically allocate the memory required to create a task then
1084  * the size of the task object needs to be know.  The StaticTask_t structure
1085  * below is provided for this purpose.  Its sizes and alignment requirements are
1086  * guaranteed to match those of the genuine structure, no matter which
1087  * architecture is being used, and no matter how the values in FreeRTOSConfig.h
1088  * are set.  Its contents are somewhat obfuscated in the hope users will
1089  * recognise that it would be unwise to make direct use of the structure members.
1090  */
1091 typedef struct xSTATIC_TCB
1092 {
1093         void                            *pxDummy1;
1094         #if ( portUSING_MPU_WRAPPERS == 1 )
1095                 xMPU_SETTINGS   xDummy2;
1096         #endif
1097         StaticListItem_t        xDummy3[ 2 ];
1098         UBaseType_t                     uxDummy5;
1099         void                            *pxDummy6;
1100         uint8_t                         ucDummy7[ configMAX_TASK_NAME_LEN ];
1101         #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )
1102                 void                    *pxDummy8;
1103         #endif
1104         #if ( portCRITICAL_NESTING_IN_TCB == 1 )
1105                 UBaseType_t             uxDummy9;
1106         #endif
1107         #if ( configUSE_TRACE_FACILITY == 1 )
1108                 UBaseType_t             uxDummy10[ 2 ];
1109         #endif
1110         #if ( configUSE_MUTEXES == 1 )
1111                 UBaseType_t             uxDummy12[ 2 ];
1112         #endif
1113         #if ( configUSE_APPLICATION_TASK_TAG == 1 )
1114                 void                    *pxDummy14;
1115         #endif
1116         #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )
1117                 void                    *pvDummy15[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];
1118         #endif
1119         #if ( configGENERATE_RUN_TIME_STATS == 1 )
1120                 uint32_t                ulDummy16;
1121         #endif
1122         #if ( configUSE_NEWLIB_REENTRANT == 1 )
1123                 struct  _reent  xDummy17;
1124         #endif
1125         #if ( configUSE_TASK_NOTIFICATIONS == 1 )
1126                 uint32_t                ulDummy18;
1127                 uint8_t                 ucDummy19;
1128         #endif
1129         #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )
1130                 uint8_t                 uxDummy20;
1131         #endif
1132
1133         #if( INCLUDE_xTaskAbortDelay == 1 )
1134                 uint8_t ucDummy21;
1135         #endif
1136         #if ( configUSE_POSIX_ERRNO == 1 )
1137                 int                             iDummy22;
1138         #endif
1139 } StaticTask_t;
1140
1141 /*
1142  * In line with software engineering best practice, especially when supplying a
1143  * library that is likely to change in future versions, FreeRTOS implements a
1144  * strict data hiding policy.  This means the Queue structure used internally by
1145  * FreeRTOS is not accessible to application code.  However, if the application
1146  * writer wants to statically allocate the memory required to create a queue
1147  * then the size of the queue object needs to be know.  The StaticQueue_t
1148  * structure below is provided for this purpose.  Its sizes and alignment
1149  * requirements are guaranteed to match those of the genuine structure, no
1150  * matter which architecture is being used, and no matter how the values in
1151  * FreeRTOSConfig.h are set.  Its contents are somewhat obfuscated in the hope
1152  * users will recognise that it would be unwise to make direct use of the
1153  * structure members.
1154  */
1155 typedef struct xSTATIC_QUEUE
1156 {
1157         void *pvDummy1[ 3 ];
1158
1159         union
1160         {
1161                 void *pvDummy2;
1162                 UBaseType_t uxDummy2;
1163         } u;
1164
1165         StaticList_t xDummy3[ 2 ];
1166         UBaseType_t uxDummy4[ 3 ];
1167         uint8_t ucDummy5[ 2 ];
1168
1169         #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
1170                 uint8_t ucDummy6;
1171         #endif
1172
1173         #if ( configUSE_QUEUE_SETS == 1 )
1174                 void *pvDummy7;
1175         #endif
1176
1177         #if ( configUSE_TRACE_FACILITY == 1 )
1178                 UBaseType_t uxDummy8;
1179                 uint8_t ucDummy9;
1180         #endif
1181
1182 } StaticQueue_t;
1183 typedef StaticQueue_t StaticSemaphore_t;
1184
1185 /*
1186  * In line with software engineering best practice, especially when supplying a
1187  * library that is likely to change in future versions, FreeRTOS implements a
1188  * strict data hiding policy.  This means the event group structure used
1189  * internally by FreeRTOS is not accessible to application code.  However, if
1190  * the application writer wants to statically allocate the memory required to
1191  * create an event group then the size of the event group object needs to be
1192  * know.  The StaticEventGroup_t structure below is provided for this purpose.
1193  * Its sizes and alignment requirements are guaranteed to match those of the
1194  * genuine structure, no matter which architecture is being used, and no matter
1195  * how the values in FreeRTOSConfig.h are set.  Its contents are somewhat
1196  * obfuscated in the hope users will recognise that it would be unwise to make
1197  * direct use of the structure members.
1198  */
1199 typedef struct xSTATIC_EVENT_GROUP
1200 {
1201         TickType_t xDummy1;
1202         StaticList_t xDummy2;
1203
1204         #if( configUSE_TRACE_FACILITY == 1 )
1205                 UBaseType_t uxDummy3;
1206         #endif
1207
1208         #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
1209                         uint8_t ucDummy4;
1210         #endif
1211
1212 } StaticEventGroup_t;
1213
1214 /*
1215  * In line with software engineering best practice, especially when supplying a
1216  * library that is likely to change in future versions, FreeRTOS implements a
1217  * strict data hiding policy.  This means the software timer structure used
1218  * internally by FreeRTOS is not accessible to application code.  However, if
1219  * the application writer wants to statically allocate the memory required to
1220  * create a software timer then the size of the queue object needs to be know.
1221  * The StaticTimer_t structure below is provided for this purpose.  Its sizes
1222  * and alignment requirements are guaranteed to match those of the genuine
1223  * structure, no matter which architecture is being used, and no matter how the
1224  * values in FreeRTOSConfig.h are set.  Its contents are somewhat obfuscated in
1225  * the hope users will recognise that it would be unwise to make direct use of
1226  * the structure members.
1227  */
1228 typedef struct xSTATIC_TIMER
1229 {
1230         void                            *pvDummy1;
1231         StaticListItem_t        xDummy2;
1232         TickType_t                      xDummy3;
1233         void                            *pvDummy5;
1234         TaskFunction_t          pvDummy6;
1235         #if( configUSE_TRACE_FACILITY == 1 )
1236                 UBaseType_t             uxDummy7;
1237         #endif
1238         uint8_t                         ucDummy8;
1239
1240 } StaticTimer_t;
1241
1242 /*
1243 * In line with software engineering best practice, especially when supplying a
1244 * library that is likely to change in future versions, FreeRTOS implements a
1245 * strict data hiding policy.  This means the stream buffer structure used
1246 * internally by FreeRTOS is not accessible to application code.  However, if
1247 * the application writer wants to statically allocate the memory required to
1248 * create a stream buffer then the size of the stream buffer object needs to be
1249 * know.  The StaticStreamBuffer_t structure below is provided for this purpose.
1250 * Its size and alignment requirements are guaranteed to match those of the
1251 * genuine structure, no matter which architecture is being used, and no matter
1252 * how the values in FreeRTOSConfig.h are set.  Its contents are somewhat
1253 * obfuscated in the hope users will recognise that it would be unwise to make
1254 * direct use of the structure members.
1255 */
1256 typedef struct xSTATIC_STREAM_BUFFER
1257 {
1258         size_t uxDummy1[ 4 ];
1259         void * pvDummy2[ 3 ];
1260         uint8_t ucDummy3;
1261         #if ( configUSE_TRACE_FACILITY == 1 )
1262                 UBaseType_t uxDummy4;
1263         #endif
1264 } StaticStreamBuffer_t;
1265
1266 /* Message buffers are built on stream buffers. */
1267 typedef StaticStreamBuffer_t StaticMessageBuffer_t;
1268
1269 #ifdef __cplusplus
1270 }
1271 #endif
1272
1273 #endif /* INC_FREERTOS_H */
1274