Lines Matching full:in

36 Definitions that are prefixed \b os_ are not used in the application code but local to this header …
55 Functions that cannot be called from an ISR are verifying the interrupt status and return in case t…
56 from an ISR context the status code \b osErrorISR. In some implementations this condition might be …
80 This header file defines all objects when included in a C/C++ source file. When <b>\#define osObjec…
107 /// \note MUST REMAIN UNCHANGED: \b osKernelSystemId shall be consistent in every CMSIS-RTOS.
110 /// \note MUST REMAIN UNCHANGED: \b osFeature_xxx shall be consistent in every CMSIS-RTOS.
131 /// \note MUST REMAIN UNCHANGED: \b osPriority shall be consistent in every CMSIS-RTOS.
144 /// \note MUST REMAIN UNCHANGED: \b osWaitForever shall be consistent in every CMSIS-RTOS.
148 /// \note MUST REMAIN UNCHANGED: \b osStatus shall be consistent in every CMSIS-RTOS.
158 …osErrorISR              =  0x82,       ///< not allowed in ISR context: the function cannot be cal…
169 /// \note MUST REMAIN UNCHANGED: \b os_timer_type shall be consistent in every CMSIS-RTOS.
176 /// \note MUST REMAIN UNCHANGED: \b os_pthread shall be consistent in every CMSIS-RTOS.
180 /// \note MUST REMAIN UNCHANGED: \b os_ptimer shall be consistent in every CMSIS-RTOS.
186 /// \note CAN BE CHANGED: \b os_thread_cb is implementation specific in every CMSIS-RTOS.
190 /// \note CAN BE CHANGED: \b os_timer_cb is implementation specific in every CMSIS-RTOS.
194 /// \note CAN BE CHANGED: \b os_mutex_cb is implementation specific in every CMSIS-RTOS.
198 /// \note CAN BE CHANGED: \b os_semaphore_cb is implementation specific in every CMSIS-RTOS.
202 /// \note CAN BE CHANGED: \b os_pool_cb is implementation specific in every CMSIS-RTOS.
206 /// \note CAN BE CHANGED: \b os_messageQ_cb is implementation specific in every CMSIS-RTOS.
210 /// \note CAN BE CHANGED: \b os_mailQ_cb is implementation specific in every CMSIS-RTOS.
215 /// \note CAN BE CHANGED: \b os_thread_def is implementation specific in every CMSIS-RTOS.
225 /// \note CAN BE CHANGED: \b os_timer_def is implementation specific in every CMSIS-RTOS.
235 /// \note CAN BE CHANGED: \b os_mutex_def is implementation specific in every CMSIS-RTOS.
242 /// \note CAN BE CHANGED: \b os_semaphore_def is implementation specific in every CMSIS-RTOS.
249 /// \note CAN BE CHANGED: \b os_pool_def is implementation specific in every CMSIS-RTOS.
257 /// \note CAN BE CHANGED: \b os_messageQ_def is implementation specific in every CMSIS-RTOS.
266 /// \note CAN BE CHANGED: \b os_mailQ_def is implementation specific in every CMSIS-RTOS.
274 /// \note MUST REMAIN UNCHANGED: \b os_event shall be consistent in every CMSIS-RTOS. 
293 /// \param[in]     thread_def    thread definition referenced with \ref osThread.
294 /// \param[in]     argument      pointer that is passed to the thread function as start argument.
296 /// \note MUST REMAIN UNCHANGED: \b osKernelStart shall be consistent in every CMSIS-RTOS. 
300 /// \note MUST REMAIN UNCHANGED: \b osKernelRunning shall be consistent in every CMSIS-RTOS. 
311 /// \param         stacksz      stack size (in bytes) requirements for the thread function.
313 ///       macro body is implementation specific in every CMSIS-RTOS.
326 ///       macro body is implementation specific in every CMSIS-RTOS.
332 /// \param[in]     thread_def    thread definition referenced with \ref osThread.
333 /// \param[in]     argument      pointer that is passed to the thread function as start argument.
334 /// \return thread ID for reference by other functions or NULL in case of error.
335 /// \note MUST REMAIN UNCHANGED: \b osThreadCreate shall be consistent in every CMSIS-RTOS.
339 /// \return thread ID for reference by other functions or NULL in case of error.
340 /// \note MUST REMAIN UNCHANGED: \b osThreadGetId shall be consistent in every CMSIS-RTOS.
344 /// \param[in]     thread_id   thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
346 /// \note MUST REMAIN UNCHANGED: \b osThreadTerminate shall be consistent in every CMSIS-RTOS.
349 /// Pass control to next thread that is in state \b READY.
351 /// \note MUST REMAIN UNCHANGED: \b osThreadYield shall be consistent in every CMSIS-RTOS.
355 /// \param[in]     thread_id     thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
356 /// \param[in]     priority      new priority value for the thread function.
358 /// \note MUST REMAIN UNCHANGED: \b osThreadSetPriority shall be consistent in every CMSIS-RTOS.
362 /// \param[in]     thread_id     thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
364 /// \note MUST REMAIN UNCHANGED: \b osThreadGetPriority shall be consistent in every CMSIS-RTOS.
372 /// \param[in]     millisec      time delay value 
379 /// \param[in] millisec          timeout value or 0 in case of no time-out
381 /// \note MUST REMAIN UNCHANGED: \b osWait shall be consistent in every CMSIS-RTOS.
392 ///       macro body is implementation specific in every CMSIS-RTOS.
405 ///       macro body is implementation specific in every CMSIS-RTOS.
410 /// \param[in]     timer_def     timer object referenced with \ref osTimer.
411 /// \param[in]     type          osTimerOnce for one-shot or osTimerPeriodic for periodic behavior.
412 /// \param[in]     argument      argument to the timer call back function.
413 /// \return timer ID for reference by other functions or NULL in case of error.
414 /// \note MUST REMAIN UNCHANGED: \b osTimerCreate shall be consistent in every CMSIS-RTOS.
418 /// \param[in]     timer_id      timer ID obtained by \ref osTimerCreate.
419 /// \param[in]     millisec      time delay value of the timer.
421 /// \note MUST REMAIN UNCHANGED: \b osTimerStart shall be consistent in every CMSIS-RTOS.
425 /// \param[in]     timer_id      timer ID obtained by \ref osTimerCreate.
427 /// \note MUST REMAIN UNCHANGED: \b osTimerStop shall be consistent in every CMSIS-RTOS.
434 /// \param[in]     thread_id     thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
435 /// \param[in]     signals       specifies the signal flags of the thread that should be set.
436 /// \return previous signal flags of the specified thread or 0x80000000 in case of incorrect parame…
437 /// \note MUST REMAIN UNCHANGED: \b osSignalSet shall be consistent in every CMSIS-RTOS.
441 /// \param[in]     thread_id     thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
442 /// \param[in]     signals       specifies the signal flags of the thread that shall be cleared.
443 /// \return previous signal flags of the specified thread or 0x80000000 in case of incorrect parame…
444 /// \note MUST REMAIN UNCHANGED: \b osSignalClear shall be consistent in every CMSIS-RTOS.
448 /// \param[in]     thread_id     thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
449 /// \return previous signal flags of the specified thread or 0x80000000 in case of incorrect parame…
450 /// \note MUST REMAIN UNCHANGED: \b osSignalGet shall be consistent in every CMSIS-RTOS.
454 /// \param[in]     signals       wait until all specified signal flags set or 0 for any single sign…
455 /// \param[in]     millisec      timeout value or 0 in case of no time-out.
457 /// \note MUST REMAIN UNCHANGED: \b osSignalWait shall be consistent in every CMSIS-RTOS.
466 ///       macro body is implementation specific in every CMSIS-RTOS.
478 ///       macro body is implementation specific in every CMSIS-RTOS.
483 /// \param[in]     mutex_def     mutex definition referenced with \ref osMutex.
484 /// \return mutex ID for reference by other functions or NULL in case of error.
485 /// \note MUST REMAIN UNCHANGED: \b osMutexCreate shall be consistent in every CMSIS-RTOS.
489 /// \param[in]     mutex_id      mutex ID obtained by \ref osMutexCreate.
490 /// \param[in]     millisec      timeout value or 0 in case of no time-out.
492 /// \note MUST REMAIN UNCHANGED: \b osMutexWait shall be consistent in every CMSIS-RTOS.
496 /// \param[in]     mutex_id      mutex ID obtained by \ref osMutexCreate.
498 /// \note MUST REMAIN UNCHANGED: \b osMutexRelease shall be consistent in every CMSIS-RTOS.
502 /// \param[in]     mutex_id      mutex ID obtained by \ref osMutexCreate.
504 /// \note MUST REMAIN UNCHANGED: \b osMutexDelete shall be consistent in every CMSIS-RTOS.
514 ///       macro body is implementation specific in every CMSIS-RTOS.
526 ///       macro body is implementation specific in every CMSIS-RTOS.
531 /// \param[in]     semaphore_def semaphore definition referenced with \ref osSemaphore.
532 /// \param[in]     count         number of available resources.
533 /// \return semaphore ID for reference by other functions or NULL in case of error.
534 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreCreate shall be consistent in every CMSIS-RTOS.
538 /// \param[in]     semaphore_id  semaphore object referenced with \ref osSemaphore.
539 /// \param[in]     millisec      timeout value or 0 in case of no time-out.
540 /// \return number of available tokens, or -1 in case of incorrect parameters.
541 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreWait shall be consistent in every CMSIS-RTOS.
545 /// \param[in]     semaphore_id  semaphore object referenced with \ref osSemaphore.
547 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreRelease shall be consistent in every CMSIS-RTOS.
558 /// \param         no            maximum number of objects (elements) in the memory pool.
561 ///       macro body is implementation specific in every CMSIS-RTOS.
574 ///       macro body is implementation specific in every CMSIS-RTOS.
579 /// \param[in]     pool_def      memory pool definition referenced with \ref osPool.
580 /// \return memory pool ID for reference by other functions or NULL in case of error.
581 /// \note MUST REMAIN UNCHANGED: \b osPoolCreate shall be consistent in every CMSIS-RTOS.
585 /// \param[in]     pool_id       memory pool ID obtain referenced with \ref osPoolCreate.
586 /// \return address of the allocated memory block or NULL in case of no memory available.
587 /// \note MUST REMAIN UNCHANGED: \b osPoolAlloc shall be consistent in every CMSIS-RTOS.
591 /// \param[in]     pool_id       memory pool ID obtain referenced with \ref osPoolCreate.
592 /// \return address of the allocated memory block or NULL in case of no memory available.
593 /// \note MUST REMAIN UNCHANGED: \b osPoolCAlloc shall be consistent in every CMSIS-RTOS.
597 /// \param[in]     pool_id       memory pool ID obtain referenced with \ref osPoolCreate.
598 /// \param[in]     block         address of the allocated memory block that is returned to the memo…
600 /// \note MUST REMAIN UNCHANGED: \b osPoolFree shall be consistent in every CMSIS-RTOS.
612 /// \param         queue_sz      maximum number of messages in the queue.
615 ///       macro body is implementation specific in every CMSIS-RTOS.
628 ///       macro body is implementation specific in every CMSIS-RTOS.
633 /// \param[in]     queue_def     queue definition referenced with \ref osMessageQ.
634 /// \param[in]     thread_id     thread ID (obtained by \ref osThreadCreate or \ref osThreadGetId) …
635 /// \return message queue ID for reference by other functions or NULL in case of error.
636 /// \note MUST REMAIN UNCHANGED: \b osMessageCreate shall be consistent in every CMSIS-RTOS.
640 /// \param[in]     queue_id      message queue ID obtained with \ref osMessageCreate.
641 /// \param[in]     info          message information.
642 /// \param[in]     millisec      timeout value or 0 in case of no time-out.
644 /// \note MUST REMAIN UNCHANGED: \b osMessagePut shall be consistent in every CMSIS-RTOS.
648 /// \param[in]     queue_id      message queue ID obtained with \ref osMessageCreate.
649 /// \param[in]     millisec      timeout value or 0 in case of no time-out.
651 /// \note MUST REMAIN UNCHANGED: \b osMessageGet shall be consistent in every CMSIS-RTOS.
663 /// \param         queue_sz      maximum number of messages in queue
666 ///       macro body is implementation specific in every CMSIS-RTOS.
679 ///       macro body is implementation specific in every CMSIS-RTOS.
684 /// \param[in]     queue_def     reference to the mail queue definition obtain with \ref osMailQ
685 /// \param[in]     thread_id     thread ID (obtained by \ref osThreadCreate or \ref osThreadGetId) …
686 /// \return mail queue ID for reference by other functions or NULL in case of error.
687 /// \note MUST REMAIN UNCHANGED: \b osMailCreate shall be consistent in every CMSIS-RTOS.
691 /// \param[in]     queue_id      mail queue ID obtained with \ref osMailCreate.
692 /// \param[in]     millisec      timeout value or 0 in case of no time-out
693 /// \return pointer to memory block that can be filled with mail or NULL in case error.
694 /// \note MUST REMAIN UNCHANGED: \b osMailAlloc shall be consistent in every CMSIS-RTOS.
698 /// \param[in]     queue_id      mail queue ID obtained with \ref osMailCreate.
699 /// \param[in]     millisec      timeout value or 0 in case of no time-out
700 /// \return pointer to memory block that can shall filled with mail or NULL in case error.
701 /// \note MUST REMAIN UNCHANGED: \b osMailCAlloc shall be consistent in every CMSIS-RTOS.
705 /// \param[in]     queue_id      mail queue ID obtained with \ref osMailCreate.
706 /// \param[in]     mail          memory block previously allocated with \ref osMailAlloc or \ref os…
708 /// \note MUST REMAIN UNCHANGED: \b osMailPut shall be consistent in every CMSIS-RTOS.
712 /// \param[in]     queue_id      mail queue ID obtained with \ref osMailCreate.
713 /// \param[in]     millisec      timeout value or 0 in case of no time-out
715 /// \note MUST REMAIN UNCHANGED: \b osMailGet shall be consistent in every CMSIS-RTOS.
719 /// \param[in]     queue_id      mail queue ID obtained with \ref osMailCreate.
720 /// \param[in]     mail          pointer to the memory block that was obtained with \ref osMailGet.
722 /// \note MUST REMAIN UNCHANGED: \b osMailFree shall be consistent in every CMSIS-RTOS.