Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

drivers/Timer.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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