mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/Ticker.h@188:bcfe06ba3d64, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:46:34 2018 +0000
Revision:
188:bcfe06ba3d64
Parent:
187:0387e8f68319
Child:
189:f392fc9709a3
mbed-dev library. Release version 164

Who changed what in which revision?

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