Kev Mann / mbed-dev-OS5_10_4

RTC auf true

platform/mbed_wait_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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