Alan Ffrench / Mbed 2 deprecated Experiment_2_5

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.

Dependencies:   mbed

mbed-rtos/rtos/Thread.h@0:52468b19aa21, 2020-07-29 (annotated)

Committer:
alanffrench
Date:
Wed Jul 29 18:51:38 2020 +0000
Revision:
0:52468b19aa21
Threads

Who changed what in which revision?

UserRevisionLine numberNew contents of line
alanffrench 0:52468b19aa21 1 /* mbed Microcontroller Library
alanffrench 0:52468b19aa21 2 * Copyright (c) 2006-2012 ARM Limited
alanffrench 0:52468b19aa21 3 *
alanffrench 0:52468b19aa21 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
alanffrench 0:52468b19aa21 5 * of this software and associated documentation files (the "Software"), to deal
alanffrench 0:52468b19aa21 6 * in the Software without restriction, including without limitation the rights
alanffrench 0:52468b19aa21 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
alanffrench 0:52468b19aa21 8 * copies of the Software, and to permit persons to whom the Software is
alanffrench 0:52468b19aa21 9 * furnished to do so, subject to the following conditions:
alanffrench 0:52468b19aa21 10 *
alanffrench 0:52468b19aa21 11 * The above copyright notice and this permission notice shall be included in
alanffrench 0:52468b19aa21 12 * all copies or substantial portions of the Software.
alanffrench 0:52468b19aa21 13 *
alanffrench 0:52468b19aa21 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
alanffrench 0:52468b19aa21 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
alanffrench 0:52468b19aa21 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
alanffrench 0:52468b19aa21 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
alanffrench 0:52468b19aa21 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
alanffrench 0:52468b19aa21 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
alanffrench 0:52468b19aa21 20 * SOFTWARE.
alanffrench 0:52468b19aa21 21 */
alanffrench 0:52468b19aa21 22 #ifndef THREAD_H
alanffrench 0:52468b19aa21 23 #define THREAD_H
alanffrench 0:52468b19aa21 24
alanffrench 0:52468b19aa21 25 #include <stdint.h>
alanffrench 0:52468b19aa21 26 #include "cmsis_os.h"
alanffrench 0:52468b19aa21 27
alanffrench 0:52468b19aa21 28 namespace rtos {
alanffrench 0:52468b19aa21 29
alanffrench 0:52468b19aa21 30 /** The Thread class allow defining, creating, and controlling thread functions in the system. */
alanffrench 0:52468b19aa21 31 class Thread {
alanffrench 0:52468b19aa21 32 public:
alanffrench 0:52468b19aa21 33 /** Create a new thread, and start it executing the specified function.
alanffrench 0:52468b19aa21 34 @param task function to be executed by this thread.
alanffrench 0:52468b19aa21 35 @param argument pointer that is passed to the thread function as start argument. (default: NULL).
alanffrench 0:52468b19aa21 36 @param priority initial priority of the thread function. (default: osPriorityNormal).
alanffrench 0:52468b19aa21 37 @param stack_size stack size (in bytes) requirements for the thread function. (default: DEFAULT_STACK_SIZE).
alanffrench 0:52468b19aa21 38 @param stack_pointer pointer to the stack area to be used by this thread (default: NULL).
alanffrench 0:52468b19aa21 39 */
alanffrench 0:52468b19aa21 40 Thread(void (*task)(void const *argument), void *argument=NULL,
alanffrench 0:52468b19aa21 41 osPriority priority=osPriorityNormal,
alanffrench 0:52468b19aa21 42 uint32_t stack_size=DEFAULT_STACK_SIZE,
alanffrench 0:52468b19aa21 43 unsigned char *stack_pointer=NULL);
alanffrench 0:52468b19aa21 44
alanffrench 0:52468b19aa21 45 /** Terminate execution of a thread and remove it from Active Threads
alanffrench 0:52468b19aa21 46 @return status code that indicates the execution status of the function.
alanffrench 0:52468b19aa21 47 */
alanffrench 0:52468b19aa21 48 osStatus terminate();
alanffrench 0:52468b19aa21 49
alanffrench 0:52468b19aa21 50 /** Set priority of an active thread
alanffrench 0:52468b19aa21 51 @param priority new priority value for the thread function.
alanffrench 0:52468b19aa21 52 @return status code that indicates the execution status of the function.
alanffrench 0:52468b19aa21 53 */
alanffrench 0:52468b19aa21 54 osStatus set_priority(osPriority priority);
alanffrench 0:52468b19aa21 55
alanffrench 0:52468b19aa21 56 /** Get priority of an active thread
alanffrench 0:52468b19aa21 57 @return current priority value of the thread function.
alanffrench 0:52468b19aa21 58 */
alanffrench 0:52468b19aa21 59 osPriority get_priority();
alanffrench 0:52468b19aa21 60
alanffrench 0:52468b19aa21 61 /** Set the specified Signal Flags of an active thread.
alanffrench 0:52468b19aa21 62 @param signals specifies the signal flags of the thread that should be set.
alanffrench 0:52468b19aa21 63 @return previous signal flags of the specified thread or 0x80000000 in case of incorrect parameters.
alanffrench 0:52468b19aa21 64 */
alanffrench 0:52468b19aa21 65 int32_t signal_set(int32_t signals);
alanffrench 0:52468b19aa21 66
alanffrench 0:52468b19aa21 67 /** State of the Thread */
alanffrench 0:52468b19aa21 68 enum State {
alanffrench 0:52468b19aa21 69 Inactive, /**< Not created or terminated */
alanffrench 0:52468b19aa21 70 Ready, /**< Ready to run */
alanffrench 0:52468b19aa21 71 Running, /**< Running */
alanffrench 0:52468b19aa21 72 WaitingDelay, /**< Waiting for a delay to occur */
alanffrench 0:52468b19aa21 73 WaitingInterval, /**< Waiting for an interval to occur */
alanffrench 0:52468b19aa21 74 WaitingOr, /**< Waiting for one event in a set to occur */
alanffrench 0:52468b19aa21 75 WaitingAnd, /**< Waiting for multiple events in a set to occur */
alanffrench 0:52468b19aa21 76 WaitingSemaphore, /**< Waiting for a semaphore event to occur */
alanffrench 0:52468b19aa21 77 WaitingMailbox, /**< Waiting for a mailbox event to occur */
alanffrench 0:52468b19aa21 78 WaitingMutex, /**< Waiting for a mutex event to occur */
alanffrench 0:52468b19aa21 79 };
alanffrench 0:52468b19aa21 80
alanffrench 0:52468b19aa21 81 /** State of this Thread
alanffrench 0:52468b19aa21 82 @return the State of this Thread
alanffrench 0:52468b19aa21 83 */
alanffrench 0:52468b19aa21 84 State get_state();
alanffrench 0:52468b19aa21 85
alanffrench 0:52468b19aa21 86 /** Wait for one or more Signal Flags to become signaled for the current RUNNING thread.
alanffrench 0:52468b19aa21 87 @param signals wait until all specified signal flags set or 0 for any single signal flag.
alanffrench 0:52468b19aa21 88 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
alanffrench 0:52468b19aa21 89 @return event flag information or error code.
alanffrench 0:52468b19aa21 90 */
alanffrench 0:52468b19aa21 91 static osEvent signal_wait(int32_t signals, uint32_t millisec=osWaitForever);
alanffrench 0:52468b19aa21 92
alanffrench 0:52468b19aa21 93 /** Wait for a specified time period in millisec:
alanffrench 0:52468b19aa21 94 @param millisec time delay value
alanffrench 0:52468b19aa21 95 @return status code that indicates the execution status of the function.
alanffrench 0:52468b19aa21 96 */
alanffrench 0:52468b19aa21 97 static osStatus wait(uint32_t millisec);
alanffrench 0:52468b19aa21 98
alanffrench 0:52468b19aa21 99 /** Pass control to next thread that is in state READY.
alanffrench 0:52468b19aa21 100 @return status code that indicates the execution status of the function.
alanffrench 0:52468b19aa21 101 */
alanffrench 0:52468b19aa21 102 static osStatus yield();
alanffrench 0:52468b19aa21 103
alanffrench 0:52468b19aa21 104 /** Get the thread id of the current running thread.
alanffrench 0:52468b19aa21 105 @return thread ID for reference by other functions or NULL in case of error.
alanffrench 0:52468b19aa21 106 */
alanffrench 0:52468b19aa21 107 static osThreadId gettid();
alanffrench 0:52468b19aa21 108
alanffrench 0:52468b19aa21 109 virtual ~Thread();
alanffrench 0:52468b19aa21 110
alanffrench 0:52468b19aa21 111 private:
alanffrench 0:52468b19aa21 112 osThreadId _tid;
alanffrench 0:52468b19aa21 113 osThreadDef_t _thread_def;
alanffrench 0:52468b19aa21 114 bool _dynamic_stack;
alanffrench 0:52468b19aa21 115 };
alanffrench 0:52468b19aa21 116
alanffrench 0:52468b19aa21 117 }
alanffrench 0:52468b19aa21 118 #endif