Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

platform/mbed_wait_api.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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