PES4 / Mbed OS Queue_02

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@1:b36bbc1c6d27, 2020-04-11 (annotated)

Committer:
demayer
Date:
Sat Apr 11 08:15:48 2020 +0000
Revision:
1:b36bbc1c6d27
Parent:
0:6bf0743ece18 
IMU-library in .h und .cpp file aufgeteilt

Who changed what in which revision?

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