long dao / mbed-src

Mbed for VNG board

Fork of mbed-src by mbed official

capi/wait_api.h@2:143cac498751, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 11:44:18 2013 +0000
Revision:
2:143cac498751
Parent:
0:fd0d7bdfcdc2 
Update mbed sources to Rev 59

Who changed what in which revision?

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