Gan likun / mbed-dev

00

platform/mbed_wait_api.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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