Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/wait_api.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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