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 $
37 * $DragonFly: src/sys/dev/misc/dcons/dcons_os.c,v 1.13 2007/08/07 13:14:11 hasso Exp $
40 #include <sys/param.h>
41 #if __FreeBSD_version >= 502122
45 #include <sys/kernel.h>
46 #include <sys/module.h>
47 #include <sys/systm.h>
48 #include <sys/types.h>
51 #include <sys/consio.h>
53 #include <sys/malloc.h>
56 #include <sys/thread2.h>
57 #include <sys/ucred.h>
64 #include <sys/reboot.h>
66 #include <sys/sysctl.h>
69 #include <vm/vm_param.h>
73 #include "opt_comconsole.h"
74 #include "opt_dcons.h"
77 #define DCONS_POLL_HZ 100
80 #ifndef DCONS_BUF_SIZE
81 #define DCONS_BUF_SIZE (16*1024)
84 #ifndef DCONS_FORCE_CONSOLE
85 #define DCONS_FORCE_CONSOLE 0 /* Mostly for FreeBSD-4/DragonFly */
88 #ifndef DCONS_FORCE_GDB
89 #define DCONS_FORCE_GDB 1
92 #define CDEV_MAJOR 184
94 static d_open_t dcons_open;
95 static d_close_t dcons_close;
96 static d_ioctl_t dcons_ioctl;
98 static struct dev_ops dcons_ops = {
99 { "dcons", CDEV_MAJOR, D_TTY },
100 .d_open = dcons_open,
101 .d_close = dcons_close,
104 .d_ioctl = dcons_ioctl,
105 .d_kqfilter = ttykqfilter,
106 .d_revoke = ttyrevoke
110 static char bssbuf[DCONS_BUF_SIZE]; /* buf in bss */
114 static struct dcons_global dg;
115 struct dcons_global *dcons_conf;
116 static int poll_hz = DCONS_POLL_HZ;
118 static struct dcons_softc sc[DCONS_NPORT];
120 SYSCTL_NODE(_kern, OID_AUTO, dcons, CTLFLAG_RD, 0, "Dumb Console");
121 SYSCTL_INT(_kern_dcons, OID_AUTO, poll_hz, CTLFLAG_RW, &poll_hz, 0,
122 "dcons polling rate");
124 static int drv_init = 0;
125 static struct callout dcons_callout;
126 struct dcons_buf *dcons_buf; /* for local dconschat */
130 #define THREAD d_thread_t
131 #elif __FreeBSD_version < 500000
133 #define THREAD struct proc
135 #define DEV struct cdev *
136 #define THREAD struct thread
140 static void dcons_tty_start(struct tty *);
141 static int dcons_tty_param(struct tty *, struct termios *);
142 static void dcons_timeout(void *);
143 static int dcons_drv_init(int);
145 static cn_probe_t dcons_cnprobe;
146 static cn_init_t dcons_cninit;
147 static cn_init_fini_t dcons_cninit_fini;
148 static cn_getc_t dcons_cngetc;
149 static cn_checkc_t dcons_cncheckc;
150 static cn_putc_t dcons_cnputc;
152 CONS_DRIVER(dcons, dcons_cnprobe, dcons_cninit, dcons_cninit_fini,
153 NULL, dcons_cngetc, dcons_cncheckc, dcons_cnputc, NULL);
155 #if __FreeBSD_version >= 502122
156 static gdb_probe_f dcons_dbg_probe;
157 static gdb_init_f dcons_dbg_init;
158 static gdb_term_f dcons_dbg_term;
159 static gdb_getc_f dcons_dbg_getc;
160 static gdb_checkc_f dcons_dbg_checkc;
161 static gdb_putc_f dcons_dbg_putc;
163 GDB_DBGPORT(dcons, dcons_dbg_probe, dcons_dbg_init, dcons_dbg_term,
164 dcons_dbg_checkc, dcons_dbg_getc, dcons_dbg_putc);
166 extern struct gdb_dbgport *gdb_cur;
169 #if (KDB || DDB) && ALT_BREAK_TO_DEBUGGER
171 dcons_check_break(struct dcons_softc *dc, int c)
176 lwkt_gettoken(&tty_token);
177 #if __FreeBSD_version >= 502122
178 if (kdb_alt_break(c, &dc->brk_state)) {
179 if ((dc->flags & DC_GDB) != 0) {
180 if (gdb_cur == &dcons_gdb_dbgport) {
181 kdb_dbbe_select("gdb");
188 switch (dc->brk_state) {
191 dc->brk_state = STATE2;
193 dc->brk_state = STATE0;
196 dc->brk_state = STATE0;
197 if (c == KEY_CTRLB) {
199 if (dc->flags & DC_GDB)
206 dc->brk_state = STATE1;
208 lwkt_reltoken(&tty_token);
212 #define dcons_check_break(dc, c) (c)
216 dcons_os_checkc(struct dcons_softc *dc)
220 lwkt_gettoken(&tty_token);
221 if (dg.dma_tag != NULL)
222 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
224 c = dcons_check_break(dc, dcons_checkc(dc));
226 if (dg.dma_tag != NULL)
227 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
229 lwkt_reltoken(&tty_token);
234 dcons_os_getc(struct dcons_softc *dc)
238 while ((c = dcons_os_checkc(dc)) == -1);
244 dcons_os_putc(struct dcons_softc *dc, int c)
246 if (dg.dma_tag != NULL)
247 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
251 if (dg.dma_tag != NULL)
252 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
255 dcons_open(struct dev_open_args *ap)
257 cdev_t dev = ap->a_head.a_dev;
265 lwkt_gettoken(&tty_token);
266 tp = dev->si_tty = ttymalloc(dev->si_tty);
267 tp->t_oproc = dcons_tty_start;
268 tp->t_param = dcons_tty_param;
269 tp->t_stop = nottystop;
275 if ((tp->t_state & TS_ISOPEN) == 0) {
276 tp->t_state |= TS_CARR_ON;
278 tp->t_iflag = TTYDEF_IFLAG;
279 tp->t_oflag = TTYDEF_OFLAG;
280 tp->t_cflag = TTYDEF_CFLAG|CLOCAL;
281 tp->t_lflag = TTYDEF_LFLAG;
282 tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
284 } else if ((tp->t_state & TS_XCLUDE) && priv_check_cred(ap->a_cred, PRIV_ROOT, 0)) {
286 lwkt_reltoken(&tty_token);
291 #if __FreeBSD_version < 502113
292 error = (*linesw[tp->t_line].l_open)(dev, tp);
294 error = ttyld_open(tp, dev);
296 lwkt_reltoken(&tty_token);
301 dcons_close(struct dev_close_args *ap)
303 cdev_t dev = ap->a_head.a_dev;
311 lwkt_gettoken(&tty_token);
313 if (tp->t_state & TS_ISOPEN) {
314 (*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
317 lwkt_reltoken(&tty_token);
323 dcons_ioctl(struct dev_ioctl_args *ap)
325 cdev_t dev = ap->a_head.a_dev;
334 lwkt_gettoken(&tty_token);
336 error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data, ap->a_fflag, ap->a_cred);
337 if (error != ENOIOCTL) {
338 lwkt_reltoken(&tty_token);
342 error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
343 if (error != ENOIOCTL) {
344 lwkt_reltoken(&tty_token);
348 lwkt_reltoken(&tty_token);
353 dcons_tty_param(struct tty *tp, struct termios *t)
355 lwkt_gettoken(&tty_token);
356 tp->t_ispeed = t->c_ispeed;
357 tp->t_ospeed = t->c_ospeed;
358 tp->t_cflag = t->c_cflag;
359 lwkt_reltoken(&tty_token);
364 dcons_tty_start(struct tty *tp)
366 struct dcons_softc *dc;
368 lwkt_gettoken(&tty_token);
369 dc = (struct dcons_softc *)tp->t_dev->si_drv1;
371 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
373 lwkt_reltoken(&tty_token);
377 tp->t_state |= TS_BUSY;
378 while (tp->t_outq.c_cc != 0)
379 dcons_os_putc(dc, clist_getc(&tp->t_outq));
380 tp->t_state &= ~TS_BUSY;
384 lwkt_reltoken(&tty_token);
388 dcons_timeout(void *v)
391 struct dcons_softc *dc;
394 lwkt_gettoken(&tty_token);
395 for (i = 0; i < DCONS_NPORT; i ++) {
397 tp = ((DEV)dc->dev)->si_tty;
398 while ((c = dcons_os_checkc(dc)) != -1)
399 if (tp->t_state & TS_ISOPEN)
400 #if __FreeBSD_version < 502113
401 (*linesw[tp->t_line].l_rint)(c, tp);
406 polltime = hz / poll_hz;
409 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
410 lwkt_reltoken(&tty_token);
414 dcons_cnprobe(struct consdev *cp)
417 cp->cn_probegood = 1;
418 #elif __FreeBSD_version >= 501109
419 ksprintf(cp->cn_name, "dcons");
421 cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
423 #if DCONS_FORCE_CONSOLE
424 cp->cn_pri = CN_REMOTE;
426 cp->cn_pri = CN_NORMAL;
431 dcons_cninit(struct consdev *cp)
439 = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
443 dcons_cninit_fini(struct consdev *cp)
445 cp->cn_dev = make_dev(&dcons_ops, DCONS_CON,
446 UID_ROOT, GID_WHEEL, 0600, "dcons");
451 dcons_cngetc(struct consdev *cp)
453 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
454 return (dcons_os_getc(dc));
457 dcons_cncheckc(struct consdev *cp)
459 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
460 return (dcons_os_checkc(dc));
463 dcons_cnputc(struct consdev *cp, int c)
465 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
466 dcons_os_putc(dc, c);
470 dcons_cngetc(void *private)
472 struct dcons_softc *dc = (struct dcons_softc *)private;
473 return (dcons_os_getc(dc));
476 dcons_cncheckc(void *private)
478 struct dcons_softc *dc = (struct dcons_softc *)private;
479 return (dcons_os_checkc(dc));
482 dcons_cnputc(void *private, int c)
484 struct dcons_softc *dc = (struct dcons_softc *)private;
485 dcons_os_putc(dc, c);
490 dcons_drv_init(int stage)
501 bzero(&dg, sizeof(dg));
503 dg.cdev = &dcons_consdev;
505 dg.size = DCONS_BUF_SIZE;
508 if (kgetenv_quad("dcons.addr", &addr) > 0 &&
509 kgetenv_quad("dcons.size", &size) > 0) {
512 * Allow read/write access to dcons buffer.
514 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
515 pmap_kmodify_rw((vm_offset_t)(KERNBASE + pa));
518 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
520 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
528 if (stage == 0) { /* XXX or cold */
530 * DCONS_FORCE_CONSOLE == 1 and statically linked.
531 * called from cninit(). can't use contigmalloc yet .
533 dg.buf = (struct dcons_buf *) bssbuf;
534 dcons_init(dg.buf, dg.size, sc);
539 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
540 * if the module is loaded after boot,
541 * bssbuf could be non-continuous.
543 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
544 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
545 dcons_init(dg.buf, dg.size, sc);
551 #if DDB && DCONS_FORCE_GDB
552 if (gdb_tab == NULL) {
553 gdb_tab = &dcons_consdev;
554 dcons_consdev.cn_gdbprivate = &sc[DCONS_GDB];
563 * NOTE: Must be called with tty_token held
566 dcons_attach_port(int port, char *name, int flags)
568 struct dcons_softc *dc;
572 ASSERT_LWKT_TOKEN_HELD(&tty_token);
575 dev = make_dev(&dcons_ops, port,
576 UID_ROOT, GID_WHEEL, 0600, name);
577 dc->dev = (void *)dev;
578 tp = ttymalloc(NULL);
580 dev->si_drv1 = (void *)dc;
583 tp->t_oproc = dcons_tty_start;
584 tp->t_param = dcons_tty_param;
585 tp->t_stop = nottystop;
592 * NOTE: Must be called with tty_token held
599 ASSERT_LWKT_TOKEN_HELD(&tty_token);
600 dcons_attach_port(DCONS_CON, "dcons", 0);
601 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
602 #if __FreeBSD_version < 500000
603 callout_init_mp(&dcons_callout);
605 callout_init(&dcons_callout, 0);
607 polltime = hz / poll_hz;
610 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
615 * NOTE: Must be called with tty_token held
618 dcons_detach(int port)
621 struct dcons_softc *dc;
623 ASSERT_LWKT_TOKEN_HELD(&tty_token);
626 tp = ((DEV)dc->dev)->si_tty;
628 if (tp->t_state & TS_ISOPEN) {
629 kprintf("dcons: still opened\n");
630 #if __FreeBSD_version < 502113
631 (*linesw[tp->t_line].l_close)(tp, 0);
639 * must wait until all device are closed.
642 tsleep((void *)dc, 0, "dcodtc", hz/4);
644 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
646 destroy_dev(dc->dev);
652 /* cnXXX works only for FreeBSD-5 */
654 dcons_modevent(module_t mode, int type, void *data)
658 lwkt_gettoken(&tty_token);
661 ret = dcons_drv_init(1);
663 #if __FreeBSD_version >= 500000
665 dcons_cnprobe(&dcons_consdev);
666 dcons_cninit(&dcons_consdev);
667 cnadd(&dcons_consdev);
672 kprintf("dcons: unload\n");
673 callout_stop(&dcons_callout);
674 #if __FreeBSD_version < 502122
675 #if DDB && DCONS_FORCE_GDB
679 if (gdb_tab == &dcons_consdev)
684 #if __FreeBSD_version >= 500000
685 cnremove(&dcons_consdev);
687 dcons_detach(DCONS_CON);
688 dcons_detach(DCONS_GDB);
691 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
701 lwkt_reltoken(&tty_token);
705 #if __FreeBSD_version >= 502122
706 /* Debugger interface */
709 dcons_dbg_probe(void)
711 return(DCONS_FORCE_GDB);
725 dcons_dbg_putc(int c)
727 struct dcons_softc *dc = &sc[DCONS_GDB];
728 dcons_os_putc(dc, c);
732 dcons_dbg_checkc(void)
734 struct dcons_softc *dc = &sc[DCONS_GDB];
735 return (dcons_os_checkc(dc));
741 struct dcons_softc *dc = &sc[DCONS_GDB];
742 return (dcons_os_getc(dc));
746 DEV_MODULE(dcons, dcons_modevent, NULL);
747 MODULE_VERSION(dcons, DCONS_VERSION);