Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/Timer.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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