Skip to content

Move the prototype for vApplicationIdleHook to task.h. #600

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Dec 19, 2022
Merged

Move the prototype for vApplicationIdleHook to task.h. #600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a710206
move the prototype for vApplicationIdleHook to task.h.
Dec 13, 2022
1278ace
Merge branch 'main' into move_applicationidlehook
aggarg Dec 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions include/task.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1649,6 +1649,24 @@ configSTACK_DEPTH_TYPE uxTaskGetStackHighWaterMark2( TaskHandle_t xTask ) PRIVIL

#endif

#if ( configUSE_IDLE_HOOK == 1 )

/**
* task.h
* @code{c}
* void vApplicationIdleHook( void );
* @endcode
*
* The application idle hook is called by the idle task.
* This allows the application designer to add background functionality without
* the overhead of a separate task.
* NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES, CALL A FUNCTION THAT MIGHT BLOCK.
*/
void vApplicationIdleHook( void );

#endif


#if ( configUSE_TICK_HOOK > 0 )

/**
Expand Down
8 changes: 1 addition & 7 deletions tasks.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3477,13 +3477,7 @@ static portTASK_FUNCTION( prvIdleTask, pvParameters )

#if ( configUSE_IDLE_HOOK == 1 )
{
extern void vApplicationIdleHook( void );

/* Call the user defined function from within the idle task. This
* allows the application designer to add background functionality
* without the overhead of a separate task.
* NOTE: vApplicationIdleHook() MUST NOT, UNDER ANY CIRCUMSTANCES,
* CALL A FUNCTION THAT MIGHT BLOCK. */
/* Call the user defined function from within the idle task. */
vApplicationIdleHook();
}
#endif /* configUSE_IDLE_HOOK */
Expand Down