Knight KE / Mbed OS Game_Master

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.

mbed-os/rtos/RtosTimer.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WFKnight 0:9b3d4731edbb 1 /* mbed Microcontroller Library
WFKnight 0:9b3d4731edbb 2 * Copyright (c) 2006-2012 ARM Limited
WFKnight 0:9b3d4731edbb 3 *
WFKnight 0:9b3d4731edbb 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
WFKnight 0:9b3d4731edbb 5 * of this software and associated documentation files (the "Software"), to deal
WFKnight 0:9b3d4731edbb 6 * in the Software without restriction, including without limitation the rights
WFKnight 0:9b3d4731edbb 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
WFKnight 0:9b3d4731edbb 8 * copies of the Software, and to permit persons to whom the Software is
WFKnight 0:9b3d4731edbb 9 * furnished to do so, subject to the following conditions:
WFKnight 0:9b3d4731edbb 10 *
WFKnight 0:9b3d4731edbb 11 * The above copyright notice and this permission notice shall be included in
WFKnight 0:9b3d4731edbb 12 * all copies or substantial portions of the Software.
WFKnight 0:9b3d4731edbb 13 *
WFKnight 0:9b3d4731edbb 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
WFKnight 0:9b3d4731edbb 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
WFKnight 0:9b3d4731edbb 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
WFKnight 0:9b3d4731edbb 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
WFKnight 0:9b3d4731edbb 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
WFKnight 0:9b3d4731edbb 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
WFKnight 0:9b3d4731edbb 20 * SOFTWARE.
WFKnight 0:9b3d4731edbb 21 */
WFKnight 0:9b3d4731edbb 22 #ifndef RTOS_TIMER_H
WFKnight 0:9b3d4731edbb 23 #define RTOS_TIMER_H
WFKnight 0:9b3d4731edbb 24
WFKnight 0:9b3d4731edbb 25 #include <stdint.h>
WFKnight 0:9b3d4731edbb 26 #include "cmsis_os2.h"
WFKnight 0:9b3d4731edbb 27 #include "mbed_rtos_storage.h"
WFKnight 0:9b3d4731edbb 28 #include "platform/Callback.h"
WFKnight 0:9b3d4731edbb 29 #include "platform/NonCopyable.h"
WFKnight 0:9b3d4731edbb 30 #include "platform/mbed_toolchain.h"
WFKnight 0:9b3d4731edbb 31 #include "mbed_rtos1_types.h"
WFKnight 0:9b3d4731edbb 32
WFKnight 0:9b3d4731edbb 33 namespace rtos {
WFKnight 0:9b3d4731edbb 34 /** \addtogroup rtos */
WFKnight 0:9b3d4731edbb 35 /** @{*/
WFKnight 0:9b3d4731edbb 36 /**
WFKnight 0:9b3d4731edbb 37 * \defgroup rtos_RtosTimer RtosTimer class
WFKnight 0:9b3d4731edbb 38 * @{
WFKnight 0:9b3d4731edbb 39 */
WFKnight 0:9b3d4731edbb 40
WFKnight 0:9b3d4731edbb 41 /** The RtosTimer class allow creating and and controlling of timer functions in the system.
WFKnight 0:9b3d4731edbb 42 A timer function is called when a time period expires whereby both on-shot and
WFKnight 0:9b3d4731edbb 43 periodic timers are possible. A timer can be started, restarted, or stopped.
WFKnight 0:9b3d4731edbb 44
WFKnight 0:9b3d4731edbb 45 Timers are handled in the thread osTimerThread.
WFKnight 0:9b3d4731edbb 46 Callback functions run under control of this thread and may use CMSIS-RTOS API calls.
WFKnight 0:9b3d4731edbb 47
WFKnight 0:9b3d4731edbb 48 @deprecated
WFKnight 0:9b3d4731edbb 49 The RtosTimer has been superseded by the EventQueue. The RtosTimer and EventQueue duplicate
WFKnight 0:9b3d4731edbb 50 the functionality of timing events outside of interrupt context, however the EventQueue
WFKnight 0:9b3d4731edbb 51 has additional features to handle deferring other events to multiple contexts.
WFKnight 0:9b3d4731edbb 52
WFKnight 0:9b3d4731edbb 53 For an example, the following code shows a simple use of the RtosTimer:
WFKnight 0:9b3d4731edbb 54 @code
WFKnight 0:9b3d4731edbb 55 DigitalOut led(LED1);
WFKnight 0:9b3d4731edbb 56 void blink() {
WFKnight 0:9b3d4731edbb 57 led = !led;
WFKnight 0:9b3d4731edbb 58 }
WFKnight 0:9b3d4731edbb 59
WFKnight 0:9b3d4731edbb 60 RtosTimer timer(&blink);
WFKnight 0:9b3d4731edbb 61 int main() {
WFKnight 0:9b3d4731edbb 62 timer.start(1000); // call blink every 1s
WFKnight 0:9b3d4731edbb 63 wait_ms(5000);
WFKnight 0:9b3d4731edbb 64 timer.stop(); // stop after 5s
WFKnight 0:9b3d4731edbb 65 }
WFKnight 0:9b3d4731edbb 66 @endcode
WFKnight 0:9b3d4731edbb 67
WFKnight 0:9b3d4731edbb 68 This is the above example rewritten to use the EventQueue:
WFKnight 0:9b3d4731edbb 69 @code
WFKnight 0:9b3d4731edbb 70 DigitalOut led(LED1);
WFKnight 0:9b3d4731edbb 71 void blink() {
WFKnight 0:9b3d4731edbb 72 led = !led;
WFKnight 0:9b3d4731edbb 73 }
WFKnight 0:9b3d4731edbb 74
WFKnight 0:9b3d4731edbb 75 EventQueue queue(4*EVENTS_EVENT_SIZE);
WFKnight 0:9b3d4731edbb 76 int main() {
WFKnight 0:9b3d4731edbb 77 int blink_id = queue.call_every(1000, &blink); // call blink every 1s
WFKnight 0:9b3d4731edbb 78 queue.dispatch(5000);
WFKnight 0:9b3d4731edbb 79 queue.cancel(blink_id); // stop after 5s
WFKnight 0:9b3d4731edbb 80 }
WFKnight 0:9b3d4731edbb 81 @endcode
WFKnight 0:9b3d4731edbb 82
WFKnight 0:9b3d4731edbb 83 @note
WFKnight 0:9b3d4731edbb 84 Memory considerations: The timer control structures will be created on current thread's stack, both for the mbed OS
WFKnight 0:9b3d4731edbb 85 and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).
WFKnight 0:9b3d4731edbb 86 */
WFKnight 0:9b3d4731edbb 87 class RtosTimer : private mbed::NonCopyable<RtosTimer> {
WFKnight 0:9b3d4731edbb 88 public:
WFKnight 0:9b3d4731edbb 89 /** Create timer.
WFKnight 0:9b3d4731edbb 90 @param func function to be executed by this timer.
WFKnight 0:9b3d4731edbb 91 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
WFKnight 0:9b3d4731edbb 92 @param argument argument to the timer call back function. (default: NULL)
WFKnight 0:9b3d4731edbb 93 @deprecated Replaced with RtosTimer(Callback<void()>, os_timer_type)
WFKnight 0:9b3d4731edbb 94 @deprecated
WFKnight 0:9b3d4731edbb 95 The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details
WFKnight 0:9b3d4731edbb 96
WFKnight 0:9b3d4731edbb 97 @note You cannot call this function from ISR context.
WFKnight 0:9b3d4731edbb 98 */
WFKnight 0:9b3d4731edbb 99 MBED_DEPRECATED_SINCE("mbed-os-5.1",
WFKnight 0:9b3d4731edbb 100 "Replaced with RtosTimer(Callback<void()>, os_timer_type)")
WFKnight 0:9b3d4731edbb 101 MBED_DEPRECATED_SINCE("mbed-os-5.2",
WFKnight 0:9b3d4731edbb 102 "The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details")
WFKnight 0:9b3d4731edbb 103 RtosTimer(void (*func)(void const *argument), os_timer_type type=osTimerPeriodic, void *argument=NULL) {
WFKnight 0:9b3d4731edbb 104 constructor(mbed::callback((void (*)(void *))func, argument), type);
WFKnight 0:9b3d4731edbb 105 }
WFKnight 0:9b3d4731edbb 106
WFKnight 0:9b3d4731edbb 107 /** Create timer.
WFKnight 0:9b3d4731edbb 108 @param func function to be executed by this timer.
WFKnight 0:9b3d4731edbb 109 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
WFKnight 0:9b3d4731edbb 110 @deprecated
WFKnight 0:9b3d4731edbb 111 The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details
WFKnight 0:9b3d4731edbb 112
WFKnight 0:9b3d4731edbb 113 @note You cannot call this function from ISR context.
WFKnight 0:9b3d4731edbb 114 */
WFKnight 0:9b3d4731edbb 115 MBED_DEPRECATED_SINCE("mbed-os-5.2",
WFKnight 0:9b3d4731edbb 116 "The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details")
WFKnight 0:9b3d4731edbb 117 RtosTimer(mbed::Callback<void()> func, os_timer_type type=osTimerPeriodic) {
WFKnight 0:9b3d4731edbb 118 constructor(func, type);
WFKnight 0:9b3d4731edbb 119 }
WFKnight 0:9b3d4731edbb 120
WFKnight 0:9b3d4731edbb 121 /** Create timer.
WFKnight 0:9b3d4731edbb 122 @param obj pointer to the object to call the member function on.
WFKnight 0:9b3d4731edbb 123 @param method member function to be executed by this timer.
WFKnight 0:9b3d4731edbb 124 @param type osTimerOnce for one-shot or osTimerPeriodic for periodic behaviour. (default: osTimerPeriodic)
WFKnight 0:9b3d4731edbb 125 @deprecated
WFKnight 0:9b3d4731edbb 126 The RtosTimer constructor does not support cv-qualifiers. Replaced by
WFKnight 0:9b3d4731edbb 127 RtosTimer(callback(obj, method), os_timer_type).
WFKnight 0:9b3d4731edbb 128 @deprecated
WFKnight 0:9b3d4731edbb 129 The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details
WFKnight 0:9b3d4731edbb 130
WFKnight 0:9b3d4731edbb 131 @note You cannot call this function from ISR context.
WFKnight 0:9b3d4731edbb 132 */
WFKnight 0:9b3d4731edbb 133 template <typename T, typename M>
WFKnight 0:9b3d4731edbb 134 MBED_DEPRECATED_SINCE("mbed-os-5.1",
WFKnight 0:9b3d4731edbb 135 "The RtosTimer constructor does not support cv-qualifiers. Replaced by "
WFKnight 0:9b3d4731edbb 136 "RtosTimer(callback(obj, method), os_timer_type).")
WFKnight 0:9b3d4731edbb 137 MBED_DEPRECATED_SINCE("mbed-os-5.2",
WFKnight 0:9b3d4731edbb 138 "The RtosTimer has been superseded by the EventQueue. See RtosTimer.h for more details")
WFKnight 0:9b3d4731edbb 139 RtosTimer(T *obj, M method, os_timer_type type=osTimerPeriodic) {
WFKnight 0:9b3d4731edbb 140 constructor(mbed::callback(obj, method), type);
WFKnight 0:9b3d4731edbb 141 }
WFKnight 0:9b3d4731edbb 142
WFKnight 0:9b3d4731edbb 143 /** Stop the timer.
WFKnight 0:9b3d4731edbb 144 @return status code that indicates the execution status of the function:
WFKnight 0:9b3d4731edbb 145 @a osOK the timer has been stopped.
WFKnight 0:9b3d4731edbb 146 @a osErrorISR @a stop cannot be called from interrupt service routines.
WFKnight 0:9b3d4731edbb 147 @a osErrorParameter internal error.
WFKnight 0:9b3d4731edbb 148 @a osErrorResource the timer is not running.
WFKnight 0:9b3d4731edbb 149
WFKnight 0:9b3d4731edbb 150 @note You cannot call this function from ISR context.
WFKnight 0:9b3d4731edbb 151 */
WFKnight 0:9b3d4731edbb 152 osStatus stop(void);
WFKnight 0:9b3d4731edbb 153
WFKnight 0:9b3d4731edbb 154 /** Start or restart the timer.
WFKnight 0:9b3d4731edbb 155 @param millisec non-zero value of the timer.
WFKnight 0:9b3d4731edbb 156 @return status code that indicates the execution status of the function:
WFKnight 0:9b3d4731edbb 157 @a osOK the timer has been started or restarted.
WFKnight 0:9b3d4731edbb 158 @a osErrorISR @a start cannot be called from interrupt service routines.
WFKnight 0:9b3d4731edbb 159 @a osErrorParameter internal error or incorrect parameter value.
WFKnight 0:9b3d4731edbb 160 @a osErrorResource internal error (the timer is in an invalid timer state).
WFKnight 0:9b3d4731edbb 161
WFKnight 0:9b3d4731edbb 162 @note You cannot call this function from ISR context.
WFKnight 0:9b3d4731edbb 163 */
WFKnight 0:9b3d4731edbb 164 osStatus start(uint32_t millisec);
WFKnight 0:9b3d4731edbb 165
WFKnight 0:9b3d4731edbb 166 /** RtosTimer destructor
WFKnight 0:9b3d4731edbb 167 *
WFKnight 0:9b3d4731edbb 168 * @note You cannot call this function from ISR context.
WFKnight 0:9b3d4731edbb 169 */
WFKnight 0:9b3d4731edbb 170 ~RtosTimer();
WFKnight 0:9b3d4731edbb 171
WFKnight 0:9b3d4731edbb 172 private:
WFKnight 0:9b3d4731edbb 173 // Required to share definitions without
WFKnight 0:9b3d4731edbb 174 // delegated constructors
WFKnight 0:9b3d4731edbb 175 void constructor(mbed::Callback<void()> func, os_timer_type type);
WFKnight 0:9b3d4731edbb 176
WFKnight 0:9b3d4731edbb 177 osTimerId_t _id;
WFKnight 0:9b3d4731edbb 178 mbed_rtos_storage_timer_t _obj_mem;
WFKnight 0:9b3d4731edbb 179 mbed::Callback<void()> _function;
WFKnight 0:9b3d4731edbb 180 };
WFKnight 0:9b3d4731edbb 181 /** @}*/
WFKnight 0:9b3d4731edbb 182 /** @}*/
WFKnight 0:9b3d4731edbb 183
WFKnight 0:9b3d4731edbb 184 }
WFKnight 0:9b3d4731edbb 185
WFKnight 0:9b3d4731edbb 186 #endif
WFKnight 0:9b3d4731edbb 187
WFKnight 0:9b3d4731edbb 188