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