4 * Copyright (c) 1991 The Regents of the University of California.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by the University of
18 * California, Berkeley and its contributors.
19 * 4. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * $FreeBSD: src/sys/isa/sio.c,v 1.291.2.35 2003/05/18 08:51:15 murray Exp $
36 * from: @(#)com.c 7.5 (Berkeley) 5/16/91
37 * from: i386/isa sio.c,v 1.234
40 #include "opt_comconsole.h"
41 #include "opt_compat.h"
48 * Serial driver, based on 386BSD-0.1 com driver.
49 * Mostly rewritten to use pseudo-DMA.
50 * Works for National Semiconductor NS8250-NS16550AF UARTs.
51 * COM driver, based on HP dca driver.
53 * Changes for PC-Card integration:
54 * - Added PC-Card driver table and handlers
56 #include <sys/param.h>
57 #include <sys/systm.h>
58 #include <sys/reboot.h>
59 #include <sys/malloc.h>
63 #include <sys/module.h>
65 #include <sys/dkstat.h>
66 #include <sys/fcntl.h>
67 #include <sys/interrupt.h>
68 #include <sys/kernel.h>
69 #include <sys/syslog.h>
70 #include <sys/sysctl.h>
73 #include <sys/timepps.h>
74 #include <sys/thread2.h>
75 #include <sys/devfs.h>
76 #include <sys/consio.h>
78 #include <machine/limits.h>
80 #include <bus/isa/isareg.h>
81 #include <bus/isa/isavar.h>
83 #include <bus/pci/pcireg.h>
84 #include <bus/pci/pcivar.h>
87 #include <dev/misc/puc/pucvar.h>
89 #include <machine/lock.h>
91 #include <machine/clock.h>
94 #include "sio_private.h"
97 #include "../ic_layer/esp.h"
100 #define LOTS_OF_EVENTS 64 /* helps separate urgent events from input */
102 #define CALLOUT_MASK 0x80
103 #define CONTROL_MASK 0x60
104 #define CONTROL_INIT_STATE 0x20
105 #define CONTROL_LOCK_STATE 0x40
106 #define DEV_TO_UNIT(dev) (MINOR_TO_UNIT(minor(dev)))
107 #define MINOR_TO_UNIT(mynor) ((((mynor) & ~0xffffU) >> (8 + 3)) \
109 #define UNIT_TO_MINOR(unit) ((((unit) & ~0x1fU) << (8 + 3)) \
112 #define com_scr 7 /* scratch register for 16450-16550 (R/W) */
114 #define sio_getreg(com, off) \
115 (bus_space_read_1((com)->bst, (com)->bsh, (off)))
116 #define sio_setreg(com, off, value) \
117 (bus_space_write_1((com)->bst, (com)->bsh, (off), (value)))
121 * (CS_BUSY | CS_TTGO) and (CS_BUSY | CS_TTGO | CS_ODEVREADY) must be higher
122 * than the other bits so that they can be tested as a group without masking
125 * The following com and tty flags correspond closely:
126 * CS_BUSY = TS_BUSY (maintained by comstart(), siopoll() and
128 * CS_TTGO = ~TS_TTSTOP (maintained by comparam() and comstart())
129 * CS_CTS_OFLOW = CCTS_OFLOW (maintained by comparam())
130 * CS_RTS_IFLOW = CRTS_IFLOW (maintained by comparam())
131 * TS_FLUSH is not used.
132 * XXX I think TIOCSETA doesn't clear TS_TTSTOP when it clears IXON.
133 * XXX CS_*FLOW should be CF_*FLOW in com->flags (control flags not state).
135 #define CS_BUSY 0x80 /* output in progress */
136 #define CS_TTGO 0x40 /* output not stopped by XOFF */
137 #define CS_ODEVREADY 0x20 /* external device h/w ready (CTS) */
138 #define CS_CHECKMSR 1 /* check of MSR scheduled */
139 #define CS_CTS_OFLOW 2 /* use CTS output flow control */
140 #define CS_DTR_OFF 0x10 /* DTR held off */
141 #define CS_ODONE 4 /* output completed */
142 #define CS_RTS_IFLOW 8 /* use RTS input flow control */
143 #define CSE_BUSYCHECK 1 /* siobusycheck() scheduled */
145 static char const * const error_desc[] = {
148 #define CE_INTERRUPT_BUF_OVERFLOW 1
149 "interrupt-level buffer overflow",
150 #define CE_TTY_BUF_OVERFLOW 2
151 "tty-level buffer overflow",
155 static int espattach (struct com_s *com, Port_t esp_port);
157 static int sio_isa_attach (device_t dev);
159 static timeout_t siobusycheck;
160 static u_int siodivisor (u_long rclk, speed_t speed);
161 static timeout_t siodtrwakeup;
162 static void comhardclose (struct com_s *com);
163 static void sioinput (struct com_s *com);
164 static void siointr1 (struct com_s *com);
165 static void siointr (void *arg);
166 static int commctl (struct com_s *com, int bits, int how);
167 static int comparam (struct tty *tp, struct termios *t);
168 static inthand2_t siopoll;
169 static int sio_isa_probe (device_t dev);
170 static void siosettimeout (void);
171 static int siosetwater (struct com_s *com, speed_t speed);
172 static void comstart (struct tty *tp);
173 static void comstop (struct tty *tp, int rw);
174 static timeout_t comwakeup;
175 static void disc_optim (struct tty *tp, struct termios *t,
179 static int sio_pci_attach (device_t dev);
180 static void sio_pci_kludge_unit (device_t dev);
181 static int sio_pci_probe (device_t dev);
182 #endif /* NPCI > 0 */
185 static int sio_puc_attach (device_t dev);
186 static int sio_puc_probe (device_t dev);
187 #endif /* NPUC > 0 */
189 static char driver_name[] = "sio";
191 /* table and macro for fast conversion from a unit number to its com struct */
192 devclass_t sio_devclass;
193 #define com_addr(unit) ((struct com_s *) \
194 devclass_get_softc(sio_devclass, unit))
196 static device_method_t sio_isa_methods[] = {
197 /* Device interface */
198 DEVMETHOD(device_probe, sio_isa_probe),
199 DEVMETHOD(device_attach, sio_isa_attach),
204 static driver_t sio_isa_driver = {
207 sizeof(struct com_s),
211 static device_method_t sio_pci_methods[] = {
212 /* Device interface */
213 DEVMETHOD(device_probe, sio_pci_probe),
214 DEVMETHOD(device_attach, sio_pci_attach),
219 static driver_t sio_pci_driver = {
222 sizeof(struct com_s),
224 #endif /* NPCI > 0 */
227 static device_method_t sio_puc_methods[] = {
228 /* Device interface */
229 DEVMETHOD(device_probe, sio_puc_probe),
230 DEVMETHOD(device_attach, sio_puc_attach),
235 static driver_t sio_puc_driver = {
238 sizeof(struct com_s),
240 #endif /* NPUC > 0 */
242 static d_open_t sioopen;
243 static d_close_t sioclose;
244 static d_read_t sioread;
245 static d_write_t siowrite;
246 static d_ioctl_t sioioctl;
248 static struct dev_ops sio_ops = {
249 { driver_name, 0, D_TTY },
255 .d_kqfilter = ttykqfilter,
256 .d_revoke = ttyrevoke
260 static volatile speed_t comdefaultrate = CONSPEED;
261 static u_long comdefaultrclk = DEFAULT_RCLK;
262 SYSCTL_ULONG(_machdep, OID_AUTO, conrclk, CTLFLAG_RW, &comdefaultrclk, 0, "");
263 static u_int com_events; /* input chars + weighted output completions */
264 static Port_t siocniobase;
265 static int siocnunit;
266 static Port_t siogdbiobase;
267 static int siogdbunit = -1;
268 static bool_t sio_registered;
269 static int sio_timeout;
270 static int sio_timeouts_until_log;
271 static struct callout sio_timeout_handle;
272 static int sio_numunits;
275 /* XXX configure this properly. */
276 static Port_t likely_com_ports[] = { 0x3f8, 0x2f8, 0x3e8, 0x2e8, };
277 static Port_t likely_esp_ports[] = { 0x140, 0x180, 0x280, 0 };
281 * handle sysctl read/write requests for console speed
283 * In addition to setting comdefaultrate for I/O through /dev/console,
284 * also set the initial and lock values for the /dev/ttyXX device
285 * if there is one associated with the console. Finally, if the /dev/tty
286 * device has already been open, change the speed on the open running port
291 sysctl_machdep_comdefaultrate(SYSCTL_HANDLER_ARGS)
298 lwkt_gettoken(&tty_token);
299 newspeed = comdefaultrate;
301 error = sysctl_handle_opaque(oidp, &newspeed, sizeof newspeed, req);
302 if (error || !req->newptr) {
303 lwkt_reltoken(&tty_token);
307 comdefaultrate = newspeed;
309 if (comconsole < 0) { /* serial console not selected? */
310 lwkt_reltoken(&tty_token);
314 com = com_addr(comconsole);
316 lwkt_reltoken(&tty_token);
321 * set the initial and lock rates for /dev/ttydXX and /dev/cuaXX
322 * (note, the lock rates really are boolean -- if non-zero, disallow
325 com->it_in.c_ispeed = com->it_in.c_ospeed =
326 com->lt_in.c_ispeed = com->lt_in.c_ospeed =
327 com->it_out.c_ispeed = com->it_out.c_ospeed =
328 com->lt_out.c_ispeed = com->lt_out.c_ospeed = comdefaultrate;
331 * if we're open, change the running rate too
334 if (tp && (tp->t_state & TS_ISOPEN)) {
335 tp->t_termios.c_ispeed =
336 tp->t_termios.c_ospeed = comdefaultrate;
338 error = comparam(tp, &tp->t_termios);
341 lwkt_reltoken(&tty_token);
345 SYSCTL_PROC(_machdep, OID_AUTO, conspeed, CTLTYPE_INT | CTLFLAG_RW,
346 0, 0, sysctl_machdep_comdefaultrate, "I", "");
355 static struct pci_ids pci_ids[] = {
356 { 0x100812b9, "3COM PCI FaxModem", 0x10 },
357 { 0x2000131f, "CyberSerial (1-port) 16550", 0x10 },
358 { 0x01101407, "Koutech IOFLEX-2S PCI Dual Port Serial", 0x10 },
359 { 0x01111407, "Koutech IOFLEX-2S PCI Dual Port Serial", 0x10 },
360 { 0x048011c1, "Lucent kermit based PCI Modem", 0x14 },
361 { 0x95211415, "Oxford Semiconductor PCI Dual Port Serial", 0x10 },
362 { 0x7101135e, "SeaLevel Ultra 530.PCI Single Port Serial", 0x18 },
363 { 0x0000151f, "SmartLink 5634PCV SurfRider", 0x10 },
364 { 0x98459710, "Netmos Nm9845 PCI Bridge with Dual UART", 0x10 },
365 { 0x00000000, NULL, 0 }
369 sio_pci_attach(device_t dev)
374 type = pci_get_devid(dev);
376 while (id->type && id->type != type)
378 if (id->desc == NULL)
380 sio_pci_kludge_unit(dev);
381 return (sioattach(dev, id->rid, 0UL));
385 * Don't cut and paste this to other drivers. It is a horrible kludge
386 * which will fail to work and also be unnecessary in future versions.
389 sio_pci_kludge_unit(device_t dev)
398 while (resource_int_value("sio", unit, "port", &start) == 0 &&
401 if (device_get_unit(dev) < unit) {
402 dc = device_get_devclass(dev);
403 while (devclass_get_device(dc, unit))
405 device_printf(dev, "moving to sio%d\n", unit);
406 err = device_set_unit(dev, unit); /* EVIL DO NOT COPY */
408 device_printf(dev, "error moving device %d\n", err);
413 sio_pci_probe(device_t dev)
418 type = pci_get_devid(dev);
420 while (id->type && id->type != type)
422 if (id->desc == NULL)
424 device_set_desc(dev, id->desc);
425 return (sioprobe(dev, id->rid, 0UL));
427 #endif /* NPCI > 0 */
431 sio_puc_attach(device_t dev)
435 if (BUS_READ_IVAR(device_get_parent(dev), dev, PUC_IVAR_FREQ,
438 return (sioattach(dev, 0, rclk));
442 sio_puc_probe(device_t dev)
446 if (BUS_READ_IVAR(device_get_parent(dev), dev, PUC_IVAR_FREQ,
449 return (sioprobe(dev, 0, rclk));
453 static struct isa_pnp_id sio_ids[] = {
454 {0x0005d041, "Standard PC COM port"}, /* PNP0500 */
455 {0x0105d041, "16550A-compatible COM port"}, /* PNP0501 */
456 {0x0205d041, "Multiport serial device (non-intelligent 16550)"}, /* PNP0502 */
457 {0x1005d041, "Generic IRDA-compatible device"}, /* PNP0510 */
458 {0x1105d041, "Generic IRDA-compatible device"}, /* PNP0511 */
459 /* Devices that do not have a compatid */
460 {0x12206804, NULL}, /* ACH2012 - 5634BTS 56K Video Ready Modem */
461 {0x7602a904, NULL}, /* AEI0276 - 56K v.90 Fax Modem (LKT) */
462 {0x00007905, NULL}, /* AKY0000 - 56K Plug&Play Modem */
463 {0x21107905, NULL}, /* AKY1021 - 56K Plug&Play Modem */
464 {0x01405407, NULL}, /* AZT4001 - AZT3000 PnP SOUND DEVICE, MODEM */
465 {0x56039008, NULL}, /* BDP0356 - Best Data 56x2 */
466 {0x56159008, NULL}, /* BDP1556 - B.D. Smart One 56SPS,Voice Modem*/
467 {0x36339008, NULL}, /* BDP3336 - Best Data Prods. 336F */
468 {0x0014490a, NULL}, /* BRI1400 - Boca 33.6 PnP */
469 {0x0015490a, NULL}, /* BRI1500 - Internal Fax Data */
470 {0x0034490a, NULL}, /* BRI3400 - Internal ACF Modem */
471 {0x0094490a, NULL}, /* BRI9400 - Boca K56Flex PnP */
472 {0x00b4490a, NULL}, /* BRIB400 - Boca 56k PnP */
473 {0x0030320d, NULL}, /* CIR3000 - Cirrus Logic V43 */
474 {0x0100440e, NULL}, /* CRD0001 - Cardinal MVP288IV ? */
475 {0x01308c0e, NULL}, /* CTL3001 - Creative Labs Phoneblaster */
476 {0x36033610, NULL}, /* DAV0336 - DAVICOM 336PNP MODEM */
477 {0x01009416, NULL}, /* ETT0001 - E-Tech Bullet 33k6 PnP */
478 {0x0000aa1a, NULL}, /* FUJ0000 - FUJITSU Modem 33600 PNP/I2 */
479 {0x1200c31e, NULL}, /* GVC0012 - VF1128HV-R9 (win modem?) */
480 {0x0303c31e, NULL}, /* GVC0303 - MaxTech 33.6 PnP D/F/V */
481 {0x0505c31e, NULL}, /* GVC0505 - GVC 56k Faxmodem */
482 {0x0116c31e, NULL}, /* GVC1601 - Rockwell V.34 Plug & Play Modem */
483 {0x0050c31e, NULL}, /* GVC5000 - some GVC modem */
484 {0x3800f91e, NULL}, /* GWY0038 - Telepath with v.90 */
485 {0x9062f91e, NULL}, /* GWY6290 - Telepath with x2 Technology */
486 {0x8100e425, NULL}, /* IOD0081 - I-O DATA DEVICE,INC. IFML-560 */
487 {0x21002534, NULL}, /* MAE0021 - Jetstream Int V.90 56k Voice Series 2*/
488 {0x0000f435, NULL}, /* MOT0000 - Motorola ModemSURFR 33.6 Intern */
489 {0x5015f435, NULL}, /* MOT1550 - Motorola ModemSURFR 56K Modem */
490 {0xf015f435, NULL}, /* MOT15F0 - Motorola VoiceSURFR 56K Modem */
491 {0x6045f435, NULL}, /* MOT4560 - Motorola ? */
492 {0x61e7a338, NULL}, /* NECE761 - 33.6Modem */
493 {0x08804f3f, NULL}, /* OZO8008 - Zoom (33.6k Modem) */
494 {0x0f804f3f, NULL}, /* OZO800f - Zoom 2812 (56k Modem) */
495 {0x39804f3f, NULL}, /* OZO8039 - Zoom 56k flex */
496 {0x00914f3f, NULL}, /* OZO9100 - Zoom 2919 (K56 Faxmodem) */
497 {0x3024a341, NULL}, /* PMC2430 - Pace 56 Voice Internal Modem */
498 {0x1000eb49, NULL}, /* ROK0010 - Rockwell ? */
499 {0x1200b23d, NULL}, /* RSS0012 - OMRON ME5614ISA */
500 {0x5002734a, NULL}, /* RSS0250 - 5614Jx3(G) Internal Modem */
501 {0x6202734a, NULL}, /* RSS0262 - 5614Jx3[G] V90+K56Flex Modem */
502 {0x1010104d, NULL}, /* SHP1010 - Rockwell 33600bps Modem */
503 {0xc100ad4d, NULL}, /* SMM00C1 - Leopard 56k PnP */
504 {0x9012b04e, NULL}, /* SUP1290 - Supra ? */
505 {0x1013b04e, NULL}, /* SUP1310 - SupraExpress 336i PnP */
506 {0x8013b04e, NULL}, /* SUP1380 - SupraExpress 288i PnP Voice */
507 {0x8113b04e, NULL}, /* SUP1381 - SupraExpress 336i PnP Voice */
508 {0x5016b04e, NULL}, /* SUP1650 - Supra 336i Sp Intl */
509 {0x7016b04e, NULL}, /* SUP1670 - Supra 336i V+ Intl */
510 {0x7420b04e, NULL}, /* SUP2070 - Supra ? */
511 {0x8020b04e, NULL}, /* SUP2080 - Supra ? */
512 {0x8420b04e, NULL}, /* SUP2084 - SupraExpress 56i PnP */
513 {0x7121b04e, NULL}, /* SUP2171 - SupraExpress 56i Sp? */
514 {0x8024b04e, NULL}, /* SUP2480 - Supra ? */
515 {0x01007256, NULL}, /* USR0001 - U.S. Robotics Inc., Sportster W */
516 {0x02007256, NULL}, /* USR0002 - U.S. Robotics Inc. Sportster 33. */
517 {0x04007256, NULL}, /* USR0004 - USR Sportster 14.4k */
518 {0x06007256, NULL}, /* USR0006 - USR Sportster 33.6k */
519 {0x11007256, NULL}, /* USR0011 - USR ? */
520 {0x01017256, NULL}, /* USR0101 - USR ? */
521 {0x30207256, NULL}, /* USR2030 - U.S.Robotics Inc. Sportster 560 */
522 {0x50207256, NULL}, /* USR2050 - U.S.Robotics Inc. Sportster 33. */
523 {0x70207256, NULL}, /* USR2070 - U.S.Robotics Inc. Sportster 560 */
524 {0x30307256, NULL}, /* USR3030 - U.S. Robotics 56K FAX INT */
525 {0x31307256, NULL}, /* USR3031 - U.S. Robotics 56K FAX INT */
526 {0x50307256, NULL}, /* USR3050 - U.S. Robotics 56K FAX INT */
527 {0x70307256, NULL}, /* USR3070 - U.S. Robotics 56K Voice INT */
528 {0x90307256, NULL}, /* USR3090 - USR ? */
529 {0x70917256, NULL}, /* USR9170 - U.S. Robotics 56K FAX INT */
530 {0x90917256, NULL}, /* USR9190 - USR 56k Voice INT */
531 {0x0300695c, NULL}, /* WCI0003 - Fax/Voice/Modem/Speakphone/Asvd */
532 {0x01a0896a, NULL}, /* ZTIA001 - Zoom Internal V90 Faxmodem */
533 {0x61f7896a, NULL}, /* ZTIF761 - Zoom ComStar 33.6 */
540 sio_isa_probe(device_t dev)
542 /* Check isapnp ids */
543 if (ISA_PNP_PROBE(device_get_parent(dev), dev, sio_ids) == ENXIO)
545 return (sioprobe(dev, 0, 0UL));
549 sioprobe(device_t dev, int xrid, u_long rclk)
552 static bool_t already_init;
561 intrmask_t irqmap[4];
566 u_int flags = device_get_flags(dev);
568 struct resource *port;
571 port = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
572 0, ~0, IO_COMSIZE, RF_ACTIVE);
576 lwkt_gettoken(&tty_token);
577 com = device_get_softc(dev);
578 com->bst = rman_get_bustag(port);
579 com->bsh = rman_get_bushandle(port);
586 * XXX this is broken - when we are first called, there are no
587 * previously configured IO ports. We could hard code
588 * 0x3f8, 0x2f8, 0x3e8, 0x2e8 etc but that's probably worse.
589 * This code has been doing nothing since the conversion since
590 * "count" is zero the first time around.
594 * Turn off MCR_IENABLE for all likely serial ports. An unused
595 * port with its MCR_IENABLE gate open will inhibit interrupts
596 * from any used port that shares the interrupt vector.
597 * XXX the gate enable is elsewhere for some multiports.
600 int count, i, xioport;
602 devclass_get_devices(sio_devclass, &devs, &count);
603 for (i = 0; i < count; i++) {
605 if (device_is_enabled(xdev) &&
606 bus_get_resource(xdev, SYS_RES_IOPORT, 0, &xioport,
608 outb(xioport + com_mcr, 0);
615 if (COM_LLCONSOLE(flags)) {
616 kprintf("sio%d: reserved for low-level i/o\n",
617 device_get_unit(dev));
618 bus_release_resource(dev, SYS_RES_IOPORT, rid, port);
619 lwkt_reltoken(&tty_token);
624 * If the device is on a multiport card and has an AST/4
625 * compatible interrupt control register, initialize this
626 * register and prepare to leave MCR_IENABLE clear in the mcr.
627 * Otherwise, prepare to set MCR_IENABLE in the mcr.
628 * Point idev to the device struct giving the correct id_irq.
629 * This is the struct for the master device if there is one.
632 mcr_image = MCR_IENABLE;
634 if (COM_ISMULTIPORT(flags)) {
638 idev = devclass_get_device(sio_devclass, COM_MPMASTER(flags));
640 kprintf("sio%d: master device %d not configured\n",
641 device_get_unit(dev), COM_MPMASTER(flags));
644 if (!COM_NOTAST4(flags)) {
645 if (bus_get_resource(idev, SYS_RES_IOPORT, 0, &io,
648 if (bus_get_resource(idev, SYS_RES_IRQ, 0,
650 outb(xiobase + com_scr, 0x80);
652 outb(xiobase + com_scr, 0);
657 #endif /* COM_MULTIPORT */
658 if (bus_get_resource(idev, SYS_RES_IRQ, 0, NULL, NULL) != 0)
661 bzero(failures, sizeof failures);
662 iobase = rman_get_start(port);
665 * We don't want to get actual interrupts, just masked ones.
666 * Interrupts from this line should already be masked in the ICU,
667 * but mask them in the processor as well in case there are some
668 * (misconfigured) shared interrupts.
674 * For the TI16754 chips, set prescaler to 1 (4 is often the
675 * default after-reset value) as otherwise it's impossible to
676 * get highest baudrates.
678 if (COM_TI16754(flags)) {
681 cfcr = sio_getreg(com, com_cfcr);
682 sio_setreg(com, com_cfcr, CFCR_EFR_ENABLE);
683 efr = sio_getreg(com, com_efr);
684 /* Unlock extended features to turn off prescaler. */
685 sio_setreg(com, com_efr, efr | EFR_EFE);
687 sio_setreg(com, com_cfcr, (cfcr != CFCR_EFR_ENABLE) ? cfcr : 0);
688 /* Turn off prescaler. */
689 sio_setreg(com, com_mcr,
690 sio_getreg(com, com_mcr) & ~MCR_PRESCALE);
691 sio_setreg(com, com_cfcr, CFCR_EFR_ENABLE);
692 sio_setreg(com, com_efr, efr);
693 sio_setreg(com, com_cfcr, cfcr);
697 * Initialize the speed and the word size and wait long enough to
698 * drain the maximum of 16 bytes of junk in device output queues.
699 * The speed is undefined after a master reset and must be set
700 * before relying on anything related to output. There may be
701 * junk after a (very fast) soft reboot and (apparently) after
703 * XXX what about the UART bug avoided by waiting in comparam()?
704 * We don't want to to wait long enough to drain at 2 bps.
706 if (iobase == siocniobase) {
707 DELAY((16 + 1) * 1000000 / (comdefaultrate / 10));
709 sio_setreg(com, com_cfcr, CFCR_DLAB | CFCR_8BITS);
710 divisor = siodivisor(rclk, SIO_TEST_SPEED);
711 sio_setreg(com, com_dlbl, divisor & 0xff);
712 sio_setreg(com, com_dlbh, divisor >> 8);
713 sio_setreg(com, com_cfcr, CFCR_8BITS);
714 DELAY((16 + 1) * 1000000 / (SIO_TEST_SPEED / 10));
718 * Make sure we can drain the receiver. If we can't, the serial
719 * port may not exist.
721 for (fn = 0; fn < 256; ++fn) {
722 if ((sio_getreg(com, com_lsr) & LSR_RXRDY) == 0)
724 (void)sio_getreg(com, com_data);
728 lwkt_reltoken(&tty_token);
729 kprintf("sio%d: can't drain, serial port might "
730 "not exist, disabling\n", device_get_unit(dev));
735 * Enable the interrupt gate and disable device interupts. This
736 * should leave the device driving the interrupt line low and
737 * guarantee an edge trigger if an interrupt can be generated.
740 sio_setreg(com, com_mcr, mcr_image);
741 sio_setreg(com, com_ier, 0);
742 DELAY(1000); /* XXX */
743 irqmap[0] = isa_irq_pending();
746 * Attempt to set loopback mode so that we can send a null byte
747 * without annoying any external device.
750 sio_setreg(com, com_mcr, mcr_image | MCR_LOOPBACK);
753 * Attempt to generate an output interrupt. On 8250's, setting
754 * IER_ETXRDY generates an interrupt independent of the current
755 * setting and independent of whether the THR is empty. On 16450's,
756 * setting IER_ETXRDY generates an interrupt independent of the
757 * current setting. On 16550A's, setting IER_ETXRDY only
758 * generates an interrupt when IER_ETXRDY is not already set.
760 sio_setreg(com, com_ier, IER_ETXRDY);
763 * On some 16x50 incompatibles, setting IER_ETXRDY doesn't generate
764 * an interrupt. They'd better generate one for actually doing
765 * output. Loopback may be broken on the same incompatibles but
766 * it's unlikely to do more than allow the null byte out.
768 sio_setreg(com, com_data, 0);
769 DELAY((1 + 2) * 1000000 / (SIO_TEST_SPEED / 10));
772 * Turn off loopback mode so that the interrupt gate works again
773 * (MCR_IENABLE was hidden). This should leave the device driving
774 * an interrupt line high. It doesn't matter if the interrupt
775 * line oscillates while we are not looking at it, since interrupts
779 sio_setreg(com, com_mcr, mcr_image);
782 * Some pcmcia cards have the "TXRDY bug", so we check everyone
783 * for IIR_TXRDY implementation ( Palido 321s, DC-1S... )
785 if (COM_NOPROBE(flags)) {
786 /* Reading IIR register twice */
787 for (fn = 0; fn < 2; fn ++) {
789 failures[6] = sio_getreg(com, com_iir);
791 /* Check IIR_TXRDY clear ? */
793 if (failures[6] & IIR_TXRDY) {
794 /* Nop, Double check with clearing IER */
795 sio_setreg(com, com_ier, 0);
796 if (sio_getreg(com, com_iir) & IIR_NOPEND) {
797 /* Ok. we're familia this gang */
798 SET_FLAG(dev, COM_C_IIR_TXRDYBUG);
800 /* Unknown, Just omit this chip.. XXX */
802 sio_setreg(com, com_mcr, 0);
805 /* OK. this is well-known guys */
806 CLR_FLAG(dev, COM_C_IIR_TXRDYBUG);
808 sio_setreg(com, com_ier, 0);
809 sio_setreg(com, com_cfcr, CFCR_8BITS);
811 bus_release_resource(dev, SYS_RES_IOPORT, rid, port);
812 lwkt_reltoken(&tty_token);
813 return (iobase == siocniobase ? 0 : result);
818 * o the CFCR, IER and MCR in UART hold the values written to them
819 * (the values happen to be all distinct - this is good for
820 * avoiding false positive tests from bus echoes).
821 * o an output interrupt is generated and its vector is correct.
822 * o the interrupt goes away when the IIR in the UART is read.
825 failures[0] = sio_getreg(com, com_cfcr) - CFCR_8BITS;
826 failures[1] = sio_getreg(com, com_ier) - IER_ETXRDY;
827 failures[2] = sio_getreg(com, com_mcr) - mcr_image;
828 DELAY(10000); /* Some internal modems need this time */
829 irqmap[1] = isa_irq_pending();
830 failures[4] = (sio_getreg(com, com_iir) & IIR_IMASK) - IIR_TXRDY;
831 DELAY(1000); /* XXX */
832 irqmap[2] = isa_irq_pending();
833 failures[6] = (sio_getreg(com, com_iir) & IIR_IMASK) - IIR_NOPEND;
836 * Turn off all device interrupts and check that they go off properly.
837 * Leave MCR_IENABLE alone. For ports without a master port, it gates
838 * the OUT2 output of the UART to
839 * the ICU input. Closing the gate would give a floating ICU input
840 * (unless there is another device driving it) and spurious interrupts.
841 * (On the system that this was first tested on, the input floats high
842 * and gives a (masked) interrupt as soon as the gate is closed.)
844 sio_setreg(com, com_ier, 0);
845 sio_setreg(com, com_cfcr, CFCR_8BITS); /* dummy to avoid bus echo */
846 failures[7] = sio_getreg(com, com_ier);
847 DELAY(1000); /* XXX */
848 irqmap[3] = isa_irq_pending();
849 failures[9] = (sio_getreg(com, com_iir) & IIR_IMASK) - IIR_NOPEND;
853 irqs = irqmap[1] & ~irqmap[0];
854 if (bus_get_resource(idev, SYS_RES_IRQ, 0, &xirq, NULL) == 0 &&
855 ((1 << xirq) & irqs) == 0)
857 "sio%d: configured irq %ld not in bitmap of probed irqs %#x\n",
858 device_get_unit(dev), xirq, irqs);
860 kprintf("sio%d: irq maps: %#x %#x %#x %#x\n",
861 device_get_unit(dev),
862 irqmap[0], irqmap[1], irqmap[2], irqmap[3]);
865 for (fn = 0; fn < sizeof failures; ++fn)
867 sio_setreg(com, com_mcr, 0);
870 kprintf("sio%d: probe failed test(s):",
871 device_get_unit(dev));
872 for (fn = 0; fn < sizeof failures; ++fn)
879 bus_release_resource(dev, SYS_RES_IOPORT, rid, port);
880 lwkt_reltoken(&tty_token);
881 return (iobase == siocniobase ? 0 : result);
886 espattach(struct com_s *com, Port_t esp_port)
892 * Check the ESP-specific I/O port to see if we're an ESP
893 * card. If not, return failure immediately.
895 if ((inb(esp_port) & 0xf3) == 0) {
896 kprintf(" port 0x%x is not an ESP board?\n", esp_port);
900 lwkt_gettoken(&tty_token);
902 * We've got something that claims to be a Hayes ESP card.
906 /* Get the dip-switch configuration */
907 outb(esp_port + ESP_CMD1, ESP_GETDIPS);
908 dips = inb(esp_port + ESP_STATUS1);
911 * Bits 0,1 of dips say which COM port we are.
913 if (rman_get_start(com->ioportres) == likely_com_ports[dips & 0x03])
916 kprintf(" esp_port has com %d\n", dips & 0x03);
917 lwkt_reltoken(&tty_token);
922 * Check for ESP version 2.0 or later: bits 4,5,6 = 010.
924 outb(esp_port + ESP_CMD1, ESP_GETTEST);
925 val = inb(esp_port + ESP_STATUS1); /* clear reg 1 */
926 val = inb(esp_port + ESP_STATUS2);
927 if ((val & 0x70) < 0x20) {
928 kprintf("-old (%o)", val & 0x70);
929 lwkt_reltoken(&tty_token);
934 * Check for ability to emulate 16550: bit 7 == 1
936 if ((dips & 0x80) == 0) {
938 lwkt_reltoken(&tty_token);
943 * Okay, we seem to be a Hayes ESP card. Whee.
946 com->esp_port = esp_port;
947 lwkt_reltoken(&tty_token);
953 sio_isa_attach(device_t dev)
955 return (sioattach(dev, 0, 0UL));
959 sioattach(device_t dev, int xrid, u_long rclk)
970 struct resource *port;
974 lwkt_gettoken(&tty_token);
977 callout_init_mp(&sio_timeout_handle);
981 port = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
982 0, ~0, IO_COMSIZE, RF_ACTIVE);
984 lwkt_reltoken(&tty_token);
988 iobase = rman_get_start(port);
989 unit = device_get_unit(dev);
990 com = device_get_softc(dev);
991 flags = device_get_flags(dev);
993 if (unit >= sio_numunits)
994 sio_numunits = unit + 1;
996 * sioprobe() has initialized the device registers as follows:
997 * o cfcr = CFCR_8BITS.
998 * It is most important that CFCR_DLAB is off, so that the
999 * data port is not hidden when we enable interrupts.
1001 * Interrupts are only enabled when the line is open.
1002 * o mcr = MCR_IENABLE, or 0 if the port has AST/4 compatible
1003 * interrupt control register or the config specifies no irq.
1004 * Keeping MCR_DTR and MCR_RTS off might stop the external
1005 * device from sending before we are ready.
1007 bzero(com, sizeof *com);
1009 com->ioportres = port;
1010 com->bst = rman_get_bustag(port);
1011 com->bsh = rman_get_bushandle(port);
1012 com->cfcr_image = CFCR_8BITS;
1013 com->dtr_wait = 3 * hz;
1014 callout_init_mp(&com->dtr_ch);
1015 callout_init_mp(&com->busy_ch);
1016 com->loses_outints = COM_LOSESOUTINTS(flags) != 0;
1017 com->no_irq = bus_get_resource(dev, SYS_RES_IRQ, 0, NULL, NULL) != 0;
1018 com->tx_fifo_size = 1;
1019 com->obufs[0].l_head = com->obuf1;
1020 com->obufs[1].l_head = com->obuf2;
1022 com->data_port = iobase + com_data;
1023 com->int_id_port = iobase + com_iir;
1024 com->modem_ctl_port = iobase + com_mcr;
1025 com->mcr_image = inb(com->modem_ctl_port);
1026 com->line_status_port = iobase + com_lsr;
1027 com->modem_status_port = iobase + com_msr;
1028 com->intr_ctl_port = iobase + com_ier;
1031 rclk = DEFAULT_RCLK;
1035 * We don't use all the flags from <sys/ttydefaults.h> since they
1036 * are only relevant for logins. It's important to have echo off
1037 * initially so that the line doesn't start blathering before the
1038 * echo flag can be turned off.
1040 com->it_in.c_iflag = 0;
1041 com->it_in.c_oflag = 0;
1042 com->it_in.c_cflag = TTYDEF_CFLAG;
1043 com->it_in.c_lflag = 0;
1044 if (unit == comconsole) {
1045 com->it_in.c_iflag = TTYDEF_IFLAG;
1046 com->it_in.c_oflag = TTYDEF_OFLAG;
1047 com->it_in.c_cflag = TTYDEF_CFLAG | CLOCAL;
1048 com->it_in.c_lflag = TTYDEF_LFLAG;
1049 com->lt_out.c_cflag = com->lt_in.c_cflag = CLOCAL;
1050 com->lt_out.c_ispeed = com->lt_out.c_ospeed =
1051 com->lt_in.c_ispeed = com->lt_in.c_ospeed =
1052 com->it_in.c_ispeed = com->it_in.c_ospeed = comdefaultrate;
1054 com->it_in.c_ispeed = com->it_in.c_ospeed = TTYDEF_SPEED;
1055 if (siosetwater(com, com->it_in.c_ispeed) != 0) {
1057 * Leave i/o resources allocated if this is a `cn'-level
1058 * console, so that other devices can't snarf them.
1060 if (iobase != siocniobase)
1061 bus_release_resource(dev, SYS_RES_IOPORT, rid, port);
1062 lwkt_reltoken(&tty_token);
1065 termioschars(&com->it_in);
1066 com->it_out = com->it_in;
1068 /* attempt to determine UART type */
1069 kprintf("sio%d: type", unit);
1072 #ifdef COM_MULTIPORT
1073 if (!COM_ISMULTIPORT(flags) && !COM_IIR_TXRDYBUG(flags))
1075 if (!COM_IIR_TXRDYBUG(flags))
1082 scr = sio_getreg(com, com_scr);
1083 sio_setreg(com, com_scr, 0xa5);
1084 scr1 = sio_getreg(com, com_scr);
1085 sio_setreg(com, com_scr, 0x5a);
1086 scr2 = sio_getreg(com, com_scr);
1087 sio_setreg(com, com_scr, scr);
1088 if (scr1 != 0xa5 || scr2 != 0x5a) {
1090 goto determined_type;
1093 sio_setreg(com, com_fifo, FIFO_ENABLE | FIFO_RX_HIGH);
1096 switch (inb(com->int_id_port) & IIR_FIFO_MASK) {
1107 if (COM_NOFIFO(flags)) {
1108 kprintf(" 16550A fifo disabled");
1110 com->hasfifo = TRUE;
1111 if (COM_ST16650A(flags)) {
1113 com->tx_fifo_size = 32;
1114 kprintf(" ST16650A");
1115 } else if (COM_TI16754(flags)) {
1116 com->tx_fifo_size = 64;
1117 kprintf(" TI16754");
1119 com->tx_fifo_size = COM_FIFOSIZE(flags);
1124 for (espp = likely_esp_ports; *espp != 0; espp++)
1125 if (espattach(com, *espp)) {
1126 com->tx_fifo_size = 1024;
1130 if (!com->st16650a && !COM_TI16754(flags)) {
1131 if (!com->tx_fifo_size)
1132 com->tx_fifo_size = 16;
1134 kprintf(" lookalike with %d bytes FIFO",
1144 * Set 16550 compatibility mode.
1145 * We don't use the ESP_MODE_SCALE bit to increase the
1146 * fifo trigger levels because we can't handle large
1148 * XXX flow control should be set in comparam(), not here.
1150 outb(com->esp_port + ESP_CMD1, ESP_SETMODE);
1151 outb(com->esp_port + ESP_CMD2, ESP_MODE_RTS | ESP_MODE_FIFO);
1153 /* Set RTS/CTS flow control. */
1154 outb(com->esp_port + ESP_CMD1, ESP_SETFLOWTYPE);
1155 outb(com->esp_port + ESP_CMD2, ESP_FLOW_RTS);
1156 outb(com->esp_port + ESP_CMD2, ESP_FLOW_CTS);
1158 /* Set flow-control levels. */
1159 outb(com->esp_port + ESP_CMD1, ESP_SETRXFLOW);
1160 outb(com->esp_port + ESP_CMD2, HIBYTE(768));
1161 outb(com->esp_port + ESP_CMD2, LOBYTE(768));
1162 outb(com->esp_port + ESP_CMD2, HIBYTE(512));
1163 outb(com->esp_port + ESP_CMD2, LOBYTE(512));
1165 #endif /* COM_ESP */
1166 sio_setreg(com, com_fifo, 0);
1169 #ifdef COM_MULTIPORT
1170 if (COM_ISMULTIPORT(flags)) {
1173 com->multiport = TRUE;
1174 kprintf(" (multiport");
1175 if (unit == COM_MPMASTER(flags))
1178 masterdev = devclass_get_device(sio_devclass,
1179 COM_MPMASTER(flags));
1180 com->no_irq = (masterdev == NULL || bus_get_resource(masterdev,
1181 SYS_RES_IRQ, 0, NULL, NULL) != 0);
1183 #endif /* COM_MULTIPORT */
1184 if (unit == comconsole)
1185 kprintf(", console");
1186 if (COM_IIR_TXRDYBUG(flags))
1187 kprintf(" with a bogus IIR_TXRDY register");
1190 if (!sio_registered) {
1191 register_swi(SWI_TTY, siopoll, NULL ,"swi_siopoll", NULL, -1);
1192 sio_registered = TRUE;
1194 minorbase = UNIT_TO_MINOR(unit);
1195 make_dev(&sio_ops, minorbase,
1196 UID_ROOT, GID_WHEEL, 0600, "ttyd%r", unit);
1197 make_dev(&sio_ops, minorbase | CONTROL_INIT_STATE,
1198 UID_ROOT, GID_WHEEL, 0600, "ttyid%r", unit);
1199 make_dev(&sio_ops, minorbase | CONTROL_LOCK_STATE,
1200 UID_ROOT, GID_WHEEL, 0600, "ttyld%r", unit);
1201 make_dev(&sio_ops, minorbase | CALLOUT_MASK,
1202 UID_UUCP, GID_DIALER, 0660, "cuaa%r", unit);
1203 make_dev(&sio_ops, minorbase | CALLOUT_MASK | CONTROL_INIT_STATE,
1204 UID_UUCP, GID_DIALER, 0660, "cuaia%r", unit);
1205 make_dev(&sio_ops, minorbase | CALLOUT_MASK | CONTROL_LOCK_STATE,
1206 UID_UUCP, GID_DIALER, 0660, "cuala%r", unit);
1208 com->pps.ppscap = PPS_CAPTUREASSERT | PPS_CAPTURECLEAR;
1209 pps_init(&com->pps);
1212 com->irqres = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0ul, ~0ul, 1,
1215 ret = BUS_SETUP_INTR(device_get_parent(dev), dev,
1216 com->irqres, INTR_MPSAFE, siointr, com,
1217 &com->cookie, NULL, NULL);
1219 device_printf(dev, "could not activate interrupt\n");
1222 * Enable interrupts for early break-to-debugger support
1225 if (ret == 0 && unit == comconsole &&
1226 (break_to_debugger || alt_break_to_debugger)) {
1227 outb(siocniobase + com_ier, IER_ERXRDY | IER_ERLS |
1233 lwkt_reltoken(&tty_token);
1238 sioopen(struct dev_open_args *ap)
1240 cdev_t dev = ap->a_head.a_dev;
1248 unit = MINOR_TO_UNIT(mynor);
1249 com = com_addr(unit);
1254 if (mynor & CONTROL_MASK)
1256 lwkt_gettoken(&tty_token);
1257 tp = dev->si_tty = com->tp = ttymalloc(com->tp);
1260 * We jump to this label after all non-interrupted sleeps to pick
1261 * up any changes of the device state.
1264 while (com->state & CS_DTR_OFF) {
1265 error = tsleep(&com->dtr_wait, PCATCH, "siodtr", 0);
1266 if (com_addr(unit) == NULL) {
1268 lwkt_reltoken(&tty_token);
1271 if (error != 0 || com->gone)
1274 if (tp->t_state & TS_ISOPEN) {
1276 * The device is open, so everything has been initialized.
1279 if (mynor & CALLOUT_MASK) {
1280 if (!com->active_out) {
1285 if (com->active_out) {
1286 if (ap->a_oflags & O_NONBLOCK) {
1290 error = tsleep(&com->active_out,
1291 PCATCH, "siobi", 0);
1292 if (com_addr(unit) == NULL) {
1294 lwkt_reltoken(&tty_token);
1297 if (error != 0 || com->gone)
1302 if (tp->t_state & TS_XCLUDE && priv_check_cred(ap->a_cred, PRIV_ROOT, 0)) {
1308 * The device isn't open, so there are no conflicts.
1309 * Initialize it. Initialization is done twice in many
1310 * cases: to preempt sleeping callin opens if we are
1311 * callout, and to complete a callin open after DCD rises.
1313 tp->t_oproc = comstart;
1314 tp->t_param = comparam;
1315 tp->t_stop = comstop;
1317 tp->t_termios = mynor & CALLOUT_MASK
1318 ? com->it_out : com->it_in;
1319 (void)commctl(com, TIOCM_DTR | TIOCM_RTS, DMSET);
1320 com->poll = com->no_irq;
1321 com->poll_output = com->loses_outints;
1323 error = comparam(tp, &tp->t_termios);
1328 * XXX we should goto open_top if comparam() slept.
1332 * (Re)enable and drain fifos.
1334 * Certain SMC chips cause problems if the fifos
1335 * are enabled while input is ready. Turn off the
1336 * fifo if necessary to clear the input. We test
1337 * the input ready bit after enabling the fifos
1338 * since we've already enabled them in comparam()
1339 * and to handle races between enabling and fresh
1343 sio_setreg(com, com_fifo,
1344 FIFO_RCV_RST | FIFO_XMT_RST
1347 * XXX the delays are for superstitious
1348 * historical reasons. It must be less than
1349 * the character time at the maximum
1350 * supported speed (87 usec at 115200 bps
1351 * 8N1). Otherwise we might loop endlessly
1352 * if data is streaming in. We used to use
1353 * delays of 100. That usually worked
1354 * because DELAY(100) used to usually delay
1355 * for about 85 usec instead of 100.
1358 if (!(inb(com->line_status_port) & LSR_RXRDY))
1360 sio_setreg(com, com_fifo, 0);
1362 (void) inb(com->data_port);
1367 (void) inb(com->line_status_port);
1368 (void) inb(com->data_port);
1369 com->prev_modem_status = com->last_modem_status
1370 = inb(com->modem_status_port);
1371 if (COM_IIR_TXRDYBUG(com->flags)) {
1372 outb(com->intr_ctl_port, IER_ERXRDY | IER_ERLS
1375 outb(com->intr_ctl_port, IER_ERXRDY | IER_ETXRDY
1376 | IER_ERLS | IER_EMSC);
1380 * Handle initial DCD. Callout devices get a fake initial
1381 * DCD (trapdoor DCD). If we are callout, then any sleeping
1382 * callin opens get woken up and resume sleeping on "siobi"
1383 * instead of "siodcd".
1386 * XXX `mynor & CALLOUT_MASK' should be
1387 * `tp->t_cflag & (SOFT_CARRIER | TRAPDOOR_CARRIER) where
1388 * TRAPDOOR_CARRIER is the default initial state for callout
1389 * devices and SOFT_CARRIER is like CLOCAL except it hides
1392 if (com->prev_modem_status & MSR_DCD || mynor & CALLOUT_MASK)
1393 (*linesw[tp->t_line].l_modem)(tp, 1);
1396 * Wait for DCD if necessary.
1398 if (!(tp->t_state & TS_CARR_ON) && !(mynor & CALLOUT_MASK)
1399 && !(tp->t_cflag & CLOCAL) && !(ap->a_oflags & O_NONBLOCK)) {
1401 error = tsleep(TSA_CARR_ON(tp), PCATCH, "siodcd", 0);
1402 if (com_addr(unit) == NULL) {
1404 lwkt_reltoken(&tty_token);
1408 if (error != 0 || com->gone)
1412 error = (*linesw[tp->t_line].l_open)(dev, tp);
1413 disc_optim(tp, &tp->t_termios, com);
1414 if (tp->t_state & TS_ISOPEN && mynor & CALLOUT_MASK)
1415 com->active_out = TRUE;
1419 if (!(tp->t_state & TS_ISOPEN) && com->wopeners == 0)
1421 lwkt_reltoken(&tty_token);
1426 sioclose(struct dev_close_args *ap)
1428 cdev_t dev = ap->a_head.a_dev;
1434 if (mynor & CONTROL_MASK)
1436 lwkt_gettoken(&tty_token);
1437 com = com_addr(MINOR_TO_UNIT(mynor));
1439 lwkt_reltoken(&tty_token);
1444 (*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
1445 disc_optim(tp, &tp->t_termios, com);
1446 comstop(tp, FREAD | FWRITE);
1452 kprintf("sio%d: gone\n", com->unit);
1454 if (com->ibuf != NULL)
1455 kfree(com->ibuf, M_DEVBUF);
1456 bzero(tp, sizeof *tp);
1459 lwkt_reltoken(&tty_token);
1464 comhardclose(struct com_s *com)
1471 lwkt_gettoken(&tty_token);
1473 com->poll_output = FALSE;
1474 com->do_timestamp = FALSE;
1475 com->do_dcd_timestamp = FALSE;
1476 com->pps.ppsparam.mode = 0;
1477 sio_setreg(com, com_cfcr, com->cfcr_image &= ~CFCR_SBREAK);
1482 * Leave interrupts enabled and don't clear DTR if this is the
1483 * console. This allows us to detect break-to-debugger events
1484 * while the console device is closed.
1486 if (com->unit != comconsole ||
1487 (break_to_debugger == 0 && alt_break_to_debugger == 0))
1490 sio_setreg(com, com_ier, 0);
1491 if (tp->t_cflag & HUPCL
1493 * XXX we will miss any carrier drop between here and the
1494 * next open. Perhaps we should watch DCD even when the
1495 * port is closed; it is not sufficient to check it at
1496 * the next open because it might go up and down while
1497 * we're not watching.
1499 || (!com->active_out
1500 && !(com->prev_modem_status & MSR_DCD)
1501 && !(com->it_in.c_cflag & CLOCAL))
1502 || !(tp->t_state & TS_ISOPEN)) {
1503 (void)commctl(com, TIOCM_DTR, DMBIC);
1504 if (com->dtr_wait != 0 && !(com->state & CS_DTR_OFF)) {
1505 callout_reset(&com->dtr_ch, com->dtr_wait,
1507 com->state |= CS_DTR_OFF;
1513 * Disable fifos so that they are off after controlled
1514 * reboots. Some BIOSes fail to detect 16550s when the
1515 * fifos are enabled.
1517 sio_setreg(com, com_fifo, 0);
1519 com->active_out = FALSE;
1520 wakeup(&com->active_out);
1521 wakeup(TSA_CARR_ON(tp)); /* restart any wopeners */
1522 lwkt_reltoken(&tty_token);
1527 sioread(struct dev_read_args *ap)
1529 cdev_t dev = ap->a_head.a_dev;
1533 lwkt_gettoken(&tty_token);
1535 if (mynor & CONTROL_MASK) {
1536 lwkt_reltoken(&tty_token);
1539 com = com_addr(MINOR_TO_UNIT(mynor));
1540 if (com == NULL || com->gone) {
1541 lwkt_reltoken(&tty_token);
1544 ret = ((*linesw[com->tp->t_line].l_read)(com->tp, ap->a_uio, ap->a_ioflag));
1545 lwkt_reltoken(&tty_token);
1550 siowrite(struct dev_write_args *ap)
1552 cdev_t dev = ap->a_head.a_dev;
1557 lwkt_gettoken(&tty_token);
1559 if (mynor & CONTROL_MASK) {
1560 lwkt_reltoken(&tty_token);
1564 unit = MINOR_TO_UNIT(mynor);
1565 com = com_addr(unit);
1566 if (com == NULL || com->gone) {
1567 lwkt_reltoken(&tty_token);
1571 * (XXX) We disallow virtual consoles if the physical console is
1572 * a serial port. This is in case there is a display attached that
1573 * is not the console. In that situation we don't need/want the X
1574 * server taking over the console.
1576 if (constty != NULL && unit == comconsole)
1578 ret = ((*linesw[com->tp->t_line].l_write)(com->tp, ap->a_uio, ap->a_ioflag));
1579 lwkt_reltoken(&tty_token);
1584 siobusycheck(void *chan)
1588 lwkt_gettoken(&tty_token);
1589 com = (struct com_s *)chan;
1592 * Clear TS_BUSY if low-level output is complete.
1593 * spl locking is sufficient because siointr1() does not set CS_BUSY.
1594 * If siointr1() clears CS_BUSY after we look at it, then we'll get
1595 * called again. Reading the line status port outside of siointr1()
1596 * is safe because CS_BUSY is clear so there are no output interrupts
1600 if (com->state & CS_BUSY)
1601 com->extra_state &= ~CSE_BUSYCHECK; /* False alarm. */
1602 else if ((inb(com->line_status_port) & (LSR_TSRE | LSR_TXRDY))
1603 == (LSR_TSRE | LSR_TXRDY)) {
1604 com->tp->t_state &= ~TS_BUSY;
1606 com->extra_state &= ~CSE_BUSYCHECK;
1608 callout_reset(&com->busy_ch, hz / 100, siobusycheck, com);
1611 lwkt_reltoken(&tty_token);
1615 siodivisor(u_long rclk, speed_t speed)
1621 if (speed == 0 || speed > ((speed_t)-1 - 1) / 8)
1623 divisor = (rclk / (8UL * speed) + 1) / 2;
1624 if (divisor == 0 || divisor >= 65536)
1626 actual_speed = rclk / (16UL * divisor);
1628 /* 10 times error in percent: */
1629 error = ((actual_speed - (long)speed) * 2000 / (long)speed + 1) / 2;
1631 /* 3.0% maximum error tolerance: */
1632 if (error < -30 || error > 30)
1639 siodtrwakeup(void *chan)
1643 lwkt_gettoken(&tty_token);
1644 com = (struct com_s *)chan;
1645 com->state &= ~CS_DTR_OFF;
1646 wakeup(&com->dtr_wait);
1647 lwkt_reltoken(&tty_token);
1651 * NOTE: Normally called with tty_token held but might not be when
1652 * operating as the console.
1654 * Must be called with com_lock
1657 sioinput(struct com_s *com)
1667 if (!(tp->t_state & TS_ISOPEN) || !(tp->t_cflag & CREAD)) {
1668 com_events -= (com->iptr - com->ibuf);
1669 com->iptr = com->ibuf;
1672 if (tp->t_state & TS_CAN_BYPASS_L_RINT) {
1674 * Avoid the grotesquely inefficient lineswitch routine
1675 * (ttyinput) in "raw" mode. It usually takes about 450
1676 * instructions (that's without canonical processing or echo!).
1677 * slinput is reasonably fast (usually 40 instructions plus
1682 incc = com->iptr - buf;
1683 if (tp->t_rawq.c_cc + incc > tp->t_ihiwat
1684 && (com->state & CS_RTS_IFLOW
1685 || tp->t_iflag & IXOFF)
1686 && !(tp->t_state & TS_TBLOCK))
1688 com->delta_error_counts[CE_TTY_BUF_OVERFLOW]
1689 += b_to_q((char *)buf, incc, &tp->t_rawq);
1693 tp->t_rawcc += incc;
1695 if (tp->t_state & TS_TTSTOP
1696 && (tp->t_iflag & IXANY
1697 || tp->t_cc[VSTART] == tp->t_cc[VSTOP])) {
1698 tp->t_state &= ~TS_TTSTOP;
1699 tp->t_lflag &= ~FLUSHO;
1703 } while (buf < com->iptr);
1707 line_status = buf[com->ierroff];
1710 & (LSR_BI | LSR_FE | LSR_OE | LSR_PE)) {
1711 if (line_status & LSR_BI)
1712 recv_data |= TTY_BI;
1713 if (line_status & LSR_FE)
1714 recv_data |= TTY_FE;
1715 if (line_status & LSR_OE)
1716 recv_data |= TTY_OE;
1717 if (line_status & LSR_PE)
1718 recv_data |= TTY_PE;
1720 (*linesw[tp->t_line].l_rint)(recv_data, tp);
1722 } while (buf < com->iptr);
1724 com_events -= (com->iptr - com->ibuf);
1725 com->iptr = com->ibuf;
1728 * There is now room for another low-level buffer full of input,
1729 * so enable RTS if it is now disabled and there is room in the
1730 * high-level buffer.
1732 if ((com->state & CS_RTS_IFLOW) && !(com->mcr_image & MCR_RTS) &&
1733 !(tp->t_state & TS_TBLOCK))
1734 outb(com->modem_ctl_port, com->mcr_image |= MCR_RTS);
1740 lwkt_gettoken(&tty_token);
1741 #ifndef COM_MULTIPORT
1743 siointr1((struct com_s *) arg);
1745 #else /* COM_MULTIPORT */
1746 bool_t possibly_more_intrs;
1751 * Loop until there is no activity on any port. This is necessary
1752 * to get an interrupt edge more than to avoid another interrupt.
1753 * If the IRQ signal is just an OR of the IRQ signals from several
1754 * devices, then the edge from one may be lost because another is
1759 possibly_more_intrs = FALSE;
1760 for (unit = 0; unit < sio_numunits; ++unit) {
1761 com = com_addr(unit);
1764 * would it work here, or be counter-productive?
1768 && (inb(com->int_id_port) & IIR_IMASK)
1771 possibly_more_intrs = TRUE;
1773 /* XXX com_unlock(); */
1775 } while (possibly_more_intrs);
1777 #endif /* COM_MULTIPORT */
1778 lwkt_reltoken(&tty_token);
1782 * Called with tty_token held and com_lock held.
1785 siointr1(struct com_s *com)
1788 u_char modem_status;
1795 int_ctl = inb(com->intr_ctl_port);
1796 int_ctl_new = int_ctl;
1798 while (!com->gone) {
1799 if (com->pps.ppsparam.mode & PPS_CAPTUREBOTH) {
1800 modem_status = inb(com->modem_status_port);
1801 if ((modem_status ^ com->last_modem_status) & MSR_DCD) {
1802 count = sys_cputimer->count();
1803 pps_event(&com->pps, count,
1804 (modem_status & MSR_DCD) ?
1805 PPS_CAPTUREASSERT : PPS_CAPTURECLEAR);
1808 line_status = inb(com->line_status_port);
1810 /* input event? (check first to help avoid overruns) */
1811 while (line_status & LSR_RCV_MASK) {
1812 /* break/unnattached error bits or real input? */
1813 if (!(line_status & LSR_RXRDY))
1816 recv_data = inb(com->data_port);
1819 * Solaris implements a new BREAK which is initiated
1820 * by a character sequence CR ~ ^b which is similar
1821 * to a familiar pattern used on Sun servers by the
1824 #define KEY_CRTLB 2 /* ^B */
1825 #define KEY_CR 13 /* CR '\r' */
1826 #define KEY_TILDE 126 /* ~ */
1828 if (com->unit == comconsole && alt_break_to_debugger) {
1829 static int brk_state1 = 0, brk_state2 = 0;
1830 if (recv_data == KEY_CR) {
1831 brk_state1 = recv_data;
1833 } else if (brk_state1 == KEY_CR && (recv_data == KEY_TILDE || recv_data == KEY_CRTLB)) {
1834 if (recv_data == KEY_TILDE)
1835 brk_state2 = recv_data;
1836 else if (brk_state2 == KEY_TILDE && recv_data == KEY_CRTLB) {
1840 brk_state1 = brk_state2 = 0;
1848 if (line_status & (LSR_BI | LSR_FE | LSR_PE)) {
1850 * Don't store BI if IGNBRK or FE/PE if IGNPAR.
1851 * Otherwise, push the work to a higher level
1852 * (to handle PARMRK) if we're bypassing.
1853 * Otherwise, convert BI/FE and PE+INPCK to 0.
1855 * This makes bypassing work right in the
1856 * usual "raw" case (IGNBRK set, and IGNPAR
1859 * Note: BI together with FE/PE means just BI.
1861 if (line_status & LSR_BI) {
1863 if (com->unit == comconsole &&
1864 break_to_debugger) {
1872 || com->tp->t_iflag & IGNBRK)
1876 || com->tp->t_iflag & IGNPAR)
1879 if (com->tp->t_state & TS_CAN_BYPASS_L_RINT
1880 && (line_status & (LSR_BI | LSR_FE)
1881 || com->tp->t_iflag & INPCK))
1885 if (com->hotchar != 0 && recv_data == com->hotchar)
1888 if (ioptr >= com->ibufend)
1889 CE_RECORD(com, CE_INTERRUPT_BUF_OVERFLOW);
1891 if (com->do_timestamp)
1892 microtime(&com->timestamp);
1895 #if 0 /* for testing input latency vs efficiency */
1896 if (com->iptr - com->ibuf == 8)
1899 ioptr[0] = recv_data;
1900 ioptr[com->ierroff] = line_status;
1901 com->iptr = ++ioptr;
1902 if (ioptr == com->ihighwater
1903 && com->state & CS_RTS_IFLOW)
1904 outb(com->modem_ctl_port,
1905 com->mcr_image &= ~MCR_RTS);
1906 if (line_status & LSR_OE)
1907 CE_RECORD(com, CE_OVERRUN);
1911 * "& 0x7F" is to avoid the gcc-1.40 generating a slow
1912 * jump from the top of the loop to here
1914 line_status = inb(com->line_status_port) & 0x7F;
1917 /* modem status change? (always check before doing output) */
1918 modem_status = inb(com->modem_status_port);
1919 if (modem_status != com->last_modem_status) {
1920 if (com->do_dcd_timestamp
1921 && !(com->last_modem_status & MSR_DCD)
1922 && modem_status & MSR_DCD)
1923 microtime(&com->dcd_timestamp);
1926 * Schedule high level to handle DCD changes. Note
1927 * that we don't use the delta bits anywhere. Some
1928 * UARTs mess them up, and it's easy to remember the
1929 * previous bits and calculate the delta.
1931 com->last_modem_status = modem_status;
1932 if (!(com->state & CS_CHECKMSR)) {
1933 com_events += LOTS_OF_EVENTS;
1934 com->state |= CS_CHECKMSR;
1938 /* handle CTS change immediately for crisp flow ctl */
1939 if (com->state & CS_CTS_OFLOW) {
1940 if (modem_status & MSR_CTS)
1941 com->state |= CS_ODEVREADY;
1943 com->state &= ~CS_ODEVREADY;
1947 /* output queued and everything ready? */
1948 if (line_status & LSR_TXRDY
1949 && com->state >= (CS_BUSY | CS_TTGO | CS_ODEVREADY)) {
1950 ioptr = com->obufq.l_head;
1951 if (com->tx_fifo_size > 1) {
1954 ocount = com->obufq.l_tail - ioptr;
1955 if (ocount > com->tx_fifo_size)
1956 ocount = com->tx_fifo_size;
1957 com->bytes_out += ocount;
1959 outb(com->data_port, *ioptr++);
1960 while (--ocount != 0);
1962 outb(com->data_port, *ioptr++);
1965 com->obufq.l_head = ioptr;
1966 if (COM_IIR_TXRDYBUG(com->flags)) {
1967 int_ctl_new = int_ctl | IER_ETXRDY;
1969 if (ioptr >= com->obufq.l_tail) {
1972 qp = com->obufq.l_next;
1973 qp->l_queued = FALSE;
1976 com->obufq.l_head = qp->l_head;
1977 com->obufq.l_tail = qp->l_tail;
1978 com->obufq.l_next = qp;
1980 /* output just completed */
1981 if (COM_IIR_TXRDYBUG(com->flags)) {
1982 int_ctl_new = int_ctl & ~IER_ETXRDY;
1984 com->state &= ~CS_BUSY;
1986 if (!(com->state & CS_ODONE)) {
1987 com_events += LOTS_OF_EVENTS;
1988 com->state |= CS_ODONE;
1989 setsofttty(); /* handle at high level ASAP */
1992 if (COM_IIR_TXRDYBUG(com->flags) && (int_ctl != int_ctl_new)) {
1993 outb(com->intr_ctl_port, int_ctl_new);
1998 #ifndef COM_MULTIPORT
1999 if ((inb(com->int_id_port) & IIR_IMASK) == IIR_NOPEND)
2000 #endif /* COM_MULTIPORT */
2008 sioioctl(struct dev_ioctl_args *ap)
2010 cdev_t dev = ap->a_head.a_dev;
2011 caddr_t data = ap->a_data;
2016 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
2018 struct termios term;
2020 lwkt_gettoken(&tty_token);
2023 com = com_addr(MINOR_TO_UNIT(mynor));
2024 if (com == NULL || com->gone) {
2025 lwkt_reltoken(&tty_token);
2028 if (mynor & CONTROL_MASK) {
2031 switch (mynor & CONTROL_MASK) {
2032 case CONTROL_INIT_STATE:
2033 ct = mynor & CALLOUT_MASK ? &com->it_out : &com->it_in;
2035 case CONTROL_LOCK_STATE:
2036 ct = mynor & CALLOUT_MASK ? &com->lt_out : &com->lt_in;
2039 lwkt_reltoken(&tty_token);
2040 return (ENODEV); /* /dev/nodev */
2042 switch (ap->a_cmd) {
2044 error = priv_check_cred(ap->a_cred, PRIV_ROOT, 0);
2047 *ct = *(struct termios *)data;
2048 lwkt_reltoken(&tty_token);
2051 *(struct termios *)data = *ct;
2052 lwkt_reltoken(&tty_token);
2055 *(int *)data = TTYDISC;
2056 lwkt_reltoken(&tty_token);
2059 bzero(data, sizeof(struct winsize));
2060 lwkt_reltoken(&tty_token);
2063 lwkt_reltoken(&tty_token);
2068 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
2069 term = tp->t_termios;
2071 error = ttsetcompat(tp, &ap->a_cmd, data, &term);
2073 lwkt_reltoken(&tty_token);
2076 if (ap->a_cmd != oldcmd)
2077 data = (caddr_t)&term;
2079 if (ap->a_cmd == TIOCSETA || ap->a_cmd == TIOCSETAW ||
2080 ap->a_cmd == TIOCSETAF) {
2082 struct termios *dt = (struct termios *)data;
2083 struct termios *lt = mynor & CALLOUT_MASK
2084 ? &com->lt_out : &com->lt_in;
2086 dt->c_iflag = (tp->t_iflag & lt->c_iflag)
2087 | (dt->c_iflag & ~lt->c_iflag);
2088 dt->c_oflag = (tp->t_oflag & lt->c_oflag)
2089 | (dt->c_oflag & ~lt->c_oflag);
2090 dt->c_cflag = (tp->t_cflag & lt->c_cflag)
2091 | (dt->c_cflag & ~lt->c_cflag);
2092 dt->c_lflag = (tp->t_lflag & lt->c_lflag)
2093 | (dt->c_lflag & ~lt->c_lflag);
2094 for (cc = 0; cc < NCCS; ++cc)
2095 if (lt->c_cc[cc] != 0)
2096 dt->c_cc[cc] = tp->t_cc[cc];
2097 if (lt->c_ispeed != 0)
2098 dt->c_ispeed = tp->t_ispeed;
2099 if (lt->c_ospeed != 0)
2100 dt->c_ospeed = tp->t_ospeed;
2102 error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, data, ap->a_fflag, ap->a_cred);
2103 if (error != ENOIOCTL) {
2104 lwkt_reltoken(&tty_token);
2108 error = ttioctl(tp, ap->a_cmd, data, ap->a_fflag);
2109 disc_optim(tp, &tp->t_termios, com);
2110 if (error != ENOIOCTL) {
2112 lwkt_reltoken(&tty_token);
2115 switch (ap->a_cmd) {
2117 sio_setreg(com, com_cfcr, com->cfcr_image |= CFCR_SBREAK);
2120 sio_setreg(com, com_cfcr, com->cfcr_image &= ~CFCR_SBREAK);
2123 (void)commctl(com, TIOCM_DTR, DMBIS);
2126 (void)commctl(com, TIOCM_DTR, DMBIC);
2129 * XXX should disallow changing MCR_RTS if CS_RTS_IFLOW is set. The
2130 * changes get undone on the next call to comparam().
2133 (void)commctl(com, *(int *)data, DMSET);
2136 (void)commctl(com, *(int *)data, DMBIS);
2139 (void)commctl(com, *(int *)data, DMBIC);
2142 *(int *)data = commctl(com, 0, DMGET);
2145 /* must be root since the wait applies to following logins */
2146 error = priv_check_cred(ap->a_cred, PRIV_ROOT, 0);
2149 lwkt_reltoken(&tty_token);
2152 com->dtr_wait = *(int *)data * hz / 100;
2155 *(int *)data = com->dtr_wait * 100 / hz;
2158 com->do_timestamp = TRUE;
2159 *(struct timeval *)data = com->timestamp;
2161 case TIOCDCDTIMESTAMP:
2162 com->do_dcd_timestamp = TRUE;
2163 *(struct timeval *)data = com->dcd_timestamp;
2167 error = pps_ioctl(ap->a_cmd, data, &com->pps);
2168 if (error == ENODEV)
2170 lwkt_reltoken(&tty_token);
2174 lwkt_reltoken(&tty_token);
2179 siopoll(void *dummy, void *frame)
2183 lwkt_gettoken(&tty_token);
2184 if (com_events == 0) {
2185 lwkt_reltoken(&tty_token);
2190 for (unit = 0; unit < sio_numunits; ++unit) {
2195 com = com_addr(unit);
2199 if (tp == NULL || com->gone) {
2201 * Discard any events related to never-opened or
2202 * going-away devices.
2205 incc = com->iptr - com->ibuf;
2206 com->iptr = com->ibuf;
2207 if (com->state & CS_CHECKMSR) {
2208 incc += LOTS_OF_EVENTS;
2209 com->state &= ~CS_CHECKMSR;
2215 if (com->iptr != com->ibuf) {
2220 if (com->state & CS_CHECKMSR) {
2221 u_char delta_modem_status;
2224 delta_modem_status = com->last_modem_status
2225 ^ com->prev_modem_status;
2226 com->prev_modem_status = com->last_modem_status;
2227 com_events -= LOTS_OF_EVENTS;
2228 com->state &= ~CS_CHECKMSR;
2230 if (delta_modem_status & MSR_DCD)
2231 (*linesw[tp->t_line].l_modem)
2232 (tp, com->prev_modem_status & MSR_DCD);
2234 if (com->state & CS_ODONE) {
2236 com_events -= LOTS_OF_EVENTS;
2237 com->state &= ~CS_ODONE;
2239 if (!(com->state & CS_BUSY)
2240 && !(com->extra_state & CSE_BUSYCHECK)) {
2241 callout_reset(&com->busy_ch, hz / 100,
2243 com->extra_state |= CSE_BUSYCHECK;
2245 (*linesw[tp->t_line].l_start)(tp);
2247 if (com_events == 0)
2250 if (com_events >= LOTS_OF_EVENTS)
2252 lwkt_reltoken(&tty_token);
2256 * Called with tty_token held but no com_lock
2259 comparam(struct tty *tp, struct termios *t)
2269 unit = DEV_TO_UNIT(tp->t_dev);
2270 com = com_addr(unit);
2275 /* do historical conversions */
2276 if (t->c_ispeed == 0)
2277 t->c_ispeed = t->c_ospeed;
2279 /* check requested parameters */
2280 if (t->c_ospeed == 0)
2283 if (t->c_ispeed != t->c_ospeed)
2285 divisor = siodivisor(com->rclk, t->c_ispeed);
2290 /* parameters are OK, convert them to the com struct and the device */
2293 (void)commctl(com, TIOCM_DTR, DMBIC); /* hang up line */
2295 (void)commctl(com, TIOCM_DTR, DMBIS);
2297 switch (cflag & CSIZE) {
2311 if (cflag & PARENB) {
2313 if (!(cflag & PARODD))
2319 if (com->hasfifo && divisor != 0) {
2321 * Use a fifo trigger level low enough so that the input
2322 * latency from the fifo is less than about 16 msec and
2323 * the total latency is less than about 30 msec. These
2324 * latencies are reasonable for humans. Serial comms
2325 * protocols shouldn't expect anything better since modem
2326 * latencies are larger.
2328 * Interrupts can be held up for long periods of time
2329 * due to inefficiencies in other parts of the kernel,
2330 * certain video cards, etc. Setting the FIFO trigger
2331 * point to MEDH instead of HIGH gives us 694uS of slop
2332 * (8 character times) instead of 173uS (2 character times)
2335 com->fifo_image = t->c_ospeed <= 4800
2336 ? FIFO_ENABLE : FIFO_ENABLE | FIFO_RX_MEDH;
2339 * The Hayes ESP card needs the fifo DMA mode bit set
2340 * in compatibility mode. If not, it will interrupt
2341 * for each character received.
2344 com->fifo_image |= FIFO_DMA_MODE;
2346 sio_setreg(com, com_fifo, com->fifo_image);
2350 * This returns with interrupts disabled so that we can complete
2351 * the speed change atomically. Keeping interrupts disabled is
2352 * especially important while com_data is hidden.
2354 (void) siosetwater(com, t->c_ispeed);
2357 sio_setreg(com, com_cfcr, cfcr | CFCR_DLAB);
2359 * Only set the divisor registers if they would change,
2360 * since on some 16550 incompatibles (UMC8669F), setting
2361 * them while input is arriving them loses sync until
2362 * data stops arriving.
2364 dlbl = divisor & 0xFF;
2365 if (sio_getreg(com, com_dlbl) != dlbl)
2366 sio_setreg(com, com_dlbl, dlbl);
2367 dlbh = divisor >> 8;
2368 if (sio_getreg(com, com_dlbh) != dlbh)
2369 sio_setreg(com, com_dlbh, dlbh);
2372 sio_setreg(com, com_cfcr, com->cfcr_image = cfcr);
2374 if (!(tp->t_state & TS_TTSTOP))
2375 com->state |= CS_TTGO;
2377 if (cflag & CRTS_IFLOW) {
2378 if (com->st16650a) {
2379 sio_setreg(com, com_cfcr, 0xbf);
2380 sio_setreg(com, com_fifo,
2381 sio_getreg(com, com_fifo) | 0x40);
2383 com->state |= CS_RTS_IFLOW;
2385 * If CS_RTS_IFLOW just changed from off to on, the change
2386 * needs to be propagated to MCR_RTS. This isn't urgent,
2387 * so do it later by calling comstart() instead of repeating
2388 * a lot of code from comstart() here.
2390 } else if (com->state & CS_RTS_IFLOW) {
2391 com->state &= ~CS_RTS_IFLOW;
2393 * CS_RTS_IFLOW just changed from on to off. Force MCR_RTS
2394 * on here, since comstart() won't do it later.
2396 outb(com->modem_ctl_port, com->mcr_image |= MCR_RTS);
2397 if (com->st16650a) {
2398 sio_setreg(com, com_cfcr, 0xbf);
2399 sio_setreg(com, com_fifo,
2400 sio_getreg(com, com_fifo) & ~0x40);
2406 * Set up state to handle output flow control.
2407 * XXX - worth handling MDMBUF (DCD) flow control at the lowest level?
2408 * Now has 10+ msec latency, while CTS flow has 50- usec latency.
2410 com->state |= CS_ODEVREADY;
2411 com->state &= ~CS_CTS_OFLOW;
2412 if (cflag & CCTS_OFLOW) {
2413 com->state |= CS_CTS_OFLOW;
2414 if (!(com->last_modem_status & MSR_CTS))
2415 com->state &= ~CS_ODEVREADY;
2416 if (com->st16650a) {
2417 sio_setreg(com, com_cfcr, 0xbf);
2418 sio_setreg(com, com_fifo,
2419 sio_getreg(com, com_fifo) | 0x80);
2422 if (com->st16650a) {
2423 sio_setreg(com, com_cfcr, 0xbf);
2424 sio_setreg(com, com_fifo,
2425 sio_getreg(com, com_fifo) & ~0x80);
2429 sio_setreg(com, com_cfcr, com->cfcr_image);
2431 /* XXX shouldn't call functions while intrs are disabled. */
2432 disc_optim(tp, t, com);
2434 * Recover from fiddling with CS_TTGO. We used to call siointr1()
2435 * unconditionally, but that defeated the careful discarding of
2436 * stale input in sioopen().
2438 if (com->state >= (CS_BUSY | CS_TTGO)) {
2445 if (com->ibufold != NULL) {
2446 kfree(com->ibufold, M_DEVBUF);
2447 com->ibufold = NULL;
2453 * called with tty_token held
2456 siosetwater(struct com_s *com, speed_t speed)
2464 * Make the buffer size large enough to handle a softtty interrupt
2465 * latency of about 2 ticks without loss of throughput or data
2466 * (about 3 ticks if input flow control is not used or not honoured,
2467 * but a bit less for CS5-CS7 modes).
2469 cp4ticks = speed / 10 / hz * 4;
2470 for (ibufsize = 128; ibufsize < cp4ticks;)
2472 if (ibufsize == com->ibufsize)
2476 * Allocate input buffer. The extra factor of 2 in the size is
2477 * to allow for an error byte for each input byte.
2479 ibuf = kmalloc(2 * ibufsize, M_DEVBUF, M_WAITOK | M_ZERO);
2481 /* Initialize non-critical variables. */
2482 com->ibufold = com->ibuf;
2483 com->ibufsize = ibufsize;
2486 tp->t_ififosize = 2 * ibufsize;
2487 tp->t_ispeedwat = (speed_t)-1;
2488 tp->t_ospeedwat = (speed_t)-1;
2492 * Read current input buffer.
2495 if (com->iptr != com->ibuf)
2499 * Initialize critical variables, including input buffer watermarks.
2500 * The external device is asked to stop sending when the buffer
2501 * exactly reaches high water, or when the high level requests it.
2502 * The high level is notified immediately (rather than at a later
2503 * clock tick) when this watermark is reached.
2504 * The buffer size is chosen so the watermark should almost never
2506 * The low watermark is invisibly 0 since the buffer is always
2507 * emptied all at once.
2509 com->iptr = com->ibuf = ibuf;
2510 com->ibufend = ibuf + ibufsize;
2511 com->ierroff = ibufsize;
2512 com->ihighwater = ibuf + 3 * ibufsize / 4;
2518 comstart(struct tty *tp)
2523 lwkt_gettoken(&tty_token);
2524 unit = DEV_TO_UNIT(tp->t_dev);
2525 com = com_addr(unit);
2527 lwkt_reltoken(&tty_token);
2532 if (tp->t_state & TS_TTSTOP)
2533 com->state &= ~CS_TTGO;
2535 com->state |= CS_TTGO;
2536 if (tp->t_state & TS_TBLOCK) {
2537 if (com->mcr_image & MCR_RTS && com->state & CS_RTS_IFLOW)
2538 outb(com->modem_ctl_port, com->mcr_image &= ~MCR_RTS);
2540 if (!(com->mcr_image & MCR_RTS) && com->iptr < com->ihighwater
2541 && com->state & CS_RTS_IFLOW)
2542 outb(com->modem_ctl_port, com->mcr_image |= MCR_RTS);
2545 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
2548 lwkt_reltoken(&tty_token);
2551 if (tp->t_outq.c_cc != 0) {
2555 if (!com->obufs[0].l_queued) {
2556 com->obufs[0].l_tail
2557 = com->obuf1 + q_to_b(&tp->t_outq, com->obuf1,
2559 com->obufs[0].l_next = NULL;
2560 com->obufs[0].l_queued = TRUE;
2562 if (com->state & CS_BUSY) {
2563 qp = com->obufq.l_next;
2564 while ((next = qp->l_next) != NULL)
2566 qp->l_next = &com->obufs[0];
2568 com->obufq.l_head = com->obufs[0].l_head;
2569 com->obufq.l_tail = com->obufs[0].l_tail;
2570 com->obufq.l_next = &com->obufs[0];
2571 com->state |= CS_BUSY;
2575 if (tp->t_outq.c_cc != 0 && !com->obufs[1].l_queued) {
2576 com->obufs[1].l_tail
2577 = com->obuf2 + q_to_b(&tp->t_outq, com->obuf2,
2579 com->obufs[1].l_next = NULL;
2580 com->obufs[1].l_queued = TRUE;
2582 if (com->state & CS_BUSY) {
2583 qp = com->obufq.l_next;
2584 while ((next = qp->l_next) != NULL)
2586 qp->l_next = &com->obufs[1];
2588 com->obufq.l_head = com->obufs[1].l_head;
2589 com->obufq.l_tail = com->obufs[1].l_tail;
2590 com->obufq.l_next = &com->obufs[1];
2591 com->state |= CS_BUSY;
2595 tp->t_state |= TS_BUSY;
2598 if (com->state >= (CS_BUSY | CS_TTGO))
2599 siointr1(com); /* fake interrupt to start output */
2603 lwkt_reltoken(&tty_token);
2607 comstop(struct tty *tp, int rw)
2611 lwkt_gettoken(&tty_token);
2612 com = com_addr(DEV_TO_UNIT(tp->t_dev));
2613 if (com == NULL || com->gone) {
2614 lwkt_reltoken(&tty_token);
2621 /* XXX avoid h/w bug. */
2624 sio_setreg(com, com_fifo,
2625 FIFO_XMT_RST | com->fifo_image);
2626 com->obufs[0].l_queued = FALSE;
2627 com->obufs[1].l_queued = FALSE;
2628 if (com->state & CS_ODONE)
2629 com_events -= LOTS_OF_EVENTS;
2630 com->state &= ~(CS_ODONE | CS_BUSY);
2631 com->tp->t_state &= ~TS_BUSY;
2636 /* XXX avoid h/w bug. */
2639 sio_setreg(com, com_fifo,
2640 FIFO_RCV_RST | com->fifo_image);
2641 com_events -= (com->iptr - com->ibuf);
2642 com->iptr = com->ibuf;
2646 lwkt_reltoken(&tty_token);
2650 commctl(struct com_s *com, int bits, int how)
2655 lwkt_gettoken(&tty_token);
2657 bits = TIOCM_LE; /* XXX - always enabled while open */
2658 mcr = com->mcr_image;
2663 msr = com->prev_modem_status;
2671 * XXX - MSR_RI is naturally volatile, and we make MSR_TERI
2672 * more volatile by reading the modem status a lot. Perhaps
2673 * we should latch both bits until the status is read here.
2675 if (msr & (MSR_RI | MSR_TERI))
2677 lwkt_reltoken(&tty_token);
2681 if (bits & TIOCM_DTR)
2683 if (bits & TIOCM_RTS)
2686 lwkt_reltoken(&tty_token);
2692 outb(com->modem_ctl_port,
2693 com->mcr_image = mcr | (com->mcr_image & MCR_IENABLE));
2696 outb(com->modem_ctl_port, com->mcr_image |= mcr);
2699 outb(com->modem_ctl_port, com->mcr_image &= ~mcr);
2703 lwkt_reltoken(&tty_token);
2708 * NOTE: Must be called with tty_token held
2717 ASSERT_LWKT_TOKEN_HELD(&tty_token);
2719 * Set our timeout period to 1 second if no polled devices are open.
2720 * Otherwise set it to max(1/200, 1/hz).
2721 * Enable timeouts iff some device is open.
2723 callout_stop(&sio_timeout_handle);
2726 for (unit = 0; unit < sio_numunits; ++unit) {
2727 com = com_addr(unit);
2728 if (com != NULL && com->tp != NULL
2729 && com->tp->t_state & TS_ISOPEN && !com->gone) {
2731 if (com->poll || com->poll_output) {
2732 sio_timeout = hz > 200 ? hz / 200 : 1;
2738 sio_timeouts_until_log = hz / sio_timeout;
2739 callout_reset(&sio_timeout_handle, sio_timeout,
2742 /* Flush error messages, if any. */
2743 sio_timeouts_until_log = 1;
2745 callout_stop(&sio_timeout_handle);
2750 * NOTE: Must be called with tty_token held
2753 comwakeup(void *chan)
2759 * Can be called from a callout too so just get the token
2761 lwkt_gettoken(&tty_token);
2762 callout_reset(&sio_timeout_handle, sio_timeout, comwakeup, NULL);
2765 * Recover from lost output interrupts.
2766 * Poll any lines that don't use interrupts.
2768 for (unit = 0; unit < sio_numunits; ++unit) {
2769 com = com_addr(unit);
2770 if (com != NULL && !com->gone
2771 && (com->state >= (CS_BUSY | CS_TTGO) || com->poll)) {
2779 * Check for and log errors, but not too often.
2781 if (--sio_timeouts_until_log > 0) {
2782 lwkt_reltoken(&tty_token);
2785 sio_timeouts_until_log = hz / sio_timeout;
2786 for (unit = 0; unit < sio_numunits; ++unit) {
2789 com = com_addr(unit);
2794 for (errnum = 0; errnum < CE_NTYPES; ++errnum) {
2799 delta = com->delta_error_counts[errnum];
2800 com->delta_error_counts[errnum] = 0;
2804 total = com->error_counts[errnum] += delta;
2805 log(LOG_ERR, "sio%d: %u more %s%s (total %lu)\n",
2806 unit, delta, error_desc[errnum],
2807 delta == 1 ? "" : "s", total);
2810 lwkt_reltoken(&tty_token);
2814 disc_optim(struct tty *tp, struct termios *t, struct com_s *com)
2816 lwkt_gettoken(&tty_token);
2817 if (!(t->c_iflag & (ICRNL | IGNCR | IMAXBEL | INLCR | ISTRIP | IXON))
2818 && (!(t->c_iflag & BRKINT) || (t->c_iflag & IGNBRK))
2819 && (!(t->c_iflag & PARMRK)
2820 || (t->c_iflag & (IGNPAR | IGNBRK)) == (IGNPAR | IGNBRK))
2821 && !(t->c_lflag & (ECHO | ICANON | IEXTEN | ISIG | PENDIN))
2822 && linesw[tp->t_line].l_rint == ttyinput)
2823 tp->t_state |= TS_CAN_BYPASS_L_RINT;
2825 tp->t_state &= ~TS_CAN_BYPASS_L_RINT;
2826 com->hotchar = linesw[tp->t_line].l_hotchar;
2827 lwkt_reltoken(&tty_token);
2831 * Following are all routines needed for SIO to act as console
2833 #include <sys/cons.h>
2843 static speed_t siocngetspeed (Port_t, u_long rclk);
2845 static void siocnclose (struct siocnstate *sp, Port_t iobase);
2847 static void siocnopen (struct siocnstate *sp, Port_t iobase, int speed);
2848 static void siocntxwait (Port_t iobase);
2850 static cn_probe_t siocnprobe;
2851 static cn_init_t siocninit;
2852 static cn_init_fini_t siocninit_fini;
2853 static cn_checkc_t siocncheckc;
2854 static cn_getc_t siocngetc;
2855 static cn_putc_t siocnputc;
2857 #if defined(__i386__) || defined(__x86_64__)
2858 CONS_DRIVER(sio, siocnprobe, siocninit, siocninit_fini,
2859 NULL, siocngetc, siocncheckc, siocnputc, NULL);
2862 /* To get the GDB related variables */
2864 #include <ddb/ddb.h>
2868 siocntxwait(Port_t iobase)
2873 * Wait for any pending transmission to finish. Required to avoid
2874 * the UART lockup bug when the speed is changed, and for normal
2878 while ((inb(iobase + com_lsr) & (LSR_TSRE | LSR_TXRDY))
2879 != (LSR_TSRE | LSR_TXRDY) && --timo != 0)
2884 * Read the serial port specified and try to figure out what speed
2885 * it's currently running at. We're assuming the serial port has
2886 * been initialized and is basicly idle. This routine is only intended
2887 * to be run at system startup.
2889 * If the value read from the serial port doesn't make sense, return 0.
2892 * NOTE: Must be called with tty_token held
2895 siocngetspeed(Port_t iobase, u_long rclk)
2902 cfcr = inb(iobase + com_cfcr);
2903 outb(iobase + com_cfcr, CFCR_DLAB | cfcr);
2905 dlbl = inb(iobase + com_dlbl);
2906 dlbh = inb(iobase + com_dlbh);
2908 outb(iobase + com_cfcr, cfcr);
2910 divisor = dlbh << 8 | dlbl;
2912 /* XXX there should be more sanity checking. */
2915 return (rclk / (16UL * divisor));
2919 siocnopen(struct siocnstate *sp, Port_t iobase, int speed)
2926 * Save all the device control registers except the fifo register
2927 * and set our default ones (cs8 -parenb speed=comdefaultrate).
2928 * We can't save the fifo register since it is read-only.
2930 sp->ier = inb(iobase + com_ier);
2931 outb(iobase + com_ier, 0); /* spltty() doesn't stop siointr() */
2932 siocntxwait(iobase);
2933 sp->cfcr = inb(iobase + com_cfcr);
2934 outb(iobase + com_cfcr, CFCR_DLAB | CFCR_8BITS);
2935 sp->dlbl = inb(iobase + com_dlbl);
2936 sp->dlbh = inb(iobase + com_dlbh);
2938 * Only set the divisor registers if they would change, since on
2939 * some 16550 incompatibles (Startech), setting them clears the
2940 * data input register. This also reduces the effects of the
2943 divisor = siodivisor(comdefaultrclk, speed);
2944 dlbl = divisor & 0xFF;
2945 if (sp->dlbl != dlbl)
2946 outb(iobase + com_dlbl, dlbl);
2947 dlbh = divisor >> 8;
2948 if (sp->dlbh != dlbh)
2949 outb(iobase + com_dlbh, dlbh);
2950 outb(iobase + com_cfcr, CFCR_8BITS);
2951 sp->mcr = inb(iobase + com_mcr);
2953 * We don't want interrupts, but must be careful not to "disable"
2954 * them by clearing the MCR_IENABLE bit, since that might cause
2955 * an interrupt by floating the IRQ line.
2957 outb(iobase + com_mcr, (sp->mcr & MCR_IENABLE) | MCR_DTR | MCR_RTS);
2962 siocnclose(struct siocnstate *sp, Port_t iobase)
2965 * Restore the device control registers.
2967 siocntxwait(iobase);
2968 outb(iobase + com_cfcr, CFCR_DLAB | CFCR_8BITS);
2969 if (sp->dlbl != inb(iobase + com_dlbl))
2970 outb(iobase + com_dlbl, sp->dlbl);
2971 if (sp->dlbh != inb(iobase + com_dlbh))
2972 outb(iobase + com_dlbh, sp->dlbh);
2973 outb(iobase + com_cfcr, sp->cfcr);
2975 * XXX damp oscillations of MCR_DTR and MCR_RTS by not restoring them.
2977 outb(iobase + com_mcr, sp->mcr | MCR_DTR | MCR_RTS);
2978 outb(iobase + com_ier, sp->ier);
2983 siocnprobe(struct consdev *cp)
2989 struct siocnstate sp;
2992 * Find our first enabled console, if any. If it is a high-level
2993 * console device, then initialize it and return successfully.
2994 * If it is a low-level console device, then initialize it and
2995 * return unsuccessfully. It must be initialized in both cases
2996 * for early use by console drivers and debuggers. Initializing
2997 * the hardware is not necessary in all cases, since the i/o
2998 * routines initialize it on the fly, but it is necessary if
2999 * input might arrive while the hardware is switched back to an
3000 * uninitialized state. We can't handle multiple console devices
3001 * yet because our low-level routines don't take a device arg.
3002 * We trust the user to set the console flags properly so that we
3003 * don't need to probe.
3005 cp->cn_pri = CN_DEAD;
3007 for (unit = 0; unit < 16; unit++) { /* XXX need to know how many */
3010 if (resource_int_value("sio", unit, "disabled", &disabled) == 0) {
3014 if (resource_int_value("sio", unit, "flags", &flags))
3016 if (COM_CONSOLE(flags) || COM_DEBUGGER(flags)) {
3020 if (resource_int_value("sio", unit, "port", &port))
3024 if (boothowto & RB_SERIAL) {
3026 siocngetspeed(iobase, comdefaultrclk);
3028 comdefaultrate = boot_speed;
3032 * Initialize the divisor latch. We can't rely on
3033 * siocnopen() to do this the first time, since it
3034 * avoids writing to the latch if the latch appears
3035 * to have the correct value. Also, if we didn't
3036 * just read the speed from the hardware, then we
3037 * need to set the speed in hardware so that
3038 * switching it later is null.
3041 cfcr = inb(iobase + com_cfcr);
3042 outb(iobase + com_cfcr, CFCR_DLAB | cfcr);
3043 divisor = siodivisor(comdefaultrclk, comdefaultrate);
3044 outb(iobase + com_dlbl, divisor & 0xff);
3045 outb(iobase + com_dlbh, divisor >> 8);
3046 outb(iobase + com_cfcr, cfcr);
3048 siocnopen(&sp, iobase, comdefaultrate);
3052 if (COM_CONSOLE(flags) && !COM_LLCONSOLE(flags)) {
3053 cp->cn_probegood = 1;
3054 cp->cn_private = (void *)(intptr_t)unit;
3055 cp->cn_pri = COM_FORCECONSOLE(flags)
3056 || boothowto & RB_SERIAL
3057 ? CN_REMOTE : CN_NORMAL;
3058 siocniobase = iobase;
3061 if (COM_DEBUGGER(flags) && gdb_tab == NULL) {
3062 kprintf("sio%d: gdb debugging port\n", unit);
3063 siogdbiobase = iobase;
3066 cp->cn_gdbprivate = (void *)(intptr_t)unit;
3072 #if defined(__i386__) || defined(__x86_64__)
3075 * XXX Ugly Compatability.
3076 * If no gdb port has been specified, set it to be the console
3077 * as some configuration files don't specify the gdb port.
3079 if (gdb_tab == NULL && (boothowto & RB_GDB)) {
3080 kprintf("Warning: no GDB port specified. Defaulting to sio%d.\n",
3082 kprintf("Set flag 0x80 on desired GDB port in your\n");
3083 kprintf("configuration file (currently sio only).\n");
3084 siogdbiobase = siocniobase;
3085 siogdbunit = siocnunit;
3086 cp->cn_gdbprivate = (void *)(intptr_t)siocnunit;
3094 siocninit(struct consdev *cp)
3096 comconsole = (int)(intptr_t)cp->cn_private;
3100 siocninit_fini(struct consdev *cp)
3105 if (cp->cn_probegood) {
3106 unit = (int)(intptr_t)cp->cn_private;
3108 * Call devfs_find_device_by_name on ttydX to find the correct device,
3109 * as it should have been created already at this point by the
3111 * If it isn't found, the serial port was not attached at all and we
3112 * shouldn't be here, so assert this case.
3114 dev = devfs_find_device_by_name("ttyd%r", unit);
3116 KKASSERT(dev != NULL);
3122 siocncheckc(void *private)
3125 int unit = (int)(intptr_t)private;
3128 struct siocnstate sp;
3131 if (unit == siogdbunit)
3132 iobase = siogdbiobase;
3134 iobase = siocniobase;
3138 siocnopen(&sp, iobase, comdefaultrate);
3140 if (inb(iobase + com_lsr) & LSR_RXRDY)
3141 c = inb(iobase + com_data);
3145 siocnclose(&sp, iobase);
3154 siocngetc(void *private)
3157 int unit = (int)(intptr_t)private;
3160 struct siocnstate sp;
3163 if (unit == siogdbunit)
3164 iobase = siogdbiobase;
3166 iobase = siocniobase;
3170 siocnopen(&sp, iobase, comdefaultrate);
3172 while (!(inb(iobase + com_lsr) & LSR_RXRDY))
3174 c = inb(iobase + com_data);
3176 siocnclose(&sp, iobase);
3184 siocnputc(void *private, int c)
3186 int unit = (int)(intptr_t)private;
3188 struct siocnstate sp;
3192 if (unit == siogdbunit)
3193 iobase = siogdbiobase;
3195 iobase = siocniobase;
3199 siocnopen(&sp, iobase, comdefaultrate);
3201 siocntxwait(iobase);
3202 outb(iobase + com_data, c);
3204 siocnclose(&sp, iobase);
3210 DRIVER_MODULE(sio, isa, sio_isa_driver, sio_devclass, NULL, NULL);
3211 DRIVER_MODULE(sio, acpi, sio_isa_driver, sio_devclass, NULL, NULL);
3213 DRIVER_MODULE(sio, pci, sio_pci_driver, sio_devclass, NULL, NULL);
3216 DRIVER_MODULE(sio, puc, sio_puc_driver, sio_devclass, NULL, NULL);