Umar Naeem / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by Umar Naeem

platform/wait_api.h@149:156823d33999, 2016-10-28 (annotated)

Committer:
<>
Date:
Fri Oct 28 11:17:30 2016 +0100
Revision:
149:156823d33999
Child:
160:d5399cc887bb
This updates the lib to the mbed lib v128



NOTE: This release includes a restructuring of the file and directory locations and thus some

include paths in your code may need updating accordingly.

Who changed what in which revision?

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