Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

wait_api.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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