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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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