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@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

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 165:d1b4690b3f8b 23 #include "platform/mbed_power_mgmt.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 171:3a7713b1edbc 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 170:e95d10626187 69 Ticker() : TimerEvent(), _function(0), _lock_deepsleep(true)
AnnaBridge 170:e95d10626187 70 {
AnnaBridge 156:ff21514d8981 71 }
AnnaBridge 156:ff21514d8981 72
AnnaBridge 171:3a7713b1edbc 73 // When low power ticker is in use, then do not disable deep sleep.
AnnaBridge 170:e95d10626187 74 Ticker(const ticker_data_t *data) : TimerEvent(data), _function(0), _lock_deepsleep(true)
AnnaBridge 170:e95d10626187 75 {
Anna Bridge 169:a7c7b631e539 76 #if DEVICE_LPTICKER
AnnaBridge 156:ff21514d8981 77 _lock_deepsleep = (data != get_lp_ticker_data());
AnnaBridge 156:ff21514d8981 78 #endif
AnnaBridge 156:ff21514d8981 79 }
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 /** Attach a function to be called by the Ticker, specifying the interval in seconds
AnnaBridge 156:ff21514d8981 82 *
AnnaBridge 156:ff21514d8981 83 * @param func pointer to the function to be called
AnnaBridge 156:ff21514d8981 84 * @param t the time between calls in seconds
AnnaBridge 156:ff21514d8981 85 */
AnnaBridge 170:e95d10626187 86 void attach(Callback<void()> func, float t)
AnnaBridge 170:e95d10626187 87 {
AnnaBridge 156:ff21514d8981 88 attach_us(func, t * 1000000.0f);
AnnaBridge 156:ff21514d8981 89 }
AnnaBridge 156:ff21514d8981 90
AnnaBridge 156:ff21514d8981 91 /** Attach a member function to be called by the Ticker, specifying the interval in seconds
AnnaBridge 156:ff21514d8981 92 *
AnnaBridge 156:ff21514d8981 93 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 94 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 95 * @param t the time between calls in seconds
AnnaBridge 156:ff21514d8981 96 * @deprecated
AnnaBridge 156:ff21514d8981 97 * The attach function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 98 * attach(callback(obj, method), t).
AnnaBridge 156:ff21514d8981 99 */
AnnaBridge 156:ff21514d8981 100 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 101 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 170:e95d10626187 102 "The attach function does not support cv-qualifiers. Replaced by "
AnnaBridge 170:e95d10626187 103 "attach(callback(obj, method), t).")
AnnaBridge 170:e95d10626187 104 void attach(T *obj, M method, float t)
AnnaBridge 170:e95d10626187 105 {
AnnaBridge 156:ff21514d8981 106 attach(callback(obj, method), t);
AnnaBridge 156:ff21514d8981 107 }
AnnaBridge 156:ff21514d8981 108
AnnaBridge 171:3a7713b1edbc 109 /** Attach a function to be called by the Ticker, specifying the interval in microseconds
AnnaBridge 156:ff21514d8981 110 *
AnnaBridge 156:ff21514d8981 111 * @param func pointer to the function to be called
AnnaBridge 156:ff21514d8981 112 * @param t the time between calls in micro-seconds
AnnaBridge 156:ff21514d8981 113 *
AnnaBridge 171:3a7713b1edbc 114 * @note setting @a t to a value shorter than it takes to process the ticker callback
AnnaBridge 171:3a7713b1edbc 115 * causes the system to hang. Ticker callback is called constantly with no time
AnnaBridge 156:ff21514d8981 116 * for threads scheduling.
AnnaBridge 156:ff21514d8981 117 *
AnnaBridge 156:ff21514d8981 118 */
AnnaBridge 170:e95d10626187 119 void attach_us(Callback<void()> func, us_timestamp_t t)
AnnaBridge 170:e95d10626187 120 {
AnnaBridge 156:ff21514d8981 121 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 122 // lock only for the initial callback setup and this is not low power ticker
AnnaBridge 170:e95d10626187 123 if (!_function && _lock_deepsleep) {
AnnaBridge 156:ff21514d8981 124 sleep_manager_lock_deep_sleep();
AnnaBridge 156:ff21514d8981 125 }
AnnaBridge 156:ff21514d8981 126 _function = func;
AnnaBridge 156:ff21514d8981 127 setup(t);
AnnaBridge 156:ff21514d8981 128 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 129 }
AnnaBridge 156:ff21514d8981 130
AnnaBridge 171:3a7713b1edbc 131 /** Attach a member function to be called by the Ticker, specifying the interval in microseconds
AnnaBridge 156:ff21514d8981 132 *
AnnaBridge 156:ff21514d8981 133 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 134 * @param method pointer to the member function to be called
AnnaBridge 171:3a7713b1edbc 135 * @param t the time between calls in microseconds
AnnaBridge 156:ff21514d8981 136 * @deprecated
AnnaBridge 156:ff21514d8981 137 * The attach_us function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 138 * attach_us(callback(obj, method), t).
AnnaBridge 156:ff21514d8981 139 */
AnnaBridge 156:ff21514d8981 140 template<typename T, typename M>
AnnaBridge 156:ff21514d8981 141 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 170:e95d10626187 142 "The attach_us function does not support cv-qualifiers. Replaced by "
AnnaBridge 170:e95d10626187 143 "attach_us(callback(obj, method), t).")
AnnaBridge 170:e95d10626187 144 void attach_us(T *obj, M method, us_timestamp_t t)
AnnaBridge 170:e95d10626187 145 {
AnnaBridge 156:ff21514d8981 146 attach_us(Callback<void()>(obj, method), t);
AnnaBridge 156:ff21514d8981 147 }
AnnaBridge 156:ff21514d8981 148
AnnaBridge 170:e95d10626187 149 virtual ~Ticker()
AnnaBridge 170:e95d10626187 150 {
AnnaBridge 156:ff21514d8981 151 detach();
AnnaBridge 156:ff21514d8981 152 }
AnnaBridge 156:ff21514d8981 153
AnnaBridge 156:ff21514d8981 154 /** Detach the function
AnnaBridge 156:ff21514d8981 155 */
AnnaBridge 156:ff21514d8981 156 void detach();
AnnaBridge 156:ff21514d8981 157
AnnaBridge 171:3a7713b1edbc 158 #if !defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 159 protected:
AnnaBridge 156:ff21514d8981 160 void setup(us_timestamp_t t);
AnnaBridge 156:ff21514d8981 161 virtual void handler();
AnnaBridge 156:ff21514d8981 162
AnnaBridge 156:ff21514d8981 163 protected:
AnnaBridge 171:3a7713b1edbc 164 us_timestamp_t _delay; /**< Time delay (in microseconds) for resetting the multishot callback. */
AnnaBridge 156:ff21514d8981 165 Callback<void()> _function; /**< Callback. */
AnnaBridge 171:3a7713b1edbc 166 bool _lock_deepsleep; /**< Flag which indicates if deep sleep should be disabled. */
AnnaBridge 171:3a7713b1edbc 167 #endif
AnnaBridge 156:ff21514d8981 168 };
AnnaBridge 156:ff21514d8981 169
AnnaBridge 156:ff21514d8981 170 } // namespace mbed
AnnaBridge 156:ff21514d8981 171
AnnaBridge 156:ff21514d8981 172 #endif