Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/Timer.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

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