blob: cddd87e44cb7d26748dd77b82877402d8cc40b39 [file] [log] [blame]
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001/*
xiaohu.huang4f321fb2024-03-22 14:50:29 +08002 * FreeRTOS Kernel V10.2.1
3 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08004 *
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 *
xiaohu.huang4f321fb2024-03-22 14:50:29 +080022 * http://www.FreeRTOS.org
23 * http://aws.amazon.com/freertos
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080024 *
xiaohu.huang4f321fb2024-03-22 14:50:29 +080025 * 1 tab == 4 spaces!
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080026 */
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
xiaohu.huang4f321fb2024-03-22 14:50:29 +080052extern "C" {
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080053#endif
54
55/* Application specific configuration options. */
56#include "FreeRTOSConfig.h"
57
xiaohu.huang4f321fb2024-03-22 14:50:29 +080058/* Add the extended interfaces for AML */
59#include "aml_ext_interfaces.h"
60
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080061/* Basic FreeRTOS definitions. */
62#include "projdefs.h"
63
64/* Definitions specific to the port being used. */
65#include "portable.h"
66
67/* Must be defaulted before configUSE_NEWLIB_REENTRANT is used below. */
68#ifndef configUSE_NEWLIB_REENTRANT
xiaohu.huang4f321fb2024-03-22 14:50:29 +080069 #define configUSE_NEWLIB_REENTRANT 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080070#endif
71
72/* Required if struct _reent is used. */
73#if ( configUSE_NEWLIB_REENTRANT == 1 )
xiaohu.huang4f321fb2024-03-22 14:50:29 +080074 #include <reent.h>
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080075#endif
shijie.xiong39d66992023-09-15 16:08:38 +080076
xiaohu.huang4f321fb2024-03-22 14:50:29 +080077#ifdef CONFIG_BARECTF
78#include "freertos-trace.h"
79#endif
shijie.xiong39d66992023-09-15 16:08:38 +080080
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080081/*
82 * Check all the required application specific macros have been defined.
83 * These macros are application specific and (as downloaded) are defined
84 * within FreeRTOSConfig.h.
85 */
86
87#ifndef configMINIMAL_STACK_SIZE
xiaohu.huang4f321fb2024-03-22 14:50:29 +080088 #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.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080089#endif
90
91#ifndef configMAX_PRIORITIES
xiaohu.huang4f321fb2024-03-22 14:50:29 +080092 #error Missing definition: configMAX_PRIORITIES must be defined in FreeRTOSConfig.h. See the Configuration section of the FreeRTOS API documentation for details.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080093#endif
94
95#if configMAX_PRIORITIES < 1
xiaohu.huang4f321fb2024-03-22 14:50:29 +080096 #error configMAX_PRIORITIES must be defined to be greater than or equal to 1.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +080097#endif
98
99#ifndef configUSE_PREEMPTION
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800100 #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.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800101#endif
102
103#ifndef configUSE_IDLE_HOOK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800104 #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.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800105#endif
106
107#ifndef configUSE_TICK_HOOK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800108 #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.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800109#endif
110
111#ifndef configUSE_16_BIT_TICKS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800112 #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.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800113#endif
114
115#ifndef configUSE_CO_ROUTINES
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800116 #define configUSE_CO_ROUTINES 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800117#endif
118
119#ifndef INCLUDE_vTaskPrioritySet
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800120 #define INCLUDE_vTaskPrioritySet 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800121#endif
122
123#ifndef INCLUDE_uxTaskPriorityGet
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800124 #define INCLUDE_uxTaskPriorityGet 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800125#endif
126
127#ifndef INCLUDE_vTaskDelete
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800128 #define INCLUDE_vTaskDelete 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800129#endif
130
131#ifndef INCLUDE_vTaskSuspend
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800132 #define INCLUDE_vTaskSuspend 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800133#endif
134
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800135#ifndef INCLUDE_vTaskDelayUntil
136 #define INCLUDE_vTaskDelayUntil 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800137#endif
138
139#ifndef INCLUDE_vTaskDelay
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800140 #define INCLUDE_vTaskDelay 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800141#endif
142
143#ifndef INCLUDE_xTaskGetIdleTaskHandle
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800144 #define INCLUDE_xTaskGetIdleTaskHandle 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800145#endif
146
147#ifndef INCLUDE_xTaskAbortDelay
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800148 #define INCLUDE_xTaskAbortDelay 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800149#endif
150
151#ifndef INCLUDE_xQueueGetMutexHolder
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800152 #define INCLUDE_xQueueGetMutexHolder 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800153#endif
154
155#ifndef INCLUDE_xSemaphoreGetMutexHolder
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800156 #define INCLUDE_xSemaphoreGetMutexHolder INCLUDE_xQueueGetMutexHolder
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800157#endif
158
159#ifndef INCLUDE_xTaskGetHandle
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800160 #define INCLUDE_xTaskGetHandle 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800161#endif
162
163#ifndef INCLUDE_uxTaskGetStackHighWaterMark
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800164 #define INCLUDE_uxTaskGetStackHighWaterMark 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800165#endif
166
167#ifndef INCLUDE_uxTaskGetStackHighWaterMark2
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800168 #define INCLUDE_uxTaskGetStackHighWaterMark2 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800169#endif
170
171#ifndef INCLUDE_eTaskGetState
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800172 #define INCLUDE_eTaskGetState 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800173#endif
174
175#ifndef INCLUDE_xTaskResumeFromISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800176 #define INCLUDE_xTaskResumeFromISR 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800177#endif
178
179#ifndef INCLUDE_xTimerPendFunctionCall
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800180 #define INCLUDE_xTimerPendFunctionCall 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800181#endif
182
183#ifndef INCLUDE_xTaskGetSchedulerState
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800184 #define INCLUDE_xTaskGetSchedulerState 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800185#endif
186
187#ifndef INCLUDE_xTaskGetCurrentTaskHandle
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800188 #define INCLUDE_xTaskGetCurrentTaskHandle 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800189#endif
190
191#if configUSE_CO_ROUTINES != 0
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800192 #ifndef configMAX_CO_ROUTINE_PRIORITIES
193 #error configMAX_CO_ROUTINE_PRIORITIES must be greater than or equal to 1.
194 #endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800195#endif
196
197#ifndef configUSE_DAEMON_TASK_STARTUP_HOOK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800198 #define configUSE_DAEMON_TASK_STARTUP_HOOK 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800199#endif
200
201#ifndef configUSE_APPLICATION_TASK_TAG
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800202 #define configUSE_APPLICATION_TASK_TAG 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800203#endif
204
205#ifndef configNUM_THREAD_LOCAL_STORAGE_POINTERS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800206 #define configNUM_THREAD_LOCAL_STORAGE_POINTERS 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800207#endif
208
209#ifndef configUSE_RECURSIVE_MUTEXES
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800210 #define configUSE_RECURSIVE_MUTEXES 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800211#endif
212
213#ifndef configUSE_MUTEXES
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800214 #define configUSE_MUTEXES 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800215#endif
216
217#ifndef configUSE_TIMERS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800218 #define configUSE_TIMERS 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800219#endif
220
221#ifndef configUSE_COUNTING_SEMAPHORES
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800222 #define configUSE_COUNTING_SEMAPHORES 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800223#endif
224
225#ifndef configUSE_ALTERNATIVE_API
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800226 #define configUSE_ALTERNATIVE_API 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800227#endif
228
229#ifndef portCRITICAL_NESTING_IN_TCB
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800230 #define portCRITICAL_NESTING_IN_TCB 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800231#endif
232
233#ifndef configMAX_TASK_NAME_LEN
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800234 #define configMAX_TASK_NAME_LEN 16
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800235#endif
236
237#ifndef configIDLE_SHOULD_YIELD
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800238 #define configIDLE_SHOULD_YIELD 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800239#endif
240
241#if configMAX_TASK_NAME_LEN < 1
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800242 #error configMAX_TASK_NAME_LEN must be set to a minimum of 1 in FreeRTOSConfig.h
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800243#endif
244
245#ifndef configASSERT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800246 #define configASSERT( x )
247 #define configASSERT_DEFINED 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800248#else
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800249 #define configASSERT_DEFINED 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800250#endif
251
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800252#ifndef portMEMORY_BARRIER
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800253 #define portMEMORY_BARRIER()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800254#endif
255
256/* The timers module relies on xTaskGetSchedulerState(). */
257#if configUSE_TIMERS == 1
258
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800259 #ifndef configTIMER_TASK_PRIORITY
260 #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_PRIORITY must also be defined.
261 #endif /* configTIMER_TASK_PRIORITY */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800262
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800263 #ifndef configTIMER_QUEUE_LENGTH
264 #error If configUSE_TIMERS is set to 1 then configTIMER_QUEUE_LENGTH must also be defined.
265 #endif /* configTIMER_QUEUE_LENGTH */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800266
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800267 #ifndef configTIMER_TASK_STACK_DEPTH
268 #error If configUSE_TIMERS is set to 1 then configTIMER_TASK_STACK_DEPTH must also be defined.
269 #endif /* configTIMER_TASK_STACK_DEPTH */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800270
271#endif /* configUSE_TIMERS */
272
273#ifndef portSET_INTERRUPT_MASK_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800274 #define portSET_INTERRUPT_MASK_FROM_ISR() 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800275#endif
276
277#ifndef portCLEAR_INTERRUPT_MASK_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800278 #define portCLEAR_INTERRUPT_MASK_FROM_ISR( uxSavedStatusValue ) ( void ) uxSavedStatusValue
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800279#endif
280
281#ifndef portCLEAN_UP_TCB
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800282 #define portCLEAN_UP_TCB( pxTCB ) ( void ) pxTCB
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800283#endif
284
285#ifndef portPRE_TASK_DELETE_HOOK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800286 #define portPRE_TASK_DELETE_HOOK( pvTaskToDelete, pxYieldPending )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800287#endif
288
289#ifndef portSETUP_TCB
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800290 #define portSETUP_TCB( pxTCB ) ( void ) pxTCB
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800291#endif
292
293#ifndef configQUEUE_REGISTRY_SIZE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800294 #define configQUEUE_REGISTRY_SIZE 0U
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800295#endif
296
297#if ( configQUEUE_REGISTRY_SIZE < 1 )
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800298 #define vQueueAddToRegistry( xQueue, pcName )
299 #define vQueueUnregisterQueue( xQueue )
300 #define pcQueueGetName( xQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800301#endif
302
303#ifndef portPOINTER_SIZE_TYPE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800304 #define portPOINTER_SIZE_TYPE uint32_t
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800305#endif
306
307/* Remove any unused trace macros. */
308#ifndef traceSTART
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800309 /* Used to perform any necessary initialisation - for example, open a file
310 into which trace is to be written. */
311 #define traceSTART()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800312#endif
313
314#ifndef traceEND
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800315 /* Use to close a trace, for example close a file into which trace has been
316 written. */
317 #define traceEND()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800318#endif
319
320#ifndef traceTASK_SWITCHED_IN
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800321 /* Called after a task has been selected to run. pxCurrentTCB holds a pointer
322 to the task control block of the selected task. */
323 #define traceTASK_SWITCHED_IN()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800324#endif
325
326#ifndef traceINCREASE_TICK_COUNT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800327 /* Called before stepping the tick count after waking from tickless idle
328 sleep. */
329 #define traceINCREASE_TICK_COUNT( x )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800330#endif
331
332#ifndef traceLOW_POWER_IDLE_BEGIN
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800333 /* Called immediately before entering tickless idle. */
334 #define traceLOW_POWER_IDLE_BEGIN()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800335#endif
336
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800337#ifndef traceLOW_POWER_IDLE_END
338 /* Called when returning to the Idle task after a tickless idle. */
339 #define traceLOW_POWER_IDLE_END()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800340#endif
341
342#ifndef traceTASK_SWITCHED_OUT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800343 /* Called before a task has been selected to run. pxCurrentTCB holds a pointer
344 to the task control block of the task being switched out. */
345 #define traceTASK_SWITCHED_OUT()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800346#endif
347
348#ifndef traceTASK_PRIORITY_INHERIT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800349 /* Called when a task attempts to take a mutex that is already held by a
350 lower priority task. pxTCBOfMutexHolder is a pointer to the TCB of the task
351 that holds the mutex. uxInheritedPriority is the priority the mutex holder
352 will inherit (the priority of the task that is attempting to obtain the
353 muted. */
354 #define traceTASK_PRIORITY_INHERIT( pxTCBOfMutexHolder, uxInheritedPriority )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800355#endif
356
357#ifndef traceTASK_PRIORITY_DISINHERIT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800358 /* Called when a task releases a mutex, the holding of which had resulted in
359 the task inheriting the priority of a higher priority task.
360 pxTCBOfMutexHolder is a pointer to the TCB of the task that is releasing the
361 mutex. uxOriginalPriority is the task's configured (base) priority. */
362 #define traceTASK_PRIORITY_DISINHERIT( pxTCBOfMutexHolder, uxOriginalPriority )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800363#endif
364
365#ifndef traceBLOCKING_ON_QUEUE_RECEIVE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800366 /* Task is about to block because it cannot read from a
367 queue/mutex/semaphore. pxQueue is a pointer to the queue/mutex/semaphore
368 upon which the read was attempted. pxCurrentTCB points to the TCB of the
369 task that attempted the read. */
370 #define traceBLOCKING_ON_QUEUE_RECEIVE( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800371#endif
372
373#ifndef traceBLOCKING_ON_QUEUE_PEEK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800374 /* Task is about to block because it cannot read from a
375 queue/mutex/semaphore. pxQueue is a pointer to the queue/mutex/semaphore
376 upon which the read was attempted. pxCurrentTCB points to the TCB of the
377 task that attempted the read. */
378 #define traceBLOCKING_ON_QUEUE_PEEK( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800379#endif
380
381#ifndef traceBLOCKING_ON_QUEUE_SEND
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800382 /* Task is about to block because it cannot write to a
383 queue/mutex/semaphore. pxQueue is a pointer to the queue/mutex/semaphore
384 upon which the write was attempted. pxCurrentTCB points to the TCB of the
385 task that attempted the write. */
386 #define traceBLOCKING_ON_QUEUE_SEND( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800387#endif
388
389#ifndef configCHECK_FOR_STACK_OVERFLOW
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800390 #define configCHECK_FOR_STACK_OVERFLOW 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800391#endif
392
393#ifndef configRECORD_STACK_HIGH_ADDRESS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800394 #define configRECORD_STACK_HIGH_ADDRESS 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800395#endif
396
397#ifndef configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800398 #define configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800399#endif
400
401/* The following event macros are embedded in the kernel API calls. */
402
403#ifndef traceMOVED_TASK_TO_READY_STATE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800404 #define traceMOVED_TASK_TO_READY_STATE( pxTCB )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800405#endif
406
407#ifndef tracePOST_MOVED_TASK_TO_READY_STATE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800408 #define tracePOST_MOVED_TASK_TO_READY_STATE( pxTCB )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800409#endif
410
411#ifndef traceQUEUE_CREATE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800412 #define traceQUEUE_CREATE( pxNewQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800413#endif
414
415#ifndef traceQUEUE_CREATE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800416 #define traceQUEUE_CREATE_FAILED( ucQueueType )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800417#endif
418
419#ifndef traceCREATE_MUTEX
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800420 #define traceCREATE_MUTEX( pxNewQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800421#endif
422
423#ifndef traceCREATE_MUTEX_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800424 #define traceCREATE_MUTEX_FAILED()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800425#endif
426
427#ifndef traceGIVE_MUTEX_RECURSIVE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800428 #define traceGIVE_MUTEX_RECURSIVE( pxMutex )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800429#endif
430
431#ifndef traceGIVE_MUTEX_RECURSIVE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800432 #define traceGIVE_MUTEX_RECURSIVE_FAILED( pxMutex )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800433#endif
434
435#ifndef traceTAKE_MUTEX_RECURSIVE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800436 #define traceTAKE_MUTEX_RECURSIVE( pxMutex )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800437#endif
438
439#ifndef traceTAKE_MUTEX_RECURSIVE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800440 #define traceTAKE_MUTEX_RECURSIVE_FAILED( pxMutex )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800441#endif
442
443#ifndef traceCREATE_COUNTING_SEMAPHORE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800444 #define traceCREATE_COUNTING_SEMAPHORE()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800445#endif
446
447#ifndef traceCREATE_COUNTING_SEMAPHORE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800448 #define traceCREATE_COUNTING_SEMAPHORE_FAILED()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800449#endif
450
451#ifndef traceQUEUE_SEND
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800452 #define traceQUEUE_SEND( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800453#endif
454
455#ifndef traceQUEUE_SEND_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800456 #define traceQUEUE_SEND_FAILED( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800457#endif
458
459#ifndef traceQUEUE_RECEIVE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800460 #define traceQUEUE_RECEIVE( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800461#endif
462
463#ifndef traceQUEUE_PEEK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800464 #define traceQUEUE_PEEK( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800465#endif
466
467#ifndef traceQUEUE_PEEK_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800468 #define traceQUEUE_PEEK_FAILED( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800469#endif
470
471#ifndef traceQUEUE_PEEK_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800472 #define traceQUEUE_PEEK_FROM_ISR( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800473#endif
474
475#ifndef traceQUEUE_RECEIVE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800476 #define traceQUEUE_RECEIVE_FAILED( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800477#endif
478
479#ifndef traceQUEUE_SEND_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800480 #define traceQUEUE_SEND_FROM_ISR( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800481#endif
482
483#ifndef traceQUEUE_SEND_FROM_ISR_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800484 #define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800485#endif
486
487#ifndef traceQUEUE_RECEIVE_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800488 #define traceQUEUE_RECEIVE_FROM_ISR( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800489#endif
490
491#ifndef traceQUEUE_RECEIVE_FROM_ISR_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800492 #define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800493#endif
494
495#ifndef traceQUEUE_PEEK_FROM_ISR_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800496 #define traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800497#endif
498
499#ifndef traceQUEUE_DELETE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800500 #define traceQUEUE_DELETE( pxQueue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800501#endif
502
503#ifndef traceTASK_CREATE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800504 #define traceTASK_CREATE( pxNewTCB )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800505#endif
506
507#ifndef traceTASK_CREATE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800508 #define traceTASK_CREATE_FAILED()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800509#endif
510
511#ifndef traceTASK_DELETE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800512 #define traceTASK_DELETE( pxTaskToDelete )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800513#endif
514
515#ifndef traceTASK_DELAY_UNTIL
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800516 #define traceTASK_DELAY_UNTIL( x )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800517#endif
518
519#ifndef traceTASK_DELAY
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800520 #define traceTASK_DELAY()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800521#endif
522
523#ifndef traceTASK_PRIORITY_SET
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800524 #define traceTASK_PRIORITY_SET( pxTask, uxNewPriority )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800525#endif
526
527#ifndef traceTASK_SUSPEND
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800528 #define traceTASK_SUSPEND( pxTaskToSuspend )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800529#endif
530
531#ifndef traceTASK_RESUME
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800532 #define traceTASK_RESUME( pxTaskToResume )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800533#endif
534
535#ifndef traceTASK_RESUME_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800536 #define traceTASK_RESUME_FROM_ISR( pxTaskToResume )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800537#endif
538
539#ifndef traceTASK_INCREMENT_TICK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800540 #define traceTASK_INCREMENT_TICK( xTickCount )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800541#endif
542
543#ifndef traceTIMER_CREATE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800544 #define traceTIMER_CREATE( pxNewTimer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800545#endif
546
547#ifndef traceTIMER_CREATE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800548 #define traceTIMER_CREATE_FAILED()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800549#endif
550
551#ifndef traceTIMER_COMMAND_SEND
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800552 #define traceTIMER_COMMAND_SEND( xTimer, xMessageID, xMessageValueValue, xReturn )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800553#endif
554
555#ifndef traceTIMER_EXPIRED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800556 #define traceTIMER_EXPIRED( pxTimer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800557#endif
558
559#ifndef traceTIMER_COMMAND_RECEIVED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800560 #define traceTIMER_COMMAND_RECEIVED( pxTimer, xMessageID, xMessageValue )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800561#endif
562
563#ifndef traceMALLOC
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800564 #define traceMALLOC( pvAddress, uiSize ) // printf("debug alloc %p %8u %8u\n", pvAddress, uiSize, xPortGetFreeHeapSize())
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800565#endif
566
567#ifndef traceFREE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800568 #define traceFREE( pvAddress, uiSize ) // printf("debug free %p %8u %8u\n", pvAddress, uiSize, xPortGetFreeHeapSize())
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800569#endif
570
571#ifndef traceEVENT_GROUP_CREATE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800572 #define traceEVENT_GROUP_CREATE( xEventGroup )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800573#endif
574
575#ifndef traceEVENT_GROUP_CREATE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800576 #define traceEVENT_GROUP_CREATE_FAILED()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800577#endif
578
579#ifndef traceEVENT_GROUP_SYNC_BLOCK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800580 #define traceEVENT_GROUP_SYNC_BLOCK( xEventGroup, uxBitsToSet, uxBitsToWaitFor )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800581#endif
582
583#ifndef traceEVENT_GROUP_SYNC_END
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800584 #define traceEVENT_GROUP_SYNC_END( xEventGroup, uxBitsToSet, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800585#endif
586
587#ifndef traceEVENT_GROUP_WAIT_BITS_BLOCK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800588 #define traceEVENT_GROUP_WAIT_BITS_BLOCK( xEventGroup, uxBitsToWaitFor )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800589#endif
590
591#ifndef traceEVENT_GROUP_WAIT_BITS_END
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800592 #define traceEVENT_GROUP_WAIT_BITS_END( xEventGroup, uxBitsToWaitFor, xTimeoutOccurred ) ( void ) xTimeoutOccurred
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800593#endif
594
595#ifndef traceEVENT_GROUP_CLEAR_BITS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800596 #define traceEVENT_GROUP_CLEAR_BITS( xEventGroup, uxBitsToClear )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800597#endif
598
599#ifndef traceEVENT_GROUP_CLEAR_BITS_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800600 #define traceEVENT_GROUP_CLEAR_BITS_FROM_ISR( xEventGroup, uxBitsToClear )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800601#endif
602
603#ifndef traceEVENT_GROUP_SET_BITS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800604 #define traceEVENT_GROUP_SET_BITS( xEventGroup, uxBitsToSet )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800605#endif
606
607#ifndef traceEVENT_GROUP_SET_BITS_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800608 #define traceEVENT_GROUP_SET_BITS_FROM_ISR( xEventGroup, uxBitsToSet )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800609#endif
610
611#ifndef traceEVENT_GROUP_DELETE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800612 #define traceEVENT_GROUP_DELETE( xEventGroup )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800613#endif
614
615#ifndef tracePEND_FUNC_CALL
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800616 #define tracePEND_FUNC_CALL(xFunctionToPend, pvParameter1, ulParameter2, ret)
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800617#endif
618
619#ifndef tracePEND_FUNC_CALL_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800620 #define tracePEND_FUNC_CALL_FROM_ISR(xFunctionToPend, pvParameter1, ulParameter2, ret)
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800621#endif
622
623#ifndef traceQUEUE_REGISTRY_ADD
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800624 #define traceQUEUE_REGISTRY_ADD(xQueue, pcQueueName)
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800625#endif
626
627#ifndef traceTASK_NOTIFY_TAKE_BLOCK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800628 #define traceTASK_NOTIFY_TAKE_BLOCK()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800629#endif
630
631#ifndef traceTASK_NOTIFY_TAKE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800632 #define traceTASK_NOTIFY_TAKE()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800633#endif
634
635#ifndef traceTASK_NOTIFY_WAIT_BLOCK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800636 #define traceTASK_NOTIFY_WAIT_BLOCK()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800637#endif
638
639#ifndef traceTASK_NOTIFY_WAIT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800640 #define traceTASK_NOTIFY_WAIT()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800641#endif
642
643#ifndef traceTASK_NOTIFY
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800644 #define traceTASK_NOTIFY()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800645#endif
646
647#ifndef traceTASK_NOTIFY_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800648 #define traceTASK_NOTIFY_FROM_ISR()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800649#endif
650
651#ifndef traceTASK_NOTIFY_GIVE_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800652 #define traceTASK_NOTIFY_GIVE_FROM_ISR()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800653#endif
654
655#ifndef traceSTREAM_BUFFER_CREATE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800656 #define traceSTREAM_BUFFER_CREATE_FAILED( xIsMessageBuffer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800657#endif
658
659#ifndef traceSTREAM_BUFFER_CREATE_STATIC_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800660 #define traceSTREAM_BUFFER_CREATE_STATIC_FAILED( xReturn, xIsMessageBuffer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800661#endif
662
663#ifndef traceSTREAM_BUFFER_CREATE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800664 #define traceSTREAM_BUFFER_CREATE( pxStreamBuffer, xIsMessageBuffer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800665#endif
666
667#ifndef traceSTREAM_BUFFER_DELETE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800668 #define traceSTREAM_BUFFER_DELETE( xStreamBuffer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800669#endif
670
671#ifndef traceSTREAM_BUFFER_RESET
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800672 #define traceSTREAM_BUFFER_RESET( xStreamBuffer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800673#endif
674
675#ifndef traceBLOCKING_ON_STREAM_BUFFER_SEND
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800676 #define traceBLOCKING_ON_STREAM_BUFFER_SEND( xStreamBuffer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800677#endif
678
679#ifndef traceSTREAM_BUFFER_SEND
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800680 #define traceSTREAM_BUFFER_SEND( xStreamBuffer, xBytesSent )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800681#endif
682
683#ifndef traceSTREAM_BUFFER_SEND_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800684 #define traceSTREAM_BUFFER_SEND_FAILED( xStreamBuffer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800685#endif
686
687#ifndef traceSTREAM_BUFFER_SEND_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800688 #define traceSTREAM_BUFFER_SEND_FROM_ISR( xStreamBuffer, xBytesSent )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800689#endif
690
691#ifndef traceBLOCKING_ON_STREAM_BUFFER_RECEIVE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800692 #define traceBLOCKING_ON_STREAM_BUFFER_RECEIVE( xStreamBuffer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800693#endif
694
695#ifndef traceSTREAM_BUFFER_RECEIVE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800696 #define traceSTREAM_BUFFER_RECEIVE( xStreamBuffer, xReceivedLength )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800697#endif
698
699#ifndef traceSTREAM_BUFFER_RECEIVE_FAILED
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800700 #define traceSTREAM_BUFFER_RECEIVE_FAILED( xStreamBuffer )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800701#endif
702
703#ifndef traceSTREAM_BUFFER_RECEIVE_FROM_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800704 #define traceSTREAM_BUFFER_RECEIVE_FROM_ISR( xStreamBuffer, xReceivedLength )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800705#endif
706
707#ifndef configGENERATE_RUN_TIME_STATS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800708 #define configGENERATE_RUN_TIME_STATS 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800709#endif
710
711#if ( configGENERATE_RUN_TIME_STATS == 1 )
712
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800713 #ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS
714 #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.
715 #endif /* portCONFIGURE_TIMER_FOR_RUN_TIME_STATS */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800716
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800717 #ifndef portGET_RUN_TIME_COUNTER_VALUE
718 #ifndef portALT_GET_RUN_TIME_COUNTER_VALUE
719 #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.
720 #endif /* portALT_GET_RUN_TIME_COUNTER_VALUE */
721 #endif /* portGET_RUN_TIME_COUNTER_VALUE */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800722
723#endif /* configGENERATE_RUN_TIME_STATS */
724
725#ifndef portCONFIGURE_TIMER_FOR_RUN_TIME_STATS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800726 #define portCONFIGURE_TIMER_FOR_RUN_TIME_STATS()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800727#endif
728
729#ifndef configUSE_MALLOC_FAILED_HOOK
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800730 #define configUSE_MALLOC_FAILED_HOOK 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800731#endif
732
733#ifndef portPRIVILEGE_BIT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800734 #define portPRIVILEGE_BIT ( ( UBaseType_t ) 0x00 )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800735#endif
736
737#ifndef portYIELD_WITHIN_API
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800738 #define portYIELD_WITHIN_API portYIELD
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800739#endif
740
741#ifndef portSUPPRESS_TICKS_AND_SLEEP
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800742 #define portSUPPRESS_TICKS_AND_SLEEP( xExpectedIdleTime )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800743#endif
744
745#ifndef configEXPECTED_IDLE_TIME_BEFORE_SLEEP
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800746 #define configEXPECTED_IDLE_TIME_BEFORE_SLEEP 2
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800747#endif
748
749#if configEXPECTED_IDLE_TIME_BEFORE_SLEEP < 2
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800750 #error configEXPECTED_IDLE_TIME_BEFORE_SLEEP must not be less than 2
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800751#endif
752
753#ifndef configUSE_TICKLESS_IDLE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800754 #define configUSE_TICKLESS_IDLE 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800755#endif
756
757#ifndef configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800758 #define configPRE_SUPPRESS_TICKS_AND_SLEEP_PROCESSING( x )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800759#endif
760
761#ifndef configPRE_SLEEP_PROCESSING
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800762 #define configPRE_SLEEP_PROCESSING( x )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800763#endif
764
765#ifndef configPOST_SLEEP_PROCESSING
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800766 #define configPOST_SLEEP_PROCESSING( x )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800767#endif
768
769#ifndef configUSE_QUEUE_SETS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800770 #define configUSE_QUEUE_SETS 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800771#endif
772
773#ifndef portTASK_USES_FLOATING_POINT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800774 #define portTASK_USES_FLOATING_POINT()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800775#endif
776
777#ifndef portALLOCATE_SECURE_CONTEXT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800778 #define portALLOCATE_SECURE_CONTEXT( ulSecureStackSize )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800779#endif
780
781#ifndef portDONT_DISCARD
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800782 #define portDONT_DISCARD
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800783#endif
784
785#ifndef configUSE_TIME_SLICING
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800786 #define configUSE_TIME_SLICING 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800787#endif
788
789#ifndef configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800790 #define configINCLUDE_APPLICATION_DEFINED_PRIVILEGED_FUNCTIONS 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800791#endif
792
793#ifndef configUSE_STATS_FORMATTING_FUNCTIONS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800794 #define configUSE_STATS_FORMATTING_FUNCTIONS 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800795#endif
796
797#ifndef portASSERT_IF_INTERRUPT_PRIORITY_INVALID
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800798 #define portASSERT_IF_INTERRUPT_PRIORITY_INVALID()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800799#endif
800
801#ifndef configUSE_TRACE_FACILITY
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800802 #define configUSE_TRACE_FACILITY 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800803#endif
804
805#ifndef mtCOVERAGE_TEST_MARKER
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800806 #define mtCOVERAGE_TEST_MARKER()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800807#endif
808
809#ifndef mtCOVERAGE_TEST_DELAY
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800810 #define mtCOVERAGE_TEST_DELAY()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800811#endif
812
813#ifndef portASSERT_IF_IN_ISR
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800814 #define portASSERT_IF_IN_ISR()
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800815#endif
816
817#ifndef configUSE_PORT_OPTIMISED_TASK_SELECTION
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800818 #define configUSE_PORT_OPTIMISED_TASK_SELECTION 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800819#endif
820
821#ifndef configAPPLICATION_ALLOCATED_HEAP
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800822 #define configAPPLICATION_ALLOCATED_HEAP 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800823#endif
824
825#ifndef configUSE_TASK_NOTIFICATIONS
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800826 #define configUSE_TASK_NOTIFICATIONS 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800827#endif
828
829#ifndef configUSE_POSIX_ERRNO
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800830 #define configUSE_POSIX_ERRNO 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800831#endif
832
833#ifndef portTICK_TYPE_IS_ATOMIC
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800834 #define portTICK_TYPE_IS_ATOMIC 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800835#endif
836
837#ifndef configSUPPORT_STATIC_ALLOCATION
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800838 /* Defaults to 0 for backward compatibility. */
839 #define configSUPPORT_STATIC_ALLOCATION 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800840#endif
841
842#ifndef configSUPPORT_DYNAMIC_ALLOCATION
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800843 /* Defaults to 1 for backward compatibility. */
844 #define configSUPPORT_DYNAMIC_ALLOCATION 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800845#endif
846
847#ifndef configSTACK_DEPTH_TYPE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800848 /* Defaults to uint16_t for backward compatibility, but can be overridden
849 in FreeRTOSConfig.h if uint16_t is too restrictive. */
850 #define configSTACK_DEPTH_TYPE uint16_t
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800851#endif
852
853#ifndef configMESSAGE_BUFFER_LENGTH_TYPE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800854 /* Defaults to size_t for backward compatibility, but can be overridden
855 in FreeRTOSConfig.h if lengths will always be less than the number of bytes
856 in a size_t. */
857 #define configMESSAGE_BUFFER_LENGTH_TYPE size_t
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800858#endif
859
860/* Sanity check the configuration. */
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800861#if( configUSE_TICKLESS_IDLE != 0 )
862 #if( INCLUDE_vTaskSuspend != 1 )
863 #error INCLUDE_vTaskSuspend must be set to 1 if configUSE_TICKLESS_IDLE is not set to 0
864 #endif /* INCLUDE_vTaskSuspend */
865#endif /* configUSE_TICKLESS_IDLE */
866
867#if( ( configSUPPORT_STATIC_ALLOCATION == 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 0 ) )
868 #error configSUPPORT_STATIC_ALLOCATION and configSUPPORT_DYNAMIC_ALLOCATION cannot both be 0, but can both be 1.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800869#endif
870
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800871#if( ( configUSE_RECURSIVE_MUTEXES == 1 ) && ( configUSE_MUTEXES != 1 ) )
872 #error configUSE_MUTEXES must be set to 1 to use recursive mutexes
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800873#endif
874
875#ifndef configINITIAL_TICK_COUNT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800876 #define configINITIAL_TICK_COUNT 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800877#endif
878
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800879#if( portTICK_TYPE_IS_ATOMIC == 0 )
880 /* Either variables of tick type cannot be read atomically, or
881 portTICK_TYPE_IS_ATOMIC was not set - map the critical sections used when
882 the tick count is returned to the standard critical section macros. */
883 #define portTICK_TYPE_ENTER_CRITICAL() portENTER_CRITICAL()
884 #define portTICK_TYPE_EXIT_CRITICAL() portEXIT_CRITICAL()
885 #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() portSET_INTERRUPT_MASK_FROM_ISR()
886 #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) portCLEAR_INTERRUPT_MASK_FROM_ISR( ( x ) )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800887#else
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800888 /* The tick type can be read atomically, so critical sections used when the
889 tick count is returned can be defined away. */
890 #define portTICK_TYPE_ENTER_CRITICAL()
891 #define portTICK_TYPE_EXIT_CRITICAL()
892 #define portTICK_TYPE_SET_INTERRUPT_MASK_FROM_ISR() 0
893 #define portTICK_TYPE_CLEAR_INTERRUPT_MASK_FROM_ISR( x ) ( void ) x
894#endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800895
896/* Definitions to allow backward compatibility with FreeRTOS versions prior to
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800897V8 if desired. */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800898#ifndef configENABLE_BACKWARD_COMPATIBILITY
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800899 #define configENABLE_BACKWARD_COMPATIBILITY 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800900#endif
901
902#ifndef configPRINTF
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800903 /* configPRINTF() was not defined, so define it away to nothing. To use
904 configPRINTF() then define it as follows (where MyPrintFunction() is
905 provided by the application writer):
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800906
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800907 void MyPrintFunction(const char *pcFormat, ... );
908 #define configPRINTF( X ) MyPrintFunction X
909
910 Then call like a standard printf() function, but placing brackets around
911 all parameters so they are passed as a single parameter. For example:
912 configPRINTF( ("Value = %d", MyVariable) ); */
913 #define configPRINTF( X )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800914#endif
915
916#ifndef configMAX
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800917 /* The application writer has not provided their own MAX macro, so define
918 the following generic implementation. */
919 #define configMAX( a, b ) ( ( ( a ) > ( b ) ) ? ( a ) : ( b ) )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800920#endif
921
922#ifndef configMIN
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800923 /* The application writer has not provided their own MAX macro, so define
924 the following generic implementation. */
925 #define configMIN( a, b ) ( ( ( a ) < ( b ) ) ? ( a ) : ( b ) )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800926#endif
927
928#if configENABLE_BACKWARD_COMPATIBILITY == 1
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800929 #define eTaskStateGet eTaskGetState
930 #define portTickType TickType_t
931 #define xTaskHandle TaskHandle_t
932 #define xQueueHandle QueueHandle_t
933 #define xSemaphoreHandle SemaphoreHandle_t
934 #define xQueueSetHandle QueueSetHandle_t
935 #define xQueueSetMemberHandle QueueSetMemberHandle_t
936 #define xTimeOutType TimeOut_t
937 #define xMemoryRegion MemoryRegion_t
938 #define xTaskParameters TaskParameters_t
939 #define xTaskStatusType TaskStatus_t
940 #define xTimerHandle TimerHandle_t
941 #define xCoRoutineHandle CoRoutineHandle_t
942 #define pdTASK_HOOK_CODE TaskHookFunction_t
943 #define portTICK_RATE_MS portTICK_PERIOD_MS
944 #define pcTaskGetTaskName pcTaskGetName
945 #define pcTimerGetTimerName pcTimerGetName
946 #define pcQueueGetQueueName pcQueueGetName
947 #define vTaskGetTaskInfo vTaskGetInfo
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800948
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800949 /* Backward compatibility within the scheduler code only - these definitions
950 are not really required but are included for completeness. */
951 #define tmrTIMER_CALLBACK TimerCallbackFunction_t
952 #define pdTASK_CODE TaskFunction_t
953 #define xListItem ListItem_t
954 #define xList List_t
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800955
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800956 /* For libraries that break the list data hiding, and access list structure
957 members directly (which is not supposed to be done). */
958 #define pxContainer pvContainer
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800959#endif /* configENABLE_BACKWARD_COMPATIBILITY */
960
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800961#if( configUSE_ALTERNATIVE_API != 0 )
962 #error The alternative API was deprecated some time ago, and was removed in FreeRTOS V9.0 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800963#endif
964
965/* Set configUSE_TASK_FPU_SUPPORT to 0 to omit floating point support even
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800966if floating point hardware is otherwise supported by the FreeRTOS port in use.
967This constant is not supported by all FreeRTOS ports that include floating
968point support. */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800969#ifndef configUSE_TASK_FPU_SUPPORT
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800970 #define configUSE_TASK_FPU_SUPPORT 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800971#endif
972
973/* Set configENABLE_MPU to 1 to enable MPU support and 0 to disable it. This is
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800974currently used in ARMv8M ports. */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800975#ifndef configENABLE_MPU
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800976 #define configENABLE_MPU 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800977#endif
978
979/* Set configENABLE_FPU to 1 to enable FPU support and 0 to disable it. This is
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800980currently used in ARMv8M ports. */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800981#ifndef configENABLE_FPU
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800982 #define configENABLE_FPU 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800983#endif
984
985/* Set configENABLE_TRUSTZONE to 1 enable TrustZone support and 0 to disable it.
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800986This is currently used in ARMv8M ports. */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800987#ifndef configENABLE_TRUSTZONE
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800988 #define configENABLE_TRUSTZONE 1
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800989#endif
990
991/* Set configRUN_FREERTOS_SECURE_ONLY to 1 to run the FreeRTOS ARMv8M port on
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800992the Secure Side only. */
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800993#ifndef configRUN_FREERTOS_SECURE_ONLY
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800994 #define configRUN_FREERTOS_SECURE_ONLY 0
kelvin.zhang57fb6ae2021-10-15 10:19:42 +0800995#endif
996
xiaohu.huang4f321fb2024-03-22 14:50:29 +0800997#ifndef configUSE_TASK_START_HOOK
998 #define configUSE_TASK_START_HOOK 0
Xiaohu.Huang2c96ef42021-10-15 16:12:27 +0800999#endif
1000
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001001#ifndef portGetDspHeartBeat
1002 #define portGetDspHeartBeat() 0
1003#endif
Xiaohu.Huang2c96ef42021-10-15 16:12:27 +08001004
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001005/* Sometimes the FreeRTOSConfig.h settings only allow a task to be created using
1006 * dynamically allocated RAM, in which case when any task is deleted it is known
1007 * that both the task's stack and TCB need to be freed. Sometimes the
1008 * FreeRTOSConfig.h settings only allow a task to be created using statically
1009 * allocated RAM, in which case when any task is deleted it is known that neither
1010 * the task's stack or TCB should be freed. Sometimes the FreeRTOSConfig.h
1011 * settings allow a task to be created using either statically or dynamically
1012 * allocated RAM, in which case a member of the TCB is used to record whether the
1013 * stack and/or TCB were allocated statically or dynamically, so when a task is
1014 * deleted the RAM that was allocated dynamically is freed again and no attempt is
1015 * made to free the RAM that was allocated statically.
1016 * tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE is only true if it is possible for a
1017 * task to be created using either statically or dynamically allocated RAM. Note
1018 * that if portUSING_MPU_WRAPPERS is 1 then a protected task can be created with
1019 * a statically allocated stack and a dynamically allocated TCB.
1020 *
1021 * The following table lists various combinations of portUSING_MPU_WRAPPERS,
1022 * configSUPPORT_DYNAMIC_ALLOCATION and configSUPPORT_STATIC_ALLOCATION and
1023 * when it is possible to have both static and dynamic allocation:
1024 * +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+
1025 * | MPU | Dynamic | Static | Available Functions | Possible Allocations | Both Dynamic and | Need Free |
1026 * | | | | | | Static Possible | |
1027 * +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+
1028 * | 0 | 0 | 1 | xTaskCreateStatic | TCB - Static, Stack - Static | No | No |
1029 * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1030 * | 0 | 1 | 0 | xTaskCreate | TCB - Dynamic, Stack - Dynamic | No | Yes |
1031 * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1032 * | 0 | 1 | 1 | xTaskCreate, | 1. TCB - Dynamic, Stack - Dynamic | Yes | Yes |
1033 * | | | | xTaskCreateStatic | 2. TCB - Static, Stack - Static | | |
1034 * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1035 * | 1 | 0 | 1 | xTaskCreateStatic, | TCB - Static, Stack - Static | No | No |
1036 * | | | | xTaskCreateRestrictedStatic | | | |
1037 * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1038 * | 1 | 1 | 0 | xTaskCreate, | 1. TCB - Dynamic, Stack - Dynamic | Yes | Yes |
1039 * | | | | xTaskCreateRestricted | 2. TCB - Dynamic, Stack - Static | | |
1040 * +-----|---------|--------|-----------------------------|-----------------------------------|------------------|-----------|
1041 * | 1 | 1 | 1 | xTaskCreate, | 1. TCB - Dynamic, Stack - Dynamic | Yes | Yes |
1042 * | | | | xTaskCreateStatic, | 2. TCB - Dynamic, Stack - Static | | |
1043 * | | | | xTaskCreateRestricted, | 3. TCB - Static, Stack - Static | | |
1044 * | | | | xTaskCreateRestrictedStatic | | | |
1045 * +-----+---------+--------+-----------------------------+-----------------------------------+------------------+-----------+
1046 */
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001047#define tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE ( ( ( portUSING_MPU_WRAPPERS == 0 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) ) || \
1048 ( ( portUSING_MPU_WRAPPERS == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) ) )
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001049
1050/*
1051 * In line with software engineering best practice, FreeRTOS implements a strict
1052 * data hiding policy, so the real structures used by FreeRTOS to maintain the
1053 * state of tasks, queues, semaphores, etc. are not accessible to the application
1054 * code. However, if the application writer wants to statically allocate such
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001055 * an object then the size of the object needs to be know. Dummy structures
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001056 * that are guaranteed to have the same size and alignment requirements of the
1057 * real objects are used for this purpose. The dummy list and list item
1058 * structures below are used for inclusion in such a dummy structure.
1059 */
1060struct xSTATIC_LIST_ITEM
1061{
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001062 #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1063 TickType_t xDummy1;
1064 #endif
1065 TickType_t xDummy2;
1066 void *pvDummy3[ 4 ];
1067 #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1068 TickType_t xDummy4;
1069 #endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001070};
1071typedef struct xSTATIC_LIST_ITEM StaticListItem_t;
1072
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001073/* See the comments above the struct xSTATIC_LIST_ITEM definition. */
1074struct xSTATIC_MINI_LIST_ITEM
1075{
1076 #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1077 TickType_t xDummy1;
1078 #endif
1079 TickType_t xDummy2;
1080 void *pvDummy3[ 2 ];
1081};
1082typedef struct xSTATIC_MINI_LIST_ITEM StaticMiniListItem_t;
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001083
1084/* See the comments above the struct xSTATIC_LIST_ITEM definition. */
1085typedef struct xSTATIC_LIST
1086{
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001087 #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1088 TickType_t xDummy1;
1089 #endif
1090 UBaseType_t uxDummy2;
1091 void *pvDummy3;
1092 StaticMiniListItem_t xDummy4;
1093 #if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 1 )
1094 TickType_t xDummy5;
1095 #endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001096} StaticList_t;
1097
1098/*
1099 * In line with software engineering best practice, especially when supplying a
1100 * library that is likely to change in future versions, FreeRTOS implements a
1101 * strict data hiding policy. This means the Task structure used internally by
1102 * FreeRTOS is not accessible to application code. However, if the application
1103 * writer wants to statically allocate the memory required to create a task then
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001104 * the size of the task object needs to be know. The StaticTask_t structure
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001105 * below is provided for this purpose. Its sizes and alignment requirements are
1106 * guaranteed to match those of the genuine structure, no matter which
1107 * architecture is being used, and no matter how the values in FreeRTOSConfig.h
1108 * are set. Its contents are somewhat obfuscated in the hope users will
1109 * recognise that it would be unwise to make direct use of the structure members.
1110 */
1111typedef struct xSTATIC_TCB
1112{
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001113 void *pxDummy1;
1114 #if ( portUSING_MPU_WRAPPERS == 1 )
1115 xMPU_SETTINGS xDummy2;
1116 #endif
1117 StaticListItem_t xDummy3[ 2 ];
1118 UBaseType_t uxDummy5;
1119 void *pxDummy6;
1120 UBaseType_t uxDummyStackDepth;
1121 uint8_t ucDummy7[ configMAX_TASK_NAME_LEN ];
1122 #if ( ( portSTACK_GROWTH > 0 ) || ( configRECORD_STACK_HIGH_ADDRESS == 1 ) )
1123 void *pxDummy8;
1124 #endif
1125 #if ( portCRITICAL_NESTING_IN_TCB == 1 )
1126 UBaseType_t uxDummy9;
1127 #endif
1128 #if ( configUSE_TRACE_FACILITY == 1 )
1129 UBaseType_t uxDummy10[ 2 ];
1130 #endif
1131 #if ( configUSE_MUTEXES == 1 )
1132 UBaseType_t uxDummy12[ 2 ];
1133 #endif
1134 #if ( configUSE_APPLICATION_TASK_TAG == 1 )
1135 void *pxDummy14;
1136 #endif
1137 #if( configNUM_THREAD_LOCAL_STORAGE_POINTERS > 0 )
1138 void *pvDummy15[ configNUM_THREAD_LOCAL_STORAGE_POINTERS ];
1139 #endif
1140 #if ( configGENERATE_RUN_TIME_STATS == 1 )
1141 uint32_t ulDummy16;
1142 #endif
1143 #if ( configUSE_NEWLIB_REENTRANT == 1 )
1144 struct _reent xDummy17;
1145 #endif
1146 #if ( configUSE_TASK_NOTIFICATIONS == 1 )
1147 uint32_t ulDummy18;
1148 uint8_t ucDummy19;
1149 #endif
1150 #if ( tskSTATIC_AND_DYNAMIC_ALLOCATION_POSSIBLE != 0 )
1151 uint8_t uxDummy20;
1152 #endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001153
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001154 #if( INCLUDE_xTaskAbortDelay == 1 )
1155 uint8_t ucDummy21;
1156 #endif
1157 #if ( configUSE_POSIX_ERRNO == 1 )
1158 int iDummy22;
1159 #endif
1160 #if ( configUSE_TASK_START_HOOK == 1 )
1161 void *pxDummy23[2];
1162 #endif
1163 #if ENABLE_KASAN
1164 int iDummy24;
1165 #endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001166} StaticTask_t;
1167
1168/*
1169 * In line with software engineering best practice, especially when supplying a
1170 * library that is likely to change in future versions, FreeRTOS implements a
1171 * strict data hiding policy. This means the Queue structure used internally by
1172 * FreeRTOS is not accessible to application code. However, if the application
1173 * writer wants to statically allocate the memory required to create a queue
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001174 * then the size of the queue object needs to be know. The StaticQueue_t
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001175 * structure below is provided for this purpose. Its sizes and alignment
1176 * requirements are guaranteed to match those of the genuine structure, no
1177 * matter which architecture is being used, and no matter how the values in
1178 * FreeRTOSConfig.h are set. Its contents are somewhat obfuscated in the hope
1179 * users will recognise that it would be unwise to make direct use of the
1180 * structure members.
1181 */
1182typedef struct xSTATIC_QUEUE
1183{
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001184 void *pvDummy1[ 3 ];
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001185
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001186 union
1187 {
1188 void *pvDummy2;
1189 UBaseType_t uxDummy2;
1190 } u;
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001191
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001192 StaticList_t xDummy3[ 2 ];
1193 UBaseType_t uxDummy4[ 3 ];
1194 uint8_t ucDummy5[ 2 ];
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001195
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001196 #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
1197 uint8_t ucDummy6;
1198 #endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001199
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001200 #if ( configUSE_QUEUE_SETS == 1 )
1201 void *pvDummy7;
1202 #endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001203
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001204 #if ( configUSE_TRACE_FACILITY == 1 )
1205 UBaseType_t uxDummy8;
1206 uint8_t ucDummy9;
1207 #endif
1208
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001209} StaticQueue_t;
1210typedef StaticQueue_t StaticSemaphore_t;
1211
1212/*
1213 * In line with software engineering best practice, especially when supplying a
1214 * library that is likely to change in future versions, FreeRTOS implements a
1215 * strict data hiding policy. This means the event group structure used
1216 * internally by FreeRTOS is not accessible to application code. However, if
1217 * the application writer wants to statically allocate the memory required to
1218 * create an event group then the size of the event group object needs to be
1219 * know. The StaticEventGroup_t structure below is provided for this purpose.
1220 * Its sizes and alignment requirements are guaranteed to match those of the
1221 * genuine structure, no matter which architecture is being used, and no matter
1222 * how the values in FreeRTOSConfig.h are set. Its contents are somewhat
1223 * obfuscated in the hope users will recognise that it would be unwise to make
1224 * direct use of the structure members.
1225 */
1226typedef struct xSTATIC_EVENT_GROUP
1227{
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001228 TickType_t xDummy1;
1229 StaticList_t xDummy2;
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001230
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001231 #if( configUSE_TRACE_FACILITY == 1 )
1232 UBaseType_t uxDummy3;
1233 #endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001234
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001235 #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )
1236 uint8_t ucDummy4;
1237 #endif
1238
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001239} StaticEventGroup_t;
1240
1241/*
1242 * In line with software engineering best practice, especially when supplying a
1243 * library that is likely to change in future versions, FreeRTOS implements a
1244 * strict data hiding policy. This means the software timer structure used
1245 * internally by FreeRTOS is not accessible to application code. However, if
1246 * the application writer wants to statically allocate the memory required to
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001247 * create a software timer then the size of the queue object needs to be know.
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001248 * The StaticTimer_t structure below is provided for this purpose. Its sizes
1249 * and alignment requirements are guaranteed to match those of the genuine
1250 * structure, no matter which architecture is being used, and no matter how the
1251 * values in FreeRTOSConfig.h are set. Its contents are somewhat obfuscated in
1252 * the hope users will recognise that it would be unwise to make direct use of
1253 * the structure members.
1254 */
1255typedef struct xSTATIC_TIMER
1256{
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001257 void *pvDummy1;
1258 StaticListItem_t xDummy2;
1259 TickType_t xDummy3;
1260 void *pvDummy5;
1261 TaskFunction_t pvDummy6;
1262 #if( configUSE_TRACE_FACILITY == 1 )
1263 UBaseType_t uxDummy7;
1264 #endif
1265 uint8_t ucDummy8;
1266
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001267} StaticTimer_t;
1268
1269/*
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001270* In line with software engineering best practice, especially when supplying a
1271* library that is likely to change in future versions, FreeRTOS implements a
1272* strict data hiding policy. This means the stream buffer structure used
1273* internally by FreeRTOS is not accessible to application code. However, if
1274* the application writer wants to statically allocate the memory required to
1275* create a stream buffer then the size of the stream buffer object needs to be
1276* know. The StaticStreamBuffer_t structure below is provided for this purpose.
1277* Its size and alignment requirements are guaranteed to match those of the
1278* genuine structure, no matter which architecture is being used, and no matter
1279* how the values in FreeRTOSConfig.h are set. Its contents are somewhat
1280* obfuscated in the hope users will recognise that it would be unwise to make
1281* direct use of the structure members.
1282*/
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001283typedef struct xSTATIC_STREAM_BUFFER
1284{
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001285 size_t uxDummy1[ 4 ];
1286 void * pvDummy2[ 3 ];
1287 uint8_t ucDummy3;
1288 #if ( configUSE_TRACE_FACILITY == 1 )
1289 UBaseType_t uxDummy4;
1290 #endif
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001291} StaticStreamBuffer_t;
1292
1293/* Message buffers are built on stream buffers. */
1294typedef StaticStreamBuffer_t StaticMessageBuffer_t;
1295
1296#ifdef __cplusplus
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001297}
kelvin.zhang57fb6ae2021-10-15 10:19:42 +08001298#endif
1299
1300#endif /* INC_FREERTOS_H */
xiaohu.huang4f321fb2024-03-22 14:50:29 +08001301