mkclock.c revision 1.1
1/*	$NetBSD: mkclock.c,v 1.1 2006/11/09 15:08:04 tsutsui Exp $ */
2
3/*
4 * Copyright (c) 1992, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 * Copyright (c) 1994 Gordon W. Ross
7 * Copyright (c) 1993 Adam Glass
8 * Copyright (c) 1996 Paul Kranenburg
9 * Copyright (c) 1996
10 * 	The President and Fellows of Harvard College. All rights reserved.
11 *
12 * This software was developed by the Computer Systems Engineering group
13 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
14 * contributed to Berkeley.
15 *
16 * All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 *	This product includes software developed by Harvard University.
19 *	This product includes software developed by the University of
20 *	California, Lawrence Berkeley Laboratory.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 *
26 * 1. Redistributions of source code must retain the above copyright
27 *    notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 *    notice, this list of conditions and the following disclaimer in the
30 *    documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 *    must display the following acknowledgement:
33 *	This product includes software developed by the University of
34 *	California, Berkeley and its contributors.
35 *	This product includes software developed by Paul Kranenburg.
36 *	This product includes software developed by Harvard University.
37 * 4. Neither the name of the University nor the names of its contributors
38 *    may be used to endorse or promote products derived from this software
39 *    without specific prior written permission.
40 *
41 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
52 *
53 *	@(#)clock.c	8.1 (Berkeley) 6/11/93
54 *
55 */
56
57#include <sys/cdefs.h>
58__KERNEL_RCSID(0, "$NetBSD: mkclock.c,v 1.1 2006/11/09 15:08:04 tsutsui Exp $");
59
60/*
61 * Clock driver for 'mkclock' - Mostek MK48Txx TOD clock.
62 */
63
64#include <sys/param.h>
65#include <sys/kernel.h>
66#include <sys/device.h>
67#include <sys/proc.h>
68#include <sys/resourcevar.h>
69#include <sys/malloc.h>
70#include <sys/systm.h>
71
72#include <uvm/uvm_extern.h>
73
74#include <machine/bus.h>
75#include <machine/autoconf.h>
76#include <machine/eeprom.h>
77#include <machine/cpu.h>
78
79#include <dev/clock_subr.h>
80#include <dev/ic/mk48txxreg.h>
81#include <dev/ic/mk48txxvar.h>
82
83#include <sparc64/dev/iommureg.h>
84#include <sparc64/dev/sbusreg.h>
85#include <dev/sbus/sbusvar.h>
86#include <dev/ebus/ebusreg.h>
87#include <dev/ebus/ebusvar.h>
88
89/*
90 * clock (eeprom) attaches at the sbus or the ebus (PCI)
91 */
92static int	mkclock_sbus_match(struct device *, struct cfdata *, void *);
93static void	mkclock_sbus_attach(struct device *, struct device *, void *);
94
95static int	mkclock_ebus_match(struct device *, struct cfdata *, void *);
96static void	mkclock_ebus_attach(struct device *, struct device *, void *);
97
98static void	mkclock_attach(struct mk48txx_softc *, int);
99
100static int	mkclock_wenable(struct todr_chip_handle *, int);
101
102
103CFATTACH_DECL(mkclock_sbus, sizeof(struct mk48txx_softc),
104    mkclock_sbus_match, mkclock_sbus_attach, NULL, NULL);
105
106CFATTACH_DECL(mkclock_ebus, sizeof(struct mk48txx_softc),
107    mkclock_ebus_match, mkclock_ebus_attach, NULL, NULL);
108
109/*
110 * The OPENPROM calls the clock the "eeprom", so we have to have our
111 * own special match function to call it the "clock".
112 */
113static int
114mkclock_sbus_match(struct device *parent, struct cfdata *cf, void *aux)
115{
116	struct sbus_attach_args *sa = aux;
117
118	return (strcmp("eeprom", sa->sa_name) == 0);
119}
120
121static int
122mkclock_ebus_match(struct device *parent, struct cfdata *cf, void *aux)
123{
124	struct ebus_attach_args *ea = aux;
125
126	return (strcmp("eeprom", ea->ea_name) == 0);
127}
128
129/*
130 * Attach a clock (really `eeprom') to the sbus or ebus.
131 *
132 * We ignore any existing virtual address as we need to map
133 * this read-only and make it read-write only temporarily,
134 * whenever we read or write the clock chip.  The clock also
135 * contains the ID ``PROM'', and I have already had the pleasure
136 * of reloading the CPU type, Ethernet address, etc, by hand from
137 * the console FORTH interpreter.  I intend not to enjoy it again.
138 *
139 * the MK48T02 is 2K.  the MK48T08 is 8K, and the MK48T59 is
140 * supposed to be identical to it.
141 *
142 * This is *UGLY*!  We probably have multiple mappings.  But I do
143 * know that this all fits inside an 8K page, so I'll just map in
144 * once.
145 *
146 * What we really need is some way to record the bus attach args
147 * so we can call *_bus_map() later with BUS_SPACE_MAP_READONLY
148 * or not to write enable/disable the device registers.  This is
149 * a non-trivial operation.
150 */
151
152/* ARGSUSED */
153static void
154mkclock_sbus_attach(struct device *parent, struct device *self, void *aux)
155{
156	struct mk48txx_softc *sc = (void *)self;
157	struct sbus_attach_args *sa = aux;
158	int sz;
159
160	sc->sc_bst = sa->sa_bustag;
161
162	/* use sa->sa_regs[0].size? */
163	sz = 8192;
164
165	if (sbus_bus_map(sc->sc_bst,
166			 sa->sa_slot,
167			 (sa->sa_offset & ~(PAGE_SIZE - 1)),
168			 sz,
169			 BUS_SPACE_MAP_LINEAR | BUS_SPACE_MAP_READONLY,
170			 &sc->sc_bsh) != 0) {
171		printf("%s: can't map register\n", self->dv_xname);
172		return;
173	}
174	mkclock_attach(sc, sa->sa_node);
175}
176
177
178/* ARGSUSED */
179static void
180mkclock_ebus_attach(struct device *parent, struct device *self, void *aux)
181{
182	struct mk48txx_softc *sc = (void *)self;
183	struct ebus_attach_args *ea = aux;
184	int sz;
185
186	sc->sc_bst = ea->ea_bustag;
187
188	/* hard code to 8K? */
189	sz = ea->ea_reg[0].size;
190
191	if (bus_space_map(sc->sc_bst,
192			 EBUS_ADDR_FROM_REG(&ea->ea_reg[0]),
193			 sz,
194			 BUS_SPACE_MAP_LINEAR,
195			 &sc->sc_bsh) != 0) {
196		printf("%s: can't map register\n", self->dv_xname);
197		return;
198	}
199	mkclock_attach(sc, ea->ea_node);
200}
201
202
203static void
204mkclock_attach(struct mk48txx_softc *sc, int node)
205{
206
207	sc->sc_model = prom_getpropstring(node, "model");
208
209#ifdef DIAGNOSTIC
210	if (sc->sc_model == NULL)
211		panic("clockattach: no model property");
212#endif
213
214	/* Our TOD clock year 0 is 1968 */
215	sc->sc_year0 = 1968;
216	mk48txx_attach(sc);
217
218	printf("\n");
219
220	/* Save info for the clock wenable call. */
221	sc->sc_handle.todr_setwen = mkclock_wenable;
222
223	todr_attach(&sc->sc_handle);
224}
225
226/*
227 * Write en/dis-able clock registers.  We coordinate so that several
228 * writers can run simultaneously.
229 */
230static int
231mkclock_wenable(struct todr_chip_handle *handle, int onoff)
232{
233	struct mk48txx_softc *sc;
234	vm_prot_t prot;
235	vaddr_t va;
236	int s, err = 0;
237	static int writers;
238
239	s = splhigh();
240	if (onoff)
241		prot = writers++ == 0 ? VM_PROT_READ|VM_PROT_WRITE : 0;
242	else
243		prot = --writers == 0 ? VM_PROT_READ : 0;
244	splx(s);
245	if (prot == VM_PROT_NONE) {
246		return 0;
247	}
248	sc = handle->cookie;
249	va = (vaddr_t)bus_space_vaddr(sc->sc_bst, sc->sc_bsh);
250	if (va == 0UL) {
251		printf("clock_wenable: WARNING -- cannot get va\n");
252		return EIO;
253	}
254	pmap_kprotect(va, prot);
255	return (err);
256}
257