8666893c93fc8e12a1cc4abb48b1f9ee927f40eb
[bertos.git] / bertos / cpu / arm / drv / timer_at91.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \version $Id$
34  *
35  * \author Francesco Sacchi <batt@develer.com>
36  *
37  * \brief Low-level timer module for Atmel AT91 (interface).
38  */
39
40 #ifndef DRV_AT91_TIMER_H
41 #define DRV_AT91_TIMER_H
42
43 #include <hw/hw_cpufreq.h>     /* CPU_FREQ */
44
45 #include "cfg/cfg_timer.h"     /* CONFIG_TIMER */
46 #include <cfg/compiler.h>      /* uint8_t */
47 #include <cfg/macros.h>        /* BV */
48
49 #include <io/arm.h>
50
51 /**
52  * \name Values for CONFIG_TIMER.
53  *
54  * Select which hardware timer interrupt to use for system clock and softtimers.
55  *
56  * $WIZ$ timer_select = "TIMER_ON_PIT", "TIMER_DEFAULT"
57  */
58 #define TIMER_ON_PIT 1  ///< System timer on Periodic interval timer
59
60 #define TIMER_DEFAULT TIMER_ON_PIT  ///< Default system timer
61
62 /*
63  * Hardware dependent timer initialization.
64  */
65 #if (CONFIG_TIMER == TIMER_ON_PIT)
66
67         void timer_handler(void);
68
69         #define DEFINE_TIMER_ISR     void timer_handler(void)
70         #define TIMER_TICKS_PER_SEC  1000
71         #define TIMER_HW_CNT         (CPU_FREQ / (16 * TIMER_TICKS_PER_SEC) - 1)
72
73         /** Frequency of the hardware high-precision timer. */
74         #define TIMER_HW_HPTICKS_PER_SEC (CPU_FREQ / 16)
75
76         /** Type of time expressed in ticks of the hardware high-precision timer */
77         typedef uint32_t hptime_t;
78         #define SIZEOF_HPTIME_T 4
79
80         INLINE void timer_hw_irq(void)
81         {
82                 /* Reset counters, this is needed to reset timer and interrupt flags */
83                 uint32_t dummy = PIVR;
84                 (void) dummy;
85         }
86
87         INLINE bool timer_hw_triggered(void)
88         {
89                 return PIT_SR & BV(PITS);
90         }
91
92         INLINE hptime_t timer_hw_hpread(void)
93         {
94                 /* In the upper part of PIT_PIIR there is unused data */
95                 return PIIR & CPIV_MASK;
96         }
97
98 #else
99
100         #error Unimplemented value for CONFIG_TIMER
101 #endif /* CONFIG_TIMER */
102
103 void timer_hw_init(void);
104
105
106 #endif /* DRV_TIMER_AT91_H */