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