1 /*-
2 * Copyright (c) 2015 Nathan Whitehorn
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 */
26
27 #include <sys/param.h>
28 #include <sys/systm.h>
29 #include <sys/module.h>
30 #include <sys/bus.h>
31 #include <sys/conf.h>
32 #include <sys/clock.h>
33 #include <sys/cpu.h>
34 #include <sys/eventhandler.h>
35 #include <sys/kernel.h>
36 #include <sys/kthread.h>
37 #include <sys/reboot.h>
38 #include <sys/sysctl.h>
39 #include <sys/endian.h>
40
41 #include <vm/vm.h>
42 #include <vm/pmap.h>
43
44 #include <dev/ofw/ofw_bus.h>
45 #include <dev/ofw/ofw_bus_subr.h>
46 #include <dev/ofw/openfirm.h>
47
48 #include "clock_if.h"
49 #include "opal.h"
50
51 static int opaldev_probe(device_t);
52 static int opaldev_attach(device_t);
53 /* clock interface */
54 static int opal_gettime(device_t dev, struct timespec *ts);
55 static int opal_settime(device_t dev, struct timespec *ts);
56 /* ofw bus interface */
57 static const struct ofw_bus_devinfo *opaldev_get_devinfo(device_t dev,
58 device_t child);
59
60 static void opal_shutdown(void *arg, int howto);
61 static void opal_handle_shutdown_message(void *unused,
62 struct opal_msg *msg);
63 static void opal_intr(void *);
64
65 static device_method_t opaldev_methods[] = {
66 /* Device interface */
67 DEVMETHOD(device_probe, opaldev_probe),
68 DEVMETHOD(device_attach, opaldev_attach),
69
70 /* clock interface */
71 DEVMETHOD(clock_gettime, opal_gettime),
72 DEVMETHOD(clock_settime, opal_settime),
73
74 /* Bus interface */
75 DEVMETHOD(bus_child_pnpinfo, ofw_bus_gen_child_pnpinfo),
76
77 /* ofw_bus interface */
78 DEVMETHOD(ofw_bus_get_devinfo, opaldev_get_devinfo),
79 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
80 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
81 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
82 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
83 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
84
85 DEVMETHOD_END
86 };
87
88 static driver_t opaldev_driver = {
89 "opal",
90 opaldev_methods,
91 0
92 };
93
94 EARLY_DRIVER_MODULE(opaldev, ofwbus, opaldev_driver, 0, 0, BUS_PASS_BUS);
95
96 static void opal_heartbeat(void);
97 static void opal_handle_messages(void);
98
99 static struct proc *opal_hb_proc;
100 static struct kproc_desc opal_heartbeat_kp = {
101 "opal_heartbeat",
102 opal_heartbeat,
103 &opal_hb_proc
104 };
105
106 SYSINIT(opal_heartbeat_setup, SI_SUB_KTHREAD_IDLE, SI_ORDER_ANY, kproc_start,
107 &opal_heartbeat_kp);
108
109 static int opal_heartbeat_ms;
110 EVENTHANDLER_LIST_DEFINE(OPAL_ASYNC_COMP);
111 EVENTHANDLER_LIST_DEFINE(OPAL_EPOW);
112 EVENTHANDLER_LIST_DEFINE(OPAL_SHUTDOWN);
113 EVENTHANDLER_LIST_DEFINE(OPAL_HMI_EVT);
114 EVENTHANDLER_LIST_DEFINE(OPAL_DPO);
115 EVENTHANDLER_LIST_DEFINE(OPAL_OCC);
116
117 #define OPAL_SOFT_OFF 0
118 #define OPAL_SOFT_REBOOT 1
119
120 static void
opal_heartbeat(void)121 opal_heartbeat(void)
122 {
123 uint64_t events;
124
125 if (opal_heartbeat_ms == 0)
126 kproc_exit(0);
127
128 while (1) {
129 events = 0;
130 /* Turn the OPAL state crank */
131 opal_call(OPAL_POLL_EVENTS, vtophys(&events));
132 if (be64toh(events) & OPAL_EVENT_MSG_PENDING)
133 opal_handle_messages();
134 tsleep(opal_hb_proc, 0, "opal",
135 MSEC_2_TICKS(opal_heartbeat_ms));
136 }
137 }
138
139 static int
opaldev_probe(device_t dev)140 opaldev_probe(device_t dev)
141 {
142 phandle_t iparent;
143 pcell_t *irqs;
144 int i, n_irqs;
145
146 if (!ofw_bus_is_compatible(dev, "ibm,opal-v3"))
147 return (ENXIO);
148 if (opal_check() != 0)
149 return (ENXIO);
150
151 device_set_desc(dev, "OPAL Abstraction Firmware");
152
153 /* Manually add IRQs before attaching */
154 if (OF_hasprop(ofw_bus_get_node(dev), "opal-interrupts")) {
155 iparent = OF_finddevice("/interrupt-controller@0");
156 iparent = OF_xref_from_node(iparent);
157
158 n_irqs = OF_getproplen(ofw_bus_get_node(dev),
159 "opal-interrupts") / sizeof(*irqs);
160 irqs = malloc(n_irqs * sizeof(*irqs), M_DEVBUF, M_WAITOK);
161 OF_getencprop(ofw_bus_get_node(dev), "opal-interrupts", irqs,
162 n_irqs * sizeof(*irqs));
163 for (i = 0; i < n_irqs; i++)
164 bus_set_resource(dev, SYS_RES_IRQ, i,
165 ofw_bus_map_intr(dev, iparent, 1, &irqs[i]), 1);
166 free(irqs, M_DEVBUF);
167 }
168
169 return (BUS_PROBE_SPECIFIC);
170 }
171
172 static int
opaldev_attach(device_t dev)173 opaldev_attach(device_t dev)
174 {
175 phandle_t child;
176 device_t cdev;
177 uint64_t junk;
178 int i, rv;
179 uint32_t async_count;
180 struct ofw_bus_devinfo *dinfo;
181 struct resource *irq;
182
183 /* Test for RTC support and register clock if it works */
184 rv = opal_call(OPAL_RTC_READ, vtophys(&junk), vtophys(&junk));
185 do {
186 rv = opal_call(OPAL_RTC_READ, vtophys(&junk), vtophys(&junk));
187 if (rv == OPAL_BUSY_EVENT)
188 rv = opal_call(OPAL_POLL_EVENTS, 0);
189 } while (rv == OPAL_BUSY_EVENT);
190
191 if (rv == OPAL_SUCCESS)
192 clock_register(dev, 2000);
193
194 EVENTHANDLER_REGISTER(OPAL_SHUTDOWN, opal_handle_shutdown_message,
195 NULL, EVENTHANDLER_PRI_ANY);
196 EVENTHANDLER_REGISTER(shutdown_final, opal_shutdown, NULL,
197 SHUTDOWN_PRI_LAST);
198
199 OF_getencprop(ofw_bus_get_node(dev), "ibm,heartbeat-ms",
200 &opal_heartbeat_ms, sizeof(opal_heartbeat_ms));
201 /* Bind to interrupts */
202 for (i = 0; (irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &i,
203 RF_ACTIVE)) != NULL; i++)
204 bus_setup_intr(dev, irq, INTR_TYPE_TTY | INTR_MPSAFE |
205 INTR_ENTROPY, NULL, opal_intr, (void *)rman_get_start(irq),
206 NULL);
207
208 OF_getencprop(ofw_bus_get_node(dev), "opal-msg-async-num",
209 &async_count, sizeof(async_count));
210 opal_init_async_tokens(async_count);
211
212 for (child = OF_child(ofw_bus_get_node(dev)); child != 0;
213 child = OF_peer(child)) {
214 dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
215 if (ofw_bus_gen_setup_devinfo(dinfo, child) != 0) {
216 free(dinfo, M_DEVBUF);
217 continue;
218 }
219 cdev = device_add_child(dev, NULL, DEVICE_UNIT_ANY);
220 if (cdev == NULL) {
221 device_printf(dev, "<%s>: device_add_child failed\n",
222 dinfo->obd_name);
223 ofw_bus_gen_destroy_devinfo(dinfo);
224 free(dinfo, M_DEVBUF);
225 continue;
226 }
227 device_set_ivars(cdev, dinfo);
228 }
229
230 bus_attach_children(dev);
231 return (0);
232 }
233
234 static int
bcd2bin32(int bcd)235 bcd2bin32(int bcd)
236 {
237 int out = 0;
238
239 out += bcd2bin(bcd & 0xff);
240 out += 100*bcd2bin((bcd & 0x0000ff00) >> 8);
241 out += 10000*bcd2bin((bcd & 0x00ff0000) >> 16);
242 out += 1000000*bcd2bin((bcd & 0xffff0000) >> 24);
243
244 return (out);
245 }
246
247 static int
bin2bcd32(int bin)248 bin2bcd32(int bin)
249 {
250 int out = 0;
251 int tmp;
252
253 tmp = bin % 100;
254 out += bin2bcd(tmp) * 0x1;
255 bin = bin / 100;
256
257 tmp = bin % 100;
258 out += bin2bcd(tmp) * 0x100;
259 bin = bin / 100;
260
261 tmp = bin % 100;
262 out += bin2bcd(tmp) * 0x10000;
263
264 return (out);
265 }
266
267 static int
opal_gettime(device_t dev,struct timespec * ts)268 opal_gettime(device_t dev, struct timespec *ts)
269 {
270 int rv;
271 struct clocktime ct;
272 uint32_t ymd;
273 uint64_t hmsm;
274
275 rv = opal_call(OPAL_RTC_READ, vtophys(&ymd), vtophys(&hmsm));
276 while (rv == OPAL_BUSY_EVENT) {
277 opal_call(OPAL_POLL_EVENTS, 0);
278 pause("opalrtc", 1);
279 rv = opal_call(OPAL_RTC_READ, vtophys(&ymd), vtophys(&hmsm));
280 }
281
282 if (rv != OPAL_SUCCESS)
283 return (ENXIO);
284
285 hmsm = be64toh(hmsm);
286 ymd = be32toh(ymd);
287
288 ct.nsec = bcd2bin32((hmsm & 0x000000ffffff0000) >> 16) * 1000;
289 ct.sec = bcd2bin((hmsm & 0x0000ff0000000000) >> 40);
290 ct.min = bcd2bin((hmsm & 0x00ff000000000000) >> 48);
291 ct.hour = bcd2bin((hmsm & 0xff00000000000000) >> 56);
292
293 ct.day = bcd2bin((ymd & 0x000000ff) >> 0);
294 ct.mon = bcd2bin((ymd & 0x0000ff00) >> 8);
295 ct.year = bcd2bin32((ymd & 0xffff0000) >> 16);
296
297 return (clock_ct_to_ts(&ct, ts));
298 }
299
300 static int
opal_settime(device_t dev,struct timespec * ts)301 opal_settime(device_t dev, struct timespec *ts)
302 {
303 int rv;
304 struct clocktime ct;
305 uint32_t ymd = 0;
306 uint64_t hmsm = 0;
307
308 clock_ts_to_ct(ts, &ct);
309
310 ymd |= (uint32_t)bin2bcd(ct.day);
311 ymd |= ((uint32_t)bin2bcd(ct.mon) << 8);
312 ymd |= ((uint32_t)bin2bcd32(ct.year) << 16);
313
314 hmsm |= ((uint64_t)bin2bcd32(ct.nsec/1000) << 16);
315 hmsm |= ((uint64_t)bin2bcd(ct.sec) << 40);
316 hmsm |= ((uint64_t)bin2bcd(ct.min) << 48);
317 hmsm |= ((uint64_t)bin2bcd(ct.hour) << 56);
318
319 /*
320 * We do NOT swap endian here, because the values are being sent
321 * via registers instead of indirect via memory.
322 */
323 do {
324 rv = opal_call(OPAL_RTC_WRITE, ymd, hmsm);
325 if (rv == OPAL_BUSY_EVENT) {
326 rv = opal_call(OPAL_POLL_EVENTS, 0);
327 pause("opalrtc", 1);
328 }
329 } while (rv == OPAL_BUSY_EVENT);
330
331 if (rv != OPAL_SUCCESS)
332 return (ENXIO);
333
334 return (0);
335 }
336
337 static const struct ofw_bus_devinfo *
opaldev_get_devinfo(device_t dev,device_t child)338 opaldev_get_devinfo(device_t dev, device_t child)
339 {
340 return (device_get_ivars(child));
341 }
342
343 static void
opal_shutdown(void * arg,int howto)344 opal_shutdown(void *arg, int howto)
345 {
346
347 if ((howto & RB_POWEROFF) != 0)
348 opal_call(OPAL_CEC_POWER_DOWN, 0 /* Normal power off */);
349 else if ((howto & RB_HALT) == 0)
350 opal_call(OPAL_CEC_REBOOT);
351 else
352 return;
353
354 opal_call(OPAL_RETURN_CPU);
355 }
356
357 static void
opal_handle_shutdown_message(void * unused,struct opal_msg * msg)358 opal_handle_shutdown_message(void *unused, struct opal_msg *msg)
359 {
360 int howto;
361
362 switch (be64toh(msg->params[0])) {
363 case OPAL_SOFT_OFF:
364 howto = RB_POWEROFF;
365 break;
366 case OPAL_SOFT_REBOOT:
367 howto = RB_REROOT;
368 break;
369 }
370 shutdown_nice(howto);
371 }
372
373 static void
opal_handle_messages(void)374 opal_handle_messages(void)
375 {
376 static struct opal_msg msg;
377 uint64_t rv;
378 uint32_t type;
379
380 rv = opal_call(OPAL_GET_MSG, vtophys(&msg), sizeof(msg));
381
382 switch (rv) {
383 case OPAL_SUCCESS:
384 break;
385 case OPAL_RESOURCE:
386 /* no available messages - return */
387 return;
388 case OPAL_PARAMETER:
389 printf("%s error: invalid buffer. Please file a bug report.\n", __func__);
390 return;
391 case OPAL_PARTIAL:
392 printf("%s error: buffer is too small and messages was discarded. Please file a bug report.\n", __func__);
393 return;
394 default:
395 printf("%s opal_call returned unknown result <%lu>\n", __func__, rv);
396 return;
397 }
398
399 type = be32toh(msg.msg_type);
400 switch (type) {
401 case OPAL_MSG_ASYNC_COMP:
402 EVENTHANDLER_DIRECT_INVOKE(OPAL_ASYNC_COMP, &msg);
403 break;
404 case OPAL_MSG_EPOW:
405 EVENTHANDLER_DIRECT_INVOKE(OPAL_EPOW, &msg);
406 break;
407 case OPAL_MSG_SHUTDOWN:
408 EVENTHANDLER_DIRECT_INVOKE(OPAL_SHUTDOWN, &msg);
409 break;
410 case OPAL_MSG_HMI_EVT:
411 EVENTHANDLER_DIRECT_INVOKE(OPAL_HMI_EVT, &msg);
412 break;
413 case OPAL_MSG_DPO:
414 EVENTHANDLER_DIRECT_INVOKE(OPAL_DPO, &msg);
415 break;
416 case OPAL_MSG_OCC:
417 EVENTHANDLER_DIRECT_INVOKE(OPAL_OCC, &msg);
418 break;
419 default:
420 printf("%s Unknown OPAL message type %d\n", __func__, type);
421 }
422 }
423
424 static void
opal_intr(void * xintr)425 opal_intr(void *xintr)
426 {
427 uint64_t events = 0;
428
429 opal_call(OPAL_HANDLE_INTERRUPT, (uint32_t)(uint64_t)xintr,
430 vtophys(&events));
431 /* Wake up the heartbeat, if it's been setup. */
432 if (be64toh(events) != 0 && opal_hb_proc != NULL)
433 wakeup(opal_hb_proc);
434
435 }
436