Jonathan Piat / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/wait_api.h@563:9f26fcd0c9ce, 2015-06-09 (annotated)

Committer:
mbed_official
Date:
Tue Jun 09 15:30:08 2015 +0100
Revision:
563:9f26fcd0c9ce
Parent:
13:0645d8841f51 
Synchronized with git revision a140fc60a6f74003a3d46c4ce8bf8c742148b9fd



Full URL: https://github.com/mbedmicro/mbed/commit/a140fc60a6f74003a3d46c4ce8bf8c742148b9fd/

Who changed what in which revision?

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