2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012 NetApp, Inc.
5 * Copyright (c) 2013 Neel Natu <neel@freebsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/types.h>
36 #include <dev/ic/ns16550.h>
37 #ifndef WITHOUT_CAPSICUM
38 #include <sys/capsicum.h>
55 #include "uart_emul.h"
57 #define COM1_BASE 0x3F8
59 #define COM2_BASE 0x2F8
62 #define DEFAULT_RCLK 1843200
63 #define DEFAULT_BAUD 9600
65 #define FCR_RX_MASK 0xC0
70 #define MSR_DELTA_MASK 0x0f
73 #define REG_SCR com_scr
78 static bool uart_stdio; /* stdio in use for i/o */
79 static struct termios tio_stdio_orig;
86 { COM1_BASE, COM1_IRQ, false},
87 { COM2_BASE, COM2_IRQ, false},
90 #define UART_NLDEVS (sizeof(uart_lres) / sizeof(uart_lres[0]))
94 int rindex; /* index to read from */
95 int windex; /* index to write to */
96 int num; /* number of characters in the fifo */
97 int size; /* size of the fifo */
102 int fd; /* tty device file descriptor */
103 struct termios tio_orig, tio_new; /* I/O Terminals */
107 pthread_mutex_t mtx; /* protects all softc elements */
108 uint8_t data; /* Data register (R/W) */
109 uint8_t ier; /* Interrupt enable register (R/W) */
110 uint8_t lcr; /* Line control register (R/W) */
111 uint8_t mcr; /* Modem control register (R/W) */
112 uint8_t lsr; /* Line status register (R/W) */
113 uint8_t msr; /* Modem status register (R/W) */
114 uint8_t fcr; /* FIFO control register (W) */
115 uint8_t scr; /* Scratch register (R/W) */
117 uint8_t dll; /* Baudrate divisor latch LSB */
118 uint8_t dlh; /* Baudrate divisor latch MSB */
124 bool thre_int_pending; /* THRE interrupt pending */
127 uart_intr_func_t intr_assert;
128 uart_intr_func_t intr_deassert;
131 static void uart_drain(int fd, enum ev_type ev, void *arg);
137 tcsetattr(STDIN_FILENO, TCSANOW, &tio_stdio_orig);
141 ttyopen(struct ttyfd *tf)
144 tcgetattr(tf->fd, &tf->tio_orig);
146 tf->tio_new = tf->tio_orig;
147 cfmakeraw(&tf->tio_new);
148 tf->tio_new.c_cflag |= CLOCAL;
149 tcsetattr(tf->fd, TCSANOW, &tf->tio_new);
151 if (tf->fd == STDIN_FILENO) {
152 tio_stdio_orig = tf->tio_orig;
158 ttyread(struct ttyfd *tf)
162 if (read(tf->fd, &rb, 1) == 1)
169 ttywrite(struct ttyfd *tf, unsigned char wb)
172 (void)write(tf->fd, &wb, 1);
176 rxfifo_reset(struct uart_softc *sc, int size)
184 bzero(fifo, sizeof(struct fifo));
187 if (sc->tty.opened) {
189 * Flush any unread input from the tty buffer.
192 nread = read(sc->tty.fd, flushbuf, sizeof(flushbuf));
193 if (nread != sizeof(flushbuf))
198 * Enable mevent to trigger when new characters are available
201 error = mevent_enable(sc->mev);
207 rxfifo_available(struct uart_softc *sc)
212 return (fifo->num < fifo->size);
216 rxfifo_putchar(struct uart_softc *sc, uint8_t ch)
223 if (fifo->num < fifo->size) {
224 fifo->buf[fifo->windex] = ch;
225 fifo->windex = (fifo->windex + 1) % fifo->size;
227 if (!rxfifo_available(sc)) {
228 if (sc->tty.opened) {
230 * Disable mevent callback if the FIFO is full.
232 error = mevent_disable(sc->mev);
242 rxfifo_getchar(struct uart_softc *sc)
245 int c, error, wasfull;
250 if (!rxfifo_available(sc))
252 c = fifo->buf[fifo->rindex];
253 fifo->rindex = (fifo->rindex + 1) % fifo->size;
256 if (sc->tty.opened) {
257 error = mevent_enable(sc->mev);
267 rxfifo_numchars(struct uart_softc *sc)
269 struct fifo *fifo = &sc->rxfifo;
275 uart_opentty(struct uart_softc *sc)
279 sc->mev = mevent_add(sc->tty.fd, EVF_READ, uart_drain, sc);
280 assert(sc->mev != NULL);
284 modem_status(uint8_t mcr)
288 if (mcr & MCR_LOOPBACK) {
290 * In the loopback mode certain bits from the MCR are
291 * reflected back into MSR.
304 * Always assert DCD and DSR so tty open doesn't block
305 * even if CLOCAL is turned off.
307 msr = MSR_DCD | MSR_DSR;
309 assert((msr & MSR_DELTA_MASK) == 0);
315 * The IIR returns a prioritized interrupt reason:
316 * - receive data available
317 * - transmit holding register empty
318 * - modem status change
320 * Return an interrupt reason if one is available.
323 uart_intr_reason(struct uart_softc *sc)
326 if ((sc->lsr & LSR_OE) != 0 && (sc->ier & IER_ERLS) != 0)
328 else if (rxfifo_numchars(sc) > 0 && (sc->ier & IER_ERXRDY) != 0)
330 else if (sc->thre_int_pending && (sc->ier & IER_ETXRDY) != 0)
332 else if ((sc->msr & MSR_DELTA_MASK) != 0 && (sc->ier & IER_EMSC) != 0)
339 uart_reset(struct uart_softc *sc)
343 divisor = DEFAULT_RCLK / DEFAULT_BAUD / 16;
345 sc->dlh = divisor >> 16;
346 sc->msr = modem_status(sc->mcr);
348 rxfifo_reset(sc, 1); /* no fifo until enabled by software */
352 * Toggle the COM port's intr pin depending on whether or not we have an
353 * interrupt condition to report to the processor.
356 uart_toggle_intr(struct uart_softc *sc)
360 intr_reason = uart_intr_reason(sc);
362 if (intr_reason == IIR_NOPEND)
363 (*sc->intr_deassert)(sc->arg);
365 (*sc->intr_assert)(sc->arg);
369 uart_drain(int fd, enum ev_type ev, void *arg)
371 struct uart_softc *sc;
376 assert(fd == sc->tty.fd);
377 assert(ev == EVF_READ);
380 * This routine is called in the context of the mevent thread
381 * to take out the softc lock to protect against concurrent
382 * access from a vCPU i/o exit
384 pthread_mutex_lock(&sc->mtx);
386 if ((sc->mcr & MCR_LOOPBACK) != 0) {
387 (void) ttyread(&sc->tty);
389 while (rxfifo_available(sc) &&
390 ((ch = ttyread(&sc->tty)) != -1)) {
391 rxfifo_putchar(sc, ch);
393 uart_toggle_intr(sc);
396 pthread_mutex_unlock(&sc->mtx);
400 uart_write(struct uart_softc *sc, int offset, uint8_t value)
405 pthread_mutex_lock(&sc->mtx);
408 * Take care of the special case DLAB accesses first
410 if ((sc->lcr & LCR_DLAB) != 0) {
411 if (offset == REG_DLL) {
416 if (offset == REG_DLH) {
424 if (sc->mcr & MCR_LOOPBACK) {
425 if (rxfifo_putchar(sc, value) != 0)
427 } else if (sc->tty.opened) {
428 ttywrite(&sc->tty, value);
429 } /* else drop on floor */
430 sc->thre_int_pending = true;
434 * Apply mask so that bits 4-7 are 0
435 * Also enables bits 0-3 only if they're 1
437 sc->ier = value & 0x0F;
441 * When moving from FIFO and 16450 mode and vice versa,
442 * the FIFO contents are reset.
444 if ((sc->fcr & FCR_ENABLE) ^ (value & FCR_ENABLE)) {
445 fifosz = (value & FCR_ENABLE) ? FIFOSZ : 1;
446 rxfifo_reset(sc, fifosz);
450 * The FCR_ENABLE bit must be '1' for the programming
451 * of other FCR bits to be effective.
453 if ((value & FCR_ENABLE) == 0) {
456 if ((value & FCR_RCV_RST) != 0)
457 rxfifo_reset(sc, FIFOSZ);
460 (FCR_ENABLE | FCR_DMA | FCR_RX_MASK);
467 /* Apply mask so that bits 5-7 are 0 */
468 sc->mcr = value & 0x1F;
469 msr = modem_status(sc->mcr);
472 * Detect if there has been any change between the
473 * previous and the new value of MSR. If there is
474 * then assert the appropriate MSR delta bit.
476 if ((msr & MSR_CTS) ^ (sc->msr & MSR_CTS))
478 if ((msr & MSR_DSR) ^ (sc->msr & MSR_DSR))
480 if ((msr & MSR_DCD) ^ (sc->msr & MSR_DCD))
482 if ((sc->msr & MSR_RI) != 0 && (msr & MSR_RI) == 0)
486 * Update the value of MSR while retaining the delta
489 sc->msr &= MSR_DELTA_MASK;
494 * Line status register is not meant to be written to
495 * during normal operation.
500 * As far as I can tell MSR is a read-only register.
511 uart_toggle_intr(sc);
512 pthread_mutex_unlock(&sc->mtx);
516 uart_read(struct uart_softc *sc, int offset)
518 uint8_t iir, intr_reason, reg;
520 pthread_mutex_lock(&sc->mtx);
523 * Take care of the special case DLAB accesses first
525 if ((sc->lcr & LCR_DLAB) != 0) {
526 if (offset == REG_DLL) {
531 if (offset == REG_DLH) {
539 reg = rxfifo_getchar(sc);
545 iir = (sc->fcr & FCR_ENABLE) ? IIR_FIFO_MASK : 0;
547 intr_reason = uart_intr_reason(sc);
550 * Deal with side effects of reading the IIR register
552 if (intr_reason == IIR_TXRDY)
553 sc->thre_int_pending = false;
566 /* Transmitter is always ready for more data */
567 sc->lsr |= LSR_TEMT | LSR_THRE;
569 /* Check for new receive data */
570 if (rxfifo_numchars(sc) > 0)
571 sc->lsr |= LSR_RXRDY;
573 sc->lsr &= ~LSR_RXRDY;
577 /* The LSR_OE bit is cleared on LSR read */
582 * MSR delta bits are cleared on read
585 sc->msr &= ~MSR_DELTA_MASK;
596 uart_toggle_intr(sc);
597 pthread_mutex_unlock(&sc->mtx);
603 uart_legacy_alloc(int which, int *baseaddr, int *irq)
606 if (which < 0 || which >= UART_NLDEVS || uart_lres[which].inuse)
609 uart_lres[which].inuse = true;
610 *baseaddr = uart_lres[which].baseaddr;
611 *irq = uart_lres[which].irq;
617 uart_init(uart_intr_func_t intr_assert, uart_intr_func_t intr_deassert,
620 struct uart_softc *sc;
622 sc = calloc(1, sizeof(struct uart_softc));
625 sc->intr_assert = intr_assert;
626 sc->intr_deassert = intr_deassert;
628 pthread_mutex_init(&sc->mtx, NULL);
636 uart_tty_backend(struct uart_softc *sc, const char *opts)
643 fd = open(opts, O_RDWR | O_NONBLOCK);
644 if (fd > 0 && isatty(fd)) {
646 sc->tty.opened = true;
654 uart_set_backend(struct uart_softc *sc, const char *opts)
657 #ifndef WITHOUT_CAPSICUM
659 cap_ioctl_t cmds[] = { TIOCGETA, TIOCSETA, TIOCGWINSZ };
660 cap_ioctl_t sicmds[] = { TIOCGETA, TIOCGWINSZ };
668 if (strcmp("stdio", opts) == 0) {
670 sc->tty.fd = STDIN_FILENO;
671 sc->tty.opened = true;
675 } else if (uart_tty_backend(sc, opts) == 0) {
679 /* Make the backend file descriptor non-blocking */
681 retval = fcntl(sc->tty.fd, F_SETFL, O_NONBLOCK);
684 #ifndef WITHOUT_CAPSICUM
685 cap_rights_init(&rights, CAP_EVENT, CAP_IOCTL, CAP_READ,
687 if (cap_rights_limit(sc->tty.fd, &rights) == -1 &&
689 errx(EX_OSERR, "Unable to apply rights for sandbox");
690 if (cap_ioctls_limit(sc->tty.fd, cmds, nitems(cmds)) == -1 &&
692 errx(EX_OSERR, "Unable to apply rights for sandbox");
694 cap_rights_init(&rights, CAP_FCNTL, CAP_FSTAT,
695 CAP_IOCTL, CAP_READ);
696 if (cap_rights_limit(STDIN_FILENO, &rights) == -1 &&
699 "Unable to apply rights for sandbox");
700 if (cap_ioctls_limit(STDIN_FILENO, sicmds,
701 nitems(sicmds)) == -1 && errno != ENOSYS)
703 "Unable to apply rights for sandbox");
704 if (cap_fcntls_limit(STDIN_FILENO, CAP_FCNTL_GETFL) ==
705 -1 && errno != ENOSYS)
707 "Unable to apply rights for sandbox");