2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2004 Marius Strobl <marius@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
33 * The `rtc' device is found on the ISA bus and the EBus. The ISA version
34 * always is a MC146818 compatible clock while the EBus variant either is the
35 * MC146818 compatible Real-Time Clock function of a National Semiconductor
36 * PC87317/PC97317 which also provides Advanced Power Control functionality
37 * or a Texas Instruments bq4802.
42 #include <sys/param.h>
43 #include <sys/systm.h>
45 #include <sys/kernel.h>
47 #include <sys/module.h>
48 #include <sys/mutex.h>
49 #include <sys/resource.h>
51 #include <dev/ofw/ofw_bus.h>
53 #include <machine/bus.h>
54 #include <machine/resource.h>
58 #include <isa/isavar.h>
60 #include <dev/mc146818/mc146818reg.h>
61 #include <dev/mc146818/mc146818var.h>
65 #define RTC_DESC "Real-Time Clock"
67 #define RTC_READ mc146818_def_read
68 #define RTC_WRITE mc146818_def_write
70 #define PC87317_COMMON MC_REGA_DV0 /* bank 0 */
71 #define PC87317_RTC (MC_REGA_DV1 | MC_REGA_DV0) /* bank 1 */
72 #define PC87317_RTC_CR 0x48 /* Century Register */
73 #define PC87317_APC MC_REGA_DV2 /* bank 2 */
74 #define PC87317_APC_CADDR 0x51 /* Century Address Register */
75 #define PC87317_APC_CADDR_BANK0 0x00 /* locate CR in bank 0 */
76 #define PC87317_APC_CADDR_BANK1 0x80 /* locate CR in bank 1 */
78 static devclass_t rtc_devclass;
80 static device_attach_t rtc_attach;
81 static device_probe_t rtc_ebus_probe;
83 static device_probe_t rtc_isa_probe;
86 static device_method_t rtc_ebus_methods[] = {
87 /* Device interface */
88 DEVMETHOD(device_probe, rtc_ebus_probe),
89 DEVMETHOD(device_attach, rtc_attach),
92 DEVMETHOD(clock_gettime, mc146818_gettime),
93 DEVMETHOD(clock_settime, mc146818_settime),
98 static driver_t rtc_ebus_driver = {
101 sizeof(struct mc146818_softc),
104 DRIVER_MODULE(rtc, ebus, rtc_ebus_driver, rtc_devclass, 0, 0);
107 static device_method_t rtc_isa_methods[] = {
108 /* Device interface */
109 DEVMETHOD(device_probe, rtc_isa_probe),
110 DEVMETHOD(device_attach, rtc_attach),
112 /* clock interface */
113 DEVMETHOD(clock_gettime, mc146818_gettime),
114 DEVMETHOD(clock_settime, mc146818_settime),
119 static driver_t rtc_isa_driver = {
122 sizeof(struct mc146818_softc),
125 static struct isa_pnp_id rtc_isa_ids[] = {
126 { 0x000bd041, RTC_DESC }, /* PNP0B00 */
130 DRIVER_MODULE(rtc, isa, rtc_isa_driver, rtc_devclass, 0, 0);
131 ISA_PNP_INFO(rtc_isa_ids);
134 static u_int pc87317_getcent(device_t dev);
135 static void pc87317_setcent(device_t dev, u_int cent);
138 rtc_ebus_probe(device_t dev)
141 if (strcmp(ofw_bus_get_name(dev), "rtc") == 0) {
142 /* The bq4802 is not supported, yet. */
143 if (ofw_bus_get_compat(dev) != NULL &&
144 strcmp(ofw_bus_get_compat(dev), "bq4802") == 0)
146 device_set_desc(dev, RTC_DESC);
155 rtc_isa_probe(device_t dev)
158 if (ISA_PNP_PROBE(device_get_parent(dev), dev, rtc_isa_ids) == 0)
166 rtc_attach(device_t dev)
169 struct mc146818_softc *sc;
170 struct resource *res;
171 int ebus, error, rid;
173 sc = device_get_softc(dev);
175 mtx_init(&sc->sc_mtx, "rtc_mtx", NULL, MTX_SPIN);
178 if (strcmp(device_get_name(device_get_parent(dev)), "ebus") == 0)
182 res = bus_alloc_resource_any(dev, ebus ? SYS_RES_MEMORY :
183 SYS_RES_IOPORT, &rid, RF_ACTIVE);
185 device_printf(dev, "cannot allocate resources\n");
189 sc->sc_bst = rman_get_bustag(res);
190 sc->sc_bsh = rman_get_bushandle(res);
192 sc->sc_mcread = RTC_READ;
193 sc->sc_mcwrite = RTC_WRITE;
194 /* The TOD clock year 0 is 0. */
197 * For ISA use the default century get/set functions, for EBus we
198 * provide our own versions.
200 sc->sc_flag = MC146818_NO_CENT_ADJUST;
203 * Make sure the CR is at the default location (also used
206 RTC_WRITE(dev, MC_REGA, PC87317_APC);
207 RTC_WRITE(dev, PC87317_APC_CADDR, PC87317_APC_CADDR_BANK1 |
209 RTC_WRITE(dev, MC_REGA, PC87317_COMMON);
210 sc->sc_getcent = pc87317_getcent;
211 sc->sc_setcent = pc87317_setcent;
213 if ((error = mc146818_attach(dev)) != 0) {
214 device_printf(dev, "cannot attach time of day clock\n");
219 if (mc146818_gettime(dev, &ts) != 0)
220 device_printf(dev, "invalid time");
222 device_printf(dev, "current time: %ld.%09ld\n",
223 (long)ts.tv_sec, ts.tv_nsec);
229 bus_release_resource(dev, ebus ? SYS_RES_MEMORY : SYS_RES_IOPORT, rid,
232 mtx_destroy(&sc->sc_mtx);
238 pc87317_getcent(device_t dev)
242 RTC_WRITE(dev, MC_REGA, PC87317_RTC);
243 cent = RTC_READ(dev, PC87317_RTC_CR);
244 RTC_WRITE(dev, MC_REGA, PC87317_COMMON);
249 pc87317_setcent(device_t dev, u_int cent)
252 RTC_WRITE(dev, MC_REGA, PC87317_RTC);
253 RTC_WRITE(dev, PC87317_RTC_CR, cent);
254 RTC_WRITE(dev, MC_REGA, PC87317_COMMON);