4 * Copyright (C) 2003,2004
5 * Hidetoshi Shimokawa. All rights reserved.
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:
18 * This product includes software developed by Hidetoshi Shimokawa.
20 * 4. Neither the name of the author nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * $FreeBSD: src/sys/dev/dcons/dcons_os.c,v 1.4 2004/10/24 12:41:04 simokawa Exp $
39 #include <sys/param.h>
40 #if __FreeBSD_version >= 502122
44 #include <sys/kernel.h>
45 #include <sys/module.h>
46 #include <sys/systm.h>
47 #include <sys/types.h>
50 #include <sys/consio.h>
52 #include <sys/malloc.h>
55 #include <sys/thread2.h>
56 #include <sys/ucred.h>
63 #include <sys/reboot.h>
65 #include <sys/sysctl.h>
68 #include <vm/vm_param.h>
72 #include "opt_comconsole.h"
73 #include "opt_dcons.h"
76 #define DCONS_POLL_HZ 100
79 #ifndef DCONS_BUF_SIZE
80 #define DCONS_BUF_SIZE (16*1024)
83 #ifndef DCONS_FORCE_CONSOLE
84 #define DCONS_FORCE_CONSOLE 0 /* Mostly for FreeBSD-4/DragonFly */
87 #ifndef DCONS_FORCE_GDB
88 #define DCONS_FORCE_GDB 1
91 static d_open_t dcons_open;
92 static d_close_t dcons_close;
93 static d_ioctl_t dcons_ioctl;
95 static struct dev_ops dcons_ops = {
96 { "dcons", 0, D_TTY },
98 .d_close = dcons_close,
101 .d_ioctl = dcons_ioctl,
102 .d_kqfilter = ttykqfilter,
103 .d_revoke = ttyrevoke
107 static char bssbuf[DCONS_BUF_SIZE]; /* buf in bss */
111 static struct dcons_global dg;
112 struct dcons_global *dcons_conf;
113 static int poll_hz = DCONS_POLL_HZ;
115 static struct dcons_softc sc[DCONS_NPORT];
117 SYSCTL_NODE(_kern, OID_AUTO, dcons, CTLFLAG_RD, 0, "Dumb Console");
118 SYSCTL_INT(_kern_dcons, OID_AUTO, poll_hz, CTLFLAG_RW, &poll_hz, 0,
119 "dcons polling rate");
121 static int drv_init = 0;
122 static struct callout dcons_callout;
123 struct dcons_buf *dcons_buf; /* for local dconschat */
127 #define THREAD d_thread_t
128 #elif __FreeBSD_version < 500000
130 #define THREAD struct proc
132 #define DEV struct cdev *
133 #define THREAD struct thread
137 static void dcons_tty_start(struct tty *);
138 static int dcons_tty_param(struct tty *, struct termios *);
139 static void dcons_timeout(void *);
140 static int dcons_drv_init(int);
142 static cn_probe_t dcons_cnprobe;
143 static cn_init_t dcons_cninit;
144 static cn_init_fini_t dcons_cninit_fini;
145 static cn_getc_t dcons_cngetc;
146 static cn_checkc_t dcons_cncheckc;
147 static cn_putc_t dcons_cnputc;
149 CONS_DRIVER(dcons, dcons_cnprobe, dcons_cninit, dcons_cninit_fini,
150 NULL, dcons_cngetc, dcons_cncheckc, dcons_cnputc, NULL);
152 #if __FreeBSD_version >= 502122
153 static gdb_probe_f dcons_dbg_probe;
154 static gdb_init_f dcons_dbg_init;
155 static gdb_term_f dcons_dbg_term;
156 static gdb_getc_f dcons_dbg_getc;
157 static gdb_checkc_f dcons_dbg_checkc;
158 static gdb_putc_f dcons_dbg_putc;
160 GDB_DBGPORT(dcons, dcons_dbg_probe, dcons_dbg_init, dcons_dbg_term,
161 dcons_dbg_checkc, dcons_dbg_getc, dcons_dbg_putc);
163 extern struct gdb_dbgport *gdb_cur;
166 #if (KDB || DDB) && ALT_BREAK_TO_DEBUGGER
168 dcons_check_break(struct dcons_softc *dc, int c)
173 lwkt_gettoken(&tty_token);
174 #if __FreeBSD_version >= 502122
175 if (kdb_alt_break(c, &dc->brk_state)) {
176 if ((dc->flags & DC_GDB) != 0) {
177 if (gdb_cur == &dcons_gdb_dbgport) {
178 kdb_dbbe_select("gdb");
185 switch (dc->brk_state) {
188 dc->brk_state = STATE2;
190 dc->brk_state = STATE0;
193 dc->brk_state = STATE0;
194 if (c == KEY_CTRLB) {
196 if (dc->flags & DC_GDB)
203 dc->brk_state = STATE1;
205 lwkt_reltoken(&tty_token);
209 #define dcons_check_break(dc, c) (c)
213 dcons_os_checkc(struct dcons_softc *dc)
217 lwkt_gettoken(&tty_token);
218 if (dg.dma_tag != NULL)
219 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
221 c = dcons_check_break(dc, dcons_checkc(dc));
223 if (dg.dma_tag != NULL)
224 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
226 lwkt_reltoken(&tty_token);
231 dcons_os_getc(struct dcons_softc *dc)
235 while ((c = dcons_os_checkc(dc)) == -1);
241 dcons_os_putc(struct dcons_softc *dc, int c)
243 if (dg.dma_tag != NULL)
244 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
248 if (dg.dma_tag != NULL)
249 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
252 dcons_open(struct dev_open_args *ap)
254 cdev_t dev = ap->a_head.a_dev;
262 lwkt_gettoken(&tty_token);
263 tp = dev->si_tty = ttymalloc(dev->si_tty);
264 tp->t_oproc = dcons_tty_start;
265 tp->t_param = dcons_tty_param;
266 tp->t_stop = nottystop;
272 if ((tp->t_state & TS_ISOPEN) == 0) {
273 tp->t_state |= TS_CARR_ON;
275 tp->t_iflag = TTYDEF_IFLAG;
276 tp->t_oflag = TTYDEF_OFLAG;
277 tp->t_cflag = TTYDEF_CFLAG|CLOCAL;
278 tp->t_lflag = TTYDEF_LFLAG;
279 tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
281 } else if ((tp->t_state & TS_XCLUDE) && priv_check_cred(ap->a_cred, PRIV_ROOT, 0)) {
283 lwkt_reltoken(&tty_token);
288 #if __FreeBSD_version < 502113
289 error = (*linesw[tp->t_line].l_open)(dev, tp);
291 error = ttyld_open(tp, dev);
293 lwkt_reltoken(&tty_token);
298 dcons_close(struct dev_close_args *ap)
300 cdev_t dev = ap->a_head.a_dev;
308 lwkt_gettoken(&tty_token);
310 if (tp->t_state & TS_ISOPEN) {
311 (*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
314 lwkt_reltoken(&tty_token);
320 dcons_ioctl(struct dev_ioctl_args *ap)
322 cdev_t dev = ap->a_head.a_dev;
331 lwkt_gettoken(&tty_token);
333 error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data, ap->a_fflag, ap->a_cred);
334 if (error != ENOIOCTL) {
335 lwkt_reltoken(&tty_token);
339 error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
340 if (error != ENOIOCTL) {
341 lwkt_reltoken(&tty_token);
345 lwkt_reltoken(&tty_token);
350 dcons_tty_param(struct tty *tp, struct termios *t)
352 lwkt_gettoken(&tty_token);
353 tp->t_ispeed = t->c_ispeed;
354 tp->t_ospeed = t->c_ospeed;
355 tp->t_cflag = t->c_cflag;
356 lwkt_reltoken(&tty_token);
361 dcons_tty_start(struct tty *tp)
363 struct dcons_softc *dc;
365 lwkt_gettoken(&tty_token);
366 dc = (struct dcons_softc *)tp->t_dev->si_drv1;
368 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
370 lwkt_reltoken(&tty_token);
374 tp->t_state |= TS_BUSY;
375 while (tp->t_outq.c_cc != 0)
376 dcons_os_putc(dc, clist_getc(&tp->t_outq));
377 tp->t_state &= ~TS_BUSY;
381 lwkt_reltoken(&tty_token);
385 dcons_timeout(void *v)
388 struct dcons_softc *dc;
391 lwkt_gettoken(&tty_token);
392 for (i = 0; i < DCONS_NPORT; i ++) {
394 tp = ((DEV)dc->dev)->si_tty;
395 while ((c = dcons_os_checkc(dc)) != -1)
396 if (tp->t_state & TS_ISOPEN)
397 #if __FreeBSD_version < 502113
398 (*linesw[tp->t_line].l_rint)(c, tp);
403 polltime = hz / poll_hz;
406 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
407 lwkt_reltoken(&tty_token);
411 dcons_cnprobe(struct consdev *cp)
414 cp->cn_probegood = 1;
415 #elif __FreeBSD_version >= 501109
416 ksprintf(cp->cn_name, "dcons");
418 cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
420 #if DCONS_FORCE_CONSOLE
421 cp->cn_pri = CN_REMOTE;
423 cp->cn_pri = CN_NORMAL;
428 dcons_cninit(struct consdev *cp)
436 = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
440 dcons_cninit_fini(struct consdev *cp)
442 cp->cn_dev = make_dev(&dcons_ops, DCONS_CON,
443 UID_ROOT, GID_WHEEL, 0600, "dcons");
448 dcons_cngetc(struct consdev *cp)
450 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
451 return (dcons_os_getc(dc));
454 dcons_cncheckc(struct consdev *cp)
456 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
457 return (dcons_os_checkc(dc));
460 dcons_cnputc(struct consdev *cp, int c)
462 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
463 dcons_os_putc(dc, c);
467 dcons_cngetc(void *private)
469 struct dcons_softc *dc = (struct dcons_softc *)private;
470 return (dcons_os_getc(dc));
473 dcons_cncheckc(void *private)
475 struct dcons_softc *dc = (struct dcons_softc *)private;
476 return (dcons_os_checkc(dc));
479 dcons_cnputc(void *private, int c)
481 struct dcons_softc *dc = (struct dcons_softc *)private;
482 dcons_os_putc(dc, c);
487 dcons_drv_init(int stage)
498 bzero(&dg, sizeof(dg));
500 dg.cdev = &dcons_consdev;
502 dg.size = DCONS_BUF_SIZE;
505 if (kgetenv_quad("dcons.addr", &addr) > 0 &&
506 kgetenv_quad("dcons.size", &size) > 0) {
509 * Allow read/write access to dcons buffer.
511 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
512 pmap_kmodify_rw((vm_offset_t)(KERNBASE + pa));
515 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
517 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
525 if (stage == 0) { /* XXX or cold */
527 * DCONS_FORCE_CONSOLE == 1 and statically linked.
528 * called from cninit(). can't use contigmalloc yet .
530 dg.buf = (struct dcons_buf *) bssbuf;
531 dcons_init(dg.buf, dg.size, sc);
536 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
537 * if the module is loaded after boot,
538 * bssbuf could be non-continuous.
540 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
541 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
542 dcons_init(dg.buf, dg.size, sc);
548 #if DDB && DCONS_FORCE_GDB
549 if (gdb_tab == NULL) {
550 gdb_tab = &dcons_consdev;
551 dcons_consdev.cn_gdbprivate = &sc[DCONS_GDB];
560 * NOTE: Must be called with tty_token held
563 dcons_attach_port(int port, char *name, int flags)
565 struct dcons_softc *dc;
569 ASSERT_LWKT_TOKEN_HELD(&tty_token);
572 dev = make_dev(&dcons_ops, port,
573 UID_ROOT, GID_WHEEL, 0600, name);
574 dc->dev = (void *)dev;
575 tp = ttymalloc(NULL);
577 dev->si_drv1 = (void *)dc;
580 tp->t_oproc = dcons_tty_start;
581 tp->t_param = dcons_tty_param;
582 tp->t_stop = nottystop;
589 * NOTE: Must be called with tty_token held
596 ASSERT_LWKT_TOKEN_HELD(&tty_token);
597 dcons_attach_port(DCONS_CON, "dcons", 0);
598 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
599 #if __FreeBSD_version < 500000
600 callout_init_mp(&dcons_callout);
602 callout_init(&dcons_callout, 0);
604 polltime = hz / poll_hz;
607 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
612 * NOTE: Must be called with tty_token held
615 dcons_detach(int port)
618 struct dcons_softc *dc;
620 ASSERT_LWKT_TOKEN_HELD(&tty_token);
623 tp = ((DEV)dc->dev)->si_tty;
625 if (tp->t_state & TS_ISOPEN) {
626 kprintf("dcons: still opened\n");
627 #if __FreeBSD_version < 502113
628 (*linesw[tp->t_line].l_close)(tp, 0);
636 * must wait until all device are closed.
639 tsleep((void *)dc, 0, "dcodtc", hz/4);
641 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
643 destroy_dev(dc->dev);
649 /* cnXXX works only for FreeBSD-5 */
651 dcons_modevent(module_t mode, int type, void *data)
655 lwkt_gettoken(&tty_token);
658 ret = dcons_drv_init(1);
660 #if __FreeBSD_version >= 500000
662 dcons_cnprobe(&dcons_consdev);
663 dcons_cninit(&dcons_consdev);
664 cnadd(&dcons_consdev);
669 kprintf("dcons: unload\n");
670 callout_stop(&dcons_callout);
671 #if __FreeBSD_version < 502122
672 #if DDB && DCONS_FORCE_GDB
676 if (gdb_tab == &dcons_consdev)
681 #if __FreeBSD_version >= 500000
682 cnremove(&dcons_consdev);
684 dcons_detach(DCONS_CON);
685 dcons_detach(DCONS_GDB);
688 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
698 lwkt_reltoken(&tty_token);
702 #if __FreeBSD_version >= 502122
703 /* Debugger interface */
706 dcons_dbg_probe(void)
708 return(DCONS_FORCE_GDB);
722 dcons_dbg_putc(int c)
724 struct dcons_softc *dc = &sc[DCONS_GDB];
725 dcons_os_putc(dc, c);
729 dcons_dbg_checkc(void)
731 struct dcons_softc *dc = &sc[DCONS_GDB];
732 return (dcons_os_checkc(dc));
738 struct dcons_softc *dc = &sc[DCONS_GDB];
739 return (dcons_os_getc(dc));
743 DEV_MODULE(dcons, dcons_modevent, NULL);
744 MODULE_VERSION(dcons, DCONS_VERSION);