TUKS MCU Introductory course / TUKS-COURSE-TIMER

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-dev/drivers/Timer.h@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elmot 1:d0dfbce63a89 1 /* mbed Microcontroller Library
elmot 1:d0dfbce63a89 2 * Copyright (c) 2006-2013 ARM Limited
elmot 1:d0dfbce63a89 3 *
elmot 1:d0dfbce63a89 4 * Licensed under the Apache License, Version 2.0 (the "License");
elmot 1:d0dfbce63a89 5 * you may not use this file except in compliance with the License.
elmot 1:d0dfbce63a89 6 * You may obtain a copy of the License at
elmot 1:d0dfbce63a89 7 *
elmot 1:d0dfbce63a89 8 * http://www.apache.org/licenses/LICENSE-2.0
elmot 1:d0dfbce63a89 9 *
elmot 1:d0dfbce63a89 10 * Unless required by applicable law or agreed to in writing, software
elmot 1:d0dfbce63a89 11 * distributed under the License is distributed on an "AS IS" BASIS,
elmot 1:d0dfbce63a89 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elmot 1:d0dfbce63a89 13 * See the License for the specific language governing permissions and
elmot 1:d0dfbce63a89 14 * limitations under the License.
elmot 1:d0dfbce63a89 15 */
elmot 1:d0dfbce63a89 16 #ifndef MBED_TIMER_H
elmot 1:d0dfbce63a89 17 #define MBED_TIMER_H
elmot 1:d0dfbce63a89 18
elmot 1:d0dfbce63a89 19 #include "platform/platform.h"
elmot 1:d0dfbce63a89 20 #include "hal/ticker_api.h"
elmot 1:d0dfbce63a89 21
elmot 1:d0dfbce63a89 22 namespace mbed {
elmot 1:d0dfbce63a89 23 /** \addtogroup drivers */
elmot 1:d0dfbce63a89 24 /** @{*/
elmot 1:d0dfbce63a89 25
elmot 1:d0dfbce63a89 26 /** A general purpose timer
elmot 1:d0dfbce63a89 27 *
elmot 1:d0dfbce63a89 28 * @Note Synchronization level: Interrupt safe
elmot 1:d0dfbce63a89 29 *
elmot 1:d0dfbce63a89 30 * Example:
elmot 1:d0dfbce63a89 31 * @code
elmot 1:d0dfbce63a89 32 * // Count the time to toggle a LED
elmot 1:d0dfbce63a89 33 *
elmot 1:d0dfbce63a89 34 * #include "mbed.h"
elmot 1:d0dfbce63a89 35 *
elmot 1:d0dfbce63a89 36 * Timer timer;
elmot 1:d0dfbce63a89 37 * DigitalOut led(LED1);
elmot 1:d0dfbce63a89 38 * int begin, end;
elmot 1:d0dfbce63a89 39 *
elmot 1:d0dfbce63a89 40 * int main() {
elmot 1:d0dfbce63a89 41 * timer.start();
elmot 1:d0dfbce63a89 42 * begin = timer.read_us();
elmot 1:d0dfbce63a89 43 * led = !led;
elmot 1:d0dfbce63a89 44 * end = timer.read_us();
elmot 1:d0dfbce63a89 45 * printf("Toggle the led takes %d us", end - begin);
elmot 1:d0dfbce63a89 46 * }
elmot 1:d0dfbce63a89 47 * @endcode
elmot 1:d0dfbce63a89 48 */
elmot 1:d0dfbce63a89 49 class Timer {
elmot 1:d0dfbce63a89 50
elmot 1:d0dfbce63a89 51 public:
elmot 1:d0dfbce63a89 52 Timer();
elmot 1:d0dfbce63a89 53 Timer(const ticker_data_t *data);
elmot 1:d0dfbce63a89 54
elmot 1:d0dfbce63a89 55 /** Start the timer
elmot 1:d0dfbce63a89 56 */
elmot 1:d0dfbce63a89 57 void start();
elmot 1:d0dfbce63a89 58
elmot 1:d0dfbce63a89 59 /** Stop the timer
elmot 1:d0dfbce63a89 60 */
elmot 1:d0dfbce63a89 61 void stop();
elmot 1:d0dfbce63a89 62
elmot 1:d0dfbce63a89 63 /** Reset the timer to 0.
elmot 1:d0dfbce63a89 64 *
elmot 1:d0dfbce63a89 65 * If it was already counting, it will continue
elmot 1:d0dfbce63a89 66 */
elmot 1:d0dfbce63a89 67 void reset();
elmot 1:d0dfbce63a89 68
elmot 1:d0dfbce63a89 69 /** Get the time passed in seconds
elmot 1:d0dfbce63a89 70 */
elmot 1:d0dfbce63a89 71 float read();
elmot 1:d0dfbce63a89 72
elmot 1:d0dfbce63a89 73 /** Get the time passed in mili-seconds
elmot 1:d0dfbce63a89 74 */
elmot 1:d0dfbce63a89 75 int read_ms();
elmot 1:d0dfbce63a89 76
elmot 1:d0dfbce63a89 77 /** Get the time passed in micro-seconds
elmot 1:d0dfbce63a89 78 */
elmot 1:d0dfbce63a89 79 int read_us();
elmot 1:d0dfbce63a89 80
elmot 1:d0dfbce63a89 81 /** An operator shorthand for read()
elmot 1:d0dfbce63a89 82 */
elmot 1:d0dfbce63a89 83 operator float();
elmot 1:d0dfbce63a89 84
elmot 1:d0dfbce63a89 85 protected:
elmot 1:d0dfbce63a89 86 int slicetime();
elmot 1:d0dfbce63a89 87 int _running; // whether the timer is running
elmot 1:d0dfbce63a89 88 unsigned int _start; // the start time of the latest slice
elmot 1:d0dfbce63a89 89 int _time; // any accumulated time from previous slices
elmot 1:d0dfbce63a89 90 const ticker_data_t *_ticker_data;
elmot 1:d0dfbce63a89 91 };
elmot 1:d0dfbce63a89 92
elmot 1:d0dfbce63a89 93 } // namespace mbed
elmot 1:d0dfbce63a89 94
elmot 1:d0dfbce63a89 95 #endif
elmot 1:d0dfbce63a89 96
elmot 1:d0dfbce63a89 97 /** @}*/