EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

drivers/Timer.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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