sys/arm/arm/generic_timer.c

   1 /*-
   2  * Copyright (c) 2011 The FreeBSD Foundation
   3  * Copyright (c) 2013 Ruslan Bukin <br@bsdpad.com>
   4  * All rights reserved.
   5  *
   6  * Based on mpcore_timer.c developed by Ben Gray <ben.r.gray@gmail.com>
   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  * 3. The name of the company nor the name of the author may be used to
  17  *    endorse or promote products derived from this software without specific
  18  *    prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /**
  34  *      Cortex-A7, Cortex-A15, ARMv8 and later Generic Timer
  35  */
  36
  37 #include "opt_acpi.h"
  38 #include "opt_platform.h"
  39
  40 #include <sys/cdefs.h>
  41 __FBSDID("$FreeBSD$");
  42
  43 #include <sys/param.h>
  44 #include <sys/systm.h>
  45 #include <sys/bus.h>
  46 #include <sys/kernel.h>
  47 #include <sys/module.h>
  48 #include <sys/malloc.h>
  49 #include <sys/rman.h>
  50 #include <sys/timeet.h>
  51 #include <sys/timetc.h>
  52 #include <sys/smp.h>
  53 #include <sys/vdso.h>
  54 #include <sys/watchdog.h>
  55 #include <machine/bus.h>
  56 #include <machine/cpu.h>
  57 #include <machine/intr.h>
  58 #include <machine/md_var.h>
  59
  60 #ifdef FDT
  61 #include <dev/fdt/fdt_common.h>
  62 #include <dev/ofw/openfirm.h>
  63 #include <dev/ofw/ofw_bus.h>
  64 #include <dev/ofw/ofw_bus_subr.h>
  65 #endif
  66
  67 #ifdef DEV_ACPI
  68 #include <contrib/dev/acpica/include/acpi.h>
  69 #include <dev/acpica/acpivar.h>
  70 #endif
  71
  72 #define GT_CTRL_ENABLE          (1 << 0)
  73 #define GT_CTRL_INT_MASK        (1 << 1)
  74 #define GT_CTRL_INT_STAT        (1 << 2)
  75 #define GT_REG_CTRL             0
  76 #define GT_REG_TVAL             1
  77
  78 #define GT_CNTKCTL_PL0PTEN      (1 << 9) /* PL0 Physical timer reg access */
  79 #define GT_CNTKCTL_PL0VTEN      (1 << 8) /* PL0 Virtual timer reg access */
  80 #define GT_CNTKCTL_EVNTI        (0xf << 4) /* Virtual counter event bits */
  81 #define GT_CNTKCTL_EVNTDIR      (1 << 3) /* Virtual counter event transition */
  82 #define GT_CNTKCTL_EVNTEN       (1 << 2) /* Enables virtual counter events */
  83 #define GT_CNTKCTL_PL0VCTEN     (1 << 1) /* PL0 CNTVCT and CNTFRQ access */
  84 #define GT_CNTKCTL_PL0PCTEN     (1 << 0) /* PL0 CNTPCT and CNTFRQ access */
  85
  86 struct arm_tmr_softc {
  87         struct resource         *res[4];
  88         void                    *ihl[4];
  89         uint32_t                clkfreq;
  90         struct eventtimer       et;
  91         bool                    physical;
  92 };
  93
  94 static struct arm_tmr_softc *arm_tmr_sc = NULL;
  95
  96 static struct resource_spec timer_spec[] = {
  97         { SYS_RES_IRQ,          0,      RF_ACTIVE },    /* Secure */
  98         { SYS_RES_IRQ,          1,      RF_ACTIVE },    /* Non-secure */
  99         { SYS_RES_IRQ,          2,      RF_ACTIVE },    /* Virt */
 100         { SYS_RES_IRQ,          3,      RF_ACTIVE | RF_OPTIONAL }, /* Hyp */
 101         { -1, 0 }
 102 };
 103
 104 static timecounter_get_t arm_tmr_get_timecount;
 105
 106 static struct timecounter arm_tmr_timecount = {
 107         .tc_name           = "ARM MPCore Timecounter",
 108         .tc_get_timecount  = arm_tmr_get_timecount,
 109         .tc_poll_pps       = NULL,
 110         .tc_counter_mask   = ~0u,
 111         .tc_frequency      = 0,
 112         .tc_quality        = 1000,
 113 };
 114
 115 #ifdef __arm__
 116 #define get_el0(x)      cp15_## x ##_get()
 117 #define get_el1(x)      cp15_## x ##_get()
 118 #define set_el0(x, val) cp15_## x ##_set(val)
 119 #define set_el1(x, val) cp15_## x ##_set(val)
 120 #else /* __aarch64__ */
 121 #define get_el0(x)      READ_SPECIALREG(x ##_el0)
 122 #define get_el1(x)      READ_SPECIALREG(x ##_el1)
 123 #define set_el0(x, val) WRITE_SPECIALREG(x ##_el0, val)
 124 #define set_el1(x, val) WRITE_SPECIALREG(x ##_el1, val)
 125 #endif
 126
 127 static uint32_t arm_tmr_fill_vdso_timehands(struct vdso_timehands *vdso_th,
 128     struct timecounter *tc);
 129
 130 static int
 131 get_freq(void)
 132 {
 133         return (get_el0(cntfrq));
 134 }
 135
 136 static long
 137 get_cntxct(bool physical)
 138 {
 139         uint64_t val;
 140
 141         isb();
 142         if (physical)
 143                 val = get_el0(cntpct);
 144         else
 145                 val = get_el0(cntvct);
 146
 147         return (val);
 148 }
 149
 150 static int
 151 set_ctrl(uint32_t val, bool physical)
 152 {
 153
 154         if (physical)
 155                 set_el0(cntp_ctl, val);
 156         else
 157                 set_el0(cntv_ctl, val);
 158         isb();
 159
 160         return (0);
 161 }
 162
 163 static int
 164 set_tval(uint32_t val, bool physical)
 165 {
 166
 167         if (physical)
 168                 set_el0(cntp_tval, val);
 169         else
 170                 set_el0(cntv_tval, val);
 171         isb();
 172
 173         return (0);
 174 }
 175
 176 static int
 177 get_ctrl(bool physical)
 178 {
 179         uint32_t val;
 180
 181         if (physical)
 182                 val = get_el0(cntp_ctl);
 183         else
 184                 val = get_el0(cntv_ctl);
 185
 186         return (val);
 187 }
 188
 189 static void
 190 setup_user_access(void *arg __unused)
 191 {
 192         uint32_t cntkctl;
 193
 194         cntkctl = get_el1(cntkctl);
 195         cntkctl &= ~(GT_CNTKCTL_PL0PTEN | GT_CNTKCTL_PL0VTEN |
 196             GT_CNTKCTL_EVNTEN);
 197         if (arm_tmr_sc->physical) {
 198                 cntkctl |= GT_CNTKCTL_PL0PCTEN;
 199                 cntkctl &= ~GT_CNTKCTL_PL0VCTEN;
 200         } else {
 201                 cntkctl |= GT_CNTKCTL_PL0VCTEN;
 202                 cntkctl &= ~GT_CNTKCTL_PL0PCTEN;
 203         }
 204         set_el1(cntkctl, cntkctl);
 205         isb();
 206 }
 207
 208 static void
 209 tmr_setup_user_access(void *arg __unused)
 210 {
 211
 212         smp_rendezvous(NULL, setup_user_access, NULL, NULL);
 213 }
 214 SYSINIT(tmr_ua, SI_SUB_SMP, SI_ORDER_SECOND, tmr_setup_user_access, NULL);
 215
 216 static unsigned
 217 arm_tmr_get_timecount(struct timecounter *tc)
 218 {
 219
 220         return (get_cntxct(arm_tmr_sc->physical));
 221 }
 222
 223 static int
 224 arm_tmr_start(struct eventtimer *et, sbintime_t first,
 225     sbintime_t period __unused)
 226 {
 227         struct arm_tmr_softc *sc;
 228         int counts, ctrl;
 229
 230         sc = (struct arm_tmr_softc *)et->et_priv;
 231
 232         if (first != 0) {
 233                 counts = ((uint32_t)et->et_frequency * first) >> 32;
 234                 ctrl = get_ctrl(sc->physical);
 235                 ctrl &= ~GT_CTRL_INT_MASK;
 236                 ctrl |= GT_CTRL_ENABLE;
 237                 set_tval(counts, sc->physical);
 238                 set_ctrl(ctrl, sc->physical);
 239                 return (0);
 240         }
 241
 242         return (EINVAL);
 243
 244 }
 245
 246 static int
 247 arm_tmr_stop(struct eventtimer *et)
 248 {
 249         struct arm_tmr_softc *sc;
 250         int ctrl;
 251
 252         sc = (struct arm_tmr_softc *)et->et_priv;
 253
 254         ctrl = get_ctrl(sc->physical);
 255         ctrl &= GT_CTRL_ENABLE;
 256         set_ctrl(ctrl, sc->physical);
 257
 258         return (0);
 259 }
 260
 261 static int
 262 arm_tmr_intr(void *arg)
 263 {
 264         struct arm_tmr_softc *sc;
 265         int ctrl;
 266
 267         sc = (struct arm_tmr_softc *)arg;
 268         ctrl = get_ctrl(sc->physical);
 269         if (ctrl & GT_CTRL_INT_STAT) {
 270                 ctrl |= GT_CTRL_INT_MASK;
 271                 set_ctrl(ctrl, sc->physical);
 272         }
 273
 274         if (sc->et.et_active)
 275                 sc->et.et_event_cb(&sc->et, sc->et.et_arg);
 276
 277         return (FILTER_HANDLED);
 278 }
 279
 280 #ifdef FDT
 281 static int
 282 arm_tmr_fdt_probe(device_t dev)
 283 {
 284
 285         if (!ofw_bus_status_okay(dev))
 286                 return (ENXIO);
 287
 288         if (ofw_bus_is_compatible(dev, "arm,armv7-timer")) {
 289                 device_set_desc(dev, "ARMv7 Generic Timer");
 290                 return (BUS_PROBE_DEFAULT);
 291         } else if (ofw_bus_is_compatible(dev, "arm,armv8-timer")) {
 292                 device_set_desc(dev, "ARMv8 Generic Timer");
 293                 return (BUS_PROBE_DEFAULT);
 294         }
 295
 296         return (ENXIO);
 297 }
 298 #endif
 299
 300 #ifdef DEV_ACPI
 301 static void
 302 arm_tmr_acpi_identify(driver_t *driver, device_t parent)
 303 {
 304         ACPI_TABLE_GTDT *gtdt;
 305         vm_paddr_t physaddr;
 306         device_t dev;
 307
 308         physaddr = acpi_find_table(ACPI_SIG_GTDT);
 309         if (physaddr == 0)
 310                 return;
 311
 312         gtdt = acpi_map_table(physaddr, ACPI_SIG_GTDT);
 313         if (gtdt == NULL) {
 314                 device_printf(parent, "gic: Unable to map the GTDT\n");
 315                 return;
 316         }
 317
 318         dev = BUS_ADD_CHILD(parent, BUS_PASS_TIMER + BUS_PASS_ORDER_MIDDLE,
 319             "generic_timer", -1);
 320         if (dev == NULL) {
 321                 device_printf(parent, "add gic child failed\n");
 322                 goto out;
 323         }
 324
 325         BUS_SET_RESOURCE(parent, dev, SYS_RES_IRQ, 0,
 326             gtdt->SecureEl1Interrupt, 1);
 327         BUS_SET_RESOURCE(parent, dev, SYS_RES_IRQ, 1,
 328             gtdt->NonSecureEl1Interrupt, 1);
 329         BUS_SET_RESOURCE(parent, dev, SYS_RES_IRQ, 2,
 330             gtdt->VirtualTimerInterrupt, 1);
 331
 332 out:
 333         acpi_unmap_table(gtdt);
 334 }
 335
 336 static int
 337 arm_tmr_acpi_probe(device_t dev)
 338 {
 339
 340         device_set_desc(dev, "ARM Generic Timer");
 341         return (BUS_PROBE_NOWILDCARD);
 342 }
 343 #endif
 344
 345
 346 static int
 347 arm_tmr_attach(device_t dev)
 348 {
 349         struct arm_tmr_softc *sc;
 350 #ifdef FDT
 351         phandle_t node;
 352         pcell_t clock;
 353 #endif
 354         int error;
 355         int i;
 356
 357         sc = device_get_softc(dev);
 358         if (arm_tmr_sc)
 359                 return (ENXIO);
 360
 361 #ifdef FDT
 362         /* Get the base clock frequency */
 363         node = ofw_bus_get_node(dev);
 364         if (node > 0) {
 365                 error = OF_getencprop(node, "clock-frequency", &clock,
 366                     sizeof(clock));
 367                 if (error > 0)
 368                         sc->clkfreq = clock;
 369         }
 370 #endif
 371
 372         if (sc->clkfreq == 0) {
 373                 /* Try to get clock frequency from timer */
 374                 sc->clkfreq = get_freq();
 375         }
 376
 377         if (sc->clkfreq == 0) {
 378                 device_printf(dev, "No clock frequency specified\n");
 379                 return (ENXIO);
 380         }
 381
 382         if (bus_alloc_resources(dev, timer_spec, sc->res)) {
 383                 device_printf(dev, "could not allocate resources\n");
 384                 return (ENXIO);
 385         }
 386
 387 #ifdef __arm__
 388         sc->physical = true;
 389 #else /* __aarch64__ */
 390         sc->physical = false;
 391 #endif
 392
 393         arm_tmr_sc = sc;
 394
 395         /* Setup secure, non-secure and virtual IRQs handler */
 396         for (i = 0; i < 3; i++) {
 397                 error = bus_setup_intr(dev, sc->res[i], INTR_TYPE_CLK,
 398                     arm_tmr_intr, NULL, sc, &sc->ihl[i]);
 399                 if (error) {
 400                         device_printf(dev, "Unable to alloc int resource.\n");
 401                         return (ENXIO);
 402                 }
 403         }
 404
 405         arm_cpu_fill_vdso_timehands = arm_tmr_fill_vdso_timehands;
 406
 407         arm_tmr_timecount.tc_frequency = sc->clkfreq;
 408         tc_init(&arm_tmr_timecount);
 409
 410         sc->et.et_name = "ARM MPCore Eventtimer";
 411         sc->et.et_flags = ET_FLAGS_ONESHOT | ET_FLAGS_PERCPU;
 412         sc->et.et_quality = 1000;
 413
 414         sc->et.et_frequency = sc->clkfreq;
 415         sc->et.et_min_period = (0x00000002LLU << 32) / sc->et.et_frequency;
 416         sc->et.et_max_period = (0xfffffffeLLU << 32) / sc->et.et_frequency;
 417         sc->et.et_start = arm_tmr_start;
 418         sc->et.et_stop = arm_tmr_stop;
 419         sc->et.et_priv = sc;
 420         et_register(&sc->et);
 421
 422         return (0);
 423 }
 424
 425 #ifdef FDT
 426 static device_method_t arm_tmr_fdt_methods[] = {
 427         DEVMETHOD(device_probe,         arm_tmr_fdt_probe),
 428         DEVMETHOD(device_attach,        arm_tmr_attach),
 429         { 0, 0 }
 430 };
 431
 432 static driver_t arm_tmr_fdt_driver = {
 433         "generic_timer",
 434         arm_tmr_fdt_methods,
 435         sizeof(struct arm_tmr_softc),
 436 };
 437
 438 static devclass_t arm_tmr_fdt_devclass;
 439
 440 EARLY_DRIVER_MODULE(timer, simplebus, arm_tmr_fdt_driver, arm_tmr_fdt_devclass,
 441     0, 0, BUS_PASS_TIMER + BUS_PASS_ORDER_MIDDLE);
 442 EARLY_DRIVER_MODULE(timer, ofwbus, arm_tmr_fdt_driver, arm_tmr_fdt_devclass,
 443     0, 0, BUS_PASS_TIMER + BUS_PASS_ORDER_MIDDLE);
 444 #endif
 445
 446 #ifdef DEV_ACPI
 447 static device_method_t arm_tmr_acpi_methods[] = {
 448         DEVMETHOD(device_identify,      arm_tmr_acpi_identify),
 449         DEVMETHOD(device_probe,         arm_tmr_acpi_probe),
 450         DEVMETHOD(device_attach,        arm_tmr_attach),
 451         { 0, 0 }
 452 };
 453
 454 static driver_t arm_tmr_acpi_driver = {
 455         "generic_timer",
 456         arm_tmr_acpi_methods,
 457         sizeof(struct arm_tmr_softc),
 458 };
 459
 460 static devclass_t arm_tmr_acpi_devclass;
 461
 462 EARLY_DRIVER_MODULE(timer, acpi, arm_tmr_acpi_driver, arm_tmr_acpi_devclass,
 463     0, 0, BUS_PASS_TIMER + BUS_PASS_ORDER_MIDDLE);
 464 #endif
 465
 466 void
 467 DELAY(int usec)
 468 {
 469         int32_t counts, counts_per_usec;
 470         uint32_t first, last;
 471
 472         /*
 473          * Check the timers are setup, if not just
 474          * use a for loop for the meantime
 475          */
 476         if (arm_tmr_sc == NULL) {
 477                 for (; usec > 0; usec--)
 478                         for (counts = 200; counts > 0; counts--)
 479                                 /*
 480                                  * Prevent the compiler from optimizing
 481                                  * out the loop
 482                                  */
 483                                 cpufunc_nullop();
 484                 return;
 485         }
 486
 487         /* Get the number of times to count */
 488         counts_per_usec = ((arm_tmr_timecount.tc_frequency / 1000000) + 1);
 489
 490         /*
 491          * Clamp the timeout at a maximum value (about 32 seconds with
 492          * a 66MHz clock). *Nobody* should be delay()ing for anywhere
 493          * near that length of time and if they are, they should be hung
 494          * out to dry.
 495          */
 496         if (usec >= (0x80000000U / counts_per_usec))
 497                 counts = (0x80000000U / counts_per_usec) - 1;
 498         else
 499                 counts = usec * counts_per_usec;
 500
 501         first = get_cntxct(arm_tmr_sc->physical);
 502
 503         while (counts > 0) {
 504                 last = get_cntxct(arm_tmr_sc->physical);
 505                 counts -= (int32_t)(last - first);
 506                 first = last;
 507         }
 508 }
 509
 510 static uint32_t
 511 arm_tmr_fill_vdso_timehands(struct vdso_timehands *vdso_th,
 512     struct timecounter *tc)
 513 {
 514
 515         vdso_th->th_physical = arm_tmr_sc->physical;
 516         bzero(vdso_th->th_res, sizeof(vdso_th->th_res));
 517         return (tc == &arm_tmr_timecount);
 518 }