Doc fixes.
[bertos.git] / drv / timer.c
old mode 100755 (executable)
new mode 100644 (file)
index 0fe4d2c..0e756db
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
- * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2003, 2004, 2005, 2006 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief Hardware independent timer driver (implementation)
  * \author Bernardo Innocenti <bernie@develer.com>
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.26  2005/11/04 16:20:02  bernie
- *#* Fix reference to README.devlib in header.
- *#*
- *#* Revision 1.25  2005/07/19 07:26:37  bernie
- *#* Refactor to decouple timer ticks from milliseconds.
- *#*
- *#* Revision 1.24  2005/04/11 19:10:28  bernie
- *#* Include top-level headers from cfg/ subdir.
- *#*
- *#* Revision 1.23  2004/12/13 12:07:06  bernie
- *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
- *#*
- *#* Revision 1.22  2004/12/08 09:12:09  bernie
- *#* Rename time_t to mtime_t.
- *#*
- *#* Revision 1.21  2004/11/28 23:20:25  bernie
- *#* Remove obsolete INITLIST macro.
- *#*
- *#* Revision 1.20  2004/11/16 20:59:06  bernie
- *#* Add watchdog timer support.
- *#*/
-
 #include "timer.h"
-#include <cfg/cpu.h>
-#include <hw.h>
+
+#include <cpu/attr.h>
+#include <cpu/types.h>
+#include <cpu/irq.h>
+
+#include <cfg/os.h>
 #include <cfg/debug.h>
+#include <cfg/module.h>
 #include <appconfig.h>
 
-#include CPU_CSOURCE(timer)
+/*
+ * Include platform-specific binding code if we're hosted.
+ * Try the CPU specific one for bare-metal environments.
+ */
+#if OS_HOSTED
+       #include OS_CSOURCE(timer)
+#else
+       #include CPU_CSOURCE(timer)
+#endif
 
 /*
  * Sanity check for config parameters required by this module.
        #include <drv/wdt.h>
 #endif
 
-#if CONFIG_KERNEL && CONFIG_KERN_SIGNALS
-       #include <kern/proc.h>
+#if CONFIG_KERNEL
+       #include <config_kern.h>
+       #if CONFIG_KERN_PREEMPTIVE
+               #include <hw/switch.h>
+       #endif
+       #if CONFIG_KERN_SIGNALS
+               #include <kern/signal.h> /* sig_wait(), sig_check() */
+               #include <kern/proc.h>   /* proc_current() */
+               #include <cfg/macros.h>  /* BV() */
+       #endif
 #endif
 
 
-/*!
+/**
  * \def CONFIG_TIMER_STROBE
  *
  * This is a debug facility that can be used to
 #endif
 
 
-//! Master system clock (1 tick accuracy)
+/// Master system clock (1 tick accuracy)
 volatile ticks_t _clock;
 
 
 #ifndef CONFIG_TIMER_DISABLE_EVENTS
 
-/*!
+/**
  * List of active asynchronous timers.
  */
 REGISTER static List timers_queue;
 
 
-/*!
+/**
  * Add the specified timer to the software timer service queue.
  * When the delay indicated by the timer expires, the timer
  * device will execute the event associated with it.
@@ -133,13 +155,13 @@ void timer_add(Timer *timer)
        }
 
        /* Enqueue timer request into the list */
-       INSERTBEFORE(&timer->link, &node->link);
+       INSERT_BEFORE(&timer->link, &node->link);
 
        IRQ_RESTORE(flags);
 }
 
 
-/*!
+/**
  * Remove a timer from the timer queue before it has expired.
  */
 Timer *timer_abort(Timer *timer)
@@ -153,14 +175,14 @@ Timer *timer_abort(Timer *timer)
 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
 
 
-/*!
- * Wait for the specified amount of time (expressed in ms).
+/**
+ * Wait for the specified amount of timer ticks.
  */
 void timer_delayTicks(ticks_t delay)
 {
-#if defined(IRQ_GETSTATE)
+#if defined(IRQ_ENABLED)
        /* We shouldn't sleep with interrupts disabled */
-       ASSERT(IRQ_GETSTATE());
+       ASSERT(IRQ_ENABLED());
 #endif
 
 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
@@ -168,7 +190,7 @@ void timer_delayTicks(ticks_t delay)
 
        ASSERT(!sig_check(SIG_SINGLE));
        timer_set_event_signal(&t, proc_current(), SIG_SINGLE);
-       timer_set_delay(&t, delay);
+       timer_setDelay(&t, delay);
        timer_add(&t);
        sig_wait(SIG_SINGLE);
 
@@ -190,7 +212,7 @@ void timer_delayTicks(ticks_t delay)
 
 #ifndef CONFIG_TIMER_DISABLE_UDELAY
 
-/*!
+/**
  * Busy wait until the specified amount of high-precision ticks have elapsed.
  *
  * \note This function is interrupt safe, the only
@@ -217,7 +239,7 @@ void timer_busyWait(hptime_t delay)
        }
 }
 
-/*!
+/**
  * Wait for the specified amount of time (expressed in microseconds).
  *
  * \bug In AVR arch the maximum amount of time that can be used as
@@ -237,7 +259,7 @@ void timer_delayHp(hptime_t delay)
 #endif /* CONFIG_TIMER_DISABLE_UDELAY */
 
 
-/*!
+/**
  * Timer interrupt handler. Find soft timers expired and
  * trigger corresponding events.
  */
@@ -255,9 +277,16 @@ DEFINE_TIMER_ISR
 #ifndef CONFIG_TIMER_DISABLE_EVENTS
        Timer *timer;
 #endif
+       /*
+        * On systems sharing IRQ line and vector, this check is needed
+        * to ensure that IRQ is generated by timer source.
+        */
+       if (!timer_hw_triggered())
+               return;
 
        TIMER_STROBE_ON;
 
+       /* Perform hw IRQ handling */
        timer_hw_irq();
 
        /* Update the master ms counter */
@@ -289,8 +318,9 @@ DEFINE_TIMER_ISR
        TIMER_STROBE_OFF;
 }
 
+MOD_DEFINE(timer)
 
-/*!
+/**
  * Initialize timer
  */
 void timer_init(void)
@@ -304,96 +334,6 @@ void timer_init(void)
        _clock = 0;
 
        timer_hw_init();
-}
-
 
-#if CONFIG_TEST
-
-static void timer_test_constants(void)
-{
-       kprintf("TIMER_PRESCALER=%d\n", TIMER_PRESCALER);
-       kprintf("TIMER_HW_HPTICKS_PER_SEC=%lu\n", TIMER_HW_HPTICKS_PER_SEC);
-       #ifdef TIMER1_OVF_COUNT
-               kprintf("TIMER1_OVF_COUNT=%d\n", (int)TIMER1_OVF_COUNT);
-       #endif
-       kprintf("TIMER_TICKS_PER_MSEC=%d\n", (int)TIMER_TICKS_PER_MSEC);
-       kprintf("\n");
-       kprintf("ms_to_ticks(100)=%lu\n", ms_to_ticks(100));
-       kprintf("ms_to_ticks(10000)=%lu\n", ms_to_ticks(10000));
-       kprintf("us_to_ticks(100)=%lu\n", us_to_ticks(100));
-       kprintf("us_to_ticks(10000)=%lu\n", us_to_ticks(10000));
-       kprintf("\n");
-       kprintf("ticks_to_ms(100)=%lu\n", ticks_to_ms(100));
-       kprintf("ticks_to_ms(10000)=%lu\n", ticks_to_ms(10000));
-       kprintf("ticks_to_us(100)=%lu\n", ticks_to_us(100));
-       kprintf("ticks_to_us(10000)=%lu\n", ticks_to_us(10000));
-       kprintf("\n");
-       kprintf("hptime_to_us(100)=%lu\n", hptime_to_us(100));
-       kprintf("hptime_to_us(10000)=%lu\n", hptime_to_us(10000));
-       kprintf("us_to_hptime(100)=%lu\n", us_to_hptime(100));
-       kprintf("us_to_hptime(10000)=%lu\n", us_to_hptime(10000));
+       MOD_INIT(timer);
 }
-
-static void timer_test_delay(void)
-{
-       int i;
-
-       kputs("Delay test\n");
-       for (i = 0; i < 1000; i += 100)
-       {
-               kprintf("delay %d...", i);
-               timer_delay(i);
-               kputs("done\n");
-       }
-}
-
-static void timer_test_hook(iptr_t _timer)
-{
-       Timer *timer = (Timer *)(void *)_timer;
-
-       kprintf("Timer %ld expired\n", ticks_to_ms(timer->_delay));
-       timer_add(timer);
-}
-
-static void timer_test_async(void)
-{
-       static Timer test_timers[5];
-       static const mtime_t test_delays[5] = { 170, 50, 310, 1500, 310 };
-       size_t i;
-
-       for (i = 0; i < countof(test_timers); ++i)
-       {
-               Timer *timer = &test_timers[i];
-               timer_setDelay(timer, ms_to_ticks(test_delays[i]));
-               timer_set_event_softint(timer, timer_test_hook, (iptr_t)timer);
-               timer_add(timer);
-       }
-}
-
-static void timer_test_poll(void)
-{
-       int secs = 0;
-       mtime_t start_time = ticks_to_ms(timer_clock());
-       mtime_t now;
-
-       while (secs <= 10)
-       {
-               now = ticks_to_ms(timer_clock());
-               if (now - start_time >= 1000)
-               {
-                       ++secs;
-                       start_time += 1000;
-                       kprintf("seconds = %d, ticks=%ld\n", secs, now);
-               }
-       }
-}
-
-void timer_test(void)
-{
-       timer_test_constants();
-       timer_test_delay();
-       timer_test_async();
-       timer_test_poll();
-}
-
-#endif /* CONFIG_TEST */