Add function to read hp ticks.
[bertos.git] / bertos / cpu / cortex-m3 / drv / timer_cm3.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 2010 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \author Andrea Righi <arighi@develer.com>
34  *
35  * \brief Low-level timer driver (SysTick) for Cortex-M3.
36  */
37
38 #ifndef TIMER_CM3_H
39 #define TIMER_CM3_H
40
41 #include "cfg/cfg_timer.h"     /* CONFIG_TIMER */
42
43 #if CPU_CM3_LM3S
44         #include <io/lm3s.h>
45 #elif CPU_CM3_STM32
46         #include <io/stm32.h>
47 /*#elif  Add other families here */
48 #else
49         #error Unknown CPU
50 #endif
51
52 /**
53  * \name Values for CONFIG_TIMER.
54  *
55  * Select which hardware timer interrupt to use for system clock and softtimers.
56  *
57  * $WIZ$ timer_select = "TIMER_DEFAULT", "TIMER_ON_GPTM"
58  */
59 #define TIMER_ON_GPTM  1
60
61 #define TIMER_DEFAULT  TIMER_ON_GPTM ///< Default system timer
62
63 #if (CONFIG_TIMER == TIMER_ON_GPTM)
64         /* Ticks frequency (HZ) */
65         #define TIMER_TICKS_PER_SEC     1000
66
67         /* Frequency of the hardware high-precision timer. */
68         #define TIMER_HW_HPTICKS_PER_SEC (CPU_FREQ)
69
70         /* Maximum value of the high-precision hardware counter register */
71         #define TIMER_HW_CNT (CPU_FREQ / TIMER_TICKS_PER_SEC)
72
73         /** Type of time expressed in ticks of the hardware high-precision timer */
74         typedef uint32_t hptime_t;
75         #define SIZEOF_HPTIME_T 4
76
77         /* Timer ISR prototype */
78         ISR_PROTO_CONTEXT_SWITCH(timer_handler);
79         #define DEFINE_TIMER_ISR DECLARE_ISR_CONTEXT_SWITCH(timer_handler)
80
81         INLINE void timer_hw_irq(void)
82         {
83         }
84
85
86         INLINE bool timer_hw_triggered(void)
87         {
88                 return true;
89         }
90
91         INLINE hptime_t timer_hw_hpread(void)
92         {
93                 return NVIC_ST_CURRENT_R;
94         }
95
96         INLINE hptime_t timer_hw_hpticks(ticks_t clock)
97         {
98                 return (TIMER_HW_CNT - timer_hw_hpread()) + clock * TIMER_HW_CNT;
99         }
100
101 #else
102
103         #error Unimplemented value for CONFIG_TIMER
104 #endif /* CONFIG_TIMER */
105
106 void timer_hw_init(void);
107 void timer_hw_exit(void);
108
109 #endif /* TIMER_CM3_H */