sys/sparc64/sparc64/rtc.c

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