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>
54 #include <sys/thread2.h>
55 #include <sys/ucred.h>
62 #include <sys/reboot.h>
64 #include <sys/sysctl.h>
67 #include <vm/vm_param.h>
71 #include "opt_comconsole.h"
72 #include "opt_dcons.h"
75 #define DCONS_POLL_HZ 100
78 #ifndef DCONS_BUF_SIZE
79 #define DCONS_BUF_SIZE (16*1024)
82 #ifndef DCONS_FORCE_CONSOLE
83 #define DCONS_FORCE_CONSOLE 0 /* Mostly for FreeBSD-4/DragonFly */
86 #ifndef DCONS_FORCE_GDB
87 #define DCONS_FORCE_GDB 1
90 #define CDEV_MAJOR 184
92 static d_open_t dcons_open;
93 static d_close_t dcons_close;
94 static d_ioctl_t dcons_ioctl;
96 static struct dev_ops dcons_ops = {
97 { "dcons", CDEV_MAJOR, D_TTY },
99 .d_close = dcons_close,
102 .d_ioctl = dcons_ioctl,
104 .d_revoke = ttyrevoke
108 static char bssbuf[DCONS_BUF_SIZE]; /* buf in bss */
112 static struct dcons_global dg;
113 struct dcons_global *dcons_conf;
114 static int poll_hz = DCONS_POLL_HZ;
116 static struct dcons_softc sc[DCONS_NPORT];
118 SYSCTL_NODE(_kern, OID_AUTO, dcons, CTLFLAG_RD, 0, "Dumb Console");
119 SYSCTL_INT(_kern_dcons, OID_AUTO, poll_hz, CTLFLAG_RW, &poll_hz, 0,
120 "dcons polling rate");
122 static int drv_init = 0;
123 static struct callout dcons_callout;
124 struct dcons_buf *dcons_buf; /* for local dconschat */
128 #define THREAD d_thread_t
129 #elif __FreeBSD_version < 500000
131 #define THREAD struct proc
133 #define DEV struct cdev *
134 #define THREAD struct thread
138 static void dcons_tty_start(struct tty *);
139 static int dcons_tty_param(struct tty *, struct termios *);
140 static void dcons_timeout(void *);
141 static int dcons_drv_init(int);
143 static cn_probe_t dcons_cnprobe;
144 static cn_init_t dcons_cninit;
145 static cn_init_fini_t dcons_cninit_fini;
146 static cn_getc_t dcons_cngetc;
147 static cn_checkc_t dcons_cncheckc;
148 static cn_putc_t dcons_cnputc;
150 CONS_DRIVER(dcons, dcons_cnprobe, dcons_cninit, dcons_cninit_fini,
151 NULL, dcons_cngetc, dcons_cncheckc, dcons_cnputc, NULL);
153 #if __FreeBSD_version >= 502122
154 static gdb_probe_f dcons_dbg_probe;
155 static gdb_init_f dcons_dbg_init;
156 static gdb_term_f dcons_dbg_term;
157 static gdb_getc_f dcons_dbg_getc;
158 static gdb_checkc_f dcons_dbg_checkc;
159 static gdb_putc_f dcons_dbg_putc;
161 GDB_DBGPORT(dcons, dcons_dbg_probe, dcons_dbg_init, dcons_dbg_term,
162 dcons_dbg_checkc, dcons_dbg_getc, dcons_dbg_putc);
164 extern struct gdb_dbgport *gdb_cur;
167 #if (KDB || DDB) && ALT_BREAK_TO_DEBUGGER
169 dcons_check_break(struct dcons_softc *dc, int c)
174 #if __FreeBSD_version >= 502122
175 if (kdb_alt_break(c, &dc->brk_state)) {
176 if ((dc->flags & DC_GDB) != 0) {
177 if (gdb_cur == &dcons_gdb_dbgport) {
178 kdb_dbbe_select("gdb");
185 switch (dc->brk_state) {
188 dc->brk_state = STATE2;
190 dc->brk_state = STATE0;
193 dc->brk_state = STATE0;
194 if (c == KEY_CTRLB) {
196 if (dc->flags & DC_GDB)
203 dc->brk_state = STATE1;
208 #define dcons_check_break(dc, c) (c)
212 dcons_os_checkc(struct dcons_softc *dc)
216 if (dg.dma_tag != NULL)
217 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
219 c = dcons_check_break(dc, dcons_checkc(dc));
221 if (dg.dma_tag != NULL)
222 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
228 dcons_os_getc(struct dcons_softc *dc)
232 while ((c = dcons_os_checkc(dc)) == -1);
238 dcons_os_putc(struct dcons_softc *dc, int c)
240 if (dg.dma_tag != NULL)
241 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
245 if (dg.dma_tag != NULL)
246 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
249 dcons_open(struct dev_open_args *ap)
251 cdev_t dev = ap->a_head.a_dev;
259 tp = dev->si_tty = ttymalloc(dev->si_tty);
260 tp->t_oproc = dcons_tty_start;
261 tp->t_param = dcons_tty_param;
262 tp->t_stop = nottystop;
268 if ((tp->t_state & TS_ISOPEN) == 0) {
269 tp->t_state |= TS_CARR_ON;
271 tp->t_iflag = TTYDEF_IFLAG;
272 tp->t_oflag = TTYDEF_OFLAG;
273 tp->t_cflag = TTYDEF_CFLAG|CLOCAL;
274 tp->t_lflag = TTYDEF_LFLAG;
275 tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
277 } else if ((tp->t_state & TS_XCLUDE) && priv_check_cred(ap->a_cred, PRIV_ROOT, 0)) {
283 #if __FreeBSD_version < 502113
284 error = (*linesw[tp->t_line].l_open)(dev, tp);
286 error = ttyld_open(tp, dev);
293 dcons_close(struct dev_close_args *ap)
295 cdev_t dev = ap->a_head.a_dev;
304 if (tp->t_state & TS_ISOPEN) {
305 (*linesw[tp->t_line].l_close)(tp, ap->a_fflag);
313 dcons_ioctl(struct dev_ioctl_args *ap)
315 cdev_t dev = ap->a_head.a_dev;
325 error = (*linesw[tp->t_line].l_ioctl)(tp, ap->a_cmd, ap->a_data, ap->a_fflag, ap->a_cred);
326 if (error != ENOIOCTL)
329 error = ttioctl(tp, ap->a_cmd, ap->a_data, ap->a_fflag);
330 if (error != ENOIOCTL)
337 dcons_tty_param(struct tty *tp, struct termios *t)
339 tp->t_ispeed = t->c_ispeed;
340 tp->t_ospeed = t->c_ospeed;
341 tp->t_cflag = t->c_cflag;
346 dcons_tty_start(struct tty *tp)
348 struct dcons_softc *dc;
350 dc = (struct dcons_softc *)tp->t_dev->si_drv1;
352 if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
357 tp->t_state |= TS_BUSY;
358 while (tp->t_outq.c_cc != 0)
359 dcons_os_putc(dc, clist_getc(&tp->t_outq));
360 tp->t_state &= ~TS_BUSY;
367 dcons_timeout(void *v)
370 struct dcons_softc *dc;
373 for (i = 0; i < DCONS_NPORT; i ++) {
375 tp = ((DEV)dc->dev)->si_tty;
376 while ((c = dcons_os_checkc(dc)) != -1)
377 if (tp->t_state & TS_ISOPEN)
378 #if __FreeBSD_version < 502113
379 (*linesw[tp->t_line].l_rint)(c, tp);
384 polltime = hz / poll_hz;
387 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
391 dcons_cnprobe(struct consdev *cp)
394 cp->cn_probegood = 1;
395 #elif __FreeBSD_version >= 501109
396 ksprintf(cp->cn_name, "dcons");
398 cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
400 #if DCONS_FORCE_CONSOLE
401 cp->cn_pri = CN_REMOTE;
403 cp->cn_pri = CN_NORMAL;
408 dcons_cninit(struct consdev *cp)
416 = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
420 dcons_cninit_fini(struct consdev *cp)
422 cp->cn_dev = make_dev(&dcons_ops, DCONS_CON,
423 UID_ROOT, GID_WHEEL, 0600, "dcons");
428 dcons_cngetc(struct consdev *cp)
430 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
431 return (dcons_os_getc(dc));
434 dcons_cncheckc(struct consdev *cp)
436 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
437 return (dcons_os_checkc(dc));
440 dcons_cnputc(struct consdev *cp, int c)
442 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
443 dcons_os_putc(dc, c);
447 dcons_cngetc(void *private)
449 struct dcons_softc *dc = (struct dcons_softc *)private;
450 return (dcons_os_getc(dc));
453 dcons_cncheckc(void *private)
455 struct dcons_softc *dc = (struct dcons_softc *)private;
456 return (dcons_os_checkc(dc));
459 dcons_cnputc(void *private, int c)
461 struct dcons_softc *dc = (struct dcons_softc *)private;
462 dcons_os_putc(dc, c);
467 dcons_drv_init(int stage)
478 bzero(&dg, sizeof(dg));
480 dg.cdev = &dcons_consdev;
482 dg.size = DCONS_BUF_SIZE;
485 if (kgetenv_quad("dcons.addr", &addr) > 0 &&
486 kgetenv_quad("dcons.size", &size) > 0) {
489 * Allow read/write access to dcons buffer.
491 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
492 pmap_kmodify_rw((vm_offset_t)(KERNBASE + pa));
495 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
497 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
505 if (stage == 0) { /* XXX or cold */
507 * DCONS_FORCE_CONSOLE == 1 and statically linked.
508 * called from cninit(). can't use contigmalloc yet .
510 dg.buf = (struct dcons_buf *) bssbuf;
511 dcons_init(dg.buf, dg.size, sc);
516 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
517 * if the module is loaded after boot,
518 * bssbuf could be non-continuous.
520 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
521 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
522 dcons_init(dg.buf, dg.size, sc);
528 #if DDB && DCONS_FORCE_GDB
529 if (gdb_tab == NULL) {
530 gdb_tab = &dcons_consdev;
531 dcons_consdev.cn_gdbprivate = &sc[DCONS_GDB];
541 dcons_attach_port(int port, char *name, int flags)
543 struct dcons_softc *dc;
549 dev = make_dev(&dcons_ops, port,
550 UID_ROOT, GID_WHEEL, 0600, name);
551 dc->dev = (void *)dev;
552 tp = ttymalloc(NULL);
554 dev->si_drv1 = (void *)dc;
557 tp->t_oproc = dcons_tty_start;
558 tp->t_param = dcons_tty_param;
559 tp->t_stop = nottystop;
570 dcons_attach_port(DCONS_CON, "dcons", 0);
571 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
572 #if __FreeBSD_version < 500000
573 callout_init(&dcons_callout);
575 callout_init(&dcons_callout, 0);
577 polltime = hz / poll_hz;
580 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
585 dcons_detach(int port)
588 struct dcons_softc *dc;
592 tp = ((DEV)dc->dev)->si_tty;
594 if (tp->t_state & TS_ISOPEN) {
595 kprintf("dcons: still opened\n");
596 #if __FreeBSD_version < 502113
597 (*linesw[tp->t_line].l_close)(tp, 0);
605 * must wait until all device are closed.
608 tsleep((void *)dc, 0, "dcodtc", hz/4);
610 tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
612 destroy_dev(dc->dev);
618 /* cnXXX works only for FreeBSD-5 */
620 dcons_modevent(module_t mode, int type, void *data)
626 ret = dcons_drv_init(1);
628 #if __FreeBSD_version >= 500000
630 dcons_cnprobe(&dcons_consdev);
631 dcons_cninit(&dcons_consdev);
632 cnadd(&dcons_consdev);
637 kprintf("dcons: unload\n");
638 callout_stop(&dcons_callout);
639 #if __FreeBSD_version < 502122
640 #if DDB && DCONS_FORCE_GDB
644 if (gdb_tab == &dcons_consdev)
649 #if __FreeBSD_version >= 500000
650 cnremove(&dcons_consdev);
652 dcons_detach(DCONS_CON);
653 dcons_detach(DCONS_GDB);
656 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
669 #if __FreeBSD_version >= 502122
670 /* Debugger interface */
673 dcons_dbg_probe(void)
675 return(DCONS_FORCE_GDB);
689 dcons_dbg_putc(int c)
691 struct dcons_softc *dc = &sc[DCONS_GDB];
692 dcons_os_putc(dc, c);
696 dcons_dbg_checkc(void)
698 struct dcons_softc *dc = &sc[DCONS_GDB];
699 return (dcons_os_checkc(dc));
705 struct dcons_softc *dc = &sc[DCONS_GDB];
706 return (dcons_os_getc(dc));
710 DEV_MODULE(dcons, dcons_modevent, NULL);
711 MODULE_VERSION(dcons, DCONS_VERSION);