diff options
| author | Yann Herklotz <ymherklotz@gmail.com> | 2017-05-10 13:17:31 +0100 |
|---|---|---|
| committer | Yann Herklotz <ymherklotz@gmail.com> | 2017-05-10 13:17:31 +0100 |
| commit | aa30a51f3e2d9120aa819c1bc8162793662ccf32 (patch) | |
| tree | e7659204b1ecf3f65fae106c12b096fd552c2d8d /mbed/drivers/Timer.h | |
| download | WaveGenerator-aa30a51f3e2d9120aa819c1bc8162793662ccf32.tar.gz WaveGenerator-aa30a51f3e2d9120aa819c1bc8162793662ccf32.zip | |
Adding initial files
Diffstat (limited to 'mbed/drivers/Timer.h')
| -rw-r--r-- | mbed/drivers/Timer.h | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/mbed/drivers/Timer.h b/mbed/drivers/Timer.h new file mode 100644 index 0000000..4a1c312 --- /dev/null +++ b/mbed/drivers/Timer.h @@ -0,0 +1,97 @@ +/* mbed Microcontroller Library
+ * Copyright (c) 2006-2013 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef MBED_TIMER_H
+#define MBED_TIMER_H
+
+#include "platform/platform.h"
+#include "hal/ticker_api.h"
+
+namespace mbed {
+/** \addtogroup drivers */
+/** @{*/
+
+/** A general purpose timer
+ *
+ * @Note Synchronization level: Interrupt safe
+ *
+ * Example:
+ * @code
+ * // Count the time to toggle a LED
+ *
+ * #include "mbed.h"
+ *
+ * Timer timer;
+ * DigitalOut led(LED1);
+ * int begin, end;
+ *
+ * int main() {
+ * timer.start();
+ * begin = timer.read_us();
+ * led = !led;
+ * end = timer.read_us();
+ * printf("Toggle the led takes %d us", end - begin);
+ * }
+ * @endcode
+ */
+class Timer {
+
+public:
+ Timer();
+ Timer(const ticker_data_t *data);
+
+ /** Start the timer
+ */
+ void start();
+
+ /** Stop the timer
+ */
+ void stop();
+
+ /** Reset the timer to 0.
+ *
+ * If it was already counting, it will continue
+ */
+ void reset();
+
+ /** Get the time passed in seconds
+ */
+ float read();
+
+ /** Get the time passed in mili-seconds
+ */
+ int read_ms();
+
+ /** Get the time passed in micro-seconds
+ */
+ int read_us();
+
+ /** An operator shorthand for read()
+ */
+ operator float();
+
+protected:
+ int slicetime();
+ int _running; // whether the timer is running
+ unsigned int _start; // the start time of the latest slice
+ int _time; // any accumulated time from previous slices
+ const ticker_data_t *_ticker_data;
+};
+
+} // namespace mbed
+
+#endif
+
+/** @}*/
|