mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/Ticker.h@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
156:ff21514d8981
Child:
165:d1b4690b3f8b
mbed library. Release version 158

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 156:ff21514d8981 3 *
AnnaBridge 156:ff21514d8981 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 5 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 6 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 7 *
AnnaBridge 156:ff21514d8981 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 9 *
AnnaBridge 156:ff21514d8981 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 13 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 14 * limitations under the License.
AnnaBridge 156:ff21514d8981 15 */
AnnaBridge 156:ff21514d8981 16 #ifndef MBED_TICKER_H
AnnaBridge 156:ff21514d8981 17 #define MBED_TICKER_H
AnnaBridge 156:ff21514d8981 18
AnnaBridge 156:ff21514d8981 19 #include "drivers/TimerEvent.h"
AnnaBridge 156:ff21514d8981 20 #include "platform/Callback.h"
AnnaBridge 156:ff21514d8981 21 #include "platform/mbed_toolchain.h"
AnnaBridge 156:ff21514d8981 22 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 23 #include "platform/mbed_sleep.h"
AnnaBridge 156:ff21514d8981 24 #include "hal/lp_ticker_api.h"
AnnaBridge 156:ff21514d8981 25 #include "platform/mbed_critical.h"
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 namespace mbed {
AnnaBridge 156:ff21514d8981 28 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 29
AnnaBridge 156:ff21514d8981 30 /** A Ticker is used to call a function at a recurring interval
AnnaBridge 156:ff21514d8981 31 *
AnnaBridge 156:ff21514d8981 32 * You can use as many separate Ticker objects as you require.
AnnaBridge 156:ff21514d8981 33 *
AnnaBridge 156:ff21514d8981 34 * @note Synchronization level: Interrupt safe
AnnaBridge 156:ff21514d8981 35 *
AnnaBridge 156:ff21514d8981 36 * Example:
AnnaBridge 156:ff21514d8981 37 * @code
AnnaBridge 156:ff21514d8981 38 * // Toggle the blinking led after 5 seconds
AnnaBridge 156:ff21514d8981 39 *
AnnaBridge 156:ff21514d8981 40 * #include "mbed.h"
AnnaBridge 156:ff21514d8981 41 *
AnnaBridge 156:ff21514d8981 42 * Ticker timer;
AnnaBridge 156:ff21514d8981 43 * DigitalOut led1(LED1);
AnnaBridge 156:ff21514d8981 44 * DigitalOut led2(LED2);
AnnaBridge 156:ff21514d8981 45 *
AnnaBridge 156:ff21514d8981 46 * int flip = 0;
AnnaBridge 156:ff21514d8981 47 *
AnnaBridge 156:ff21514d8981 48 * void attime() {
AnnaBridge 156:ff21514d8981 49 * flip = !flip;
AnnaBridge 156:ff21514d8981 50 * }
AnnaBridge 156:ff21514d8981 51 *
AnnaBridge 156:ff21514d8981 52 * int main() {
AnnaBridge 156:ff21514d8981 53 * timer.attach(&attime, 5);
AnnaBridge 156:ff21514d8981 54 * while(1) {
AnnaBridge 156:ff21514d8981 55 * if(flip == 0) {
AnnaBridge 156:ff21514d8981 56 * led1 = !led1;
AnnaBridge 156:ff21514d8981 57 * } else {
AnnaBridge 156:ff21514d8981 58 * led2 = !led2;
AnnaBridge 156:ff21514d8981 59 * }
AnnaBridge 156:ff21514d8981 60 * wait(0.2);
AnnaBridge 156:ff21514d8981 61 * }
AnnaBridge 156:ff21514d8981 62 * }
AnnaBridge 156:ff21514d8981 63 * @endcode
AnnaBridge 156:ff21514d8981 64 * @ingroup drivers
AnnaBridge 156:ff21514d8981 65 */
AnnaBridge 156:ff21514d8981 66 class Ticker : public TimerEvent, private NonCopyable<Ticker> {
AnnaBridge 156:ff21514d8981 67
AnnaBridge 156:ff21514d8981 68 public:
AnnaBridge 156:ff21514d8981 69 Ticker() : TimerEvent(), _function(0), _lock_deepsleep(true) {
AnnaBridge 156:ff21514d8981 70 }
AnnaBridge 156:ff21514d8981 71
AnnaBridge 156:ff21514d8981 72 // When low power ticker is in use, then do not disable deep-sleep.
AnnaBridge 156:ff21514d8981 73 Ticker(const ticker_data_t *data) : TimerEvent(data), _function(0), _lock_deepsleep(true) {
AnnaBridge 156:ff21514d8981 74 data->interface->init();
AnnaBridge 156:ff21514d8981 75 #if DEVICE_LOWPOWERTIMER
AnnaBridge 156:ff21514d8981 76 _lock_deepsleep = (data != get_lp_ticker_data());
AnnaBridge 156:ff21514d8981 77 #endif
AnnaBridge 156:ff21514d8981 78 }
AnnaBridge 156:ff21514d8981 79
AnnaBridge 156:ff21514d8981 80 /** Attach a function to be called by the Ticker, specifying the interval in seconds
AnnaBridge 156:ff21514d8981 81 *
AnnaBridge 156:ff21514d8981 82 * @param func pointer to the function to be called
AnnaBridge 156:ff21514d8981 83 * @param t the time between calls in seconds
AnnaBridge 156:ff21514d8981 84 */
AnnaBridge 156:ff21514d8981 85 void attach(Callback<void()> func, float t) {
AnnaBridge 156:ff21514d8981 86 attach_us(func, t * 1000000.0f);
AnnaBridge 156:ff21514d8981 87 }
AnnaBridge 156:ff21514d8981 88
AnnaBridge 156:ff21514d8981 89 /** Attach a member function to be called by the Ticker, specifying the interval in seconds
AnnaBridge 156:ff21514d8981 90 *
AnnaBridge 156:ff21514d8981 91 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 92 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 93 * @param t the time between calls in seconds
AnnaBridge 156:ff21514d8981 94 * @deprecated
AnnaBridge 156:ff21514d8981 95 * The attach function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 96 * attach(callback(obj, method), t).
AnnaBridge 156:ff21514d8981 97 */
AnnaBridge 156:ff21514d8981 98 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 99 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 156:ff21514d8981 100 "The attach function does not support cv-qualifiers. Replaced by "
AnnaBridge 156:ff21514d8981 101 "attach(callback(obj, method), t).")
AnnaBridge 156:ff21514d8981 102 void attach(T *obj, M method, float t) {
AnnaBridge 156:ff21514d8981 103 attach(callback(obj, method), t);
AnnaBridge 156:ff21514d8981 104 }
AnnaBridge 156:ff21514d8981 105
AnnaBridge 156:ff21514d8981 106 /** Attach a function to be called by the Ticker, specifying the interval in micro-seconds
AnnaBridge 156:ff21514d8981 107 *
AnnaBridge 156:ff21514d8981 108 * @param func pointer to the function to be called
AnnaBridge 156:ff21514d8981 109 * @param t the time between calls in micro-seconds
AnnaBridge 156:ff21514d8981 110 *
AnnaBridge 156:ff21514d8981 111 * @note setting @a t to a value shorter that it takes to process the ticker callback
AnnaBridge 156:ff21514d8981 112 * will cause the system to hang. Ticker callback will be called constantly with no time
AnnaBridge 156:ff21514d8981 113 * for threads scheduling.
AnnaBridge 156:ff21514d8981 114 *
AnnaBridge 156:ff21514d8981 115 */
AnnaBridge 156:ff21514d8981 116 void attach_us(Callback<void()> func, us_timestamp_t t) {
AnnaBridge 156:ff21514d8981 117 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 118 // lock only for the initial callback setup and this is not low power ticker
AnnaBridge 156:ff21514d8981 119 if(!_function && _lock_deepsleep) {
AnnaBridge 156:ff21514d8981 120 sleep_manager_lock_deep_sleep();
AnnaBridge 156:ff21514d8981 121 }
AnnaBridge 156:ff21514d8981 122 _function = func;
AnnaBridge 156:ff21514d8981 123 setup(t);
AnnaBridge 156:ff21514d8981 124 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 125 }
AnnaBridge 156:ff21514d8981 126
AnnaBridge 156:ff21514d8981 127 /** Attach a member function to be called by the Ticker, specifying the interval in micro-seconds
AnnaBridge 156:ff21514d8981 128 *
AnnaBridge 156:ff21514d8981 129 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 130 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 131 * @param t the time between calls in micro-seconds
AnnaBridge 156:ff21514d8981 132 * @deprecated
AnnaBridge 156:ff21514d8981 133 * The attach_us function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 134 * attach_us(callback(obj, method), t).
AnnaBridge 156:ff21514d8981 135 */
AnnaBridge 156:ff21514d8981 136 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 137 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 156:ff21514d8981 138 "The attach_us function does not support cv-qualifiers. Replaced by "
AnnaBridge 156:ff21514d8981 139 "attach_us(callback(obj, method), t).")
AnnaBridge 156:ff21514d8981 140 void attach_us(T *obj, M method, us_timestamp_t t) {
AnnaBridge 156:ff21514d8981 141 attach_us(Callback<void()>(obj, method), t);
AnnaBridge 156:ff21514d8981 142 }
AnnaBridge 156:ff21514d8981 143
AnnaBridge 156:ff21514d8981 144 virtual ~Ticker() {
AnnaBridge 156:ff21514d8981 145 detach();
AnnaBridge 156:ff21514d8981 146 }
AnnaBridge 156:ff21514d8981 147
AnnaBridge 156:ff21514d8981 148 /** Detach the function
AnnaBridge 156:ff21514d8981 149 */
AnnaBridge 156:ff21514d8981 150 void detach();
AnnaBridge 156:ff21514d8981 151
AnnaBridge 156:ff21514d8981 152 protected:
AnnaBridge 156:ff21514d8981 153 void setup(us_timestamp_t t);
AnnaBridge 156:ff21514d8981 154 virtual void handler();
AnnaBridge 156:ff21514d8981 155
AnnaBridge 156:ff21514d8981 156 protected:
AnnaBridge 156:ff21514d8981 157 us_timestamp_t _delay; /**< Time delay (in microseconds) for re-setting the multi-shot callback. */
AnnaBridge 156:ff21514d8981 158 Callback<void()> _function; /**< Callback. */
AnnaBridge 156:ff21514d8981 159 bool _lock_deepsleep; /**< Flag which indicates if deep-sleep should be disabled. */
AnnaBridge 156:ff21514d8981 160 };
AnnaBridge 156:ff21514d8981 161
AnnaBridge 156:ff21514d8981 162 } // namespace mbed
AnnaBridge 156:ff21514d8981 163
AnnaBridge 156:ff21514d8981 164 #endif