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/resource.h>
72#include <machine/ver.h>
73
74#include <sys/rman.h>
75
76#include <dev/mk48txx/mk48txxvar.h>
77
78#include "clock_if.h"
79
80static devclass_t eeprom_devclass;
81
82static device_probe_t eeprom_probe;
83static device_attach_t eeprom_attach;
84
85static device_method_t eeprom_methods[] = {
86	/* Device interface */
87	DEVMETHOD(device_probe,		eeprom_probe),
88	DEVMETHOD(device_attach,	eeprom_attach),
89
90	/* clock interface */
91	DEVMETHOD(clock_gettime,	mk48txx_gettime),
92	DEVMETHOD(clock_settime,	mk48txx_settime),
93
94	DEVMETHOD_END
95};
96
97static driver_t eeprom_driver = {
98	"eeprom",
99	eeprom_methods,
100	sizeof(struct mk48txx_softc),
101};
102
103DRIVER_MODULE(eeprom, ebus, eeprom_driver, eeprom_devclass, 0, 0);
104DRIVER_MODULE(eeprom, fhc, eeprom_driver, eeprom_devclass, 0, 0);
105DRIVER_MODULE(eeprom, sbus, eeprom_driver, eeprom_devclass, 0, 0);
106
107static int
108eeprom_probe(device_t dev)
109{
110	const char *name;
111
112	name = ofw_bus_get_name(dev);
113	if (strcmp(name, "eeprom") == 0 ||
114	    strcmp(name, "FJSV,eeprom") == 0) {
115		device_set_desc(dev, "EEPROM/clock");
116		return (0);
117	}
118	return (ENXIO);
119}
120
121static int
122eeprom_attach(device_t dev)
123{
124	struct mk48txx_softc *sc;
125	struct timespec ts;
126	int error, rid;
127
128	sc = device_get_softc(dev);
129
130	mtx_init(&sc->sc_mtx, "eeprom_mtx", NULL, MTX_DEF);
131
132	rid = 0;
133	sc->sc_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
134	    RF_ACTIVE);
135	if (sc->sc_res == NULL) {
136		device_printf(dev, "cannot allocate resources\n");
137		error = ENXIO;
138		goto fail_mtx;
139	}
140
141	if ((sc->sc_model = ofw_bus_get_model(dev)) == NULL) {
142		device_printf(dev, "cannot determine model\n");
143		error = ENXIO;
144		goto fail_res;
145	}
146
147	/* Our TOD clock year 0 is 1968. */
148	sc->sc_year0 = 1968;
149	/* Use default register read/write functions. */
150	sc->sc_flag = 0;
151	/*
152	 * Generally, if the `eeprom' node has a `watchdog-enable' property
153	 * this indicates that the watchdog part of the MK48T59 is usable,
154	 * i.e. its RST pin is connected to the WDR input of the CPUs or
155	 * something. The `eeprom' nodes of E250, E450 and the clock board
156	 * variant in Exx00 have such properties. For E250 and E450 the
157	 * watchdog just works, for Exx00 the delivery of the reset signal
158	 * apparently has to be additionally enabled elsewhere...
159	 * The OFW environment variable `watchdog-reboot?' is ignored for
160	 * these watchdogs as they always trigger a system reset when they
161	 * time out and can't be made to issue a break to the boot monitor
162	 * instead.
163	 */
164	if (OF_getproplen(ofw_bus_get_node(dev), "watchdog-enable") != -1 &&
165	    (strcmp(sparc64_model, "SUNW,Ultra-250") == 0 ||
166	    strcmp(sparc64_model, "SUNW,Ultra-4") == 0))
167		sc->sc_flag |= MK48TXX_WDOG_REGISTER | MK48TXX_WDOG_ENABLE_WDS;
168	if ((error = mk48txx_attach(dev)) != 0) {
169		device_printf(dev, "cannot attach time of day clock\n");
170		goto fail_res;
171	}
172
173	if (bootverbose) {
174		if (mk48txx_gettime(dev, &ts) != 0)
175			device_printf(dev, "invalid time");
176		else
177			device_printf(dev, "current time: %ld.%09ld\n",
178			    (long)ts.tv_sec, ts.tv_nsec);
179	}
180
181	return (0);
182
183 fail_res:
184	bus_release_resource(dev, SYS_RES_MEMORY, rid, sc->sc_res);
185 fail_mtx:
186	mtx_destroy(&sc->sc_mtx);
187
188	return (error);
189}
190