len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-11-03 18:22:45 -05:00
Code Issues Projects Releases Packages Wiki Activity

Minor updates to formatting and MISRA compliance of the PR used to update the vTaskDelayUntil() function to xTaskDelayUntil(). (#198)

Browse source
This commit is contained in:
RichardBarry 2020-10-10 21:42:38 -07:00 • committed by GitHub
parent 6375d52250
commit 167ea16282
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

23
include/task.h
View file

@ -816,7 +816,8 @@ void vTaskDelay( const TickType_t xTicksToDelay ) PRIVILEGED_FUNCTION;
* a fixed interface period. * a fixed interface period.
* *
* @return Value which can be used to check whether the task was actually delayed. * @return Value which can be used to check whether the task was actually delayed.
* Will be pdTRUE if the task way delayed and pdFALSE otherwise. * Will be pdTRUE if the task way delayed and pdFALSE otherwise. A task will not
* be delayed if the next expected wake time is in the past.
* *
* Example usage: * Example usage:
* <pre> * <pre>
@ -825,16 +826,17 @@ void vTaskDelay( const TickType_t xTicksToDelay ) PRIVILEGED_FUNCTION;
* { * {
* TickType_t xLastWakeTime; * TickType_t xLastWakeTime;
* const TickType_t xFrequency = 10; * const TickType_t xFrequency = 10;
* BaseType_t xWasDelayed;
* *
* // Initialise the xLastWakeTime variable with the current time. * // Initialise the xLastWakeTime variable with the current time.
* xLastWakeTime = xTaskGetTickCount (); * xLastWakeTime = xTaskGetTickCount ();
* for( ;; ) * for( ;; )
* { * {
* // Wait for the next cycle. * // Wait for the next cycle.
* BaseType_t xWasDelayed = xTaskDelayUntil( &xLastWakeTime, xFrequency ); * xWasDelayed = xTaskDelayUntil( &xLastWakeTime, xFrequency );
* *
* // Perform action here. xWasDelayed value can be used to determine * // Perform action here. xWasDelayed value can be used to determine
* // whether a deadline was missed if the code here took too long. * // whether a deadline was missed if the code here took too long.
* } * }
* } * }
* </pre> * </pre>
@ -843,9 +845,10 @@ void vTaskDelay( const TickType_t xTicksToDelay ) PRIVILEGED_FUNCTION;
*/ */
BaseType_t xTaskDelayUntil( TickType_t * const pxPreviousWakeTime, BaseType_t xTaskDelayUntil( TickType_t * const pxPreviousWakeTime,
const TickType_t xTimeIncrement ) PRIVILEGED_FUNCTION; const TickType_t xTimeIncrement ) PRIVILEGED_FUNCTION;
#define vTaskDelayUntil( pxPreviousWakeTime, xTimeIncrement ) \
{ \ #define vTaskDelayUntil( pxPreviousWakeTime, xTimeIncrement ) \
xTaskDelayUntil ( pxPreviousWakeTime , xTimeIncrement ); \ { \
( void ) xTaskDelayUntil( pxPreviousWakeTime, xTimeIncrement ); \
} }