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)
204 #if __FreeBSD_version >= 502122
205 if (kdb_alt_break(c, &dc->brk_state)) {
206 if ((dc->flags & DC_GDB) != 0) {
208 if (gdb_cur == &dcons_gdb_dbgport) {
209 kdb_dbbe_select("gdb");
210 kdb_enter("Break sequence on dcons gdb port");
214 kdb_enter("Break sequence on dcons console port");
217 switch (dc->brk_state) {
220 dc->brk_state = STATE2;
222 dc->brk_state = STATE0;
225 dc->brk_state = STATE0;
226 if (c == KEY_CTRLB) {
228 if (dc->flags & DC_GDB)
235 dc->brk_state = STATE1;
240 #define dcons_check_break(dc, c) (c)
244 dcons_os_checkc(struct dcons_softc *dc)
248 EVENTHANDLER_INVOKE(dcons_poll, 0);
249 if (dg.dma_tag != NULL)
250 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
252 c = dcons_check_break(dc, dcons_checkc(dc));
254 if (dg.dma_tag != NULL)
255 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
260 #if defined(GDB) || !defined(CONS_NODEV)
262 dcons_os_getc(struct dcons_softc *dc)
266 while ((c = dcons_os_checkc(dc)) == -1);
273 dcons_os_putc(struct dcons_softc *dc, int c)
275 if (dg.dma_tag != NULL)
276 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
280 if (dg.dma_tag != NULL)
281 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
284 dcons_open(DEV dev, int flag, int mode, THREAD *td)
294 tp->t_oproc = dcons_tty_start;
295 tp->t_param = dcons_tty_param;
296 tp->t_stop = nottystop;
302 if ((tp->t_state & TS_ISOPEN) == 0) {
303 tp->t_state |= TS_CARR_ON;
304 ttyconsolemode(tp, 0);
305 } else if ((tp->t_state & TS_XCLUDE) &&
306 priv_check(td, PRIV_TTY_EXCLUSIVE)) {
312 #if __FreeBSD_version < 502113
313 error = (*linesw[tp->t_line].l_open)(dev, tp);
315 error = ttyld_open(tp, dev);
322 dcons_close(DEV dev, int flag, int mode, THREAD *td)
332 if (tp->t_state & TS_ISOPEN) {
333 #if __FreeBSD_version < 502113
334 (*linesw[tp->t_line].l_close)(tp, flag);
337 ttyld_close(tp, flag);
345 #if defined(__DragonFly__) || __FreeBSD_version < 500104
347 dcons_ioctl(DEV dev, u_long cmd, caddr_t data, int flag, THREAD *td)
358 error = (*linesw[tp->t_line].l_ioctl)(tp, cmd, data, flag, td);
359 if (error != ENOIOCTL)
362 error = ttioctl(tp, cmd, data, flag);
363 if (error != ENOIOCTL)
371 dcons_tty_param(struct tty *tp, struct termios *t)
373 tp->t_ispeed = t->c_ispeed;
374 tp->t_ospeed = t->c_ospeed;
375 tp->t_cflag = t->c_cflag;
380 dcons_tty_start(struct tty *tp)
382 struct dcons_softc *dc;
385 dc = (struct dcons_softc *)tp->t_dev->si_drv1;
387 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
392 tp->t_state |= TS_BUSY;
393 while (tp->t_outq.c_cc != 0)
394 dcons_os_putc(dc, getc(&tp->t_outq));
395 tp->t_state &= ~TS_BUSY;
402 dcons_timeout(void *v)
405 struct dcons_softc *dc;
408 for (i = 0; i < DCONS_NPORT; i ++) {
410 tp = ((DEV)dc->dev)->si_tty;
411 while ((c = dcons_os_checkc(dc)) != -1)
412 if (tp->t_state & TS_ISOPEN)
413 #if __FreeBSD_version < 502113
414 (*linesw[tp->t_line].l_rint)(c, tp);
419 polltime = hz / poll_hz;
422 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
426 dcons_cnprobe(struct consdev *cp)
429 cp->cn_dev = make_dev(&dcons_cdevsw, DCONS_CON,
430 UID_ROOT, GID_WHEEL, 0600, "dcons");
431 #elif __FreeBSD_version >= 501109
432 sprintf(cp->cn_name, "dcons");
434 cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
436 #if DCONS_FORCE_CONSOLE
437 cp->cn_pri = CN_REMOTE;
439 cp->cn_pri = CN_NORMAL;
444 dcons_cninit(struct consdev *cp)
452 = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
456 dcons_cnterm(struct consdev *cp)
462 dcons_cngetc(struct consdev *cp)
464 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
465 return (dcons_os_checkc(dc));
468 dcons_cnputc(struct consdev *cp, int c)
470 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
471 dcons_os_putc(dc, c);
475 dcons_cngetc(DEV dev)
477 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
478 return (dcons_os_getc(dc));
481 dcons_cncheckc(DEV dev)
483 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
484 return (dcons_os_checkc(dc));
487 dcons_cnputc(DEV dev, int c)
489 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
490 dcons_os_putc(dc, c);
495 dcons_drv_init(int stage)
497 #if defined(__i386__) || defined(__amd64__)
506 bzero(&dg, sizeof(dg));
508 dg.cdev = &dcons_consdev;
510 dg.size = DCONS_BUF_SIZE;
512 #if defined(__i386__) || defined(__amd64__)
513 if (getenv_quad("dcons.addr", &addr) > 0 &&
514 getenv_quad("dcons.size", &size) > 0) {
518 * Allow read/write access to dcons buffer.
520 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
521 *vtopte(KERNBASE + pa) |= PG_RW;
525 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
527 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
535 if (stage == 0) { /* XXX or cold */
537 * DCONS_FORCE_CONSOLE == 1 and statically linked.
538 * called from cninit(). can't use contigmalloc yet .
540 dg.buf = (struct dcons_buf *) bssbuf;
541 dcons_init(dg.buf, dg.size, sc);
546 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
547 * if the module is loaded after boot,
548 * bssbuf could be non-continuous.
550 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
551 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
552 dcons_init(dg.buf, dg.size, sc);
558 #if __FreeBSD_version < 502122
559 #if defined(DDB) && DCONS_FORCE_GDB
561 gdbconsdev.cn_arg = (void *)&sc[DCONS_GDB];
562 #if __FreeBSD_version >= 501109
563 sprintf(gdbconsdev.cn_name, "dgdb");
565 gdb_arg = &gdbconsdev;
566 #elif defined(__DragonFly__)
567 gdbdev = make_dev(&dcons_cdevsw, DCONS_GDB,
568 UID_ROOT, GID_WHEEL, 0600, "dgdb");
570 gdbdev = makedev(CDEV_MAJOR, DCONS_GDB);
572 gdb_getc = dcons_cngetc;
573 gdb_putc = dcons_cnputc;
583 dcons_attach_port(int port, char *name, int flags)
585 struct dcons_softc *dc;
591 dev = make_dev(&dcons_cdevsw, port,
592 UID_ROOT, GID_WHEEL, 0600, name);
593 dc->dev = (void *)dev;
596 dev->si_drv1 = (void *)dc;
599 tp->t_oproc = dcons_tty_start;
600 tp->t_param = dcons_tty_param;
601 tp->t_stop = nottystop;
613 cdevsw_add(&dcons_cdevsw, -1, 0);
615 dcons_attach_port(DCONS_CON, "dcons", 0);
616 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
617 #if __FreeBSD_version < 500000
618 callout_init(&dcons_callout);
620 callout_init(&dcons_callout, 0);
622 polltime = hz / poll_hz;
625 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
630 dcons_detach(int port)
633 struct dcons_softc *dc;
637 tp = ((DEV)dc->dev)->si_tty;
639 if (tp->t_state & TS_ISOPEN) {
640 printf("dcons: still opened\n");
641 #if __FreeBSD_version < 502113
642 (*linesw[tp->t_line].l_close)(tp, 0);
653 * must wait until all device are closed.
656 tsleep((void *)dc, 0, "dcodtc", hz/4);
658 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
660 destroy_dev(dc->dev);
666 /* cnXXX works only for FreeBSD-5 */
668 dcons_modevent(module_t mode, int type, void *data)
674 ret = dcons_drv_init(1);
676 #if __FreeBSD_version >= 500000
678 dcons_cnprobe(&dcons_consdev);
679 dcons_cninit(&dcons_consdev);
680 cnadd(&dcons_consdev);
685 printf("dcons: unload\n");
686 callout_stop(&dcons_callout);
687 #if __FreeBSD_version < 502122
688 #if defined(DDB) && DCONS_FORCE_GDB
696 #if __FreeBSD_version >= 500000
697 cnremove(&dcons_consdev);
699 dcons_detach(DCONS_CON);
700 dcons_detach(DCONS_GDB);
703 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
707 #if 0 /* Keep connection after halt */
718 #if defined(GDB) && (__FreeBSD_version >= 502122)
719 /* Debugger interface */
722 dcons_dbg_probe(void)
726 if (getenv_int("dcons_gdb", &dcons_gdb) == 0)
742 dcons_dbg_putc(int c)
744 struct dcons_softc *dc = &sc[DCONS_GDB];
745 dcons_os_putc(dc, c);
751 struct dcons_softc *dc = &sc[DCONS_GDB];
752 return (dcons_os_getc(dc));
756 DEV_MODULE(dcons, dcons_modevent, NULL);
757 MODULE_VERSION(dcons, DCONS_VERSION);