Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/Timer.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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