modtronix H / mbed_nz32sc151

mbed library for NZ32-SC151

api/wait_api.h@17:639ed60ce759, 2016-08-19 (annotated)

Committer:
modtronix-com
Date:
Fri Aug 19 15:46:42 2016 +1000
Revision:
17:639ed60ce759
Parent:
1:71204b8406f2 
Added tag v1.1 for changeset 076cbe3e55be

Who changed what in which revision?

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