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