Nut/OS  4.10.3
API Reference
timer.h
Go to the documentation of this file.
00001 #ifndef _ARCH_TIMER_H_
00002 #define _ARCH_TIMER_H_
00003 
00004 /*
00005  * Copyright (C) 2001-2005 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 /*
00037  * $Log$
00038  * Revision 1.5  2009/03/05 22:16:57  freckle
00039  * use __NUT_EMULATION instead of __APPLE__, __linux__, or __CYGWIN__
00040  *
00041  * Revision 1.4  2008/08/22 09:25:34  haraldkipp
00042  * Clock value caching and new functions NutArchClockGet, NutClockGet and
00043  * NutClockSet added.
00044  *
00045  * Revision 1.3  2008/08/11 06:59:58  haraldkipp
00046  * BSD types replaced by stdint types (feature request #1282721).
00047  *
00048  * Revision 1.2  2008/07/08 08:25:05  haraldkipp
00049  * NutDelay is no more architecture specific.
00050  * Number of loops per millisecond is configurable or will be automatically
00051  * determined.
00052  * A new function NutMicroDelay provides shorter delays.
00053  *
00054  * Revision 1.1  2005/07/26 18:42:19  haraldkipp
00055  * First check in
00056  *
00057  */
00058 
00059 #include <stdint.h>
00060 
00061 #ifdef __NUT_EMULATION__
00062 #include <arch/unix/timer.h>
00063 #elif defined(__AVR__)
00064 #include <arch/avr/timer.h>
00065 #elif defined(__arm__)
00066 #include <arch/arm/timer.h>
00067 #elif defined(__AVR32__)
00068 #include <arch/avr32/timer.h>
00069 #elif defined(__H8300H__) || defined(__H8300S__)
00070 #include <arch/h8300h/timer.h>
00071 #elif defined(__m68k__)
00072 #include <arch/m68k/timer.h>
00073 #endif
00074 
00075 __BEGIN_DECLS
00076 /* Prototypes */
00077 
00078 /*
00079  * Architecture dependent functions.
00080  */
00081 extern void NutRegisterTimer(void (*handler) (void *));
00082 extern uint32_t NutArchClockGet(int idx);
00083 extern uint32_t NutGetTickClock(void);
00084 extern uint32_t NutTimerMillisToTicks(uint32_t ms);
00085 
00086 __END_DECLS
00087 /* End of prototypes */
00088 
00089 #endif