Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] INCLUDE_xEventGroupSetBitFromISR and INCLUDE_xResumeFromISR configs are unused #1210

Closed
arctic-alpaca opened this issue Dec 19, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@arctic-alpaca
Copy link

Describe the issue

The customization documentation lists INCLUDE_xEventGroupSetBitFromISR and INCLUDE_xResumeFromISR. Both are not used in the actual FreeRTOS code as far as I can tell.

xEventGroupSetBitsFromISR documentation refers to INCLUDE_xEventGroupSetBitFromISR having to be set, but that's not the case.
The actually required configUSE_TRACE_FACILITY is not mentioned in the requirements for this function to be present.

Reference

INCLUDE_xResumeFromISR search results in code: https://github.com/search?q=repo%3AFreeRTOS%2FFreeRTOS-Kernel+INCLUDE_xResumeFromISR&type=code

INCLUDE_xEventGroupSetBitFromISR search results in code: https://github.com/search?q=repo%3AFreeRTOS%2FFreeRTOS-Kernel+INCLUDE_xEventGroupSetBitFromISR&type=code

Both options are listed at https://www.freertos.org/Documentation/02-Kernel/03-Supported-devices/02-Customization

xEventGroupSetBitsFromISR documentation.

@arctic-alpaca arctic-alpaca added the documentation Improvements or additions to documentation label Dec 19, 2024
aggarg added a commit to aggarg/FreeRTOS-Kernel that referenced this issue Dec 19, 2024
These were reported here - FreeRTOS#1210.

Signed-off-by: Gaurav Aggarwal <[email protected]>
@aggarg
Copy link
Member

aggarg commented Dec 19, 2024

Thank you reporting these. We have made the website updates and those will go out in the next deployment.

This PR removes the unused config parameters from template files - #1211.

The actually required configUSE_TRACE_FACILITY is not mentioned in the requirements for this function to be present.

configUSE_TRACE_FACILITY is not absolutely needed - it controls where xEventGroupSetBitsFromISR is present as a separate function or directly mapped to xTimerPendFunctionCallFromISR - https://github.com/FreeRTOS/FreeRTOS-Kernel/blob/main/include/event_groups.h#L610-L617.

aggarg added a commit that referenced this issue Dec 19, 2024
These were reported here - #1210.

Signed-off-by: Gaurav Aggarwal <[email protected]>
@aggarg aggarg closed this as completed Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants