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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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