Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

platform/wait_api.h@0:5c4d7b2438d3, 2016-11-11 (annotated)

Committer:
switches
Date:
Fri Nov 11 20:59:50 2016 +0000
Revision:
0:5c4d7b2438d3
Initial commit

Who changed what in which revision?

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