teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

api/wait_api.h@148:4802eb17e82b, 2016-10-17 (annotated)

Committer:
rodriguise
Date:
Mon Oct 17 18:47:01 2016 +0000
Revision:
148:4802eb17e82b
Parent:
144:ef7eb2e8f9f7 
backup

Who changed what in which revision?

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