Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/drivers/Timer.h@11:b3f2a8bdac4d, 2017-12-16 (annotated)

Committer:
Zaitsev
Date:
Sat Dec 16 10:26:48 2017 +0000
Revision:
11:b3f2a8bdac4d
Parent:
10:41552d038a69 
A copy for D.S;

Who changed what in which revision?

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