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@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Parent:
128:9bcdf88f62b0
Child:
146:22da6e220af6
Release 145 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1 /* mbed Microcontroller Library
<> 128:9bcdf88f62b0 2 * Copyright (c) 2006-2013 ARM Limited
<> 128:9bcdf88f62b0 3 *
<> 128:9bcdf88f62b0 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 128:9bcdf88f62b0 5 * you may not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 6 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 7 *
<> 128:9bcdf88f62b0 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 9 *
<> 128:9bcdf88f62b0 10 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 128:9bcdf88f62b0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 13 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 14 * limitations under the License.
<> 128:9bcdf88f62b0 15 */
<> 128:9bcdf88f62b0 16 #ifndef MBED_TIMER_H
<> 128:9bcdf88f62b0 17 #define MBED_TIMER_H
<> 128:9bcdf88f62b0 18
<> 128:9bcdf88f62b0 19 #include "platform/platform.h"
<> 128:9bcdf88f62b0 20 #include "hal/ticker_api.h"
<> 128:9bcdf88f62b0 21
<> 128:9bcdf88f62b0 22 namespace mbed {
<> 128:9bcdf88f62b0 23 /** \addtogroup drivers */
<> 128:9bcdf88f62b0 24
<> 128:9bcdf88f62b0 25 /** A general purpose timer
<> 128:9bcdf88f62b0 26 *
AnnaBridge 145:64910690c574 27 * @note Synchronization level: Interrupt safe
<> 128:9bcdf88f62b0 28 *
<> 128:9bcdf88f62b0 29 * Example:
<> 128:9bcdf88f62b0 30 * @code
<> 128:9bcdf88f62b0 31 * // Count the time to toggle a LED
<> 128:9bcdf88f62b0 32 *
<> 128:9bcdf88f62b0 33 * #include "mbed.h"
<> 128:9bcdf88f62b0 34 *
<> 128:9bcdf88f62b0 35 * Timer timer;
<> 128:9bcdf88f62b0 36 * DigitalOut led(LED1);
<> 128:9bcdf88f62b0 37 * int begin, end;
<> 128:9bcdf88f62b0 38 *
<> 128:9bcdf88f62b0 39 * int main() {
<> 128:9bcdf88f62b0 40 * timer.start();
<> 128:9bcdf88f62b0 41 * begin = timer.read_us();
<> 128:9bcdf88f62b0 42 * led = !led;
<> 128:9bcdf88f62b0 43 * end = timer.read_us();
<> 128:9bcdf88f62b0 44 * printf("Toggle the led takes %d us", end - begin);
<> 128:9bcdf88f62b0 45 * }
<> 128:9bcdf88f62b0 46 * @endcode
AnnaBridge 145:64910690c574 47 * @ingroup drivers
<> 128:9bcdf88f62b0 48 */
<> 128:9bcdf88f62b0 49 class Timer {
<> 128:9bcdf88f62b0 50
<> 128:9bcdf88f62b0 51 public:
<> 128:9bcdf88f62b0 52 Timer();
<> 128:9bcdf88f62b0 53 Timer(const ticker_data_t *data);
<> 128:9bcdf88f62b0 54
<> 128:9bcdf88f62b0 55 /** Start the timer
<> 128:9bcdf88f62b0 56 */
<> 128:9bcdf88f62b0 57 void start();
<> 128:9bcdf88f62b0 58
<> 128:9bcdf88f62b0 59 /** Stop the timer
<> 128:9bcdf88f62b0 60 */
<> 128:9bcdf88f62b0 61 void stop();
<> 128:9bcdf88f62b0 62
<> 128:9bcdf88f62b0 63 /** Reset the timer to 0.
<> 128:9bcdf88f62b0 64 *
<> 128:9bcdf88f62b0 65 * If it was already counting, it will continue
<> 128:9bcdf88f62b0 66 */
<> 128:9bcdf88f62b0 67 void reset();
<> 128:9bcdf88f62b0 68
<> 128:9bcdf88f62b0 69 /** Get the time passed in seconds
AnnaBridge 145:64910690c574 70 *
AnnaBridge 145:64910690c574 71 * @returns Time passed in seconds
<> 128:9bcdf88f62b0 72 */
<> 128:9bcdf88f62b0 73 float read();
<> 128:9bcdf88f62b0 74
AnnaBridge 145:64910690c574 75 /** Get the time passed in milli-seconds
AnnaBridge 145:64910690c574 76 *
AnnaBridge 145:64910690c574 77 * @returns Time passed in milli seconds
<> 128:9bcdf88f62b0 78 */
<> 128:9bcdf88f62b0 79 int read_ms();
<> 128:9bcdf88f62b0 80
<> 128:9bcdf88f62b0 81 /** Get the time passed in micro-seconds
AnnaBridge 145:64910690c574 82 *
AnnaBridge 145:64910690c574 83 * @returns Time passed in micro seconds
<> 128:9bcdf88f62b0 84 */
<> 128:9bcdf88f62b0 85 int read_us();
<> 128:9bcdf88f62b0 86
<> 128:9bcdf88f62b0 87 /** An operator shorthand for read()
<> 128:9bcdf88f62b0 88 */
<> 128:9bcdf88f62b0 89 operator float();
<> 128:9bcdf88f62b0 90
AnnaBridge 145:64910690c574 91 /** Get in a high resolution type the time passed in micro-seconds.
AnnaBridge 145:64910690c574 92 */
AnnaBridge 145:64910690c574 93 us_timestamp_t read_high_resolution_us();
AnnaBridge 145:64910690c574 94
<> 128:9bcdf88f62b0 95 protected:
AnnaBridge 145:64910690c574 96 us_timestamp_t slicetime();
AnnaBridge 145:64910690c574 97 int _running; // whether the timer is running
AnnaBridge 145:64910690c574 98 us_timestamp_t _start; // the start time of the latest slice
AnnaBridge 145:64910690c574 99 us_timestamp_t _time; // any accumulated time from previous slices
<> 128:9bcdf88f62b0 100 const ticker_data_t *_ticker_data;
<> 128:9bcdf88f62b0 101 };
<> 128:9bcdf88f62b0 102
<> 128:9bcdf88f62b0 103 } // namespace mbed
<> 128:9bcdf88f62b0 104
<> 128:9bcdf88f62b0 105 #endif