michaelh/zephyr
1
0
Fork 0
Code Releases Activity

docs: cleanup cmsis RTOS api docs

Browse source 
Fix formatting of the CMSIS RTOS APIs.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-07-14 09:15:43 -04:00
commit ae5776051a
1 changed files with 34 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

66
doc/guides/portability/cmsis_rtos_v2.rst
View file

@ -14,72 +14,74 @@ Features not supported in Zephyr implementation
*********************************************** ***********************************************
Kernel Kernel
osKernelGetState, osKernelSuspend, osKernelResume, osKernelInitialize ``osKernelGetState``, ``osKernelSuspend``, ``osKernelResume``, ``osKernelInitialize``
and osKernelStart are not supported. and ``osKernelStart`` are not supported.
Mutex Mutex
osMutexPrioInherit is supported by default and is not configurable, ``osMutexPrioInherit`` is supported by default and is not configurable,
you cannot select/unselect this attribute. you cannot select/unselect this attribute.
osMutexRecursive is also supported by default. If this attribute is
``osMutexRecursive`` is also supported by default. If this attribute is
not set, an error is thrown when the same thread tries to acquire not set, an error is thrown when the same thread tries to acquire
it the second time. it the second time.
osMutexRobust is not supported in Zephyr.
``osMutexRobust`` is not supported in Zephyr.
Return values not supported in the Zephyr implementation Return values not supported in the Zephyr implementation
******************************************************** ********************************************************
osKernelUnlock, osKernelLock, osKernelRestoreLock ``osKernelUnlock``, ``osKernelLock``, ``osKernelRestoreLock``
osError (Unspecified error) is not supported. ``osError`` (Unspecified error) is not supported.
osSemaphoreDelete ``osSemaphoreDelete``
osErrorResource (the semaphore specified by parameter ``osErrorResource`` (the semaphore specified by parameter
semaphore_id is in an invalid semaphore state) is not supported. semaphore_id is in an invalid semaphore state) is not supported.
osMutexDelete ``osMutexDelete``
osErrorResource (mutex specified by parameter mutex_id ``osErrorResource`` (mutex specified by parameter mutex_id
is in an invalid mutex state) is not supported. is in an invalid mutex state) is not supported.
osTimerDelete ``osTimerDelete``
osErrorResource (the timer specified by parameter timer_id ``osErrorResource`` (the timer specified by parameter timer_id
is in an invalid timer state) is not supported. is in an invalid timer state) is not supported.
osMessageQueueReset ``osMessageQueueReset``
osErrorResource (the message queue specified by ``osErrorResource`` (the message queue specified by
parameter msgq_id is in an invalid message queue state) parameter msgq_id is in an invalid message queue state)
is not supported. is not supported.
osMessageQueueDelete ``osMessageQueueDelete``
osErrorResource (the message queue specified by ``osErrorResource`` (the message queue specified by
parameter msgq_id is in an invalid message queue state) parameter msgq_id is in an invalid message queue state)
is not supported. is not supported.
osMemoryPoolFree ``osMemoryPoolFree``
osErrorResource (the memory pool specified by ``osErrorResource`` (the memory pool specified by
parameter mp_id is in an invalid memory pool state) is parameter mp_id is in an invalid memory pool state) is
not supported. not supported.
osMemoryPoolDelete ``osMemoryPoolDelete``
osErrorResource (the memory pool specified by ``osErrorResource`` (the memory pool specified by
parameter mp_id is in an invalid memory pool state) is parameter mp_id is in an invalid memory pool state) is
not supported. not supported.
osEventFlagsSet, osEventFlagsClear ``osEventFlagsSet``, ``osEventFlagsClear``
osFlagsErrorUnknown (Unspecified error) ``osFlagsErrorUnknown`` (Unspecified error)
and osFlagsErrorResource (Event flags object specified by and osFlagsErrorResource (Event flags object specified by
parameter ef_id is not ready to be used) are not supported. parameter ef_id is not ready to be used) are not supported.
osEventFlagsDelete ``osEventFlagsDelete``
osErrorParameter (the value of the parameter ef_id is ``osErrorParameter`` (the value of the parameter ef_id is
incorrect) is not supported. incorrect) is not supported.
osThreadFlagsSet ``osThreadFlagsSet``
osFlagsErrorUnknown (Unspecified error) and ``osFlagsErrorUnknown`` (Unspecified error) and
osFlagsErrorResource (Thread specified by parameter ``osFlagsErrorResource`` (Thread specified by parameter
thread_id is not active to receive flags) are not supported. thread_id is not active to receive flags) are not supported.
osThreadFlagsClear ``osThreadFlagsClear``
osFlagsErrorResource (Running thread is not active to ``osFlagsErrorResource`` (Running thread is not active to
receive flags) is not supported. receive flags) is not supported.
osDelayUntil ``osDelayUntil``
osParameter (the time cannot be handled) is not supported. ``osParameter`` (the time cannot be handled) is not supported.