Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

Timer.h@27:7110ebee3484, 2011-11-29 (annotated)

Committer:
emilmont
Date:
Tue Nov 29 14:59:27 2011 +0000
Revision:
27:7110ebee3484
Parent:
11:1c1ebd0324fa
Child:
43:aff670d0d510
New Libraries 11.11

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rolf.meyer@arm.com 11:1c1ebd0324fa 1 /* mbed Microcontroller Library - Timer
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
rolf.meyer@arm.com 11:1c1ebd0324fa 5 #ifndef MBED_TIMER_H
rolf.meyer@arm.com 11:1c1ebd0324fa 6 #define MBED_TIMER_H
rolf.meyer@arm.com 11:1c1ebd0324fa 7
rolf.meyer@arm.com 11:1c1ebd0324fa 8 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PeripheralNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 11 #include "Base.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 12
rolf.meyer@arm.com 11:1c1ebd0324fa 13 namespace mbed {
rolf.meyer@arm.com 11:1c1ebd0324fa 14
rolf.meyer@arm.com 11:1c1ebd0324fa 15 /* Class: Timer
rolf.meyer@arm.com 11:1c1ebd0324fa 16 * A general purpose timer
rolf.meyer@arm.com 11:1c1ebd0324fa 17 *
rolf.meyer@arm.com 11:1c1ebd0324fa 18 * Example:
rolf.meyer@arm.com 11:1c1ebd0324fa 19 * > // Count the time to toggle a LED
rolf.meyer@arm.com 11:1c1ebd0324fa 20 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 21 * > #include "mbed.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 22 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 23 * > Timer timer;
rolf.meyer@arm.com 11:1c1ebd0324fa 24 * > DigitalOut led(LED1);
rolf.meyer@arm.com 11:1c1ebd0324fa 25 * > int begin, end;
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * >
rolf.meyer@arm.com 11:1c1ebd0324fa 27 * > int main() {
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * > timer.start();
rolf.meyer@arm.com 11:1c1ebd0324fa 29 * > begin = timer.read_us();
rolf.meyer@arm.com 11:1c1ebd0324fa 30 * > led = !led;
rolf.meyer@arm.com 11:1c1ebd0324fa 31 * > end = timer.read_us();
rolf.meyer@arm.com 11:1c1ebd0324fa 32 * > printf("Toggle the led takes %d us", end - begin);
rolf.meyer@arm.com 11:1c1ebd0324fa 33 * > }
rolf.meyer@arm.com 11:1c1ebd0324fa 34 */
rolf.meyer@arm.com 11:1c1ebd0324fa 35 class Timer : public Base {
rolf.meyer@arm.com 11:1c1ebd0324fa 36
rolf.meyer@arm.com 11:1c1ebd0324fa 37 public:
rolf.meyer@arm.com 11:1c1ebd0324fa 38
rolf.meyer@arm.com 11:1c1ebd0324fa 39 Timer(const char *name = NULL);
rolf.meyer@arm.com 11:1c1ebd0324fa 40
rolf.meyer@arm.com 11:1c1ebd0324fa 41 /* Function: start
rolf.meyer@arm.com 11:1c1ebd0324fa 42 * Start the timer
rolf.meyer@arm.com 11:1c1ebd0324fa 43 */
rolf.meyer@arm.com 11:1c1ebd0324fa 44 void start();
rolf.meyer@arm.com 11:1c1ebd0324fa 45
rolf.meyer@arm.com 11:1c1ebd0324fa 46 /* Function: stop
rolf.meyer@arm.com 11:1c1ebd0324fa 47 * Stop the timer
rolf.meyer@arm.com 11:1c1ebd0324fa 48 */
rolf.meyer@arm.com 11:1c1ebd0324fa 49 void stop();
rolf.meyer@arm.com 11:1c1ebd0324fa 50
rolf.meyer@arm.com 11:1c1ebd0324fa 51 /* Function: reset
rolf.meyer@arm.com 11:1c1ebd0324fa 52 * Reset the timer to 0.
rolf.meyer@arm.com 11:1c1ebd0324fa 53 *
rolf.meyer@arm.com 11:1c1ebd0324fa 54 * If it was already counting, it will continue
rolf.meyer@arm.com 11:1c1ebd0324fa 55 */
rolf.meyer@arm.com 11:1c1ebd0324fa 56 void reset();
rolf.meyer@arm.com 11:1c1ebd0324fa 57
rolf.meyer@arm.com 11:1c1ebd0324fa 58 /* Function: read
rolf.meyer@arm.com 11:1c1ebd0324fa 59 * Get the time passed in seconds
rolf.meyer@arm.com 11:1c1ebd0324fa 60 */
rolf.meyer@arm.com 11:1c1ebd0324fa 61 float read();
rolf.meyer@arm.com 11:1c1ebd0324fa 62
rolf.meyer@arm.com 11:1c1ebd0324fa 63 /* Function: read_ms
rolf.meyer@arm.com 11:1c1ebd0324fa 64 * Get the time passed in mili-seconds
rolf.meyer@arm.com 11:1c1ebd0324fa 65 */
rolf.meyer@arm.com 11:1c1ebd0324fa 66 int read_ms();
rolf.meyer@arm.com 11:1c1ebd0324fa 67
rolf.meyer@arm.com 11:1c1ebd0324fa 68 /* Function: read_us
rolf.meyer@arm.com 11:1c1ebd0324fa 69 * Get the time passed in micro-seconds
rolf.meyer@arm.com 11:1c1ebd0324fa 70 */
rolf.meyer@arm.com 11:1c1ebd0324fa 71 int read_us();
rolf.meyer@arm.com 11:1c1ebd0324fa 72
rolf.meyer@arm.com 11:1c1ebd0324fa 73 #ifdef MBED_OPERATORS
rolf.meyer@arm.com 11:1c1ebd0324fa 74 operator float();
rolf.meyer@arm.com 11:1c1ebd0324fa 75 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 76
rolf.meyer@arm.com 11:1c1ebd0324fa 77 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 78 virtual const struct rpc_method *get_rpc_methods();
rolf.meyer@arm.com 11:1c1ebd0324fa 79 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 80 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 81
rolf.meyer@arm.com 11:1c1ebd0324fa 82 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 83
rolf.meyer@arm.com 11:1c1ebd0324fa 84 int slicetime();
rolf.meyer@arm.com 11:1c1ebd0324fa 85 int _running; // whether the timer is running
rolf.meyer@arm.com 11:1c1ebd0324fa 86 unsigned int _start; // the start time of the latest slice
rolf.meyer@arm.com 11:1c1ebd0324fa 87 int _time; // any accumulated time from previous slices
rolf.meyer@arm.com 11:1c1ebd0324fa 88
rolf.meyer@arm.com 11:1c1ebd0324fa 89 };
rolf.meyer@arm.com 11:1c1ebd0324fa 90
rolf.meyer@arm.com 11:1c1ebd0324fa 91 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 92
rolf.meyer@arm.com 11:1c1ebd0324fa 93 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 94