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>
75 #include "opt_comconsole.h"
76 #include "opt_dcons.h"
79 #define DCONS_POLL_HZ 100
82 #ifndef DCONS_BUF_SIZE
83 #define DCONS_BUF_SIZE (16*1024)
86 #ifndef DCONS_FORCE_CONSOLE
87 #define DCONS_FORCE_CONSOLE 0 /* Mostly for FreeBSD-4/DragonFly */
90 #ifndef DCONS_FORCE_GDB
91 #define DCONS_FORCE_GDB 1
94 #if __FreeBSD_version >= 500101
96 #if __FreeBSD_version < 502122
97 static struct consdev gdbconsdev;
101 static d_open_t dcons_open;
102 static d_close_t dcons_close;
103 #if defined(__DragonFly__) || __FreeBSD_version < 500104
104 static d_ioctl_t dcons_ioctl;
107 static struct cdevsw dcons_cdevsw = {
109 #define CDEV_MAJOR 184
110 "dcons", CDEV_MAJOR, D_TTY, NULL, 0,
111 dcons_open, dcons_close, ttyread, ttywrite, dcons_ioctl,
112 ttypoll, nommap, nostrategy, nodump, nopsize,
113 #elif __FreeBSD_version >= 500104
114 .d_version = D_VERSION,
115 .d_open = dcons_open,
116 .d_close = dcons_close,
118 .d_flags = D_TTY | D_NEEDGIANT,
120 #define CDEV_MAJOR 184
121 /* open */ dcons_open,
122 /* close */ dcons_close,
124 /* write */ ttywrite,
125 /* ioctl */ dcons_ioctl,
128 /* strategy */ nostrategy,
130 /* major */ CDEV_MAJOR,
138 static char bssbuf[DCONS_BUF_SIZE]; /* buf in bss */
142 static struct dcons_global dg;
143 struct dcons_global *dcons_conf;
144 static int poll_hz = DCONS_POLL_HZ;
146 static struct dcons_softc sc[DCONS_NPORT];
148 SYSCTL_NODE(_kern, OID_AUTO, dcons, CTLFLAG_RD, 0, "Dumb Console");
149 SYSCTL_INT(_kern_dcons, OID_AUTO, poll_hz, CTLFLAG_RW, &poll_hz, 0,
150 "dcons polling rate");
152 static int drv_init = 0;
153 static struct callout dcons_callout;
154 struct dcons_buf *dcons_buf; /* for local dconschat */
158 #define THREAD d_thread_t
159 #elif __FreeBSD_version < 500000
161 #define THREAD struct proc
163 #define DEV struct cdev *
164 #define THREAD struct thread
168 static void dcons_tty_start(struct tty *);
169 static int dcons_tty_param(struct tty *, struct termios *);
170 static void dcons_timeout(void *);
171 static int dcons_drv_init(int);
173 static cn_probe_t dcons_cnprobe;
174 static cn_init_t dcons_cninit;
175 static cn_term_t dcons_cnterm;
176 static cn_getc_t dcons_cngetc;
177 static cn_putc_t dcons_cnputc;
179 CONSOLE_DRIVER(dcons);
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_putc_f dcons_dbg_putc;
188 GDB_DBGPORT(dcons, dcons_dbg_probe, dcons_dbg_init, dcons_dbg_term,
189 dcons_dbg_getc, dcons_dbg_putc);
191 extern struct gdb_dbgport *gdb_cur;
194 #if (defined(KDB) || defined(DDB)) && defined(ALT_BREAK_TO_DEBUGGER)
196 dcons_check_break(struct dcons_softc *dc, int c)
201 #if __FreeBSD_version >= 502122
202 if (kdb_alt_break(c, &dc->brk_state)) {
203 if ((dc->flags & DC_GDB) != 0) {
204 if (gdb_cur == &dcons_gdb_dbgport) {
205 kdb_dbbe_select("gdb");
212 switch (dc->brk_state) {
215 dc->brk_state = STATE2;
217 dc->brk_state = STATE0;
220 dc->brk_state = STATE0;
221 if (c == KEY_CTRLB) {
223 if (dc->flags & DC_GDB)
230 dc->brk_state = STATE1;
235 #define dcons_check_break(dc, c) (c)
239 dcons_os_checkc(struct dcons_softc *dc)
243 if (dg.dma_tag != NULL)
244 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
246 c = dcons_check_break(dc, dcons_checkc(dc));
248 if (dg.dma_tag != NULL)
249 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
255 dcons_os_getc(struct dcons_softc *dc)
259 while ((c = dcons_os_checkc(dc)) == -1);
265 dcons_os_putc(struct dcons_softc *dc, int c)
267 if (dg.dma_tag != NULL)
268 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
272 if (dg.dma_tag != NULL)
273 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
276 dcons_open(DEV dev, int flag, int mode, THREAD *td)
286 tp->t_oproc = dcons_tty_start;
287 tp->t_param = dcons_tty_param;
288 tp->t_stop = nottystop;
294 if ((tp->t_state & TS_ISOPEN) == 0) {
295 tp->t_state |= TS_CARR_ON;
296 ttyconsolemode(tp, 0);
297 } else if ((tp->t_state & TS_XCLUDE) &&
298 priv_check(td, PRIV_TTY_EXCLUSIVE)) {
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 */
448 dcons_cnterm(struct consdev *cp)
454 dcons_cngetc(struct consdev *cp)
456 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
457 return (dcons_os_checkc(dc));
460 dcons_cnputc(struct consdev *cp, int c)
462 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
463 dcons_os_putc(dc, c);
467 dcons_cngetc(DEV dev)
469 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
470 return (dcons_os_getc(dc));
473 dcons_cncheckc(DEV dev)
475 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
476 return (dcons_os_checkc(dc));
479 dcons_cnputc(DEV dev, int c)
481 struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
482 dcons_os_putc(dc, c);
487 dcons_drv_init(int stage)
489 #if defined(__i386__) || defined(__amd64__)
498 bzero(&dg, sizeof(dg));
500 dg.cdev = &dcons_consdev;
502 dg.size = DCONS_BUF_SIZE;
504 #if defined(__i386__) || defined(__amd64__)
505 if (getenv_quad("dcons.addr", &addr) > 0 &&
506 getenv_quad("dcons.size", &size) > 0) {
510 * Allow read/write access to dcons buffer.
512 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
513 *vtopte(KERNBASE + pa) |= PG_RW;
517 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
519 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
527 if (stage == 0) { /* XXX or cold */
529 * DCONS_FORCE_CONSOLE == 1 and statically linked.
530 * called from cninit(). can't use contigmalloc yet .
532 dg.buf = (struct dcons_buf *) bssbuf;
533 dcons_init(dg.buf, dg.size, sc);
538 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
539 * if the module is loaded after boot,
540 * bssbuf could be non-continuous.
542 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
543 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
544 dcons_init(dg.buf, dg.size, sc);
550 #if __FreeBSD_version < 502122
551 #if defined(DDB) && DCONS_FORCE_GDB
553 gdbconsdev.cn_arg = (void *)&sc[DCONS_GDB];
554 #if __FreeBSD_version >= 501109
555 sprintf(gdbconsdev.cn_name, "dgdb");
557 gdb_arg = &gdbconsdev;
558 #elif defined(__DragonFly__)
559 gdbdev = make_dev(&dcons_cdevsw, DCONS_GDB,
560 UID_ROOT, GID_WHEEL, 0600, "dgdb");
562 gdbdev = makedev(CDEV_MAJOR, DCONS_GDB);
564 gdb_getc = dcons_cngetc;
565 gdb_putc = dcons_cnputc;
575 dcons_attach_port(int port, char *name, int flags)
577 struct dcons_softc *dc;
583 dev = make_dev(&dcons_cdevsw, port,
584 UID_ROOT, GID_WHEEL, 0600, name);
585 dc->dev = (void *)dev;
588 dev->si_drv1 = (void *)dc;
591 tp->t_oproc = dcons_tty_start;
592 tp->t_param = dcons_tty_param;
593 tp->t_stop = nottystop;
605 cdevsw_add(&dcons_cdevsw, -1, 0);
607 dcons_attach_port(DCONS_CON, "dcons", 0);
608 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
609 #if __FreeBSD_version < 500000
610 callout_init(&dcons_callout);
612 callout_init(&dcons_callout, 0);
614 polltime = hz / poll_hz;
617 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
622 dcons_detach(int port)
625 struct dcons_softc *dc;
629 tp = ((DEV)dc->dev)->si_tty;
631 if (tp->t_state & TS_ISOPEN) {
632 printf("dcons: still opened\n");
633 #if __FreeBSD_version < 502113
634 (*linesw[tp->t_line].l_close)(tp, 0);
645 * must wait until all device are closed.
648 tsleep((void *)dc, 0, "dcodtc", hz/4);
650 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
652 destroy_dev(dc->dev);
658 /* cnXXX works only for FreeBSD-5 */
660 dcons_modevent(module_t mode, int type, void *data)
666 ret = dcons_drv_init(1);
668 #if __FreeBSD_version >= 500000
670 dcons_cnprobe(&dcons_consdev);
671 dcons_cninit(&dcons_consdev);
672 cnadd(&dcons_consdev);
677 printf("dcons: unload\n");
678 callout_stop(&dcons_callout);
679 #if __FreeBSD_version < 502122
680 #if defined(DDB) && DCONS_FORCE_GDB
688 #if __FreeBSD_version >= 500000
689 cnremove(&dcons_consdev);
691 dcons_detach(DCONS_CON);
692 dcons_detach(DCONS_GDB);
695 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
708 #if __FreeBSD_version >= 502122
709 /* Debugger interface */
712 dcons_dbg_probe(void)
714 return(DCONS_FORCE_GDB);
728 dcons_dbg_putc(int c)
730 struct dcons_softc *dc = &sc[DCONS_GDB];
731 dcons_os_putc(dc, c);
737 struct dcons_softc *dc = &sc[DCONS_GDB];
738 return (dcons_os_getc(dc));
742 DEV_MODULE(dcons, dcons_modevent, NULL);
743 MODULE_VERSION(dcons, DCONS_VERSION);