sys/sparc64/sparc64/eeprom.c

   1 /*-
   2  * Copyright (c) 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1994 Gordon W. Ross
   5  * Copyright (c) 1993 Adam Glass
   6  * Copyright (c) 1996 Paul Kranenburg
   7  * Copyright (c) 1996
   8  *      The President and Fellows of Harvard College. All rights reserved.
   9  *
  10  * This software was developed by the Computer Systems Engineering group
  11  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
  12  * contributed to Berkeley.
  13  *
  14  * All advertising materials mentioning features or use of this software
  15  * must display the following acknowledgement:
  16  *      This product includes software developed by Harvard University.
  17  *
  18  * Redistribution and use in source and binary forms, with or without
  19  * modification, are permitted provided that the following conditions
  20  * are met:
  21  *
  22  * 1. Redistributions of source code must retain the above copyright
  23  *    notice, this list of conditions and the following disclaimer.
  24  * 2. Redistributions in binary form must reproduce the above copyright
  25  *    notice, this list of conditions and the following disclaimer in the
  26  *    documentation and/or other materials provided with the distribution.
  27  * 3. All advertising materials mentioning features or use of this software
  28  *    must display the following acknowledgement:
  29  *      This product includes software developed by Paul Kranenburg.
  30  *      This product includes software developed by Harvard University.
  31  * 4. Neither the name of the University nor the names of its contributors
  32  *    may be used to endorse or promote products derived from this software
  33  *    without specific prior written permission.
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  36  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  38  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  39  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  40  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  41  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  42  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  43  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  44  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  45  * SUCH DAMAGE.
  46  *
  47  *      from: @(#)clock.c       8.1 (Berkeley) 6/11/93
  48  *      from: NetBSD: clock.c,v 1.41 2001/07/24 19:29:25 eeh Exp
  49  */
  50
  51 #include <sys/cdefs.h>
  52 __FBSDID("$FreeBSD$");
  53
  54 /*
  55  * clock (eeprom) attaches at EBus, FireHose or SBus
  56  */
  57
  58 #include <sys/param.h>
  59 #include <sys/systm.h>
  60 #include <sys/bus.h>
  61 #include <sys/eventhandler.h>
  62 #include <sys/kernel.h>
  63 #include <sys/lock.h>
  64 #include <sys/module.h>
  65 #include <sys/mutex.h>
  66 #include <sys/resource.h>
  67
  68 #include <dev/ofw/ofw_bus.h>
  69
  70 #include <machine/bus.h>
  71 #include <machine/idprom.h>
  72 #include <machine/resource.h>
  73
  74 #include <sys/rman.h>
  75
  76 #include <dev/mk48txx/mk48txxvar.h>
  77
  78 #include "clock_if.h"
  79
  80 #define IDPROM_OFFSET   40
  81
  82 static devclass_t eeprom_devclass;
  83
  84 static device_probe_t eeprom_probe;
  85 static device_attach_t eeprom_attach;
  86
  87 static device_method_t eeprom_methods[] = {
  88         /* Device interface */
  89         DEVMETHOD(device_probe,         eeprom_probe),
  90         DEVMETHOD(device_attach,        eeprom_attach),
  91
  92         /* clock interface */
  93         DEVMETHOD(clock_gettime,        mk48txx_gettime),
  94         DEVMETHOD(clock_settime,        mk48txx_settime),
  95
  96         { 0, 0 }
  97 };
  98
  99 static driver_t eeprom_driver = {
 100         "eeprom",
 101         eeprom_methods,
 102         sizeof(struct mk48txx_softc),
 103 };
 104
 105 DRIVER_MODULE(eeprom, ebus, eeprom_driver, eeprom_devclass, 0, 0);
 106 DRIVER_MODULE(eeprom, fhc, eeprom_driver, eeprom_devclass, 0, 0);
 107 DRIVER_MODULE(eeprom, sbus, eeprom_driver, eeprom_devclass, 0, 0);
 108
 109 static int
 110 eeprom_probe(device_t dev)
 111 {
 112
 113         if (strcmp("eeprom", ofw_bus_get_name(dev)) == 0) {
 114                 device_set_desc(dev, "EEPROM/clock");
 115                 return (0);
 116         }
 117         return (ENXIO);
 118 }
 119
 120 static int
 121 eeprom_attach(device_t dev)
 122 {
 123         struct mk48txx_softc *sc;
 124         struct resource *res;
 125         struct timespec ts;
 126         uint32_t h;
 127         int error, i, rid;
 128
 129         sc = device_get_softc(dev);
 130
 131         mtx_init(&sc->sc_mtx, "eeprom_mtx", NULL, MTX_DEF);
 132
 133         rid = 0;
 134         res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 135         if (res == NULL) {
 136                 device_printf(dev, "cannot allocate resources\n");
 137                 error = ENXIO;
 138                 goto fail_mtx;
 139         }
 140         sc->sc_bst = rman_get_bustag(res);
 141         sc->sc_bsh = rman_get_bushandle(res);
 142
 143         if ((sc->sc_model = ofw_bus_get_model(dev)) == NULL) {
 144                 device_printf(dev, "cannot determine model\n");
 145                 error = ENXIO;
 146                 goto fail_res;
 147         }
 148
 149         /* Our TOD clock year 0 is 1968 */
 150         sc->sc_year0 = 1968;
 151         /* Use default register read/write functions. */
 152         sc->sc_flag = 0;
 153         if ((error = mk48txx_attach(dev)) != 0) {
 154                 device_printf(dev, "cannot attach time of day clock\n");
 155                 goto fail_res;
 156         }
 157
 158         /*
 159          * Get the hostid from the NVRAM. This serves no real purpose other
 160          * than being able to display it below as not all sparc64 models
 161          * have an `eeprom' device and even some that do store the hostid
 162          * elsewhere. The hostid in the NVRAM of the MK48Txx reads all zero
 163          * on the latter models. A generic way to retrieve the hostid is to
 164          * use the `idprom' node.
 165          */
 166         mtx_lock(&sc->sc_mtx);
 167         h = bus_space_read_1(sc->sc_bst, sc->sc_bsh, sc->sc_nvramsz -
 168             IDPROM_OFFSET + offsetof(struct idprom, id_machine)) << 24;
 169         for (i = 0; i < 3; i++) {
 170                 h |= bus_space_read_1(sc->sc_bst, sc->sc_bsh, sc->sc_nvramsz -
 171                     IDPROM_OFFSET + offsetof(struct idprom, id_hostid[i])) <<
 172                     ((2 - i) * 8);
 173         }
 174         mtx_unlock(&sc->sc_mtx);
 175         if (h != 0)
 176                 device_printf(dev, "hostid %x\n", (u_int)h);
 177
 178         if (bootverbose) {
 179                 mk48txx_gettime(dev, &ts);
 180                 device_printf(dev, "current time: %ld.%09ld\n", (long)ts.tv_sec,
 181                     ts.tv_nsec);
 182         }
 183
 184         return (0);
 185
 186  fail_res:
 187         bus_release_resource(dev, SYS_RES_MEMORY, rid, res);
 188  fail_mtx:
 189         mtx_destroy(&sc->sc_mtx);
 190
 191         return (error);
 192 }