Frank 26080115
These are the examples provided for [[/users/frank26080115/libraries/LPC1700CMSIS_Lib/]] Note, the entire "program" is not compilable!
EMAC/uIP/uip/clock.h@0:bf7b9fba3924, 2011-03-20 (annotated)
- Committer:
- frank26080115
- Date:
- Sun Mar 20 05:38:56 2011 +0000
- Revision:
- 0:bf7b9fba3924
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| frank26080115 | 0:bf7b9fba3924 | 1 | /** @addtogroup EMAC_uIP |
| frank26080115 | 0:bf7b9fba3924 | 2 | * @{ |
| frank26080115 | 0:bf7b9fba3924 | 3 | */ |
| frank26080115 | 0:bf7b9fba3924 | 4 | |
| frank26080115 | 0:bf7b9fba3924 | 5 | /** |
| frank26080115 | 0:bf7b9fba3924 | 6 | * \defgroup clock Clock interface |
| frank26080115 | 0:bf7b9fba3924 | 7 | * |
| frank26080115 | 0:bf7b9fba3924 | 8 | * The clock interface is the interface between the \ref timer "timer library" |
| frank26080115 | 0:bf7b9fba3924 | 9 | * and the platform specific clock functionality. The clock |
| frank26080115 | 0:bf7b9fba3924 | 10 | * interface must be implemented for each platform that uses the \ref |
| frank26080115 | 0:bf7b9fba3924 | 11 | * timer "timer library". |
| frank26080115 | 0:bf7b9fba3924 | 12 | * |
| frank26080115 | 0:bf7b9fba3924 | 13 | * The clock interface does only one this: it measures time. The clock |
| frank26080115 | 0:bf7b9fba3924 | 14 | * interface provides a macro, CLOCK_SECOND, which corresponds to one |
| frank26080115 | 0:bf7b9fba3924 | 15 | * second of system time. |
| frank26080115 | 0:bf7b9fba3924 | 16 | * |
| frank26080115 | 0:bf7b9fba3924 | 17 | * \sa \ref timer "Timer library" |
| frank26080115 | 0:bf7b9fba3924 | 18 | * |
| frank26080115 | 0:bf7b9fba3924 | 19 | * @{ |
| frank26080115 | 0:bf7b9fba3924 | 20 | */ |
| frank26080115 | 0:bf7b9fba3924 | 21 | |
| frank26080115 | 0:bf7b9fba3924 | 22 | /* |
| frank26080115 | 0:bf7b9fba3924 | 23 | * Copyright (c) 2004, Swedish Institute of Computer Science. |
| frank26080115 | 0:bf7b9fba3924 | 24 | * All rights reserved. |
| frank26080115 | 0:bf7b9fba3924 | 25 | * |
| frank26080115 | 0:bf7b9fba3924 | 26 | * Redistribution and use in source and binary forms, with or without |
| frank26080115 | 0:bf7b9fba3924 | 27 | * modification, are permitted provided that the following conditions |
| frank26080115 | 0:bf7b9fba3924 | 28 | * are met: |
| frank26080115 | 0:bf7b9fba3924 | 29 | * 1. Redistributions of source code must retain the above copyright |
| frank26080115 | 0:bf7b9fba3924 | 30 | * notice, this list of conditions and the following disclaimer. |
| frank26080115 | 0:bf7b9fba3924 | 31 | * 2. Redistributions in binary form must reproduce the above copyright |
| frank26080115 | 0:bf7b9fba3924 | 32 | * notice, this list of conditions and the following disclaimer in the |
| frank26080115 | 0:bf7b9fba3924 | 33 | * documentation and/or other materials provided with the distribution. |
| frank26080115 | 0:bf7b9fba3924 | 34 | * 3. Neither the name of the Institute nor the names of its contributors |
| frank26080115 | 0:bf7b9fba3924 | 35 | * may be used to endorse or promote products derived from this software |
| frank26080115 | 0:bf7b9fba3924 | 36 | * without specific prior written permission. |
| frank26080115 | 0:bf7b9fba3924 | 37 | * |
| frank26080115 | 0:bf7b9fba3924 | 38 | * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND |
| frank26080115 | 0:bf7b9fba3924 | 39 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| frank26080115 | 0:bf7b9fba3924 | 40 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| frank26080115 | 0:bf7b9fba3924 | 41 | * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE |
| frank26080115 | 0:bf7b9fba3924 | 42 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| frank26080115 | 0:bf7b9fba3924 | 43 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| frank26080115 | 0:bf7b9fba3924 | 44 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| frank26080115 | 0:bf7b9fba3924 | 45 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| frank26080115 | 0:bf7b9fba3924 | 46 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| frank26080115 | 0:bf7b9fba3924 | 47 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| frank26080115 | 0:bf7b9fba3924 | 48 | * SUCH DAMAGE. |
| frank26080115 | 0:bf7b9fba3924 | 49 | * |
| frank26080115 | 0:bf7b9fba3924 | 50 | * This file is part of the uIP TCP/IP stack |
| frank26080115 | 0:bf7b9fba3924 | 51 | * |
| frank26080115 | 0:bf7b9fba3924 | 52 | * Author: Adam Dunkels <adam@sics.se> |
| frank26080115 | 0:bf7b9fba3924 | 53 | * |
| frank26080115 | 0:bf7b9fba3924 | 54 | * $Id: clock.h,v 1.3 2006/06/11 21:46:39 adam Exp $ |
| frank26080115 | 0:bf7b9fba3924 | 55 | */ |
| frank26080115 | 0:bf7b9fba3924 | 56 | #ifndef __CLOCK_H__ |
| frank26080115 | 0:bf7b9fba3924 | 57 | #define __CLOCK_H__ |
| frank26080115 | 0:bf7b9fba3924 | 58 | |
| frank26080115 | 0:bf7b9fba3924 | 59 | #include "clock-arch.h" |
| frank26080115 | 0:bf7b9fba3924 | 60 | |
| frank26080115 | 0:bf7b9fba3924 | 61 | /** |
| frank26080115 | 0:bf7b9fba3924 | 62 | * Initialize the clock library. |
| frank26080115 | 0:bf7b9fba3924 | 63 | * |
| frank26080115 | 0:bf7b9fba3924 | 64 | * This function initializes the clock library and should be called |
| frank26080115 | 0:bf7b9fba3924 | 65 | * from the main() function of the system. |
| frank26080115 | 0:bf7b9fba3924 | 66 | * |
| frank26080115 | 0:bf7b9fba3924 | 67 | */ |
| frank26080115 | 0:bf7b9fba3924 | 68 | void clock_init(void); |
| frank26080115 | 0:bf7b9fba3924 | 69 | |
| frank26080115 | 0:bf7b9fba3924 | 70 | /** |
| frank26080115 | 0:bf7b9fba3924 | 71 | * Get the current clock time. |
| frank26080115 | 0:bf7b9fba3924 | 72 | * |
| frank26080115 | 0:bf7b9fba3924 | 73 | * This function returns the current system clock time. |
| frank26080115 | 0:bf7b9fba3924 | 74 | * |
| frank26080115 | 0:bf7b9fba3924 | 75 | * \return The current clock time, measured in system ticks. |
| frank26080115 | 0:bf7b9fba3924 | 76 | */ |
| frank26080115 | 0:bf7b9fba3924 | 77 | clock_time_t clock_time(void); |
| frank26080115 | 0:bf7b9fba3924 | 78 | |
| frank26080115 | 0:bf7b9fba3924 | 79 | /** |
| frank26080115 | 0:bf7b9fba3924 | 80 | * A second, measured in system clock time. |
| frank26080115 | 0:bf7b9fba3924 | 81 | * |
| frank26080115 | 0:bf7b9fba3924 | 82 | * \hideinitializer |
| frank26080115 | 0:bf7b9fba3924 | 83 | */ |
| frank26080115 | 0:bf7b9fba3924 | 84 | #ifdef CLOCK_CONF_SECOND |
| frank26080115 | 0:bf7b9fba3924 | 85 | #define CLOCK_SECOND CLOCK_CONF_SECOND |
| frank26080115 | 0:bf7b9fba3924 | 86 | #else |
| frank26080115 | 0:bf7b9fba3924 | 87 | #define CLOCK_SECOND (clock_time_t)32 |
| frank26080115 | 0:bf7b9fba3924 | 88 | #endif |
| frank26080115 | 0:bf7b9fba3924 | 89 | |
| frank26080115 | 0:bf7b9fba3924 | 90 | #endif /* __CLOCK_H__ */ |
| frank26080115 | 0:bf7b9fba3924 | 91 | |
| frank26080115 | 0:bf7b9fba3924 | 92 | /** @} */ |
| frank26080115 | 0:bf7b9fba3924 | 93 | /** @} */ |