ju Lei / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

wait_api.h@64:75c1708b266b, 2013-07-05 (annotated)

Committer:
ldyz
Date:
Fri Jul 05 13:16:13 2013 +0000
Revision:
64:75c1708b266b
Parent:
59:0883845fe643 
test

Who changed what in which revision?

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