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