RUBEN ELISEO VAZQUEZ / Mbed 2 deprecated ds1302-bluetooth

the program have one sensor acs712 and moduleds1302

Dependencies:   FATFileSystem mbed

rtx/TARGET_CORTEX_M/cmsis_os.h@0:b82abca089ac, 2017-06-08 (annotated)

Committer:
RUBENTEC
Date:
Thu Jun 08 20:17:34 2017 +0000
Revision:
0:b82abca089ac
ds1302-bluetooth-acs712

Who changed what in which revision?

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