Julien Kern / mbed

mbed library

Dependents:   Printf

Fork of mbed by mbed official

wait_api.h@44:24d45a770a51, 2012-11-21 (annotated)

Committer:
emilmont
Date:
Wed Nov 21 10:49:56 2012 +0000
Revision:
44:24d45a770a51
Parent:
43:e2ed12d17f06
Child:
54:71b101360fb9
Complete refactoring of the mbed library to move the target dependent code to a thin well defined layer, defining a proper object oriented C API to be implemented by the different silicon vendors.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 44:24d45a770a51 2 * Copyright (c) 2006-2012 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
emilmont 44:24d45a770a51 22 #ifndef MBED_WAIT_API_H
emilmont 44:24d45a770a51 23 #define MBED_WAIT_API_H
emilmont 44:24d45a770a51 24
emilmont 44:24d45a770a51 25 #ifdef __cplusplus
emilmont 44:24d45a770a51 26 extern "C" {
emilmont 44:24d45a770a51 27 #endif
emilmont 44:24d45a770a51 28
emilmont 43:e2ed12d17f06 29 /** Generic wait functions.
simon 20:029aa53d7323 30 *
simon 20:029aa53d7323 31 * These provide simple NOP type wait capabilities.
simon 20:029aa53d7323 32 *
simon 20:029aa53d7323 33 * Example:
emilmont 43:e2ed12d17f06 34 * @code
emilmont 43:e2ed12d17f06 35 * #include "mbed.h"
emilmont 43:e2ed12d17f06 36 *
emilmont 43:e2ed12d17f06 37 * DigitalOut heartbeat(LED1);
emilmont 43:e2ed12d17f06 38 *
emilmont 43:e2ed12d17f06 39 * int main() {
emilmont 43:e2ed12d17f06 40 * while (1) {
emilmont 43:e2ed12d17f06 41 * heartbeat = 1;
emilmont 43:e2ed12d17f06 42 * wait(0.5);
emilmont 43:e2ed12d17f06 43 * heartbeat = 0;
emilmont 43:e2ed12d17f06 44 * wait(0.5);
emilmont 43:e2ed12d17f06 45 * }
emilmont 43:e2ed12d17f06 46 * }
simon 20:029aa53d7323 47 */
simon 20:029aa53d7323 48
emilmont 43:e2ed12d17f06 49 /** Waits for a number of seconds, with microsecond resolution (within
simon 20:029aa53d7323 50 * the accuracy of single precision floating point).
simon 20:029aa53d7323 51 *
emilmont 43:e2ed12d17f06 52 * @param s number of seconds to wait
simon 20:029aa53d7323 53 */
rolf.meyer@arm.com 11:1c1ebd0324fa 54 void wait(float s);
simon 20:029aa53d7323 55
emilmont 43:e2ed12d17f06 56 /** Waits a number of milliseconds.
simon 20:029aa53d7323 57 *
emilmont 43:e2ed12d17f06 58 * @param ms the whole number of milliseconds to wait
simon 20:029aa53d7323 59 */
rolf.meyer@arm.com 11:1c1ebd0324fa 60 void wait_ms(int ms);
simon 20:029aa53d7323 61
emilmont 43:e2ed12d17f06 62 /** Waits a number of microseconds.
simon 20:029aa53d7323 63 *
emilmont 43:e2ed12d17f06 64 * @param us the whole number of microseconds to wait
simon 20:029aa53d7323 65 */
rolf.meyer@arm.com 11:1c1ebd0324fa 66 void wait_us(int us);
rolf.meyer@arm.com 11:1c1ebd0324fa 67
rolf.meyer@arm.com 11:1c1ebd0324fa 68 #ifdef __cplusplus
rolf.meyer@arm.com 11:1c1ebd0324fa 69 }
rolf.meyer@arm.com 11:1c1ebd0324fa 70 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 71
rolf.meyer@arm.com 11:1c1ebd0324fa 72 #endif