Greg Steiert / maxim_dev

Dependents:   sensomed

platform/wait_api.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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