2 * Copyright (C) 2003,2004
3 * Hidetoshi Shimokawa. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
16 * This product includes software developed by Hidetoshi Shimokawa.
18 * 4. Neither the name of the author nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $FreeBSD: src/sys/dev/dcons/dcons_os.c,v 1.4 2004/10/24 12:41:04 simokawa Exp $
35 * $DragonFly: src/sys/dev/misc/dcons/dcons_os.c,v 1.13 2007/08/07 13:14:11 hasso Exp $
38 #include <sys/param.h>
39 #if __FreeBSD_version >= 502122
43 #include <sys/kernel.h>
44 #include <sys/module.h>
45 #include <sys/systm.h>
46 #include <sys/types.h>
49 #include <sys/consio.h>
51 #include <sys/malloc.h>
54 #include <sys/thread2.h>
55 #include <sys/ucred.h>
62 #include <sys/reboot.h>
64 #include <sys/sysctl.h>
67 #include <vm/vm_param.h>
71 #include "opt_comconsole.h"
72 #include "opt_dcons.h"
75 #define DCONS_POLL_HZ 100
78 #ifndef DCONS_BUF_SIZE
79 #define DCONS_BUF_SIZE (16*1024)
82 #ifndef DCONS_FORCE_CONSOLE
83 #define DCONS_FORCE_CONSOLE 0 /* Mostly for FreeBSD-4/DragonFly */
86 #ifndef DCONS_FORCE_GDB
87 #define DCONS_FORCE_GDB 1
90 #define CDEV_MAJOR 184
92 static d_open_t dcons_open;
93 static d_close_t dcons_close;
94 static d_ioctl_t dcons_ioctl;
96 static struct dev_ops dcons_ops = {
97 { "dcons", CDEV_MAJOR, D_TTY },
99 .d_close = dcons_close,
102 .d_ioctl = dcons_ioctl,
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 #if __FreeBSD_version >= 502122
174 if (kdb_alt_break(c, &dc->brk_state)) {
175 if ((dc->flags & DC_GDB) != 0) {
176 if (gdb_cur == &dcons_gdb_dbgport) {
177 kdb_dbbe_select("gdb");
184 switch (dc->brk_state) {
187 dc->brk_state = STATE2;
189 dc->brk_state = STATE0;
192 dc->brk_state = STATE0;
193 if (c == KEY_CTRLB) {
195 if (dc->flags & DC_GDB)
202 dc->brk_state = STATE1;
207 #define dcons_check_break(dc, c) (c)
211 dcons_os_checkc(struct dcons_softc *dc)
215 if (dg.dma_tag != NULL)
216 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
218 c = dcons_check_break(dc, dcons_checkc(dc));
220 if (dg.dma_tag != NULL)
221 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
227 dcons_os_getc(struct dcons_softc *dc)
231 while ((c = dcons_os_checkc(dc)) == -1);
237 dcons_os_putc(struct dcons_softc *dc, int c)
239 if (dg.dma_tag != NULL)
240 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
244 if (dg.dma_tag != NULL)
245 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
248 dcons_open(struct dev_open_args *ap)
250 cdev_t dev = ap->a_head.a_dev;
258 tp = dev->si_tty = ttymalloc(dev->si_tty);
259 tp->t_oproc = dcons_tty_start;
260 tp->t_param = dcons_tty_param;
261 tp->t_stop = nottystop;
267 if ((tp->t_state & TS_ISOPEN) == 0) {
268 tp->t_state |= TS_CARR_ON;
270 tp->t_iflag = TTYDEF_IFLAG;
271 tp->t_oflag = TTYDEF_OFLAG;
272 tp->t_cflag = TTYDEF_CFLAG|CLOCAL;
273 tp->t_lflag = TTYDEF_LFLAG;
274 tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
276 } else if ((tp->t_state & TS_XCLUDE) && priv_check_cred(ap->a_cred, PRIV_ROOT, 0)) {
282 #if __FreeBSD_version < 502113
283 error = (*linesw[tp->t_line].l_open)(dev, tp);
285 error = ttyld_open(tp, dev);
292 dcons_close(struct dev_close_args *ap)
294 cdev_t dev = ap->a_head.a_dev;
303 if (tp->t_state & TS_ISOPEN) {
304 (*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
312 dcons_ioctl(struct dev_ioctl_args *ap)
314 cdev_t dev = ap->a_head.a_dev;
324 error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data, ap->a_fflag, ap->a_cred);
325 if (error != ENOIOCTL)
328 error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
329 if (error != ENOIOCTL)
336 dcons_tty_param(struct tty *tp, struct termios *t)
338 tp->t_ispeed = t->c_ispeed;
339 tp->t_ospeed = t->c_ospeed;
340 tp->t_cflag = t->c_cflag;
345 dcons_tty_start(struct tty *tp)
347 struct dcons_softc *dc;
349 dc = (struct dcons_softc *)tp->t_dev->si_drv1;
351 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
356 tp->t_state |= TS_BUSY;
357 while (tp->t_outq.c_cc != 0)
358 dcons_os_putc(dc, clist_getc(&tp->t_outq));
359 tp->t_state &= ~TS_BUSY;
366 dcons_timeout(void *v)
369 struct dcons_softc *dc;
372 for (i = 0; i < DCONS_NPORT; i ++) {
374 tp = ((DEV)dc->dev)->si_tty;
375 while ((c = dcons_os_checkc(dc)) != -1)
376 if (tp->t_state & TS_ISOPEN)
377 #if __FreeBSD_version < 502113
378 (*linesw[tp->t_line].l_rint)(c, tp);
383 polltime = hz / poll_hz;
386 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
390 dcons_cnprobe(struct consdev *cp)
393 cp->cn_probegood = 1;
394 #elif __FreeBSD_version >= 501109
395 ksprintf(cp->cn_name, "dcons");
397 cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
399 #if DCONS_FORCE_CONSOLE
400 cp->cn_pri = CN_REMOTE;
402 cp->cn_pri = CN_NORMAL;
407 dcons_cninit(struct consdev *cp)
415 = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
419 dcons_cninit_fini(struct consdev *cp)
421 cp->cn_dev = make_dev(&dcons_ops, DCONS_CON,
422 UID_ROOT, GID_WHEEL, 0600, "dcons");
427 dcons_cngetc(struct consdev *cp)
429 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
430 return (dcons_os_getc(dc));
433 dcons_cncheckc(struct consdev *cp)
435 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
436 return (dcons_os_checkc(dc));
439 dcons_cnputc(struct consdev *cp, int c)
441 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
442 dcons_os_putc(dc, c);
446 dcons_cngetc(void *private)
448 struct dcons_softc *dc = (struct dcons_softc *)private;
449 return (dcons_os_getc(dc));
452 dcons_cncheckc(void *private)
454 struct dcons_softc *dc = (struct dcons_softc *)private;
455 return (dcons_os_checkc(dc));
458 dcons_cnputc(void *private, int c)
460 struct dcons_softc *dc = (struct dcons_softc *)private;
461 dcons_os_putc(dc, c);
466 dcons_drv_init(int stage)
477 bzero(&dg, sizeof(dg));
479 dg.cdev = &dcons_consdev;
481 dg.size = DCONS_BUF_SIZE;
484 if (kgetenv_quad("dcons.addr", &addr) > 0 &&
485 kgetenv_quad("dcons.size", &size) > 0) {
488 * Allow read/write access to dcons buffer.
490 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
491 pmap_kmodify_rw((vm_offset_t)(KERNBASE + pa));
494 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
496 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
504 if (stage == 0) { /* XXX or cold */
506 * DCONS_FORCE_CONSOLE == 1 and statically linked.
507 * called from cninit(). can't use contigmalloc yet .
509 dg.buf = (struct dcons_buf *) bssbuf;
510 dcons_init(dg.buf, dg.size, sc);
515 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
516 * if the module is loaded after boot,
517 * bssbuf could be non-continuous.
519 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
520 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
521 dcons_init(dg.buf, dg.size, sc);
527 #if DDB && DCONS_FORCE_GDB
528 if (gdb_tab == NULL) {
529 gdb_tab = &dcons_consdev;
530 dcons_consdev.cn_gdbprivate = &sc[DCONS_GDB];
540 dcons_attach_port(int port, char *name, int flags)
542 struct dcons_softc *dc;
548 dev = make_dev(&dcons_ops, port,
549 UID_ROOT, GID_WHEEL, 0600, name);
550 dc->dev = (void *)dev;
551 tp = ttymalloc(NULL);
553 dev->si_drv1 = (void *)dc;
556 tp->t_oproc = dcons_tty_start;
557 tp->t_param = dcons_tty_param;
558 tp->t_stop = nottystop;
570 dev_ops_add(&dcons_ops, -1, 0);
572 dcons_attach_port(DCONS_CON, "dcons", 0);
573 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
574 #if __FreeBSD_version < 500000
575 callout_init(&dcons_callout);
577 callout_init(&dcons_callout, 0);
579 polltime = hz / poll_hz;
582 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
587 dcons_detach(int port)
590 struct dcons_softc *dc;
594 tp = ((DEV)dc->dev)->si_tty;
596 if (tp->t_state & TS_ISOPEN) {
597 kprintf("dcons: still opened\n");
598 #if __FreeBSD_version < 502113
599 (*linesw[tp->t_line].l_close)(tp, 0);
607 * must wait until all device are closed.
610 tsleep((void *)dc, 0, "dcodtc", hz/4);
612 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
614 destroy_dev(dc->dev);
620 /* cnXXX works only for FreeBSD-5 */
622 dcons_modevent(module_t mode, int type, void *data)
628 ret = dcons_drv_init(1);
630 #if __FreeBSD_version >= 500000
632 dcons_cnprobe(&dcons_consdev);
633 dcons_cninit(&dcons_consdev);
634 cnadd(&dcons_consdev);
639 kprintf("dcons: unload\n");
640 callout_stop(&dcons_callout);
641 #if __FreeBSD_version < 502122
642 #if DDB && DCONS_FORCE_GDB
646 if (gdb_tab == &dcons_consdev)
651 #if __FreeBSD_version >= 500000
652 cnremove(&dcons_consdev);
654 dcons_detach(DCONS_CON);
655 dcons_detach(DCONS_GDB);
658 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
671 #if __FreeBSD_version >= 502122
672 /* Debugger interface */
675 dcons_dbg_probe(void)
677 return(DCONS_FORCE_GDB);
691 dcons_dbg_putc(int c)
693 struct dcons_softc *dc = &sc[DCONS_GDB];
694 dcons_os_putc(dc, c);
698 dcons_dbg_checkc(void)
700 struct dcons_softc *dc = &sc[DCONS_GDB];
701 return (dcons_os_checkc(dc));
707 struct dcons_softc *dc = &sc[DCONS_GDB];
708 return (dcons_os_getc(dc));
712 DEV_MODULE(dcons, dcons_modevent, NULL);
713 MODULE_VERSION(dcons, DCONS_VERSION);