2 * Copyright (C) 2011,2015 by Nathan Whitehorn. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
18 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
19 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
20 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
21 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 #include <sys/cdefs.h>
26 __FBSDID("$FreeBSD$");
28 #include <sys/endian.h>
29 #include <sys/param.h>
33 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/mutex.h>
39 #include <sys/systm.h>
45 #include <machine/bus.h>
47 #include <dev/ofw/openfirm.h>
48 #include <dev/ofw/ofw_bus.h>
49 #include <dev/ofw/ofw_bus_subr.h>
50 #include <dev/uart/uart.h>
51 #include <dev/uart/uart_cpu.h>
52 #include <dev/uart/uart_bus.h>
57 struct uart_opal_softc {
63 struct resource *irqres;
65 struct callout callout;
80 static struct uart_opal_softc *console_sc = NULL;
81 static struct consdev *stdout_cp;
87 #define VS_DATA_PACKET_HEADER 0xff
88 #define VS_CONTROL_PACKET_HEADER 0xfe
89 #define VSV_SET_MODEM_CTL 0x01
90 #define VSV_MODEM_CTL_UPDATE 0x02
91 #define VSV_RENEGOTIATE_CONNECTION 0x03
92 #define VS_QUERY_PACKET_HEADER 0xfd
93 #define VSV_SEND_VERSION_NUMBER 0x01
94 #define VSV_SEND_MODEM_CTL_STATUS 0x02
95 #define VS_QUERY_RESPONSE_PACKET_HEADER 0xfc
97 static int uart_opal_probe(device_t dev);
98 static int uart_opal_attach(device_t dev);
99 static void uart_opal_intr(void *v);
101 static device_method_t uart_opal_methods[] = {
102 /* Device interface */
103 DEVMETHOD(device_probe, uart_opal_probe),
104 DEVMETHOD(device_attach, uart_opal_attach),
109 static driver_t uart_opal_driver = {
112 sizeof(struct uart_opal_softc),
115 DRIVER_MODULE(uart_opal, opalcons, uart_opal_driver, 0, 0);
117 static int uart_opal_getc(struct uart_opal_softc *sc);
118 static cn_probe_t uart_opal_cnprobe;
119 static cn_init_t uart_opal_cninit;
120 static cn_term_t uart_opal_cnterm;
121 static cn_getc_t uart_opal_cngetc;
122 static cn_putc_t uart_opal_cnputc;
123 static cn_grab_t uart_opal_cngrab;
124 static cn_ungrab_t uart_opal_cnungrab;
126 CONSOLE_DRIVER(uart_opal);
128 static void uart_opal_ttyoutwakeup(struct tty *tp);
130 static struct ttydevsw uart_opal_tty_class = {
131 .tsw_flags = TF_INITLOCK|TF_CALLOUT,
132 .tsw_outwakeup = uart_opal_ttyoutwakeup,
142 uart_opal_real_map_outbuffer(uint64_t *bufferp, uint64_t *lenp)
145 if (!mtx_initialized(&opalcons_buffer.mtx))
146 mtx_init(&opalcons_buffer.mtx, "uart_opal", NULL,
147 MTX_SPIN | MTX_QUIET | MTX_NOWITNESS);
149 if (!pmap_bootstrapped)
152 mtx_lock_spin(&opalcons_buffer.mtx);
154 opalcons_buffer.size = *(uint64_t *)(*lenp) =
155 min(sizeof(opalcons_buffer.tmpbuf), *(uint64_t *)(*lenp));
156 memcpy(opalcons_buffer.tmpbuf, (void *)(*bufferp),
157 *(uint64_t *)(*lenp));
158 *bufferp = (uint64_t)opalcons_buffer.tmpbuf;
159 *lenp = (uint64_t)&opalcons_buffer.size;
163 uart_opal_real_unmap_outbuffer(uint64_t *len)
166 if (!pmap_bootstrapped)
169 mtx_assert(&opalcons_buffer.mtx, MA_OWNED);
170 *len = opalcons_buffer.size;
171 mtx_unlock_spin(&opalcons_buffer.mtx);
175 uart_opal_console_write_buffer_space(int vtermid)
177 int64_t buffer_space_val = 0;
178 vm_paddr_t buffer_space_ptr;
180 if (pmap_bootstrapped)
181 buffer_space_ptr = vtophys(&buffer_space_val);
183 buffer_space_ptr = (vm_paddr_t)&buffer_space_val;
185 if (opal_call(OPAL_CONSOLE_WRITE_BUFFER_SPACE, vtermid,
186 buffer_space_ptr) != OPAL_SUCCESS)
189 return (be64toh(buffer_space_val));
193 uart_opal_probe_node(struct uart_opal_softc *sc)
195 phandle_t node = sc->node;
202 if (OF_getprop(node, "device_type", buf, sizeof(buf)) <= 0)
204 if (strcmp(buf, "serial") != 0)
208 OF_getencprop(node, "reg", ®, sizeof(reg));
214 if (OF_getprop(node, "compatible", buf, sizeof(buf)) <= 0)
216 if (strcmp(buf, "ibm,opal-console-raw") == 0) {
217 sc->protocol = OPAL_RAW;
219 } else if (strcmp(buf, "ibm,opal-console-hvsi") == 0) {
220 sc->protocol = OPAL_HVSI;
228 uart_opal_probe(device_t dev)
230 struct uart_opal_softc sc;
233 sc.node = ofw_bus_get_node(dev);
234 err = uart_opal_probe_node(&sc);
238 device_set_desc(dev, "OPAL Serial Port");
244 uart_opal_cnprobe(struct consdev *cp)
247 phandle_t input, chosen;
248 static struct uart_opal_softc sc;
250 if (opal_check() != 0)
253 if ((chosen = OF_finddevice("/chosen")) == -1)
256 /* Check if OF has an active stdin/stdout */
257 if (OF_getprop(chosen, "linux,stdout-path", buf, sizeof(buf)) <= 0)
260 input = OF_finddevice(buf);
265 if (uart_opal_probe_node(&sc) != 0)
267 mtx_init(&sc.sc_mtx, "uart_opal", NULL, MTX_SPIN | MTX_QUIET |
270 cp->cn_pri = CN_NORMAL;
272 cp->cn_arg = console_sc;
277 cp->cn_pri = CN_DEAD;
282 uart_opal_attach(device_t dev)
284 struct uart_opal_softc *sc;
287 sc = device_get_softc(dev);
288 sc->node = ofw_bus_get_node(dev);
289 uart_opal_probe_node(sc);
291 unit = device_get_unit(dev);
292 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL,
293 MTX_SPIN | MTX_QUIET | MTX_NOWITNESS);
295 if (console_sc != NULL && console_sc->vtermid == sc->vtermid) {
296 device_printf(dev, "console\n");
297 device_set_softc(dev, console_sc);
299 sprintf(uart_opal_consdev.cn_name, "ttyu%r", unit);
301 sc->tp = tty_alloc(&uart_opal_tty_class, sc);
303 if (console_sc == sc)
304 tty_init_console(sc->tp, 0);
308 sc->irqres = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->irqrid,
309 RF_ACTIVE | RF_SHAREABLE);
310 if (sc->irqres != NULL) {
311 bus_setup_intr(dev, sc->irqres, INTR_TYPE_TTY | INTR_MPSAFE,
312 NULL, uart_opal_intr, sc, &sc->sc_icookie);
314 callout_init(&sc->callout, CALLOUT_MPSAFE);
315 sc->polltime = hz / 20;
316 if (sc->polltime < 1)
318 callout_reset(&sc->callout, sc->polltime, uart_opal_intr, sc);
321 tty_makedev(sc->tp, NULL, "u%r", unit);
327 uart_opal_cninit(struct consdev *cp)
330 strcpy(cp->cn_name, "opalcons");
334 uart_opal_cnterm(struct consdev *cp)
339 uart_opal_get(struct uart_opal_softc *sc, void *buffer, size_t bufsize)
344 if (sc->protocol == OPAL_RAW) {
345 uint64_t len = htobe64(bufsize);
346 uint64_t olen = (uint64_t)&len;
347 uint64_t obuf = (uint64_t)buffer;
349 if (pmap_bootstrapped) {
350 olen = vtophys(&len);
351 obuf = vtophys(buffer);
354 err = opal_call(OPAL_CONSOLE_READ, sc->vtermid, olen, obuf);
355 if (err != OPAL_SUCCESS)
358 bufsize = be64toh(len);
360 uart_lock(&sc->sc_mtx);
361 if (sc->inbuflen == 0) {
362 err = opal_call(OPAL_CONSOLE_READ, sc->vtermid,
363 &sc->inbuflen, sc->opal_inbuf);
364 if (err != OPAL_SUCCESS) {
365 uart_unlock(&sc->sc_mtx);
369 sc->inbuflen = be64toh(sc->inbuflen);
372 if (sc->inbuflen == 0) {
373 uart_unlock(&sc->sc_mtx);
377 if (bufsize > sc->inbuflen)
378 bufsize = sc->inbuflen;
381 sc->inbuflen = sc->inbuflen - 4;
382 /* The HVSI protocol has a 4 byte header, skip it */
383 memmove(&sc->opal_inbuf[0], &sc->opal_inbuf[4],
387 memcpy(buffer, sc->opal_inbuf, bufsize);
388 sc->inbuflen -= bufsize;
389 if (sc->inbuflen > 0)
390 memmove(&sc->opal_inbuf[0], &sc->opal_inbuf[bufsize],
393 uart_unlock(&sc->sc_mtx);
400 uart_opal_put(struct uart_opal_softc *sc, void *buffer, size_t bufsize)
406 uint64_t olen = (uint64_t)&len;
407 uint64_t obuf = (uint64_t)cbuf;
409 if (sc->protocol == OPAL_RAW) {
410 obuf = (uint64_t)buffer;
413 uart_opal_real_map_outbuffer(&obuf, &olen);
414 *(uint64_t*)olen = htobe64(*(uint64_t*)olen);
415 err = opal_call(OPAL_CONSOLE_WRITE, sc->vtermid, olen, obuf);
416 *(uint64_t*)olen = be64toh(*(uint64_t*)olen);
417 uart_opal_real_unmap_outbuffer(&len);
419 uart_lock(&sc->sc_mtx);
422 seqno = sc->outseqno++;
423 cbuf[0] = VS_DATA_PACKET_HEADER;
424 cbuf[1] = 4 + bufsize; /* total length */
425 cbuf[2] = (seqno >> 8) & 0xff;
426 cbuf[3] = seqno & 0xff;
427 memcpy(&cbuf[4], buffer, bufsize);
430 uart_opal_real_map_outbuffer(&obuf, &olen);
431 *(uint64_t*)olen = htobe64(*(uint64_t*)olen);
432 err = opal_call(OPAL_CONSOLE_WRITE, sc->vtermid, olen, obuf);
433 *(uint64_t*)olen = be64toh(*(uint64_t*)olen);
434 uart_opal_real_unmap_outbuffer(&len);
436 uart_unlock(&sc->sc_mtx);
441 if (err == OPAL_SUCCESS)
443 else if (err == OPAL_BUSY_EVENT)
450 uart_opal_cngetc(struct consdev *cp)
452 return (uart_opal_getc(cp->cn_arg));
456 uart_opal_getc(struct uart_opal_softc *sc)
461 retval = uart_opal_get(sc, &c, 1);
465 kdb_alt_break(c, &sc->alt_break_state);
472 uart_opal_cnputc(struct consdev *cp, int c)
474 unsigned char ch = c;
478 /* Clear FIFO if needed. Must be repeated few times. */
479 for (a = 0; a < 20; a++) {
480 opal_call(OPAL_POLL_EVENTS, NULL);
483 uart_opal_put(cp->cn_arg, &ch, 1);
487 uart_opal_cngrab(struct consdev *cp)
492 uart_opal_cnungrab(struct consdev *cp)
497 uart_opal_ttyoutwakeup(struct tty *tp)
499 struct uart_opal_softc *sc;
502 int64_t buffer_space;
506 while ((len = ttydisc_getc(tp, buffer, sizeof(buffer))) != 0) {
507 int bytes_written = 0;
508 while (bytes_written == 0) {
509 buffer_space = uart_opal_console_write_buffer_space(sc->vtermid);
510 if (buffer_space == -1)
511 /* OPAL failure or invalid terminal */
513 else if (buffer_space >= len)
514 bytes_written = uart_opal_put(sc, buffer, len);
516 if (bytes_written == 0)
517 /* OPAL must be busy, poll and retry */
518 opal_call(OPAL_POLL_EVENTS, NULL);
519 else if (bytes_written == -1)
520 /* OPAL failure or invalid terminal */
527 uart_opal_intr(void *v)
529 struct uart_opal_softc *sc = v;
530 struct tty *tp = sc->tp;
534 while ((c = uart_opal_getc(sc)) > 0)
535 ttydisc_rint(tp, c, 0);
536 ttydisc_rint_done(tp);
539 opal_call(OPAL_POLL_EVENTS, NULL);
541 if (sc->irqres == NULL)
542 callout_reset(&sc->callout, sc->polltime, uart_opal_intr, sc);
546 opalcons_probe(device_t dev)
550 name = ofw_bus_get_name(dev);
551 if (name == NULL || strcmp(name, "consoles") != 0)
554 device_set_desc(dev, "OPAL Consoles");
555 return (BUS_PROBE_SPECIFIC);
559 opalcons_attach(device_t dev)
563 struct ofw_bus_devinfo *dinfo;
565 for (child = OF_child(ofw_bus_get_node(dev)); child != 0;
566 child = OF_peer(child)) {
567 dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
568 if (ofw_bus_gen_setup_devinfo(dinfo, child) != 0) {
569 free(dinfo, M_DEVBUF);
572 cdev = device_add_child(dev, NULL, -1);
574 device_printf(dev, "<%s>: device_add_child failed\n",
576 ofw_bus_gen_destroy_devinfo(dinfo);
577 free(dinfo, M_DEVBUF);
580 device_set_ivars(cdev, dinfo);
583 return (bus_generic_attach(dev));
586 static const struct ofw_bus_devinfo *
587 opalcons_get_devinfo(device_t dev, device_t child)
589 return (device_get_ivars(child));
592 static device_method_t opalcons_methods[] = {
593 /* Device interface */
594 DEVMETHOD(device_probe, opalcons_probe),
595 DEVMETHOD(device_attach, opalcons_attach),
597 /* ofw_bus interface */
598 DEVMETHOD(ofw_bus_get_devinfo, opalcons_get_devinfo),
599 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
600 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
601 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
602 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
603 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
608 static driver_t opalcons_driver = {
614 DRIVER_MODULE(opalcons, opal, opalcons_driver, 0, 0);