zhang boie / mbed-dev-f30333

drivers/Timer.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

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