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