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
34 * $FreeBSD: src/sys/dev/dcons/dcons_os.c,v 1.4 2004/10/24 12:41:04 simokawa Exp $
35 * $DragonFly: src/sys/dev/misc/dcons/dcons_os.c,v 1.13 2007/08/07 13:14:11 hasso Exp $
38 #include <sys/param.h>
39 #if __FreeBSD_version >= 502122
43 #include <sys/kernel.h>
44 #include <sys/module.h>
45 #include <sys/systm.h>
46 #include <sys/types.h>
49 #include <sys/consio.h>
51 #include <sys/malloc.h>
53 #include <sys/thread2.h>
54 #include <sys/ucred.h>
61 #include <sys/reboot.h>
63 #include <sys/sysctl.h>
66 #include <vm/vm_param.h>
70 #include "opt_comconsole.h"
71 #include "opt_dcons.h"
74 #define DCONS_POLL_HZ 100
77 #ifndef DCONS_BUF_SIZE
78 #define DCONS_BUF_SIZE (16*1024)
81 #ifndef DCONS_FORCE_CONSOLE
82 #define DCONS_FORCE_CONSOLE 0 /* Mostly for FreeBSD-4/DragonFly */
85 #ifndef DCONS_FORCE_GDB
86 #define DCONS_FORCE_GDB 1
89 #define CDEV_MAJOR 184
91 static d_open_t dcons_open;
92 static d_close_t dcons_close;
93 static d_ioctl_t dcons_ioctl;
95 static struct dev_ops dcons_ops = {
96 { "dcons", CDEV_MAJOR, D_TTY },
98 .d_close = dcons_close,
101 .d_ioctl = dcons_ioctl,
106 static char bssbuf[DCONS_BUF_SIZE]; /* buf in bss */
110 static struct dcons_global dg;
111 struct dcons_global *dcons_conf;
112 static int poll_hz = DCONS_POLL_HZ;
114 static struct dcons_softc sc[DCONS_NPORT];
116 SYSCTL_NODE(_kern, OID_AUTO, dcons, CTLFLAG_RD, 0, "Dumb Console");
117 SYSCTL_INT(_kern_dcons, OID_AUTO, poll_hz, CTLFLAG_RW, &poll_hz, 0,
118 "dcons polling rate");
120 static int drv_init = 0;
121 static struct callout dcons_callout;
122 struct dcons_buf *dcons_buf; /* for local dconschat */
126 #define THREAD d_thread_t
127 #elif __FreeBSD_version < 500000
129 #define THREAD struct proc
131 #define DEV struct cdev *
132 #define THREAD struct thread
136 static void dcons_tty_start(struct tty *);
137 static int dcons_tty_param(struct tty *, struct termios *);
138 static void dcons_timeout(void *);
139 static int dcons_drv_init(int);
141 static cn_probe_t dcons_cnprobe;
142 static cn_init_t dcons_cninit;
143 static cn_init_fini_t dcons_cninit_fini;
144 static cn_getc_t dcons_cngetc;
145 static cn_checkc_t dcons_cncheckc;
146 static cn_putc_t dcons_cnputc;
148 CONS_DRIVER(dcons, dcons_cnprobe, dcons_cninit, dcons_cninit_fini,
149 NULL, dcons_cngetc, dcons_cncheckc, dcons_cnputc, NULL);
151 #if __FreeBSD_version >= 502122
152 static gdb_probe_f dcons_dbg_probe;
153 static gdb_init_f dcons_dbg_init;
154 static gdb_term_f dcons_dbg_term;
155 static gdb_getc_f dcons_dbg_getc;
156 static gdb_checkc_f dcons_dbg_checkc;
157 static gdb_putc_f dcons_dbg_putc;
159 GDB_DBGPORT(dcons, dcons_dbg_probe, dcons_dbg_init, dcons_dbg_term,
160 dcons_dbg_checkc, dcons_dbg_getc, dcons_dbg_putc);
162 extern struct gdb_dbgport *gdb_cur;
165 #if (KDB || DDB) && ALT_BREAK_TO_DEBUGGER
167 dcons_check_break(struct dcons_softc *dc, int c)
172 #if __FreeBSD_version >= 502122
173 if (kdb_alt_break(c, &dc->brk_state)) {
174 if ((dc->flags & DC_GDB) != 0) {
175 if (gdb_cur == &dcons_gdb_dbgport) {
176 kdb_dbbe_select("gdb");
183 switch (dc->brk_state) {
186 dc->brk_state = STATE2;
188 dc->brk_state = STATE0;
191 dc->brk_state = STATE0;
192 if (c == KEY_CTRLB) {
194 if (dc->flags & DC_GDB)
201 dc->brk_state = STATE1;
206 #define dcons_check_break(dc, c) (c)
210 dcons_os_checkc(struct dcons_softc *dc)
214 if (dg.dma_tag != NULL)
215 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
217 c = dcons_check_break(dc, dcons_checkc(dc));
219 if (dg.dma_tag != NULL)
220 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
226 dcons_os_getc(struct dcons_softc *dc)
230 while ((c = dcons_os_checkc(dc)) == -1);
236 dcons_os_putc(struct dcons_softc *dc, int c)
238 if (dg.dma_tag != NULL)
239 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
243 if (dg.dma_tag != NULL)
244 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
247 dcons_open(struct dev_open_args *ap)
249 cdev_t dev = ap->a_head.a_dev;
257 tp = dev->si_tty = ttymalloc(dev->si_tty);
258 tp->t_oproc = dcons_tty_start;
259 tp->t_param = dcons_tty_param;
260 tp->t_stop = nottystop;
266 if ((tp->t_state & TS_ISOPEN) == 0) {
267 tp->t_state |= TS_CARR_ON;
269 tp->t_iflag = TTYDEF_IFLAG;
270 tp->t_oflag = TTYDEF_OFLAG;
271 tp->t_cflag = TTYDEF_CFLAG|CLOCAL;
272 tp->t_lflag = TTYDEF_LFLAG;
273 tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
275 } else if ((tp->t_state & TS_XCLUDE) && suser_cred(ap->a_cred, 0)) {
281 #if __FreeBSD_version < 502113
282 error = (*linesw[tp->t_line].l_open)(dev, tp);
284 error = ttyld_open(tp, dev);
291 dcons_close(struct dev_close_args *ap)
293 cdev_t dev = ap->a_head.a_dev;
302 if (tp->t_state & TS_ISOPEN) {
303 (*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
311 dcons_ioctl(struct dev_ioctl_args *ap)
313 cdev_t dev = ap->a_head.a_dev;
323 error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data, ap->a_fflag, ap->a_cred);
324 if (error != ENOIOCTL)
327 error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
328 if (error != ENOIOCTL)
335 dcons_tty_param(struct tty *tp, struct termios *t)
337 tp->t_ispeed = t->c_ispeed;
338 tp->t_ospeed = t->c_ospeed;
339 tp->t_cflag = t->c_cflag;
344 dcons_tty_start(struct tty *tp)
346 struct dcons_softc *dc;
348 dc = (struct dcons_softc *)tp->t_dev->si_drv1;
350 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
355 tp->t_state |= TS_BUSY;
356 while (tp->t_outq.c_cc != 0)
357 dcons_os_putc(dc, clist_getc(&tp->t_outq));
358 tp->t_state &= ~TS_BUSY;
365 dcons_timeout(void *v)
368 struct dcons_softc *dc;
371 for (i = 0; i < DCONS_NPORT; i ++) {
373 tp = ((DEV)dc->dev)->si_tty;
374 while ((c = dcons_os_checkc(dc)) != -1)
375 if (tp->t_state & TS_ISOPEN)
376 #if __FreeBSD_version < 502113
377 (*linesw[tp->t_line].l_rint)(c, tp);
382 polltime = hz / poll_hz;
385 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
389 dcons_cnprobe(struct consdev *cp)
392 cp->cn_probegood = 1;
393 #elif __FreeBSD_version >= 501109
394 ksprintf(cp->cn_name, "dcons");
396 cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
398 #if DCONS_FORCE_CONSOLE
399 cp->cn_pri = CN_REMOTE;
401 cp->cn_pri = CN_NORMAL;
406 dcons_cninit(struct consdev *cp)
414 = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
418 dcons_cninit_fini(struct consdev *cp)
420 cp->cn_dev = make_dev(&dcons_ops, DCONS_CON,
421 UID_ROOT, GID_WHEEL, 0600, "dcons");
426 dcons_cngetc(struct consdev *cp)
428 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
429 return (dcons_os_getc(dc));
432 dcons_cncheckc(struct consdev *cp)
434 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
435 return (dcons_os_checkc(dc));
438 dcons_cnputc(struct consdev *cp, int c)
440 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
441 dcons_os_putc(dc, c);
445 dcons_cngetc(void *private)
447 struct dcons_softc *dc = (struct dcons_softc *)private;
448 return (dcons_os_getc(dc));
451 dcons_cncheckc(void *private)
453 struct dcons_softc *dc = (struct dcons_softc *)private;
454 return (dcons_os_checkc(dc));
457 dcons_cnputc(void *private, int c)
459 struct dcons_softc *dc = (struct dcons_softc *)private;
460 dcons_os_putc(dc, c);
465 dcons_drv_init(int stage)
476 bzero(&dg, sizeof(dg));
478 dg.cdev = &dcons_consdev;
480 dg.size = DCONS_BUF_SIZE;
483 if (kgetenv_quad("dcons.addr", &addr) > 0 &&
484 kgetenv_quad("dcons.size", &size) > 0) {
487 * Allow read/write access to dcons buffer.
489 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
490 pmap_kmodify_rw((vm_offset_t)(KERNBASE + pa));
493 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
495 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
503 if (stage == 0) { /* XXX or cold */
505 * DCONS_FORCE_CONSOLE == 1 and statically linked.
506 * called from cninit(). can't use contigmalloc yet .
508 dg.buf = (struct dcons_buf *) bssbuf;
509 dcons_init(dg.buf, dg.size, sc);
514 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
515 * if the module is loaded after boot,
516 * bssbuf could be non-continuous.
518 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
519 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
520 dcons_init(dg.buf, dg.size, sc);
526 #if DDB && DCONS_FORCE_GDB
527 if (gdb_tab == NULL) {
528 gdb_tab = &dcons_consdev;
529 dcons_consdev.cn_gdbprivate = &sc[DCONS_GDB];
539 dcons_attach_port(int port, char *name, int flags)
541 struct dcons_softc *dc;
547 dev = make_dev(&dcons_ops, port,
548 UID_ROOT, GID_WHEEL, 0600, name);
549 dc->dev = (void *)dev;
550 tp = ttymalloc(NULL);
552 dev->si_drv1 = (void *)dc;
555 tp->t_oproc = dcons_tty_start;
556 tp->t_param = dcons_tty_param;
557 tp->t_stop = nottystop;
569 dev_ops_add(&dcons_ops, -1, 0);
571 dcons_attach_port(DCONS_CON, "dcons", 0);
572 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
573 #if __FreeBSD_version < 500000
574 callout_init(&dcons_callout);
576 callout_init(&dcons_callout, 0);
578 polltime = hz / poll_hz;
581 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
586 dcons_detach(int port)
589 struct dcons_softc *dc;
593 tp = ((DEV)dc->dev)->si_tty;
595 if (tp->t_state & TS_ISOPEN) {
596 kprintf("dcons: still opened\n");
597 #if __FreeBSD_version < 502113
598 (*linesw[tp->t_line].l_close)(tp, 0);
606 * must wait until all device are closed.
609 tsleep((void *)dc, 0, "dcodtc", hz/4);
611 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
613 destroy_dev(dc->dev);
619 /* cnXXX works only for FreeBSD-5 */
621 dcons_modevent(module_t mode, int type, void *data)
627 ret = dcons_drv_init(1);
629 #if __FreeBSD_version >= 500000
631 dcons_cnprobe(&dcons_consdev);
632 dcons_cninit(&dcons_consdev);
633 cnadd(&dcons_consdev);
638 kprintf("dcons: unload\n");
639 callout_stop(&dcons_callout);
640 #if __FreeBSD_version < 502122
641 #if DDB && DCONS_FORCE_GDB
645 if (gdb_tab == &dcons_consdev)
650 #if __FreeBSD_version >= 500000
651 cnremove(&dcons_consdev);
653 dcons_detach(DCONS_CON);
654 dcons_detach(DCONS_GDB);
657 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
670 #if __FreeBSD_version >= 502122
671 /* Debugger interface */
674 dcons_dbg_probe(void)
676 return(DCONS_FORCE_GDB);
690 dcons_dbg_putc(int c)
692 struct dcons_softc *dc = &sc[DCONS_GDB];
693 dcons_os_putc(dc, c);
697 dcons_dbg_checkc(void)
699 struct dcons_softc *dc = &sc[DCONS_GDB];
700 return (dcons_os_checkc(dc));
706 struct dcons_softc *dc = &sc[DCONS_GDB];
707 return (dcons_os_getc(dc));
711 DEV_MODULE(dcons, dcons_modevent, NULL);
712 MODULE_VERSION(dcons, DCONS_VERSION);