sys/arm/arm/sp804.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
   5  * Copyright (c) 2012 Damjan Marion <dmarion@freebsd.org>
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 #include <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/bus.h>
  34 #include <sys/kernel.h>
  35 #include <sys/module.h>
  36 #include <sys/malloc.h>
  37
  38 #include <sys/timeet.h>
  39 #include <sys/timetc.h>
  40 #include <sys/watchdog.h>
  41 #include <machine/bus.h>
  42 #include <machine/cpu.h>
  43 #include <machine/intr.h>
  44
  45 #include <machine/machdep.h> /* For arm_set_delay */
  46
  47 #include <dev/ofw/openfirm.h>
  48 #include <dev/ofw/ofw_bus.h>
  49 #include <dev/ofw/ofw_bus_subr.h>
  50
  51 #include <machine/bus.h>
  52
  53 #define SP804_TIMER1_LOAD       0x00
  54 #define SP804_TIMER1_VALUE      0x04
  55 #define SP804_TIMER1_CONTROL    0x08
  56 #define         TIMER_CONTROL_EN        (1 << 7)
  57 #define         TIMER_CONTROL_FREERUN   (0 << 6)
  58 #define         TIMER_CONTROL_PERIODIC  (1 << 6)
  59 #define         TIMER_CONTROL_INTREN    (1 << 5)
  60 #define         TIMER_CONTROL_DIV1      (0 << 2)
  61 #define         TIMER_CONTROL_DIV16     (1 << 2)
  62 #define         TIMER_CONTROL_DIV256    (2 << 2)
  63 #define         TIMER_CONTROL_32BIT     (1 << 1)
  64 #define         TIMER_CONTROL_ONESHOT   (1 << 0)
  65 #define SP804_TIMER1_INTCLR     0x0C
  66 #define SP804_TIMER1_RIS        0x10
  67 #define SP804_TIMER1_MIS        0x14
  68 #define SP804_TIMER1_BGLOAD     0x18
  69 #define SP804_TIMER2_LOAD       0x20
  70 #define SP804_TIMER2_VALUE      0x24
  71 #define SP804_TIMER2_CONTROL    0x28
  72 #define SP804_TIMER2_INTCLR     0x2C
  73 #define SP804_TIMER2_RIS        0x30
  74 #define SP804_TIMER2_MIS        0x34
  75 #define SP804_TIMER2_BGLOAD     0x38
  76
  77 #define SP804_PERIPH_ID0        0xFE0
  78 #define SP804_PERIPH_ID1        0xFE4
  79 #define SP804_PERIPH_ID2        0xFE8
  80 #define SP804_PERIPH_ID3        0xFEC
  81 #define SP804_PRIMECELL_ID0     0xFF0
  82 #define SP804_PRIMECELL_ID1     0xFF4
  83 #define SP804_PRIMECELL_ID2     0xFF8
  84 #define SP804_PRIMECELL_ID3     0xFFC
  85
  86 #define DEFAULT_FREQUENCY       1000000
  87 /*
  88  * QEMU seems to have problem with full frequency
  89  */
  90 #define DEFAULT_DIVISOR         16
  91 #define DEFAULT_CONTROL_DIV     TIMER_CONTROL_DIV16
  92
  93 struct sp804_timer_softc {
  94         struct resource*        mem_res;
  95         struct resource*        irq_res;
  96         void*                   intr_hl;
  97         uint32_t                sysclk_freq;
  98         bus_space_tag_t         bst;
  99         bus_space_handle_t      bsh;
 100         struct timecounter      tc;
 101         bool                    et_enabled;
 102         struct eventtimer       et;
 103         int                     timer_initialized;
 104 };
 105
 106 /* Read/Write macros for Timer used as timecounter */
 107 #define sp804_timer_tc_read_4(reg)              \
 108         bus_space_read_4(sc->bst, sc->bsh, reg)
 109
 110 #define sp804_timer_tc_write_4(reg, val)        \
 111         bus_space_write_4(sc->bst, sc->bsh, reg, val)
 112
 113 static unsigned sp804_timer_tc_get_timecount(struct timecounter *);
 114 static void sp804_timer_delay(int, void *);
 115
 116 static unsigned
 117 sp804_timer_tc_get_timecount(struct timecounter *tc)
 118 {
 119         struct sp804_timer_softc *sc = tc->tc_priv;
 120         return 0xffffffff - sp804_timer_tc_read_4(SP804_TIMER1_VALUE);
 121 }
 122
 123 static int
 124 sp804_timer_start(struct eventtimer *et, sbintime_t first, sbintime_t period)
 125 {
 126         struct sp804_timer_softc *sc = et->et_priv;
 127         uint32_t count, reg;
 128
 129         if (first != 0) {
 130                 sc->et_enabled = 1;
 131
 132                 count = ((uint32_t)et->et_frequency * first) >> 32;
 133
 134                 sp804_timer_tc_write_4(SP804_TIMER2_LOAD, count);
 135                 reg = TIMER_CONTROL_32BIT | TIMER_CONTROL_INTREN |
 136                     TIMER_CONTROL_PERIODIC | DEFAULT_CONTROL_DIV |
 137                     TIMER_CONTROL_EN;
 138                 sp804_timer_tc_write_4(SP804_TIMER2_CONTROL, reg);
 139
 140                 return (0);
 141         }
 142
 143         if (period != 0) {
 144                 panic("period");
 145         }
 146
 147         return (EINVAL);
 148 }
 149
 150 static int
 151 sp804_timer_stop(struct eventtimer *et)
 152 {
 153         struct sp804_timer_softc *sc = et->et_priv;
 154         uint32_t reg;
 155
 156         sc->et_enabled = 0;
 157         reg = sp804_timer_tc_read_4(SP804_TIMER2_CONTROL);
 158         reg &= ~(TIMER_CONTROL_EN);
 159         sp804_timer_tc_write_4(SP804_TIMER2_CONTROL, reg);
 160
 161         return (0);
 162 }
 163
 164 static int
 165 sp804_timer_intr(void *arg)
 166 {
 167         struct sp804_timer_softc *sc = arg;
 168
 169         (void)sp804_timer_tc_read_4(SP804_TIMER1_VALUE);
 170
 171         sp804_timer_tc_write_4(SP804_TIMER2_INTCLR, 1);
 172         if (sc->et_enabled) {
 173                 if (sc->et.et_active) {
 174                         sc->et.et_event_cb(&sc->et, sc->et.et_arg);
 175                 }
 176         }
 177
 178         return (FILTER_HANDLED);
 179 }
 180
 181 static int
 182 sp804_timer_probe(device_t dev)
 183 {
 184
 185         if (!ofw_bus_status_okay(dev))
 186                 return (ENXIO);
 187
 188         if (ofw_bus_is_compatible(dev, "arm,sp804")) {
 189                 device_set_desc(dev, "SP804 System Timer");
 190                 return (BUS_PROBE_DEFAULT);
 191         }
 192
 193         return (ENXIO);
 194 }
 195
 196 static int
 197 sp804_timer_attach(device_t dev)
 198 {
 199         struct sp804_timer_softc *sc = device_get_softc(dev);
 200         int rid = 0;
 201         int i;
 202         uint32_t id, reg;
 203         phandle_t node;
 204         pcell_t clock;
 205
 206         sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 207         if (sc->mem_res == NULL) {
 208                 device_printf(dev, "could not allocate memory resource\n");
 209                 return (ENXIO);
 210         }
 211
 212         sc->bst = rman_get_bustag(sc->mem_res);
 213         sc->bsh = rman_get_bushandle(sc->mem_res);
 214
 215         /* Request the IRQ resources */
 216         sc->irq_res =  bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 217         if (sc->irq_res == NULL) {
 218                 device_printf(dev, "Error: could not allocate irq resources\n");
 219                 return (ENXIO);
 220         }
 221
 222         sc->sysclk_freq = DEFAULT_FREQUENCY;
 223         /* Get the base clock frequency */
 224         node = ofw_bus_get_node(dev);
 225         if ((OF_getencprop(node, "clock-frequency", &clock, sizeof(clock))) > 0) {
 226                 sc->sysclk_freq = clock;
 227         }
 228
 229         /* Setup and enable the timer */
 230         if (bus_setup_intr(dev, sc->irq_res, INTR_TYPE_CLK,
 231                         sp804_timer_intr, NULL, sc,
 232                         &sc->intr_hl) != 0) {
 233                 bus_release_resource(dev, SYS_RES_IRQ, rid,
 234                         sc->irq_res);
 235                 device_printf(dev, "Unable to setup the clock irq handler.\n");
 236                 return (ENXIO);
 237         }
 238
 239         sp804_timer_tc_write_4(SP804_TIMER1_CONTROL, 0);
 240         sp804_timer_tc_write_4(SP804_TIMER2_CONTROL, 0);
 241
 242         /*
 243          * Timer 1, timecounter
 244          */
 245         sc->tc.tc_frequency = sc->sysclk_freq;
 246         sc->tc.tc_name = "SP804-1";
 247         sc->tc.tc_get_timecount = sp804_timer_tc_get_timecount;
 248         sc->tc.tc_poll_pps = NULL;
 249         sc->tc.tc_counter_mask = ~0u;
 250         sc->tc.tc_quality = 1000;
 251         sc->tc.tc_priv = sc;
 252
 253         sp804_timer_tc_write_4(SP804_TIMER1_VALUE, 0xffffffff);
 254         sp804_timer_tc_write_4(SP804_TIMER1_LOAD, 0xffffffff);
 255         reg = TIMER_CONTROL_PERIODIC | TIMER_CONTROL_32BIT;
 256         sp804_timer_tc_write_4(SP804_TIMER1_CONTROL, reg);
 257         reg |= TIMER_CONTROL_EN;
 258         sp804_timer_tc_write_4(SP804_TIMER1_CONTROL, reg);
 259         tc_init(&sc->tc);
 260
 261         /*
 262          * Timer 2, event timer
 263          */
 264         sc->et_enabled = 0;
 265         sc->et.et_name = "SP804-2";
 266         sc->et.et_flags = ET_FLAGS_PERIODIC | ET_FLAGS_ONESHOT;
 267         sc->et.et_quality = 1000;
 268         sc->et.et_frequency = sc->sysclk_freq / DEFAULT_DIVISOR;
 269         sc->et.et_min_period = (0x00000002LLU << 32) / sc->et.et_frequency;
 270         sc->et.et_max_period = (0xfffffffeLLU << 32) / sc->et.et_frequency;
 271         sc->et.et_start = sp804_timer_start;
 272         sc->et.et_stop = sp804_timer_stop;
 273         sc->et.et_priv = sc;
 274         et_register(&sc->et);
 275
 276         id = 0;
 277         for (i = 3; i >= 0; i--) {
 278                 id = (id << 8) |
 279                      (sp804_timer_tc_read_4(SP804_PERIPH_ID0 + i*4) & 0xff);
 280         }
 281
 282         device_printf(dev, "peripheral ID: %08x\n", id);
 283
 284         id = 0;
 285         for (i = 3; i >= 0; i--) {
 286                 id = (id << 8) |
 287                      (sp804_timer_tc_read_4(SP804_PRIMECELL_ID0 + i*4) & 0xff);
 288         }
 289
 290         arm_set_delay(sp804_timer_delay, sc);
 291
 292         device_printf(dev, "PrimeCell ID: %08x\n", id);
 293
 294         sc->timer_initialized = 1;
 295
 296         return (0);
 297 }
 298
 299 static device_method_t sp804_timer_methods[] = {
 300         DEVMETHOD(device_probe,         sp804_timer_probe),
 301         DEVMETHOD(device_attach,        sp804_timer_attach),
 302         { 0, 0 }
 303 };
 304
 305 static driver_t sp804_timer_driver = {
 306         "timer",
 307         sp804_timer_methods,
 308         sizeof(struct sp804_timer_softc),
 309 };
 310
 311 DRIVER_MODULE(sp804_timer, simplebus, sp804_timer_driver, 0, 0);
 312
 313 static void
 314 sp804_timer_delay(int usec, void *arg)
 315 {
 316         struct sp804_timer_softc *sc = arg;
 317         int32_t counts;
 318         uint32_t first, last;
 319
 320         /* Get the number of times to count */
 321         counts = usec * ((sc->tc.tc_frequency / 1000000) + 1);
 322
 323         first = sp804_timer_tc_get_timecount(&sc->tc);
 324
 325         while (counts > 0) {
 326                 last = sp804_timer_tc_get_timecount(&sc->tc);
 327                 if (last == first)
 328                         continue;
 329                 if (last > first) {
 330                         counts -= (int32_t)(last - first);
 331                 } else {
 332                         counts -= (int32_t)((0xFFFFFFFF - first) + last);
 333                 }
 334                 first = last;
 335         }
 336 }