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@11:1c1ebd0324fa, 2009-08-28 (annotated)

Committer:
rolf.meyer@arm.com
Date:
Fri Aug 28 12:10:11 2009 +0000
Revision:
11:1c1ebd0324fa
Parent:
5:62573be585e9
Child:
27:7110ebee3484
A shiny new version

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