wait_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_WAIT_API_H
00023 #define MBED_WAIT_API_H
00024 
00025 #ifdef __cplusplus
00026 extern "C" {
00027 #endif
00028 
00029 /** Generic wait functions.
00030  *
00031  * These provide simple NOP type wait capabilities.
00032  *
00033  * Example:
00034  * @code
00035  * #include "mbed.h"
00036  *
00037  * DigitalOut heartbeat(LED1);
00038  *
00039  * int main() {
00040  *     while (1) {
00041  *         heartbeat = 1;
00042  *         wait(0.5);
00043  *         heartbeat = 0;
00044  *         wait(0.5);
00045  *     }
00046  * }
00047  */
00048 
00049 /** Waits for a number of seconds, with microsecond resolution (within
00050  *  the accuracy of single precision floating point).
00051  *
00052  *  @param s number of seconds to wait
00053  */
00054 void wait(float s);
00055 
00056 /** Waits a number of milliseconds.
00057  *
00058  *  @param ms the whole number of milliseconds to wait
00059  */
00060 void wait_ms(int ms);
00061 
00062 /** Waits a number of microseconds.
00063  *
00064  *  @param us the whole number of microseconds to wait
00065  */
00066 void wait_us(int us);
00067 
00068 #ifdef __cplusplus
00069 }
00070 #endif
00071 
00072 #endif
00073