# asynclabs/WiShield_user_contrib

Switch branches/tags
Nothing to show
Fetching contributors…
Cannot retrieve contributors at this time
89 lines (81 sloc) 2.83 KB
 /** * \defgroup clock Clock interface * * The clock interface is the interface between the \ref timer "timer library" * and the platform specific clock functionality. The clock * interface must be implemented for each platform that uses the \ref * timer "timer library". * * The clock interface does only one this: it measures time. The clock * interface provides a macro, CLOCK_SECOND, which corresponds to one * second of system time. * * \sa \ref timer "Timer library" * * @{ */ /* * Copyright (c) 2004, Swedish Institute of Computer Science. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the Institute nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * This file is part of the uIP TCP/IP stack * * Author: Adam Dunkels * * $Id: clock.h,v 1.3 2006/06/11 21:46:39 adam Exp$ */ #ifndef __CLOCK_H__ #define __CLOCK_H__ #include "clock-arch.h" /** * Initialize the clock library. * * This function initializes the clock library and should be called * from the main() function of the system. * */ void clock_init(void); /** * Get the current clock time. * * This function returns the current system clock time. * * \return The current clock time, measured in system ticks. */ clock_time_t clock_time(void); /** * A second, measured in system clock time. * * \hideinitializer */ #ifdef CLOCK_CONF_SECOND #define CLOCK_SECOND CLOCK_CONF_SECOND #else #define CLOCK_SECOND (clock_time_t)32 #endif #endif /* __CLOCK_H__ */ /** @} */