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@152:235179ab3f27, 2017-10-02 (annotated)

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