Thor Hall / mbed-dev_mbed_lib_v125

This fork captures the mbed lib v125 for ease of integration into older projects.

Fork of mbed-dev by mbed official

api/wait_api.h@187:92cbb9eec47b, 2018-07-20 (annotated)

Committer:
apluscw
Date:
Fri Jul 20 21:24:42 2018 +0000
Revision:
187:92cbb9eec47b
Mbed library with source code from mbed lib v125. Posted to ease integration with some older projects.

Who changed what in which revision?

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