Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

platform/wait_api.h@1:3deb71413561, 2017-07-20 (annotated)

Committer:
xuaner
Date:
Thu Jul 20 14:26:57 2017 +0000
Revision:
1:3deb71413561
Parent:
0:f269e3021894 
mbed_os

Who changed what in which revision?

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