Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/Timer.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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