takashi kadono / Mbed OS Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/drivers/Timer.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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