1 /* $NetBSD: mcclock_mace.c,v 1.17 2015/02/18 16:47:59 macallan Exp $ */
2
3 /*
4 * Copyright (c) 2001 Antti Kantee. All Rights Reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the company nor the name of the author may be used to
15 * endorse or promote products derived from this software without specific
16 * prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY CAUASLITY LIMITED ``AS IS'' AND ANY EXPRESS
19 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL CAUSALITY LIMITED OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 */
30
31 /*
32 * Copyright (c) 1998 Mark Brinicombe.
33 * Copyright (c) 1998 Causality Limited.
34 * All rights reserved.
35 *
36 * Written by Mark Brinicombe, Causality Limited
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed by Mark Brinicombe
49 * for the NetBSD Project.
50 * 4. The name of the company nor the name of the author may be used to
51 * endorse or promote products derived from this software without specific
52 * prior written permission.
53 *
54 * THIS SOFTWARE IS PROVIDED BY CAUASLITY LIMITED ``AS IS'' AND ANY EXPRESS
55 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
56 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
57 * DISCLAIMED. IN NO EVENT SHALL CAUSALITY LIMITED OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
60 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * SUCH DAMAGE.
65 */
66
67 #include <sys/cdefs.h>
68 __KERNEL_RCSID(0, "$NetBSD: mcclock_mace.c,v 1.17 2015/02/18 16:47:59 macallan Exp $");
69
70 #include <sys/param.h>
71 #include <sys/systm.h>
72 #include <sys/device.h>
73
74 #include <machine/cpu.h>
75 #include <machine/autoconf.h>
76 #include <sys/bus.h>
77 #include <machine/machtype.h>
78
79 #include <dev/clock_subr.h>
80 #include <dev/ic/ds1687reg.h>
81
82 #include <sgimips/mace/macevar.h>
83
84 #include <sgimips/sgimips/clockvar.h>
85
86 struct mcclock_mace_softc {
87 device_t sc_dev;
88
89 struct todr_chip_handle sc_todrch;
90
91 bus_space_tag_t sc_st;
92 bus_space_handle_t sc_sh;
93 };
94
95 static struct mcclock_mace_softc *mace0 = NULL;
96
97 static int mcclock_mace_match(device_t, cfdata_t, void *);
98 static void mcclock_mace_attach(device_t, device_t, void *);
99
100 static int mcclock_mace_gettime_ymdhms(todr_chip_handle_t,
101 struct clock_ymdhms *);
102 static int mcclock_mace_settime_ymdhms(todr_chip_handle_t,
103 struct clock_ymdhms *);
104
105 unsigned int ds1687_read(void *arg, unsigned int addr);
106 void ds1687_write(void *arg, unsigned int addr, unsigned int data);
107
108 void mcclock_poweroff(void);
109
110
111 CFATTACH_DECL_NEW(mcclock_mace, sizeof(struct mcclock_mace_softc),
112 mcclock_mace_match, mcclock_mace_attach, NULL, NULL);
113
114 static int
mcclock_mace_match(device_t parent,cfdata_t cf,void * aux)115 mcclock_mace_match(device_t parent, cfdata_t cf, void *aux)
116 {
117
118 return 1;
119 }
120
121 void
mcclock_mace_attach(device_t parent,device_t self,void * aux)122 mcclock_mace_attach(device_t parent, device_t self, void *aux)
123 {
124 struct mcclock_mace_softc *sc = device_private(self);
125 struct mace_attach_args *maa = aux;
126
127 sc->sc_dev = self;
128 sc->sc_st = maa->maa_st;
129 /* XXX should be bus_space_map() */
130 if (bus_space_subregion(maa->maa_st, maa->maa_sh,
131 maa->maa_offset, 0, &sc->sc_sh))
132 panic("mcclock_mace_attach: couldn't map");
133
134 /*
135 * We want a fixed format: 24-hour, BCD data, so just force the
136 * RTC to this mode; if there was junk there we'll be able to
137 * fix things up later when we discover the time read back is
138 * no good.
139 */
140 ds1687_write(sc, DS1687_CONTROLA, DS1687_DV1 | DS1687_BANK1);
141 ds1687_write(sc, DS1687_CONTROLB, DS1687_24HRS);
142
143 /* XXXrkb: init kickstart/wakeup stuff */
144
145 if (!(ds1687_read(sc, DS1687_CONTROLD) & DS1687_VRT))
146 printf(": lithium cell is dead, RTC unreliable");
147
148 printf("\n");
149
150 sc->sc_todrch.cookie = sc;
151 sc->sc_todrch.todr_gettime_ymdhms = mcclock_mace_gettime_ymdhms;
152 sc->sc_todrch.todr_settime_ymdhms = mcclock_mace_settime_ymdhms;
153 sc->sc_todrch.todr_setwen = NULL;
154
155 todr_attach(&sc->sc_todrch);
156 mace0 = sc;
157 }
158
159 /*
160 * We need to use the following two functions from
161 * DS1687_PUT/GETTOD(). Hence the names.
162 */
163 unsigned int
ds1687_read(void * arg,unsigned int addr)164 ds1687_read(void *arg, unsigned int addr)
165 {
166 struct mcclock_mace_softc *sc = arg;
167
168 return bus_space_read_1(sc->sc_st, sc->sc_sh, (addr << 8) + 7);
169 }
170
171 void
ds1687_write(void * arg,unsigned int addr,unsigned int data)172 ds1687_write(void *arg, unsigned int addr, unsigned int data)
173 {
174 struct mcclock_mace_softc *sc = arg;
175
176 bus_space_write_1(sc->sc_st, sc->sc_sh, (addr << 8) + 7, data);
177 }
178
179 static int
mcclock_mace_gettime_ymdhms(todr_chip_handle_t todrch,struct clock_ymdhms * dt)180 mcclock_mace_gettime_ymdhms(todr_chip_handle_t todrch, struct clock_ymdhms *dt)
181 {
182 struct mcclock_mace_softc *sc = todrch->cookie;
183 ds1687_todregs regs;
184 int s;
185
186 s = splhigh();
187 DS1687_GETTOD(sc, ®s);
188 splx(s);
189
190 dt->dt_sec = bcdtobin(regs[DS1687_SOFT_SEC]);
191 dt->dt_min = bcdtobin(regs[DS1687_SOFT_MIN]);
192 dt->dt_hour = bcdtobin(regs[DS1687_SOFT_HOUR]);
193 dt->dt_wday = bcdtobin(regs[DS1687_SOFT_DOW]);
194 dt->dt_day = bcdtobin(regs[DS1687_SOFT_DOM]);
195 dt->dt_mon = bcdtobin(regs[DS1687_SOFT_MONTH]);
196 dt->dt_year = bcdtobin(regs[DS1687_SOFT_YEAR]) +
197 (100 * bcdtobin(regs[DS1687_SOFT_CENTURY]));
198
199 return 0;
200 }
201
202 static int
mcclock_mace_settime_ymdhms(todr_chip_handle_t todrch,struct clock_ymdhms * dt)203 mcclock_mace_settime_ymdhms(todr_chip_handle_t todrch, struct clock_ymdhms *dt)
204 {
205 struct mcclock_mace_softc *sc = todrch->cookie;
206 ds1687_todregs regs;
207 int s;
208
209 memset(®s, 0, sizeof(regs));
210
211 regs[DS1687_SOFT_SEC] = bintobcd(dt->dt_sec);
212 regs[DS1687_SOFT_MIN] = bintobcd(dt->dt_min);
213 regs[DS1687_SOFT_HOUR] = bintobcd(dt->dt_hour);
214 regs[DS1687_SOFT_DOW] = bintobcd(dt->dt_wday);
215 regs[DS1687_SOFT_DOM] = bintobcd(dt->dt_day);
216 regs[DS1687_SOFT_MONTH] = bintobcd(dt->dt_mon);
217 regs[DS1687_SOFT_YEAR] = bintobcd(dt->dt_year % 100);
218 regs[DS1687_SOFT_CENTURY] = bintobcd(dt->dt_year / 100);
219 s = splhigh();
220 DS1687_PUTTOD(sc, ®s);
221 splx(s);
222
223 return 0;
224 }
225
226 void
mcclock_poweroff(void)227 mcclock_poweroff(void)
228 {
229 uint8_t a, xctl_a, xctl_b;
230
231 if (mace0 == NULL)
232 return;
233
234 (void)splhigh();
235 a = ds1687_read(mace0, DS1687_CONTROLA);
236 a &= ~DS1687_DV2;
237 a |= DS1687_DV1;
238 ds1687_write(mace0, DS1687_CONTROLA, a | DS1687_BANK1);
239 wbflush();
240
241 xctl_b = ds1687_read(mace0, DS1687_BANK1_XCTRL4B);
242 xctl_b |= DS1687_X4B_ABE | DS1687_X4B_KIE;
243 ds1687_write(mace0, DS1687_BANK1_XCTRL4B, xctl_b);
244
245 xctl_a = ds1687_read(mace0, DS1687_BANK1_XCTRL4A);
246 xctl_a &= ~(DS1687_X4A_RCF | DS1687_X4A_WAF | DS1687_X4A_KF);
247 ds1687_write(mace0, DS1687_BANK1_XCTRL4A, xctl_a);
248 wbflush();
249
250 /* and down we go */
251 ds1687_write(mace0, DS1687_BANK1_XCTRL4A, xctl_a | DS1687_X4A_PAB);
252 ds1687_write(mace0, DS1687_CONTROLA, a);
253 wbflush();
254 for (;;)
255 ;
256 }
257