begriffs open source - cmsis/blob - 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 \addtogroup flags_error_codes Flags Functions Error Codes
  55 \ingroup CMSIS_RTOS_Definitions
  56 \brief Constants used by \ref CMSIS_RTOS_ThreadFlagsMgmt and \ref CMSIS_RTOS_EventFlags to return error codes.
  57 \details In case of an error, flags functions (\ref CMSIS_RTOS_ThreadFlagsMgmt and
  58 \ref CMSIS_RTOS_EventFlags) return error codes. To indicate that an error has occurred, the highest bit of
  59 the return value is be set. You can check the exact error using the codes shown below.
  60 @{
  61 */
  62 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
  63 /** \def osFlagsErrorUnknown
  64 \details Generic error. It is returned when no other error can be applied.
  65
  66 Reference:
  67  - \ref osThreadFlagsSet
  68  - \ref osThreadFlagsClear
  69  - \ref osThreadFlagsWait
  70  - \ref osEventFlagsSet
  71  - \ref osEventFlagsClear
  72  - \ref osEventFlagsWait
  73 */
  74
  75 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
  76 /** \def osFlagsErrorTimeout
  77 \details This error is returned if a timeout was specified and the specified flags were not set, when the
  78 timeout occurred.
  79
  80 Reference:
  81  - \ref osThreadFlagsSet
  82  - \ref osThreadFlagsClear
  83  - \ref osThreadFlagsWait
  84  - \ref osEventFlagsSet
  85  - \ref osEventFlagsClear
  86  - \ref osEventFlagsWait
  87 */
  88
  89 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
  90 /** \def osFlagsErrorResource
  91 \details This error is returned when you try to get a flag that was not set \a and timeout 0 was
  92 specified. Is also returned when the specified object identifier is corrupt or invalid.
  93
  94 Reference:
  95  - \ref osThreadFlagsSet
  96  - \ref osThreadFlagsClear
  97  - \ref osThreadFlagsWait
  98  - \ref osEventFlagsSet
  99  - \ref osEventFlagsClear
 100  - \ref osEventFlagsWait
 101 */
 102
 103 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 104 /** \def osFlagsErrorParameter
 105 \details This error is returned when a given parameter is wrong.
 106
 107 Reference:
 108  - \ref osThreadFlagsSet
 109  - \ref osThreadFlagsClear
 110  - \ref osThreadFlagsWait
 111  - \ref osEventFlagsSet
 112  - \ref osEventFlagsClear
 113  - \ref osEventFlagsWait
 114 */
 115
 116 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 117 /** \def osFlagsErrorISR
 118 \details This error is returned when a non-ISR-callable function was called from an ISR.
 119
 120 Reference:
 121  - \ref osThreadFlagsSet
 122  - \ref osThreadFlagsClear
 123  - \ref osThreadFlagsWait
 124  - \ref osEventFlagsSet
 125  - \ref osEventFlagsClear
 126  - \ref osEventFlagsWait
 127 */
 128
 129 /// @}
 130