xref: /netbsd-src/sys/arch/sparc64/dev/mkclock.c (revision 46f5119e40af2e51998f686b2fdcc76b5488f7f3)
1 /*	$NetBSD: mkclock.c,v 1.7 2011/03/12 11:42:57 nakayama 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.7 2011/03/12 11:42:57 nakayama 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 <dev/sbus/sbusvar.h>
84 #include <dev/ebus/ebusreg.h>
85 #include <dev/ebus/ebusvar.h>
86 
87 /*
88  * clock (eeprom) attaches at the sbus or the ebus (PCI)
89  */
90 static int	mkclock_sbus_match(device_t, cfdata_t, void *);
91 static void	mkclock_sbus_attach(device_t, device_t, void *);
92 
93 static int	mkclock_ebus_match(device_t, cfdata_t, void *);
94 static void	mkclock_ebus_attach(device_t, device_t, void *);
95 
96 static void	mkclock_attach(struct mk48txx_softc *, int);
97 
98 static int	mkclock_wenable(struct todr_chip_handle *, int);
99 
100 
101 CFATTACH_DECL_NEW(mkclock_sbus, sizeof(struct mk48txx_softc),
102     mkclock_sbus_match, mkclock_sbus_attach, NULL, NULL);
103 
104 CFATTACH_DECL_NEW(mkclock_ebus, sizeof(struct mk48txx_softc),
105     mkclock_ebus_match, mkclock_ebus_attach, NULL, NULL);
106 
107 /*
108  * The OPENPROM calls the clock the "eeprom", so we have to have our
109  * own special match function to call it the "clock".
110  */
111 static int
112 mkclock_sbus_match(device_t parent, cfdata_t cf, void *aux)
113 {
114 	struct sbus_attach_args *sa = aux;
115 
116 	return (strcmp("eeprom", sa->sa_name) == 0);
117 }
118 
119 static int
120 mkclock_ebus_match(device_t parent, cfdata_t cf, void *aux)
121 {
122 	struct ebus_attach_args *ea = aux;
123 
124 	return (strcmp("eeprom", ea->ea_name) == 0);
125 }
126 
127 /*
128  * Attach a clock (really `eeprom') to the sbus or ebus.
129  *
130  * We ignore any existing virtual address as we need to map
131  * this read-only and make it read-write only temporarily,
132  * whenever we read or write the clock chip.  The clock also
133  * contains the ID ``PROM'', and I have already had the pleasure
134  * of reloading the CPU type, Ethernet address, etc, by hand from
135  * the console FORTH interpreter.  I intend not to enjoy it again.
136  *
137  * the MK48T02 is 2K.  the MK48T08 is 8K, and the MK48T59 is
138  * supposed to be identical to it.
139  *
140  * This is *UGLY*!  We probably have multiple mappings.  But I do
141  * know that this all fits inside an 8K page, so I'll just map in
142  * once.
143  *
144  * What we really need is some way to record the bus attach args
145  * so we can call *_bus_map() later with BUS_SPACE_MAP_READONLY
146  * or not to write enable/disable the device registers.  This is
147  * a non-trivial operation.
148  */
149 
150 /* ARGSUSED */
151 static void
152 mkclock_sbus_attach(device_t parent, device_t self, void *aux)
153 {
154 	struct mk48txx_softc *sc = device_private(self);
155 	struct sbus_attach_args *sa = aux;
156 	int sz;
157 
158 	sc->sc_dev = self;
159 	sc->sc_bst = sa->sa_bustag;
160 
161 	/* use sa->sa_regs[0].size? */
162 	sz = 8192;
163 
164 	if (sbus_bus_map(sc->sc_bst,
165 			 sa->sa_slot,
166 			 trunc_page(sa->sa_offset),
167 			 sz,
168 			 BUS_SPACE_MAP_LINEAR | BUS_SPACE_MAP_READONLY,
169 			 &sc->sc_bsh) != 0) {
170 		aprint_error(": can't map register\n");
171 		return;
172 	}
173 	mkclock_attach(sc, sa->sa_node);
174 }
175 
176 
177 /* ARGSUSED */
178 static void
179 mkclock_ebus_attach(struct device *parent, struct device *self, void *aux)
180 {
181 	struct mk48txx_softc *sc = device_private(self);
182 	struct ebus_attach_args *ea = aux;
183 	int sz;
184 
185 	sc->sc_dev = self;
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 		aprint_error(": can't map register\n");
197 		return;
198 	}
199 	mkclock_attach(sc, ea->ea_node);
200 }
201 
202 
203 static void
204 mkclock_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 
217 	/* Save info for the clock wenable call. */
218 	sc->sc_handle.todr_setwen = mkclock_wenable;
219 
220 	mk48txx_attach(sc);
221 
222 	aprint_normal("\n");
223 }
224 
225 /*
226  * Write en/dis-able clock registers.  We coordinate so that several
227  * writers can run simultaneously.
228  */
229 static int
230 mkclock_wenable(struct todr_chip_handle *handle, int onoff)
231 {
232 	struct mk48txx_softc *sc;
233 	vm_prot_t prot;
234 	vaddr_t va;
235 	int s, err = 0;
236 	static int writers;
237 
238 	s = splhigh();
239 	if (onoff)
240 		prot = writers++ == 0 ? VM_PROT_READ|VM_PROT_WRITE : 0;
241 	else
242 		prot = --writers == 0 ? VM_PROT_READ : 0;
243 	splx(s);
244 	if (prot == VM_PROT_NONE) {
245 		return 0;
246 	}
247 	sc = handle->cookie;
248 	va = (vaddr_t)bus_space_vaddr(sc->sc_bst, sc->sc_bsh);
249 	if (va == 0UL) {
250 		printf("clock_wenable: WARNING -- cannot get va\n");
251 		return EIO;
252 	}
253 	pmap_kprotect(va, prot);
254 	return (err);
255 }
256