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_nopoll(struct dcons_softc *dc)
248 if (dg.dma_tag != NULL)
249 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
251 c = dcons_check_break(dc, dcons_checkc(dc));
253 if (dg.dma_tag != NULL)
254 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
260 dcons_os_checkc(struct dcons_softc *dc)
262 EVENTHANDLER_INVOKE(dcons_poll, 0);
263 return (dcons_os_checkc_nopoll(dc));
266 #if defined(GDB) || !defined(CONS_NODEV)
268 dcons_os_getc(struct dcons_softc *dc)
272 while ((c = dcons_os_checkc(dc)) == -1);
279 dcons_os_putc(struct dcons_softc *dc, int c)
281 if (dg.dma_tag != NULL)
282 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
286 if (dg.dma_tag != NULL)
287 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
290 dcons_open(DEV dev, int flag, int mode, THREAD *td)
300 tp->t_oproc = dcons_tty_start;
301 tp->t_param = dcons_tty_param;
302 tp->t_stop = nottystop;
308 if ((tp->t_state & TS_ISOPEN) == 0) {
309 tp->t_state |= TS_CARR_ON;
310 ttyconsolemode(tp, 0);
311 } else if ((tp->t_state & TS_XCLUDE) &&
312 priv_check(td, PRIV_TTY_EXCLUSIVE)) {
318 #if __FreeBSD_version < 502113
319 error = (*linesw[tp->t_line].l_open)(dev, tp);
321 error = ttyld_open(tp, dev);
328 dcons_close(DEV dev, int flag, int mode, THREAD *td)
338 if (tp->t_state & TS_ISOPEN) {
339 #if __FreeBSD_version < 502113
340 (*linesw[tp->t_line].l_close)(tp, flag);
343 ttyld_close(tp, flag);
351 #if defined(__DragonFly__) || __FreeBSD_version < 500104
353 dcons_ioctl(DEV dev, u_long cmd, caddr_t data, int flag, THREAD *td)
364 error = (*linesw[tp->t_line].l_ioctl)(tp, cmd, data, flag, td);
365 if (error != ENOIOCTL)
368 error = ttioctl(tp, cmd, data, flag);
369 if (error != ENOIOCTL)
377 dcons_tty_param(struct tty *tp, struct termios *t)
379 tp->t_ispeed = t->c_ispeed;
380 tp->t_ospeed = t->c_ospeed;
381 tp->t_cflag = t->c_cflag;
386 dcons_tty_start(struct tty *tp)
388 struct dcons_softc *dc;
391 dc = (struct dcons_softc *)tp->t_dev->si_drv1;
393 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
398 tp->t_state |= TS_BUSY;
399 while (tp->t_outq.c_cc != 0)
400 dcons_os_putc(dc, getc(&tp->t_outq));
401 tp->t_state &= ~TS_BUSY;
408 dcons_timeout(void *v)
411 struct dcons_softc *dc;
414 for (i = 0; i < DCONS_NPORT; i ++) {
416 tp = ((DEV)dc->dev)->si_tty;
417 while ((c = dcons_os_checkc_nopoll(dc)) != -1)
418 if (tp->t_state & TS_ISOPEN)
419 #if __FreeBSD_version < 502113
420 (*linesw[tp->t_line].l_rint)(c, tp);
425 polltime = hz / poll_hz;
428 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
432 dcons_cnprobe(struct consdev *cp)
435 cp->cn_dev = make_dev(&dcons_cdevsw, DCONS_CON,
436 UID_ROOT, GID_WHEEL, 0600, "dcons");
437 #elif __FreeBSD_version >= 501109
438 sprintf(cp->cn_name, "dcons");
440 cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
442 #if DCONS_FORCE_CONSOLE
443 cp->cn_pri = CN_REMOTE;
445 cp->cn_pri = CN_NORMAL;
450 dcons_cninit(struct consdev *cp)
458 = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
462 dcons_cnterm(struct consdev *cp)
468 dcons_cngetc(struct consdev *cp)
470 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
471 return (dcons_os_checkc(dc));
474 dcons_cnputc(struct consdev *cp, int c)
476 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
477 dcons_os_putc(dc, c);
481 dcons_cngetc(DEV dev)
483 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
484 return (dcons_os_getc(dc));
487 dcons_cncheckc(DEV dev)
489 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
490 return (dcons_os_checkc(dc));
493 dcons_cnputc(DEV dev, int c)
495 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
496 dcons_os_putc(dc, c);
501 dcons_drv_init(int stage)
503 #if defined(__i386__) || defined(__amd64__)
512 bzero(&dg, sizeof(dg));
514 dg.cdev = &dcons_consdev;
516 dg.size = DCONS_BUF_SIZE;
518 #if defined(__i386__) || defined(__amd64__)
519 if (getenv_quad("dcons.addr", &addr) > 0 &&
520 getenv_quad("dcons.size", &size) > 0) {
524 * Allow read/write access to dcons buffer.
526 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
527 *vtopte(KERNBASE + pa) |= PG_RW;
531 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
533 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
541 if (stage == 0) { /* XXX or cold */
543 * DCONS_FORCE_CONSOLE == 1 and statically linked.
544 * called from cninit(). can't use contigmalloc yet .
546 dg.buf = (struct dcons_buf *) bssbuf;
547 dcons_init(dg.buf, dg.size, sc);
552 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
553 * if the module is loaded after boot,
554 * bssbuf could be non-continuous.
556 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
557 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
558 dcons_init(dg.buf, dg.size, sc);
564 #if __FreeBSD_version < 502122
565 #if defined(DDB) && DCONS_FORCE_GDB
567 gdbconsdev.cn_arg = (void *)&sc[DCONS_GDB];
568 #if __FreeBSD_version >= 501109
569 sprintf(gdbconsdev.cn_name, "dgdb");
571 gdb_arg = &gdbconsdev;
572 #elif defined(__DragonFly__)
573 gdbdev = make_dev(&dcons_cdevsw, DCONS_GDB,
574 UID_ROOT, GID_WHEEL, 0600, "dgdb");
576 gdbdev = makedev(CDEV_MAJOR, DCONS_GDB);
578 gdb_getc = dcons_cngetc;
579 gdb_putc = dcons_cnputc;
589 dcons_attach_port(int port, char *name, int flags)
591 struct dcons_softc *dc;
597 dev = make_dev(&dcons_cdevsw, port,
598 UID_ROOT, GID_WHEEL, 0600, name);
599 dc->dev = (void *)dev;
602 dev->si_drv1 = (void *)dc;
605 tp->t_oproc = dcons_tty_start;
606 tp->t_param = dcons_tty_param;
607 tp->t_stop = nottystop;
619 cdevsw_add(&dcons_cdevsw, -1, 0);
621 dcons_attach_port(DCONS_CON, "dcons", 0);
622 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
623 #if __FreeBSD_version < 500000
624 callout_init(&dcons_callout);
626 callout_init(&dcons_callout, 0);
628 polltime = hz / poll_hz;
631 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
636 dcons_detach(int port)
639 struct dcons_softc *dc;
643 tp = ((DEV)dc->dev)->si_tty;
645 if (tp->t_state & TS_ISOPEN) {
646 printf("dcons: still opened\n");
647 #if __FreeBSD_version < 502113
648 (*linesw[tp->t_line].l_close)(tp, 0);
659 * must wait until all device are closed.
662 tsleep((void *)dc, 0, "dcodtc", hz/4);
664 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
666 destroy_dev(dc->dev);
672 /* cnXXX works only for FreeBSD-5 */
674 dcons_modevent(module_t mode, int type, void *data)
680 ret = dcons_drv_init(1);
682 #if __FreeBSD_version >= 500000
684 dcons_cnprobe(&dcons_consdev);
685 dcons_cninit(&dcons_consdev);
686 cnadd(&dcons_consdev);
691 printf("dcons: unload\n");
692 callout_stop(&dcons_callout);
693 #if __FreeBSD_version < 502122
694 #if defined(DDB) && DCONS_FORCE_GDB
702 #if __FreeBSD_version >= 500000
703 cnremove(&dcons_consdev);
705 dcons_detach(DCONS_CON);
706 dcons_detach(DCONS_GDB);
709 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
713 #if 0 /* Keep connection after halt */
724 #if defined(GDB) && (__FreeBSD_version >= 502122)
725 /* Debugger interface */
728 dcons_dbg_probe(void)
732 if (getenv_int("dcons_gdb", &dcons_gdb) == 0)
748 dcons_dbg_putc(int c)
750 struct dcons_softc *dc = &sc[DCONS_GDB];
751 dcons_os_putc(dc, c);
757 struct dcons_softc *dc = &sc[DCONS_GDB];
758 return (dcons_os_getc(dc));
762 DEV_MODULE(dcons, dcons_modevent, NULL);
763 MODULE_VERSION(dcons, DCONS_VERSION);