timer.h

Go to the documentation of this file.
00001 #ifndef _SYS_TIMER_H
00002 #define _SYS_TIMER_H
00003 
00004 /*
00005  * Copyright (C) 2001-2006 by egnite Software GmbH. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  *
00035  * -
00036  * Portions Copyright (C) 2000 David J. Hudson <dave@humbug.demon.co.uk>
00037  *
00038  * This file is distributed in the hope that it will be useful, but WITHOUT
00039  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00040  * FITNESS FOR A PARTICULAR PURPOSE.
00041  *
00042  * You can redistribute this file and/or modify it under the terms of the GNU
00043  * General Public License (GPL) as published by the Free Software Foundation;
00044  * either version 2 of the License, or (at your discretion) any later version.
00045  * See the accompanying file "copying-gpl.txt" for more details.
00046  *
00047  * As a special exception to the GPL, permission is granted for additional
00048  * uses of the text contained in this file.  See the accompanying file
00049  * "copying-liquorice.txt" for details.
00050  */
00051 
00052 /*
00053  * $Log: timer.h,v $
00054  * Revision 1.11  2008/07/08 08:25:05  haraldkipp
00055  * NutDelay is no more architecture specific.
00056  * Number of loops per millisecond is configurable or will be automatically
00057  * determined.
00058  * A new function NutMicroDelay provides shorter delays.
00059  *
00060  * Revision 1.10  2006/06/28 14:36:34  haraldkipp
00061  * Event/thread/timer re-design.
00062  *
00063  * Revision 1.9  2005/07/26 16:04:02  haraldkipp
00064  * Hardware dependent timer code moved to nutlibarch.
00065  *
00066  * Revision 1.8  2005/07/12 16:36:53  freckle
00067  * made NutTimerInsert public
00068  *
00069  * Revision 1.7  2005/07/12 16:26:08  freckle
00070  * extracted timer creation from NutTimerStartTicks into NutTimerCreate
00071  *
00072  * Revision 1.6  2005/06/12 16:54:14  haraldkipp
00073  * New function processes elapsed timers.
00074  *
00075  * Revision 1.5  2005/01/19 17:59:42  freckle
00076  * Improved interrupt performance by reducing some critical section
00077  *
00078  * Revision 1.4  2004/03/16 16:48:44  haraldkipp
00079  * Added Jan Dubiec's H8/300 port.
00080  *
00081  * Revision 1.3  2003/11/03 16:35:18  haraldkipp
00082  * New API returns system uptime in miliseconds
00083  *
00084  * Revision 1.2  2003/10/13 10:17:11  haraldkipp
00085  * Seconds counter added
00086  * 
00087  * Revision 1.1.1.1  2003/05/09 14:41:22  haraldkipp
00088  * Initial using 3.2.1
00089  *
00090  * Revision 1.12  2003/02/04 18:00:54  harald
00091  * Version 3 released
00092  *
00093  * Revision 1.11  2003/01/14 16:38:18  harald
00094  * New tick counter query
00095  *
00096  * Revision 1.10  2002/06/26 17:29:29  harald
00097  * First pre-release with 2.4 stack
00098  *
00099  */
00100 
00101 #include <sys/types.h>
00102 #include <arch/timer.h>
00103 
00112 typedef struct _NUTTIMERINFO NUTTIMERINFO;
00113 
00118 struct _NUTTIMERINFO {
00121     NUTTIMERINFO *tn_next;          
00124     NUTTIMERINFO *tn_prev;          
00128     u_long tn_ticks;        
00131     u_long tn_ticks_left;   
00134     void (*tn_callback)(HANDLE, void *);    
00137     volatile void *tn_arg;          
00138 };
00139 
00140 extern NUTTIMERINFO* nutTimerList;
00141 
00142 #define TM_ONESHOT  0x01
00143 
00144 __BEGIN_DECLS
00145 /* Prototypes */
00146 
00147 /*
00148  * Functions used by the kernel.
00149  */
00150 extern void NutTimerInit(void);
00151 extern NUTTIMERINFO * NutTimerCreate(u_long ticks, void (*callback) (HANDLE, void *), void *arg, u_char flags);
00152 extern void NutTimerInsert(NUTTIMERINFO * tn);
00153 extern void NutTimerProcessElapsed(void);
00154 
00155 /*
00156  * API declarations.
00157  */
00158 extern void NutSleep(u_long ms);
00159 extern void NutDelay(u_char ms);
00160 extern void NutMicroDelay(u_long us);
00161 
00162 extern u_long NutGetTickCount(void);
00163 extern u_long NutGetSeconds(void);
00164 extern u_long NutGetMillis(void);
00165 
00166 extern HANDLE NutTimerStart(u_long ms, void (*callback)(HANDLE, void *), void *arg, u_char flags);
00167 extern HANDLE NutTimerStartTicks(u_long ticks, void (*callback) (HANDLE, void *), void *arg, u_char flags);
00168 extern void NutTimerStop(HANDLE handle);
00169 
00170 __END_DECLS
00171 /* End of prototypes */
00172 
00173 #endif

© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/