Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-rtos/rtx/cmsis_os.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sinrab 0:5464d5e415e5 1 /* ----------------------------------------------------------------------
sinrab 0:5464d5e415e5 2 * Copyright (C) 2012 ARM Limited. All rights reserved.
sinrab 0:5464d5e415e5 3 *
sinrab 0:5464d5e415e5 4 * $Date: 5. June 2012
sinrab 0:5464d5e415e5 5 * $Revision: V1.01
sinrab 0:5464d5e415e5 6 *
sinrab 0:5464d5e415e5 7 * Project: CMSIS-RTOS API
sinrab 0:5464d5e415e5 8 * Title: cmsis_os.h RTX header file
sinrab 0:5464d5e415e5 9 *
sinrab 0:5464d5e415e5 10 * Version 0.02
sinrab 0:5464d5e415e5 11 * Initial Proposal Phase
sinrab 0:5464d5e415e5 12 * Version 0.03
sinrab 0:5464d5e415e5 13 * osKernelStart added, optional feature: main started as thread
sinrab 0:5464d5e415e5 14 * osSemaphores have standard behavior
sinrab 0:5464d5e415e5 15 * osTimerCreate does not start the timer, added osTimerStart
sinrab 0:5464d5e415e5 16 * osThreadPass is renamed to osThreadYield
sinrab 0:5464d5e415e5 17 * Version 1.01
sinrab 0:5464d5e415e5 18 * Support for C++ interface
sinrab 0:5464d5e415e5 19 * - const attribute removed from the osXxxxDef_t typedef's
sinrab 0:5464d5e415e5 20 * - const attribute added to the osXxxxDef macros
sinrab 0:5464d5e415e5 21 * Added: osTimerDelete, osMutexDelete, osSemaphoreDelete
sinrab 0:5464d5e415e5 22 * Added: osKernelInitialize
sinrab 0:5464d5e415e5 23 * -------------------------------------------------------------------- */
sinrab 0:5464d5e415e5 24
sinrab 0:5464d5e415e5 25 /**
sinrab 0:5464d5e415e5 26 \page cmsis_os_h Header File Template: cmsis_os.h
sinrab 0:5464d5e415e5 27
sinrab 0:5464d5e415e5 28 The file \b cmsis_os.h is a template header file for a CMSIS-RTOS compliant Real-Time Operating System (RTOS).
sinrab 0:5464d5e415e5 29 Each RTOS that is compliant with CMSIS-RTOS shall provide a specific \b cmsis_os.h header file that represents
sinrab 0:5464d5e415e5 30 its implementation.
sinrab 0:5464d5e415e5 31
sinrab 0:5464d5e415e5 32 The file cmsis_os.h contains:
sinrab 0:5464d5e415e5 33 - CMSIS-RTOS API function definitions
sinrab 0:5464d5e415e5 34 - struct definitions for parameters and return types
sinrab 0:5464d5e415e5 35 - status and priority values used by CMSIS-RTOS API functions
sinrab 0:5464d5e415e5 36 - macros for defining threads and other kernel objects
sinrab 0:5464d5e415e5 37
sinrab 0:5464d5e415e5 38
sinrab 0:5464d5e415e5 39 <b>Name conventions and header file modifications</b>
sinrab 0:5464d5e415e5 40
sinrab 0:5464d5e415e5 41 All definitions are prefixed with \b os to give an unique name space for CMSIS-RTOS functions.
sinrab 0:5464d5e415e5 42 Definitions that are prefixed \b os_ are not used in the application code but local to this header file.
sinrab 0:5464d5e415e5 43 All definitions and functions that belong to a module are grouped and have a common prefix, i.e. \b osThread.
sinrab 0:5464d5e415e5 44
sinrab 0:5464d5e415e5 45 Definitions that are marked with <b>CAN BE CHANGED</b> can be adapted towards the needs of the actual CMSIS-RTOS implementation.
sinrab 0:5464d5e415e5 46 These definitions can be specific to the underlying RTOS kernel.
sinrab 0:5464d5e415e5 47
sinrab 0:5464d5e415e5 48 Definitions that are marked with <b>MUST REMAIN UNCHANGED</b> cannot be altered. Otherwise the CMSIS-RTOS implementation is no longer
sinrab 0:5464d5e415e5 49 compliant to the standard. Note that some functions are optional and need not to be provided by every CMSIS-RTOS implementation.
sinrab 0:5464d5e415e5 50
sinrab 0:5464d5e415e5 51
sinrab 0:5464d5e415e5 52 <b>Function calls from interrupt service routines</b>
sinrab 0:5464d5e415e5 53
sinrab 0:5464d5e415e5 54 The following CMSIS-RTOS functions can be called from threads and interrupt service routines (ISR):
sinrab 0:5464d5e415e5 55 - \ref osSignalSet
sinrab 0:5464d5e415e5 56 - \ref osSemaphoreRelease
sinrab 0:5464d5e415e5 57 - \ref osPoolAlloc, \ref osPoolCAlloc, \ref osPoolFree
sinrab 0:5464d5e415e5 58 - \ref osMessagePut, \ref osMessageGet
sinrab 0:5464d5e415e5 59 - \ref osMailAlloc, \ref osMailCAlloc, \ref osMailGet, \ref osMailPut, \ref osMailFree
sinrab 0:5464d5e415e5 60
sinrab 0:5464d5e415e5 61 Functions that cannot be called from an ISR are verifying the interrupt status and return in case that they are called
sinrab 0:5464d5e415e5 62 from an ISR context the status code \b osErrorISR. In some implementations this condition might be caught using the HARD FAULT vector.
sinrab 0:5464d5e415e5 63
sinrab 0:5464d5e415e5 64 Some CMSIS-RTOS implementations support CMSIS-RTOS function calls from multiple ISR at the same time.
sinrab 0:5464d5e415e5 65 If this is impossible, the CMSIS-RTOS rejects calls by nested ISR functions with the status code \b osErrorISRRecursive.
sinrab 0:5464d5e415e5 66
sinrab 0:5464d5e415e5 67
sinrab 0:5464d5e415e5 68 <b>Define and reference object definitions</b>
sinrab 0:5464d5e415e5 69
sinrab 0:5464d5e415e5 70 With <b>\#define osObjectsExternal</b> objects are defined as external symbols. This allows to create a consistent header file
sinrab 0:5464d5e415e5 71 that is used throughout a project as shown below:
sinrab 0:5464d5e415e5 72
sinrab 0:5464d5e415e5 73 <i>Header File</i>
sinrab 0:5464d5e415e5 74 \code
sinrab 0:5464d5e415e5 75 #include <cmsis_os.h> // CMSIS RTOS header file
sinrab 0:5464d5e415e5 76
sinrab 0:5464d5e415e5 77 // Thread definition
sinrab 0:5464d5e415e5 78 extern void thread_sample (void const *argument); // function prototype
sinrab 0:5464d5e415e5 79 osThreadDef (thread_sample, osPriorityBelowNormal, 1, 100);
sinrab 0:5464d5e415e5 80
sinrab 0:5464d5e415e5 81 // Pool definition
sinrab 0:5464d5e415e5 82 osPoolDef(MyPool, 10, long);
sinrab 0:5464d5e415e5 83 \endcode
sinrab 0:5464d5e415e5 84
sinrab 0:5464d5e415e5 85
sinrab 0:5464d5e415e5 86 This header file defines all objects when included in a C/C++ source file. When <b>\#define osObjectsExternal</b> is
sinrab 0:5464d5e415e5 87 present before the header file, the objects are defined as external symbols. A single consistent header file can therefore be
sinrab 0:5464d5e415e5 88 used throughout the whole project.
sinrab 0:5464d5e415e5 89
sinrab 0:5464d5e415e5 90 <i>Example</i>
sinrab 0:5464d5e415e5 91 \code
sinrab 0:5464d5e415e5 92 #include "osObjects.h" // Definition of the CMSIS-RTOS objects
sinrab 0:5464d5e415e5 93 \endcode
sinrab 0:5464d5e415e5 94
sinrab 0:5464d5e415e5 95 \code
sinrab 0:5464d5e415e5 96 #define osObjectExternal // Objects will be defined as external symbols
sinrab 0:5464d5e415e5 97 #include "osObjects.h" // Reference to the CMSIS-RTOS objects
sinrab 0:5464d5e415e5 98 \endcode
sinrab 0:5464d5e415e5 99
sinrab 0:5464d5e415e5 100 */
sinrab 0:5464d5e415e5 101
sinrab 0:5464d5e415e5 102 #ifndef _CMSIS_OS_H
sinrab 0:5464d5e415e5 103 #define _CMSIS_OS_H
sinrab 0:5464d5e415e5 104
sinrab 0:5464d5e415e5 105 /// \note MUST REMAIN UNCHANGED: \b osCMSIS identifies the CMSIS-RTOS API version.
sinrab 0:5464d5e415e5 106 #define osCMSIS 0x10001 ///< API version (main [31:16] .sub [15:0])
sinrab 0:5464d5e415e5 107
sinrab 0:5464d5e415e5 108 /// \note CAN BE CHANGED: \b osCMSIS_KERNEL identifies the underlying RTOS kernel and version number.
sinrab 0:5464d5e415e5 109 #define osCMSIS_RTX ((4<<16)|61) ///< RTOS identification and version (main [31:16] .sub [15:0])
sinrab 0:5464d5e415e5 110
sinrab 0:5464d5e415e5 111 /// \note MUST REMAIN UNCHANGED: \b osKernelSystemId shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 112 #define osKernelSystemId "RTX V4.61" ///< RTOS identification string
sinrab 0:5464d5e415e5 113
sinrab 0:5464d5e415e5 114
sinrab 0:5464d5e415e5 115 #define CMSIS_OS_RTX
sinrab 0:5464d5e415e5 116
sinrab 0:5464d5e415e5 117 // The stack space occupied is mainly dependent on the underling C standard library
sinrab 0:5464d5e415e5 118 #if defined(TOOLCHAIN_GCC) || defined(TOOLCHAIN_ARM_STD)
sinrab 0:5464d5e415e5 119 # define WORDS_STACK_SIZE 512
sinrab 0:5464d5e415e5 120 #elif defined(TOOLCHAIN_ARM_MICRO)
sinrab 0:5464d5e415e5 121 # define WORDS_STACK_SIZE 128
sinrab 0:5464d5e415e5 122 #endif
sinrab 0:5464d5e415e5 123
sinrab 0:5464d5e415e5 124 #define DEFAULT_STACK_SIZE (WORDS_STACK_SIZE*4)
sinrab 0:5464d5e415e5 125
sinrab 0:5464d5e415e5 126
sinrab 0:5464d5e415e5 127 /// \note MUST REMAIN UNCHANGED: \b osFeature_xxx shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 128 #define osFeature_MainThread 1 ///< main thread 1=main can be thread, 0=not available
sinrab 0:5464d5e415e5 129 #define osFeature_Pool 1 ///< Memory Pools: 1=available, 0=not available
sinrab 0:5464d5e415e5 130 #define osFeature_MailQ 1 ///< Mail Queues: 1=available, 0=not available
sinrab 0:5464d5e415e5 131 #define osFeature_MessageQ 1 ///< Message Queues: 1=available, 0=not available
sinrab 0:5464d5e415e5 132 #define osFeature_Signals 16 ///< maximum number of Signal Flags available per thread
sinrab 0:5464d5e415e5 133 #define osFeature_Semaphore 65535 ///< maximum count for \ref osSemaphoreCreate function
sinrab 0:5464d5e415e5 134 #define osFeature_Wait 0 ///< osWait function: 1=available, 0=not available
sinrab 0:5464d5e415e5 135
sinrab 0:5464d5e415e5 136 #if defined (__CC_ARM)
sinrab 0:5464d5e415e5 137 #define os_InRegs __value_in_regs // Compiler specific: force struct in registers
sinrab 0:5464d5e415e5 138 #else
sinrab 0:5464d5e415e5 139 #define os_InRegs
sinrab 0:5464d5e415e5 140 #endif
sinrab 0:5464d5e415e5 141
sinrab 0:5464d5e415e5 142 #include <stdint.h>
sinrab 0:5464d5e415e5 143 #include <stddef.h>
sinrab 0:5464d5e415e5 144
sinrab 0:5464d5e415e5 145 #ifdef __cplusplus
sinrab 0:5464d5e415e5 146 extern "C"
sinrab 0:5464d5e415e5 147 {
sinrab 0:5464d5e415e5 148 #endif
sinrab 0:5464d5e415e5 149
sinrab 0:5464d5e415e5 150 #include "os_tcb.h"
sinrab 0:5464d5e415e5 151
sinrab 0:5464d5e415e5 152 // ==== Enumeration, structures, defines ====
sinrab 0:5464d5e415e5 153
sinrab 0:5464d5e415e5 154 /// Priority used for thread control.
sinrab 0:5464d5e415e5 155 /// \note MUST REMAIN UNCHANGED: \b osPriority shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 156 typedef enum {
sinrab 0:5464d5e415e5 157 osPriorityIdle = -3, ///< priority: idle (lowest)
sinrab 0:5464d5e415e5 158 osPriorityLow = -2, ///< priority: low
sinrab 0:5464d5e415e5 159 osPriorityBelowNormal = -1, ///< priority: below normal
sinrab 0:5464d5e415e5 160 osPriorityNormal = 0, ///< priority: normal (default)
sinrab 0:5464d5e415e5 161 osPriorityAboveNormal = +1, ///< priority: above normal
sinrab 0:5464d5e415e5 162 osPriorityHigh = +2, ///< priority: high
sinrab 0:5464d5e415e5 163 osPriorityRealtime = +3, ///< priority: realtime (highest)
sinrab 0:5464d5e415e5 164 osPriorityError = 0x84 ///< system cannot determine priority or thread has illegal priority
sinrab 0:5464d5e415e5 165 } osPriority;
sinrab 0:5464d5e415e5 166
sinrab 0:5464d5e415e5 167 /// Timeout value.
sinrab 0:5464d5e415e5 168 /// \note MUST REMAIN UNCHANGED: \b osWaitForever shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 169 #define osWaitForever 0xFFFFFFFF ///< wait forever timeout value
sinrab 0:5464d5e415e5 170
sinrab 0:5464d5e415e5 171 /// Status code values returned by CMSIS-RTOS functions.
sinrab 0:5464d5e415e5 172 /// \note MUST REMAIN UNCHANGED: \b osStatus shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 173 typedef enum {
sinrab 0:5464d5e415e5 174 osOK = 0, ///< function completed; no error or event occurred.
sinrab 0:5464d5e415e5 175 osEventSignal = 0x08, ///< function completed; signal event occurred.
sinrab 0:5464d5e415e5 176 osEventMessage = 0x10, ///< function completed; message event occurred.
sinrab 0:5464d5e415e5 177 osEventMail = 0x20, ///< function completed; mail event occurred.
sinrab 0:5464d5e415e5 178 osEventTimeout = 0x40, ///< function completed; timeout occurred.
sinrab 0:5464d5e415e5 179 osErrorParameter = 0x80, ///< parameter error: a mandatory parameter was missing or specified an incorrect object.
sinrab 0:5464d5e415e5 180 osErrorResource = 0x81, ///< resource not available: a specified resource was not available.
sinrab 0:5464d5e415e5 181 osErrorTimeoutResource = 0xC1, ///< resource not available within given time: a specified resource was not available within the timeout period.
sinrab 0:5464d5e415e5 182 osErrorISR = 0x82, ///< not allowed in ISR context: the function cannot be called from interrupt service routines.
sinrab 0:5464d5e415e5 183 osErrorISRRecursive = 0x83, ///< function called multiple times from ISR with same object.
sinrab 0:5464d5e415e5 184 osErrorPriority = 0x84, ///< system cannot determine priority or thread has illegal priority.
sinrab 0:5464d5e415e5 185 osErrorNoMemory = 0x85, ///< system is out of memory: it was impossible to allocate or reserve memory for the operation.
sinrab 0:5464d5e415e5 186 osErrorValue = 0x86, ///< value of a parameter is out of range.
sinrab 0:5464d5e415e5 187 osErrorOS = 0xFF, ///< unspecified RTOS error: run-time error but no other error message fits.
sinrab 0:5464d5e415e5 188 os_status_reserved = 0x7FFFFFFF ///< prevent from enum down-size compiler optimization.
sinrab 0:5464d5e415e5 189 } osStatus;
sinrab 0:5464d5e415e5 190
sinrab 0:5464d5e415e5 191
sinrab 0:5464d5e415e5 192 /// Timer type value for the timer definition.
sinrab 0:5464d5e415e5 193 /// \note MUST REMAIN UNCHANGED: \b os_timer_type shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 194 typedef enum {
sinrab 0:5464d5e415e5 195 osTimerOnce = 0, ///< one-shot timer
sinrab 0:5464d5e415e5 196 osTimerPeriodic = 1 ///< repeating timer
sinrab 0:5464d5e415e5 197 } os_timer_type;
sinrab 0:5464d5e415e5 198
sinrab 0:5464d5e415e5 199 /// Entry point of a thread.
sinrab 0:5464d5e415e5 200 /// \note MUST REMAIN UNCHANGED: \b os_pthread shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 201 typedef void (*os_pthread) (void const *argument);
sinrab 0:5464d5e415e5 202
sinrab 0:5464d5e415e5 203 /// Entry point of a timer call back function.
sinrab 0:5464d5e415e5 204 /// \note MUST REMAIN UNCHANGED: \b os_ptimer shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 205 typedef void (*os_ptimer) (void const *argument);
sinrab 0:5464d5e415e5 206
sinrab 0:5464d5e415e5 207 // >>> the following data type definitions may shall adapted towards a specific RTOS
sinrab 0:5464d5e415e5 208
sinrab 0:5464d5e415e5 209 /// Thread ID identifies the thread (pointer to a thread control block).
sinrab 0:5464d5e415e5 210 /// \note CAN BE CHANGED: \b os_thread_cb is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 211 typedef struct os_thread_cb *osThreadId;
sinrab 0:5464d5e415e5 212
sinrab 0:5464d5e415e5 213 /// Timer ID identifies the timer (pointer to a timer control block).
sinrab 0:5464d5e415e5 214 /// \note CAN BE CHANGED: \b os_timer_cb is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 215 typedef struct os_timer_cb *osTimerId;
sinrab 0:5464d5e415e5 216
sinrab 0:5464d5e415e5 217 /// Mutex ID identifies the mutex (pointer to a mutex control block).
sinrab 0:5464d5e415e5 218 /// \note CAN BE CHANGED: \b os_mutex_cb is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 219 typedef struct os_mutex_cb *osMutexId;
sinrab 0:5464d5e415e5 220
sinrab 0:5464d5e415e5 221 /// Semaphore ID identifies the semaphore (pointer to a semaphore control block).
sinrab 0:5464d5e415e5 222 /// \note CAN BE CHANGED: \b os_semaphore_cb is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 223 typedef struct os_semaphore_cb *osSemaphoreId;
sinrab 0:5464d5e415e5 224
sinrab 0:5464d5e415e5 225 /// Pool ID identifies the memory pool (pointer to a memory pool control block).
sinrab 0:5464d5e415e5 226 /// \note CAN BE CHANGED: \b os_pool_cb is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 227 typedef struct os_pool_cb *osPoolId;
sinrab 0:5464d5e415e5 228
sinrab 0:5464d5e415e5 229 /// Message ID identifies the message queue (pointer to a message queue control block).
sinrab 0:5464d5e415e5 230 /// \note CAN BE CHANGED: \b os_messageQ_cb is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 231 typedef struct os_messageQ_cb *osMessageQId;
sinrab 0:5464d5e415e5 232
sinrab 0:5464d5e415e5 233 /// Mail ID identifies the mail queue (pointer to a mail queue control block).
sinrab 0:5464d5e415e5 234 /// \note CAN BE CHANGED: \b os_mailQ_cb is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 235 typedef struct os_mailQ_cb *osMailQId;
sinrab 0:5464d5e415e5 236
sinrab 0:5464d5e415e5 237
sinrab 0:5464d5e415e5 238 /// Thread Definition structure contains startup information of a thread.
sinrab 0:5464d5e415e5 239 /// \note CAN BE CHANGED: \b os_thread_def is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 240 typedef struct os_thread_def {
sinrab 0:5464d5e415e5 241 os_pthread pthread; ///< start address of thread function
sinrab 0:5464d5e415e5 242 osPriority tpriority; ///< initial thread priority
sinrab 0:5464d5e415e5 243 uint32_t stacksize; ///< stack size requirements in bytes
sinrab 0:5464d5e415e5 244 unsigned char *stack_pointer; ///< pointer to the stack memory block
sinrab 0:5464d5e415e5 245 struct OS_TCB tcb;
sinrab 0:5464d5e415e5 246 } osThreadDef_t;
sinrab 0:5464d5e415e5 247
sinrab 0:5464d5e415e5 248 /// Timer Definition structure contains timer parameters.
sinrab 0:5464d5e415e5 249 /// \note CAN BE CHANGED: \b os_timer_def is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 250 typedef struct os_timer_def {
sinrab 0:5464d5e415e5 251 os_ptimer ptimer; ///< start address of a timer function
sinrab 0:5464d5e415e5 252 void *timer; ///< pointer to internal data
sinrab 0:5464d5e415e5 253 } osTimerDef_t;
sinrab 0:5464d5e415e5 254
sinrab 0:5464d5e415e5 255 /// Mutex Definition structure contains setup information for a mutex.
sinrab 0:5464d5e415e5 256 /// \note CAN BE CHANGED: \b os_mutex_def is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 257 typedef struct os_mutex_def {
sinrab 0:5464d5e415e5 258 void *mutex; ///< pointer to internal data
sinrab 0:5464d5e415e5 259 } osMutexDef_t;
sinrab 0:5464d5e415e5 260
sinrab 0:5464d5e415e5 261 /// Semaphore Definition structure contains setup information for a semaphore.
sinrab 0:5464d5e415e5 262 /// \note CAN BE CHANGED: \b os_semaphore_def is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 263 typedef struct os_semaphore_def {
sinrab 0:5464d5e415e5 264 void *semaphore; ///< pointer to internal data
sinrab 0:5464d5e415e5 265 } osSemaphoreDef_t;
sinrab 0:5464d5e415e5 266
sinrab 0:5464d5e415e5 267 /// Definition structure for memory block allocation.
sinrab 0:5464d5e415e5 268 /// \note CAN BE CHANGED: \b os_pool_def is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 269 typedef struct os_pool_def {
sinrab 0:5464d5e415e5 270 uint32_t pool_sz; ///< number of items (elements) in the pool
sinrab 0:5464d5e415e5 271 uint32_t item_sz; ///< size of an item
sinrab 0:5464d5e415e5 272 void *pool; ///< pointer to memory for pool
sinrab 0:5464d5e415e5 273 } osPoolDef_t;
sinrab 0:5464d5e415e5 274
sinrab 0:5464d5e415e5 275 /// Definition structure for message queue.
sinrab 0:5464d5e415e5 276 /// \note CAN BE CHANGED: \b os_messageQ_def is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 277 typedef struct os_messageQ_def {
sinrab 0:5464d5e415e5 278 uint32_t queue_sz; ///< number of elements in the queue
sinrab 0:5464d5e415e5 279 void *pool; ///< memory array for messages
sinrab 0:5464d5e415e5 280 } osMessageQDef_t;
sinrab 0:5464d5e415e5 281
sinrab 0:5464d5e415e5 282 /// Definition structure for mail queue.
sinrab 0:5464d5e415e5 283 /// \note CAN BE CHANGED: \b os_mailQ_def is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 284 typedef struct os_mailQ_def {
sinrab 0:5464d5e415e5 285 uint32_t queue_sz; ///< number of elements in the queue
sinrab 0:5464d5e415e5 286 uint32_t item_sz; ///< size of an item
sinrab 0:5464d5e415e5 287 void *pool; ///< memory array for mail
sinrab 0:5464d5e415e5 288 } osMailQDef_t;
sinrab 0:5464d5e415e5 289
sinrab 0:5464d5e415e5 290 /// Event structure contains detailed information about an event.
sinrab 0:5464d5e415e5 291 /// \note MUST REMAIN UNCHANGED: \b os_event shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 292 /// However the struct may be extended at the end.
sinrab 0:5464d5e415e5 293 typedef struct {
sinrab 0:5464d5e415e5 294 osStatus status; ///< status code: event or error information
sinrab 0:5464d5e415e5 295 union {
sinrab 0:5464d5e415e5 296 uint32_t v; ///< message as 32-bit value
sinrab 0:5464d5e415e5 297 void *p; ///< message or mail as void pointer
sinrab 0:5464d5e415e5 298 int32_t signals; ///< signal flags
sinrab 0:5464d5e415e5 299 } value; ///< event value
sinrab 0:5464d5e415e5 300 union {
sinrab 0:5464d5e415e5 301 osMailQId mail_id; ///< mail id obtained by \ref osMailCreate
sinrab 0:5464d5e415e5 302 osMessageQId message_id; ///< message id obtained by \ref osMessageCreate
sinrab 0:5464d5e415e5 303 } def; ///< event definition
sinrab 0:5464d5e415e5 304 } osEvent;
sinrab 0:5464d5e415e5 305
sinrab 0:5464d5e415e5 306
sinrab 0:5464d5e415e5 307 // ==== Kernel Control Functions ====
sinrab 0:5464d5e415e5 308
sinrab 0:5464d5e415e5 309 /// Initialize the RTOS Kernel for creating objects.
sinrab 0:5464d5e415e5 310 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 311 /// \note MUST REMAIN UNCHANGED: \b osKernelInitialize shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 312 osStatus osKernelInitialize (void);
sinrab 0:5464d5e415e5 313
sinrab 0:5464d5e415e5 314 /// Start the RTOS Kernel.
sinrab 0:5464d5e415e5 315 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 316 /// \note MUST REMAIN UNCHANGED: \b osKernelStart shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 317 osStatus osKernelStart (void);
sinrab 0:5464d5e415e5 318
sinrab 0:5464d5e415e5 319 /// Check if the RTOS kernel is already started.
sinrab 0:5464d5e415e5 320 /// \note MUST REMAIN UNCHANGED: \b osKernelRunning shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 321 /// \return 0 RTOS is not started, 1 RTOS is started.
sinrab 0:5464d5e415e5 322 int32_t osKernelRunning(void);
sinrab 0:5464d5e415e5 323
sinrab 0:5464d5e415e5 324
sinrab 0:5464d5e415e5 325 // ==== Thread Management ====
sinrab 0:5464d5e415e5 326
sinrab 0:5464d5e415e5 327 /// Create a Thread Definition with function, priority, and stack requirements.
sinrab 0:5464d5e415e5 328 /// \param name name of the thread function.
sinrab 0:5464d5e415e5 329 /// \param priority initial priority of the thread function.
sinrab 0:5464d5e415e5 330 /// \param stacksz stack size (in bytes) requirements for the thread function.
sinrab 0:5464d5e415e5 331 /// \note CAN BE CHANGED: The parameters to \b osThreadDef shall be consistent but the
sinrab 0:5464d5e415e5 332 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 333 #if defined (osObjectsExternal) // object is external
sinrab 0:5464d5e415e5 334 #define osThreadDef(name, priority, stacksz) \
sinrab 0:5464d5e415e5 335 extern osThreadDef_t os_thread_def_##name
sinrab 0:5464d5e415e5 336 #else // define the object
sinrab 0:5464d5e415e5 337 #define osThreadDef(name, priority, stacksz) \
sinrab 0:5464d5e415e5 338 unsigned char os_thread_def_stack_##name [stacksz]; \
sinrab 0:5464d5e415e5 339 osThreadDef_t os_thread_def_##name = \
sinrab 0:5464d5e415e5 340 { (name), (priority), (stacksz), (os_thread_def_stack_##name)}
sinrab 0:5464d5e415e5 341 #endif
sinrab 0:5464d5e415e5 342
sinrab 0:5464d5e415e5 343 /// Access a Thread definition.
sinrab 0:5464d5e415e5 344 /// \param name name of the thread definition object.
sinrab 0:5464d5e415e5 345 /// \note CAN BE CHANGED: The parameter to \b osThread shall be consistent but the
sinrab 0:5464d5e415e5 346 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 347 #define osThread(name) \
sinrab 0:5464d5e415e5 348 &os_thread_def_##name
sinrab 0:5464d5e415e5 349
sinrab 0:5464d5e415e5 350 /// Create a thread and add it to Active Threads and set it to state READY.
sinrab 0:5464d5e415e5 351 /// \param[in] thread_def thread definition referenced with \ref osThread.
sinrab 0:5464d5e415e5 352 /// \param[in] argument pointer that is passed to the thread function as start argument.
sinrab 0:5464d5e415e5 353 /// \return thread ID for reference by other functions or NULL in case of error.
sinrab 0:5464d5e415e5 354 /// \note MUST REMAIN UNCHANGED: \b osThreadCreate shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 355 osThreadId osThreadCreate (osThreadDef_t *thread_def, void *argument);
sinrab 0:5464d5e415e5 356
sinrab 0:5464d5e415e5 357 /// Return the thread ID of the current running thread.
sinrab 0:5464d5e415e5 358 /// \return thread ID for reference by other functions or NULL in case of error.
sinrab 0:5464d5e415e5 359 /// \note MUST REMAIN UNCHANGED: \b osThreadGetId shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 360 osThreadId osThreadGetId (void);
sinrab 0:5464d5e415e5 361
sinrab 0:5464d5e415e5 362 /// Terminate execution of a thread and remove it from Active Threads.
sinrab 0:5464d5e415e5 363 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
sinrab 0:5464d5e415e5 364 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 365 /// \note MUST REMAIN UNCHANGED: \b osThreadTerminate shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 366 osStatus osThreadTerminate (osThreadId thread_id);
sinrab 0:5464d5e415e5 367
sinrab 0:5464d5e415e5 368 /// Pass control to next thread that is in state \b READY.
sinrab 0:5464d5e415e5 369 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 370 /// \note MUST REMAIN UNCHANGED: \b osThreadYield shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 371 osStatus osThreadYield (void);
sinrab 0:5464d5e415e5 372
sinrab 0:5464d5e415e5 373 /// Change priority of an active thread.
sinrab 0:5464d5e415e5 374 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
sinrab 0:5464d5e415e5 375 /// \param[in] priority new priority value for the thread function.
sinrab 0:5464d5e415e5 376 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 377 /// \note MUST REMAIN UNCHANGED: \b osThreadSetPriority shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 378 osStatus osThreadSetPriority (osThreadId thread_id, osPriority priority);
sinrab 0:5464d5e415e5 379
sinrab 0:5464d5e415e5 380 /// Get current priority of an active thread.
sinrab 0:5464d5e415e5 381 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
sinrab 0:5464d5e415e5 382 /// \return current priority value of the thread function.
sinrab 0:5464d5e415e5 383 /// \note MUST REMAIN UNCHANGED: \b osThreadGetPriority shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 384 osPriority osThreadGetPriority (osThreadId thread_id);
sinrab 0:5464d5e415e5 385
sinrab 0:5464d5e415e5 386
sinrab 0:5464d5e415e5 387 // ==== Generic Wait Functions ====
sinrab 0:5464d5e415e5 388
sinrab 0:5464d5e415e5 389 /// Wait for Timeout (Time Delay).
sinrab 0:5464d5e415e5 390 /// \param[in] millisec time delay value
sinrab 0:5464d5e415e5 391 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 392 osStatus osDelay (uint32_t millisec);
sinrab 0:5464d5e415e5 393
sinrab 0:5464d5e415e5 394 #if (defined (osFeature_Wait) && (osFeature_Wait != 0)) // Generic Wait available
sinrab 0:5464d5e415e5 395
sinrab 0:5464d5e415e5 396 /// Wait for Signal, Message, Mail, or Timeout.
sinrab 0:5464d5e415e5 397 /// \param[in] millisec timeout value or 0 in case of no time-out
sinrab 0:5464d5e415e5 398 /// \return event that contains signal, message, or mail information or error code.
sinrab 0:5464d5e415e5 399 /// \note MUST REMAIN UNCHANGED: \b osWait shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 400 os_InRegs osEvent osWait (uint32_t millisec);
sinrab 0:5464d5e415e5 401
sinrab 0:5464d5e415e5 402 #endif // Generic Wait available
sinrab 0:5464d5e415e5 403
sinrab 0:5464d5e415e5 404
sinrab 0:5464d5e415e5 405 // ==== Timer Management Functions ====
sinrab 0:5464d5e415e5 406 /// Define a Timer object.
sinrab 0:5464d5e415e5 407 /// \param name name of the timer object.
sinrab 0:5464d5e415e5 408 /// \param function name of the timer call back function.
sinrab 0:5464d5e415e5 409 /// \note CAN BE CHANGED: The parameter to \b osTimerDef shall be consistent but the
sinrab 0:5464d5e415e5 410 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 411 #if defined (osObjectsExternal) // object is external
sinrab 0:5464d5e415e5 412 #define osTimerDef(name, function) \
sinrab 0:5464d5e415e5 413 extern osTimerDef_t os_timer_def_##name
sinrab 0:5464d5e415e5 414 #else // define the object
sinrab 0:5464d5e415e5 415 #define osTimerDef(name, function) \
sinrab 0:5464d5e415e5 416 uint32_t os_timer_cb_##name[5]; \
sinrab 0:5464d5e415e5 417 osTimerDef_t os_timer_def_##name = \
sinrab 0:5464d5e415e5 418 { (function), (os_timer_cb_##name) }
sinrab 0:5464d5e415e5 419 #endif
sinrab 0:5464d5e415e5 420
sinrab 0:5464d5e415e5 421 /// Access a Timer definition.
sinrab 0:5464d5e415e5 422 /// \param name name of the timer object.
sinrab 0:5464d5e415e5 423 /// \note CAN BE CHANGED: The parameter to \b osTimer shall be consistent but the
sinrab 0:5464d5e415e5 424 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 425 #define osTimer(name) \
sinrab 0:5464d5e415e5 426 &os_timer_def_##name
sinrab 0:5464d5e415e5 427
sinrab 0:5464d5e415e5 428 /// Create a timer.
sinrab 0:5464d5e415e5 429 /// \param[in] timer_def timer object referenced with \ref osTimer.
sinrab 0:5464d5e415e5 430 /// \param[in] type osTimerOnce for one-shot or osTimerPeriodic for periodic behavior.
sinrab 0:5464d5e415e5 431 /// \param[in] argument argument to the timer call back function.
sinrab 0:5464d5e415e5 432 /// \return timer ID for reference by other functions or NULL in case of error.
sinrab 0:5464d5e415e5 433 /// \note MUST REMAIN UNCHANGED: \b osTimerCreate shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 434 osTimerId osTimerCreate (osTimerDef_t *timer_def, os_timer_type type, void *argument);
sinrab 0:5464d5e415e5 435
sinrab 0:5464d5e415e5 436 /// Start or restart a timer.
sinrab 0:5464d5e415e5 437 /// \param[in] timer_id timer ID obtained by \ref osTimerCreate.
sinrab 0:5464d5e415e5 438 /// \param[in] millisec time delay value of the timer.
sinrab 0:5464d5e415e5 439 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 440 /// \note MUST REMAIN UNCHANGED: \b osTimerStart shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 441 osStatus osTimerStart (osTimerId timer_id, uint32_t millisec);
sinrab 0:5464d5e415e5 442
sinrab 0:5464d5e415e5 443 /// Stop the timer.
sinrab 0:5464d5e415e5 444 /// \param[in] timer_id timer ID obtained by \ref osTimerCreate.
sinrab 0:5464d5e415e5 445 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 446 /// \note MUST REMAIN UNCHANGED: \b osTimerStop shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 447 osStatus osTimerStop (osTimerId timer_id);
sinrab 0:5464d5e415e5 448
sinrab 0:5464d5e415e5 449 /// Delete a timer that was created by \ref osTimerCreate.
sinrab 0:5464d5e415e5 450 /// \param[in] timer_id timer ID obtained by \ref osTimerCreate.
sinrab 0:5464d5e415e5 451 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 452 /// \note MUST REMAIN UNCHANGED: \b osTimerDelete shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 453 osStatus osTimerDelete (osTimerId timer_id);
sinrab 0:5464d5e415e5 454
sinrab 0:5464d5e415e5 455
sinrab 0:5464d5e415e5 456 // ==== Signal Management ====
sinrab 0:5464d5e415e5 457
sinrab 0:5464d5e415e5 458 /// Set the specified Signal Flags of an active thread.
sinrab 0:5464d5e415e5 459 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
sinrab 0:5464d5e415e5 460 /// \param[in] signals specifies the signal flags of the thread that should be set.
sinrab 0:5464d5e415e5 461 /// \return previous signal flags of the specified thread or 0x80000000 in case of incorrect parameters.
sinrab 0:5464d5e415e5 462 /// \note MUST REMAIN UNCHANGED: \b osSignalSet shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 463 int32_t osSignalSet (osThreadId thread_id, int32_t signals);
sinrab 0:5464d5e415e5 464
sinrab 0:5464d5e415e5 465 /// Clear the specified Signal Flags of an active thread.
sinrab 0:5464d5e415e5 466 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
sinrab 0:5464d5e415e5 467 /// \param[in] signals specifies the signal flags of the thread that shall be cleared.
sinrab 0:5464d5e415e5 468 /// \return previous signal flags of the specified thread or 0x80000000 in case of incorrect parameters.
sinrab 0:5464d5e415e5 469 /// \note MUST REMAIN UNCHANGED: \b osSignalClear shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 470 int32_t osSignalClear (osThreadId thread_id, int32_t signals);
sinrab 0:5464d5e415e5 471
sinrab 0:5464d5e415e5 472 /// Get Signal Flags status of an active thread.
sinrab 0:5464d5e415e5 473 /// \param[in] thread_id thread ID obtained by \ref osThreadCreate or \ref osThreadGetId.
sinrab 0:5464d5e415e5 474 /// \return previous signal flags of the specified thread or 0x80000000 in case of incorrect parameters.
sinrab 0:5464d5e415e5 475 /// \note MUST REMAIN UNCHANGED: \b osSignalGet shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 476 int32_t osSignalGet (osThreadId thread_id);
sinrab 0:5464d5e415e5 477
sinrab 0:5464d5e415e5 478 /// Wait for one or more Signal Flags to become signaled for the current \b RUNNING thread.
sinrab 0:5464d5e415e5 479 /// \param[in] signals wait until all specified signal flags set or 0 for any single signal flag.
sinrab 0:5464d5e415e5 480 /// \param[in] millisec timeout value or 0 in case of no time-out.
sinrab 0:5464d5e415e5 481 /// \return event flag information or error code.
sinrab 0:5464d5e415e5 482 /// \note MUST REMAIN UNCHANGED: \b osSignalWait shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 483 os_InRegs osEvent osSignalWait (int32_t signals, uint32_t millisec);
sinrab 0:5464d5e415e5 484
sinrab 0:5464d5e415e5 485
sinrab 0:5464d5e415e5 486 // ==== Mutex Management ====
sinrab 0:5464d5e415e5 487
sinrab 0:5464d5e415e5 488 /// Define a Mutex.
sinrab 0:5464d5e415e5 489 /// \param name name of the mutex object.
sinrab 0:5464d5e415e5 490 /// \note CAN BE CHANGED: The parameter to \b osMutexDef shall be consistent but the
sinrab 0:5464d5e415e5 491 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 492 #if defined (osObjectsExternal) // object is external
sinrab 0:5464d5e415e5 493 #define osMutexDef(name) \
sinrab 0:5464d5e415e5 494 extern osMutexDef_t os_mutex_def_##name
sinrab 0:5464d5e415e5 495 #else // define the object
sinrab 0:5464d5e415e5 496 #define osMutexDef(name) \
sinrab 0:5464d5e415e5 497 uint32_t os_mutex_cb_##name[3]; \
sinrab 0:5464d5e415e5 498 osMutexDef_t os_mutex_def_##name = { (os_mutex_cb_##name) }
sinrab 0:5464d5e415e5 499 #endif
sinrab 0:5464d5e415e5 500
sinrab 0:5464d5e415e5 501 /// Access a Mutex definition.
sinrab 0:5464d5e415e5 502 /// \param name name of the mutex object.
sinrab 0:5464d5e415e5 503 /// \note CAN BE CHANGED: The parameter to \b osMutex shall be consistent but the
sinrab 0:5464d5e415e5 504 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 505 #define osMutex(name) \
sinrab 0:5464d5e415e5 506 &os_mutex_def_##name
sinrab 0:5464d5e415e5 507
sinrab 0:5464d5e415e5 508 /// Create and Initialize a Mutex object.
sinrab 0:5464d5e415e5 509 /// \param[in] mutex_def mutex definition referenced with \ref osMutex.
sinrab 0:5464d5e415e5 510 /// \return mutex ID for reference by other functions or NULL in case of error.
sinrab 0:5464d5e415e5 511 /// \note MUST REMAIN UNCHANGED: \b osMutexCreate shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 512 osMutexId osMutexCreate (osMutexDef_t *mutex_def);
sinrab 0:5464d5e415e5 513
sinrab 0:5464d5e415e5 514 /// Wait until a Mutex becomes available.
sinrab 0:5464d5e415e5 515 /// \param[in] mutex_id mutex ID obtained by \ref osMutexCreate.
sinrab 0:5464d5e415e5 516 /// \param[in] millisec timeout value or 0 in case of no time-out.
sinrab 0:5464d5e415e5 517 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 518 /// \note MUST REMAIN UNCHANGED: \b osMutexWait shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 519 osStatus osMutexWait (osMutexId mutex_id, uint32_t millisec);
sinrab 0:5464d5e415e5 520
sinrab 0:5464d5e415e5 521 /// Release a Mutex that was obtained by \ref osMutexWait.
sinrab 0:5464d5e415e5 522 /// \param[in] mutex_id mutex ID obtained by \ref osMutexCreate.
sinrab 0:5464d5e415e5 523 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 524 /// \note MUST REMAIN UNCHANGED: \b osMutexRelease shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 525 osStatus osMutexRelease (osMutexId mutex_id);
sinrab 0:5464d5e415e5 526
sinrab 0:5464d5e415e5 527 /// Delete a Mutex that was created by \ref osMutexCreate.
sinrab 0:5464d5e415e5 528 /// \param[in] mutex_id mutex ID obtained by \ref osMutexCreate.
sinrab 0:5464d5e415e5 529 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 530 /// \note MUST REMAIN UNCHANGED: \b osMutexDelete shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 531 osStatus osMutexDelete (osMutexId mutex_id);
sinrab 0:5464d5e415e5 532
sinrab 0:5464d5e415e5 533
sinrab 0:5464d5e415e5 534 // ==== Semaphore Management Functions ====
sinrab 0:5464d5e415e5 535
sinrab 0:5464d5e415e5 536 #if (defined (osFeature_Semaphore) && (osFeature_Semaphore != 0)) // Semaphore available
sinrab 0:5464d5e415e5 537
sinrab 0:5464d5e415e5 538 /// Define a Semaphore object.
sinrab 0:5464d5e415e5 539 /// \param name name of the semaphore object.
sinrab 0:5464d5e415e5 540 /// \note CAN BE CHANGED: The parameter to \b osSemaphoreDef shall be consistent but the
sinrab 0:5464d5e415e5 541 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 542 #if defined (osObjectsExternal) // object is external
sinrab 0:5464d5e415e5 543 #define osSemaphoreDef(name) \
sinrab 0:5464d5e415e5 544 extern osSemaphoreDef_t os_semaphore_def_##name
sinrab 0:5464d5e415e5 545 #else // define the object
sinrab 0:5464d5e415e5 546 #define osSemaphoreDef(name) \
sinrab 0:5464d5e415e5 547 uint32_t os_semaphore_cb_##name[2]; \
sinrab 0:5464d5e415e5 548 osSemaphoreDef_t os_semaphore_def_##name = { (os_semaphore_cb_##name) }
sinrab 0:5464d5e415e5 549 #endif
sinrab 0:5464d5e415e5 550
sinrab 0:5464d5e415e5 551 /// Access a Semaphore definition.
sinrab 0:5464d5e415e5 552 /// \param name name of the semaphore object.
sinrab 0:5464d5e415e5 553 /// \note CAN BE CHANGED: The parameter to \b osSemaphore shall be consistent but the
sinrab 0:5464d5e415e5 554 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 555 #define osSemaphore(name) \
sinrab 0:5464d5e415e5 556 &os_semaphore_def_##name
sinrab 0:5464d5e415e5 557
sinrab 0:5464d5e415e5 558 /// Create and Initialize a Semaphore object used for managing resources.
sinrab 0:5464d5e415e5 559 /// \param[in] semaphore_def semaphore definition referenced with \ref osSemaphore.
sinrab 0:5464d5e415e5 560 /// \param[in] count number of available resources.
sinrab 0:5464d5e415e5 561 /// \return semaphore ID for reference by other functions or NULL in case of error.
sinrab 0:5464d5e415e5 562 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreCreate shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 563 osSemaphoreId osSemaphoreCreate (osSemaphoreDef_t *semaphore_def, int32_t count);
sinrab 0:5464d5e415e5 564
sinrab 0:5464d5e415e5 565 /// Wait until a Semaphore token becomes available.
sinrab 0:5464d5e415e5 566 /// \param[in] semaphore_id semaphore object referenced with \ref osSemaphoreCreate.
sinrab 0:5464d5e415e5 567 /// \param[in] millisec timeout value or 0 in case of no time-out.
sinrab 0:5464d5e415e5 568 /// \return number of available tokens, or -1 in case of incorrect parameters.
sinrab 0:5464d5e415e5 569 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreWait shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 570 int32_t osSemaphoreWait (osSemaphoreId semaphore_id, uint32_t millisec);
sinrab 0:5464d5e415e5 571
sinrab 0:5464d5e415e5 572 /// Release a Semaphore token.
sinrab 0:5464d5e415e5 573 /// \param[in] semaphore_id semaphore object referenced with \ref osSemaphoreCreate.
sinrab 0:5464d5e415e5 574 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 575 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreRelease shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 576 osStatus osSemaphoreRelease (osSemaphoreId semaphore_id);
sinrab 0:5464d5e415e5 577
sinrab 0:5464d5e415e5 578 /// Delete a Semaphore that was created by \ref osSemaphoreCreate.
sinrab 0:5464d5e415e5 579 /// \param[in] semaphore_id semaphore object referenced with \ref osSemaphoreCreate.
sinrab 0:5464d5e415e5 580 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 581 /// \note MUST REMAIN UNCHANGED: \b osSemaphoreDelete shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 582 osStatus osSemaphoreDelete (osSemaphoreId semaphore_id);
sinrab 0:5464d5e415e5 583
sinrab 0:5464d5e415e5 584 #endif // Semaphore available
sinrab 0:5464d5e415e5 585
sinrab 0:5464d5e415e5 586
sinrab 0:5464d5e415e5 587 // ==== Memory Pool Management Functions ====
sinrab 0:5464d5e415e5 588
sinrab 0:5464d5e415e5 589 #if (defined (osFeature_Pool) && (osFeature_Pool != 0)) // Memory Pool Management available
sinrab 0:5464d5e415e5 590
sinrab 0:5464d5e415e5 591 /// \brief Define a Memory Pool.
sinrab 0:5464d5e415e5 592 /// \param name name of the memory pool.
sinrab 0:5464d5e415e5 593 /// \param no maximum number of blocks (objects) in the memory pool.
sinrab 0:5464d5e415e5 594 /// \param type data type of a single block (object).
sinrab 0:5464d5e415e5 595 /// \note CAN BE CHANGED: The parameter to \b osPoolDef shall be consistent but the
sinrab 0:5464d5e415e5 596 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 597 #if defined (osObjectsExternal) // object is external
sinrab 0:5464d5e415e5 598 #define osPoolDef(name, no, type) \
sinrab 0:5464d5e415e5 599 extern osPoolDef_t os_pool_def_##name
sinrab 0:5464d5e415e5 600 #else // define the object
sinrab 0:5464d5e415e5 601 #define osPoolDef(name, no, type) \
sinrab 0:5464d5e415e5 602 uint32_t os_pool_m_##name[3+((sizeof(type)+3)/4)*(no)]; \
sinrab 0:5464d5e415e5 603 osPoolDef_t os_pool_def_##name = \
sinrab 0:5464d5e415e5 604 { (no), sizeof(type), (os_pool_m_##name) }
sinrab 0:5464d5e415e5 605 #endif
sinrab 0:5464d5e415e5 606
sinrab 0:5464d5e415e5 607 /// \brief Access a Memory Pool definition.
sinrab 0:5464d5e415e5 608 /// \param name name of the memory pool
sinrab 0:5464d5e415e5 609 /// \note CAN BE CHANGED: The parameter to \b osPool shall be consistent but the
sinrab 0:5464d5e415e5 610 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 611 #define osPool(name) \
sinrab 0:5464d5e415e5 612 &os_pool_def_##name
sinrab 0:5464d5e415e5 613
sinrab 0:5464d5e415e5 614 /// Create and Initialize a memory pool.
sinrab 0:5464d5e415e5 615 /// \param[in] pool_def memory pool definition referenced with \ref osPool.
sinrab 0:5464d5e415e5 616 /// \return memory pool ID for reference by other functions or NULL in case of error.
sinrab 0:5464d5e415e5 617 /// \note MUST REMAIN UNCHANGED: \b osPoolCreate shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 618 osPoolId osPoolCreate (osPoolDef_t *pool_def);
sinrab 0:5464d5e415e5 619
sinrab 0:5464d5e415e5 620 /// Allocate a memory block from a memory pool.
sinrab 0:5464d5e415e5 621 /// \param[in] pool_id memory pool ID obtain referenced with \ref osPoolCreate.
sinrab 0:5464d5e415e5 622 /// \return address of the allocated memory block or NULL in case of no memory available.
sinrab 0:5464d5e415e5 623 /// \note MUST REMAIN UNCHANGED: \b osPoolAlloc shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 624 void *osPoolAlloc (osPoolId pool_id);
sinrab 0:5464d5e415e5 625
sinrab 0:5464d5e415e5 626 /// Allocate a memory block from a memory pool and set memory block to zero.
sinrab 0:5464d5e415e5 627 /// \param[in] pool_id memory pool ID obtain referenced with \ref osPoolCreate.
sinrab 0:5464d5e415e5 628 /// \return address of the allocated memory block or NULL in case of no memory available.
sinrab 0:5464d5e415e5 629 /// \note MUST REMAIN UNCHANGED: \b osPoolCAlloc shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 630 void *osPoolCAlloc (osPoolId pool_id);
sinrab 0:5464d5e415e5 631
sinrab 0:5464d5e415e5 632 /// Return an allocated memory block back to a specific memory pool.
sinrab 0:5464d5e415e5 633 /// \param[in] pool_id memory pool ID obtain referenced with \ref osPoolCreate.
sinrab 0:5464d5e415e5 634 /// \param[in] block address of the allocated memory block that is returned to the memory pool.
sinrab 0:5464d5e415e5 635 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 636 /// \note MUST REMAIN UNCHANGED: \b osPoolFree shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 637 osStatus osPoolFree (osPoolId pool_id, void *block);
sinrab 0:5464d5e415e5 638
sinrab 0:5464d5e415e5 639 #endif // Memory Pool Management available
sinrab 0:5464d5e415e5 640
sinrab 0:5464d5e415e5 641
sinrab 0:5464d5e415e5 642 // ==== Message Queue Management Functions ====
sinrab 0:5464d5e415e5 643
sinrab 0:5464d5e415e5 644 #if (defined (osFeature_MessageQ) && (osFeature_MessageQ != 0)) // Message Queues available
sinrab 0:5464d5e415e5 645
sinrab 0:5464d5e415e5 646 /// \brief Create a Message Queue Definition.
sinrab 0:5464d5e415e5 647 /// \param name name of the queue.
sinrab 0:5464d5e415e5 648 /// \param queue_sz maximum number of messages in the queue.
sinrab 0:5464d5e415e5 649 /// \param type data type of a single message element (for debugger).
sinrab 0:5464d5e415e5 650 /// \note CAN BE CHANGED: The parameter to \b osMessageQDef shall be consistent but the
sinrab 0:5464d5e415e5 651 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 652 #if defined (osObjectsExternal) // object is external
sinrab 0:5464d5e415e5 653 #define osMessageQDef(name, queue_sz, type) \
sinrab 0:5464d5e415e5 654 extern osMessageQDef_t os_messageQ_def_##name
sinrab 0:5464d5e415e5 655 #else // define the object
sinrab 0:5464d5e415e5 656 #define osMessageQDef(name, queue_sz, type) \
sinrab 0:5464d5e415e5 657 uint32_t os_messageQ_q_##name[4+(queue_sz)]; \
sinrab 0:5464d5e415e5 658 osMessageQDef_t os_messageQ_def_##name = \
sinrab 0:5464d5e415e5 659 { (queue_sz), (os_messageQ_q_##name) }
sinrab 0:5464d5e415e5 660 #endif
sinrab 0:5464d5e415e5 661
sinrab 0:5464d5e415e5 662 /// \brief Access a Message Queue Definition.
sinrab 0:5464d5e415e5 663 /// \param name name of the queue
sinrab 0:5464d5e415e5 664 /// \note CAN BE CHANGED: The parameter to \b osMessageQ shall be consistent but the
sinrab 0:5464d5e415e5 665 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 666 #define osMessageQ(name) \
sinrab 0:5464d5e415e5 667 &os_messageQ_def_##name
sinrab 0:5464d5e415e5 668
sinrab 0:5464d5e415e5 669 /// Create and Initialize a Message Queue.
sinrab 0:5464d5e415e5 670 /// \param[in] queue_def queue definition referenced with \ref osMessageQ.
sinrab 0:5464d5e415e5 671 /// \param[in] thread_id thread ID (obtained by \ref osThreadCreate or \ref osThreadGetId) or NULL.
sinrab 0:5464d5e415e5 672 /// \return message queue ID for reference by other functions or NULL in case of error.
sinrab 0:5464d5e415e5 673 /// \note MUST REMAIN UNCHANGED: \b osMessageCreate shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 674 osMessageQId osMessageCreate (osMessageQDef_t *queue_def, osThreadId thread_id);
sinrab 0:5464d5e415e5 675
sinrab 0:5464d5e415e5 676 /// Put a Message to a Queue.
sinrab 0:5464d5e415e5 677 /// \param[in] queue_id message queue ID obtained with \ref osMessageCreate.
sinrab 0:5464d5e415e5 678 /// \param[in] info message information.
sinrab 0:5464d5e415e5 679 /// \param[in] millisec timeout value or 0 in case of no time-out.
sinrab 0:5464d5e415e5 680 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 681 /// \note MUST REMAIN UNCHANGED: \b osMessagePut shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 682 osStatus osMessagePut (osMessageQId queue_id, uint32_t info, uint32_t millisec);
sinrab 0:5464d5e415e5 683
sinrab 0:5464d5e415e5 684 /// Get a Message or Wait for a Message from a Queue.
sinrab 0:5464d5e415e5 685 /// \param[in] queue_id message queue ID obtained with \ref osMessageCreate.
sinrab 0:5464d5e415e5 686 /// \param[in] millisec timeout value or 0 in case of no time-out.
sinrab 0:5464d5e415e5 687 /// \return event information that includes status code.
sinrab 0:5464d5e415e5 688 /// \note MUST REMAIN UNCHANGED: \b osMessageGet shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 689 os_InRegs osEvent osMessageGet (osMessageQId queue_id, uint32_t millisec);
sinrab 0:5464d5e415e5 690
sinrab 0:5464d5e415e5 691 #endif // Message Queues available
sinrab 0:5464d5e415e5 692
sinrab 0:5464d5e415e5 693
sinrab 0:5464d5e415e5 694 // ==== Mail Queue Management Functions ====
sinrab 0:5464d5e415e5 695
sinrab 0:5464d5e415e5 696 #if (defined (osFeature_MailQ) && (osFeature_MailQ != 0)) // Mail Queues available
sinrab 0:5464d5e415e5 697
sinrab 0:5464d5e415e5 698 /// \brief Create a Mail Queue Definition.
sinrab 0:5464d5e415e5 699 /// \param name name of the queue
sinrab 0:5464d5e415e5 700 /// \param queue_sz maximum number of messages in queue
sinrab 0:5464d5e415e5 701 /// \param type data type of a single message element
sinrab 0:5464d5e415e5 702 /// \note CAN BE CHANGED: The parameter to \b osMailQDef shall be consistent but the
sinrab 0:5464d5e415e5 703 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 704 #if defined (osObjectsExternal) // object is external
sinrab 0:5464d5e415e5 705 #define osMailQDef(name, queue_sz, type) \
sinrab 0:5464d5e415e5 706 extern osMailQDef_t os_mailQ_def_##name
sinrab 0:5464d5e415e5 707 #else // define the object
sinrab 0:5464d5e415e5 708 #define osMailQDef(name, queue_sz, type) \
sinrab 0:5464d5e415e5 709 uint32_t os_mailQ_q_##name[4+(queue_sz)]; \
sinrab 0:5464d5e415e5 710 uint32_t os_mailQ_m_##name[3+((sizeof(type)+3)/4)*(queue_sz)]; \
sinrab 0:5464d5e415e5 711 void * os_mailQ_p_##name[2] = { (os_mailQ_q_##name), os_mailQ_m_##name }; \
sinrab 0:5464d5e415e5 712 osMailQDef_t os_mailQ_def_##name = \
sinrab 0:5464d5e415e5 713 { (queue_sz), sizeof(type), (os_mailQ_p_##name) }
sinrab 0:5464d5e415e5 714 #endif
sinrab 0:5464d5e415e5 715
sinrab 0:5464d5e415e5 716 /// \brief Access a Mail Queue Definition.
sinrab 0:5464d5e415e5 717 /// \param name name of the queue
sinrab 0:5464d5e415e5 718 /// \note CAN BE CHANGED: The parameter to \b osMailQ shall be consistent but the
sinrab 0:5464d5e415e5 719 /// macro body is implementation specific in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 720 #define osMailQ(name) \
sinrab 0:5464d5e415e5 721 &os_mailQ_def_##name
sinrab 0:5464d5e415e5 722
sinrab 0:5464d5e415e5 723 /// Create and Initialize mail queue.
sinrab 0:5464d5e415e5 724 /// \param[in] queue_def reference to the mail queue definition obtain with \ref osMailQ
sinrab 0:5464d5e415e5 725 /// \param[in] thread_id thread ID (obtained by \ref osThreadCreate or \ref osThreadGetId) or NULL.
sinrab 0:5464d5e415e5 726 /// \return mail queue ID for reference by other functions or NULL in case of error.
sinrab 0:5464d5e415e5 727 /// \note MUST REMAIN UNCHANGED: \b osMailCreate shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 728 osMailQId osMailCreate (osMailQDef_t *queue_def, osThreadId thread_id);
sinrab 0:5464d5e415e5 729
sinrab 0:5464d5e415e5 730 /// Allocate a memory block from a mail.
sinrab 0:5464d5e415e5 731 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
sinrab 0:5464d5e415e5 732 /// \param[in] millisec timeout value or 0 in case of no time-out
sinrab 0:5464d5e415e5 733 /// \return pointer to memory block that can be filled with mail or NULL in case of error.
sinrab 0:5464d5e415e5 734 /// \note MUST REMAIN UNCHANGED: \b osMailAlloc shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 735 void *osMailAlloc (osMailQId queue_id, uint32_t millisec);
sinrab 0:5464d5e415e5 736
sinrab 0:5464d5e415e5 737 /// Allocate a memory block from a mail and set memory block to zero.
sinrab 0:5464d5e415e5 738 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
sinrab 0:5464d5e415e5 739 /// \param[in] millisec timeout value or 0 in case of no time-out
sinrab 0:5464d5e415e5 740 /// \return pointer to memory block that can be filled with mail or NULL in case of error.
sinrab 0:5464d5e415e5 741 /// \note MUST REMAIN UNCHANGED: \b osMailCAlloc shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 742 void *osMailCAlloc (osMailQId queue_id, uint32_t millisec);
sinrab 0:5464d5e415e5 743
sinrab 0:5464d5e415e5 744 /// Put a mail to a queue.
sinrab 0:5464d5e415e5 745 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
sinrab 0:5464d5e415e5 746 /// \param[in] mail memory block previously allocated with \ref osMailAlloc or \ref osMailCAlloc.
sinrab 0:5464d5e415e5 747 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 748 /// \note MUST REMAIN UNCHANGED: \b osMailPut shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 749 osStatus osMailPut (osMailQId queue_id, void *mail);
sinrab 0:5464d5e415e5 750
sinrab 0:5464d5e415e5 751 /// Get a mail from a queue.
sinrab 0:5464d5e415e5 752 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
sinrab 0:5464d5e415e5 753 /// \param[in] millisec timeout value or 0 in case of no time-out
sinrab 0:5464d5e415e5 754 /// \return event that contains mail information or error code.
sinrab 0:5464d5e415e5 755 /// \note MUST REMAIN UNCHANGED: \b osMailGet shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 756 os_InRegs osEvent osMailGet (osMailQId queue_id, uint32_t millisec);
sinrab 0:5464d5e415e5 757
sinrab 0:5464d5e415e5 758 /// Free a memory block from a mail.
sinrab 0:5464d5e415e5 759 /// \param[in] queue_id mail queue ID obtained with \ref osMailCreate.
sinrab 0:5464d5e415e5 760 /// \param[in] mail pointer to the memory block that was obtained with \ref osMailGet.
sinrab 0:5464d5e415e5 761 /// \return status code that indicates the execution status of the function.
sinrab 0:5464d5e415e5 762 /// \note MUST REMAIN UNCHANGED: \b osMailFree shall be consistent in every CMSIS-RTOS.
sinrab 0:5464d5e415e5 763 osStatus osMailFree (osMailQId queue_id, void *mail);
sinrab 0:5464d5e415e5 764
sinrab 0:5464d5e415e5 765 #endif // Mail Queues available
sinrab 0:5464d5e415e5 766
sinrab 0:5464d5e415e5 767
sinrab 0:5464d5e415e5 768 #ifdef __cplusplus
sinrab 0:5464d5e415e5 769 }
sinrab 0:5464d5e415e5 770 #endif
sinrab 0:5464d5e415e5 771
sinrab 0:5464d5e415e5 772 #endif // _CMSIS_OS_H
sinrab 0:5464d5e415e5 773