begriffs open source - cmsis/blob - CMSIS/DoxyGen/RTOS2/src/cmsis_os2_Sema.txt

   1 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
   2 //  ==== Semaphore Management ====
   3 /**
   4 \addtogroup CMSIS_RTOS_SemaphoreMgmt Semaphores
   5 \ingroup CMSIS_RTOS
   6 \brief Access shared resources simultaneously from different threads.
   7 \details
   8 Semaphores are used to manage and protect access to shared resources. Semaphores are very similar to
   9 \ref CMSIS_RTOS_MutexMgmt "Mutexes". Whereas a Mutex permits just one thread to access a shared resource at a
  10 time, a semaphore can be used to permit a fixed number of threads/ISRs to access a pool of shared resources. Using
  11 semaphores, access to a group of identical peripherals can be managed (for example multiple DMA channels).
  12
  13 \image html "Semaphore.png" "CMSIS-RTOS Semaphore"
  14
  15 A semaphore object should be initialized to the maximum number of available tokens. This number of available resources is
  16 specified as parameter of the \ref osSemaphoreNew function. Each time a semaphore token is obtained with \ref osSemaphoreAcquire
  17 (in \em available state), the semaphore count is decremented. When the semaphore count is 0 (i.e. \em depleted state), no
  18 more semaphore tokens can be obtained. The thread/ISR that tries to obtain the semaphore token needs to wait until the next
  19 token is free. Semaphores are released with \ref osSemaphoreRelease incrementing the semaphore count.
  20
  21 \image html "semaphore_states.png" "CMSIS-RTOS Semaphore States"
  22
  23 \note The functions \ref osSemaphoreAcquire, \ref osSemaphoreGetCount, and \ref osSemaphoreRelease can be called from
  24 \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
  25
  26 \note Refer to \ref semaphoreConfig for RTX5 configuration options.
  27
  28 Semaphore Use Cases
  29 -------------------
  30 Due to their flexibility, semaphores cover a wide range of synchronizing applications. At the same time, they are perhaps the
  31 most challenging RTOS object to understand. The following explains a use case for semaphores, taken from the book
  32 <a href="http://www.greenteapress.com/semaphores/" target="_blank">The Little Book Of Semaphores</a> by Allen B. Downey which
  33 is available for free download.
  34
  35 <b>Non-binary Semaphore (Multiplex)</b>
  36
  37 A multiplex limits the number of threads that can access a critical section of code. For example, this could be a function
  38 accessing DMA resources which can only support a limited number of calls.
  39
  40 To allow multiple threads to run the function, initialize a semaphore to the maximum number of threads that can be allowed.
  41 The number of tokens in the semaphore represents the number of additional threads that may enter. If this number is zero,
  42 then the next thread trying to access the function will have to wait until one of the other threads exits and releases its
  43 token. When all threads have exited the token number is back to n. The following example shows the code for one of the
  44 threads that might access the resource:
  45
  46 \code
  47 osSemaphoreId_t multiplex_id;
  48
  49 void thread_n (void)
  50 {
  51   multiplex_id = osSemaphoreNew(3, 3, NULL);
  52   while(1)
  53     {
  54       osSemaphoreAcquire(multiplex_id, osWaitForever);
  55       // do something
  56       osSemaphoreRelease(multiplex_id);
  57     }
  58 }
  59 \endcode
  60
  61 <b>Producer/Consumer Semaphore</b>
  62
  63 The producer-consumer problem can be solved using two semaphores.
  64
  65 A first semaphore (\token{empty_id}) counts down the available (empty) buffers, i.e.
  66 the producer thread can wait for available buffer slots by acquiring from this one.
  67
  68 A second semaphore (\token{filled_id}) counts up the used (filled) buffers, i.e.
  69 the consumer thread can wait for available data by acquiring from this one.
  70
  71 It is crucial for the correct behaviour that the threads acquire and release on both
  72 semaphores in the given sequence. According to this example one can have multiple
  73 producer and/or consumer threads running concurrently.
  74
  75 \code
  76 #define BUFFER_SIZE 10
  77 osSemaphoreId_t empty_id = osSemaphoreNew(BUFFER_SIZE, BUFFER_SIZE, NULL);
  78 osSemaphoreId_t filled_id = osSemaphoreNew(BUFFER_SIZE, 0, NULL);
  79
  80 void producer_thread (void)
  81 {
  82   while(1)
  83   {
  84     osSemaphoreAcquire(empty_id, osWaitForever);
  85     // produce data
  86     osSemaphoreRelease(filled_id);
  87   }
  88 }
  89
  90 void consumer_thread (void)
  91 {
  92   while(1)
  93   {
  94     osSemaphoreAcquire(filled_id, osWaitForever);
  95     // consume data
  96     osSemaphoreRelease(empty_id);
  97   }
  98 }
  99 \endcode
 100
 101 @{
 102 */
 103
 104 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 105 /**
 106 \typedef  osSemaphoreId_t
 107 \details
 108 Returned by:
 109 - \ref osSemaphoreNew
 110 */
 111
 112 /**
 113 \struct osSemaphoreAttr_t
 114 \details
 115 Specifies the following attributes for the \ref osSemaphoreNew function.
 116 */
 117
 118 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 119 /**
 120 \fn osSemaphoreId_t osSemaphoreNew (uint32_t max_count, uint32_t initial_count, const osSemaphoreAttr_t *attr)
 121 \details
 122 The function \b osSemaphoreNew creates and initializes a semaphore object that is used to manage access to shared resources
 123 and returns the pointer to the semaphore object identifier or \token{NULL} in case of an error. It can be safely called
 124 before the RTOS is started (call to \ref osKernelStart), but not before it is initialized (call to \ref osKernelInitialize).
 125
 126 The parameter \em max_count specifies the maximum number of available tokens. A \em max_count value of 1 creates a binary
 127 semaphore.
 128
 129 The parameter \em initial_count sets the initial number of available tokens.
 130
 131 The parameter \em attr specifies additional semaphore attributes. Default attributes will be used if set to \token{NULL}.
 132
 133 \note This function \b cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
 134
 135 <b>Code Example</b>
 136 \code
 137 #include "cmsis_os2.h"                                     // CMSIS RTOS header file
 138
 139 void Thread_Semaphore (void *argument);                    // thread function
 140 osThreadId_t tid_Thread_Semaphore;                         // thread id
 141
 142 osSemaphoreId_t sid_Thread_Semaphore;                      // semaphore id
 143
 144 int Init_Semaphore (void)
 145 {
 146
 147   sid_Thread_Semaphore = osSemaphoreNew(2, 2, NULL);
 148   if (!sid_Thread_Semaphore) {
 149     ; // Semaphore object not created, handle failure
 150   }
 151
 152   tid_Thread_Semaphore = osThreadNew (Thread_Semaphore, NULL, NULL);
 153   if (!tid_Thread_Semaphore) {
 154     return(-1);
 155   }
 156
 157   return(0);
 158 }
 159
 160 void Thread_Semaphore (void *argument)
 161 {
 162   osStatus_t val;
 163
 164   while (1) {
 165     ; // Insert thread code here...
 166
 167     val = osSemaphoreAcquire (sid_Thread_Semaphore, 10);   // wait for max. 10 ticks for semaphore token to get available
 168     switch (val) {
 169     case osOK:
 170       ; // Use protected code here...
 171       osSemaphoreRelease (sid_Thread_Semaphore);           // Return a token back to a semaphore
 172       break;
 173     case osErrorResource:
 174       break;
 175     case osErrorParameter:
 176       break;
 177     default:
 178       break;
 179     }
 180
 181     osThreadYield ();                                      // suspend thread
 182   }
 183 }
 184 \endcode
 185 */
 186
 187 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 188 /**
 189 \fn const char *osSemaphoreGetName (osSemaphoreId_t semaphore_id)
 190 \details
 191 The function \b osSemaphoreGetName returns the pointer to the name string of the semaphore identified by parameter \a
 192 semaphore_id or \token{NULL} in case of an error.
 193
 194 \note This function \b cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
 195 */
 196
 197 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 198 /**
 199 \fn osStatus_t osSemaphoreAcquire (osSemaphoreId_t semaphore_id, uint32_t timeout)
 200 \details
 201 The blocking function \b osSemaphoreAcquire waits until a token of the semaphore object specified by parameter
 202 \a semaphore_id becomes available. If a token is available, the function instantly returns and decrements the token count.
 203
 204 The parameter \a timeout specifies how long the system waits to acquire the token. While the system waits, the thread
 205 that is calling this function is put into the \ref ThreadStates "BLOCKED" state. The parameter \ref CMSIS_RTOS_TimeOutValue
 206 "timeout" can have the following values:
 207  - when \a timeout is \token{0}, the function returns instantly (i.e. try semantics).
 208  - when \a timeout is set to \b osWaitForever the function will wait for an infinite time until the semaphore becomes
 209    available (i.e. wait semantics).
 210  - all other values specify a time in kernel ticks for a timeout (i.e. timed-wait semantics).
 211
 212 Possible \ref osStatus_t return values:
 213  - \em osOK: the token has been obtained and the token count decremented.
 214  - \em osErrorTimeout: the token could not be obtained in the given time.
 215  - \em osErrorResource: the token could not be obtained when no \a timeout was specified.
 216  - \em osErrorParameter: the parameter \a semaphore_id is \token{NULL} or invalid.
 217
 218 \note May be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" if the parameter \a timeout is set to
 219 \token{0}.
 220
 221 <b>Code Example</b>
 222
 223 Refer to \ref osSemaphoreNew.
 224 */
 225
 226 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 227 /**
 228 \fn osStatus_t osSemaphoreRelease (osSemaphoreId_t semaphore_id)
 229 \details
 230 The function \b osSemaphoreRelease releases a token of the semaphore object specified by parameter \a semaphore_id. Tokens
 231 can only be released up to the maximum count specified at creation time, see \ref osSemaphoreNew. Other threads that
 232 currently wait for a token of this semaphore object will be put into the \ref ThreadStates "READY" state.
 233
 234 Possible \ref osStatus_t return values:
 235  - \em osOK: the token has been released and the count incremented.
 236  - \em osErrorResource: the token could not be released (maximum token count has been reached).
 237  - \em osErrorParameter: the parameter \a semaphore_id is \token{NULL} or invalid.
 238
 239 \note This function may be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
 240
 241 <b>Code Example</b>
 242
 243 Refer to \ref osSemaphoreNew.
 244 */
 245
 246 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 247 /**
 248 \fn uint32_t osSemaphoreGetCount (osSemaphoreId_t semaphore_id)
 249 \details
 250 The function \b osSemaphoreGetCount returns the number of available tokens of the semaphore object specified by parameter
 251 \a semaphore_id. In case of an error it returns \token{0}.
 252
 253 \note This function may be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
 254 */
 255
 256 /*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
 257 /**
 258 \fn osStatus_t osSemaphoreDelete (osSemaphoreId_t semaphore_id)
 259 \details
 260 The function \b osSemaphoreDelete deletes a semaphore object specified by parameter \a semaphore_id. It releases internal
 261 memory obtained for semaphore handling. After this call, the \a semaphore_id is no longer valid and cannot be used. The
 262 semaphore may be created again using the function \ref osSemaphoreNew.
 263
 264 Possible \ref osStatus_t return values:
 265  - \em osOK: the semaphore object has been deleted.
 266  - \em osErrorParameter: the parameter \a semaphore_id is \token{NULL} or invalid.
 267  - \em osErrorResource: the semaphore is in an invalid state.
 268  - \em osErrorISR: \b osSemaphoreDelete cannot be called from interrupt service routines.
 269
 270 \note This function \b cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
 271 */
 272 /// @}
 273
 274 // these struct members must stay outside the group to avoid double entries in documentation
 275 /**
 276 \var osSemaphoreAttr_t::attr_bits
 277 \details
 278 Reserved for future use (must be set to '0' for future compatibility).
 279
 280 \var osSemaphoreAttr_t::cb_mem
 281 \details
 282 Pointer to a memory for the semaphore control block object. Refer to \ref StaticObjectMemory for more information.
 283
 284 Default: \token{NULL} to use \ref CMSIS_RTOS_MemoryMgmt_Automatic for the semaphore control block.
 285
 286 \var osSemaphoreAttr_t::cb_size
 287 \details
 288 The size (in bytes) of memory block passed with \ref cb_mem. For RTX, the minimum value is defined with \ref osRtxSemaphoreCbSize (higher values are permitted).
 289
 290 Default: \token{0} as the default is no memory provided with \ref cb_mem.
 291
 292 \var osSemaphoreAttr_t::name
 293 \details
 294 Pointer to a constant string with a human readable name (displayed during debugging) of the semaphore object.
 295
 296 Default: \token{NULL} no name specified.
 297 */