Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

platform/mbed_wait_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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