Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

Timer.h@44:24d45a770a51, 2012-11-21 (annotated)

Committer:
emilmont
Date:
Wed Nov 21 10:49:56 2012 +0000
Revision:
44:24d45a770a51
Parent:
43:e2ed12d17f06
Child:
54:71b101360fb9
Complete refactoring of the mbed library to move the target dependent code to a thin well defined layer, defining a proper object oriented C API to be implemented by the different silicon vendors.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 44:24d45a770a51 2 * Copyright (c) 2006-2012 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
emilmont 44:24d45a770a51 22 #ifndef MBED_TIMER_H
emilmont 44:24d45a770a51 23 #define MBED_TIMER_H
emilmont 44:24d45a770a51 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 44:24d45a770a51 26
emilmont 44:24d45a770a51 27 namespace mbed {
emilmont 44:24d45a770a51 28
emilmont 44:24d45a770a51 29 /** A general purpose timer
emilmont 44:24d45a770a51 30 *
emilmont 44:24d45a770a51 31 * Example:
emilmont 44:24d45a770a51 32 * @code
emilmont 44:24d45a770a51 33 * // Count the time to toggle a LED
emilmont 44:24d45a770a51 34 *
emilmont 44:24d45a770a51 35 * #include "mbed.h"
emilmont 44:24d45a770a51 36 *
emilmont 44:24d45a770a51 37 * Timer timer;
emilmont 44:24d45a770a51 38 * DigitalOut led(LED1);
emilmont 44:24d45a770a51 39 * int begin, end;
emilmont 44:24d45a770a51 40 *
emilmont 44:24d45a770a51 41 * int main() {
emilmont 44:24d45a770a51 42 * timer.start();
emilmont 44:24d45a770a51 43 * begin = timer.read_us();
emilmont 44:24d45a770a51 44 * led = !led;
emilmont 44:24d45a770a51 45 * end = timer.read_us();
emilmont 44:24d45a770a51 46 * printf("Toggle the led takes %d us", end - begin);
emilmont 44:24d45a770a51 47 * }
emilmont 44:24d45a770a51 48 * @endcode
emilmont 44:24d45a770a51 49 */
emilmont 44:24d45a770a51 50 class Timer {
emilmont 44:24d45a770a51 51
emilmont 44:24d45a770a51 52 public:
emilmont 44:24d45a770a51 53 Timer();
emilmont 44:24d45a770a51 54
emilmont 44:24d45a770a51 55 /** Start the timer
emilmont 44:24d45a770a51 56 */
emilmont 44:24d45a770a51 57 void start();
emilmont 44:24d45a770a51 58
emilmont 44:24d45a770a51 59 /** Stop the timer
emilmont 44:24d45a770a51 60 */
emilmont 44:24d45a770a51 61 void stop();
emilmont 44:24d45a770a51 62
emilmont 44:24d45a770a51 63 /** Reset the timer to 0.
emilmont 44:24d45a770a51 64 *
emilmont 44:24d45a770a51 65 * If it was already counting, it will continue
emilmont 44:24d45a770a51 66 */
emilmont 44:24d45a770a51 67 void reset();
emilmont 44:24d45a770a51 68
emilmont 44:24d45a770a51 69 /** Get the time passed in seconds
emilmont 44:24d45a770a51 70 */
emilmont 44:24d45a770a51 71 float read();
emilmont 44:24d45a770a51 72
emilmont 44:24d45a770a51 73 /** Get the time passed in mili-seconds
emilmont 44:24d45a770a51 74 */
emilmont 44:24d45a770a51 75 int read_ms();
emilmont 44:24d45a770a51 76
emilmont 44:24d45a770a51 77 /** Get the time passed in micro-seconds
emilmont 44:24d45a770a51 78 */
emilmont 44:24d45a770a51 79 int read_us();
emilmont 44:24d45a770a51 80
emilmont 44:24d45a770a51 81 #ifdef MBED_OPERATORS
emilmont 44:24d45a770a51 82 operator float();
emilmont 44:24d45a770a51 83 #endif
emilmont 44:24d45a770a51 84
emilmont 44:24d45a770a51 85 protected:
emilmont 44:24d45a770a51 86 int slicetime();
emilmont 44:24d45a770a51 87 int _running; // whether the timer is running
emilmont 44:24d45a770a51 88 unsigned int _start; // the start time of the latest slice
emilmont 44:24d45a770a51 89 int _time; // any accumulated time from previous slices
emilmont 44:24d45a770a51 90 };
emilmont 44:24d45a770a51 91
emilmont 44:24d45a770a51 92 } // namespace mbed
emilmont 44:24d45a770a51 93
emilmont 44:24d45a770a51 94 #endif