Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/Ticker.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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