kernel: Remove some unused variables in the serial drivers.
[dragonfly.git] / sys / dev / serial / sio / sio.c
blobd814a31769f5e8656c977945e5a2674a36a8a00a
1 /*-
2 * (MPSAFE)
4 * Copyright (c) 1991 The Regents of the University of California.
5 * All rights reserved.
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 * 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
33 * SUCH DAMAGE.
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"
42 #include "opt_ddb.h"
43 #include "opt_sio.h"
44 #include "use_pci.h"
45 #include "use_puc.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>
60 #include <sys/tty.h>
61 #include <sys/proc.h>
62 #include <sys/priv.h>
63 #include <sys/module.h>
64 #include <sys/conf.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>
71 #include <sys/bus.h>
72 #include <sys/rman.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>
82 #if NPCI > 0
83 #include <bus/pci/pcireg.h>
84 #include <bus/pci/pcivar.h>
85 #endif
86 #if NPUC > 0
87 #include <dev/misc/puc/pucvar.h>
88 #endif
89 #include <machine/lock.h>
91 #include <machine/clock.h>
93 #include "sioreg.h"
94 #include "sio_private.h"
96 #ifdef COM_ESP
97 #include "../ic_layer/esp.h"
98 #endif
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)) \
108 | ((mynor) & 0x1f))
109 #define UNIT_TO_MINOR(unit) ((((unit) & ~0x1fU) << (8 + 3)) \
110 | ((unit) & 0x1f))
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)))
120 * com state bits.
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
123 * off the low bits.
125 * The following com and tty flags correspond closely:
126 * CS_BUSY = TS_BUSY (maintained by comstart(), siopoll() and
127 * comstop())
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[] = {
146 #define CE_OVERRUN 0
147 "silo overflow",
148 #define CE_INTERRUPT_BUF_OVERFLOW 1
149 "interrupt-level buffer overflow",
150 #define CE_TTY_BUF_OVERFLOW 2
151 "tty-level buffer overflow",
154 #ifdef COM_ESP
155 static int espattach (struct com_s *com, Port_t esp_port);
156 #endif
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,
176 struct com_s *com);
178 #if NPCI > 0
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 */
184 #if NPUC > 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),
201 { 0, 0 }
204 static driver_t sio_isa_driver = {
205 driver_name,
206 sio_isa_methods,
207 sizeof(struct com_s),
210 #if NPCI > 0
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),
216 { 0, 0 }
219 static driver_t sio_pci_driver = {
220 driver_name,
221 sio_pci_methods,
222 sizeof(struct com_s),
224 #endif /* NPCI > 0 */
226 #if NPUC > 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),
232 { 0, 0 }
235 static driver_t sio_puc_driver = {
236 driver_name,
237 sio_puc_methods,
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 },
250 .d_open = sioopen,
251 .d_close = sioclose,
252 .d_read = sioread,
253 .d_write = siowrite,
254 .d_ioctl = sioioctl,
255 .d_kqfilter = ttykqfilter,
256 .d_revoke = ttyrevoke
259 int comconsole = -1;
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;
274 #ifdef COM_ESP
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 };
278 #endif
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
287 * itself.
290 static int
291 sysctl_machdep_comdefaultrate(SYSCTL_HANDLER_ARGS)
293 int error;
294 speed_t newspeed;
295 struct com_s *com;
296 struct tty *tp;
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);
304 return (error);
307 comdefaultrate = newspeed;
309 if (comconsole < 0) { /* serial console not selected? */
310 lwkt_reltoken(&tty_token);
311 return (0);
314 com = com_addr(comconsole);
315 if (com == NULL) {
316 lwkt_reltoken(&tty_token);
317 return (ENXIO);
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
323 * speed changes)
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
333 tp = com->tp;
334 if (tp && (tp->t_state & TS_ISOPEN)) {
335 tp->t_termios.c_ispeed =
336 tp->t_termios.c_ospeed = comdefaultrate;
337 crit_enter();
338 error = comparam(tp, &tp->t_termios);
339 crit_exit();
341 lwkt_reltoken(&tty_token);
342 return error;
345 SYSCTL_PROC(_machdep, OID_AUTO, conspeed, CTLTYPE_INT | CTLFLAG_RW,
346 0, 0, sysctl_machdep_comdefaultrate, "I", "");
348 #if NPCI > 0
349 struct pci_ids {
350 u_int32_t type;
351 const char *desc;
352 int rid;
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 }
368 static int
369 sio_pci_attach(device_t dev)
371 u_int32_t type;
372 struct pci_ids *id;
374 type = pci_get_devid(dev);
375 id = pci_ids;
376 while (id->type && id->type != type)
377 id++;
378 if (id->desc == NULL)
379 return (ENXIO);
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.
388 static void
389 sio_pci_kludge_unit(device_t dev)
391 devclass_t dc;
392 int err;
393 int start;
394 int unit;
396 unit = 0;
397 start = 0;
398 while (resource_int_value("sio", unit, "port", &start) == 0 &&
399 start > 0)
400 unit++;
401 if (device_get_unit(dev) < unit) {
402 dc = device_get_devclass(dev);
403 while (devclass_get_device(dc, unit))
404 unit++;
405 device_printf(dev, "moving to sio%d\n", unit);
406 err = device_set_unit(dev, unit); /* EVIL DO NOT COPY */
407 if (err)
408 device_printf(dev, "error moving device %d\n", err);
412 static int
413 sio_pci_probe(device_t dev)
415 u_int32_t type;
416 struct pci_ids *id;
418 type = pci_get_devid(dev);
419 id = pci_ids;
420 while (id->type && id->type != type)
421 id++;
422 if (id->desc == NULL)
423 return (ENXIO);
424 device_set_desc(dev, id->desc);
425 return (sioprobe(dev, id->rid, 0UL));
427 #endif /* NPCI > 0 */
429 #if NPUC > 0
430 static int
431 sio_puc_attach(device_t dev)
433 uintptr_t rclk;
435 if (BUS_READ_IVAR(device_get_parent(dev), dev, PUC_IVAR_FREQ,
436 &rclk) != 0)
437 rclk = DEFAULT_RCLK;
438 return (sioattach(dev, 0, rclk));
441 static int
442 sio_puc_probe(device_t dev)
444 uintptr_t rclk;
446 if (BUS_READ_IVAR(device_get_parent(dev), dev, PUC_IVAR_FREQ,
447 &rclk) != 0)
448 rclk = DEFAULT_RCLK;
449 return (sioprobe(dev, 0, rclk));
451 #endif /* NPUC */
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 */
539 static int
540 sio_isa_probe(device_t dev)
542 /* Check isapnp ids */
543 if (ISA_PNP_PROBE(device_get_parent(dev), dev, sio_ids) == ENXIO)
544 return (ENXIO);
545 return (sioprobe(dev, 0, 0UL));
549 sioprobe(device_t dev, int xrid, u_long rclk)
551 #if 0
552 static bool_t already_init;
553 device_t xdev;
554 #endif
555 struct com_s *com;
556 u_int divisor;
557 bool_t failures[10];
558 int fn;
559 device_t idev;
560 Port_t iobase;
561 intrmask_t irqmap[4];
562 intrmask_t irqs;
563 u_char mcr_image;
564 int result;
565 u_long xirq;
566 u_int flags = device_get_flags(dev);
567 int rid;
568 struct resource *port;
570 rid = xrid;
571 port = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
572 0, ~0, IO_COMSIZE, RF_ACTIVE);
573 if (!port)
574 return (ENXIO);
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);
580 if (rclk == 0)
581 rclk = DEFAULT_RCLK;
582 com->rclk = rclk;
584 #if 0
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.
592 if (!already_init) {
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.
599 device_t *devs;
600 int count, i, xioport;
602 devclass_get_devices(sio_devclass, &devs, &count);
603 for (i = 0; i < count; i++) {
604 xdev = devs[i];
605 if (device_is_enabled(xdev) &&
606 bus_get_resource(xdev, SYS_RES_IOPORT, 0, &xioport,
607 NULL) == 0)
608 outb(xioport + com_mcr, 0);
610 kfree(devs, M_TEMP);
611 already_init = TRUE;
613 #endif
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);
620 return (ENXIO);
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.
631 idev = dev;
632 mcr_image = MCR_IENABLE;
633 #ifdef COM_MULTIPORT
634 if (COM_ISMULTIPORT(flags)) {
635 Port_t xiobase;
636 u_long io;
638 idev = devclass_get_device(sio_devclass, COM_MPMASTER(flags));
639 if (idev == NULL) {
640 kprintf("sio%d: master device %d not configured\n",
641 device_get_unit(dev), COM_MPMASTER(flags));
642 idev = dev;
644 if (!COM_NOTAST4(flags)) {
645 if (bus_get_resource(idev, SYS_RES_IOPORT, 0, &io,
646 NULL) == 0) {
647 xiobase = io;
648 if (bus_get_resource(idev, SYS_RES_IRQ, 0,
649 NULL, NULL) == 0)
650 outb(xiobase + com_scr, 0x80);
651 else
652 outb(xiobase + com_scr, 0);
654 mcr_image = 0;
657 #endif /* COM_MULTIPORT */
658 if (bus_get_resource(idev, SYS_RES_IRQ, 0, NULL, NULL) != 0)
659 mcr_image = 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.
670 com_lock();
671 /* EXTRA DELAY? */
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)) {
679 u_char cfcr, efr;
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);
686 /* Disable EFR. */
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
702 * master reset.
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));
708 } else {
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)
723 break;
724 (void)sio_getreg(com, com_data);
726 if (fn == 256) {
727 com_unlock();
728 lwkt_reltoken(&tty_token);
729 kprintf("sio%d: can't drain, serial port might "
730 "not exist, disabling\n", device_get_unit(dev));
731 return (ENXIO);
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.
739 /* EXTRA DELAY? */
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.
749 /* EXTRA DELAY? */
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
776 * are disabled.
778 /* EXTRA DELAY? */
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 ++) {
788 DELAY(10000);
789 failures[6] = sio_getreg(com, com_iir);
791 /* Check IIR_TXRDY clear ? */
792 result = 0;
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);
799 } else {
800 /* Unknown, Just omit this chip.. XXX */
801 result = ENXIO;
802 sio_setreg(com, com_mcr, 0);
804 } else {
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);
810 com_unlock();
811 bus_release_resource(dev, SYS_RES_IOPORT, rid, port);
812 lwkt_reltoken(&tty_token);
813 return (iobase == siocniobase ? 0 : result);
817 * Check that
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.
824 /* EXTRA DELAY? */
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;
851 com_unlock();
853 irqs = irqmap[1] & ~irqmap[0];
854 if (bus_get_resource(idev, SYS_RES_IRQ, 0, &xirq, NULL) == 0 &&
855 ((1 << xirq) & irqs) == 0)
856 kprintf(
857 "sio%d: configured irq %ld not in bitmap of probed irqs %#x\n",
858 device_get_unit(dev), xirq, irqs);
859 if (bootverbose)
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]);
864 result = 0;
865 for (fn = 0; fn < sizeof failures; ++fn)
866 if (failures[fn]) {
867 sio_setreg(com, com_mcr, 0);
868 result = ENXIO;
869 if (bootverbose) {
870 kprintf("sio%d: probe failed test(s):",
871 device_get_unit(dev));
872 for (fn = 0; fn < sizeof failures; ++fn)
873 if (failures[fn])
874 kprintf(" %d", fn);
875 kprintf("\n");
877 break;
879 bus_release_resource(dev, SYS_RES_IOPORT, rid, port);
880 lwkt_reltoken(&tty_token);
881 return (iobase == siocniobase ? 0 : result);
884 #ifdef COM_ESP
885 static int
886 espattach(struct com_s *com, Port_t esp_port)
888 u_char dips;
889 u_char val;
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);
897 return (0);
900 lwkt_gettoken(&tty_token);
902 * We've got something that claims to be a Hayes ESP card.
903 * Let's hope so.
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])
914 kprintf(" : ESP");
915 else {
916 kprintf(" esp_port has com %d\n", dips & 0x03);
917 lwkt_reltoken(&tty_token);
918 return (0);
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);
930 return (0);
934 * Check for ability to emulate 16550: bit 7 == 1
936 if ((dips & 0x80) == 0) {
937 kprintf(" slave");
938 lwkt_reltoken(&tty_token);
939 return (0);
943 * Okay, we seem to be a Hayes ESP card. Whee.
945 com->esp = TRUE;
946 com->esp_port = esp_port;
947 lwkt_reltoken(&tty_token);
948 return (1);
950 #endif /* COM_ESP */
952 static int
953 sio_isa_attach(device_t dev)
955 return (sioattach(dev, 0, 0UL));
959 sioattach(device_t dev, int xrid, u_long rclk)
961 struct com_s *com;
962 #ifdef COM_ESP
963 Port_t *espp;
964 #endif
965 Port_t iobase;
966 int minorbase;
967 int unit;
968 u_int flags;
969 int rid;
970 struct resource *port;
971 int ret;
972 static int did_init;
974 lwkt_gettoken(&tty_token);
975 if (did_init == 0) {
976 did_init = 1;
977 callout_init_mp(&sio_timeout_handle);
980 rid = xrid;
981 port = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
982 0, ~0, IO_COMSIZE, RF_ACTIVE);
983 if (!port) {
984 lwkt_reltoken(&tty_token);
985 return (ENXIO);
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.
1000 * o ier = 0.
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);
1008 com->unit = unit;
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;
1030 if (rclk == 0)
1031 rclk = DEFAULT_RCLK;
1032 com->rclk = 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;
1053 } else
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);
1063 return (ENOMEM);
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))
1074 #else
1075 if (!COM_IIR_TXRDYBUG(flags))
1076 #endif
1078 u_char scr;
1079 u_char scr1;
1080 u_char scr2;
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) {
1089 kprintf(" 8250");
1090 goto determined_type;
1093 sio_setreg(com, com_fifo, FIFO_ENABLE | FIFO_RX_HIGH);
1094 DELAY(100);
1095 com->st16650a = 0;
1096 switch (inb(com->int_id_port) & IIR_FIFO_MASK) {
1097 case FIFO_RX_LOW:
1098 kprintf(" 16450");
1099 break;
1100 case FIFO_RX_MEDL:
1101 kprintf(" 16450?");
1102 break;
1103 case FIFO_RX_MEDH:
1104 kprintf(" 16550?");
1105 break;
1106 case FIFO_RX_HIGH:
1107 if (COM_NOFIFO(flags)) {
1108 kprintf(" 16550A fifo disabled");
1109 } else {
1110 com->hasfifo = TRUE;
1111 if (COM_ST16650A(flags)) {
1112 com->st16650a = 1;
1113 com->tx_fifo_size = 32;
1114 kprintf(" ST16650A");
1115 } else if (COM_TI16754(flags)) {
1116 com->tx_fifo_size = 64;
1117 kprintf(" TI16754");
1118 } else {
1119 com->tx_fifo_size = COM_FIFOSIZE(flags);
1120 kprintf(" 16550A");
1123 #ifdef COM_ESP
1124 for (espp = likely_esp_ports; *espp != 0; espp++)
1125 if (espattach(com, *espp)) {
1126 com->tx_fifo_size = 1024;
1127 break;
1129 #endif
1130 if (!com->st16650a && !COM_TI16754(flags)) {
1131 if (!com->tx_fifo_size)
1132 com->tx_fifo_size = 16;
1133 else
1134 kprintf(" lookalike with %d bytes FIFO",
1135 com->tx_fifo_size);
1138 break;
1141 #ifdef COM_ESP
1142 if (com->esp) {
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
1147 * bursts of input.
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);
1167 determined_type: ;
1169 #ifdef COM_MULTIPORT
1170 if (COM_ISMULTIPORT(flags)) {
1171 device_t masterdev;
1173 com->multiport = TRUE;
1174 kprintf(" (multiport");
1175 if (unit == COM_MPMASTER(flags))
1176 kprintf(" master");
1177 kprintf(")");
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");
1188 kprintf("\n");
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);
1207 com->flags = flags;
1208 com->pps.ppscap = PPS_CAPTUREASSERT | PPS_CAPTURECLEAR;
1209 pps_init(&com->pps);
1211 rid = 0;
1212 com->irqres = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0ul, ~0ul, 1,
1213 RF_ACTIVE);
1214 if (com->irqres) {
1215 ret = BUS_SETUP_INTR(device_get_parent(dev), dev,
1216 com->irqres, INTR_MPSAFE, siointr, com,
1217 &com->cookie, NULL, NULL);
1218 if (ret)
1219 device_printf(dev, "could not activate interrupt\n");
1220 #if defined(DDB)
1222 * Enable interrupts for early break-to-debugger support
1223 * on the console.
1225 if (ret == 0 && unit == comconsole &&
1226 (break_to_debugger || alt_break_to_debugger)) {
1227 outb(siocniobase + com_ier, IER_ERXRDY | IER_ERLS |
1228 IER_EMSC);
1230 #endif
1233 lwkt_reltoken(&tty_token);
1234 return (0);
1237 static int
1238 sioopen(struct dev_open_args *ap)
1240 cdev_t dev = ap->a_head.a_dev;
1241 struct com_s *com;
1242 int error;
1243 int mynor;
1244 struct tty *tp;
1245 int unit;
1247 mynor = minor(dev);
1248 unit = MINOR_TO_UNIT(mynor);
1249 com = com_addr(unit);
1250 if (com == NULL)
1251 return (ENXIO);
1252 if (com->gone)
1253 return (ENXIO);
1254 if (mynor & CONTROL_MASK)
1255 return (0);
1256 lwkt_gettoken(&tty_token);
1257 tp = dev->si_tty = com->tp = ttymalloc(com->tp);
1258 crit_enter();
1260 * We jump to this label after all non-interrupted sleeps to pick
1261 * up any changes of the device state.
1263 open_top:
1264 while (com->state & CS_DTR_OFF) {
1265 error = tsleep(&com->dtr_wait, PCATCH, "siodtr", 0);
1266 if (com_addr(unit) == NULL) {
1267 crit_exit();
1268 lwkt_reltoken(&tty_token);
1269 return (ENXIO);
1271 if (error != 0 || com->gone)
1272 goto out;
1274 if (tp->t_state & TS_ISOPEN) {
1276 * The device is open, so everything has been initialized.
1277 * Handle conflicts.
1279 if (mynor & CALLOUT_MASK) {
1280 if (!com->active_out) {
1281 error = EBUSY;
1282 goto out;
1284 } else {
1285 if (com->active_out) {
1286 if (ap->a_oflags & O_NONBLOCK) {
1287 error = EBUSY;
1288 goto out;
1290 error = tsleep(&com->active_out,
1291 PCATCH, "siobi", 0);
1292 if (com_addr(unit) == NULL) {
1293 crit_exit();
1294 lwkt_reltoken(&tty_token);
1295 return (ENXIO);
1297 if (error != 0 || com->gone)
1298 goto out;
1299 goto open_top;
1302 if (tp->t_state & TS_XCLUDE && priv_check_cred(ap->a_cred, PRIV_ROOT, 0)) {
1303 error = EBUSY;
1304 goto out;
1306 } else {
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;
1316 tp->t_dev = dev;
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;
1322 ++com->wopeners;
1323 error = comparam(tp, &tp->t_termios);
1324 --com->wopeners;
1325 if (error != 0)
1326 goto out;
1328 * XXX we should goto open_top if comparam() slept.
1330 if (com->hasfifo) {
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
1340 * input.
1342 while (TRUE) {
1343 sio_setreg(com, com_fifo,
1344 FIFO_RCV_RST | FIFO_XMT_RST
1345 | com->fifo_image);
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.
1357 DELAY(50);
1358 if (!(inb(com->line_status_port) & LSR_RXRDY))
1359 break;
1360 sio_setreg(com, com_fifo, 0);
1361 DELAY(50);
1362 (void) inb(com->data_port);
1366 com_lock();
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
1373 | IER_EMSC);
1374 } else {
1375 outb(com->intr_ctl_port, IER_ERXRDY | IER_ETXRDY
1376 | IER_ERLS | IER_EMSC);
1378 com_unlock();
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
1390 * the true carrier.
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)) {
1400 ++com->wopeners;
1401 error = tsleep(TSA_CARR_ON(tp), PCATCH, "siodcd", 0);
1402 if (com_addr(unit) == NULL) {
1403 crit_exit();
1404 lwkt_reltoken(&tty_token);
1405 return (ENXIO);
1407 --com->wopeners;
1408 if (error != 0 || com->gone)
1409 goto out;
1410 goto open_top;
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;
1416 siosettimeout();
1417 out:
1418 crit_exit();
1419 if (!(tp->t_state & TS_ISOPEN) && com->wopeners == 0)
1420 comhardclose(com);
1421 lwkt_reltoken(&tty_token);
1422 return (error);
1425 static int
1426 sioclose(struct dev_close_args *ap)
1428 cdev_t dev = ap->a_head.a_dev;
1429 struct com_s *com;
1430 int mynor;
1431 struct tty *tp;
1433 mynor = minor(dev);
1434 if (mynor & CONTROL_MASK)
1435 return (0);
1436 lwkt_gettoken(&tty_token);
1437 com = com_addr(MINOR_TO_UNIT(mynor));
1438 if (com == NULL) {
1439 lwkt_reltoken(&tty_token);
1440 return (ENODEV);
1442 tp = com->tp;
1443 crit_enter();
1444 (*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
1445 disc_optim(tp, &tp->t_termios, com);
1446 comstop(tp, FREAD | FWRITE);
1447 comhardclose(com);
1448 ttyclose(tp);
1449 siosettimeout();
1450 crit_exit();
1451 if (com->gone) {
1452 kprintf("sio%d: gone\n", com->unit);
1453 crit_enter();
1454 if (com->ibuf != NULL)
1455 kfree(com->ibuf, M_DEVBUF);
1456 bzero(tp, sizeof *tp);
1457 crit_exit();
1459 lwkt_reltoken(&tty_token);
1460 return (0);
1463 static void
1464 comhardclose(struct com_s *com)
1466 struct tty *tp;
1467 crit_enter();
1468 lwkt_gettoken(&tty_token);
1469 com->poll = FALSE;
1470 com->poll_output = FALSE;
1471 com->do_timestamp = FALSE;
1472 com->do_dcd_timestamp = FALSE;
1473 com->pps.ppsparam.mode = 0;
1474 sio_setreg(com, com_cfcr, com->cfcr_image &= ~CFCR_SBREAK);
1475 tp = com->tp;
1477 #if defined(DDB)
1479 * Leave interrupts enabled and don't clear DTR if this is the
1480 * console. This allows us to detect break-to-debugger events
1481 * while the console device is closed.
1483 if (com->unit != comconsole ||
1484 (break_to_debugger == 0 && alt_break_to_debugger == 0))
1485 #endif
1487 sio_setreg(com, com_ier, 0);
1488 if (tp->t_cflag & HUPCL
1490 * XXX we will miss any carrier drop between here and the
1491 * next open. Perhaps we should watch DCD even when the
1492 * port is closed; it is not sufficient to check it at
1493 * the next open because it might go up and down while
1494 * we're not watching.
1496 || (!com->active_out
1497 && !(com->prev_modem_status & MSR_DCD)
1498 && !(com->it_in.c_cflag & CLOCAL))
1499 || !(tp->t_state & TS_ISOPEN)) {
1500 (void)commctl(com, TIOCM_DTR, DMBIC);
1501 if (com->dtr_wait != 0 && !(com->state & CS_DTR_OFF)) {
1502 callout_reset(&com->dtr_ch, com->dtr_wait,
1503 siodtrwakeup, com);
1504 com->state |= CS_DTR_OFF;
1508 if (com->hasfifo) {
1510 * Disable fifos so that they are off after controlled
1511 * reboots. Some BIOSes fail to detect 16550s when the
1512 * fifos are enabled.
1514 sio_setreg(com, com_fifo, 0);
1516 com->active_out = FALSE;
1517 wakeup(&com->active_out);
1518 wakeup(TSA_CARR_ON(tp)); /* restart any wopeners */
1519 lwkt_reltoken(&tty_token);
1520 crit_exit();
1523 static int
1524 sioread(struct dev_read_args *ap)
1526 cdev_t dev = ap->a_head.a_dev;
1527 int mynor, ret;
1528 struct com_s *com;
1530 lwkt_gettoken(&tty_token);
1531 mynor = minor(dev);
1532 if (mynor & CONTROL_MASK) {
1533 lwkt_reltoken(&tty_token);
1534 return (ENODEV);
1536 com = com_addr(MINOR_TO_UNIT(mynor));
1537 if (com == NULL || com->gone) {
1538 lwkt_reltoken(&tty_token);
1539 return (ENODEV);
1541 ret = ((*linesw[com->tp->t_line].l_read)(com->tp, ap->a_uio, ap->a_ioflag));
1542 lwkt_reltoken(&tty_token);
1543 return ret;
1546 static int
1547 siowrite(struct dev_write_args *ap)
1549 cdev_t dev = ap->a_head.a_dev;
1550 int mynor;
1551 struct com_s *com;
1552 int unit, ret;
1554 lwkt_gettoken(&tty_token);
1555 mynor = minor(dev);
1556 if (mynor & CONTROL_MASK) {
1557 lwkt_reltoken(&tty_token);
1558 return (ENODEV);
1561 unit = MINOR_TO_UNIT(mynor);
1562 com = com_addr(unit);
1563 if (com == NULL || com->gone) {
1564 lwkt_reltoken(&tty_token);
1565 return (ENODEV);
1568 * (XXX) We disallow virtual consoles if the physical console is
1569 * a serial port. This is in case there is a display attached that
1570 * is not the console. In that situation we don't need/want the X
1571 * server taking over the console.
1573 if (constty != NULL && unit == comconsole)
1574 constty = NULL;
1575 ret = ((*linesw[com->tp->t_line].l_write)(com->tp, ap->a_uio, ap->a_ioflag));
1576 lwkt_reltoken(&tty_token);
1577 return ret;
1580 static void
1581 siobusycheck(void *chan)
1583 struct com_s *com;
1585 lwkt_gettoken(&tty_token);
1586 com = (struct com_s *)chan;
1589 * Clear TS_BUSY if low-level output is complete.
1590 * spl locking is sufficient because siointr1() does not set CS_BUSY.
1591 * If siointr1() clears CS_BUSY after we look at it, then we'll get
1592 * called again. Reading the line status port outside of siointr1()
1593 * is safe because CS_BUSY is clear so there are no output interrupts
1594 * to lose.
1596 crit_enter();
1597 if (com->state & CS_BUSY)
1598 com->extra_state &= ~CSE_BUSYCHECK; /* False alarm. */
1599 else if ((inb(com->line_status_port) & (LSR_TSRE | LSR_TXRDY))
1600 == (LSR_TSRE | LSR_TXRDY)) {
1601 com->tp->t_state &= ~TS_BUSY;
1602 ttwwakeup(com->tp);
1603 com->extra_state &= ~CSE_BUSYCHECK;
1604 } else {
1605 callout_reset(&com->busy_ch, hz / 100, siobusycheck, com);
1607 crit_exit();
1608 lwkt_reltoken(&tty_token);
1611 static u_int
1612 siodivisor(u_long rclk, speed_t speed)
1614 long actual_speed;
1615 u_int divisor;
1616 int error;
1618 if (speed == 0 || speed > ((speed_t)-1 - 1) / 8)
1619 return (0);
1620 divisor = (rclk / (8UL * speed) + 1) / 2;
1621 if (divisor == 0 || divisor >= 65536)
1622 return (0);
1623 actual_speed = rclk / (16UL * divisor);
1625 /* 10 times error in percent: */
1626 error = ((actual_speed - (long)speed) * 2000 / (long)speed + 1) / 2;
1628 /* 3.0% maximum error tolerance: */
1629 if (error < -30 || error > 30)
1630 return (0);
1632 return (divisor);
1635 static void
1636 siodtrwakeup(void *chan)
1638 struct com_s *com;
1640 lwkt_gettoken(&tty_token);
1641 com = (struct com_s *)chan;
1642 com->state &= ~CS_DTR_OFF;
1643 wakeup(&com->dtr_wait);
1644 lwkt_reltoken(&tty_token);
1648 * NOTE: Normally called with tty_token held but might not be when
1649 * operating as the console.
1651 * Must be called with com_lock
1653 static void
1654 sioinput(struct com_s *com)
1656 u_char *buf;
1657 int incc;
1658 u_char line_status;
1659 int recv_data;
1660 struct tty *tp;
1662 buf = com->ibuf;
1663 tp = com->tp;
1664 if (!(tp->t_state & TS_ISOPEN) || !(tp->t_cflag & CREAD)) {
1665 com_events -= (com->iptr - com->ibuf);
1666 com->iptr = com->ibuf;
1667 return;
1669 if (tp->t_state & TS_CAN_BYPASS_L_RINT) {
1671 * Avoid the grotesquely inefficient lineswitch routine
1672 * (ttyinput) in "raw" mode. It usually takes about 450
1673 * instructions (that's without canonical processing or echo!).
1674 * slinput is reasonably fast (usually 40 instructions plus
1675 * call overhead).
1677 do {
1678 com_unlock();
1679 incc = com->iptr - buf;
1680 if (tp->t_rawq.c_cc + incc > tp->t_ihiwat
1681 && (com->state & CS_RTS_IFLOW
1682 || tp->t_iflag & IXOFF)
1683 && !(tp->t_state & TS_TBLOCK))
1684 ttyblock(tp);
1685 com->delta_error_counts[CE_TTY_BUF_OVERFLOW]
1686 += b_to_q((char *)buf, incc, &tp->t_rawq);
1687 buf += incc;
1688 tk_nin += incc;
1689 tk_rawcc += incc;
1690 tp->t_rawcc += incc;
1691 ttwakeup(tp);
1692 if (tp->t_state & TS_TTSTOP
1693 && (tp->t_iflag & IXANY
1694 || tp->t_cc[VSTART] == tp->t_cc[VSTOP])) {
1695 tp->t_state &= ~TS_TTSTOP;
1696 tp->t_lflag &= ~FLUSHO;
1697 comstart(tp);
1699 com_lock();
1700 } while (buf < com->iptr);
1701 } else {
1702 do {
1703 com_unlock();
1704 line_status = buf[com->ierroff];
1705 recv_data = *buf++;
1706 if (line_status
1707 & (LSR_BI | LSR_FE | LSR_OE | LSR_PE)) {
1708 if (line_status & LSR_BI)
1709 recv_data |= TTY_BI;
1710 if (line_status & LSR_FE)
1711 recv_data |= TTY_FE;
1712 if (line_status & LSR_OE)
1713 recv_data |= TTY_OE;
1714 if (line_status & LSR_PE)
1715 recv_data |= TTY_PE;
1717 (*linesw[tp->t_line].l_rint)(recv_data, tp);
1718 com_lock();
1719 } while (buf < com->iptr);
1721 com_events -= (com->iptr - com->ibuf);
1722 com->iptr = com->ibuf;
1725 * There is now room for another low-level buffer full of input,
1726 * so enable RTS if it is now disabled and there is room in the
1727 * high-level buffer.
1729 if ((com->state & CS_RTS_IFLOW) && !(com->mcr_image & MCR_RTS) &&
1730 !(tp->t_state & TS_TBLOCK))
1731 outb(com->modem_ctl_port, com->mcr_image |= MCR_RTS);
1734 void
1735 siointr(void *arg)
1737 lwkt_gettoken(&tty_token);
1738 #ifndef COM_MULTIPORT
1739 com_lock();
1740 siointr1((struct com_s *) arg);
1741 com_unlock();
1742 #else /* COM_MULTIPORT */
1743 bool_t possibly_more_intrs;
1744 int unit;
1745 struct com_s *com;
1748 * Loop until there is no activity on any port. This is necessary
1749 * to get an interrupt edge more than to avoid another interrupt.
1750 * If the IRQ signal is just an OR of the IRQ signals from several
1751 * devices, then the edge from one may be lost because another is
1752 * on.
1754 com_lock();
1755 do {
1756 possibly_more_intrs = FALSE;
1757 for (unit = 0; unit < sio_numunits; ++unit) {
1758 com = com_addr(unit);
1760 * XXX com_lock();
1761 * would it work here, or be counter-productive?
1763 if (com != NULL
1764 && !com->gone
1765 && (inb(com->int_id_port) & IIR_IMASK)
1766 != IIR_NOPEND) {
1767 siointr1(com);
1768 possibly_more_intrs = TRUE;
1770 /* XXX com_unlock(); */
1772 } while (possibly_more_intrs);
1773 com_unlock();
1774 #endif /* COM_MULTIPORT */
1775 lwkt_reltoken(&tty_token);
1779 * Called with tty_token held and com_lock held.
1781 static void
1782 siointr1(struct com_s *com)
1784 u_char line_status;
1785 u_char modem_status;
1786 u_char *ioptr;
1787 u_char recv_data;
1788 u_char int_ctl;
1789 u_char int_ctl_new;
1790 u_int count;
1792 int_ctl = inb(com->intr_ctl_port);
1793 int_ctl_new = int_ctl;
1795 while (!com->gone) {
1796 if (com->pps.ppsparam.mode & PPS_CAPTUREBOTH) {
1797 modem_status = inb(com->modem_status_port);
1798 if ((modem_status ^ com->last_modem_status) & MSR_DCD) {
1799 count = sys_cputimer->count();
1800 pps_event(&com->pps, count,
1801 (modem_status & MSR_DCD) ?
1802 PPS_CAPTUREASSERT : PPS_CAPTURECLEAR);
1805 line_status = inb(com->line_status_port);
1807 /* input event? (check first to help avoid overruns) */
1808 while (line_status & LSR_RCV_MASK) {
1809 /* break/unnattached error bits or real input? */
1810 if (!(line_status & LSR_RXRDY))
1811 recv_data = 0;
1812 else
1813 recv_data = inb(com->data_port);
1814 #if defined(DDB)
1816 * Solaris implements a new BREAK which is initiated
1817 * by a character sequence CR ~ ^b which is similar
1818 * to a familiar pattern used on Sun servers by the
1819 * Remote Console.
1821 #define KEY_CRTLB 2 /* ^B */
1822 #define KEY_CR 13 /* CR '\r' */
1823 #define KEY_TILDE 126 /* ~ */
1825 if (com->unit == comconsole && alt_break_to_debugger) {
1826 static int brk_state1 = 0, brk_state2 = 0;
1827 if (recv_data == KEY_CR) {
1828 brk_state1 = recv_data;
1829 brk_state2 = 0;
1830 } else if (brk_state1 == KEY_CR && (recv_data == KEY_TILDE || recv_data == KEY_CRTLB)) {
1831 if (recv_data == KEY_TILDE)
1832 brk_state2 = recv_data;
1833 else if (brk_state2 == KEY_TILDE && recv_data == KEY_CRTLB) {
1834 com_unlock();
1835 breakpoint();
1836 com_lock();
1837 brk_state1 = brk_state2 = 0;
1838 goto cont;
1839 } else
1840 brk_state2 = 0;
1841 } else
1842 brk_state1 = 0;
1844 #endif
1845 if (line_status & (LSR_BI | LSR_FE | LSR_PE)) {
1847 * Don't store BI if IGNBRK or FE/PE if IGNPAR.
1848 * Otherwise, push the work to a higher level
1849 * (to handle PARMRK) if we're bypassing.
1850 * Otherwise, convert BI/FE and PE+INPCK to 0.
1852 * This makes bypassing work right in the
1853 * usual "raw" case (IGNBRK set, and IGNPAR
1854 * and INPCK clear).
1856 * Note: BI together with FE/PE means just BI.
1858 if (line_status & LSR_BI) {
1859 #if defined(DDB)
1860 if (com->unit == comconsole &&
1861 break_to_debugger) {
1862 com_unlock();
1863 breakpoint();
1864 com_lock();
1865 goto cont;
1867 #endif
1868 if (com->tp == NULL
1869 || com->tp->t_iflag & IGNBRK)
1870 goto cont;
1871 } else {
1872 if (com->tp == NULL
1873 || com->tp->t_iflag & IGNPAR)
1874 goto cont;
1876 if (com->tp->t_state & TS_CAN_BYPASS_L_RINT
1877 && (line_status & (LSR_BI | LSR_FE)
1878 || com->tp->t_iflag & INPCK))
1879 recv_data = 0;
1881 ++com->bytes_in;
1882 if (com->hotchar != 0 && recv_data == com->hotchar)
1883 setsofttty();
1884 ioptr = com->iptr;
1885 if (ioptr >= com->ibufend)
1886 CE_RECORD(com, CE_INTERRUPT_BUF_OVERFLOW);
1887 else {
1888 if (com->do_timestamp)
1889 microtime(&com->timestamp);
1890 ++com_events;
1891 schedsofttty();
1892 #if 0 /* for testing input latency vs efficiency */
1893 if (com->iptr - com->ibuf == 8)
1894 setsofttty();
1895 #endif
1896 ioptr[0] = recv_data;
1897 ioptr[com->ierroff] = line_status;
1898 com->iptr = ++ioptr;
1899 if (ioptr == com->ihighwater
1900 && com->state & CS_RTS_IFLOW)
1901 outb(com->modem_ctl_port,
1902 com->mcr_image &= ~MCR_RTS);
1903 if (line_status & LSR_OE)
1904 CE_RECORD(com, CE_OVERRUN);
1906 cont:
1908 * "& 0x7F" is to avoid the gcc-1.40 generating a slow
1909 * jump from the top of the loop to here
1911 line_status = inb(com->line_status_port) & 0x7F;
1914 /* modem status change? (always check before doing output) */
1915 modem_status = inb(com->modem_status_port);
1916 if (modem_status != com->last_modem_status) {
1917 if (com->do_dcd_timestamp
1918 && !(com->last_modem_status & MSR_DCD)
1919 && modem_status & MSR_DCD)
1920 microtime(&com->dcd_timestamp);
1923 * Schedule high level to handle DCD changes. Note
1924 * that we don't use the delta bits anywhere. Some
1925 * UARTs mess them up, and it's easy to remember the
1926 * previous bits and calculate the delta.
1928 com->last_modem_status = modem_status;
1929 if (!(com->state & CS_CHECKMSR)) {
1930 com_events += LOTS_OF_EVENTS;
1931 com->state |= CS_CHECKMSR;
1932 setsofttty();
1935 /* handle CTS change immediately for crisp flow ctl */
1936 if (com->state & CS_CTS_OFLOW) {
1937 if (modem_status & MSR_CTS)
1938 com->state |= CS_ODEVREADY;
1939 else
1940 com->state &= ~CS_ODEVREADY;
1944 /* output queued and everything ready? */
1945 if (line_status & LSR_TXRDY
1946 && com->state >= (CS_BUSY | CS_TTGO | CS_ODEVREADY)) {
1947 ioptr = com->obufq.l_head;
1948 if (com->tx_fifo_size > 1) {
1949 u_int ocount;
1951 ocount = com->obufq.l_tail - ioptr;
1952 if (ocount > com->tx_fifo_size)
1953 ocount = com->tx_fifo_size;
1954 com->bytes_out += ocount;
1956 outb(com->data_port, *ioptr++);
1957 while (--ocount != 0);
1958 } else {
1959 outb(com->data_port, *ioptr++);
1960 ++com->bytes_out;
1962 com->obufq.l_head = ioptr;
1963 if (COM_IIR_TXRDYBUG(com->flags)) {
1964 int_ctl_new = int_ctl | IER_ETXRDY;
1966 if (ioptr >= com->obufq.l_tail) {
1967 struct lbq *qp;
1969 qp = com->obufq.l_next;
1970 qp->l_queued = FALSE;
1971 qp = qp->l_next;
1972 if (qp != NULL) {
1973 com->obufq.l_head = qp->l_head;
1974 com->obufq.l_tail = qp->l_tail;
1975 com->obufq.l_next = qp;
1976 } else {
1977 /* output just completed */
1978 if (COM_IIR_TXRDYBUG(com->flags)) {
1979 int_ctl_new = int_ctl & ~IER_ETXRDY;
1981 com->state &= ~CS_BUSY;
1983 if (!(com->state & CS_ODONE)) {
1984 com_events += LOTS_OF_EVENTS;
1985 com->state |= CS_ODONE;
1986 setsofttty(); /* handle at high level ASAP */
1989 if (COM_IIR_TXRDYBUG(com->flags) && (int_ctl != int_ctl_new)) {
1990 outb(com->intr_ctl_port, int_ctl_new);
1994 /* finished? */
1995 #ifndef COM_MULTIPORT
1996 if ((inb(com->int_id_port) & IIR_IMASK) == IIR_NOPEND)
1997 #endif /* COM_MULTIPORT */
1999 return;
2004 static int
2005 sioioctl(struct dev_ioctl_args *ap)
2007 cdev_t dev = ap->a_head.a_dev;
2008 caddr_t data = ap->a_data;
2009 struct com_s *com;
2010 int error;
2011 int mynor;
2012 struct tty *tp;
2013 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
2014 u_long oldcmd;
2015 struct termios term;
2016 #endif
2017 lwkt_gettoken(&tty_token);
2018 mynor = minor(dev);
2020 com = com_addr(MINOR_TO_UNIT(mynor));
2021 if (com == NULL || com->gone) {
2022 lwkt_reltoken(&tty_token);
2023 return (ENODEV);
2025 if (mynor & CONTROL_MASK) {
2026 struct termios *ct;
2028 switch (mynor & CONTROL_MASK) {
2029 case CONTROL_INIT_STATE:
2030 ct = mynor & CALLOUT_MASK ? &com->it_out : &com->it_in;
2031 break;
2032 case CONTROL_LOCK_STATE:
2033 ct = mynor & CALLOUT_MASK ? &com->lt_out : &com->lt_in;
2034 break;
2035 default:
2036 lwkt_reltoken(&tty_token);
2037 return (ENODEV); /* /dev/nodev */
2039 switch (ap->a_cmd) {
2040 case TIOCSETA:
2041 error = priv_check_cred(ap->a_cred, PRIV_ROOT, 0);
2042 if (error != 0)
2043 return (error);
2044 *ct = *(struct termios *)data;
2045 lwkt_reltoken(&tty_token);
2046 return (0);
2047 case TIOCGETA:
2048 *(struct termios *)data = *ct;
2049 lwkt_reltoken(&tty_token);
2050 return (0);
2051 case TIOCGETD:
2052 *(int *)data = TTYDISC;
2053 lwkt_reltoken(&tty_token);
2054 return (0);
2055 case TIOCGWINSZ:
2056 bzero(data, sizeof(struct winsize));
2057 lwkt_reltoken(&tty_token);
2058 return (0);
2059 default:
2060 lwkt_reltoken(&tty_token);
2061 return (ENOTTY);
2064 tp = com->tp;
2065 #if defined(COMPAT_43) || defined(COMPAT_SUNOS)
2066 term = tp->t_termios;
2067 oldcmd = ap->a_cmd;
2068 error = ttsetcompat(tp, &ap->a_cmd, data, &term);
2069 if (error != 0) {
2070 lwkt_reltoken(&tty_token);
2071 return (error);
2073 if (ap->a_cmd != oldcmd)
2074 data = (caddr_t)&term;
2075 #endif
2076 if (ap->a_cmd == TIOCSETA || ap->a_cmd == TIOCSETAW ||
2077 ap->a_cmd == TIOCSETAF) {
2078 int cc;
2079 struct termios *dt = (struct termios *)data;
2080 struct termios *lt = mynor & CALLOUT_MASK
2081 ? &com->lt_out : &com->lt_in;
2083 dt->c_iflag = (tp->t_iflag & lt->c_iflag)
2084 | (dt->c_iflag & ~lt->c_iflag);
2085 dt->c_oflag = (tp->t_oflag & lt->c_oflag)
2086 | (dt->c_oflag & ~lt->c_oflag);
2087 dt->c_cflag = (tp->t_cflag & lt->c_cflag)
2088 | (dt->c_cflag & ~lt->c_cflag);
2089 dt->c_lflag = (tp->t_lflag & lt->c_lflag)
2090 | (dt->c_lflag & ~lt->c_lflag);
2091 for (cc = 0; cc < NCCS; ++cc)
2092 if (lt->c_cc[cc] != 0)
2093 dt->c_cc[cc] = tp->t_cc[cc];
2094 if (lt->c_ispeed != 0)
2095 dt->c_ispeed = tp->t_ispeed;
2096 if (lt->c_ospeed != 0)
2097 dt->c_ospeed = tp->t_ospeed;
2099 error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, data, ap->a_fflag, ap->a_cred);
2100 if (error != ENOIOCTL) {
2101 lwkt_reltoken(&tty_token);
2102 return (error);
2104 crit_enter();
2105 error = ttioctl(tp, ap->a_cmd, data, ap->a_fflag);
2106 disc_optim(tp, &tp->t_termios, com);
2107 if (error != ENOIOCTL) {
2108 crit_exit();
2109 lwkt_reltoken(&tty_token);
2110 return (error);
2112 switch (ap->a_cmd) {
2113 case TIOCSBRK:
2114 sio_setreg(com, com_cfcr, com->cfcr_image |= CFCR_SBREAK);
2115 break;
2116 case TIOCCBRK:
2117 sio_setreg(com, com_cfcr, com->cfcr_image &= ~CFCR_SBREAK);
2118 break;
2119 case TIOCSDTR:
2120 (void)commctl(com, TIOCM_DTR, DMBIS);
2121 break;
2122 case TIOCCDTR:
2123 (void)commctl(com, TIOCM_DTR, DMBIC);
2124 break;
2126 * XXX should disallow changing MCR_RTS if CS_RTS_IFLOW is set. The
2127 * changes get undone on the next call to comparam().
2129 case TIOCMSET:
2130 (void)commctl(com, *(int *)data, DMSET);
2131 break;
2132 case TIOCMBIS:
2133 (void)commctl(com, *(int *)data, DMBIS);
2134 break;
2135 case TIOCMBIC:
2136 (void)commctl(com, *(int *)data, DMBIC);
2137 break;
2138 case TIOCMGET:
2139 *(int *)data = commctl(com, 0, DMGET);
2140 break;
2141 case TIOCMSDTRWAIT:
2142 /* must be root since the wait applies to following logins */
2143 error = priv_check_cred(ap->a_cred, PRIV_ROOT, 0);
2144 if (error != 0) {
2145 crit_exit();
2146 lwkt_reltoken(&tty_token);
2147 return (error);
2149 com->dtr_wait = *(int *)data * hz / 100;
2150 break;
2151 case TIOCMGDTRWAIT:
2152 *(int *)data = com->dtr_wait * 100 / hz;
2153 break;
2154 case TIOCTIMESTAMP:
2155 com->do_timestamp = TRUE;
2156 *(struct timeval *)data = com->timestamp;
2157 break;
2158 case TIOCDCDTIMESTAMP:
2159 com->do_dcd_timestamp = TRUE;
2160 *(struct timeval *)data = com->dcd_timestamp;
2161 break;
2162 default:
2163 crit_exit();
2164 error = pps_ioctl(ap->a_cmd, data, &com->pps);
2165 if (error == ENODEV)
2166 error = ENOTTY;
2167 lwkt_reltoken(&tty_token);
2168 return (error);
2170 crit_exit();
2171 lwkt_reltoken(&tty_token);
2172 return (0);
2175 static void
2176 siopoll(void *dummy, void *frame)
2178 int unit;
2180 lwkt_gettoken(&tty_token);
2181 if (com_events == 0) {
2182 lwkt_reltoken(&tty_token);
2183 return;
2186 repeat:
2187 for (unit = 0; unit < sio_numunits; ++unit) {
2188 struct com_s *com;
2189 int incc;
2190 struct tty *tp;
2192 com = com_addr(unit);
2193 if (com == NULL)
2194 continue;
2195 tp = com->tp;
2196 if (tp == NULL || com->gone) {
2198 * Discard any events related to never-opened or
2199 * going-away devices.
2201 com_lock();
2202 incc = com->iptr - com->ibuf;
2203 com->iptr = com->ibuf;
2204 if (com->state & CS_CHECKMSR) {
2205 incc += LOTS_OF_EVENTS;
2206 com->state &= ~CS_CHECKMSR;
2208 com_events -= incc;
2209 com_unlock();
2210 continue;
2212 if (com->iptr != com->ibuf) {
2213 com_lock();
2214 sioinput(com);
2215 com_unlock();
2217 if (com->state & CS_CHECKMSR) {
2218 u_char delta_modem_status;
2220 com_lock();
2221 delta_modem_status = com->last_modem_status
2222 ^ com->prev_modem_status;
2223 com->prev_modem_status = com->last_modem_status;
2224 com_events -= LOTS_OF_EVENTS;
2225 com->state &= ~CS_CHECKMSR;
2226 com_unlock();
2227 if (delta_modem_status & MSR_DCD)
2228 (*linesw[tp->t_line].l_modem)
2229 (tp, com->prev_modem_status & MSR_DCD);
2231 if (com->state & CS_ODONE) {
2232 com_lock();
2233 com_events -= LOTS_OF_EVENTS;
2234 com->state &= ~CS_ODONE;
2235 com_unlock();
2236 if (!(com->state & CS_BUSY)
2237 && !(com->extra_state & CSE_BUSYCHECK)) {
2238 callout_reset(&com->busy_ch, hz / 100,
2239 siobusycheck, com);
2240 com->extra_state |= CSE_BUSYCHECK;
2242 (*linesw[tp->t_line].l_start)(tp);
2244 if (com_events == 0)
2245 break;
2247 if (com_events >= LOTS_OF_EVENTS)
2248 goto repeat;
2249 lwkt_reltoken(&tty_token);
2253 * Called with tty_token held but no com_lock
2255 static int
2256 comparam(struct tty *tp, struct termios *t)
2258 u_int cfcr;
2259 int cflag;
2260 struct com_s *com;
2261 u_int divisor;
2262 u_char dlbh;
2263 u_char dlbl;
2264 int unit;
2266 unit = DEV_TO_UNIT(tp->t_dev);
2267 com = com_addr(unit);
2268 if (com == NULL) {
2269 return (ENODEV);
2272 /* do historical conversions */
2273 if (t->c_ispeed == 0)
2274 t->c_ispeed = t->c_ospeed;
2276 /* check requested parameters */
2277 if (t->c_ospeed == 0)
2278 divisor = 0;
2279 else {
2280 if (t->c_ispeed != t->c_ospeed)
2281 return (EINVAL);
2282 divisor = siodivisor(com->rclk, t->c_ispeed);
2283 if (divisor == 0)
2284 return (EINVAL);
2287 /* parameters are OK, convert them to the com struct and the device */
2288 crit_enter();
2289 if (divisor == 0)
2290 (void)commctl(com, TIOCM_DTR, DMBIC); /* hang up line */
2291 else
2292 (void)commctl(com, TIOCM_DTR, DMBIS);
2293 cflag = t->c_cflag;
2294 switch (cflag & CSIZE) {
2295 case CS5:
2296 cfcr = CFCR_5BITS;
2297 break;
2298 case CS6:
2299 cfcr = CFCR_6BITS;
2300 break;
2301 case CS7:
2302 cfcr = CFCR_7BITS;
2303 break;
2304 default:
2305 cfcr = CFCR_8BITS;
2306 break;
2308 if (cflag & PARENB) {
2309 cfcr |= CFCR_PENAB;
2310 if (!(cflag & PARODD))
2311 cfcr |= CFCR_PEVEN;
2313 if (cflag & CSTOPB)
2314 cfcr |= CFCR_STOPB;
2316 if (com->hasfifo && divisor != 0) {
2318 * Use a fifo trigger level low enough so that the input
2319 * latency from the fifo is less than about 16 msec and
2320 * the total latency is less than about 30 msec. These
2321 * latencies are reasonable for humans. Serial comms
2322 * protocols shouldn't expect anything better since modem
2323 * latencies are larger.
2325 * Interrupts can be held up for long periods of time
2326 * due to inefficiencies in other parts of the kernel,
2327 * certain video cards, etc. Setting the FIFO trigger
2328 * point to MEDH instead of HIGH gives us 694uS of slop
2329 * (8 character times) instead of 173uS (2 character times)
2330 * @ 115200 bps.
2332 com->fifo_image = t->c_ospeed <= 4800
2333 ? FIFO_ENABLE : FIFO_ENABLE | FIFO_RX_MEDH;
2334 #ifdef COM_ESP
2336 * The Hayes ESP card needs the fifo DMA mode bit set
2337 * in compatibility mode. If not, it will interrupt
2338 * for each character received.
2340 if (com->esp)
2341 com->fifo_image |= FIFO_DMA_MODE;
2342 #endif
2343 sio_setreg(com, com_fifo, com->fifo_image);
2347 * This returns with interrupts disabled so that we can complete
2348 * the speed change atomically. Keeping interrupts disabled is
2349 * especially important while com_data is hidden.
2351 (void) siosetwater(com, t->c_ispeed);
2353 if (divisor != 0) {
2354 sio_setreg(com, com_cfcr, cfcr | CFCR_DLAB);
2356 * Only set the divisor registers if they would change,
2357 * since on some 16550 incompatibles (UMC8669F), setting
2358 * them while input is arriving them loses sync until
2359 * data stops arriving.
2361 dlbl = divisor & 0xFF;
2362 if (sio_getreg(com, com_dlbl) != dlbl)
2363 sio_setreg(com, com_dlbl, dlbl);
2364 dlbh = divisor >> 8;
2365 if (sio_getreg(com, com_dlbh) != dlbh)
2366 sio_setreg(com, com_dlbh, dlbh);
2369 sio_setreg(com, com_cfcr, com->cfcr_image = cfcr);
2371 if (!(tp->t_state & TS_TTSTOP))
2372 com->state |= CS_TTGO;
2374 if (cflag & CRTS_IFLOW) {
2375 if (com->st16650a) {
2376 sio_setreg(com, com_cfcr, 0xbf);
2377 sio_setreg(com, com_fifo,
2378 sio_getreg(com, com_fifo) | 0x40);
2380 com->state |= CS_RTS_IFLOW;
2382 * If CS_RTS_IFLOW just changed from off to on, the change
2383 * needs to be propagated to MCR_RTS. This isn't urgent,
2384 * so do it later by calling comstart() instead of repeating
2385 * a lot of code from comstart() here.
2387 } else if (com->state & CS_RTS_IFLOW) {
2388 com->state &= ~CS_RTS_IFLOW;
2390 * CS_RTS_IFLOW just changed from on to off. Force MCR_RTS
2391 * on here, since comstart() won't do it later.
2393 outb(com->modem_ctl_port, com->mcr_image |= MCR_RTS);
2394 if (com->st16650a) {
2395 sio_setreg(com, com_cfcr, 0xbf);
2396 sio_setreg(com, com_fifo,
2397 sio_getreg(com, com_fifo) & ~0x40);
2403 * Set up state to handle output flow control.
2404 * XXX - worth handling MDMBUF (DCD) flow control at the lowest level?
2405 * Now has 10+ msec latency, while CTS flow has 50- usec latency.
2407 com->state |= CS_ODEVREADY;
2408 com->state &= ~CS_CTS_OFLOW;
2409 if (cflag & CCTS_OFLOW) {
2410 com->state |= CS_CTS_OFLOW;
2411 if (!(com->last_modem_status & MSR_CTS))
2412 com->state &= ~CS_ODEVREADY;
2413 if (com->st16650a) {
2414 sio_setreg(com, com_cfcr, 0xbf);
2415 sio_setreg(com, com_fifo,
2416 sio_getreg(com, com_fifo) | 0x80);
2418 } else {
2419 if (com->st16650a) {
2420 sio_setreg(com, com_cfcr, 0xbf);
2421 sio_setreg(com, com_fifo,
2422 sio_getreg(com, com_fifo) & ~0x80);
2426 sio_setreg(com, com_cfcr, com->cfcr_image);
2428 /* XXX shouldn't call functions while intrs are disabled. */
2429 disc_optim(tp, t, com);
2431 * Recover from fiddling with CS_TTGO. We used to call siointr1()
2432 * unconditionally, but that defeated the careful discarding of
2433 * stale input in sioopen().
2435 if (com->state >= (CS_BUSY | CS_TTGO)) {
2436 com_lock();
2437 siointr1(com);
2438 com_unlock();
2440 crit_exit();
2441 comstart(tp);
2442 if (com->ibufold != NULL) {
2443 kfree(com->ibufold, M_DEVBUF);
2444 com->ibufold = NULL;
2446 return (0);
2450 * called with tty_token held
2452 static int
2453 siosetwater(struct com_s *com, speed_t speed)
2455 int cp4ticks;
2456 u_char *ibuf;
2457 int ibufsize;
2458 struct tty *tp;
2461 * Make the buffer size large enough to handle a softtty interrupt
2462 * latency of about 2 ticks without loss of throughput or data
2463 * (about 3 ticks if input flow control is not used or not honoured,
2464 * but a bit less for CS5-CS7 modes).
2466 cp4ticks = speed / 10 / hz * 4;
2467 for (ibufsize = 128; ibufsize < cp4ticks;)
2468 ibufsize <<= 1;
2469 if (ibufsize == com->ibufsize)
2470 return (0);
2473 * Allocate input buffer. The extra factor of 2 in the size is
2474 * to allow for an error byte for each input byte.
2476 ibuf = kmalloc(2 * ibufsize, M_DEVBUF, M_WAITOK | M_ZERO);
2478 /* Initialize non-critical variables. */
2479 com->ibufold = com->ibuf;
2480 com->ibufsize = ibufsize;
2481 tp = com->tp;
2482 if (tp != NULL) {
2483 tp->t_ififosize = 2 * ibufsize;
2484 tp->t_ispeedwat = (speed_t)-1;
2485 tp->t_ospeedwat = (speed_t)-1;
2489 * Read current input buffer.
2491 com_lock();
2492 if (com->iptr != com->ibuf)
2493 sioinput(com);
2496 * Initialize critical variables, including input buffer watermarks.
2497 * The external device is asked to stop sending when the buffer
2498 * exactly reaches high water, or when the high level requests it.
2499 * The high level is notified immediately (rather than at a later
2500 * clock tick) when this watermark is reached.
2501 * The buffer size is chosen so the watermark should almost never
2502 * be reached.
2503 * The low watermark is invisibly 0 since the buffer is always
2504 * emptied all at once.
2506 com->iptr = com->ibuf = ibuf;
2507 com->ibufend = ibuf + ibufsize;
2508 com->ierroff = ibufsize;
2509 com->ihighwater = ibuf + 3 * ibufsize / 4;
2510 com_unlock();
2511 return (0);
2514 static void
2515 comstart(struct tty *tp)
2517 struct com_s *com;
2518 int unit;
2520 lwkt_gettoken(&tty_token);
2521 unit = DEV_TO_UNIT(tp->t_dev);
2522 com = com_addr(unit);
2523 if (com == NULL) {
2524 lwkt_reltoken(&tty_token);
2525 return;
2527 crit_enter();
2528 com_lock();
2529 if (tp->t_state & TS_TTSTOP)
2530 com->state &= ~CS_TTGO;
2531 else
2532 com->state |= CS_TTGO;
2533 if (tp->t_state & TS_TBLOCK) {
2534 if (com->mcr_image & MCR_RTS && com->state & CS_RTS_IFLOW)
2535 outb(com->modem_ctl_port, com->mcr_image &= ~MCR_RTS);
2536 } else {
2537 if (!(com->mcr_image & MCR_RTS) && com->iptr < com->ihighwater
2538 && com->state & CS_RTS_IFLOW)
2539 outb(com->modem_ctl_port, com->mcr_image |= MCR_RTS);
2541 com_unlock();
2542 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
2543 ttwwakeup(tp);
2544 crit_exit();
2545 lwkt_reltoken(&tty_token);
2546 return;
2548 if (tp->t_outq.c_cc != 0) {
2549 struct lbq *qp;
2550 struct lbq *next;
2552 if (!com->obufs[0].l_queued) {
2553 com->obufs[0].l_tail
2554 = com->obuf1 + q_to_b(&tp->t_outq, com->obuf1,
2555 sizeof com->obuf1);
2556 com->obufs[0].l_next = NULL;
2557 com->obufs[0].l_queued = TRUE;
2558 com_lock();
2559 if (com->state & CS_BUSY) {
2560 qp = com->obufq.l_next;
2561 while ((next = qp->l_next) != NULL)
2562 qp = next;
2563 qp->l_next = &com->obufs[0];
2564 } else {
2565 com->obufq.l_head = com->obufs[0].l_head;
2566 com->obufq.l_tail = com->obufs[0].l_tail;
2567 com->obufq.l_next = &com->obufs[0];
2568 com->state |= CS_BUSY;
2570 com_unlock();
2572 if (tp->t_outq.c_cc != 0 && !com->obufs[1].l_queued) {
2573 com->obufs[1].l_tail
2574 = com->obuf2 + q_to_b(&tp->t_outq, com->obuf2,
2575 sizeof com->obuf2);
2576 com->obufs[1].l_next = NULL;
2577 com->obufs[1].l_queued = TRUE;
2578 com_lock();
2579 if (com->state & CS_BUSY) {
2580 qp = com->obufq.l_next;
2581 while ((next = qp->l_next) != NULL)
2582 qp = next;
2583 qp->l_next = &com->obufs[1];
2584 } else {
2585 com->obufq.l_head = com->obufs[1].l_head;
2586 com->obufq.l_tail = com->obufs[1].l_tail;
2587 com->obufq.l_next = &com->obufs[1];
2588 com->state |= CS_BUSY;
2590 com_unlock();
2592 tp->t_state |= TS_BUSY;
2594 com_lock();
2595 if (com->state >= (CS_BUSY | CS_TTGO))
2596 siointr1(com); /* fake interrupt to start output */
2597 com_unlock();
2598 ttwwakeup(tp);
2599 crit_exit();
2600 lwkt_reltoken(&tty_token);
2603 static void
2604 comstop(struct tty *tp, int rw)
2606 struct com_s *com;
2608 lwkt_gettoken(&tty_token);
2609 com = com_addr(DEV_TO_UNIT(tp->t_dev));
2610 if (com == NULL || com->gone) {
2611 lwkt_reltoken(&tty_token);
2612 return;
2614 com_lock();
2615 if (rw & FWRITE) {
2616 if (com->hasfifo)
2617 #ifdef COM_ESP
2618 /* XXX avoid h/w bug. */
2619 if (!com->esp)
2620 #endif
2621 sio_setreg(com, com_fifo,
2622 FIFO_XMT_RST | com->fifo_image);
2623 com->obufs[0].l_queued = FALSE;
2624 com->obufs[1].l_queued = FALSE;
2625 if (com->state & CS_ODONE)
2626 com_events -= LOTS_OF_EVENTS;
2627 com->state &= ~(CS_ODONE | CS_BUSY);
2628 com->tp->t_state &= ~TS_BUSY;
2630 if (rw & FREAD) {
2631 if (com->hasfifo)
2632 #ifdef COM_ESP
2633 /* XXX avoid h/w bug. */
2634 if (!com->esp)
2635 #endif
2636 sio_setreg(com, com_fifo,
2637 FIFO_RCV_RST | com->fifo_image);
2638 com_events -= (com->iptr - com->ibuf);
2639 com->iptr = com->ibuf;
2641 com_unlock();
2642 comstart(tp);
2643 lwkt_reltoken(&tty_token);
2646 static int
2647 commctl(struct com_s *com, int bits, int how)
2649 int mcr;
2650 int msr;
2652 lwkt_gettoken(&tty_token);
2653 if (how == DMGET) {
2654 bits = TIOCM_LE; /* XXX - always enabled while open */
2655 mcr = com->mcr_image;
2656 if (mcr & MCR_DTR)
2657 bits |= TIOCM_DTR;
2658 if (mcr & MCR_RTS)
2659 bits |= TIOCM_RTS;
2660 msr = com->prev_modem_status;
2661 if (msr & MSR_CTS)
2662 bits |= TIOCM_CTS;
2663 if (msr & MSR_DCD)
2664 bits |= TIOCM_CD;
2665 if (msr & MSR_DSR)
2666 bits |= TIOCM_DSR;
2668 * XXX - MSR_RI is naturally volatile, and we make MSR_TERI
2669 * more volatile by reading the modem status a lot. Perhaps
2670 * we should latch both bits until the status is read here.
2672 if (msr & (MSR_RI | MSR_TERI))
2673 bits |= TIOCM_RI;
2674 lwkt_reltoken(&tty_token);
2675 return (bits);
2677 mcr = 0;
2678 if (bits & TIOCM_DTR)
2679 mcr |= MCR_DTR;
2680 if (bits & TIOCM_RTS)
2681 mcr |= MCR_RTS;
2682 if (com->gone) {
2683 lwkt_reltoken(&tty_token);
2684 return(0);
2686 com_lock();
2687 switch (how) {
2688 case DMSET:
2689 outb(com->modem_ctl_port,
2690 com->mcr_image = mcr | (com->mcr_image & MCR_IENABLE));
2691 break;
2692 case DMBIS:
2693 outb(com->modem_ctl_port, com->mcr_image |= mcr);
2694 break;
2695 case DMBIC:
2696 outb(com->modem_ctl_port, com->mcr_image &= ~mcr);
2697 break;
2699 com_unlock();
2700 lwkt_reltoken(&tty_token);
2701 return (0);
2705 * NOTE: Must be called with tty_token held
2707 static void
2708 siosettimeout(void)
2710 struct com_s *com;
2711 bool_t someopen;
2712 int unit;
2714 ASSERT_LWKT_TOKEN_HELD(&tty_token);
2716 * Set our timeout period to 1 second if no polled devices are open.
2717 * Otherwise set it to max(1/200, 1/hz).
2718 * Enable timeouts iff some device is open.
2720 callout_stop(&sio_timeout_handle);
2721 sio_timeout = hz;
2722 someopen = FALSE;
2723 for (unit = 0; unit < sio_numunits; ++unit) {
2724 com = com_addr(unit);
2725 if (com != NULL && com->tp != NULL
2726 && com->tp->t_state & TS_ISOPEN && !com->gone) {
2727 someopen = TRUE;
2728 if (com->poll || com->poll_output) {
2729 sio_timeout = hz > 200 ? hz / 200 : 1;
2730 break;
2734 if (someopen) {
2735 sio_timeouts_until_log = hz / sio_timeout;
2736 callout_reset(&sio_timeout_handle, sio_timeout,
2737 comwakeup, NULL);
2738 } else {
2739 /* Flush error messages, if any. */
2740 sio_timeouts_until_log = 1;
2741 comwakeup(NULL);
2742 callout_stop(&sio_timeout_handle);
2747 * NOTE: Must be called with tty_token held
2749 static void
2750 comwakeup(void *chan)
2752 struct com_s *com;
2753 int unit;
2756 * Can be called from a callout too so just get the token
2758 lwkt_gettoken(&tty_token);
2759 callout_reset(&sio_timeout_handle, sio_timeout, comwakeup, NULL);
2762 * Recover from lost output interrupts.
2763 * Poll any lines that don't use interrupts.
2765 for (unit = 0; unit < sio_numunits; ++unit) {
2766 com = com_addr(unit);
2767 if (com != NULL && !com->gone
2768 && (com->state >= (CS_BUSY | CS_TTGO) || com->poll)) {
2769 com_lock();
2770 siointr1(com);
2771 com_unlock();
2776 * Check for and log errors, but not too often.
2778 if (--sio_timeouts_until_log > 0) {
2779 lwkt_reltoken(&tty_token);
2780 return;
2782 sio_timeouts_until_log = hz / sio_timeout;
2783 for (unit = 0; unit < sio_numunits; ++unit) {
2784 int errnum;
2786 com = com_addr(unit);
2787 if (com == NULL)
2788 continue;
2789 if (com->gone)
2790 continue;
2791 for (errnum = 0; errnum < CE_NTYPES; ++errnum) {
2792 u_int delta;
2793 u_long total;
2795 com_lock();
2796 delta = com->delta_error_counts[errnum];
2797 com->delta_error_counts[errnum] = 0;
2798 com_unlock();
2799 if (delta == 0)
2800 continue;
2801 total = com->error_counts[errnum] += delta;
2802 log(LOG_ERR, "sio%d: %u more %s%s (total %lu)\n",
2803 unit, delta, error_desc[errnum],
2804 delta == 1 ? "" : "s", total);
2807 lwkt_reltoken(&tty_token);
2810 static void
2811 disc_optim(struct tty *tp, struct termios *t, struct com_s *com)
2813 lwkt_gettoken(&tty_token);
2814 if (!(t->c_iflag & (ICRNL | IGNCR | IMAXBEL | INLCR | ISTRIP | IXON))
2815 && (!(t->c_iflag & BRKINT) || (t->c_iflag & IGNBRK))
2816 && (!(t->c_iflag & PARMRK)
2817 || (t->c_iflag & (IGNPAR | IGNBRK)) == (IGNPAR | IGNBRK))
2818 && !(t->c_lflag & (ECHO | ICANON | IEXTEN | ISIG | PENDIN))
2819 && linesw[tp->t_line].l_rint == ttyinput)
2820 tp->t_state |= TS_CAN_BYPASS_L_RINT;
2821 else
2822 tp->t_state &= ~TS_CAN_BYPASS_L_RINT;
2823 com->hotchar = linesw[tp->t_line].l_hotchar;
2824 lwkt_reltoken(&tty_token);
2828 * Following are all routines needed for SIO to act as console
2830 #include <sys/cons.h>
2832 struct siocnstate {
2833 u_char dlbl;
2834 u_char dlbh;
2835 u_char ier;
2836 u_char cfcr;
2837 u_char mcr;
2840 static speed_t siocngetspeed (Port_t, u_long rclk);
2841 #if 0
2842 static void siocnclose (struct siocnstate *sp, Port_t iobase);
2843 #endif
2844 static void siocnopen (struct siocnstate *sp, Port_t iobase, int speed);
2845 static void siocntxwait (Port_t iobase);
2847 static cn_probe_t siocnprobe;
2848 static cn_init_t siocninit;
2849 static cn_init_fini_t siocninit_fini;
2850 static cn_checkc_t siocncheckc;
2851 static cn_getc_t siocngetc;
2852 static cn_putc_t siocnputc;
2854 #if defined(__i386__) || defined(__x86_64__)
2855 CONS_DRIVER(sio, siocnprobe, siocninit, siocninit_fini,
2856 NULL, siocngetc, siocncheckc, siocnputc, NULL);
2857 #endif
2859 /* To get the GDB related variables */
2860 #if DDB > 0
2861 #include <ddb/ddb.h>
2862 #endif
2864 static void
2865 siocntxwait(Port_t iobase)
2867 int timo;
2870 * Wait for any pending transmission to finish. Required to avoid
2871 * the UART lockup bug when the speed is changed, and for normal
2872 * transmits.
2874 timo = 100000;
2875 while ((inb(iobase + com_lsr) & (LSR_TSRE | LSR_TXRDY))
2876 != (LSR_TSRE | LSR_TXRDY) && --timo != 0)
2881 * Read the serial port specified and try to figure out what speed
2882 * it's currently running at. We're assuming the serial port has
2883 * been initialized and is basicly idle. This routine is only intended
2884 * to be run at system startup.
2886 * If the value read from the serial port doesn't make sense, return 0.
2889 * NOTE: Must be called with tty_token held
2891 static speed_t
2892 siocngetspeed(Port_t iobase, u_long rclk)
2894 u_int divisor;
2895 u_char dlbh;
2896 u_char dlbl;
2897 u_char cfcr;
2899 cfcr = inb(iobase + com_cfcr);
2900 outb(iobase + com_cfcr, CFCR_DLAB | cfcr);
2902 dlbl = inb(iobase + com_dlbl);
2903 dlbh = inb(iobase + com_dlbh);
2905 outb(iobase + com_cfcr, cfcr);
2907 divisor = dlbh << 8 | dlbl;
2909 /* XXX there should be more sanity checking. */
2910 if (divisor == 0)
2911 return (CONSPEED);
2912 return (rclk / (16UL * divisor));
2915 static void
2916 siocnopen(struct siocnstate *sp, Port_t iobase, int speed)
2918 u_int divisor;
2919 u_char dlbh;
2920 u_char dlbl;
2923 * Save all the device control registers except the fifo register
2924 * and set our default ones (cs8 -parenb speed=comdefaultrate).
2925 * We can't save the fifo register since it is read-only.
2927 sp->ier = inb(iobase + com_ier);
2928 outb(iobase + com_ier, 0); /* spltty() doesn't stop siointr() */
2929 siocntxwait(iobase);
2930 sp->cfcr = inb(iobase + com_cfcr);
2931 outb(iobase + com_cfcr, CFCR_DLAB | CFCR_8BITS);
2932 sp->dlbl = inb(iobase + com_dlbl);
2933 sp->dlbh = inb(iobase + com_dlbh);
2935 * Only set the divisor registers if they would change, since on
2936 * some 16550 incompatibles (Startech), setting them clears the
2937 * data input register. This also reduces the effects of the
2938 * UMC8669F bug.
2940 divisor = siodivisor(comdefaultrclk, speed);
2941 dlbl = divisor & 0xFF;
2942 if (sp->dlbl != dlbl)
2943 outb(iobase + com_dlbl, dlbl);
2944 dlbh = divisor >> 8;
2945 if (sp->dlbh != dlbh)
2946 outb(iobase + com_dlbh, dlbh);
2947 outb(iobase + com_cfcr, CFCR_8BITS);
2948 sp->mcr = inb(iobase + com_mcr);
2950 * We don't want interrupts, but must be careful not to "disable"
2951 * them by clearing the MCR_IENABLE bit, since that might cause
2952 * an interrupt by floating the IRQ line.
2954 outb(iobase + com_mcr, (sp->mcr & MCR_IENABLE) | MCR_DTR | MCR_RTS);
2957 #if 0
2958 static void
2959 siocnclose(struct siocnstate *sp, Port_t iobase)
2962 * Restore the device control registers.
2964 siocntxwait(iobase);
2965 outb(iobase + com_cfcr, CFCR_DLAB | CFCR_8BITS);
2966 if (sp->dlbl != inb(iobase + com_dlbl))
2967 outb(iobase + com_dlbl, sp->dlbl);
2968 if (sp->dlbh != inb(iobase + com_dlbh))
2969 outb(iobase + com_dlbh, sp->dlbh);
2970 outb(iobase + com_cfcr, sp->cfcr);
2972 * XXX damp oscillations of MCR_DTR and MCR_RTS by not restoring them.
2974 outb(iobase + com_mcr, sp->mcr | MCR_DTR | MCR_RTS);
2975 outb(iobase + com_ier, sp->ier);
2977 #endif
2979 static void
2980 siocnprobe(struct consdev *cp)
2982 speed_t boot_speed;
2983 u_char cfcr;
2984 u_int divisor;
2985 int unit;
2986 struct siocnstate sp;
2989 * Find our first enabled console, if any. If it is a high-level
2990 * console device, then initialize it and return successfully.
2991 * If it is a low-level console device, then initialize it and
2992 * return unsuccessfully. It must be initialized in both cases
2993 * for early use by console drivers and debuggers. Initializing
2994 * the hardware is not necessary in all cases, since the i/o
2995 * routines initialize it on the fly, but it is necessary if
2996 * input might arrive while the hardware is switched back to an
2997 * uninitialized state. We can't handle multiple console devices
2998 * yet because our low-level routines don't take a device arg.
2999 * We trust the user to set the console flags properly so that we
3000 * don't need to probe.
3002 cp->cn_pri = CN_DEAD;
3004 for (unit = 0; unit < 16; unit++) { /* XXX need to know how many */
3005 int flags;
3006 int disabled;
3007 if (resource_int_value("sio", unit, "disabled", &disabled) == 0) {
3008 if (disabled)
3009 continue;
3011 if (resource_int_value("sio", unit, "flags", &flags))
3012 continue;
3013 if (COM_CONSOLE(flags) || COM_DEBUGGER(flags)) {
3014 int port;
3015 Port_t iobase;
3017 if (resource_int_value("sio", unit, "port", &port))
3018 continue;
3019 iobase = port;
3020 crit_enter();
3021 if (boothowto & RB_SERIAL) {
3022 boot_speed =
3023 siocngetspeed(iobase, comdefaultrclk);
3024 if (boot_speed)
3025 comdefaultrate = boot_speed;
3029 * Initialize the divisor latch. We can't rely on
3030 * siocnopen() to do this the first time, since it
3031 * avoids writing to the latch if the latch appears
3032 * to have the correct value. Also, if we didn't
3033 * just read the speed from the hardware, then we
3034 * need to set the speed in hardware so that
3035 * switching it later is null.
3037 com_lock();
3038 cfcr = inb(iobase + com_cfcr);
3039 outb(iobase + com_cfcr, CFCR_DLAB | cfcr);
3040 divisor = siodivisor(comdefaultrclk, comdefaultrate);
3041 outb(iobase + com_dlbl, divisor & 0xff);
3042 outb(iobase + com_dlbh, divisor >> 8);
3043 outb(iobase + com_cfcr, cfcr);
3045 siocnopen(&sp, iobase, comdefaultrate);
3046 com_unlock();
3048 crit_exit();
3049 if (COM_CONSOLE(flags) && !COM_LLCONSOLE(flags)) {
3050 cp->cn_probegood = 1;
3051 cp->cn_private = (void *)(intptr_t)unit;
3052 cp->cn_pri = COM_FORCECONSOLE(flags)
3053 || boothowto & RB_SERIAL
3054 ? CN_REMOTE : CN_NORMAL;
3055 siocniobase = iobase;
3056 siocnunit = unit;
3058 if (COM_DEBUGGER(flags) && gdb_tab == NULL) {
3059 kprintf("sio%d: gdb debugging port\n", unit);
3060 siogdbiobase = iobase;
3061 siogdbunit = unit;
3062 #if DDB > 0
3063 cp->cn_gdbprivate = (void *)(intptr_t)unit;
3064 gdb_tab = cp;
3065 #endif
3069 #if defined(__i386__) || defined(__x86_64__)
3070 #if DDB > 0
3072 * XXX Ugly Compatability.
3073 * If no gdb port has been specified, set it to be the console
3074 * as some configuration files don't specify the gdb port.
3076 if (gdb_tab == NULL && (boothowto & RB_GDB)) {
3077 kprintf("Warning: no GDB port specified. Defaulting to sio%d.\n",
3078 siocnunit);
3079 kprintf("Set flag 0x80 on desired GDB port in your\n");
3080 kprintf("configuration file (currently sio only).\n");
3081 siogdbiobase = siocniobase;
3082 siogdbunit = siocnunit;
3083 cp->cn_gdbprivate = (void *)(intptr_t)siocnunit;
3084 gdb_tab = cp;
3086 #endif
3087 #endif
3090 static void
3091 siocninit(struct consdev *cp)
3093 comconsole = (int)(intptr_t)cp->cn_private;
3096 static void
3097 siocninit_fini(struct consdev *cp)
3099 cdev_t dev;
3100 int unit;
3102 if (cp->cn_probegood) {
3103 unit = (int)(intptr_t)cp->cn_private;
3105 * Call devfs_find_device_by_name on ttydX to find the correct device,
3106 * as it should have been created already at this point by the
3107 * attach routine.
3108 * If it isn't found, the serial port was not attached at all and we
3109 * shouldn't be here, so assert this case.
3111 dev = devfs_find_device_by_name("ttyd%r", unit);
3113 KKASSERT(dev != NULL);
3114 cp->cn_dev = dev;
3118 static int
3119 siocncheckc(void *private)
3121 int c;
3122 int unit = (int)(intptr_t)private;
3123 Port_t iobase;
3124 #if 0
3125 struct siocnstate sp;
3126 #endif
3128 if (unit == siogdbunit)
3129 iobase = siogdbiobase;
3130 else
3131 iobase = siocniobase;
3132 com_lock();
3133 crit_enter();
3134 #if 0
3135 siocnopen(&sp, iobase, comdefaultrate);
3136 #endif
3137 if (inb(iobase + com_lsr) & LSR_RXRDY)
3138 c = inb(iobase + com_data);
3139 else
3140 c = -1;
3141 #if 0
3142 siocnclose(&sp, iobase);
3143 #endif
3144 crit_exit();
3145 com_unlock();
3146 return (c);
3151 siocngetc(void *private)
3153 int c;
3154 int unit = (int)(intptr_t)private;
3155 Port_t iobase;
3156 #if 0
3157 struct siocnstate sp;
3158 #endif
3160 if (unit == siogdbunit)
3161 iobase = siogdbiobase;
3162 else
3163 iobase = siocniobase;
3164 com_lock();
3165 crit_enter();
3166 #if 0
3167 siocnopen(&sp, iobase, comdefaultrate);
3168 #endif
3169 while (!(inb(iobase + com_lsr) & LSR_RXRDY))
3171 c = inb(iobase + com_data);
3172 #if 0
3173 siocnclose(&sp, iobase);
3174 #endif
3175 crit_exit();
3176 com_unlock();
3177 return (c);
3180 void
3181 siocnputc(void *private, int c)
3183 int unit = (int)(intptr_t)private;
3184 #if 0
3185 struct siocnstate sp;
3186 #endif
3187 Port_t iobase;
3189 if (unit == siogdbunit)
3190 iobase = siogdbiobase;
3191 else
3192 iobase = siocniobase;
3193 com_lock();
3194 crit_enter();
3195 #if 0
3196 siocnopen(&sp, iobase, comdefaultrate);
3197 #endif
3198 siocntxwait(iobase);
3199 outb(iobase + com_data, c);
3200 #if 0
3201 siocnclose(&sp, iobase);
3202 #endif
3203 crit_exit();
3204 com_unlock();
3207 DRIVER_MODULE(sio, isa, sio_isa_driver, sio_devclass, NULL, NULL);
3208 DRIVER_MODULE(sio, acpi, sio_isa_driver, sio_devclass, NULL, NULL);
3209 #if NPCI > 0
3210 DRIVER_MODULE(sio, pci, sio_pci_driver, sio_devclass, NULL, NULL);
3211 #endif
3212 #if NPUC > 0
3213 DRIVER_MODULE(sio, puc, sio_puc_driver, sio_devclass, NULL, NULL);
3214 #endif