Dylan Saada / Mbed 2 deprecated telemetre2

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

USBHost/mbed-rtos/rtos/Thread.h@0:6ce9c65992e5, 2015-04-15 (annotated)

Committer:
dylancachan
Date:
Wed Apr 15 06:23:18 2015 +0000
Revision:
0:6ce9c65992e5
telemetre

Who changed what in which revision?

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