]> begriffs open source - cmsis/blob - CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Status.txt
RTOS2 Documentation Updates
[cmsis] / CMSIS / DoxyGen / RTOS2 / src / cmsis_os2_Status.txt
1 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
2 // ==== Definitions ====
3 /**
4 \addtogroup CMSIS_RTOS_Definitions Definitions
5 \ingroup CMSIS_RTOS
6 \brief Constants and enumerations used by many CMSIS-RTOS functions.
7 \details The following constants and enumerations are used by many CMSIS-RTOS function calls.
8 @{
9 */
10 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
11 /**
12 \typedef osStatus_t
13 \details
14 The \b osStatus_t enumeration defines the event status and error codes that are returned by many CMSIS-RTOS functions.
15 */
16
17 /**
18 \def osWaitForever
19 \details A special \ref CMSIS_RTOS_TimeOutValue that informs the RTOS to wait infinite until a resource becomes available.
20 It applies to the following functions: 
21  - \ref osThreadFlagsWait : \copybrief osThreadFlagsWait 
22  - \ref osEventFlagsWait : \copybrief osEventFlagsWait
23  - \ref osMutexAcquire : \copybrief osMutexAcquire
24  - \ref osSemaphoreAcquire : \copybrief osSemaphoreAcquire
25  - \ref osMemoryPoolAlloc : \copybrief osMemoryPoolAlloc
26  - \ref osMessageQueuePut :     \copybrief osMessageQueuePut
27  - \ref osMessageQueueGet :     \copybrief osMessageQueueGet
28 */
29
30 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
31 /** \def osFlagsWaitAny
32
33 Reference: 
34  - \ref osEventFlagsWait
35  - \ref osThreadFlagsWait
36 */
37 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
38 /** \def osFlagsWaitAll
39
40 Reference: 
41  - \ref osEventFlagsWait
42  - \ref osThreadFlagsWait
43 */
44 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
45 /** \def osFlagsNoClear
46
47 Reference: 
48  - \ref osEventFlagsWait
49  - \ref osThreadFlagsWait
50 */
51
52 /// @} 
53
54
55