2 * Copyright (c) 2004 Marius Strobl <marius@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 * The `rtc' device is a MC146818 compatible clock found on the ISA
32 * bus and EBus. The EBus variant actually is the Real-Time Clock
33 * function of a National Semiconductor PC87317/PC97317 which also
34 * provides Advanced Power Control functionality.
39 #include <sys/param.h>
40 #include <sys/systm.h>
42 #include <sys/kernel.h>
44 #include <sys/module.h>
45 #include <sys/mutex.h>
46 #include <sys/resource.h>
48 #include <dev/ofw/ofw_bus.h>
50 #include <machine/bus.h>
51 #include <machine/resource.h>
55 #include <isa/isavar.h>
57 #include <dev/mc146818/mc146818reg.h>
58 #include <dev/mc146818/mc146818var.h>
62 #define RTC_DESC "Real-Time Clock"
64 #define RTC_READ mc146818_def_read
65 #define RTC_WRITE mc146818_def_write
67 #define PC87317_COMMON MC_REGA_DV0 /* bank 0 */
68 #define PC87317_RTC (MC_REGA_DV1 | MC_REGA_DV0) /* bank 1 */
69 #define PC87317_RTC_CR 0x48 /* Century Register */
70 #define PC87317_APC MC_REGA_DV2 /* bank 2 */
71 #define PC87317_APC_CADDR 0x51 /* Century Address Register */
72 #define PC87317_APC_CADDR_BANK0 0x00 /* locate CR in bank 0 */
73 #define PC87317_APC_CADDR_BANK1 0x80 /* locate CR in bank 1 */
75 static devclass_t rtc_devclass;
77 static device_attach_t rtc_attach;
78 static device_probe_t rtc_ebus_probe;
80 static device_probe_t rtc_isa_probe;
83 static device_method_t rtc_ebus_methods[] = {
84 /* Device interface */
85 DEVMETHOD(device_probe, rtc_ebus_probe),
86 DEVMETHOD(device_attach, rtc_attach),
89 DEVMETHOD(clock_gettime, mc146818_gettime),
90 DEVMETHOD(clock_settime, mc146818_settime),
95 static driver_t rtc_ebus_driver = {
98 sizeof(struct mc146818_softc),
101 DRIVER_MODULE(rtc, ebus, rtc_ebus_driver, rtc_devclass, 0, 0);
104 static device_method_t rtc_isa_methods[] = {
105 /* Device interface */
106 DEVMETHOD(device_probe, rtc_isa_probe),
107 DEVMETHOD(device_attach, rtc_attach),
109 /* clock interface */
110 DEVMETHOD(clock_gettime, mc146818_gettime),
111 DEVMETHOD(clock_settime, mc146818_settime),
116 static driver_t rtc_isa_driver = {
119 sizeof(struct mc146818_softc),
122 DRIVER_MODULE(rtc, isa, rtc_isa_driver, rtc_devclass, 0, 0);
125 static u_int pc87317_getcent(device_t);
126 static void pc87317_setcent(device_t, u_int);
129 rtc_ebus_probe(device_t dev)
132 if (strcmp(ofw_bus_get_name(dev), "rtc") == 0) {
133 device_set_desc(dev, RTC_DESC);
141 static struct isa_pnp_id rtc_isa_ids[] = {
142 { 0x000bd041, RTC_DESC }, /* PNP0B00 */
147 rtc_isa_probe(device_t dev)
150 if (ISA_PNP_PROBE(device_get_parent(dev), dev, rtc_isa_ids) == 0)
158 rtc_attach(device_t dev)
161 struct mc146818_softc *sc;
162 struct resource *res;
163 int ebus, error, rid;
165 sc = device_get_softc(dev);
167 mtx_init(&sc->sc_mtx, "rtc_mtx", NULL, MTX_SPIN);
170 if (strcmp(device_get_name(device_get_parent(dev)), "ebus") == 0)
174 res = bus_alloc_resource_any(dev, ebus ? SYS_RES_MEMORY :
175 SYS_RES_IOPORT, &rid, RF_ACTIVE);
177 device_printf(dev, "cannot allocate resources\n");
181 sc->sc_bst = rman_get_bustag(res);
182 sc->sc_bsh = rman_get_bushandle(res);
184 sc->sc_mcread = RTC_READ;
185 sc->sc_mcwrite = RTC_WRITE;
186 /* The TOD clock year 0 is 0. */
189 * For ISA use the default century get/set functions, for EBus we
190 * provide our own versions.
192 sc->sc_flag = MC146818_NO_CENT_ADJUST;
195 * Make sure the CR is at the default location (also used
198 RTC_WRITE(dev, MC_REGA, PC87317_APC);
199 RTC_WRITE(dev, PC87317_APC_CADDR, PC87317_APC_CADDR_BANK1 |
201 RTC_WRITE(dev, MC_REGA, PC87317_COMMON);
202 sc->sc_getcent = pc87317_getcent;
203 sc->sc_setcent = pc87317_setcent;
205 if ((error = mc146818_attach(dev)) != 0) {
206 device_printf(dev, "cannot attach time of day clock\n");
211 if (mc146818_gettime(dev, &ts) != 0)
212 device_printf(dev, "invalid time");
214 device_printf(dev, "current time: %ld.%09ld\n",
215 (long)ts.tv_sec, ts.tv_nsec);
221 bus_release_resource(dev, ebus ? SYS_RES_MEMORY : SYS_RES_IOPORT, rid,
224 mtx_destroy(&sc->sc_mtx);
230 pc87317_getcent(device_t dev)
234 RTC_WRITE(dev, MC_REGA, PC87317_RTC);
235 cent = RTC_READ(dev, PC87317_RTC_CR);
236 RTC_WRITE(dev, MC_REGA, PC87317_COMMON);
241 pc87317_setcent(device_t dev, u_int cent)
244 RTC_WRITE(dev, MC_REGA, PC87317_RTC);
245 RTC_WRITE(dev, PC87317_RTC_CR, cent);
246 RTC_WRITE(dev, MC_REGA, PC87317_COMMON);