BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/platform/mbed_wait_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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