initial

Dependencies:   mbed

Committer:
yihui
Date:
Mon Jan 11 02:32:24 2016 +0000
Revision:
0:638edba3adf6
initial

Who changed what in which revision?

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