mbed SDK library sources

Fork of mbed-src by mbed official

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

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