Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

init

Dependencies:   mbed

mbed-os/drivers/Ticker.h@10:46a4cf51ee38, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:16:49 2018 -0700
Revision:
10:46a4cf51ee38
Parent:
9:d58e77ebd769 
remove mbed-os

Who changed what in which revision?

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