Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/platform/mbed_wait_api.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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