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>
52 #include <sys/ucred.h>
54 #include <machine/bus.h>
60 #include <dev/dcons/dcons.h>
61 #include <dev/dcons/dcons_os.h>
65 #include <sys/reboot.h>
67 #include <sys/sysctl.h>
70 #include <vm/vm_param.h>
74 #include "opt_comconsole.h"
75 #include "opt_dcons.h"
78 #define DCONS_POLL_HZ 100
81 #ifndef DCONS_BUF_SIZE
82 #define DCONS_BUF_SIZE (16*1024)
85 #ifndef DCONS_FORCE_CONSOLE
86 #define DCONS_FORCE_CONSOLE 0 /* Mostly for FreeBSD-4/DragonFly */
89 #ifndef DCONS_FORCE_GDB
90 #define DCONS_FORCE_GDB 1
93 #if __FreeBSD_version >= 500101
95 #if __FreeBSD_version < 502122
96 static struct consdev gdbconsdev;
100 static d_open_t dcons_open;
101 static d_close_t dcons_close;
102 #if defined(__DragonFly__) || __FreeBSD_version < 500104
103 static d_ioctl_t dcons_ioctl;
106 static struct cdevsw dcons_cdevsw = {
108 #define CDEV_MAJOR 184
109 "dcons", CDEV_MAJOR, D_TTY, NULL, 0,
110 dcons_open, dcons_close, ttyread, ttywrite, dcons_ioctl,
111 ttypoll, nommap, nostrategy, nodump, nopsize,
112 #elif __FreeBSD_version >= 500104
113 .d_version = D_VERSION,
114 .d_open = dcons_open,
115 .d_close = dcons_close,
117 .d_flags = D_TTY | D_NEEDGIANT,
119 #define CDEV_MAJOR 184
120 /* open */ dcons_open,
121 /* close */ dcons_close,
123 /* write */ ttywrite,
124 /* ioctl */ dcons_ioctl,
127 /* strategy */ nostrategy,
129 /* major */ CDEV_MAJOR,
137 static char bssbuf[DCONS_BUF_SIZE]; /* buf in bss */
141 static struct dcons_global dg;
142 struct dcons_global *dcons_conf;
143 static int poll_hz = DCONS_POLL_HZ;
145 static struct dcons_softc sc[DCONS_NPORT];
147 SYSCTL_NODE(_kern, OID_AUTO, dcons, CTLFLAG_RD, 0, "Dumb Console");
148 SYSCTL_INT(_kern_dcons, OID_AUTO, poll_hz, CTLFLAG_RW, &poll_hz, 0,
149 "dcons polling rate");
151 static int drv_init = 0;
152 static struct callout dcons_callout;
153 struct dcons_buf *dcons_buf; /* for local dconschat */
157 #define THREAD d_thread_t
158 #elif __FreeBSD_version < 500000
160 #define THREAD struct proc
162 #define DEV struct cdev *
163 #define THREAD struct thread
167 static void dcons_tty_start(struct tty *);
168 static int dcons_tty_param(struct tty *, struct termios *);
169 static void dcons_timeout(void *);
170 static int dcons_drv_init(int);
172 static cn_probe_t dcons_cnprobe;
173 static cn_init_t dcons_cninit;
174 static cn_getc_t dcons_cngetc;
175 static cn_checkc_t dcons_cncheckc;
176 static cn_putc_t dcons_cnputc;
178 CONS_DRIVER(dcons, dcons_cnprobe, dcons_cninit, NULL, dcons_cngetc,
179 dcons_cncheckc, dcons_cnputc, NULL);
181 #if __FreeBSD_version >= 502122
182 static gdb_probe_f dcons_dbg_probe;
183 static gdb_init_f dcons_dbg_init;
184 static gdb_term_f dcons_dbg_term;
185 static gdb_getc_f dcons_dbg_getc;
186 static gdb_checkc_f dcons_dbg_checkc;
187 static gdb_putc_f dcons_dbg_putc;
189 GDB_DBGPORT(dcons, dcons_dbg_probe, dcons_dbg_init, dcons_dbg_term,
190 dcons_dbg_checkc, dcons_dbg_getc, dcons_dbg_putc);
192 extern struct gdb_dbgport *gdb_cur;
195 #if (defined(KDB) || defined(DDB)) && defined(ALT_BREAK_TO_DEBUGGER)
197 dcons_check_break(struct dcons_softc *dc, int c)
202 #if __FreeBSD_version >= 502122
203 if (kdb_alt_break(c, &dc->brk_state)) {
204 if ((dc->flags & DC_GDB) != 0) {
205 if (gdb_cur == &dcons_gdb_dbgport) {
206 kdb_dbbe_select("gdb");
213 switch (dc->brk_state) {
216 dc->brk_state = STATE2;
218 dc->brk_state = STATE0;
221 dc->brk_state = STATE0;
222 if (c == KEY_CTRLB) {
224 if (dc->flags & DC_GDB)
231 dc->brk_state = STATE1;
236 #define dcons_check_break(dc, c) (c)
240 dcons_os_checkc(struct dcons_softc *dc)
244 if (dg.dma_tag != NULL)
245 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
247 c = dcons_check_break(dc, dcons_checkc(dc));
249 if (dg.dma_tag != NULL)
250 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
256 dcons_os_getc(struct dcons_softc *dc)
260 while ((c = dcons_os_checkc(dc)) == -1);
266 dcons_os_putc(struct dcons_softc *dc, int c)
268 if (dg.dma_tag != NULL)
269 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
273 if (dg.dma_tag != NULL)
274 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
277 dcons_open(DEV dev, int flag, int mode, THREAD *td)
287 tp->t_oproc = dcons_tty_start;
288 tp->t_param = dcons_tty_param;
289 tp->t_stop = nottystop;
295 if ((tp->t_state & TS_ISOPEN) == 0) {
296 tp->t_state |= TS_CARR_ON;
297 ttyconsolemode(tp, 0);
298 } else if ((tp->t_state & TS_XCLUDE) && suser(td)) {
304 #if __FreeBSD_version < 502113
305 error = (*linesw[tp->t_line].l_open)(dev, tp);
307 error = ttyld_open(tp, dev);
314 dcons_close(DEV dev, int flag, int mode, THREAD *td)
324 if (tp->t_state & TS_ISOPEN) {
325 #if __FreeBSD_version < 502113
326 (*linesw[tp->t_line].l_close)(tp, flag);
329 ttyld_close(tp, flag);
337 #if defined(__DragonFly__) || __FreeBSD_version < 500104
339 dcons_ioctl(DEV dev, u_long cmd, caddr_t data, int flag, THREAD *td)
350 error = (*linesw[tp->t_line].l_ioctl)(tp, cmd, data, flag, td);
351 if (error != ENOIOCTL)
354 error = ttioctl(tp, cmd, data, flag);
355 if (error != ENOIOCTL)
363 dcons_tty_param(struct tty *tp, struct termios *t)
365 tp->t_ispeed = t->c_ispeed;
366 tp->t_ospeed = t->c_ospeed;
367 tp->t_cflag = t->c_cflag;
372 dcons_tty_start(struct tty *tp)
374 struct dcons_softc *dc;
377 dc = (struct dcons_softc *)tp->t_dev->si_drv1;
379 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
384 tp->t_state |= TS_BUSY;
385 while (tp->t_outq.c_cc != 0)
386 dcons_os_putc(dc, getc(&tp->t_outq));
387 tp->t_state &= ~TS_BUSY;
394 dcons_timeout(void *v)
397 struct dcons_softc *dc;
400 for (i = 0; i < DCONS_NPORT; i ++) {
402 tp = ((DEV)dc->dev)->si_tty;
403 while ((c = dcons_os_checkc(dc)) != -1)
404 if (tp->t_state & TS_ISOPEN)
405 #if __FreeBSD_version < 502113
406 (*linesw[tp->t_line].l_rint)(c, tp);
411 polltime = hz / poll_hz;
414 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
418 dcons_cnprobe(struct consdev *cp)
421 cp->cn_dev = make_dev(&dcons_cdevsw, DCONS_CON,
422 UID_ROOT, GID_WHEEL, 0600, "dcons");
423 #elif __FreeBSD_version >= 501109
424 sprintf(cp->cn_name, "dcons");
426 cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
428 #if DCONS_FORCE_CONSOLE
429 cp->cn_pri = CN_REMOTE;
431 cp->cn_pri = CN_NORMAL;
436 dcons_cninit(struct consdev *cp)
444 = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
449 dcons_cngetc(struct consdev *cp)
451 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
452 return (dcons_os_getc(dc));
455 dcons_cncheckc(struct consdev *cp)
457 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
458 return (dcons_os_checkc(dc));
461 dcons_cnputc(struct consdev *cp, int c)
463 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
464 dcons_os_putc(dc, c);
468 dcons_cngetc(DEV dev)
470 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
471 return (dcons_os_getc(dc));
474 dcons_cncheckc(DEV dev)
476 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
477 return (dcons_os_checkc(dc));
480 dcons_cnputc(DEV dev, int c)
482 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
483 dcons_os_putc(dc, c);
488 dcons_drv_init(int stage)
490 #if defined(__i386__) || defined(__amd64__)
499 bzero(&dg, sizeof(dg));
501 dg.cdev = &dcons_consdev;
503 dg.size = DCONS_BUF_SIZE;
505 #if defined(__i386__) || defined(__amd64__)
506 if (getenv_quad("dcons.addr", &addr) > 0 &&
507 getenv_quad("dcons.size", &size) > 0) {
511 * Allow read/write access to dcons buffer.
513 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
514 *vtopte(KERNBASE + pa) |= PG_RW;
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 __FreeBSD_version < 502122
552 #if defined(DDB) && DCONS_FORCE_GDB
554 gdbconsdev.cn_arg = (void *)&sc[DCONS_GDB];
555 #if __FreeBSD_version >= 501109
556 sprintf(gdbconsdev.cn_name, "dgdb");
558 gdb_arg = &gdbconsdev;
559 #elif defined(__DragonFly__)
560 gdbdev = make_dev(&dcons_cdevsw, DCONS_GDB,
561 UID_ROOT, GID_WHEEL, 0600, "dgdb");
563 gdbdev = makedev(CDEV_MAJOR, DCONS_GDB);
565 gdb_getc = dcons_cngetc;
566 gdb_putc = dcons_cnputc;
576 dcons_attach_port(int port, char *name, int flags)
578 struct dcons_softc *dc;
584 dev = make_dev(&dcons_cdevsw, port,
585 UID_ROOT, GID_WHEEL, 0600, name);
586 dc->dev = (void *)dev;
589 dev->si_drv1 = (void *)dc;
592 tp->t_oproc = dcons_tty_start;
593 tp->t_param = dcons_tty_param;
594 tp->t_stop = nottystop;
606 cdevsw_add(&dcons_cdevsw, -1, 0);
608 dcons_attach_port(DCONS_CON, "dcons", 0);
609 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
610 #if __FreeBSD_version < 500000
611 callout_init(&dcons_callout);
613 callout_init(&dcons_callout, 0);
615 polltime = hz / poll_hz;
618 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
623 dcons_detach(int port)
626 struct dcons_softc *dc;
630 tp = ((DEV)dc->dev)->si_tty;
632 if (tp->t_state & TS_ISOPEN) {
633 printf("dcons: still opened\n");
634 #if __FreeBSD_version < 502113
635 (*linesw[tp->t_line].l_close)(tp, 0);
646 * must wait until all device are closed.
649 tsleep((void *)dc, 0, "dcodtc", hz/4);
651 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
653 destroy_dev(dc->dev);
659 /* cnXXX works only for FreeBSD-5 */
661 dcons_modevent(module_t mode, int type, void *data)
667 ret = dcons_drv_init(1);
669 #if __FreeBSD_version >= 500000
671 dcons_cnprobe(&dcons_consdev);
672 dcons_cninit(&dcons_consdev);
673 cnadd(&dcons_consdev);
678 printf("dcons: unload\n");
679 callout_stop(&dcons_callout);
680 #if __FreeBSD_version < 502122
681 #if defined(DDB) && DCONS_FORCE_GDB
689 #if __FreeBSD_version >= 500000
690 cnremove(&dcons_consdev);
692 dcons_detach(DCONS_CON);
693 dcons_detach(DCONS_GDB);
696 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
709 #if __FreeBSD_version >= 502122
710 /* Debugger interface */
713 dcons_dbg_probe(void)
715 return(DCONS_FORCE_GDB);
729 dcons_dbg_putc(int c)
731 struct dcons_softc *dc = &sc[DCONS_GDB];
732 dcons_os_putc(dc, c);
736 dcons_dbg_checkc(void)
738 struct dcons_softc *dc = &sc[DCONS_GDB];
739 return (dcons_os_checkc(dc));
745 struct dcons_softc *dc = &sc[DCONS_GDB];
746 return (dcons_os_getc(dc));
750 DEV_MODULE(dcons, dcons_modevent, NULL);
751 MODULE_VERSION(dcons, DCONS_VERSION);