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/Timer.h@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
156:ff21514d8981
Child:
165:d1b4690b3f8b
mbed library. Release version 158

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_TIMER_H
AnnaBridge 156:ff21514d8981 17 #define MBED_TIMER_H
AnnaBridge 156:ff21514d8981 18
AnnaBridge 156:ff21514d8981 19 #include "platform/platform.h"
AnnaBridge 156:ff21514d8981 20 #include "hal/ticker_api.h"
AnnaBridge 156:ff21514d8981 21 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 22 #include "platform/mbed_sleep.h"
AnnaBridge 156:ff21514d8981 23
AnnaBridge 156:ff21514d8981 24 namespace mbed {
AnnaBridge 156:ff21514d8981 25 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 /** A general purpose timer
AnnaBridge 156:ff21514d8981 28 *
AnnaBridge 156:ff21514d8981 29 * @note Synchronization level: Interrupt safe
AnnaBridge 156:ff21514d8981 30 *
AnnaBridge 156:ff21514d8981 31 * Example:
AnnaBridge 156:ff21514d8981 32 * @code
AnnaBridge 156:ff21514d8981 33 * // Count the time to toggle a LED
AnnaBridge 156:ff21514d8981 34 *
AnnaBridge 156:ff21514d8981 35 * #include "mbed.h"
AnnaBridge 156:ff21514d8981 36 *
AnnaBridge 156:ff21514d8981 37 * Timer timer;
AnnaBridge 156:ff21514d8981 38 * DigitalOut led(LED1);
AnnaBridge 156:ff21514d8981 39 * int begin, end;
AnnaBridge 156:ff21514d8981 40 *
AnnaBridge 156:ff21514d8981 41 * int main() {
AnnaBridge 156:ff21514d8981 42 * timer.start();
AnnaBridge 156:ff21514d8981 43 * begin = timer.read_us();
AnnaBridge 156:ff21514d8981 44 * led = !led;
AnnaBridge 156:ff21514d8981 45 * end = timer.read_us();
AnnaBridge 156:ff21514d8981 46 * printf("Toggle the led takes %d us", end - begin);
AnnaBridge 156:ff21514d8981 47 * }
AnnaBridge 156:ff21514d8981 48 * @endcode
AnnaBridge 156:ff21514d8981 49 * @ingroup drivers
AnnaBridge 156:ff21514d8981 50 */
AnnaBridge 156:ff21514d8981 51 class Timer : private NonCopyable<Timer> {
AnnaBridge 156:ff21514d8981 52
AnnaBridge 156:ff21514d8981 53 public:
AnnaBridge 156:ff21514d8981 54 Timer();
AnnaBridge 156:ff21514d8981 55 Timer(const ticker_data_t *data);
AnnaBridge 156:ff21514d8981 56 ~Timer();
AnnaBridge 156:ff21514d8981 57
AnnaBridge 156:ff21514d8981 58 /** Start the timer
AnnaBridge 156:ff21514d8981 59 */
AnnaBridge 156:ff21514d8981 60 void start();
AnnaBridge 156:ff21514d8981 61
AnnaBridge 156:ff21514d8981 62 /** Stop the timer
AnnaBridge 156:ff21514d8981 63 */
AnnaBridge 156:ff21514d8981 64 void stop();
AnnaBridge 156:ff21514d8981 65
AnnaBridge 156:ff21514d8981 66 /** Reset the timer to 0.
AnnaBridge 156:ff21514d8981 67 *
AnnaBridge 156:ff21514d8981 68 * If it was already counting, it will continue
AnnaBridge 156:ff21514d8981 69 */
AnnaBridge 156:ff21514d8981 70 void reset();
AnnaBridge 156:ff21514d8981 71
AnnaBridge 156:ff21514d8981 72 /** Get the time passed in seconds
AnnaBridge 156:ff21514d8981 73 *
AnnaBridge 156:ff21514d8981 74 * @returns Time passed in seconds
AnnaBridge 156:ff21514d8981 75 */
AnnaBridge 156:ff21514d8981 76 float read();
AnnaBridge 156:ff21514d8981 77
AnnaBridge 156:ff21514d8981 78 /** Get the time passed in milli-seconds
AnnaBridge 156:ff21514d8981 79 *
AnnaBridge 156:ff21514d8981 80 * @returns Time passed in milli seconds
AnnaBridge 156:ff21514d8981 81 */
AnnaBridge 156:ff21514d8981 82 int read_ms();
AnnaBridge 156:ff21514d8981 83
AnnaBridge 156:ff21514d8981 84 /** Get the time passed in micro-seconds
AnnaBridge 156:ff21514d8981 85 *
AnnaBridge 156:ff21514d8981 86 * @returns Time passed in micro seconds
AnnaBridge 156:ff21514d8981 87 */
AnnaBridge 156:ff21514d8981 88 int read_us();
AnnaBridge 156:ff21514d8981 89
AnnaBridge 156:ff21514d8981 90 /** An operator shorthand for read()
AnnaBridge 156:ff21514d8981 91 */
AnnaBridge 156:ff21514d8981 92 operator float();
AnnaBridge 156:ff21514d8981 93
AnnaBridge 156:ff21514d8981 94 /** Get in a high resolution type the time passed in micro-seconds.
AnnaBridge 156:ff21514d8981 95 */
AnnaBridge 156:ff21514d8981 96 us_timestamp_t read_high_resolution_us();
AnnaBridge 156:ff21514d8981 97
AnnaBridge 156:ff21514d8981 98 protected:
AnnaBridge 156:ff21514d8981 99 us_timestamp_t slicetime();
AnnaBridge 156:ff21514d8981 100 int _running; // whether the timer is running
AnnaBridge 156:ff21514d8981 101 us_timestamp_t _start; // the start time of the latest slice
AnnaBridge 156:ff21514d8981 102 us_timestamp_t _time; // any accumulated time from previous slices
AnnaBridge 156:ff21514d8981 103 const ticker_data_t *_ticker_data;
AnnaBridge 156:ff21514d8981 104 bool _lock_deepsleep; // flag which indicates if deep-sleep should be disabled
AnnaBridge 156:ff21514d8981 105 };
AnnaBridge 156:ff21514d8981 106
AnnaBridge 156:ff21514d8981 107 } // namespace mbed
AnnaBridge 156:ff21514d8981 108
AnnaBridge 156:ff21514d8981 109 #endif