Mateusz Kowalik / Application_danix

,,

Fork of Application by Daniel Sygut

mbed-dev/platform/wait_api.h@10:41552d038a69, 2017-01-10 (annotated)

Committer:
Zaitsev
Date:
Tue Jan 10 20:42:26 2017 +0000
Revision:
10:41552d038a69
USB Serial bi-directional bridge

Who changed what in which revision?

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