Tux Leon / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

drivers/Timer.h@168:9672193075cf, 2017-07-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Jul 06 15:42:05 2017 +0100
Revision:
168:9672193075cf
Parent:
167:e84263d55307
Child:
174:b96e65c34a4d
This updates the lib to the mbed lib v 146

Who changed what in which revision?

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