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@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

Who changed what in which revision?

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