1 /*- 2 * Copyright (c) 2003 Marcel Moolenaar 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 * 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 #include <sys/cdefs.h> 28 __FBSDID("$FreeBSD$"); 29 30 #include <sys/param.h> 31 #include <sys/systm.h> 32 #include <sys/bus.h> 33 #include <sys/conf.h> 34 #include <sys/cons.h> 35 #include <sys/fcntl.h> 36 #include <sys/interrupt.h> 37 #include <sys/kernel.h> 38 #include <sys/malloc.h> 39 #include <sys/reboot.h> 40 #include <machine/bus.h> 41 #include <sys/rman.h> 42 #include <sys/termios.h> 43 #include <sys/tty.h> 44 #include <machine/resource.h> 45 #include <machine/stdarg.h> 46 47 #include <dev/uart/uart.h> 48 #include <dev/uart/uart_bus.h> 49 #include <dev/uart/uart_cpu.h> 50 51 #include "uart_if.h" 52 53 static cn_probe_t uart_cnprobe; 54 static cn_init_t uart_cninit; 55 static cn_term_t uart_cnterm; 56 static cn_getc_t uart_cngetc; 57 static cn_putc_t uart_cnputc; 58 59 CONSOLE_DRIVER(uart); 60 61 static struct uart_devinfo uart_console; 62 63 static void 64 uart_cnprobe(struct consdev *cp) 65 { 66 67 cp->cn_pri = CN_DEAD; 68 69 KASSERT(uart_console.cookie == NULL, ("foo")); 70 71 if (uart_cpu_getdev(UART_DEV_CONSOLE, &uart_console)) 72 return; 73 74 if (uart_probe(&uart_console)) 75 return; 76 77 strlcpy(cp->cn_name, uart_driver_name, sizeof(cp->cn_name)); 78 cp->cn_pri = (boothowto & RB_SERIAL) ? CN_REMOTE : CN_NORMAL; 79 cp->cn_arg = &uart_console; 80 } 81 82 static void 83 uart_cninit(struct consdev *cp) 84 { 85 struct uart_devinfo *di; 86 87 /* 88 * Yedi trick: we need to be able to define cn_dev before we go 89 * single- or multi-user. The problem is that we don't know at 90 * this time what the device will be. Hence, we need to link from 91 * the uart_devinfo to the consdev that corresponds to it so that 92 * we can define cn_dev in uart_bus_attach() when we find the 93 * device during bus enumeration. That's when we'll know what the 94 * the unit number will be. 95 */ 96 di = cp->cn_arg; 97 KASSERT(di->cookie == NULL, ("foo")); 98 di->cookie = cp; 99 di->type = UART_DEV_CONSOLE; 100 uart_add_sysdev(di); 101 uart_init(di); 102 } 103 104 static void 105 uart_cnterm(struct consdev *cp) 106 { 107 108 uart_term(cp->cn_arg); 109 } 110 111 static void 112 uart_cnputc(struct consdev *cp, int c) 113 { 114 115 uart_putc(cp->cn_arg, c); 116 } 117 118 static int 119 uart_cngetc(struct consdev *cp) 120 { 121 122 return (uart_poll(cp->cn_arg)); 123 } 124 125 static int 126 uart_tty_open(struct tty *tp) 127 { 128 struct uart_softc *sc; 129 130 sc = tty_softc(tp); 131 132 if (sc == NULL || sc->sc_leaving) 133 return (ENXIO); 134 135 sc->sc_opened = 1; 136 return (0); 137 } 138 139 static void 140 uart_tty_close(struct tty *tp) 141 { 142 struct uart_softc *sc; 143 144 sc = tty_softc(tp); 145 if (sc == NULL || sc->sc_leaving || !sc->sc_opened) 146 return; 147 148 if (sc->sc_hwiflow) 149 UART_IOCTL(sc, UART_IOCTL_IFLOW, 0); 150 if (sc->sc_hwoflow) 151 UART_IOCTL(sc, UART_IOCTL_OFLOW, 0); 152 if (sc->sc_sysdev == NULL) 153 UART_SETSIG(sc, SER_DDTR | SER_DRTS); 154 155 wakeup(sc); 156 sc->sc_opened = 0; 157 return; 158 } 159 160 static void 161 uart_tty_outwakeup(struct tty *tp) 162 { 163 struct uart_softc *sc; 164 165 sc = tty_softc(tp); 166 if (sc == NULL || sc->sc_leaving) 167 return; 168 169 /* 170 * Handle input flow control. Note that if we have hardware support, 171 * we don't do anything here. We continue to receive until our buffer 172 * is full. At that time we cannot empty the UART itself and it will 173 * de-assert RTS for us. In that situation we're completely stuffed. 174 * Without hardware support, we need to toggle RTS ourselves. 175 */ 176 if ((tp->t_termios.c_cflag & CRTS_IFLOW) && !sc->sc_hwiflow) { 177 #if 0 178 /*if ((tp->t_state & TS_TBLOCK) && 179 (sc->sc_hwsig & SER_RTS)) 180 UART_SETSIG(sc, SER_DRTS); 181 else */ if (/*!(tp->t_state & TS_TBLOCK) &&*/ 182 !(sc->sc_hwsig & SER_RTS)) 183 UART_SETSIG(sc, SER_DRTS|SER_RTS); 184 #endif 185 /* XXX: we should use inwakeup to implement this! */ 186 if (!(sc->sc_hwsig & SER_RTS)) 187 UART_SETSIG(sc, SER_DRTS|SER_RTS); 188 } 189 190 if (sc->sc_txbusy) 191 return; 192 193 sc->sc_txdatasz = ttydisc_getc(tp, sc->sc_txbuf, sc->sc_txfifosz); 194 if (sc->sc_txdatasz != 0) 195 UART_TRANSMIT(sc); 196 } 197 198 static int 199 uart_tty_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td) 200 { 201 struct uart_softc *sc; 202 203 sc = tty_softc(tp); 204 205 switch (cmd) { 206 case TIOCSBRK: 207 UART_IOCTL(sc, UART_IOCTL_BREAK, 1); 208 return (0); 209 case TIOCCBRK: 210 UART_IOCTL(sc, UART_IOCTL_BREAK, 0); 211 return (0); 212 default: 213 return pps_ioctl(cmd, data, &sc->sc_pps); 214 } 215 } 216 217 static int 218 uart_tty_param(struct tty *tp, struct termios *t) 219 { 220 struct uart_softc *sc; 221 int databits, parity, stopbits; 222 223 sc = tty_softc(tp); 224 if (sc == NULL || sc->sc_leaving) 225 return (ENODEV); 226 if (t->c_ispeed != t->c_ospeed && t->c_ospeed != 0) 227 return (EINVAL); 228 /* Fixate certain parameters for system devices. */ 229 if (sc->sc_sysdev != NULL) { 230 t->c_ispeed = t->c_ospeed = sc->sc_sysdev->baudrate; 231 t->c_cflag |= CLOCAL; 232 t->c_cflag &= ~HUPCL; 233 } 234 if (t->c_ospeed == 0) { 235 UART_SETSIG(sc, SER_DDTR | SER_DRTS); 236 return (0); 237 } 238 switch (t->c_cflag & CSIZE) { 239 case CS5: databits = 5; break; 240 case CS6: databits = 6; break; 241 case CS7: databits = 7; break; 242 default: databits = 8; break; 243 } 244 stopbits = (t->c_cflag & CSTOPB) ? 2 : 1; 245 if (t->c_cflag & PARENB) 246 parity = (t->c_cflag & PARODD) ? UART_PARITY_ODD 247 : UART_PARITY_EVEN; 248 else 249 parity = UART_PARITY_NONE; 250 if (UART_PARAM(sc, t->c_ospeed, databits, stopbits, parity) != 0) 251 return (EINVAL); 252 UART_SETSIG(sc, SER_DDTR | SER_DTR); 253 /* Set input flow control state. */ 254 if (!sc->sc_hwiflow) { 255 /* if ((t->c_cflag & CRTS_IFLOW) && (tp->t_state & TS_TBLOCK)) 256 UART_SETSIG(sc, SER_DRTS); 257 else */ 258 UART_SETSIG(sc, SER_DRTS | SER_RTS); 259 } else 260 UART_IOCTL(sc, UART_IOCTL_IFLOW, (t->c_cflag & CRTS_IFLOW)); 261 /* Set output flow control state. */ 262 if (sc->sc_hwoflow) 263 UART_IOCTL(sc, UART_IOCTL_OFLOW, (t->c_cflag & CCTS_OFLOW)); 264 265 return (0); 266 } 267 268 static int 269 uart_tty_modem(struct tty *tp, int biton, int bitoff) 270 { 271 struct uart_softc *sc; 272 273 sc = tty_softc(tp); 274 if (biton != 0 || bitoff != 0) 275 UART_SETSIG(sc, SER_DELTA(bitoff|biton) | biton); 276 return (sc->sc_hwsig); 277 } 278 279 void 280 uart_tty_intr(void *arg) 281 { 282 struct uart_softc *sc = arg; 283 struct tty *tp; 284 int c, err = 0, pend, sig, xc; 285 286 if (sc->sc_leaving) 287 return; 288 289 pend = atomic_readandclear_32(&sc->sc_ttypend); 290 if (!(pend & SER_INT_MASK)) 291 return; 292 293 tp = sc->sc_u.u_tty.tp; 294 tty_lock(tp); 295 296 if (pend & SER_INT_RXREADY) { 297 while (!uart_rx_empty(sc) /* && !(tp->t_state & TS_TBLOCK)*/) { 298 xc = uart_rx_get(sc); 299 c = xc & 0xff; 300 if (xc & UART_STAT_FRAMERR) 301 err |= TRE_FRAMING; 302 if (xc & UART_STAT_OVERRUN) 303 err |= TRE_OVERRUN; 304 if (xc & UART_STAT_PARERR) 305 err |= TRE_PARITY; 306 ttydisc_rint(tp, c, err); 307 } 308 } 309 310 if (pend & SER_INT_BREAK) 311 ttydisc_rint(tp, 0, TRE_BREAK); 312 313 if (pend & SER_INT_SIGCHG) { 314 sig = pend & SER_INT_SIGMASK; 315 if (sig & SER_DDCD) 316 ttydisc_modem(tp, sig & SER_DCD); 317 if ((sig & SER_DCTS) && (tp->t_termios.c_cflag & CCTS_OFLOW) && 318 !sc->sc_hwoflow) { 319 if (sig & SER_CTS) 320 uart_tty_outwakeup(tp); 321 } 322 } 323 324 if (pend & SER_INT_TXIDLE) 325 uart_tty_outwakeup(tp); 326 ttydisc_rint_done(tp); 327 tty_unlock(tp); 328 } 329 330 static void 331 uart_tty_free(void *arg) 332 { 333 334 /* 335 * XXX: uart(4) could reuse the device unit number before it is 336 * being freed by the TTY layer. We should use this hook to free 337 * the device unit number, but unfortunately newbus does not 338 * seem to support such a construct. 339 */ 340 } 341 342 static struct ttydevsw uart_tty_class = { 343 .tsw_flags = TF_INITLOCK|TF_CALLOUT, 344 .tsw_open = uart_tty_open, 345 .tsw_close = uart_tty_close, 346 .tsw_outwakeup = uart_tty_outwakeup, 347 .tsw_ioctl = uart_tty_ioctl, 348 .tsw_param = uart_tty_param, 349 .tsw_modem = uart_tty_modem, 350 .tsw_free = uart_tty_free, 351 }; 352 353 int 354 uart_tty_attach(struct uart_softc *sc) 355 { 356 struct tty *tp; 357 int unit; 358 359 sc->sc_u.u_tty.tp = tp = tty_alloc(&uart_tty_class, sc, NULL); 360 361 unit = device_get_unit(sc->sc_dev); 362 363 if (sc->sc_sysdev != NULL && sc->sc_sysdev->type == UART_DEV_CONSOLE) { 364 sprintf(((struct consdev *)sc->sc_sysdev->cookie)->cn_name, 365 "ttyu%r", unit); 366 tty_init_console(tp, 0); 367 } 368 369 swi_add(&tty_intr_event, uart_driver_name, uart_tty_intr, sc, SWI_TTY, 370 INTR_TYPE_TTY, &sc->sc_softih); 371 372 tty_makedev(tp, NULL, "u%r", unit); 373 374 return (0); 375 } 376 377 int 378 uart_tty_detach(struct uart_softc *sc) 379 { 380 struct tty *tp; 381 382 tp = sc->sc_u.u_tty.tp; 383 384 tty_lock(tp); 385 swi_remove(sc->sc_softih); 386 tty_rel_gone(tp); 387 388 return (0); 389 } 390