CMSIS-RTOS RTX  Version 4.78
CMSIS-RTOS RTX: Real-Time Operating System for Cortex-M processor-based devices
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Generic Wait Function

Wait for a time period or unspecified events. More...

Functions

osStatus osDelay (uint32_t millisec)
 Wait for Timeout (Time Delay).
 

Description

The Generic Wait function group provides means for a time delay and allow to wait for unspecified events.

Function Documentation

osStatus osDelay ( uint32_t  millisec)
Parameters
[in]millisectime delay value
Returns
status code that indicates the execution status of the function.

Wait for a specified time period in millisec.

Status and Error Codes

  • osEventTimeout: the time delay is executed.
  • osErrorISR: osDelay cannot be called from interrupt service routines.

Example

#include "cmsis_os.h"
void Thread_1 (void const *arg) { // Thread function
osStatus status; // capture the return status
uint32_t delayTime; // delay time in milliseconds
delayTime = 1000; // delay 1 second
:
status = osDelay (delayTime); // suspend thread execution
// handle error code
:
}