Lines Matching full:in
22 * Control functions for short timeouts in microsecond resolution:
32 * not use this file except in compliance with the License.
37 * Unless required by applicable law or agreed to in writing, software
54 /// \note MUST REMAIN UNCHANGED: \b osKernelSystemId shall be consistent in every CMSIS-RTOS.
57 /// \note MUST REMAIN UNCHANGED: \b osFeature_xxx shall be consistent in every CMSIS-RTOS.
81 /// \note MUST REMAIN UNCHANGED: \b osPriority shall be consistent in every CMSIS-RTOS.
94 /// \note MUST REMAIN UNCHANGED: \b osWaitForever shall be consistent in every CMSIS-RTOS.
98 /// \note MUST REMAIN UNCHANGED: \b osStatus shall be consistent in every CMSIS-RTOS.
108 …osErrorISR = 0x82, ///< not allowed in ISR context: the function cannot be cal…
119 /// \note MUST REMAIN UNCHANGED: \b os_timer_type shall be consistent in every CMSIS-RTOS.
126 /// \note MUST REMAIN UNCHANGED: \b os_pthread shall be consistent in every CMSIS-RTOS.
130 /// \note MUST REMAIN UNCHANGED: \b os_ptimer shall be consistent in every CMSIS-RTOS.
136 /// \note CAN BE CHANGED: \b os_thread_cb is implementation specific in every CMSIS-RTOS.
140 /// \note CAN BE CHANGED: \b os_timer_cb is implementation specific in every CMSIS-RTOS.
144 /// \note CAN BE CHANGED: \b os_mutex_cb is implementation specific in every CMSIS-RTOS.
148 /// \note CAN BE CHANGED: \b os_semaphore_cb is implementation specific in every CMSIS-RTOS.
152 /// \note CAN BE CHANGED: \b os_pool_cb is implementation specific in every CMSIS-RTOS.
156 /// \note CAN BE CHANGED: \b os_messageQ_cb is implementation specific in every CMSIS-RTOS.
160 /// \note CAN BE CHANGED: \b os_mailQ_cb is implementation specific in every CMSIS-RTOS.
165 /// \note CAN BE CHANGED: \b os_thread_def is implementation specific in every CMSIS-RTOS.
170 …uint32_t stacksize; ///< stack size requirements in bytes; 0 is default stack size
181 /// \note CAN BE CHANGED: \b os_timer_def is implementation specific in every CMSIS-RTOS.
187 /// \note CAN BE CHANGED: \b os_mutex_def is implementation specific in every CMSIS-RTOS.
193 /// \note CAN BE CHANGED: \b os_semaphore_def is implementation specific in every CMSIS-RTOS.
199 /// \note CAN BE CHANGED: \b os_pool_def is implementation specific in every CMSIS-RTOS.
201 uint32_t pool_sz; ///< number of items (elements) in the pool
207 /// \note CAN BE CHANGED: \b os_messageQ_def is implementation specific in every CMSIS-RTOS.
209 uint32_t queue_sz; ///< number of elements in the queue
216 /// \note CAN BE CHANGED: \b os_mailQ_def is implementation specific in every CMSIS-RTOS.
218 uint32_t queue_sz; ///< number of elements in the queue
225 /// \note MUST REMAIN UNCHANGED: \b os_event shall be consistent in every CMSIS-RTOS.
245 /// \note MUST REMAIN UNCHANGED: \b osKernelInitialize shall be consistent in every CMSIS-RTOS.
250 /// \note MUST REMAIN UNCHANGED: \b osKernelStart shall be consistent in every CMSIS-RTOS.
254 /// \note MUST REMAIN UNCHANGED: \b osKernelRunning shall be consistent in every CMSIS-RTOS.
261 /// \note MUST REMAIN UNCHANGED: \b osKernelSysTick shall be consistent in every CMSIS-RTOS.
265 /// The RTOS kernel system timer frequency in Hz
266 /// \note Reflects the system timer setting and is typically defined in a configuration file.
270 /// \param microsec time value in microseconds.
282 /// \param stacksz stack size (in bytes) requirements for the thread function.
284 /// macro body is implementation specific in every CMSIS-RTOS.
304 /// macro body is implementation specific in every CMSIS-RTOS.
309 /// \param[in] thread_def thread definition referenced with \ref osThread.
310 /// \param[in] argument pointer that is passed to the thread function as start argument.
311 /// \return thread ID for reference by other functions or NULL in case of error.
312 /// \note MUST REMAIN UNCHANGED: \b osThreadCreate shall be consistent in every CMSIS-RTOS.
316 /// \return thread ID for reference by other functions or NULL in case of error.
317 /// \note MUST REMAIN UNCHANGED: \b osThreadGetId shall be consistent in every CMSIS-RTOS.
321 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
323 /// \note MUST REMAIN UNCHANGED: \b osThreadTerminate shall be consistent in every CMSIS-RTOS.
326 /// Pass control to next thread that is in state \b READY.
328 /// \note MUST REMAIN UNCHANGED: \b osThreadYield shall be consistent in every CMSIS-RTOS.
332 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
333 /// \param[in] priority new priority value for the thread function.
335 /// \note MUST REMAIN UNCHANGED: \b osThreadSetPriority shall be consistent in every CMSIS-RTOS.
339 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
341 /// \note MUST REMAIN UNCHANGED: \b osThreadGetPriority shall be consistent in every CMSIS-RTOS.
348 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue "time delay" value
355 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out
357 /// \note MUST REMAIN UNCHANGED: \b osWait shall be consistent in every CMSIS-RTOS.
368 /// macro body is implementation specific in every CMSIS-RTOS.
381 /// macro body is implementation specific in every CMSIS-RTOS.
386 /// \param[in] timer_def timer object referenced with \ref osTimer.
387 /// \param[in] type osTimerOnce for one-shot or osTimerPeriodic for periodic behavior.
388 /// \param[in] argument argument to the timer call back function.
389 /// \return timer ID for reference by other functions or NULL in case of error.
390 /// \note MUST REMAIN UNCHANGED: \b osTimerCreate shall be consistent in every CMSIS-RTOS.
394 /// \param[in] timer_id timer ID obtained by \ref osTimerCreate.
395 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue "time delay" value of the timer.
397 /// \note MUST REMAIN UNCHANGED: \b osTimerStart shall be consistent in every CMSIS-RTOS.
401 /// \param[in] timer_id timer ID obtained by \ref osTimerCreate.
403 /// \note MUST REMAIN UNCHANGED: \b osTimerStop shall be consistent in every CMSIS-RTOS.
407 /// \param[in] timer_id timer ID obtained by \ref osTimerCreate.
409 /// \note MUST REMAIN UNCHANGED: \b osTimerDelete shall be consistent in every CMSIS-RTOS.
416 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
417 /// \param[in] signals specifies the signal flags of the thread that should be set.
418 /// \return previous signal flags of the specified thread or 0x80000000 in case of incorrect parame…
419 /// \note MUST REMAIN UNCHANGED: \b osSignalSet shall be consistent in every CMSIS-RTOS.
423 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
424 /// \param[in] signals specifies the signal flags of the thread that shall be cleared.
425 /// \return previous signal flags of the specified thread or 0x80000000 in case of incorrect parame…
426 /// \note MUST REMAIN UNCHANGED: \b osSignalClear shall be consistent in every CMSIS-RTOS.
430 /// \param[in] signals wait until all specified signal flags set or 0 for any single sign…
431 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
433 /// \note MUST REMAIN UNCHANGED: \b osSignalWait shall be consistent in every CMSIS-RTOS.
442 /// macro body is implementation specific in every CMSIS-RTOS.
454 /// macro body is implementation specific in every CMSIS-RTOS.
459 /// \param[in] mutex_def mutex definition referenced with \ref osMutex.
460 /// \return mutex ID for reference by other functions or NULL in case of error.
461 /// \note MUST REMAIN UNCHANGED: \b osMutexCreate shall be consistent in every CMSIS-RTOS.
465 /// \param[in] mutex_id mutex ID obtained by \ref osMutexCreate.
466 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
468 /// \note MUST REMAIN UNCHANGED: \b osMutexWait shall be consistent in every CMSIS-RTOS.
472 /// \param[in] mutex_id mutex ID obtained by \ref osMutexCreate.
474 /// \note MUST REMAIN UNCHANGED: \b osMutexRelease shall be consistent in every CMSIS-RTOS.
478 /// \param[in] mutex_id mutex ID obtained by \ref osMutexCreate.
480 /// \note MUST REMAIN UNCHANGED: \b osMutexDelete shall be consistent in every CMSIS-RTOS.
491 /// macro body is implementation specific in every CMSIS-RTOS.
503 /// macro body is implementation specific in every CMSIS-RTOS.
508 /// \param[in] semaphore_def semaphore definition referenced with \ref osSemaphore.
509 /// \param[in] count number of available resources.
510 /// \return semaphore ID for reference by other functions or NULL in case of error.
511 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreCreate shall be consistent in every CMSIS-RTOS.
515 /// \param[in] semaphore_id semaphore object referenced with \ref osSemaphoreCreate.
516 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
517 /// \return number of available tokens, or -1 in case of incorrect parameters.
518 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreWait shall be consistent in every CMSIS-RTOS.
522 /// \param[in] semaphore_id semaphore object referenced with \ref osSemaphoreCreate.
524 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreRelease shall be consistent in every CMSIS-RTOS.
528 /// \param[in] semaphore_id semaphore object referenced with \ref osSemaphoreCreate.
530 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreDelete shall be consistent in every CMSIS-RTOS.
542 /// \param no maximum number of blocks (objects) in the memory pool.
545 /// macro body is implementation specific in every CMSIS-RTOS.
559 /// macro body is implementation specific in every CMSIS-RTOS.
564 /// \param[in] pool_def memory pool definition referenced with \ref osPool.
565 /// \return memory pool ID for reference by other functions or NULL in case of error.
566 /// \note MUST REMAIN UNCHANGED: \b osPoolCreate shall be consistent in every CMSIS-RTOS.
570 /// \param[in] pool_id memory pool ID obtain referenced with \ref osPoolCreate.
571 /// \return address of the allocated memory block or NULL in case of no memory available.
572 /// \note MUST REMAIN UNCHANGED: \b osPoolAlloc shall be consistent in every CMSIS-RTOS.
576 /// \param[in] pool_id memory pool ID obtain referenced with \ref osPoolCreate.
577 /// \return address of the allocated memory block or NULL in case of no memory available.
578 /// \note MUST REMAIN UNCHANGED: \b osPoolCAlloc shall be consistent in every CMSIS-RTOS.
582 /// \param[in] pool_id memory pool ID obtain referenced with \ref osPoolCreate.
583 /// \param[in] block address of the allocated memory block that is returned to the memo…
585 /// \note MUST REMAIN UNCHANGED: \b osPoolFree shall be consistent in every CMSIS-RTOS.
597 /// \param queue_sz maximum number of messages in the queue.
600 /// macro body is implementation specific in every CMSIS-RTOS.
615 /// macro body is implementation specific in every CMSIS-RTOS.
620 /// \param[in] queue_def queue definition referenced with \ref osMessageQ.
621 /// \param[in] thread_id thread ID (obtained by \ref osThreadCreate or \ref osThreadGetId) …
622 /// \return message queue ID for reference by other functions or NULL in case of error.
623 /// \note MUST REMAIN UNCHANGED: \b osMessageCreate shall be consistent in every CMSIS-RTOS.
627 /// \param[in] queue_id message queue ID obtained with \ref osMessageCreate.
628 /// \param[in] info message information.
629 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
631 /// \note MUST REMAIN UNCHANGED: \b osMessagePut shall be consistent in every CMSIS-RTOS.
635 /// \param[in] queue_id message queue ID obtained with \ref osMessageCreate.
636 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
638 /// \note MUST REMAIN UNCHANGED: \b osMessageGet shall be consistent in every CMSIS-RTOS.
650 /// \param queue_sz maximum number of messages in queue
653 /// macro body is implementation specific in every CMSIS-RTOS.
668 /// macro body is implementation specific in every CMSIS-RTOS.
673 /// \param[in] queue_def reference to the mail queue definition obtain with \ref osMailQ
674 /// \param[in] thread_id thread ID (obtained by \ref osThreadCreate or \ref osThreadGetId) …
675 /// \return mail queue ID for reference by other functions or NULL in case of error.
676 /// \note MUST REMAIN UNCHANGED: \b osMailCreate shall be consistent in every CMSIS-RTOS.
680 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
681 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out
682 /// \return pointer to memory block that can be filled with mail or NULL in case of error.
683 /// \note MUST REMAIN UNCHANGED: \b osMailAlloc shall be consistent in every CMSIS-RTOS.
687 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
688 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out
689 /// \return pointer to memory block that can be filled with mail or NULL in case of error.
690 /// \note MUST REMAIN UNCHANGED: \b osMailCAlloc shall be consistent in every CMSIS-RTOS.
694 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
695 /// \param[in] mail memory block previously allocated with \ref osMailAlloc or \ref os…
697 /// \note MUST REMAIN UNCHANGED: \b osMailPut shall be consistent in every CMSIS-RTOS.
701 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
702 /// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out
704 /// \note MUST REMAIN UNCHANGED: \b osMailGet shall be consistent in every CMSIS-RTOS.
708 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
709 /// \param[in] mail pointer to the memory block that was obtained with \ref osMailGet.
711 /// \note MUST REMAIN UNCHANGED: \b osMailFree shall be consistent in every CMSIS-RTOS.