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