mbed library sources
Dependents: frdm_kl05z_gpio_test
Fork of mbed-src by
capi/wait_api.h
- Committer:
- mbed_official
- Date:
- 2012-11-20
- Revision:
- 0:fd0d7bdfcdc2
- Child:
- 2:143cac498751
File content as of revision 0:fd0d7bdfcdc2:
/* mbed Microcontroller Library * Copyright (c) 2006-2012 ARM Limited * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ #ifndef MBED_WAIT_API_H #define MBED_WAIT_API_H #ifdef __cplusplus extern "C" { #endif /** Generic wait functions. * * These provide simple NOP type wait capabilities. * * Example: * @code * #include "mbed.h" * * DigitalOut heartbeat(LED1); * * int main() { * while (1) { * heartbeat = 1; * wait(0.5); * heartbeat = 0; * wait(0.5); * } * } */ /** Waits for a number of seconds, with microsecond resolution (within * the accuracy of single precision floating point). * * @param s number of seconds to wait */ void wait(float s); /** Waits a number of milliseconds. * * @param ms the whole number of milliseconds to wait */ void wait_ms(int ms); /** Waits a number of microseconds. * * @param us the whole number of microseconds to wait */ void wait_us(int us); #ifdef __cplusplus } #endif #endif