teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

api/Timer.h@148:4802eb17e82b, 2016-10-17 (annotated)

Committer:
rodriguise
Date:
Mon Oct 17 18:47:01 2016 +0000
Revision:
148:4802eb17e82b
Parent:
144:ef7eb2e8f9f7 
backup

Who changed what in which revision?

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