Ermanno Brusadin / mbed-src

mbed library sources

api/wait_api.h@0:0a673c671a56, 2016-07-27 (annotated)

Committer:
ebrus
Date:
Wed Jul 27 18:35:32 2016 +0000
Revision:
0:0a673c671a56
4

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ebrus 0:0a673c671a56 1 /* mbed Microcontroller Library
ebrus 0:0a673c671a56 2 * Copyright (c) 2006-2013 ARM Limited
ebrus 0:0a673c671a56 3 *
ebrus 0:0a673c671a56 4 * Licensed under the Apache License, Version 2.0 (the "License");
ebrus 0:0a673c671a56 5 * you may not use this file except in compliance with the License.
ebrus 0:0a673c671a56 6 * You may obtain a copy of the License at
ebrus 0:0a673c671a56 7 *
ebrus 0:0a673c671a56 8 * http://www.apache.org/licenses/LICENSE-2.0
ebrus 0:0a673c671a56 9 *
ebrus 0:0a673c671a56 10 * Unless required by applicable law or agreed to in writing, software
ebrus 0:0a673c671a56 11 * distributed under the License is distributed on an "AS IS" BASIS,
ebrus 0:0a673c671a56 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ebrus 0:0a673c671a56 13 * See the License for the specific language governing permissions and
ebrus 0:0a673c671a56 14 * limitations under the License.
ebrus 0:0a673c671a56 15 */
ebrus 0:0a673c671a56 16 #ifndef MBED_WAIT_API_H
ebrus 0:0a673c671a56 17 #define MBED_WAIT_API_H
ebrus 0:0a673c671a56 18
ebrus 0:0a673c671a56 19 #ifdef __cplusplus
ebrus 0:0a673c671a56 20 extern "C" {
ebrus 0:0a673c671a56 21 #endif
ebrus 0:0a673c671a56 22
ebrus 0:0a673c671a56 23 /** Generic wait functions.
ebrus 0:0a673c671a56 24 *
ebrus 0:0a673c671a56 25 * These provide simple NOP type wait capabilities.
ebrus 0:0a673c671a56 26 *
ebrus 0:0a673c671a56 27 * Example:
ebrus 0:0a673c671a56 28 * @code
ebrus 0:0a673c671a56 29 * #include "mbed.h"
ebrus 0:0a673c671a56 30 *
ebrus 0:0a673c671a56 31 * DigitalOut heartbeat(LED1);
ebrus 0:0a673c671a56 32 *
ebrus 0:0a673c671a56 33 * int main() {
ebrus 0:0a673c671a56 34 * while (1) {
ebrus 0:0a673c671a56 35 * heartbeat = 1;
ebrus 0:0a673c671a56 36 * wait(0.5);
ebrus 0:0a673c671a56 37 * heartbeat = 0;
ebrus 0:0a673c671a56 38 * wait(0.5);
ebrus 0:0a673c671a56 39 * }
ebrus 0:0a673c671a56 40 * }
ebrus 0:0a673c671a56 41 */
ebrus 0:0a673c671a56 42
ebrus 0:0a673c671a56 43 /** Waits for a number of seconds, with microsecond resolution (within
ebrus 0:0a673c671a56 44 * the accuracy of single precision floating point).
ebrus 0:0a673c671a56 45 *
ebrus 0:0a673c671a56 46 * @param s number of seconds to wait
ebrus 0:0a673c671a56 47 */
ebrus 0:0a673c671a56 48 void wait(float s);
ebrus 0:0a673c671a56 49
ebrus 0:0a673c671a56 50 /** Waits a number of milliseconds.
ebrus 0:0a673c671a56 51 *
ebrus 0:0a673c671a56 52 * @param ms the whole number of milliseconds to wait
ebrus 0:0a673c671a56 53 */
ebrus 0:0a673c671a56 54 void wait_ms(int ms);
ebrus 0:0a673c671a56 55
ebrus 0:0a673c671a56 56 /** Waits a number of microseconds.
ebrus 0:0a673c671a56 57 *
ebrus 0:0a673c671a56 58 * @param us the whole number of microseconds to wait
ebrus 0:0a673c671a56 59 */
ebrus 0:0a673c671a56 60 void wait_us(int us);
ebrus 0:0a673c671a56 61
ebrus 0:0a673c671a56 62 #ifdef __cplusplus
ebrus 0:0a673c671a56 63 }
ebrus 0:0a673c671a56 64 #endif
ebrus 0:0a673c671a56 65
ebrus 0:0a673c671a56 66 #endif