Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/wait_api.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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