mbed OS5
Fork of UIPEthernet by
Embed:
(wiki syntax)
Show/hide line numbers
uip_clock.h
00001 /** 00002 * \defgroup clock Clock interface 00003 * 00004 * The clock interface is the interface between the \ref timer "timer library" 00005 * and the platform specific clock functionality. The clock 00006 * interface must be implemented for each platform that uses the \ref 00007 * timer "timer library". 00008 * 00009 * The clock interface does only one this: it measures time. The clock 00010 * interface provides a macro, CLOCK_SECOND, which corresponds to one 00011 * second of system time. 00012 * 00013 * \sa \ref timer "Timer library" 00014 * 00015 * @{ 00016 */ 00017 /* 00018 * Copyright (c) 2004, Swedish Institute of Computer Science. 00019 * All rights reserved. 00020 * 00021 * Redistribution and use in source and binary forms, with or without 00022 * modification, are permitted provided that the following conditions 00023 * are met: 00024 * 1. Redistributions of source code must retain the above copyright 00025 * notice, this list of conditions and the following disclaimer. 00026 * 2. Redistributions in binary form must reproduce the above copyright 00027 * notice, this list of conditions and the following disclaimer in the 00028 * documentation and/or other materials provided with the distribution. 00029 * 3. Neither the name of the Institute nor the names of its contributors 00030 * may be used to endorse or promote products derived from this software 00031 * without specific prior written permission. 00032 * 00033 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 00034 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00035 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00036 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 00037 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00038 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 00039 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 00040 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00041 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 00042 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 00043 * SUCH DAMAGE. 00044 * 00045 * This file is part of the UIP TCP/IP stack 00046 * 00047 * Author: Adam Dunkels <adam@sics.se> 00048 * 00049 * $Id: clock.h,v 1.3 2006/06/11 21:46:39 adam Exp $ 00050 */ 00051 #ifndef __UIP_CLOCK_H__ 00052 #define __UIP_CLOCK_H__ 00053 00054 #include "clock-arch.h" 00055 00056 /** 00057 * Initialize the clock library. 00058 * 00059 * This function initializes the clock library and should be called 00060 * from the main() function of the system. 00061 * 00062 */ 00063 void uip_clock_init(void); 00064 00065 /** 00066 * Get the current clock time. 00067 * 00068 * This function returns the current system clock time. 00069 * 00070 * \return The current clock time, measured in system ticks. 00071 */ 00072 clock_time_t clock_time(void); 00073 00074 /** 00075 * A second, measured in system clock time. 00076 * 00077 * \hideinitializer 00078 */ 00079 00080 #ifdef CLOCK_CONF_SECOND 00081 #define CLOCK_SECOND CLOCK_CONF_SECOND 00082 #else 00083 #define CLOCK_SECOND (clock_time_t) 32 00084 #endif 00085 #endif /* __CLOCK_H__ */ 00086 00087 /** @} */
Generated on Tue Jul 12 2022 18:10:58 by 1.7.2