Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/Timer.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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