sys/dev/uart/uart_core.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2003 Marcel Moolenaar
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  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.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/bus.h>
  35 #include <sys/conf.h>
  36 #include <sys/cons.h>
  37 #include <sys/fcntl.h>
  38 #include <sys/interrupt.h>
  39 #include <sys/kdb.h>
  40 #include <sys/kernel.h>
  41 #include <sys/malloc.h>
  42 #include <sys/queue.h>
  43 #include <sys/reboot.h>
  44 #include <sys/sysctl.h>
  45 #include <machine/bus.h>
  46 #include <sys/rman.h>
  47 #include <machine/resource.h>
  48 #include <machine/stdarg.h>
  49
  50 #include <dev/uart/uart.h>
  51 #include <dev/uart/uart_bus.h>
  52 #include <dev/uart/uart_cpu.h>
  53 #include <dev/uart/uart_ppstypes.h>
  54
  55 #include "uart_if.h"
  56
  57 devclass_t uart_devclass;
  58 const char uart_driver_name[] = "uart";
  59
  60 SLIST_HEAD(uart_devinfo_list, uart_devinfo) uart_sysdevs =
  61     SLIST_HEAD_INITIALIZER(uart_sysdevs);
  62
  63 static MALLOC_DEFINE(M_UART, "UART", "UART driver");
  64
  65 #ifndef UART_POLL_FREQ
  66 #define UART_POLL_FREQ          50
  67 #endif
  68 static int uart_poll_freq = UART_POLL_FREQ;
  69 SYSCTL_INT(_debug, OID_AUTO, uart_poll_freq, CTLFLAG_RDTUN, &uart_poll_freq,
  70     0, "UART poll frequency");
  71
  72 static int uart_force_poll;
  73 SYSCTL_INT(_debug, OID_AUTO, uart_force_poll, CTLFLAG_RDTUN, &uart_force_poll,
  74     0, "Force UART polling");
  75
  76 static inline int
  77 uart_pps_mode_valid(int pps_mode)
  78 {
  79         int opt;
  80
  81         switch(pps_mode & UART_PPS_SIGNAL_MASK) {
  82         case UART_PPS_DISABLED:
  83         case UART_PPS_CTS:
  84         case UART_PPS_DCD:
  85                 break;
  86         default:
  87                 return (false);
  88         }
  89
  90         opt = pps_mode & UART_PPS_OPTION_MASK;
  91         if ((opt & ~(UART_PPS_INVERT_PULSE | UART_PPS_NARROW_PULSE)) != 0)
  92                 return (false);
  93
  94         return (true);
  95 }
  96
  97 static void
  98 uart_pps_print_mode(struct uart_softc *sc)
  99 {
 100
 101         device_printf(sc->sc_dev, "PPS capture mode: ");
 102         switch(sc->sc_pps_mode & UART_PPS_SIGNAL_MASK) {
 103         case UART_PPS_DISABLED:
 104                 printf("disabled");
 105                 break;
 106         case UART_PPS_CTS:
 107                 printf("CTS");
 108                 break;
 109         case UART_PPS_DCD:
 110                 printf("DCD");
 111                 break;
 112         default:
 113                 printf("invalid");
 114                 break;
 115         }
 116         if (sc->sc_pps_mode & UART_PPS_INVERT_PULSE)
 117                 printf("-Inverted");
 118         if (sc->sc_pps_mode & UART_PPS_NARROW_PULSE)
 119                 printf("-NarrowPulse");
 120         printf("\n");
 121 }
 122
 123 static int
 124 uart_pps_mode_sysctl(SYSCTL_HANDLER_ARGS)
 125 {
 126         struct uart_softc *sc;
 127         int err, tmp;
 128
 129         sc = arg1;
 130         tmp = sc->sc_pps_mode;
 131         err = sysctl_handle_int(oidp, &tmp, 0, req);
 132         if (err != 0 || req->newptr == NULL)
 133                 return (err);
 134         if (!uart_pps_mode_valid(tmp))
 135                 return (EINVAL);
 136         sc->sc_pps_mode = tmp;
 137         return(0);
 138 }
 139
 140 static void
 141 uart_pps_process(struct uart_softc *sc, int ser_sig)
 142 {
 143         sbintime_t now;
 144         int is_assert, pps_sig;
 145
 146         /* Which signal is configured as PPS?  Early out if none. */
 147         switch(sc->sc_pps_mode & UART_PPS_SIGNAL_MASK) {
 148         case UART_PPS_CTS:
 149                 pps_sig = SER_CTS;
 150                 break;
 151         case UART_PPS_DCD:
 152                 pps_sig = SER_DCD;
 153                 break;
 154         default:
 155                 return;
 156         }
 157
 158         /* Early out if there is no change in the signal configured as PPS. */
 159         if ((ser_sig & SER_DELTA(pps_sig)) == 0)
 160                 return;
 161
 162         /*
 163          * In narrow-pulse mode we need to synthesize both capture and clear
 164          * events from a single "delta occurred" indication from the uart
 165          * hardware because the pulse width is too narrow to reliably detect
 166          * both edges.  However, when the pulse width is close to our interrupt
 167          * processing latency we might intermittantly catch both edges.  To
 168          * guard against generating spurious events when that happens, we use a
 169          * separate timer to ensure at least half a second elapses before we
 170          * generate another event.
 171          */
 172         pps_capture(&sc->sc_pps);
 173         if (sc->sc_pps_mode & UART_PPS_NARROW_PULSE) {
 174                 now = getsbinuptime();
 175                 if (now > sc->sc_pps_captime + 500 * SBT_1MS) {
 176                         sc->sc_pps_captime = now;
 177                         pps_event(&sc->sc_pps, PPS_CAPTUREASSERT);
 178                         pps_event(&sc->sc_pps, PPS_CAPTURECLEAR);
 179                 }
 180         } else  {
 181                 is_assert = ser_sig & pps_sig;
 182                 if (sc->sc_pps_mode & UART_PPS_INVERT_PULSE)
 183                         is_assert = !is_assert;
 184                 pps_event(&sc->sc_pps, is_assert ? PPS_CAPTUREASSERT :
 185                     PPS_CAPTURECLEAR);
 186         }
 187 }
 188
 189 static void
 190 uart_pps_init(struct uart_softc *sc)
 191 {
 192         struct sysctl_ctx_list *ctx;
 193         struct sysctl_oid *tree;
 194
 195         ctx = device_get_sysctl_ctx(sc->sc_dev);
 196         tree = device_get_sysctl_tree(sc->sc_dev);
 197
 198         /*
 199          * The historical default for pps capture mode is either DCD or CTS,
 200          * depending on the UART_PPS_ON_CTS kernel option.  Start with that,
 201          * then try to fetch the tunable that overrides the mode for all uart
 202          * devices, then try to fetch the sysctl-tunable that overrides the mode
 203          * for one specific device.
 204          */
 205 #ifdef UART_PPS_ON_CTS
 206         sc->sc_pps_mode = UART_PPS_CTS;
 207 #else
 208         sc->sc_pps_mode = UART_PPS_DCD;
 209 #endif
 210         TUNABLE_INT_FETCH("hw.uart.pps_mode", &sc->sc_pps_mode);
 211         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(tree), OID_AUTO, "pps_mode",
 212             CTLTYPE_INT | CTLFLAG_RWTUN, sc, 0, uart_pps_mode_sysctl, "I",
 213             "pulse mode: 0/1/2=disabled/CTS/DCD; "
 214             "add 0x10 to invert, 0x20 for narrow pulse");
 215
 216         if (!uart_pps_mode_valid(sc->sc_pps_mode)) {
 217                 device_printf(sc->sc_dev,
 218                     "Invalid pps_mode 0x%02x configured; disabling PPS capture\n",
 219                     sc->sc_pps_mode);
 220                 sc->sc_pps_mode = UART_PPS_DISABLED;
 221         } else if (bootverbose) {
 222                 uart_pps_print_mode(sc);
 223         }
 224
 225         sc->sc_pps.ppscap = PPS_CAPTUREBOTH;
 226         sc->sc_pps.driver_mtx = uart_tty_getlock(sc);
 227         sc->sc_pps.driver_abi = PPS_ABI_VERSION;
 228         pps_init_abi(&sc->sc_pps);
 229 }
 230
 231 void
 232 uart_add_sysdev(struct uart_devinfo *di)
 233 {
 234         SLIST_INSERT_HEAD(&uart_sysdevs, di, next);
 235 }
 236
 237 const char *
 238 uart_getname(struct uart_class *uc)
 239 {
 240         return ((uc != NULL) ? uc->name : NULL);
 241 }
 242
 243 struct uart_ops *
 244 uart_getops(struct uart_class *uc)
 245 {
 246         return ((uc != NULL) ? uc->uc_ops : NULL);
 247 }
 248
 249 int
 250 uart_getrange(struct uart_class *uc)
 251 {
 252         return ((uc != NULL) ? uc->uc_range : 0);
 253 }
 254
 255 u_int
 256 uart_getregshift(struct uart_class *uc)
 257 {
 258         return ((uc != NULL) ? uc->uc_rshift : 0);
 259 }
 260
 261 u_int
 262 uart_getregiowidth(struct uart_class *uc)
 263 {
 264         return ((uc != NULL) ? uc->uc_riowidth : 0);
 265 }
 266
 267 /*
 268  * Schedule a soft interrupt. We do this on the 0 to !0 transition
 269  * of the TTY pending interrupt status.
 270  */
 271 void
 272 uart_sched_softih(struct uart_softc *sc, uint32_t ipend)
 273 {
 274         uint32_t new, old;
 275
 276         do {
 277                 old = sc->sc_ttypend;
 278                 new = old | ipend;
 279         } while (!atomic_cmpset_32(&sc->sc_ttypend, old, new));
 280
 281         if ((old & SER_INT_MASK) == 0)
 282                 swi_sched(sc->sc_softih, 0);
 283 }
 284
 285 /*
 286  * A break condition has been detected. We treat the break condition as
 287  * a special case that should not happen during normal operation. When
 288  * the break condition is to be passed to higher levels in the form of
 289  * a NUL character, we really want the break to be in the right place in
 290  * the input stream. The overhead to achieve that is not in relation to
 291  * the exceptional nature of the break condition, so we permit ourselves
 292  * to be sloppy.
 293  */
 294 static __inline int
 295 uart_intr_break(void *arg)
 296 {
 297         struct uart_softc *sc = arg;
 298
 299 #if defined(KDB)
 300         if (sc->sc_sysdev != NULL && sc->sc_sysdev->type == UART_DEV_CONSOLE) {
 301                 if (kdb_break())
 302                         return (0);
 303         }
 304 #endif
 305         if (sc->sc_opened)
 306                 uart_sched_softih(sc, SER_INT_BREAK);
 307         return (0);
 308 }
 309
 310 /*
 311  * Handle a receiver overrun situation. We lost at least 1 byte in the
 312  * input stream and it's our job to contain the situation. We grab as
 313  * much of the data we can, but otherwise flush the receiver FIFO to
 314  * create some breathing room. The net effect is that we avoid the
 315  * overrun condition to happen for the next X characters, where X is
 316  * related to the FIFO size at the cost of losing data right away.
 317  * So, instead of having multiple overrun interrupts in close proximity
 318  * to each other and possibly pessimizing UART interrupt latency for
 319  * other UARTs in a multiport configuration, we create a longer segment
 320  * of missing characters by freeing up the FIFO.
 321  * Each overrun condition is marked in the input buffer by a token. The
 322  * token represents the loss of at least one, but possible more bytes in
 323  * the input stream.
 324  */
 325 static __inline int
 326 uart_intr_overrun(void *arg)
 327 {
 328         struct uart_softc *sc = arg;
 329
 330         if (sc->sc_opened) {
 331                 UART_RECEIVE(sc);
 332                 if (uart_rx_put(sc, UART_STAT_OVERRUN))
 333                         sc->sc_rxbuf[sc->sc_rxput] = UART_STAT_OVERRUN;
 334                 uart_sched_softih(sc, SER_INT_RXREADY);
 335         }
 336         UART_FLUSH(sc, UART_FLUSH_RECEIVER);
 337         return (0);
 338 }
 339
 340 /*
 341  * Received data ready.
 342  */
 343 static __inline int
 344 uart_intr_rxready(void *arg)
 345 {
 346         struct uart_softc *sc = arg;
 347         int rxp;
 348
 349         rxp = sc->sc_rxput;
 350         UART_RECEIVE(sc);
 351 #if defined(KDB)
 352         if (sc->sc_sysdev != NULL && sc->sc_sysdev->type == UART_DEV_CONSOLE) {
 353                 while (rxp != sc->sc_rxput) {
 354                         kdb_alt_break(sc->sc_rxbuf[rxp++], &sc->sc_altbrk);
 355                         if (rxp == sc->sc_rxbufsz)
 356                                 rxp = 0;
 357                 }
 358         }
 359 #endif
 360         if (sc->sc_opened)
 361                 uart_sched_softih(sc, SER_INT_RXREADY);
 362         else
 363                 sc->sc_rxput = sc->sc_rxget;    /* Ignore received data. */
 364         return (1);
 365 }
 366
 367 /*
 368  * Line or modem status change (OOB signalling).
 369  * We pass the signals to the software interrupt handler for further
 370  * processing. Note that we merge the delta bits, but set the state
 371  * bits. This is to avoid losing state transitions due to having more
 372  * than 1 hardware interrupt between software interrupts.
 373  */
 374 static __inline int
 375 uart_intr_sigchg(void *arg)
 376 {
 377         struct uart_softc *sc = arg;
 378         int new, old, sig;
 379
 380         sig = UART_GETSIG(sc);
 381
 382         /*
 383          * Time pulse counting support, invoked whenever the PPS parameters are
 384          * currently set to capture either edge of the signal.
 385          */
 386         if (sc->sc_pps.ppsparam.mode & PPS_CAPTUREBOTH) {
 387                 uart_pps_process(sc, sig);
 388         }
 389
 390         /*
 391          * Keep track of signal changes, even when the device is not
 392          * opened. This allows us to inform upper layers about a
 393          * possible loss of DCD and thus the existence of a (possibly)
 394          * different connection when we have DCD back, during the time
 395          * that the device was closed.
 396          */
 397         do {
 398                 old = sc->sc_ttypend;
 399                 new = old & ~SER_MASK_STATE;
 400                 new |= sig & SER_INT_SIGMASK;
 401         } while (!atomic_cmpset_32(&sc->sc_ttypend, old, new));
 402
 403         if (sc->sc_opened)
 404                 uart_sched_softih(sc, SER_INT_SIGCHG);
 405         return (1);
 406 }
 407
 408 /*
 409  * The transmitter can accept more data.
 410  */
 411 static __inline int
 412 uart_intr_txidle(void *arg)
 413 {
 414         struct uart_softc *sc = arg;
 415
 416         if (sc->sc_txbusy) {
 417                 sc->sc_txbusy = 0;
 418                 uart_sched_softih(sc, SER_INT_TXIDLE);
 419         }
 420         return (0);
 421 }
 422
 423 static int
 424 uart_intr(void *arg)
 425 {
 426         struct uart_softc *sc = arg;
 427         int cnt, ipend, testintr;
 428
 429         if (sc->sc_leaving)
 430                 return (FILTER_STRAY);
 431
 432         cnt = 0;
 433         testintr = sc->sc_testintr;
 434         while ((!testintr || cnt < 20) && (ipend = UART_IPEND(sc)) != 0) {
 435                 cnt++;
 436                 if (ipend & SER_INT_OVERRUN)
 437                         uart_intr_overrun(sc);
 438                 if (ipend & SER_INT_BREAK)
 439                         uart_intr_break(sc);
 440                 if (ipend & SER_INT_RXREADY)
 441                         uart_intr_rxready(sc);
 442                 if (ipend & SER_INT_SIGCHG)
 443                         uart_intr_sigchg(sc);
 444                 if (ipend & SER_INT_TXIDLE)
 445                         uart_intr_txidle(sc);
 446         }
 447
 448         if (sc->sc_polled) {
 449                 callout_reset(&sc->sc_timer, hz / uart_poll_freq,
 450                     (timeout_t *)uart_intr, sc);
 451         }
 452
 453         return ((cnt == 0) ? FILTER_STRAY :
 454             ((testintr && cnt == 20) ? FILTER_SCHEDULE_THREAD :
 455             FILTER_HANDLED));
 456 }
 457
 458 serdev_intr_t *
 459 uart_bus_ihand(device_t dev, int ipend)
 460 {
 461
 462         switch (ipend) {
 463         case SER_INT_BREAK:
 464                 return (uart_intr_break);
 465         case SER_INT_OVERRUN:
 466                 return (uart_intr_overrun);
 467         case SER_INT_RXREADY:
 468                 return (uart_intr_rxready);
 469         case SER_INT_SIGCHG:
 470                 return (uart_intr_sigchg);
 471         case SER_INT_TXIDLE:
 472                 return (uart_intr_txidle);
 473         }
 474         return (NULL);
 475 }
 476
 477 int
 478 uart_bus_ipend(device_t dev)
 479 {
 480         struct uart_softc *sc;
 481
 482         sc = device_get_softc(dev);
 483         return (UART_IPEND(sc));
 484 }
 485
 486 int
 487 uart_bus_sysdev(device_t dev)
 488 {
 489         struct uart_softc *sc;
 490
 491         sc = device_get_softc(dev);
 492         return ((sc->sc_sysdev != NULL) ? 1 : 0);
 493 }
 494
 495 int
 496 uart_bus_probe(device_t dev, int regshft, int regiowidth, int rclk, int rid, int chan)
 497 {
 498         struct uart_softc *sc;
 499         struct uart_devinfo *sysdev;
 500         int error;
 501
 502         sc = device_get_softc(dev);
 503
 504         /*
 505          * All uart_class references are weak. Check that the needed
 506          * class has been compiled-in. Fail if not.
 507          */
 508         if (sc->sc_class == NULL)
 509                 return (ENXIO);
 510
 511         /*
 512          * Initialize the instance. Note that the instance (=softc) does
 513          * not necessarily match the hardware specific softc. We can't do
 514          * anything about it now, because we may not attach to the device.
 515          * Hardware drivers cannot use any of the class specific fields
 516          * while probing.
 517          */
 518         kobj_init((kobj_t)sc, (kobj_class_t)sc->sc_class);
 519         sc->sc_dev = dev;
 520         if (device_get_desc(dev) == NULL)
 521                 device_set_desc(dev, uart_getname(sc->sc_class));
 522
 523         /*
 524          * Allocate the register resource. We assume that all UARTs have
 525          * a single register window in either I/O port space or memory
 526          * mapped I/O space. Any UART that needs multiple windows will
 527          * consequently not be supported by this driver as-is. We try I/O
 528          * port space first because that's the common case.
 529          */
 530         sc->sc_rrid = rid;
 531         sc->sc_rtype = SYS_RES_IOPORT;
 532         sc->sc_rres = bus_alloc_resource_any(dev, sc->sc_rtype, &sc->sc_rrid,
 533             RF_ACTIVE);
 534         if (sc->sc_rres == NULL) {
 535                 sc->sc_rrid = rid;
 536                 sc->sc_rtype = SYS_RES_MEMORY;
 537                 sc->sc_rres = bus_alloc_resource_any(dev, sc->sc_rtype,
 538                     &sc->sc_rrid, RF_ACTIVE);
 539                 if (sc->sc_rres == NULL)
 540                         return (ENXIO);
 541         }
 542
 543         /*
 544          * Fill in the bus access structure and compare this device with
 545          * a possible console device and/or a debug port. We set the flags
 546          * in the softc so that the hardware dependent probe can adjust
 547          * accordingly. In general, you don't want to permanently disrupt
 548          * console I/O.
 549          */
 550         sc->sc_bas.bsh = rman_get_bushandle(sc->sc_rres);
 551         sc->sc_bas.bst = rman_get_bustag(sc->sc_rres);
 552         sc->sc_bas.chan = chan;
 553         sc->sc_bas.regshft = regshft;
 554         sc->sc_bas.regiowidth = regiowidth;
 555         sc->sc_bas.rclk = (rclk == 0) ? sc->sc_class->uc_rclk : rclk;
 556
 557         SLIST_FOREACH(sysdev, &uart_sysdevs, next) {
 558                 if (chan == sysdev->bas.chan &&
 559                     uart_cpu_eqres(&sc->sc_bas, &sysdev->bas)) {
 560                         /* XXX check if ops matches class. */
 561                         sc->sc_sysdev = sysdev;
 562                         sysdev->bas.rclk = sc->sc_bas.rclk;
 563                 }
 564         }
 565
 566         error = UART_PROBE(sc);
 567         bus_release_resource(dev, sc->sc_rtype, sc->sc_rrid, sc->sc_rres);
 568         return ((error) ? error : BUS_PROBE_DEFAULT);
 569 }
 570
 571 int
 572 uart_bus_attach(device_t dev)
 573 {
 574         struct uart_softc *sc, *sc0;
 575         const char *sep;
 576         int error, filt;
 577
 578         /*
 579          * The sc_class field defines the type of UART we're going to work
 580          * with and thus the size of the softc. Replace the generic softc
 581          * with one that matches the UART now that we're certain we handle
 582          * the device.
 583          */
 584         sc0 = device_get_softc(dev);
 585         if (sc0->sc_class->size > device_get_driver(dev)->size) {
 586                 sc = malloc(sc0->sc_class->size, M_UART, M_WAITOK|M_ZERO);
 587                 bcopy(sc0, sc, sizeof(*sc));
 588                 device_set_softc(dev, sc);
 589         } else
 590                 sc = sc0;
 591
 592         /*
 593          * Now that we know the softc for this device, connect the back
 594          * pointer from the sysdev for this device, if any
 595          */
 596         if (sc->sc_sysdev != NULL)
 597                 sc->sc_sysdev->sc = sc;
 598
 599         /*
 600          * Protect ourselves against interrupts while we're not completely
 601          * finished attaching and initializing. We don't expect interrupts
 602          * until after UART_ATTACH(), though.
 603          */
 604         sc->sc_leaving = 1;
 605
 606         mtx_init(&sc->sc_hwmtx_s, "uart_hwmtx", NULL, MTX_SPIN);
 607         if (sc->sc_hwmtx == NULL)
 608                 sc->sc_hwmtx = &sc->sc_hwmtx_s;
 609
 610         /*
 611          * Re-allocate. We expect that the softc contains the information
 612          * collected by uart_bus_probe() intact.
 613          */
 614         sc->sc_rres = bus_alloc_resource_any(dev, sc->sc_rtype, &sc->sc_rrid,
 615             RF_ACTIVE);
 616         if (sc->sc_rres == NULL) {
 617                 mtx_destroy(&sc->sc_hwmtx_s);
 618                 return (ENXIO);
 619         }
 620         sc->sc_bas.bsh = rman_get_bushandle(sc->sc_rres);
 621         sc->sc_bas.bst = rman_get_bustag(sc->sc_rres);
 622
 623         /*
 624          * Ensure there is room for at least three full FIFOs of data in the
 625          * receive buffer (handles the case of low-level drivers with huge
 626          * FIFOs), and also ensure that there is no less than the historical
 627          * size of 384 bytes (handles the typical small-FIFO case).
 628          */
 629         sc->sc_rxbufsz = MAX(384, sc->sc_rxfifosz * 3);
 630         sc->sc_rxbuf = malloc(sc->sc_rxbufsz * sizeof(*sc->sc_rxbuf),
 631             M_UART, M_WAITOK);
 632         sc->sc_txbuf = malloc(sc->sc_txfifosz * sizeof(*sc->sc_txbuf),
 633             M_UART, M_WAITOK);
 634
 635         error = UART_ATTACH(sc);
 636         if (error)
 637                 goto fail;
 638
 639         if (sc->sc_hwiflow || sc->sc_hwoflow) {
 640                 sep = "";
 641                 device_print_prettyname(dev);
 642                 if (sc->sc_hwiflow) {
 643                         printf("%sRTS iflow", sep);
 644                         sep = ", ";
 645                 }
 646                 if (sc->sc_hwoflow) {
 647                         printf("%sCTS oflow", sep);
 648                         sep = ", ";
 649                 }
 650                 printf("\n");
 651         }
 652
 653         if (sc->sc_sysdev != NULL) {
 654                 if (sc->sc_sysdev->baudrate == 0) {
 655                         if (UART_IOCTL(sc, UART_IOCTL_BAUD,
 656                             (intptr_t)&sc->sc_sysdev->baudrate) != 0)
 657                                 sc->sc_sysdev->baudrate = -1;
 658                 }
 659                 switch (sc->sc_sysdev->type) {
 660                 case UART_DEV_CONSOLE:
 661                         device_printf(dev, "console");
 662                         break;
 663                 case UART_DEV_DBGPORT:
 664                         device_printf(dev, "debug port");
 665                         break;
 666                 case UART_DEV_KEYBOARD:
 667                         device_printf(dev, "keyboard");
 668                         break;
 669                 default:
 670                         device_printf(dev, "unknown system device");
 671                         break;
 672                 }
 673                 printf(" (%d,%c,%d,%d)\n", sc->sc_sysdev->baudrate,
 674                     "noems"[sc->sc_sysdev->parity], sc->sc_sysdev->databits,
 675                     sc->sc_sysdev->stopbits);
 676         }
 677
 678         sc->sc_leaving = 0;
 679         sc->sc_testintr = 1;
 680         filt = uart_intr(sc);
 681         sc->sc_testintr = 0;
 682
 683         /*
 684          * Don't use interrupts if we couldn't clear any pending interrupt
 685          * conditions. We may have broken H/W and polling is probably the
 686          * safest thing to do.
 687          */
 688         if (filt != FILTER_SCHEDULE_THREAD && !uart_force_poll) {
 689                 sc->sc_ires = bus_alloc_resource_any(dev, SYS_RES_IRQ,
 690                     &sc->sc_irid, RF_ACTIVE | RF_SHAREABLE);
 691         }
 692         if (sc->sc_ires != NULL) {
 693                 error = bus_setup_intr(dev, sc->sc_ires, INTR_TYPE_TTY,
 694                     uart_intr, NULL, sc, &sc->sc_icookie);
 695                 sc->sc_fastintr = (error == 0) ? 1 : 0;
 696
 697                 if (!sc->sc_fastintr)
 698                         error = bus_setup_intr(dev, sc->sc_ires,
 699                             INTR_TYPE_TTY | INTR_MPSAFE, NULL,
 700                             (driver_intr_t *)uart_intr, sc, &sc->sc_icookie);
 701
 702                 if (error) {
 703                         device_printf(dev, "could not activate interrupt\n");
 704                         bus_release_resource(dev, SYS_RES_IRQ, sc->sc_irid,
 705                             sc->sc_ires);
 706                         sc->sc_ires = NULL;
 707                 }
 708         }
 709         if (sc->sc_ires == NULL) {
 710                 /* No interrupt resource. Force polled mode. */
 711                 sc->sc_polled = 1;
 712                 callout_init(&sc->sc_timer, 1);
 713                 callout_reset(&sc->sc_timer, hz / uart_poll_freq,
 714                     (timeout_t *)uart_intr, sc);
 715         }
 716
 717         if (bootverbose && (sc->sc_fastintr || sc->sc_polled)) {
 718                 sep = "";
 719                 device_print_prettyname(dev);
 720                 if (sc->sc_fastintr) {
 721                         printf("%sfast interrupt", sep);
 722                         sep = ", ";
 723                 }
 724                 if (sc->sc_polled) {
 725                         printf("%spolled mode (%dHz)", sep, uart_poll_freq);
 726                         sep = ", ";
 727                 }
 728                 printf("\n");
 729         }
 730
 731         if (sc->sc_sysdev != NULL && sc->sc_sysdev->attach != NULL) {
 732                 if ((error = sc->sc_sysdev->attach(sc)) != 0)
 733                         goto fail;
 734         } else {
 735                 if ((error = uart_tty_attach(sc)) != 0)
 736                         goto fail;
 737                 uart_pps_init(sc);
 738         }
 739
 740         if (sc->sc_sysdev != NULL)
 741                 sc->sc_sysdev->hwmtx = sc->sc_hwmtx;
 742
 743         return (0);
 744
 745  fail:
 746         free(sc->sc_txbuf, M_UART);
 747         free(sc->sc_rxbuf, M_UART);
 748
 749         if (sc->sc_ires != NULL) {
 750                 bus_teardown_intr(dev, sc->sc_ires, sc->sc_icookie);
 751                 bus_release_resource(dev, SYS_RES_IRQ, sc->sc_irid,
 752                     sc->sc_ires);
 753         }
 754         bus_release_resource(dev, sc->sc_rtype, sc->sc_rrid, sc->sc_rres);
 755
 756         mtx_destroy(&sc->sc_hwmtx_s);
 757
 758         return (error);
 759 }
 760
 761 int
 762 uart_bus_detach(device_t dev)
 763 {
 764         struct uart_softc *sc;
 765
 766         sc = device_get_softc(dev);
 767
 768         sc->sc_leaving = 1;
 769
 770         if (sc->sc_sysdev != NULL)
 771                 sc->sc_sysdev->hwmtx = NULL;
 772
 773         UART_DETACH(sc);
 774
 775         if (sc->sc_sysdev != NULL && sc->sc_sysdev->detach != NULL)
 776                 (*sc->sc_sysdev->detach)(sc);
 777         else
 778                 uart_tty_detach(sc);
 779
 780         free(sc->sc_txbuf, M_UART);
 781         free(sc->sc_rxbuf, M_UART);
 782
 783         if (sc->sc_ires != NULL) {
 784                 bus_teardown_intr(dev, sc->sc_ires, sc->sc_icookie);
 785                 bus_release_resource(dev, SYS_RES_IRQ, sc->sc_irid,
 786                     sc->sc_ires);
 787         }
 788         bus_release_resource(dev, sc->sc_rtype, sc->sc_rrid, sc->sc_rres);
 789
 790         mtx_destroy(&sc->sc_hwmtx_s);
 791
 792         if (sc->sc_class->size > device_get_driver(dev)->size) {
 793                 device_set_softc(dev, NULL);
 794                 free(sc, M_UART);
 795         }
 796
 797         return (0);
 798 }
 799
 800 int
 801 uart_bus_resume(device_t dev)
 802 {
 803         struct uart_softc *sc;
 804
 805         sc = device_get_softc(dev);
 806         return (UART_ATTACH(sc));
 807 }
 808
 809 void
 810 uart_grab(struct uart_devinfo *di)
 811 {
 812
 813         if (di->sc)
 814                 UART_GRAB(di->sc);
 815 }
 816
 817 void
 818 uart_ungrab(struct uart_devinfo *di)
 819 {
 820
 821         if (di->sc)
 822                 UART_UNGRAB(di->sc);
 823 }