Bei Chen Liu / mbed-src

mbed library sources

Fork of mbed-src by mbed official

capi/wait_api.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_WAIT_API_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_WAIT_API_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #ifdef __cplusplus
mbed_official 0:fd0d7bdfcdc2 26 extern "C" {
mbed_official 0:fd0d7bdfcdc2 27 #endif
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 /** Generic wait functions.
mbed_official 0:fd0d7bdfcdc2 30 *
mbed_official 0:fd0d7bdfcdc2 31 * These provide simple NOP type wait capabilities.
mbed_official 0:fd0d7bdfcdc2 32 *
mbed_official 0:fd0d7bdfcdc2 33 * Example:
mbed_official 0:fd0d7bdfcdc2 34 * @code
mbed_official 0:fd0d7bdfcdc2 35 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 36 *
mbed_official 0:fd0d7bdfcdc2 37 * DigitalOut heartbeat(LED1);
mbed_official 0:fd0d7bdfcdc2 38 *
mbed_official 0:fd0d7bdfcdc2 39 * int main() {
mbed_official 0:fd0d7bdfcdc2 40 * while (1) {
mbed_official 0:fd0d7bdfcdc2 41 * heartbeat = 1;
mbed_official 0:fd0d7bdfcdc2 42 * wait(0.5);
mbed_official 0:fd0d7bdfcdc2 43 * heartbeat = 0;
mbed_official 0:fd0d7bdfcdc2 44 * wait(0.5);
mbed_official 0:fd0d7bdfcdc2 45 * }
mbed_official 0:fd0d7bdfcdc2 46 * }
mbed_official 0:fd0d7bdfcdc2 47 */
mbed_official 0:fd0d7bdfcdc2 48
mbed_official 0:fd0d7bdfcdc2 49 /** Waits for a number of seconds, with microsecond resolution (within
mbed_official 0:fd0d7bdfcdc2 50 * the accuracy of single precision floating point).
mbed_official 0:fd0d7bdfcdc2 51 *
mbed_official 0:fd0d7bdfcdc2 52 * @param s number of seconds to wait
mbed_official 0:fd0d7bdfcdc2 53 */
mbed_official 0:fd0d7bdfcdc2 54 void wait(float s);
mbed_official 0:fd0d7bdfcdc2 55
mbed_official 0:fd0d7bdfcdc2 56 /** Waits a number of milliseconds.
mbed_official 0:fd0d7bdfcdc2 57 *
mbed_official 0:fd0d7bdfcdc2 58 * @param ms the whole number of milliseconds to wait
mbed_official 0:fd0d7bdfcdc2 59 */
mbed_official 0:fd0d7bdfcdc2 60 void wait_ms(int ms);
mbed_official 0:fd0d7bdfcdc2 61
mbed_official 0:fd0d7bdfcdc2 62 /** Waits a number of microseconds.
mbed_official 0:fd0d7bdfcdc2 63 *
mbed_official 0:fd0d7bdfcdc2 64 * @param us the whole number of microseconds to wait
mbed_official 0:fd0d7bdfcdc2 65 */
mbed_official 0:fd0d7bdfcdc2 66 void wait_us(int us);
mbed_official 0:fd0d7bdfcdc2 67
mbed_official 0:fd0d7bdfcdc2 68 #ifdef __cplusplus
mbed_official 0:fd0d7bdfcdc2 69 }
mbed_official 0:fd0d7bdfcdc2 70 #endif
mbed_official 0:fd0d7bdfcdc2 71
mbed_official 0:fd0d7bdfcdc2 72 #endif