Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/wait_api.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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