2 * Copyright (c) 2015 Nathan Whitehorn
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$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/module.h>
35 #include <sys/clock.h>
37 #include <sys/eventhandler.h>
38 #include <sys/kernel.h>
39 #include <sys/kthread.h>
40 #include <sys/reboot.h>
41 #include <sys/sysctl.h>
42 #include <sys/endian.h>
47 #include <dev/ofw/ofw_bus.h>
48 #include <dev/ofw/ofw_bus_subr.h>
49 #include <dev/ofw/openfirm.h>
54 static int opaldev_probe(device_t);
55 static int opaldev_attach(device_t);
57 static int opal_gettime(device_t dev, struct timespec *ts);
58 static int opal_settime(device_t dev, struct timespec *ts);
59 /* ofw bus interface */
60 static const struct ofw_bus_devinfo *opaldev_get_devinfo(device_t dev,
63 static void opal_shutdown(void *arg, int howto);
64 static void opal_handle_shutdown_message(void *unused,
65 struct opal_msg *msg);
66 static void opal_intr(void *);
68 static device_method_t opaldev_methods[] = {
69 /* Device interface */
70 DEVMETHOD(device_probe, opaldev_probe),
71 DEVMETHOD(device_attach, opaldev_attach),
74 DEVMETHOD(clock_gettime, opal_gettime),
75 DEVMETHOD(clock_settime, opal_settime),
78 DEVMETHOD(bus_child_pnpinfo, ofw_bus_gen_child_pnpinfo),
80 /* ofw_bus interface */
81 DEVMETHOD(ofw_bus_get_devinfo, opaldev_get_devinfo),
82 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
83 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
84 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
85 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
86 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
91 static driver_t opaldev_driver = {
97 EARLY_DRIVER_MODULE(opaldev, ofwbus, opaldev_driver, 0, 0, BUS_PASS_BUS);
99 static void opal_heartbeat(void);
100 static void opal_handle_messages(void);
102 static struct proc *opal_hb_proc;
103 static struct kproc_desc opal_heartbeat_kp = {
109 SYSINIT(opal_heartbeat_setup, SI_SUB_KTHREAD_IDLE, SI_ORDER_ANY, kproc_start,
112 static int opal_heartbeat_ms;
113 EVENTHANDLER_LIST_DEFINE(OPAL_ASYNC_COMP);
114 EVENTHANDLER_LIST_DEFINE(OPAL_EPOW);
115 EVENTHANDLER_LIST_DEFINE(OPAL_SHUTDOWN);
116 EVENTHANDLER_LIST_DEFINE(OPAL_HMI_EVT);
117 EVENTHANDLER_LIST_DEFINE(OPAL_DPO);
118 EVENTHANDLER_LIST_DEFINE(OPAL_OCC);
120 #define OPAL_SOFT_OFF 0
121 #define OPAL_SOFT_REBOOT 1
128 if (opal_heartbeat_ms == 0)
133 /* Turn the OPAL state crank */
134 opal_call(OPAL_POLL_EVENTS, vtophys(&events));
135 if (be64toh(events) & OPAL_EVENT_MSG_PENDING)
136 opal_handle_messages();
137 tsleep(opal_hb_proc, 0, "opal",
138 MSEC_2_TICKS(opal_heartbeat_ms));
143 opaldev_probe(device_t dev)
149 if (!ofw_bus_is_compatible(dev, "ibm,opal-v3"))
151 if (opal_check() != 0)
154 device_set_desc(dev, "OPAL Abstraction Firmware");
156 /* Manually add IRQs before attaching */
157 if (OF_hasprop(ofw_bus_get_node(dev), "opal-interrupts")) {
158 iparent = OF_finddevice("/interrupt-controller@0");
159 iparent = OF_xref_from_node(iparent);
161 n_irqs = OF_getproplen(ofw_bus_get_node(dev),
162 "opal-interrupts") / sizeof(*irqs);
163 irqs = malloc(n_irqs * sizeof(*irqs), M_DEVBUF, M_WAITOK);
164 OF_getencprop(ofw_bus_get_node(dev), "opal-interrupts", irqs,
165 n_irqs * sizeof(*irqs));
166 for (i = 0; i < n_irqs; i++)
167 bus_set_resource(dev, SYS_RES_IRQ, i,
168 ofw_bus_map_intr(dev, iparent, 1, &irqs[i]), 1);
169 free(irqs, M_DEVBUF);
172 return (BUS_PROBE_SPECIFIC);
176 opaldev_attach(device_t dev)
182 uint32_t async_count;
183 struct ofw_bus_devinfo *dinfo;
184 struct resource *irq;
186 /* Test for RTC support and register clock if it works */
187 rv = opal_call(OPAL_RTC_READ, vtophys(&junk), vtophys(&junk));
189 rv = opal_call(OPAL_RTC_READ, vtophys(&junk), vtophys(&junk));
190 if (rv == OPAL_BUSY_EVENT)
191 rv = opal_call(OPAL_POLL_EVENTS, 0);
192 } while (rv == OPAL_BUSY_EVENT);
194 if (rv == OPAL_SUCCESS)
195 clock_register(dev, 2000);
197 EVENTHANDLER_REGISTER(OPAL_SHUTDOWN, opal_handle_shutdown_message,
198 NULL, EVENTHANDLER_PRI_ANY);
199 EVENTHANDLER_REGISTER(shutdown_final, opal_shutdown, NULL,
202 OF_getencprop(ofw_bus_get_node(dev), "ibm,heartbeat-ms",
203 &opal_heartbeat_ms, sizeof(opal_heartbeat_ms));
204 /* Bind to interrupts */
205 for (i = 0; (irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &i,
206 RF_ACTIVE)) != NULL; i++)
207 bus_setup_intr(dev, irq, INTR_TYPE_TTY | INTR_MPSAFE |
208 INTR_ENTROPY, NULL, opal_intr, (void *)rman_get_start(irq),
211 OF_getencprop(ofw_bus_get_node(dev), "opal-msg-async-num",
212 &async_count, sizeof(async_count));
213 opal_init_async_tokens(async_count);
215 for (child = OF_child(ofw_bus_get_node(dev)); child != 0;
216 child = OF_peer(child)) {
217 dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
218 if (ofw_bus_gen_setup_devinfo(dinfo, child) != 0) {
219 free(dinfo, M_DEVBUF);
222 cdev = device_add_child(dev, NULL, -1);
224 device_printf(dev, "<%s>: device_add_child failed\n",
226 ofw_bus_gen_destroy_devinfo(dinfo);
227 free(dinfo, M_DEVBUF);
230 device_set_ivars(cdev, dinfo);
233 return (bus_generic_attach(dev));
241 out += bcd2bin(bcd & 0xff);
242 out += 100*bcd2bin((bcd & 0x0000ff00) >> 8);
243 out += 10000*bcd2bin((bcd & 0x00ff0000) >> 16);
244 out += 1000000*bcd2bin((bcd & 0xffff0000) >> 24);
256 out += bin2bcd(tmp) * 0x1;
260 out += bin2bcd(tmp) * 0x100;
264 out += bin2bcd(tmp) * 0x10000;
270 opal_gettime(device_t dev, struct timespec *ts)
277 rv = opal_call(OPAL_RTC_READ, vtophys(&ymd), vtophys(&hmsm));
278 while (rv == OPAL_BUSY_EVENT) {
279 opal_call(OPAL_POLL_EVENTS, 0);
281 rv = opal_call(OPAL_RTC_READ, vtophys(&ymd), vtophys(&hmsm));
284 if (rv != OPAL_SUCCESS)
287 hmsm = be64toh(hmsm);
290 ct.nsec = bcd2bin32((hmsm & 0x000000ffffff0000) >> 16) * 1000;
291 ct.sec = bcd2bin((hmsm & 0x0000ff0000000000) >> 40);
292 ct.min = bcd2bin((hmsm & 0x00ff000000000000) >> 48);
293 ct.hour = bcd2bin((hmsm & 0xff00000000000000) >> 56);
295 ct.day = bcd2bin((ymd & 0x000000ff) >> 0);
296 ct.mon = bcd2bin((ymd & 0x0000ff00) >> 8);
297 ct.year = bcd2bin32((ymd & 0xffff0000) >> 16);
299 return (clock_ct_to_ts(&ct, ts));
303 opal_settime(device_t dev, struct timespec *ts)
310 clock_ts_to_ct(ts, &ct);
312 ymd |= (uint32_t)bin2bcd(ct.day);
313 ymd |= ((uint32_t)bin2bcd(ct.mon) << 8);
314 ymd |= ((uint32_t)bin2bcd32(ct.year) << 16);
316 hmsm |= ((uint64_t)bin2bcd32(ct.nsec/1000) << 16);
317 hmsm |= ((uint64_t)bin2bcd(ct.sec) << 40);
318 hmsm |= ((uint64_t)bin2bcd(ct.min) << 48);
319 hmsm |= ((uint64_t)bin2bcd(ct.hour) << 56);
322 * We do NOT swap endian here, because the values are being sent
323 * via registers instead of indirect via memory.
326 rv = opal_call(OPAL_RTC_WRITE, ymd, hmsm);
327 if (rv == OPAL_BUSY_EVENT) {
328 rv = opal_call(OPAL_POLL_EVENTS, 0);
331 } while (rv == OPAL_BUSY_EVENT);
333 if (rv != OPAL_SUCCESS)
339 static const struct ofw_bus_devinfo *
340 opaldev_get_devinfo(device_t dev, device_t child)
342 return (device_get_ivars(child));
346 opal_shutdown(void *arg, int howto)
350 opal_call(OPAL_CEC_POWER_DOWN, 0 /* Normal power off */);
352 opal_call(OPAL_CEC_REBOOT);
354 opal_call(OPAL_RETURN_CPU);
358 opal_handle_shutdown_message(void *unused, struct opal_msg *msg)
362 switch (be64toh(msg->params[0])) {
366 case OPAL_SOFT_REBOOT:
370 shutdown_nice(howto);
374 opal_handle_messages(void)
376 static struct opal_msg msg;
380 rv = opal_call(OPAL_GET_MSG, vtophys(&msg), sizeof(msg));
386 /* no available messages - return */
389 printf("%s error: invalid buffer. Please file a bug report.\n", __func__);
392 printf("%s error: buffer is too small and messages was discarded. Please file a bug report.\n", __func__);
395 printf("%s opal_call returned unknown result <%lu>\n", __func__, rv);
399 type = be32toh(msg.msg_type);
401 case OPAL_MSG_ASYNC_COMP:
402 EVENTHANDLER_DIRECT_INVOKE(OPAL_ASYNC_COMP, &msg);
405 EVENTHANDLER_DIRECT_INVOKE(OPAL_EPOW, &msg);
407 case OPAL_MSG_SHUTDOWN:
408 EVENTHANDLER_DIRECT_INVOKE(OPAL_SHUTDOWN, &msg);
410 case OPAL_MSG_HMI_EVT:
411 EVENTHANDLER_DIRECT_INVOKE(OPAL_HMI_EVT, &msg);
414 EVENTHANDLER_DIRECT_INVOKE(OPAL_DPO, &msg);
417 EVENTHANDLER_DIRECT_INVOKE(OPAL_OCC, &msg);
420 printf("%s Unknown OPAL message type %d\n", __func__, type);
425 opal_intr(void *xintr)
429 opal_call(OPAL_HANDLE_INTERRUPT, (uint32_t)(uint64_t)xintr,
431 /* Wake up the heartbeat, if it's been setup. */
432 if (be64toh(events) != 0 && opal_hb_proc != NULL)
433 wakeup(opal_hb_proc);