Pierre Provent / USBHost

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:   TEST_USB_Nucleo_F429ZI Essais_USB_Nucleo_F429ZI SID_V3_Nucleo_F429ZI SID_V4_Nucleo_F429ZI_copy

mbed-rtos/rtos/Thread.h@0:77ca32e8e04e, 2020-09-25 (annotated)

Committer:
pierreprovent
Date:
Fri Sep 25 10:17:49 2020 +0000
Revision:
0:77ca32e8e04e
Programme acquisition en enregistrement sur clef USB carte Nucleo F429ZI cours ELE118 Cnam

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pierreprovent 0:77ca32e8e04e 1 /* mbed Microcontroller Library
pierreprovent 0:77ca32e8e04e 2 * Copyright (c) 2006-2012 ARM Limited
pierreprovent 0:77ca32e8e04e 3 *
pierreprovent 0:77ca32e8e04e 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
pierreprovent 0:77ca32e8e04e 5 * of this software and associated documentation files (the "Software"), to deal
pierreprovent 0:77ca32e8e04e 6 * in the Software without restriction, including without limitation the rights
pierreprovent 0:77ca32e8e04e 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
pierreprovent 0:77ca32e8e04e 8 * copies of the Software, and to permit persons to whom the Software is
pierreprovent 0:77ca32e8e04e 9 * furnished to do so, subject to the following conditions:
pierreprovent 0:77ca32e8e04e 10 *
pierreprovent 0:77ca32e8e04e 11 * The above copyright notice and this permission notice shall be included in
pierreprovent 0:77ca32e8e04e 12 * all copies or substantial portions of the Software.
pierreprovent 0:77ca32e8e04e 13 *
pierreprovent 0:77ca32e8e04e 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
pierreprovent 0:77ca32e8e04e 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
pierreprovent 0:77ca32e8e04e 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
pierreprovent 0:77ca32e8e04e 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
pierreprovent 0:77ca32e8e04e 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
pierreprovent 0:77ca32e8e04e 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
pierreprovent 0:77ca32e8e04e 20 * SOFTWARE.
pierreprovent 0:77ca32e8e04e 21 */
pierreprovent 0:77ca32e8e04e 22 #ifndef THREAD_H
pierreprovent 0:77ca32e8e04e 23 #define THREAD_H
pierreprovent 0:77ca32e8e04e 24
pierreprovent 0:77ca32e8e04e 25 #include <stdint.h>
pierreprovent 0:77ca32e8e04e 26 #include "cmsis_os.h"
pierreprovent 0:77ca32e8e04e 27 #include "platform/Callback.h"
pierreprovent 0:77ca32e8e04e 28 #include "platform/toolchain.h"
pierreprovent 0:77ca32e8e04e 29 #include "rtos/Semaphore.h"
pierreprovent 0:77ca32e8e04e 30 #include "rtos/Mutex.h"
pierreprovent 0:77ca32e8e04e 31
pierreprovent 0:77ca32e8e04e 32 namespace rtos {
pierreprovent 0:77ca32e8e04e 33 /** \addtogroup rtos */
pierreprovent 0:77ca32e8e04e 34 /** @{*/
pierreprovent 0:77ca32e8e04e 35
pierreprovent 0:77ca32e8e04e 36 /** The Thread class allow defining, creating, and controlling thread functions in the system.
pierreprovent 0:77ca32e8e04e 37 *
pierreprovent 0:77ca32e8e04e 38 * Example:
pierreprovent 0:77ca32e8e04e 39 * @code
pierreprovent 0:77ca32e8e04e 40 * #include "mbed.h"
pierreprovent 0:77ca32e8e04e 41 * #include "rtos.h"
pierreprovent 0:77ca32e8e04e 42 *
pierreprovent 0:77ca32e8e04e 43 * Thread thread;
pierreprovent 0:77ca32e8e04e 44 * DigitalOut led1(LED1);
pierreprovent 0:77ca32e8e04e 45 * volatile bool running = true;
pierreprovent 0:77ca32e8e04e 46 *
pierreprovent 0:77ca32e8e04e 47 * // Blink function toggles the led in a long running loop
pierreprovent 0:77ca32e8e04e 48 * void blink(DigitalOut *led) {
pierreprovent 0:77ca32e8e04e 49 * while (running) {
pierreprovent 0:77ca32e8e04e 50 * *led = !*led;
pierreprovent 0:77ca32e8e04e 51 * Thread::wait(1000);
pierreprovent 0:77ca32e8e04e 52 * }
pierreprovent 0:77ca32e8e04e 53 * }
pierreprovent 0:77ca32e8e04e 54 *
pierreprovent 0:77ca32e8e04e 55 * // Spawns a thread to run blink for 5 seconds
pierreprovent 0:77ca32e8e04e 56 * int main() {
pierreprovent 0:77ca32e8e04e 57 * thread.start(led1, blink);
pierreprovent 0:77ca32e8e04e 58 * Thread::wait(5000);
pierreprovent 0:77ca32e8e04e 59 * running = false;
pierreprovent 0:77ca32e8e04e 60 * thread.join();
pierreprovent 0:77ca32e8e04e 61 * }
pierreprovent 0:77ca32e8e04e 62 * @endcode
pierreprovent 0:77ca32e8e04e 63 */
pierreprovent 0:77ca32e8e04e 64 class Thread {
pierreprovent 0:77ca32e8e04e 65 public:
pierreprovent 0:77ca32e8e04e 66 /** Allocate a new thread without starting execution
pierreprovent 0:77ca32e8e04e 67 @param priority initial priority of the thread function. (default: osPriorityNormal).
pierreprovent 0:77ca32e8e04e 68 @param stack_size stack size (in bytes) requirements for the thread function. (default: DEFAULT_STACK_SIZE).
pierreprovent 0:77ca32e8e04e 69 @param stack_pointer pointer to the stack area to be used by this thread (default: NULL).
pierreprovent 0:77ca32e8e04e 70 */
pierreprovent 0:77ca32e8e04e 71 Thread(osPriority priority=osPriorityNormal,
pierreprovent 0:77ca32e8e04e 72 uint32_t stack_size=DEFAULT_STACK_SIZE,
pierreprovent 0:77ca32e8e04e 73 unsigned char *stack_pointer=NULL) {
pierreprovent 0:77ca32e8e04e 74 constructor(priority, stack_size, stack_pointer);
pierreprovent 0:77ca32e8e04e 75 }
pierreprovent 0:77ca32e8e04e 76
pierreprovent 0:77ca32e8e04e 77 /** Create a new thread, and start it executing the specified function.
pierreprovent 0:77ca32e8e04e 78 @param task function to be executed by this thread.
pierreprovent 0:77ca32e8e04e 79 @param argument pointer that is passed to the thread function as start argument. (default: NULL).
pierreprovent 0:77ca32e8e04e 80 @param priority initial priority of the thread function. (default: osPriorityNormal).
pierreprovent 0:77ca32e8e04e 81 @param stack_size stack size (in bytes) requirements for the thread function. (default: DEFAULT_STACK_SIZE).
pierreprovent 0:77ca32e8e04e 82 @param stack_pointer pointer to the stack area to be used by this thread (default: NULL).
pierreprovent 0:77ca32e8e04e 83 @deprecated
pierreprovent 0:77ca32e8e04e 84 Thread-spawning constructors hide errors. Replaced by thread.start(task).
pierreprovent 0:77ca32e8e04e 85
pierreprovent 0:77ca32e8e04e 86 @code
pierreprovent 0:77ca32e8e04e 87 Thread thread(priority, stack_size, stack_pointer);
pierreprovent 0:77ca32e8e04e 88
pierreprovent 0:77ca32e8e04e 89 osStatus status = thread.start(task);
pierreprovent 0:77ca32e8e04e 90 if (status != osOK) {
pierreprovent 0:77ca32e8e04e 91 error("oh no!");
pierreprovent 0:77ca32e8e04e 92 }
pierreprovent 0:77ca32e8e04e 93 @endcode
pierreprovent 0:77ca32e8e04e 94 */
pierreprovent 0:77ca32e8e04e 95 MBED_DEPRECATED_SINCE("mbed-os-5.1",
pierreprovent 0:77ca32e8e04e 96 "Thread-spawning constructors hide errors. "
pierreprovent 0:77ca32e8e04e 97 "Replaced by thread.start(task).")
pierreprovent 0:77ca32e8e04e 98 Thread(mbed::Callback<void()> task,
pierreprovent 0:77ca32e8e04e 99 osPriority priority=osPriorityNormal,
pierreprovent 0:77ca32e8e04e 100 uint32_t stack_size=DEFAULT_STACK_SIZE,
pierreprovent 0:77ca32e8e04e 101 unsigned char *stack_pointer=NULL) {
pierreprovent 0:77ca32e8e04e 102 constructor(task, priority, stack_size, stack_pointer);
pierreprovent 0:77ca32e8e04e 103 }
pierreprovent 0:77ca32e8e04e 104
pierreprovent 0:77ca32e8e04e 105 /** Create a new thread, and start it executing the specified function.
pierreprovent 0:77ca32e8e04e 106 @param obj argument to task.
pierreprovent 0:77ca32e8e04e 107 @param method function to be executed by this thread.
pierreprovent 0:77ca32e8e04e 108 @param argument pointer that is passed to the thread function as start argument. (default: NULL).
pierreprovent 0:77ca32e8e04e 109 @param priority initial priority of the thread function. (default: osPriorityNormal).
pierreprovent 0:77ca32e8e04e 110 @param stack_size stack size (in bytes) requirements for the thread function. (default: DEFAULT_STACK_SIZE).
pierreprovent 0:77ca32e8e04e 111 @param stack_pointer pointer to the stack area to be used by this thread (default: NULL).
pierreprovent 0:77ca32e8e04e 112 @deprecated
pierreprovent 0:77ca32e8e04e 113 Thread-spawning constructors hide errors. Replaced by thread.start(callback(task, argument)).
pierreprovent 0:77ca32e8e04e 114
pierreprovent 0:77ca32e8e04e 115 @code
pierreprovent 0:77ca32e8e04e 116 Thread thread(priority, stack_size, stack_pointer);
pierreprovent 0:77ca32e8e04e 117
pierreprovent 0:77ca32e8e04e 118 osStatus status = thread.start(callback(task, argument));
pierreprovent 0:77ca32e8e04e 119 if (status != osOK) {
pierreprovent 0:77ca32e8e04e 120 error("oh no!");
pierreprovent 0:77ca32e8e04e 121 }
pierreprovent 0:77ca32e8e04e 122 @endcode
pierreprovent 0:77ca32e8e04e 123 */
pierreprovent 0:77ca32e8e04e 124 template <typename T>
pierreprovent 0:77ca32e8e04e 125 MBED_DEPRECATED_SINCE("mbed-os-5.1",
pierreprovent 0:77ca32e8e04e 126 "Thread-spawning constructors hide errors. "
pierreprovent 0:77ca32e8e04e 127 "Replaced by thread.start(callback(task, argument)).")
pierreprovent 0:77ca32e8e04e 128 Thread(T *argument, void (T::*task)(),
pierreprovent 0:77ca32e8e04e 129 osPriority priority=osPriorityNormal,
pierreprovent 0:77ca32e8e04e 130 uint32_t stack_size=DEFAULT_STACK_SIZE,
pierreprovent 0:77ca32e8e04e 131 unsigned char *stack_pointer=NULL) {
pierreprovent 0:77ca32e8e04e 132 constructor(mbed::callback(task, argument),
pierreprovent 0:77ca32e8e04e 133 priority, stack_size, stack_pointer);
pierreprovent 0:77ca32e8e04e 134 }
pierreprovent 0:77ca32e8e04e 135
pierreprovent 0:77ca32e8e04e 136 /** Create a new thread, and start it executing the specified function.
pierreprovent 0:77ca32e8e04e 137 @param obj argument to task.
pierreprovent 0:77ca32e8e04e 138 @param method function to be executed by this thread.
pierreprovent 0:77ca32e8e04e 139 @param argument pointer that is passed to the thread function as start argument. (default: NULL).
pierreprovent 0:77ca32e8e04e 140 @param priority initial priority of the thread function. (default: osPriorityNormal).
pierreprovent 0:77ca32e8e04e 141 @param stack_size stack size (in bytes) requirements for the thread function. (default: DEFAULT_STACK_SIZE).
pierreprovent 0:77ca32e8e04e 142 @param stack_pointer pointer to the stack area to be used by this thread (default: NULL).
pierreprovent 0:77ca32e8e04e 143 @deprecated
pierreprovent 0:77ca32e8e04e 144 Thread-spawning constructors hide errors. Replaced by thread.start(callback(task, argument)).
pierreprovent 0:77ca32e8e04e 145
pierreprovent 0:77ca32e8e04e 146 @code
pierreprovent 0:77ca32e8e04e 147 Thread thread(priority, stack_size, stack_pointer);
pierreprovent 0:77ca32e8e04e 148
pierreprovent 0:77ca32e8e04e 149 osStatus status = thread.start(callback(task, argument));
pierreprovent 0:77ca32e8e04e 150 if (status != osOK) {
pierreprovent 0:77ca32e8e04e 151 error("oh no!");
pierreprovent 0:77ca32e8e04e 152 }
pierreprovent 0:77ca32e8e04e 153 @endcode
pierreprovent 0:77ca32e8e04e 154 */
pierreprovent 0:77ca32e8e04e 155 template <typename T>
pierreprovent 0:77ca32e8e04e 156 MBED_DEPRECATED_SINCE("mbed-os-5.1",
pierreprovent 0:77ca32e8e04e 157 "Thread-spawning constructors hide errors. "
pierreprovent 0:77ca32e8e04e 158 "Replaced by thread.start(callback(task, argument)).")
pierreprovent 0:77ca32e8e04e 159 Thread(T *argument, void (*task)(T *),
pierreprovent 0:77ca32e8e04e 160 osPriority priority=osPriorityNormal,
pierreprovent 0:77ca32e8e04e 161 uint32_t stack_size=DEFAULT_STACK_SIZE,
pierreprovent 0:77ca32e8e04e 162 unsigned char *stack_pointer=NULL) {
pierreprovent 0:77ca32e8e04e 163 constructor(mbed::callback(task, argument),
pierreprovent 0:77ca32e8e04e 164 priority, stack_size, stack_pointer);
pierreprovent 0:77ca32e8e04e 165 }
pierreprovent 0:77ca32e8e04e 166
pierreprovent 0:77ca32e8e04e 167 /** Create a new thread, and start it executing the specified function.
pierreprovent 0:77ca32e8e04e 168 Provided for backwards compatibility
pierreprovent 0:77ca32e8e04e 169 @param task function to be executed by this thread.
pierreprovent 0:77ca32e8e04e 170 @param argument pointer that is passed to the thread function as start argument. (default: NULL).
pierreprovent 0:77ca32e8e04e 171 @param priority initial priority of the thread function. (default: osPriorityNormal).
pierreprovent 0:77ca32e8e04e 172 @param stack_size stack size (in bytes) requirements for the thread function. (default: DEFAULT_STACK_SIZE).
pierreprovent 0:77ca32e8e04e 173 @param stack_pointer pointer to the stack area to be used by this thread (default: NULL).
pierreprovent 0:77ca32e8e04e 174 @deprecated
pierreprovent 0:77ca32e8e04e 175 Thread-spawning constructors hide errors. Replaced by thread.start(callback(task, argument)).
pierreprovent 0:77ca32e8e04e 176
pierreprovent 0:77ca32e8e04e 177 @code
pierreprovent 0:77ca32e8e04e 178 Thread thread(priority, stack_size, stack_pointer);
pierreprovent 0:77ca32e8e04e 179
pierreprovent 0:77ca32e8e04e 180 osStatus status = thread.start(callback(task, argument));
pierreprovent 0:77ca32e8e04e 181 if (status != osOK) {
pierreprovent 0:77ca32e8e04e 182 error("oh no!");
pierreprovent 0:77ca32e8e04e 183 }
pierreprovent 0:77ca32e8e04e 184 @endcode
pierreprovent 0:77ca32e8e04e 185 */
pierreprovent 0:77ca32e8e04e 186 MBED_DEPRECATED_SINCE("mbed-os-5.1",
pierreprovent 0:77ca32e8e04e 187 "Thread-spawning constructors hide errors. "
pierreprovent 0:77ca32e8e04e 188 "Replaced by thread.start(callback(task, argument)).")
pierreprovent 0:77ca32e8e04e 189 Thread(void (*task)(void const *argument), void *argument=NULL,
pierreprovent 0:77ca32e8e04e 190 osPriority priority=osPriorityNormal,
pierreprovent 0:77ca32e8e04e 191 uint32_t stack_size=DEFAULT_STACK_SIZE,
pierreprovent 0:77ca32e8e04e 192 unsigned char *stack_pointer=NULL) {
pierreprovent 0:77ca32e8e04e 193 constructor(mbed::callback((void (*)(void *))task, argument),
pierreprovent 0:77ca32e8e04e 194 priority, stack_size, stack_pointer);
pierreprovent 0:77ca32e8e04e 195 }
pierreprovent 0:77ca32e8e04e 196
pierreprovent 0:77ca32e8e04e 197 /** Starts a thread executing the specified function.
pierreprovent 0:77ca32e8e04e 198 @param task function to be executed by this thread.
pierreprovent 0:77ca32e8e04e 199 @return status code that indicates the execution status of the function.
pierreprovent 0:77ca32e8e04e 200 */
pierreprovent 0:77ca32e8e04e 201 osStatus start(mbed::Callback<void()> task);
pierreprovent 0:77ca32e8e04e 202
pierreprovent 0:77ca32e8e04e 203 /** Starts a thread executing the specified function.
pierreprovent 0:77ca32e8e04e 204 @param obj argument to task
pierreprovent 0:77ca32e8e04e 205 @param method function to be executed by this thread.
pierreprovent 0:77ca32e8e04e 206 @return status code that indicates the execution status of the function.
pierreprovent 0:77ca32e8e04e 207 @deprecated
pierreprovent 0:77ca32e8e04e 208 The start function does not support cv-qualifiers. Replaced by start(callback(obj, method)).
pierreprovent 0:77ca32e8e04e 209 */
pierreprovent 0:77ca32e8e04e 210 template <typename T, typename M>
pierreprovent 0:77ca32e8e04e 211 MBED_DEPRECATED_SINCE("mbed-os-5.1",
pierreprovent 0:77ca32e8e04e 212 "The start function does not support cv-qualifiers. "
pierreprovent 0:77ca32e8e04e 213 "Replaced by thread.start(callback(obj, method)).")
pierreprovent 0:77ca32e8e04e 214 osStatus start(T *obj, M method) {
pierreprovent 0:77ca32e8e04e 215 return start(mbed::callback(obj, method));
pierreprovent 0:77ca32e8e04e 216 }
pierreprovent 0:77ca32e8e04e 217
pierreprovent 0:77ca32e8e04e 218 /** Wait for thread to terminate
pierreprovent 0:77ca32e8e04e 219 @return status code that indicates the execution status of the function.
pierreprovent 0:77ca32e8e04e 220 @note not callable from interrupt
pierreprovent 0:77ca32e8e04e 221 */
pierreprovent 0:77ca32e8e04e 222 osStatus join();
pierreprovent 0:77ca32e8e04e 223
pierreprovent 0:77ca32e8e04e 224 /** Terminate execution of a thread and remove it from Active Threads
pierreprovent 0:77ca32e8e04e 225 @return status code that indicates the execution status of the function.
pierreprovent 0:77ca32e8e04e 226 */
pierreprovent 0:77ca32e8e04e 227 osStatus terminate();
pierreprovent 0:77ca32e8e04e 228
pierreprovent 0:77ca32e8e04e 229 /** Set priority of an active thread
pierreprovent 0:77ca32e8e04e 230 @param priority new priority value for the thread function.
pierreprovent 0:77ca32e8e04e 231 @return status code that indicates the execution status of the function.
pierreprovent 0:77ca32e8e04e 232 */
pierreprovent 0:77ca32e8e04e 233 osStatus set_priority(osPriority priority);
pierreprovent 0:77ca32e8e04e 234
pierreprovent 0:77ca32e8e04e 235 /** Get priority of an active thread
pierreprovent 0:77ca32e8e04e 236 @return current priority value of the thread function.
pierreprovent 0:77ca32e8e04e 237 */
pierreprovent 0:77ca32e8e04e 238 osPriority get_priority();
pierreprovent 0:77ca32e8e04e 239
pierreprovent 0:77ca32e8e04e 240 /** Set the specified Signal Flags of an active thread.
pierreprovent 0:77ca32e8e04e 241 @param signals specifies the signal flags of the thread that should be set.
pierreprovent 0:77ca32e8e04e 242 @return previous signal flags of the specified thread or 0x80000000 in case of incorrect parameters.
pierreprovent 0:77ca32e8e04e 243 */
pierreprovent 0:77ca32e8e04e 244 int32_t signal_set(int32_t signals);
pierreprovent 0:77ca32e8e04e 245
pierreprovent 0:77ca32e8e04e 246 /** Clears the specified Signal Flags of an active thread.
pierreprovent 0:77ca32e8e04e 247 @param signals specifies the signal flags of the thread that should be cleared.
pierreprovent 0:77ca32e8e04e 248 @return resultant signal flags of the specified thread or 0x80000000 in case of incorrect parameters.
pierreprovent 0:77ca32e8e04e 249 */
pierreprovent 0:77ca32e8e04e 250 int32_t signal_clr(int32_t signals);
pierreprovent 0:77ca32e8e04e 251
pierreprovent 0:77ca32e8e04e 252 /** State of the Thread */
pierreprovent 0:77ca32e8e04e 253 enum State {
pierreprovent 0:77ca32e8e04e 254 Inactive, /**< Not created or terminated */
pierreprovent 0:77ca32e8e04e 255 Ready, /**< Ready to run */
pierreprovent 0:77ca32e8e04e 256 Running, /**< Running */
pierreprovent 0:77ca32e8e04e 257 WaitingDelay, /**< Waiting for a delay to occur */
pierreprovent 0:77ca32e8e04e 258 WaitingInterval, /**< Waiting for an interval to occur */
pierreprovent 0:77ca32e8e04e 259 WaitingOr, /**< Waiting for one event in a set to occur */
pierreprovent 0:77ca32e8e04e 260 WaitingAnd, /**< Waiting for multiple events in a set to occur */
pierreprovent 0:77ca32e8e04e 261 WaitingSemaphore, /**< Waiting for a semaphore event to occur */
pierreprovent 0:77ca32e8e04e 262 WaitingMailbox, /**< Waiting for a mailbox event to occur */
pierreprovent 0:77ca32e8e04e 263 WaitingMutex, /**< Waiting for a mutex event to occur */
pierreprovent 0:77ca32e8e04e 264
pierreprovent 0:77ca32e8e04e 265 /* Not in sync with RTX below here */
pierreprovent 0:77ca32e8e04e 266 Deleted, /**< The task has been deleted */
pierreprovent 0:77ca32e8e04e 267 };
pierreprovent 0:77ca32e8e04e 268
pierreprovent 0:77ca32e8e04e 269 /** State of this Thread
pierreprovent 0:77ca32e8e04e 270 @return the State of this Thread
pierreprovent 0:77ca32e8e04e 271 */
pierreprovent 0:77ca32e8e04e 272 State get_state();
pierreprovent 0:77ca32e8e04e 273
pierreprovent 0:77ca32e8e04e 274 /** Get the total stack memory size for this Thread
pierreprovent 0:77ca32e8e04e 275 @return the total stack memory size in bytes
pierreprovent 0:77ca32e8e04e 276 */
pierreprovent 0:77ca32e8e04e 277 uint32_t stack_size();
pierreprovent 0:77ca32e8e04e 278
pierreprovent 0:77ca32e8e04e 279 /** Get the currently unused stack memory for this Thread
pierreprovent 0:77ca32e8e04e 280 @return the currently unused stack memory in bytes
pierreprovent 0:77ca32e8e04e 281 */
pierreprovent 0:77ca32e8e04e 282 uint32_t free_stack();
pierreprovent 0:77ca32e8e04e 283
pierreprovent 0:77ca32e8e04e 284 /** Get the currently used stack memory for this Thread
pierreprovent 0:77ca32e8e04e 285 @return the currently used stack memory in bytes
pierreprovent 0:77ca32e8e04e 286 */
pierreprovent 0:77ca32e8e04e 287 uint32_t used_stack();
pierreprovent 0:77ca32e8e04e 288
pierreprovent 0:77ca32e8e04e 289 /** Get the maximum stack memory usage to date for this Thread
pierreprovent 0:77ca32e8e04e 290 @return the maximum stack memory usage to date in bytes
pierreprovent 0:77ca32e8e04e 291 */
pierreprovent 0:77ca32e8e04e 292 uint32_t max_stack();
pierreprovent 0:77ca32e8e04e 293
pierreprovent 0:77ca32e8e04e 294 /** Wait for one or more Signal Flags to become signaled for the current RUNNING thread.
pierreprovent 0:77ca32e8e04e 295 @param signals wait until all specified signal flags set or 0 for any single signal flag.
pierreprovent 0:77ca32e8e04e 296 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
pierreprovent 0:77ca32e8e04e 297 @return event flag information or error code.
pierreprovent 0:77ca32e8e04e 298 @note not callable from interrupt
pierreprovent 0:77ca32e8e04e 299 */
pierreprovent 0:77ca32e8e04e 300 static osEvent signal_wait(int32_t signals, uint32_t millisec=osWaitForever);
pierreprovent 0:77ca32e8e04e 301
pierreprovent 0:77ca32e8e04e 302 /** Wait for a specified time period in millisec:
pierreprovent 0:77ca32e8e04e 303 @param millisec time delay value
pierreprovent 0:77ca32e8e04e 304 @return status code that indicates the execution status of the function.
pierreprovent 0:77ca32e8e04e 305 @note not callable from interrupt
pierreprovent 0:77ca32e8e04e 306 */
pierreprovent 0:77ca32e8e04e 307 static osStatus wait(uint32_t millisec);
pierreprovent 0:77ca32e8e04e 308
pierreprovent 0:77ca32e8e04e 309 /** Pass control to next thread that is in state READY.
pierreprovent 0:77ca32e8e04e 310 @return status code that indicates the execution status of the function.
pierreprovent 0:77ca32e8e04e 311 @note not callable from interrupt
pierreprovent 0:77ca32e8e04e 312 */
pierreprovent 0:77ca32e8e04e 313 static osStatus yield();
pierreprovent 0:77ca32e8e04e 314
pierreprovent 0:77ca32e8e04e 315 /** Get the thread id of the current running thread.
pierreprovent 0:77ca32e8e04e 316 @return thread ID for reference by other functions or NULL in case of error.
pierreprovent 0:77ca32e8e04e 317 */
pierreprovent 0:77ca32e8e04e 318 static osThreadId gettid();
pierreprovent 0:77ca32e8e04e 319
pierreprovent 0:77ca32e8e04e 320 /** Attach a function to be called by the RTOS idle task
pierreprovent 0:77ca32e8e04e 321 @param fptr pointer to the function to be called
pierreprovent 0:77ca32e8e04e 322 */
pierreprovent 0:77ca32e8e04e 323 static void attach_idle_hook(void (*fptr)(void));
pierreprovent 0:77ca32e8e04e 324
pierreprovent 0:77ca32e8e04e 325 /** Attach a function to be called when a task is killed
pierreprovent 0:77ca32e8e04e 326 @param fptr pointer to the function to be called
pierreprovent 0:77ca32e8e04e 327 */
pierreprovent 0:77ca32e8e04e 328 static void attach_terminate_hook(void (*fptr)(osThreadId id));
pierreprovent 0:77ca32e8e04e 329
pierreprovent 0:77ca32e8e04e 330 virtual ~Thread();
pierreprovent 0:77ca32e8e04e 331
pierreprovent 0:77ca32e8e04e 332 private:
pierreprovent 0:77ca32e8e04e 333 // Required to share definitions without
pierreprovent 0:77ca32e8e04e 334 // delegated constructors
pierreprovent 0:77ca32e8e04e 335 void constructor(osPriority priority=osPriorityNormal,
pierreprovent 0:77ca32e8e04e 336 uint32_t stack_size=DEFAULT_STACK_SIZE,
pierreprovent 0:77ca32e8e04e 337 unsigned char *stack_pointer=NULL);
pierreprovent 0:77ca32e8e04e 338 void constructor(mbed::Callback<void()> task,
pierreprovent 0:77ca32e8e04e 339 osPriority priority=osPriorityNormal,
pierreprovent 0:77ca32e8e04e 340 uint32_t stack_size=DEFAULT_STACK_SIZE,
pierreprovent 0:77ca32e8e04e 341 unsigned char *stack_pointer=NULL);
pierreprovent 0:77ca32e8e04e 342 static void _thunk(const void * thread_ptr);
pierreprovent 0:77ca32e8e04e 343
pierreprovent 0:77ca32e8e04e 344 mbed::Callback<void()> _task;
pierreprovent 0:77ca32e8e04e 345 osThreadId _tid;
pierreprovent 0:77ca32e8e04e 346 osThreadDef_t _thread_def;
pierreprovent 0:77ca32e8e04e 347 bool _dynamic_stack;
pierreprovent 0:77ca32e8e04e 348 Semaphore _join_sem;
pierreprovent 0:77ca32e8e04e 349 Mutex _mutex;
pierreprovent 0:77ca32e8e04e 350 };
pierreprovent 0:77ca32e8e04e 351
pierreprovent 0:77ca32e8e04e 352 }
pierreprovent 0:77ca32e8e04e 353 #endif
pierreprovent 0:77ca32e8e04e 354
pierreprovent 0:77ca32e8e04e 355 /** @}*/