Daoyu_Sofiane Yao_Belouka / mbed-rtos

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Mecatro_Gyro_Programme_Codeur_HC06

rtx/TARGET_ARM7/cmsis_os.h@0:a8ed743bc1e1, 2021-04-16 (annotated)

Committer:
daoyu_sofiane
Date:
Fri Apr 16 09:25:33 2021 +0000
Revision:
0:a8ed743bc1e1
Projet Gyropode

Who changed what in which revision?

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