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 #include <sys/endian.h>
27 #include <sys/param.h>
31 #include <sys/kernel.h>
33 #include <sys/module.h>
34 #include <sys/mutex.h>
37 #include <sys/systm.h>
43 #include <machine/bus.h>
45 #include <dev/ofw/openfirm.h>
46 #include <dev/ofw/ofw_bus.h>
47 #include <dev/ofw/ofw_bus_subr.h>
48 #include <dev/uart/uart.h>
49 #include <dev/uart/uart_cpu.h>
50 #include <dev/uart/uart_bus.h>
55 struct uart_opal_softc {
61 struct resource *irqres;
63 struct callout callout;
78 static struct uart_opal_softc *console_sc = NULL;
79 static struct consdev *stdout_cp;
85 #define VS_DATA_PACKET_HEADER 0xff
86 #define VS_CONTROL_PACKET_HEADER 0xfe
87 #define VSV_SET_MODEM_CTL 0x01
88 #define VSV_MODEM_CTL_UPDATE 0x02
89 #define VSV_RENEGOTIATE_CONNECTION 0x03
90 #define VS_QUERY_PACKET_HEADER 0xfd
91 #define VSV_SEND_VERSION_NUMBER 0x01
92 #define VSV_SEND_MODEM_CTL_STATUS 0x02
93 #define VS_QUERY_RESPONSE_PACKET_HEADER 0xfc
95 static int uart_opal_probe(device_t dev);
96 static int uart_opal_attach(device_t dev);
97 static void uart_opal_intr(void *v);
99 static device_method_t uart_opal_methods[] = {
100 /* Device interface */
101 DEVMETHOD(device_probe, uart_opal_probe),
102 DEVMETHOD(device_attach, uart_opal_attach),
107 static driver_t uart_opal_driver = {
110 sizeof(struct uart_opal_softc),
113 DRIVER_MODULE(uart_opal, opalcons, uart_opal_driver, 0, 0);
115 static int uart_opal_getc(struct uart_opal_softc *sc);
116 static cn_probe_t uart_opal_cnprobe;
117 static cn_init_t uart_opal_cninit;
118 static cn_term_t uart_opal_cnterm;
119 static cn_getc_t uart_opal_cngetc;
120 static cn_putc_t uart_opal_cnputc;
121 static cn_grab_t uart_opal_cngrab;
122 static cn_ungrab_t uart_opal_cnungrab;
124 CONSOLE_DRIVER(uart_opal);
126 static void uart_opal_ttyoutwakeup(struct tty *tp);
128 static struct ttydevsw uart_opal_tty_class = {
129 .tsw_flags = TF_INITLOCK|TF_CALLOUT,
130 .tsw_outwakeup = uart_opal_ttyoutwakeup,
140 uart_opal_real_map_outbuffer(uint64_t *bufferp, uint64_t *lenp)
143 if (!mtx_initialized(&opalcons_buffer.mtx))
144 mtx_init(&opalcons_buffer.mtx, "uart_opal", NULL,
145 MTX_SPIN | MTX_QUIET | MTX_NOWITNESS);
147 if (!pmap_bootstrapped)
150 mtx_lock_spin(&opalcons_buffer.mtx);
152 opalcons_buffer.size = *(uint64_t *)(*lenp) =
153 min(sizeof(opalcons_buffer.tmpbuf), *(uint64_t *)(*lenp));
154 memcpy(opalcons_buffer.tmpbuf, (void *)(*bufferp),
155 *(uint64_t *)(*lenp));
156 *bufferp = (uint64_t)opalcons_buffer.tmpbuf;
157 *lenp = (uint64_t)&opalcons_buffer.size;
161 uart_opal_real_unmap_outbuffer(uint64_t *len)
164 if (!pmap_bootstrapped)
167 mtx_assert(&opalcons_buffer.mtx, MA_OWNED);
168 *len = opalcons_buffer.size;
169 mtx_unlock_spin(&opalcons_buffer.mtx);
173 uart_opal_console_write_buffer_space(int vtermid)
175 int64_t buffer_space_val = 0;
176 vm_paddr_t buffer_space_ptr;
178 if (pmap_bootstrapped)
179 buffer_space_ptr = vtophys(&buffer_space_val);
181 buffer_space_ptr = (vm_paddr_t)&buffer_space_val;
183 if (opal_call(OPAL_CONSOLE_WRITE_BUFFER_SPACE, vtermid,
184 buffer_space_ptr) != OPAL_SUCCESS)
187 return (be64toh(buffer_space_val));
191 uart_opal_probe_node(struct uart_opal_softc *sc)
193 phandle_t node = sc->node;
200 if (OF_getprop(node, "device_type", buf, sizeof(buf)) <= 0)
202 if (strcmp(buf, "serial") != 0)
206 OF_getencprop(node, "reg", ®, sizeof(reg));
212 if (OF_getprop(node, "compatible", buf, sizeof(buf)) <= 0)
214 if (strcmp(buf, "ibm,opal-console-raw") == 0) {
215 sc->protocol = OPAL_RAW;
217 } else if (strcmp(buf, "ibm,opal-console-hvsi") == 0) {
218 sc->protocol = OPAL_HVSI;
226 uart_opal_probe(device_t dev)
228 struct uart_opal_softc sc;
231 sc.node = ofw_bus_get_node(dev);
232 err = uart_opal_probe_node(&sc);
236 device_set_desc(dev, "OPAL Serial Port");
242 uart_opal_cnprobe(struct consdev *cp)
245 phandle_t input, chosen;
246 static struct uart_opal_softc sc;
248 if (opal_check() != 0)
251 if ((chosen = OF_finddevice("/chosen")) == -1)
254 /* Check if OF has an active stdin/stdout */
255 if (OF_getprop(chosen, "linux,stdout-path", buf, sizeof(buf)) <= 0)
258 input = OF_finddevice(buf);
263 if (uart_opal_probe_node(&sc) != 0)
265 mtx_init(&sc.sc_mtx, "uart_opal", NULL, MTX_SPIN | MTX_QUIET |
268 cp->cn_pri = CN_NORMAL;
270 cp->cn_arg = console_sc;
275 cp->cn_pri = CN_DEAD;
280 uart_opal_attach(device_t dev)
282 struct uart_opal_softc *sc;
285 sc = device_get_softc(dev);
286 sc->node = ofw_bus_get_node(dev);
287 uart_opal_probe_node(sc);
289 unit = device_get_unit(dev);
290 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL,
291 MTX_SPIN | MTX_QUIET | MTX_NOWITNESS);
293 if (console_sc != NULL && console_sc->vtermid == sc->vtermid) {
294 device_printf(dev, "console\n");
295 device_set_softc(dev, console_sc);
297 sprintf(uart_opal_consdev.cn_name, "ttyu%r", unit);
299 sc->tp = tty_alloc(&uart_opal_tty_class, sc);
301 if (console_sc == sc)
302 tty_init_console(sc->tp, 0);
306 sc->irqres = bus_alloc_resource_any(dev, SYS_RES_IRQ, &sc->irqrid,
307 RF_ACTIVE | RF_SHAREABLE);
308 if (sc->irqres != NULL) {
309 bus_setup_intr(dev, sc->irqres, INTR_TYPE_TTY | INTR_MPSAFE,
310 NULL, uart_opal_intr, sc, &sc->sc_icookie);
312 callout_init(&sc->callout, CALLOUT_MPSAFE);
313 sc->polltime = hz / 20;
314 if (sc->polltime < 1)
316 callout_reset(&sc->callout, sc->polltime, uart_opal_intr, sc);
319 tty_makedev(sc->tp, NULL, "u%r", unit);
325 uart_opal_cninit(struct consdev *cp)
328 strcpy(cp->cn_name, "opalcons");
332 uart_opal_cnterm(struct consdev *cp)
337 uart_opal_get(struct uart_opal_softc *sc, void *buffer, size_t bufsize)
342 if (sc->protocol == OPAL_RAW) {
343 uint64_t len = htobe64(bufsize);
344 uint64_t olen = (uint64_t)&len;
345 uint64_t obuf = (uint64_t)buffer;
347 if (pmap_bootstrapped) {
348 olen = vtophys(&len);
349 obuf = vtophys(buffer);
352 err = opal_call(OPAL_CONSOLE_READ, sc->vtermid, olen, obuf);
353 if (err != OPAL_SUCCESS)
356 bufsize = be64toh(len);
358 uart_lock(&sc->sc_mtx);
359 if (sc->inbuflen == 0) {
360 err = opal_call(OPAL_CONSOLE_READ, sc->vtermid,
361 &sc->inbuflen, sc->opal_inbuf);
362 if (err != OPAL_SUCCESS) {
363 uart_unlock(&sc->sc_mtx);
367 sc->inbuflen = be64toh(sc->inbuflen);
370 if (sc->inbuflen == 0) {
371 uart_unlock(&sc->sc_mtx);
375 if (bufsize > sc->inbuflen)
376 bufsize = sc->inbuflen;
379 sc->inbuflen = sc->inbuflen - 4;
380 /* The HVSI protocol has a 4 byte header, skip it */
381 memmove(&sc->opal_inbuf[0], &sc->opal_inbuf[4],
385 memcpy(buffer, sc->opal_inbuf, bufsize);
386 sc->inbuflen -= bufsize;
387 if (sc->inbuflen > 0)
388 memmove(&sc->opal_inbuf[0], &sc->opal_inbuf[bufsize],
391 uart_unlock(&sc->sc_mtx);
398 uart_opal_put(struct uart_opal_softc *sc, void *buffer, size_t bufsize)
404 uint64_t olen = (uint64_t)&len;
405 uint64_t obuf = (uint64_t)cbuf;
407 if (sc->protocol == OPAL_RAW) {
408 obuf = (uint64_t)buffer;
411 uart_opal_real_map_outbuffer(&obuf, &olen);
412 *(uint64_t*)olen = htobe64(*(uint64_t*)olen);
413 err = opal_call(OPAL_CONSOLE_WRITE, sc->vtermid, olen, obuf);
414 *(uint64_t*)olen = be64toh(*(uint64_t*)olen);
415 uart_opal_real_unmap_outbuffer(&len);
417 uart_lock(&sc->sc_mtx);
420 seqno = sc->outseqno++;
421 cbuf[0] = VS_DATA_PACKET_HEADER;
422 cbuf[1] = 4 + bufsize; /* total length */
423 cbuf[2] = (seqno >> 8) & 0xff;
424 cbuf[3] = seqno & 0xff;
425 memcpy(&cbuf[4], buffer, bufsize);
428 uart_opal_real_map_outbuffer(&obuf, &olen);
429 *(uint64_t*)olen = htobe64(*(uint64_t*)olen);
430 err = opal_call(OPAL_CONSOLE_WRITE, sc->vtermid, olen, obuf);
431 *(uint64_t*)olen = be64toh(*(uint64_t*)olen);
432 uart_opal_real_unmap_outbuffer(&len);
434 uart_unlock(&sc->sc_mtx);
439 if (err == OPAL_SUCCESS)
441 else if (err == OPAL_BUSY_EVENT)
448 uart_opal_cngetc(struct consdev *cp)
450 return (uart_opal_getc(cp->cn_arg));
454 uart_opal_getc(struct uart_opal_softc *sc)
459 retval = uart_opal_get(sc, &c, 1);
463 kdb_alt_break(c, &sc->alt_break_state);
470 uart_opal_cnputc(struct consdev *cp, int c)
472 unsigned char ch = c;
476 /* Clear FIFO if needed. Must be repeated few times. */
477 for (a = 0; a < 20; a++) {
478 opal_call(OPAL_POLL_EVENTS, NULL);
481 uart_opal_put(cp->cn_arg, &ch, 1);
485 uart_opal_cngrab(struct consdev *cp)
490 uart_opal_cnungrab(struct consdev *cp)
495 uart_opal_ttyoutwakeup(struct tty *tp)
497 struct uart_opal_softc *sc;
500 int64_t buffer_space;
504 while ((len = ttydisc_getc(tp, buffer, sizeof(buffer))) != 0) {
505 int bytes_written = 0;
506 while (bytes_written == 0) {
507 buffer_space = uart_opal_console_write_buffer_space(sc->vtermid);
508 if (buffer_space == -1)
509 /* OPAL failure or invalid terminal */
511 else if (buffer_space >= len)
512 bytes_written = uart_opal_put(sc, buffer, len);
514 if (bytes_written == 0)
515 /* OPAL must be busy, poll and retry */
516 opal_call(OPAL_POLL_EVENTS, NULL);
517 else if (bytes_written == -1)
518 /* OPAL failure or invalid terminal */
525 uart_opal_intr(void *v)
527 struct uart_opal_softc *sc = v;
528 struct tty *tp = sc->tp;
532 while ((c = uart_opal_getc(sc)) > 0)
533 ttydisc_rint(tp, c, 0);
534 ttydisc_rint_done(tp);
537 opal_call(OPAL_POLL_EVENTS, NULL);
539 if (sc->irqres == NULL)
540 callout_reset(&sc->callout, sc->polltime, uart_opal_intr, sc);
544 opalcons_probe(device_t dev)
548 name = ofw_bus_get_name(dev);
549 if (name == NULL || strcmp(name, "consoles") != 0)
552 device_set_desc(dev, "OPAL Consoles");
553 return (BUS_PROBE_SPECIFIC);
557 opalcons_attach(device_t dev)
561 struct ofw_bus_devinfo *dinfo;
563 for (child = OF_child(ofw_bus_get_node(dev)); child != 0;
564 child = OF_peer(child)) {
565 dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_WAITOK | M_ZERO);
566 if (ofw_bus_gen_setup_devinfo(dinfo, child) != 0) {
567 free(dinfo, M_DEVBUF);
570 cdev = device_add_child(dev, NULL, -1);
572 device_printf(dev, "<%s>: device_add_child failed\n",
574 ofw_bus_gen_destroy_devinfo(dinfo);
575 free(dinfo, M_DEVBUF);
578 device_set_ivars(cdev, dinfo);
581 return (bus_generic_attach(dev));
584 static const struct ofw_bus_devinfo *
585 opalcons_get_devinfo(device_t dev, device_t child)
587 return (device_get_ivars(child));
590 static device_method_t opalcons_methods[] = {
591 /* Device interface */
592 DEVMETHOD(device_probe, opalcons_probe),
593 DEVMETHOD(device_attach, opalcons_attach),
595 /* ofw_bus interface */
596 DEVMETHOD(ofw_bus_get_devinfo, opalcons_get_devinfo),
597 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
598 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
599 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
600 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
601 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
606 static driver_t opalcons_driver = {
612 DRIVER_MODULE(opalcons, opal, opalcons_driver, 0, 0);