Gan likun / mbed-dev

00

drivers/Timer.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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