initial commit
[freebsd-arm:freebsd-arm.git] / arm / at91 / at91_st.c
1 /*-
2  * Copyright (c) 2005 Olivier Houchard.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  */
25
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
28
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/kernel.h>
32 #include <sys/module.h>
33 #include <sys/time.h>
34 #include <sys/bus.h>
35 #include <sys/resource.h>
36 #include <sys/rman.h>
37 #include <sys/timetc.h>
38 #include <sys/watchdog.h>
39
40 #include <machine/bus.h>
41 #include <machine/cpu.h>
42 #include <machine/cpufunc.h>
43 #include <machine/resource.h>
44 #include <machine/frame.h>
45 #include <machine/intr.h>
46 //#include <arm/at91/at91rm92reg.h>
47 #include <arm/at91/at91sam9g20reg.h>
48 #include <arm/at91/at91var.h>
49 #include <arm/at91/at91_streg.h>
50
51 static struct at91st_softc {
52         bus_space_tag_t         sc_st;
53         bus_space_handle_t      sc_sh;
54         device_t                sc_dev;
55         eventhandler_tag        sc_wet; /* watchdog event handler tag */
56 } *timer_softc;
57
58 #define RD4(off) \
59         bus_space_read_4(timer_softc->sc_st, timer_softc->sc_sh, (off))
60 #define WR4(off, val) \
61         bus_space_write_4(timer_softc->sc_st, timer_softc->sc_sh, (off), (val))
62
63 static void at91st_watchdog(void *, u_int, int *);
64
65 static inline int
66 st_crtr(void)
67 {
68         int cur1, cur2;
69         do {
70                 cur1 = RD4(ST_CRTR);
71                 cur2 = RD4(ST_CRTR);
72         } while (cur1 != cur2);
73         return (cur1);
74 }
75
76 static unsigned at91st_get_timecount(struct timecounter *tc);
77
78 static struct timecounter at91st_timecounter = {
79         at91st_get_timecount, /* get_timecount */
80         NULL, /* no poll_pps */
81 #ifdef SKYEYE_WORKAROUNDS
82         0xffffffffu, /* counter_mask */
83 #else
84         0xfffffu, /* counter_mask */
85 #endif
86         32768, /* frequency */
87         "AT91RM9200 timer", /* name */
88         1000 /* quality */
89 };
90
91 static int
92 at91st_probe(device_t dev)
93 {
94
95         device_set_desc(dev, "ST");
96         return (0);
97 }
98
99 static int
100 at91st_attach(device_t dev)
101 {
102         struct at91_softc *sc = device_get_softc(device_get_parent(dev));
103
104         timer_softc = device_get_softc(dev);
105         timer_softc->sc_st = sc->sc_st;
106         timer_softc->sc_dev = dev;
107 #if 0
108         if (bus_space_subregion(sc->sc_st, sc->sc_sh, AT91RM92_ST_BASE,
109             AT91RM92_ST_SIZE, &timer_softc->sc_sh) != 0)
110                 panic("couldn't subregion timer registers");
111 #endif
112
113         if (bus_space_subregion(sc->sc_st, sc->sc_sh, AT91SAM9G20_ST_BASE,
114             AT91SAM9G20_ST_SIZE, &timer_softc->sc_sh) != 0)
115                 panic("couldn't subregion timer registers");
116
117         /*
118          * Real time counter increments every clock cycle, need to set before
119          * initializing clocks so that DELAY works.
120          */
121         WR4(ST_RTMR, 1);
122         /* Disable all interrupts */
123         WR4(ST_IDR, 0xffffffff);
124         /* disable watchdog timer */
125         WR4(ST_WDMR, 0);
126
127         timer_softc->sc_wet = EVENTHANDLER_REGISTER(watchdog_list,
128           at91st_watchdog, dev, 0);
129         device_printf(dev,
130           "watchdog registered, timeout intervall max. 64 sec\n");
131         return (0);
132 }
133
134 static device_method_t at91st_methods[] = {
135         DEVMETHOD(device_probe, at91st_probe),
136         DEVMETHOD(device_attach, at91st_attach),
137         {0, 0},
138 };
139
140 static driver_t at91st_driver = {
141         "at91_st",
142         at91st_methods,
143         sizeof(struct at91st_softc),
144 };
145 static devclass_t at91st_devclass;
146
147 DRIVER_MODULE(at91_st, atmelarm, at91st_driver, at91st_devclass, 0, 0);
148
149 #ifdef SKYEYE_WORKAROUNDS
150 static unsigned long tot_count = 0;
151 #endif
152
153 static unsigned
154 at91st_get_timecount(struct timecounter *tc)
155 {
156 #ifdef SKYEYE_WORKAROUNDS
157         return (tot_count);
158 #else
159         return (st_crtr());
160 #endif
161 }
162
163 /*
164  * t below is in a weird unit.  The watchdog is set to 2^t
165  * nanoseconds.  Since our watchdog timer can't really do that too
166  * well, we approximate it by assuming that the timeout interval for
167  * the lsb is 2^22 ns, which is 4.194ms.  This is an overestimation of
168  * the actual time (3.906ms), but close enough for watchdogging.
169  * These approximations, though a violation of the spec, improve the
170  * performance of the application which typically specifies things as
171  * WD_TO_32SEC.  In that last case, we'd wait 32s before the wdog
172  * reset.  The spec says we should wait closer to 34s, but given how
173  * it is likely to be used, and the extremely coarse nature time
174  * interval, I think this is the best solution.
175  */
176 static void
177 at91st_watchdog(void *argp, u_int cmd, int *error)
178 {
179         uint32_t wdog;
180         int t;
181
182         t = cmd & WD_INTERVAL;
183         if (t >= 22 && t <= 37) {
184                 wdog = (1 << (t - 22)) | ST_WDMR_RSTEN;
185                 *error = 0;
186         } else {
187                 wdog = 0;
188         }
189         WR4(ST_WDMR, wdog);
190         WR4(ST_CR, ST_CR_WDRST);
191 }
192
193 static int
194 clock_intr(void *arg)
195 {
196         struct trapframe *fp = arg;
197
198         /* The interrupt is shared, so we have to make sure it's for us. */
199         if (RD4(ST_SR) & ST_SR_PITS) {
200 #ifdef SKYEYE_WORKAROUNDS
201                 tot_count += 32768 / hz;
202 #endif
203                 hardclock(TRAPF_USERMODE(fp), TRAPF_PC(fp));
204                 return (FILTER_HANDLED);
205         }
206         return (FILTER_STRAY);
207 }
208
209 void
210 cpu_initclocks(void)
211 {
212         int rel_value;
213         struct resource *irq;
214         int rid = 0;
215         void *ih;
216         device_t dev = timer_softc->sc_dev;
217
218         rel_value = 32768 / hz;
219         if (rel_value < 1)
220                 rel_value = 1;
221         if (32768 % hz) {
222                 printf("Cannot get %d Hz clock; using %dHz\n", hz, 32768 / rel_value);
223                 hz = 32768 / rel_value;
224                 tick = 1000000 / hz;
225         }
226         /* Disable all interrupts. */
227         WR4(ST_IDR, 0xffffffff);
228         /* The system timer shares the system irq (1) */
229         irq = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 1, 1, 1,
230           RF_ACTIVE | RF_SHAREABLE);
231         if (!irq)
232                 panic("Unable to allocate irq for the system timer");
233         else
234                 bus_setup_intr(dev, irq, INTR_TYPE_CLK,
235                     clock_intr, NULL, NULL, &ih);
236
237         WR4(ST_PIMR, rel_value);
238
239         /* Enable PITS interrupts. */
240         WR4(ST_IER, ST_SR_PITS);
241         tc_init(&at91st_timecounter);
242 }
243
244 void
245 DELAY(int n)
246 {
247         uint32_t start, end, cur;
248
249         start = st_crtr();
250         n = (n * 1000) / 32768;
251         if (n <= 0)
252                 n = 1;
253         end = (start + n) & ST_CRTR_MASK;
254         cur = start;
255         if (start > end) {
256                 while (cur >= start || cur < end)
257                         cur = st_crtr();
258         } else {
259                 while (cur < end)
260                         cur = st_crtr();
261         }
262 }
263
264 void
265 cpu_reset(void)
266 {
267         /*
268          * Reset the CPU by programmig the watchdog timer to reset the
269          * CPU after 128 'slow' clocks, or about ~4ms.  Loop until
270          * the reset happens for safety.
271          */
272         WR4(ST_WDMR, ST_WDMR_RSTEN | 2);
273         WR4(ST_CR, ST_CR_WDRST);
274         while (1)
275                 continue;
276 }
277
278 void
279 cpu_startprofclock(void)
280 {
281 }
282
283 void
284 cpu_stopprofclock(void)
285 {
286 }