sys/sparc64/sparc64/rtc.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2004 Marius Strobl <marius@FreeBSD.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 /*
  33  * The `rtc' device is found on the ISA bus and the EBus.  The ISA version
  34  * always is a MC146818 compatible clock while the EBus variant either is the
  35  * MC146818 compatible Real-Time Clock function of a National Semiconductor
  36  * PC87317/PC97317 which also provides Advanced Power Control functionality
  37  * or a Texas Instruments bq4802.
  38  */
  39
  40 #include "opt_isa.h"
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/bus.h>
  45 #include <sys/kernel.h>
  46 #include <sys/lock.h>
  47 #include <sys/module.h>
  48 #include <sys/mutex.h>
  49 #include <sys/resource.h>
  50
  51 #include <dev/ofw/ofw_bus.h>
  52
  53 #include <machine/bus.h>
  54 #include <machine/resource.h>
  55
  56 #include <sys/rman.h>
  57
  58 #include <isa/isavar.h>
  59
  60 #include <dev/mc146818/mc146818reg.h>
  61 #include <dev/mc146818/mc146818var.h>
  62
  63 #include "clock_if.h"
  64
  65 #define RTC_DESC        "Real-Time Clock"
  66
  67 #define RTC_READ        mc146818_def_read
  68 #define RTC_WRITE       mc146818_def_write
  69
  70 #define PC87317_COMMON          MC_REGA_DV0     /* bank 0 */
  71 #define PC87317_RTC             (MC_REGA_DV1 | MC_REGA_DV0) /* bank 1 */
  72 #define PC87317_RTC_CR          0x48            /* Century Register */
  73 #define PC87317_APC             MC_REGA_DV2     /* bank 2 */
  74 #define PC87317_APC_CADDR       0x51            /* Century Address Register */
  75 #define PC87317_APC_CADDR_BANK0 0x00            /* locate CR in bank 0 */
  76 #define PC87317_APC_CADDR_BANK1 0x80            /* locate CR in bank 1 */
  77
  78 static devclass_t rtc_devclass;
  79
  80 static device_attach_t rtc_attach;
  81 static device_probe_t rtc_ebus_probe;
  82 #ifdef DEV_ISA
  83 static device_probe_t rtc_isa_probe;
  84 #endif
  85
  86 static device_method_t rtc_ebus_methods[] = {
  87         /* Device interface */
  88         DEVMETHOD(device_probe,         rtc_ebus_probe),
  89         DEVMETHOD(device_attach,        rtc_attach),
  90
  91         /* clock interface */
  92         DEVMETHOD(clock_gettime,        mc146818_gettime),
  93         DEVMETHOD(clock_settime,        mc146818_settime),
  94
  95         DEVMETHOD_END
  96 };
  97
  98 static driver_t rtc_ebus_driver = {
  99         "rtc",
 100         rtc_ebus_methods,
 101         sizeof(struct mc146818_softc),
 102 };
 103
 104 DRIVER_MODULE(rtc, ebus, rtc_ebus_driver, rtc_devclass, 0, 0);
 105
 106 #ifdef DEV_ISA
 107 static device_method_t rtc_isa_methods[] = {
 108         /* Device interface */
 109         DEVMETHOD(device_probe,         rtc_isa_probe),
 110         DEVMETHOD(device_attach,        rtc_attach),
 111
 112         /* clock interface */
 113         DEVMETHOD(clock_gettime,        mc146818_gettime),
 114         DEVMETHOD(clock_settime,        mc146818_settime),
 115
 116         DEVMETHOD_END
 117 };
 118
 119 static driver_t rtc_isa_driver = {
 120         "rtc",
 121         rtc_isa_methods,
 122         sizeof(struct mc146818_softc),
 123 };
 124
 125 DRIVER_MODULE(rtc, isa, rtc_isa_driver, rtc_devclass, 0, 0);
 126 #endif
 127
 128 static u_int pc87317_getcent(device_t dev);
 129 static void pc87317_setcent(device_t dev, u_int cent);
 130
 131 static int
 132 rtc_ebus_probe(device_t dev)
 133 {
 134
 135         if (strcmp(ofw_bus_get_name(dev), "rtc") == 0) {
 136                 /* The bq4802 is not supported, yet. */
 137                 if (ofw_bus_get_compat(dev) != NULL &&
 138                     strcmp(ofw_bus_get_compat(dev), "bq4802") == 0)
 139                         return (ENXIO);
 140                 device_set_desc(dev, RTC_DESC);
 141                 return (0);
 142         }
 143
 144         return (ENXIO);
 145 }
 146
 147 #ifdef DEV_ISA
 148 static struct isa_pnp_id rtc_isa_ids[] = {
 149         { 0x000bd041, RTC_DESC }, /* PNP0B00 */
 150         { 0 }
 151 };
 152
 153 static int
 154 rtc_isa_probe(device_t dev)
 155 {
 156
 157         if (ISA_PNP_PROBE(device_get_parent(dev), dev, rtc_isa_ids) == 0)
 158                 return (0);
 159
 160         return (ENXIO);
 161 }
 162 #endif
 163
 164 static int
 165 rtc_attach(device_t dev)
 166 {
 167         struct timespec ts;
 168         struct mc146818_softc *sc;
 169         struct resource *res;
 170         int ebus, error, rid;
 171
 172         sc = device_get_softc(dev);
 173
 174         mtx_init(&sc->sc_mtx, "rtc_mtx", NULL, MTX_SPIN);
 175
 176         ebus = 0;
 177         if (strcmp(device_get_name(device_get_parent(dev)), "ebus") == 0)
 178                 ebus = 1;
 179
 180         rid = 0;
 181         res = bus_alloc_resource_any(dev, ebus ? SYS_RES_MEMORY :
 182             SYS_RES_IOPORT, &rid, RF_ACTIVE);
 183         if (res == NULL) {
 184                 device_printf(dev, "cannot allocate resources\n");
 185                 error = ENXIO;
 186                 goto fail_mtx;
 187         }
 188         sc->sc_bst = rman_get_bustag(res);
 189         sc->sc_bsh = rman_get_bushandle(res);
 190
 191         sc->sc_mcread = RTC_READ;
 192         sc->sc_mcwrite = RTC_WRITE;
 193         /* The TOD clock year 0 is 0. */
 194         sc->sc_year0 = 0;
 195         /*
 196          * For ISA use the default century get/set functions, for EBus we
 197          * provide our own versions.
 198          */
 199         sc->sc_flag = MC146818_NO_CENT_ADJUST;
 200         if (ebus) {
 201                 /*
 202                  * Make sure the CR is at the default location (also used
 203                  * by Solaris).
 204                  */
 205                 RTC_WRITE(dev, MC_REGA, PC87317_APC);
 206                 RTC_WRITE(dev, PC87317_APC_CADDR, PC87317_APC_CADDR_BANK1 |
 207                     PC87317_RTC_CR);
 208                 RTC_WRITE(dev, MC_REGA, PC87317_COMMON);
 209                 sc->sc_getcent = pc87317_getcent;
 210                 sc->sc_setcent = pc87317_setcent;
 211         }
 212         if ((error = mc146818_attach(dev)) != 0) {
 213                 device_printf(dev, "cannot attach time of day clock\n");
 214                 goto fail_res;
 215         }
 216
 217         if (bootverbose) {
 218                 if (mc146818_gettime(dev, &ts) != 0)
 219                         device_printf(dev, "invalid time");
 220                 else
 221                         device_printf(dev, "current time: %ld.%09ld\n",
 222                             (long)ts.tv_sec, ts.tv_nsec);
 223         }
 224
 225         return (0);
 226
 227  fail_res:
 228         bus_release_resource(dev, ebus ? SYS_RES_MEMORY : SYS_RES_IOPORT, rid,
 229             res);
 230  fail_mtx:
 231         mtx_destroy(&sc->sc_mtx);
 232
 233         return (error);
 234 }
 235
 236 static u_int
 237 pc87317_getcent(device_t dev)
 238 {
 239         u_int cent;
 240
 241         RTC_WRITE(dev, MC_REGA, PC87317_RTC);
 242         cent = RTC_READ(dev, PC87317_RTC_CR);
 243         RTC_WRITE(dev, MC_REGA, PC87317_COMMON);
 244         return (cent);
 245 }
 246
 247 static void
 248 pc87317_setcent(device_t dev, u_int cent)
 249 {
 250
 251         RTC_WRITE(dev, MC_REGA, PC87317_RTC);
 252         RTC_WRITE(dev, PC87317_RTC_CR, cent);
 253         RTC_WRITE(dev, MC_REGA, PC87317_COMMON);
 254 }