Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/platform/mbed_wait_api.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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