configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H missing from documentation?

Kernel
1

Hello,

I’m using freeRTOS for my projects running Cortex-M33 (e.g., NXP LPC5536 currently).

In my FreeRTOSConfig.h, I enable configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H.

It’s been there for so long that I forgot why I enabled it :grin:

I noticed that this configuration option is missing from the documentation but is (still) used in tasks.c

It would be great if you could add it to the documentation with some explanation. Thanks.

Best regards,
Daniel

2

I suppose the issue is that it is something that you need to know what you are doing to use it, as you are directly changing (by adding) code to task.c

In case you havn’t figured out what it does, it makes task.c do a include for the file freertos_task_c_additions.h which can then do things with the “private” definitions defined in task.c.

3

Thanks for the suggestion! I agree it should be documented. I’m not sure I want to place it on that page of our website as that shows a ‘typical’ FreeRTOSConfig.h example. The use of configINCLUDE_FREERTOS_TASK_C_ADDITIONS_H is less common amongst users. I’ll look into adding a new page or section which explains the config value.

1 Like
4

The notion that freertos_task_c_additions.h is user provided was helpful. I now remember why I enabled it. I’m using MCUXpresso IDE. And enabling this configuration allows the IDE “thread aware debugging” and to provide usage data. The freertos_task_c_additions.h is provided by the IDE and SDKs.

Thanks.
Daniel

5

As @richard-damon mentioned, this option is for advanced users as it enables access to kernel’s internal data structures and that is why it is not documented. Advanced users can find the explanation here (which we can expand on a bit) - FreeRTOS-Kernel/tasks.c at main · FreeRTOS/FreeRTOS-Kernel · GitHub.