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
37 #include <sys/param.h>
38 #if __FreeBSD_version >= 502122
42 #include <sys/kernel.h>
43 #include <sys/module.h>
44 #include <sys/systm.h>
45 #include <sys/types.h>
48 #include <sys/consio.h>
50 #include <sys/malloc.h>
53 #include <sys/ucred.h>
55 #include <machine/bus.h>
61 #include <dev/dcons/dcons.h>
62 #include <dev/dcons/dcons_os.h>
66 #include <sys/reboot.h>
68 #include <sys/sysctl.h>
71 #include <vm/vm_param.h>
74 #include "opt_comconsole.h"
75 #include "opt_dcons.h"
82 #define DCONS_POLL_HZ 100
85 #ifndef DCONS_BUF_SIZE
86 #define DCONS_BUF_SIZE (16*1024)
89 #ifndef DCONS_FORCE_CONSOLE
90 #define DCONS_FORCE_CONSOLE 0 /* Mostly for FreeBSD-4/DragonFly */
93 #ifndef DCONS_FORCE_GDB
94 #define DCONS_FORCE_GDB 1
97 #if __FreeBSD_version >= 500101
99 #if __FreeBSD_version < 502122
100 static struct consdev gdbconsdev;
104 static d_open_t dcons_open;
105 static d_close_t dcons_close;
106 #if defined(__DragonFly__) || __FreeBSD_version < 500104
107 static d_ioctl_t dcons_ioctl;
110 static struct cdevsw dcons_cdevsw = {
112 #define CDEV_MAJOR 184
113 "dcons", CDEV_MAJOR, D_TTY, NULL, 0,
114 dcons_open, dcons_close, ttyread, ttywrite, dcons_ioctl,
115 ttypoll, nommap, nostrategy, nodump, nopsize,
116 #elif __FreeBSD_version >= 500104
117 .d_version = D_VERSION,
118 .d_open = dcons_open,
119 .d_close = dcons_close,
121 .d_flags = D_TTY | D_NEEDGIANT,
123 #define CDEV_MAJOR 184
124 /* open */ dcons_open,
125 /* close */ dcons_close,
127 /* write */ ttywrite,
128 /* ioctl */ dcons_ioctl,
131 /* strategy */ nostrategy,
133 /* major */ CDEV_MAJOR,
141 static char bssbuf[DCONS_BUF_SIZE]; /* buf in bss */
145 static struct dcons_global dg;
146 struct dcons_global *dcons_conf;
147 static int poll_hz = DCONS_POLL_HZ;
149 static struct dcons_softc sc[DCONS_NPORT];
151 SYSCTL_NODE(_kern, OID_AUTO, dcons, CTLFLAG_RD, 0, "Dumb Console");
152 SYSCTL_INT(_kern_dcons, OID_AUTO, poll_hz, CTLFLAG_RW, &poll_hz, 0,
153 "dcons polling rate");
155 static int drv_init = 0;
156 static struct callout dcons_callout;
157 struct dcons_buf *dcons_buf; /* for local dconschat */
161 #define THREAD d_thread_t
162 #elif __FreeBSD_version < 500000
164 #define THREAD struct proc
166 #define DEV struct cdev *
167 #define THREAD struct thread
171 static void dcons_tty_start(struct tty *);
172 static int dcons_tty_param(struct tty *, struct termios *);
173 static void dcons_timeout(void *);
174 static int dcons_drv_init(int);
176 static cn_probe_t dcons_cnprobe;
177 static cn_init_t dcons_cninit;
178 static cn_term_t dcons_cnterm;
179 static cn_getc_t dcons_cngetc;
180 static cn_putc_t dcons_cnputc;
182 CONSOLE_DRIVER(dcons);
184 #if defined(GDB) && (__FreeBSD_version >= 502122)
185 static gdb_probe_f dcons_dbg_probe;
186 static gdb_init_f dcons_dbg_init;
187 static gdb_term_f dcons_dbg_term;
188 static gdb_getc_f dcons_dbg_getc;
189 static gdb_putc_f dcons_dbg_putc;
191 GDB_DBGPORT(dcons, dcons_dbg_probe, dcons_dbg_init, dcons_dbg_term,
192 dcons_dbg_getc, dcons_dbg_putc);
194 extern struct gdb_dbgport *gdb_cur;
197 #if (defined(GDB) || defined(DDB)) && defined(ALT_BREAK_TO_DEBUGGER)
199 dcons_check_break(struct dcons_softc *dc, int c)
201 #if __FreeBSD_version >= 502122
207 #if __FreeBSD_version >= 502122
208 if ((kdb_brk = kdb_alt_break(c, &dc->brk_state)) != 0) {
210 case KDB_REQ_DEBUGGER:
212 if ((dc->flags & DC_GDB) != 0) {
214 if (gdb_cur == &dcons_gdb_dbgport) {
215 kdb_dbbe_select("gdb");
216 kdb_enter(KDB_WHY_BREAK,
217 "Break sequence on dcons gdb port");
221 kdb_enter(KDB_WHY_BREAK,
222 "Break sequence on dcons console port");
225 kdb_panic("Panic sequence on dcons console port");
233 switch (dc->brk_state) {
236 dc->brk_state = STATE2;
238 dc->brk_state = STATE0;
241 dc->brk_state = STATE0;
242 if (c == KEY_CTRLB) {
244 if (dc->flags & DC_GDB)
251 dc->brk_state = STATE1;
256 #define dcons_check_break(dc, c) (c)
260 dcons_os_checkc_nopoll(struct dcons_softc *dc)
264 if (dg.dma_tag != NULL)
265 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
267 c = dcons_check_break(dc, dcons_checkc(dc));
269 if (dg.dma_tag != NULL)
270 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
276 dcons_os_checkc(struct dcons_softc *dc)
278 EVENTHANDLER_INVOKE(dcons_poll, 0);
279 return (dcons_os_checkc_nopoll(dc));
282 #if defined(GDB) || !defined(CONS_NODEV)
284 dcons_os_getc(struct dcons_softc *dc)
288 while ((c = dcons_os_checkc(dc)) == -1);
295 dcons_os_putc(struct dcons_softc *dc, int c)
297 if (dg.dma_tag != NULL)
298 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
302 if (dg.dma_tag != NULL)
303 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
306 dcons_open(DEV dev, int flag, int mode, THREAD *td)
316 tp->t_oproc = dcons_tty_start;
317 tp->t_param = dcons_tty_param;
318 tp->t_stop = nottystop;
324 if ((tp->t_state & TS_ISOPEN) == 0) {
325 tp->t_state |= TS_CARR_ON;
326 ttyconsolemode(tp, 0);
327 } else if ((tp->t_state & TS_XCLUDE) &&
328 priv_check(td, PRIV_TTY_EXCLUSIVE)) {
334 #if __FreeBSD_version < 502113
335 error = (*linesw[tp->t_line].l_open)(dev, tp);
337 error = ttyld_open(tp, dev);
344 dcons_close(DEV dev, int flag, int mode, THREAD *td)
354 if (tp->t_state & TS_ISOPEN) {
355 #if __FreeBSD_version < 502113
356 (*linesw[tp->t_line].l_close)(tp, flag);
359 ttyld_close(tp, flag);
367 #if defined(__DragonFly__) || __FreeBSD_version < 500104
369 dcons_ioctl(DEV dev, u_long cmd, caddr_t data, int flag, THREAD *td)
380 error = (*linesw[tp->t_line].l_ioctl)(tp, cmd, data, flag, td);
381 if (error != ENOIOCTL)
384 error = ttioctl(tp, cmd, data, flag);
385 if (error != ENOIOCTL)
393 dcons_tty_param(struct tty *tp, struct termios *t)
395 tp->t_ispeed = t->c_ispeed;
396 tp->t_ospeed = t->c_ospeed;
397 tp->t_cflag = t->c_cflag;
402 dcons_tty_start(struct tty *tp)
404 struct dcons_softc *dc;
407 dc = (struct dcons_softc *)tp->t_dev->si_drv1;
409 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
414 tp->t_state |= TS_BUSY;
415 while (tp->t_outq.c_cc != 0)
416 dcons_os_putc(dc, getc(&tp->t_outq));
417 tp->t_state &= ~TS_BUSY;
424 dcons_timeout(void *v)
427 struct dcons_softc *dc;
430 for (i = 0; i < DCONS_NPORT; i ++) {
432 tp = ((DEV)dc->dev)->si_tty;
433 while ((c = dcons_os_checkc_nopoll(dc)) != -1)
434 if (tp->t_state & TS_ISOPEN)
435 #if __FreeBSD_version < 502113
436 (*linesw[tp->t_line].l_rint)(c, tp);
441 polltime = hz / poll_hz;
444 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
448 dcons_cnprobe(struct consdev *cp)
451 cp->cn_dev = make_dev(&dcons_cdevsw, DCONS_CON,
452 UID_ROOT, GID_WHEEL, 0600, "dcons");
453 #elif __FreeBSD_version >= 501109
454 sprintf(cp->cn_name, "dcons");
456 cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
458 #if DCONS_FORCE_CONSOLE
459 cp->cn_pri = CN_REMOTE;
461 cp->cn_pri = CN_NORMAL;
466 dcons_cninit(struct consdev *cp)
474 = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
478 dcons_cnterm(struct consdev *cp)
484 dcons_cngetc(struct consdev *cp)
486 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
487 return (dcons_os_checkc(dc));
490 dcons_cnputc(struct consdev *cp, int c)
492 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
493 dcons_os_putc(dc, c);
497 dcons_cngetc(DEV dev)
499 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
500 return (dcons_os_getc(dc));
503 dcons_cncheckc(DEV dev)
505 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
506 return (dcons_os_checkc(dc));
509 dcons_cnputc(DEV dev, int c)
511 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
512 dcons_os_putc(dc, c);
517 dcons_drv_init(int stage)
519 #if defined(__i386__) || defined(__amd64__)
528 bzero(&dg, sizeof(dg));
530 dg.cdev = &dcons_consdev;
532 dg.size = DCONS_BUF_SIZE;
534 #if defined(__i386__) || defined(__amd64__)
535 if (getenv_quad("dcons.addr", &addr) > 0 &&
536 getenv_quad("dcons.size", &size) > 0) {
540 * Allow read/write access to dcons buffer.
542 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
543 *vtopte(KERNBASE + pa) |= PG_RW;
547 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
549 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
557 if (stage == 0) { /* XXX or cold */
559 * DCONS_FORCE_CONSOLE == 1 and statically linked.
560 * called from cninit(). can't use contigmalloc yet .
562 dg.buf = (struct dcons_buf *) bssbuf;
563 dcons_init(dg.buf, dg.size, sc);
568 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
569 * if the module is loaded after boot,
570 * bssbuf could be non-continuous.
572 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
573 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
574 dcons_init(dg.buf, dg.size, sc);
580 #if __FreeBSD_version < 502122
581 #if defined(DDB) && DCONS_FORCE_GDB
583 gdbconsdev.cn_arg = (void *)&sc[DCONS_GDB];
584 #if __FreeBSD_version >= 501109
585 sprintf(gdbconsdev.cn_name, "dgdb");
587 gdb_arg = &gdbconsdev;
588 #elif defined(__DragonFly__)
589 gdbdev = make_dev(&dcons_cdevsw, DCONS_GDB,
590 UID_ROOT, GID_WHEEL, 0600, "dgdb");
592 gdbdev = makedev(CDEV_MAJOR, DCONS_GDB);
594 gdb_getc = dcons_cngetc;
595 gdb_putc = dcons_cnputc;
605 dcons_attach_port(int port, char *name, int flags)
607 struct dcons_softc *dc;
613 dev = make_dev(&dcons_cdevsw, port,
614 UID_ROOT, GID_WHEEL, 0600, name);
615 dc->dev = (void *)dev;
618 dev->si_drv1 = (void *)dc;
621 tp->t_oproc = dcons_tty_start;
622 tp->t_param = dcons_tty_param;
623 tp->t_stop = nottystop;
635 cdevsw_add(&dcons_cdevsw, -1, 0);
637 dcons_attach_port(DCONS_CON, "dcons", 0);
638 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
639 #if __FreeBSD_version < 500000
640 callout_init(&dcons_callout);
642 callout_init(&dcons_callout, 0);
644 polltime = hz / poll_hz;
647 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
652 dcons_detach(int port)
655 struct dcons_softc *dc;
659 tp = ((DEV)dc->dev)->si_tty;
661 if (tp->t_state & TS_ISOPEN) {
662 printf("dcons: still opened\n");
663 #if __FreeBSD_version < 502113
664 (*linesw[tp->t_line].l_close)(tp, 0);
675 * must wait until all device are closed.
678 tsleep((void *)dc, 0, "dcodtc", hz/4);
680 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
682 destroy_dev(dc->dev);
688 /* cnXXX works only for FreeBSD-5 */
690 dcons_modevent(module_t mode, int type, void *data)
696 ret = dcons_drv_init(1);
698 #if __FreeBSD_version >= 500000
700 dcons_cnprobe(&dcons_consdev);
701 dcons_cninit(&dcons_consdev);
702 cnadd(&dcons_consdev);
707 printf("dcons: unload\n");
708 callout_stop(&dcons_callout);
709 #if __FreeBSD_version < 502122
710 #if defined(DDB) && DCONS_FORCE_GDB
718 #if __FreeBSD_version >= 500000
719 cnremove(&dcons_consdev);
721 dcons_detach(DCONS_CON);
722 dcons_detach(DCONS_GDB);
725 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
729 #if 0 /* Keep connection after halt */
740 #if defined(GDB) && (__FreeBSD_version >= 502122)
741 /* Debugger interface */
744 dcons_dbg_probe(void)
748 if (getenv_int("dcons_gdb", &dcons_gdb) == 0)
764 dcons_dbg_putc(int c)
766 struct dcons_softc *dc = &sc[DCONS_GDB];
767 dcons_os_putc(dc, c);
773 struct dcons_softc *dc = &sc[DCONS_GDB];
774 return (dcons_os_getc(dc));
778 DEV_MODULE(dcons, dcons_modevent, NULL);
779 MODULE_VERSION(dcons, DCONS_VERSION);