|
|
@@ -0,0 +1,667 @@
|
|
|
+/*
|
|
|
+ * Copyright (c) 2013-2016 ARM Limited. All rights reserved.
|
|
|
+ *
|
|
|
+ * SPDX-License-Identifier: Apache-2.0
|
|
|
+ *
|
|
|
+ * Licensed under the Apache License, Version 2.0 (the License); you may
|
|
|
+ * not use this file except in compliance with the License.
|
|
|
+ * You may obtain a copy of the License at
|
|
|
+ *
|
|
|
+ * http://www.apache.org/licenses/LICENSE-2.0
|
|
|
+ *
|
|
|
+ * Unless required by applicable law or agreed to in writing, software
|
|
|
+ * distributed under the License is distributed on an AS IS BASIS, WITHOUT
|
|
|
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
+ * See the License for the specific language governing permissions and
|
|
|
+ * limitations under the License.
|
|
|
+ *
|
|
|
+ * ----------------------------------------------------------------------
|
|
|
+ *
|
|
|
+ * $Date: 30. June 2016
|
|
|
+ * $Revision: V2.0
|
|
|
+ *
|
|
|
+ * Project: CMSIS-RTOS2 API
|
|
|
+ * Title: cmsis_os2.h header file
|
|
|
+ *
|
|
|
+ * Version 2.0
|
|
|
+ * Initial Release
|
|
|
+ *---------------------------------------------------------------------------*/
|
|
|
+
|
|
|
+#ifndef __CMSIS_OS2_H
|
|
|
+#define __CMSIS_OS2_H
|
|
|
+
|
|
|
+#if defined(__CC_ARM)
|
|
|
+#define __NO_RETURN __declspec(noreturn)
|
|
|
+#elif defined(__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)
|
|
|
+#define __NO_RETURN __attribute__((noreturn))
|
|
|
+#elif defined(__GNUC__)
|
|
|
+#define __NO_RETURN __attribute__((noreturn))
|
|
|
+#elif defined(__ICCARM__)
|
|
|
+#define __NO_RETURN __noreturn
|
|
|
+#else
|
|
|
+#define __NO_RETURN
|
|
|
+#endif
|
|
|
+
|
|
|
+#include <stdint.h>
|
|
|
+#include <stddef.h>
|
|
|
+
|
|
|
+#ifdef __cplusplus
|
|
|
+extern "C"
|
|
|
+{
|
|
|
+#endif
|
|
|
+
|
|
|
+
|
|
|
+// ==== Enumerations, structures, defines ====
|
|
|
+
|
|
|
+/// Version information.
|
|
|
+typedef struct osVersion_s {
|
|
|
+ uint32_t api; ///< API version (major.minor.rev: mmnnnrrrr dec).
|
|
|
+ uint32_t kernel; ///< Kernel version (major.minor.rev: mmnnnrrrr dec).
|
|
|
+} osVersion_t;
|
|
|
+
|
|
|
+/// Kernel state.
|
|
|
+typedef enum {
|
|
|
+ osKernelInactive = 0, ///< Inactive.
|
|
|
+ osKernelReady = 1, ///< Ready.
|
|
|
+ osKernelRunning = 2, ///< Running.
|
|
|
+ osKernelLocked = 3, ///< Locked.
|
|
|
+ osKernelSuspended = 4, ///< Suspended.
|
|
|
+ osKernelError = -1, ///< Error.
|
|
|
+ osKernelReserved = 0x7FFFFFFFU ///< Prevents enum down-size compiler optimization.
|
|
|
+} osKernelState_t;
|
|
|
+
|
|
|
+/// Thread state.
|
|
|
+typedef enum {
|
|
|
+ osThreadInactive = 0, ///< Inactive.
|
|
|
+ osThreadReady = 1, ///< Ready.
|
|
|
+ osThreadRunning = 2, ///< Running.
|
|
|
+ osThreadWaiting = 3, ///< Waiting.
|
|
|
+ osThreadSuspended = 4, ///< Suspended.
|
|
|
+ osThreadTerminated = 5, ///< Terminated.
|
|
|
+ osThreadError = -1, ///< Error.
|
|
|
+ osThreadReserved = 0x7FFFFFFF ///< Prevents enum down-size compiler optimization.
|
|
|
+} osThreadState_t;
|
|
|
+
|
|
|
+/// Priority values.
|
|
|
+typedef enum {
|
|
|
+ osPriorityNone = 0, ///< No priority (not initialized).
|
|
|
+ osPriorityIdle = 1, ///< Reserved for Idle thread.
|
|
|
+ osPriorityLow = 8, ///< Priority: low
|
|
|
+ osPriorityLow1 = 8+1, ///< Priority: low + 1
|
|
|
+ osPriorityLow2 = 8+2, ///< Priority: low + 2
|
|
|
+ osPriorityLow3 = 8+3, ///< Priority: low + 3
|
|
|
+ osPriorityLow4 = 8+4, ///< Priority: low + 4
|
|
|
+ osPriorityLow5 = 8+5, ///< Priority: low + 5
|
|
|
+ osPriorityLow6 = 8+6, ///< Priority: low + 6
|
|
|
+ osPriorityLow7 = 8+7, ///< Priority: low + 7
|
|
|
+ osPriorityBelowNormal = 16, ///< Priority: below normal
|
|
|
+ osPriorityBelowNormal1 = 16+1, ///< Priority: below normal + 1
|
|
|
+ osPriorityBelowNormal2 = 16+2, ///< Priority: below normal + 2
|
|
|
+ osPriorityBelowNormal3 = 16+3, ///< Priority: below normal + 3
|
|
|
+ osPriorityBelowNormal4 = 16+4, ///< Priority: below normal + 4
|
|
|
+ osPriorityBelowNormal5 = 16+5, ///< Priority: below normal + 5
|
|
|
+ osPriorityBelowNormal6 = 16+6, ///< Priority: below normal + 6
|
|
|
+ osPriorityBelowNormal7 = 16+7, ///< Priority: below normal + 7
|
|
|
+ osPriorityNormal = 24, ///< Priority: normal
|
|
|
+ osPriorityNormal1 = 24+1, ///< Priority: normal + 1
|
|
|
+ osPriorityNormal2 = 24+2, ///< Priority: normal + 2
|
|
|
+ osPriorityNormal3 = 24+3, ///< Priority: normal + 3
|
|
|
+ osPriorityNormal4 = 24+4, ///< Priority: normal + 4
|
|
|
+ osPriorityNormal5 = 24+5, ///< Priority: normal + 5
|
|
|
+ osPriorityNormal6 = 24+6, ///< Priority: normal + 6
|
|
|
+ osPriorityNormal7 = 24+7, ///< Priority: normal + 7
|
|
|
+ osPriorityAboveNormal = 32, ///< Priority: above normal
|
|
|
+ osPriorityAboveNormal1 = 32+1, ///< Priority: above normal + 1
|
|
|
+ osPriorityAboveNormal2 = 32+2, ///< Priority: above normal + 2
|
|
|
+ osPriorityAboveNormal3 = 32+3, ///< Priority: above normal + 3
|
|
|
+ osPriorityAboveNormal4 = 32+4, ///< Priority: above normal + 4
|
|
|
+ osPriorityAboveNormal5 = 32+5, ///< Priority: above normal + 5
|
|
|
+ osPriorityAboveNormal6 = 32+6, ///< Priority: above normal + 6
|
|
|
+ osPriorityAboveNormal7 = 32+7, ///< Priority: above normal + 7
|
|
|
+ osPriorityHigh = 40, ///< Priority: high
|
|
|
+ osPriorityHigh1 = 40+1, ///< Priority: high + 1
|
|
|
+ osPriorityHigh2 = 40+2, ///< Priority: high + 2
|
|
|
+ osPriorityHigh3 = 40+3, ///< Priority: high + 3
|
|
|
+ osPriorityHigh4 = 40+4, ///< Priority: high + 4
|
|
|
+ osPriorityHigh5 = 40+5, ///< Priority: high + 5
|
|
|
+ osPriorityHigh6 = 40+6, ///< Priority: high + 6
|
|
|
+ osPriorityHigh7 = 40+7, ///< Priority: high + 7
|
|
|
+ osPriorityRealtime = 48, ///< Priority: realtime
|
|
|
+ osPriorityRealtime1 = 48+1, ///< Priority: realtime + 1
|
|
|
+ osPriorityRealtime2 = 48+2, ///< Priority: realtime + 2
|
|
|
+ osPriorityRealtime3 = 48+3, ///< Priority: realtime + 3
|
|
|
+ osPriorityRealtime4 = 48+4, ///< Priority: realtime + 4
|
|
|
+ osPriorityRealtime5 = 48+5, ///< Priority: realtime + 5
|
|
|
+ osPriorityRealtime6 = 48+6, ///< Priority: realtime + 6
|
|
|
+ osPriorityRealtime7 = 48+7, ///< Priority: realtime + 7
|
|
|
+ osPriorityISR = 56, ///< Reserved for ISR deferred thread.
|
|
|
+ osPriorityError = -1, ///< System cannot determine priority or illegal priority.
|
|
|
+ osPriorityReserved = 0x7FFFFFFF ///< Prevents enum down-size compiler optimization.
|
|
|
+} osPriority_t;
|
|
|
+
|
|
|
+/// Entry point of a thread.
|
|
|
+typedef void *(*os_thread_func_t) (void *argument);
|
|
|
+
|
|
|
+/// Entry point of a timer call back function.
|
|
|
+typedef void (*os_timer_func_t) (void *argument);
|
|
|
+
|
|
|
+/// Timer type.
|
|
|
+typedef enum {
|
|
|
+ osTimerOnce = 0, ///< One-shot timer.
|
|
|
+ osTimerPeriodic = 1 ///< Repeating timer.
|
|
|
+} osTimerType_t;
|
|
|
+
|
|
|
+/// Timeout value.
|
|
|
+#define osWaitForever 0xFFFFFFFFU ///< Wait forever timeout value.
|
|
|
+
|
|
|
+/// Flags options (\ref osThreadFlagsWait and \ref osEventFlagsWait).
|
|
|
+#define osFlagsWaitAny 0x00000000U ///< Wait for any flag (default).
|
|
|
+#define osFlagsWaitAll 0x00000001U ///< Wait for all flags.
|
|
|
+#define osFlagsAutoClear 0x00000002U ///< Clear flags which have been specified to wait for.
|
|
|
+
|
|
|
+/// Thread attributes (attr_bits in \ref osThreadAttr_t).
|
|
|
+#define osThreadJoinable 0x00000000U ///< Thread created in joinable state (default)
|
|
|
+#define osThreadDetached 0x00000001U ///< Thread created in detached state
|
|
|
+
|
|
|
+/// Mutex attributes (attr_bits in \ref osMutexAttr_t).
|
|
|
+#define osMutexRecursive 0x00000001U ///< Recursive mutex.
|
|
|
+#define osMutexPrioInherit 0x00000002U ///< Priority inherit protocol.
|
|
|
+#define osMutexRobust 0x00000008U ///< Robust mutex.
|
|
|
+
|
|
|
+/// Status code values returned by CMSIS-RTOS functions.
|
|
|
+typedef enum {
|
|
|
+ osOK = 0, ///< Operation completed successfully.
|
|
|
+ osError = -1, ///< Unspecified RTOS error: run-time error but no other error message fits.
|
|
|
+ osErrorTimeout = -2, ///< Operation not completed within the timeout period.
|
|
|
+ osErrorResource = -3, ///< Resource not available.
|
|
|
+ osErrorParameter = -4, ///< Parameter error.
|
|
|
+ osErrorNoMemory = -5, ///< System is out of memory: it was impossible to allocate or reserve memory for the operation.
|
|
|
+ osErrorISR = -6, ///< Not allowed in ISR context: the function cannot be called from interrupt service routines.
|
|
|
+ osStatusReserved = 0x7FFFFFFF ///< Prevents enum down-size compiler optimization.
|
|
|
+} osStatus_t;
|
|
|
+
|
|
|
+
|
|
|
+/// \details Thread ID identifies the thread.
|
|
|
+typedef uint32_t osThreadId_t;
|
|
|
+
|
|
|
+/// \details Timer ID identifies the timer.
|
|
|
+typedef uint32_t osTimerId_t;
|
|
|
+
|
|
|
+/// \details Event Flags ID identifies the event flags.
|
|
|
+typedef uint32_t osEventFlagsId_t;
|
|
|
+
|
|
|
+/// \details Mutex ID identifies the mutex.
|
|
|
+typedef uint32_t osMutexId_t;
|
|
|
+
|
|
|
+/// \details Semaphore ID identifies the semaphore.
|
|
|
+typedef uint32_t osSemaphoreId_t;
|
|
|
+
|
|
|
+/// \details Memory Pool ID identifies the memory pool.
|
|
|
+typedef uint32_t osMemoryPoolId_t;
|
|
|
+
|
|
|
+/// \details Message Queue ID identifies the message queue.
|
|
|
+typedef uint32_t osMessageQueueId_t;
|
|
|
+
|
|
|
+
|
|
|
+/// Attributes structure for thread.
|
|
|
+typedef struct osThreadAttr_s {
|
|
|
+ const char *name; ///< name of the thread
|
|
|
+ uint32_t attr_bits; ///< attribute bits
|
|
|
+ void *cb_mem; ///< memory for control block
|
|
|
+ uint32_t cb_size; ///< size of provided memory for control block
|
|
|
+ void *stack_mem; ///< memory for stack
|
|
|
+ uint32_t stack_size; ///< size of stack
|
|
|
+ osPriority_t priority; ///< initial thread priority (default: osPriorityNormal)
|
|
|
+ uint32_t reserved[2]; ///< reserved (must be 0)
|
|
|
+} osThreadAttr_t;
|
|
|
+
|
|
|
+/// Attributes structure for timer.
|
|
|
+typedef struct osTimerAttr_s {
|
|
|
+ const char *name; ///< name of the timer
|
|
|
+ uint32_t attr_bits; ///< attribute bits
|
|
|
+ void *cb_mem; ///< memory for control block
|
|
|
+ uint32_t cb_size; ///< size of provided memory for control block
|
|
|
+} osTimerAttr_t;
|
|
|
+
|
|
|
+/// Attributes structure for event flags.
|
|
|
+typedef struct osEventFlagsAttr_s {
|
|
|
+ const char *name; ///< name of the event flags
|
|
|
+ uint32_t attr_bits; ///< attribute bits
|
|
|
+ void *cb_mem; ///< memory for control block
|
|
|
+ uint32_t cb_size; ///< size of provided memory for control block
|
|
|
+} osEventFlagsAttr_t;
|
|
|
+
|
|
|
+/// Attributes structure for mutex.
|
|
|
+typedef struct osMutexAttr_s {
|
|
|
+ const char *name; ///< name of the mutex
|
|
|
+ uint32_t attr_bits; ///< attribute bits
|
|
|
+ void *cb_mem; ///< memory for control block
|
|
|
+ uint32_t cb_size; ///< size of provided memory for control block
|
|
|
+} osMutexAttr_t;
|
|
|
+
|
|
|
+/// Attributes structure for semaphore.
|
|
|
+typedef struct osSemaphoreAttr_s {
|
|
|
+ const char *name; ///< name of the semaphore
|
|
|
+ uint32_t attr_bits; ///< attribute bits
|
|
|
+ void *cb_mem; ///< memory for control block
|
|
|
+ uint32_t cb_size; ///< size of provided memory for control block
|
|
|
+} osSemaphoreAttr_t;
|
|
|
+
|
|
|
+/// Attributes structure for memory pool.
|
|
|
+typedef struct osMemoryPoolAttr_s {
|
|
|
+ const char *name; ///< name of the memory pool
|
|
|
+ uint32_t attr_bits; ///< attribute bits
|
|
|
+ void *cb_mem; ///< memory for control block
|
|
|
+ uint32_t cb_size; ///< size of provided memory for control block
|
|
|
+ void *mp_mem; ///< memory for data storage
|
|
|
+ uint32_t mp_size; ///< size of provided memory for data storage
|
|
|
+} osMemoryPoolAttr_t;
|
|
|
+
|
|
|
+/// Attributes structure for message queue.
|
|
|
+typedef struct osMessageQueueAttr_s {
|
|
|
+ const char *name; ///< name of the message queue
|
|
|
+ uint32_t attr_bits; ///< attribute bits
|
|
|
+ void *cb_mem; ///< memory for control block
|
|
|
+ uint32_t cb_size; ///< size of provided memory for control block
|
|
|
+ void *mq_mem; ///< memory for data storage
|
|
|
+ uint32_t mq_size; ///< size of provided memory for data storage
|
|
|
+} osMessageQueueAttr_t;
|
|
|
+
|
|
|
+
|
|
|
+// ==== Kernel Management Functions ====
|
|
|
+
|
|
|
+/// Initialize the RTOS Kernel.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osKernelInitialize (void);
|
|
|
+
|
|
|
+/// Get RTOS Kernel Information.
|
|
|
+/// \param[out] version pointer to buffer for retrieving version information.
|
|
|
+/// \param[out] id_buf pointer to buffer for retrieving kernel identification string.
|
|
|
+/// \param[in] id_size maximum size of buffer for kernel identification string.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osKernelGetInfo (osVersion_t *version, char *id_buf, uint32_t id_size);
|
|
|
+
|
|
|
+/// Get the current RTOS Kernel state.
|
|
|
+/// \return current RTOS Kernel state.
|
|
|
+osKernelState_t osKernelGetState (void);
|
|
|
+
|
|
|
+/// Start the RTOS Kernel scheduler.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osKernelStart (void);
|
|
|
+
|
|
|
+/// Lock the RTOS Kernel scheduler.
|
|
|
+/// \return 0 already locked, 1 locked.
|
|
|
+uint32_t osKernelLock (void);
|
|
|
+
|
|
|
+/// Unlock the RTOS Kernel scheduler.
|
|
|
+void osKernelUnlock (void);
|
|
|
+
|
|
|
+/// Suspend the RTOS Kernel scheduler.
|
|
|
+/// \return time in millisec, for how long the system can sleep or power-down.
|
|
|
+uint32_t osKernelSuspend (void);
|
|
|
+
|
|
|
+/// Resume the RTOS Kernel scheduler.
|
|
|
+/// \param[in] sleep_time time in millisec for how long the system was in sleep or power-down mode.
|
|
|
+void osKernelResume (uint32_t sleep_time);
|
|
|
+
|
|
|
+/// Get the RTOS kernel time.
|
|
|
+/// \return RTOS kernel current time in millisec.
|
|
|
+uint64_t osKernelGetTime (void);
|
|
|
+
|
|
|
+/// Get the RTOS kernel system timer counter.
|
|
|
+/// \return RTOS kernel system timer as 32-bit value.
|
|
|
+uint32_t osKernelGetTick (void);
|
|
|
+
|
|
|
+/// Convert a microseconds value to a RTOS kernel system timer value.
|
|
|
+/// \param microsec time value in microseconds.
|
|
|
+/// \return time value normalized to the system timer ticks.
|
|
|
+uint32_t osKernelTickMicroSec (uint32_t microsec);
|
|
|
+
|
|
|
+
|
|
|
+// ==== Thread Management Functions ====
|
|
|
+
|
|
|
+/// Create a thread and add it to Active Threads.
|
|
|
+/// \param[in] func thread function.
|
|
|
+/// \param[in] argument pointer that is passed to the thread function as start argument.
|
|
|
+/// \param[in] attr thread attributes; NULL: default values.
|
|
|
+/// \return thread ID for reference by other functions or NULL in case of error.
|
|
|
+osThreadId_t osThreadNew (os_thread_func_t func, void *argument, const osThreadAttr_t *attr);
|
|
|
+
|
|
|
+/// Return the thread ID of the current running thread.
|
|
|
+/// \return thread ID for reference by other functions or NULL in case of error.
|
|
|
+osThreadId_t osThreadGetId (void);
|
|
|
+
|
|
|
+/// Get current thread state of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \return current thread state of the specified thread.
|
|
|
+osThreadState_t osThreadGetState (osThreadId_t thread_id);
|
|
|
+
|
|
|
+/// Change priority of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \param[in] priority new priority value for the thread function.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osThreadSetPriority (osThreadId_t thread_id, osPriority_t priority);
|
|
|
+
|
|
|
+/// Get current priority of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \return current priority value of the specified thread.
|
|
|
+osPriority_t osThreadGetPriority (osThreadId_t thread_id);
|
|
|
+
|
|
|
+/// Pass control to next thread that is in state \b READY.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osThreadYield (void);
|
|
|
+
|
|
|
+/// Abort waiting operation of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osThreadAbortWait (osThreadId_t thread_id);
|
|
|
+
|
|
|
+/// Suspend execution of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osThreadSuspend (osThreadId_t thread_id);
|
|
|
+
|
|
|
+/// Resume execution of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osThreadResume (osThreadId_t thread_id);
|
|
|
+
|
|
|
+/// Detach a thread (thread storage can be reclaimed when thread terminates).
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osThreadDetach (osThreadId_t thread_id);
|
|
|
+
|
|
|
+/// Wait for specified thread to terminate.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \param[out] exit_ptr pointer to thread exit pointer value.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osThreadJoin (osThreadId_t thread_id, void **exit_ptr);
|
|
|
+
|
|
|
+/// Terminate execution of current running thread.
|
|
|
+/// \param[in] exit_ptr thread exit pointer value.
|
|
|
+__NO_RETURN void osThreadExit (void *exit_ptr);
|
|
|
+
|
|
|
+/// Terminate execution of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osThreadTerminate (osThreadId_t thread_id);
|
|
|
+
|
|
|
+
|
|
|
+// ==== Thread Flags Functions ====
|
|
|
+
|
|
|
+/// Set the specified Thread Flags of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \param[in] flags specifies the flags of the thread that shall be set.
|
|
|
+/// \return thread flags after setting or error code if negative.
|
|
|
+int32_t osThreadFlagsSet (osThreadId_t thread_id, int32_t flags);
|
|
|
+
|
|
|
+/// Clear the specified Thread Flags of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \param[in] flags specifies the flags of the thread that shall be cleared.
|
|
|
+/// \return thread flags before clearing or error code if negative.
|
|
|
+int32_t osThreadFlagsClear (osThreadId_t thread_id, int32_t flags);
|
|
|
+
|
|
|
+/// Get the current Thread Flags of a thread.
|
|
|
+/// \param[in] thread_id thread ID obtained by \ref osThreadNew or \ref osThreadGetId.
|
|
|
+/// \return current thread flags.
|
|
|
+int32_t osThreadFlagsGet (osThreadId_t thread_id);
|
|
|
+
|
|
|
+/// Wait for one or more Thread Flags of the current running thread to become signaled.
|
|
|
+/// \param[in] flags specifies the flags to wait for.
|
|
|
+/// \param[in] options specifies flags options (osFlagsXxxx).
|
|
|
+/// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
|
|
|
+/// \return thread flags before clearing or error code if negative.
|
|
|
+int32_t osThreadFlagsWait (int32_t flags, uint32_t options, uint32_t millisec);
|
|
|
+
|
|
|
+
|
|
|
+// ==== Generic Wait Functions ====
|
|
|
+
|
|
|
+/// Wait for Timeout (Time Delay).
|
|
|
+/// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue "time delay" value
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osDelay (uint32_t millisec);
|
|
|
+
|
|
|
+/// Wait until specified time.
|
|
|
+/// \param[in] millisec absolute time in millisec
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osDelayUntil (uint64_t millisec);
|
|
|
+
|
|
|
+
|
|
|
+// ==== Timer Management Functions ====
|
|
|
+
|
|
|
+/// Create and Initialize a timer.
|
|
|
+/// \param[in] func start address of a timer call back function.
|
|
|
+/// \param[in] type osTimerOnce for one-shot or osTimerPeriodic for periodic behavior.
|
|
|
+/// \param[in] argument argument to the timer call back function.
|
|
|
+/// \param[in] attr timer attributes; NULL: default values.
|
|
|
+/// \return timer ID for reference by other functions or NULL in case of error.
|
|
|
+osTimerId_t osTimerNew (os_timer_func_t func, osTimerType_t type, void *argument, const osTimerAttr_t *attr);
|
|
|
+
|
|
|
+/// Start or restart a timer.
|
|
|
+/// \param[in] timer_id timer ID obtained by \ref osTimerNew.
|
|
|
+/// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue "time delay" value of the timer.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osTimerStart (osTimerId_t timer_id, uint32_t millisec);
|
|
|
+
|
|
|
+/// Stop a timer.
|
|
|
+/// \param[in] timer_id timer ID obtained by \ref osTimerNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osTimerStop (osTimerId_t timer_id);
|
|
|
+
|
|
|
+/// Check if a timer is running.
|
|
|
+/// \param[in] timer_id timer ID obtained by \ref osTimerNew.
|
|
|
+/// \return 0 not running, 1 running.
|
|
|
+uint32_t osTimerIsRunning (osTimerId_t timer_id);
|
|
|
+
|
|
|
+/// Delete a timer.
|
|
|
+/// \param[in] timer_id timer ID obtained by \ref osTimerNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osTimerDelete (osTimerId_t timer_id);
|
|
|
+
|
|
|
+
|
|
|
+// ==== Event Flags Management Functions ====
|
|
|
+
|
|
|
+/// Create and Initialize an Event Flags object.
|
|
|
+/// \param[in] attr event flags attributes; NULL: default values.
|
|
|
+/// \return event flags ID for reference by other functions or NULL in case of error.
|
|
|
+osEventFlagsId_t osEventFlagsNew (const osEventFlagsAttr_t *attr);
|
|
|
+
|
|
|
+/// Set the specified Event Flags.
|
|
|
+/// \param[in] ef_id event flags ID obtained by \ref osEventFlagsNew.
|
|
|
+/// \param[in] flags specifies the flags that shall be set.
|
|
|
+/// \return event flags after setting or error code if negative.
|
|
|
+int32_t osEventFlagsSet (osEventFlagsId_t ef_id, int32_t flags);
|
|
|
+
|
|
|
+/// Clear the specified Event Flags.
|
|
|
+/// \param[in] ef_id event flags ID obtained by \ref osEventFlagsNew.
|
|
|
+/// \param[in] flags specifies the flags that shall be cleared.
|
|
|
+/// \return event flags before clearing or error code if negative.
|
|
|
+int32_t osEventFlagsClear (osEventFlagsId_t ef_id, int32_t flags);
|
|
|
+
|
|
|
+/// Get the current Event Flags.
|
|
|
+/// \param[in] ef_id event flags ID obtained by \ref osEventFlagsNew.
|
|
|
+/// \return current event flags.
|
|
|
+int32_t osEventFlagsGet (osEventFlagsId_t ef_id);
|
|
|
+
|
|
|
+/// Wait for one or more Event Flags to become signaled.
|
|
|
+/// \param[in] ef_id event flags ID obtained by \ref osEventFlagsNew.
|
|
|
+/// \param[in] flags specifies the flags to wait for.
|
|
|
+/// \param[in] options specifies flags options (osFlagsXxxx).
|
|
|
+/// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
|
|
|
+/// \return event flags before clearing or error code if negative.
|
|
|
+int32_t osEventFlagsWait (osEventFlagsId_t ef_id, int32_t flags, uint32_t options, uint32_t millisec);
|
|
|
+
|
|
|
+/// Delete an Event Flags object.
|
|
|
+/// \param[in] ef_id event flags ID obtained by \ref osEventFlagsNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osEventFlagsDelete (osEventFlagsId_t ef_id);
|
|
|
+
|
|
|
+
|
|
|
+// ==== Mutex Management Functions ====
|
|
|
+
|
|
|
+/// Create and Initialize a Mutex object.
|
|
|
+/// \param[in] attr mutex attributes; NULL: default values.
|
|
|
+/// \return mutex ID for reference by other functions or NULL in case of error.
|
|
|
+osMutexId_t osMutexNew (const osMutexAttr_t *attr);
|
|
|
+
|
|
|
+/// Acquire a Mutex or timeout if it is locked.
|
|
|
+/// \param[in] mutex_id mutex ID obtained by \ref osMutexNew.
|
|
|
+/// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osMutexAcquire (osMutexId_t mutex_id, uint32_t millisec);
|
|
|
+
|
|
|
+/// Release a Mutex that was acquired by \ref osMutexAcquire.
|
|
|
+/// \param[in] mutex_id mutex ID obtained by \ref osMutexNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osMutexRelease (osMutexId_t mutex_id);
|
|
|
+
|
|
|
+/// Get Thread which owns a Mutex object.
|
|
|
+/// \param[in] mutex_id mutex ID obtained by \ref osMutexNew.
|
|
|
+/// \return thread ID of owner thread or NULL when mutex was not acquired.
|
|
|
+osThreadId_t osMutexGetOwner (osMutexId_t mutex_id);
|
|
|
+
|
|
|
+/// Delete a Mutex object.
|
|
|
+/// \param[in] mutex_id mutex ID obtained by \ref osMutexNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osMutexDelete (osMutexId_t mutex_id);
|
|
|
+
|
|
|
+
|
|
|
+// ==== Semaphore Management Functions ====
|
|
|
+
|
|
|
+/// Create and Initialize a Semaphore object.
|
|
|
+/// \param[in] max_count maximum number of available tokens.
|
|
|
+/// \param[in] initial_count initial number of available tokens.
|
|
|
+/// \param[in] attr semaphore attributes; NULL: default values.
|
|
|
+/// \return semaphore ID for reference by other functions or NULL in case of error.
|
|
|
+osSemaphoreId_t osSemaphoreNew (uint32_t max_count, uint32_t initial_count, const osSemaphoreAttr_t *attr);
|
|
|
+
|
|
|
+/// Acquire a Semaphore token or timeout if no tokens are available.
|
|
|
+/// \param[in] semaphore_id semaphore ID obtained by \ref osSemaphoreNew.
|
|
|
+/// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osSemaphoreAcquire (osSemaphoreId_t semaphore_id, uint32_t millisec);
|
|
|
+
|
|
|
+/// Release a Semaphore token that was acquired by \ref osSemaphoreAcquire.
|
|
|
+/// \param[in] semaphore_id semaphore ID obtained by \ref osSemaphoreNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osSemaphoreRelease (osSemaphoreId_t semaphore_id);
|
|
|
+
|
|
|
+/// Get current Semaphore token count.
|
|
|
+/// \param[in] semaphore_id semaphore ID obtained by \ref osSemaphoreNew.
|
|
|
+/// \return number of tokens available.
|
|
|
+uint32_t osSemaphoreGetCount (osSemaphoreId_t semaphore_id);
|
|
|
+
|
|
|
+/// Delete a Semaphore object.
|
|
|
+/// \param[in] semaphore_id semaphore ID obtained by \ref osSemaphoreNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osSemaphoreDelete (osSemaphoreId_t semaphore_id);
|
|
|
+
|
|
|
+
|
|
|
+// ==== Memory Pool Management Functions ====
|
|
|
+
|
|
|
+/// Create and Initialize a Memory Pool object.
|
|
|
+/// \param[in] block_count maximum number of memory blocks in memory pool.
|
|
|
+/// \param[in] block_size memory block size in bytes.
|
|
|
+/// \param[in] attr memory pool attributes; NULL: default values.
|
|
|
+/// \return memory pool ID for reference by other functions or NULL in case of error.
|
|
|
+osMemoryPoolId_t osMemoryPoolNew (uint32_t block_count, uint32_t block_size, const osMemoryPoolAttr_t *attr);
|
|
|
+
|
|
|
+/// Allocate a memory block from a Memory Pool.
|
|
|
+/// \param[in] mp_id memory pool ID obtained by \ref osMemoryPoolNew.
|
|
|
+/// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
|
|
|
+/// \return address of the allocated memory block or NULL in case of no memory is available.
|
|
|
+void *osMemoryPoolAlloc (osMemoryPoolId_t mp_id, uint32_t millisec);
|
|
|
+
|
|
|
+/// Return an allocated memory block back to a Memory Pool.
|
|
|
+/// \param[in] mp_id memory pool ID obtained by \ref osMemoryPoolNew.
|
|
|
+/// \param[in] block address of the allocated memory block to be returned to the memory pool.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osMemoryPoolFree (osMemoryPoolId_t mp_id, void *block);
|
|
|
+
|
|
|
+/// Get maximum number of memory blocks in a Memory Pool.
|
|
|
+/// \param[in] mp_id memory pool ID obtained by \ref osMemoryPoolNew.
|
|
|
+/// \return maximum number of memory blocks.
|
|
|
+uint32_t osMemoryPoolGetCapacity (osMemoryPoolId_t mp_id);
|
|
|
+
|
|
|
+/// Get memory block size in a Memory Pool.
|
|
|
+/// \param[in] mp_id memory pool ID obtained by \ref osMemoryPoolNew.
|
|
|
+/// \return memory block size in bytes.
|
|
|
+uint32_t osMemoryPoolGetBlockSize (osMemoryPoolId_t mp_id);
|
|
|
+
|
|
|
+/// Get number of memory blocks used in a Memory Pool.
|
|
|
+/// \param[in] mp_id memory pool ID obtained by \ref osMemoryPoolNew.
|
|
|
+/// \return number of memory blocks used.
|
|
|
+uint32_t osMemoryPoolGetCount (osMemoryPoolId_t mp_id);
|
|
|
+
|
|
|
+/// Get number of memory blocks available in a Memory Pool.
|
|
|
+/// \param[in] mp_id memory pool ID obtained by \ref osMemoryPoolNew.
|
|
|
+/// \return number of memory blocks available.
|
|
|
+uint32_t osMemoryPoolGetSpace (osMemoryPoolId_t mp_id);
|
|
|
+
|
|
|
+/// Delete a Memory Pool object.
|
|
|
+/// \param[in] mp_id memory pool ID obtained by \ref osMemoryPoolNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osMemoryPoolDelete (osMemoryPoolId_t mp_id);
|
|
|
+
|
|
|
+
|
|
|
+// ==== Message Queue Management Functions ====
|
|
|
+
|
|
|
+/// Create and Initialize a Message Queue object.
|
|
|
+/// \param[in] msg_count maximum number of messages in queue.
|
|
|
+/// \param[in] msg_size maximum message size in bytes.
|
|
|
+/// \param[in] attr message queue attributes; NULL: default values.
|
|
|
+/// \return message queue ID for reference by other functions or NULL in case of error.
|
|
|
+osMessageQueueId_t osMessageQueueNew (uint32_t msg_count, uint32_t msg_size, const osMessageQueueAttr_t *attr);
|
|
|
+
|
|
|
+/// Put a Message into a Queue or timeout if Queue is full.
|
|
|
+/// \param[in] mq_id message queue ID obtained by \ref osMessageQueueNew.
|
|
|
+/// \param[in] msg_ptr pointer to buffer with message to put into a queue.
|
|
|
+/// \param[in] msg_prio message priority.
|
|
|
+/// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osMessageQueuePut (osMessageQueueId_t mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t millisec);
|
|
|
+
|
|
|
+/// Get a Message from a Queue or timeout if Queue is empty.
|
|
|
+/// \param[in] mq_id message queue ID obtained by \ref osMessageQueueNew.
|
|
|
+/// \param[out] msg_ptr pointer to buffer for message to get from a queue.
|
|
|
+/// \param[out] msg_prio pointer to buffer for message priority or NULL.
|
|
|
+/// \param[in] millisec \ref CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osMessageQueueGet (osMessageQueueId_t mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t millisec);
|
|
|
+
|
|
|
+/// Get maximum number of messages in a Message Queue.
|
|
|
+/// \param[in] mq_id message queue ID obtained by \ref osMessageQueueNew.
|
|
|
+/// \return maximum number of messages.
|
|
|
+uint32_t osMessageQueueGetCapacity (osMessageQueueId_t mq_id);
|
|
|
+
|
|
|
+/// Get maximum message size in a Memory Pool.
|
|
|
+/// \param[in] mq_id message queue ID obtained by \ref osMessageQueueNew.
|
|
|
+/// \return maximum message size in bytes.
|
|
|
+uint32_t osMessageQueueGetMsgSize (osMessageQueueId_t mq_id);
|
|
|
+
|
|
|
+/// Get number of queued messages in a Message Queue.
|
|
|
+/// \param[in] mq_id message queue ID obtained by \ref osMessageQueueNew.
|
|
|
+/// \return number of queued messages.
|
|
|
+uint32_t osMessageQueueGetCount (osMessageQueueId_t mq_id);
|
|
|
+
|
|
|
+/// Get number of available slots for messages in a Message Queue.
|
|
|
+/// \param[in] mq_id message queue ID obtained by \ref osMessageQueueNew.
|
|
|
+/// \return number of available slots for messages.
|
|
|
+uint32_t osMessageQueueGetSpace (osMessageQueueId_t mq_id);
|
|
|
+
|
|
|
+/// Reset a Message Queue to initial empty state.
|
|
|
+/// \param[in] mq_id message queue ID obtained by \ref osMessageQueueNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osMessageQueueReset (osMessageQueueId_t mq_id);
|
|
|
+
|
|
|
+/// Delete a Message Queue object.
|
|
|
+/// \param[in] mq_id message queue ID obtained by \ref osMessageQueueNew.
|
|
|
+/// \return status code that indicates the execution status of the function.
|
|
|
+osStatus_t osMessageQueueDelete (osMessageQueueId_t mq_id);
|
|
|
+
|
|
|
+
|
|
|
+#ifdef __cplusplus
|
|
|
+}
|
|
|
+#endif
|
|
|
+
|
|
|
+#endif // __CMSIS_OS2_H
|