2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (C) 2003,2004
5 * Hidetoshi Shimokawa. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
18 * This product includes software developed by Hidetoshi Shimokawa.
20 * 4. Neither the name of the author nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 #include <sys/param.h>
40 #include <sys/eventhandler.h>
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/ucred.h>
56 #include <machine/atomic.h>
57 #include <machine/bus.h>
59 #include <dev/dcons/dcons.h>
60 #include <dev/dcons/dcons_os.h>
63 #include <sys/reboot.h>
65 #include <sys/sysctl.h>
68 #include <vm/vm_param.h>
71 #include "opt_dcons.h"
78 #define DCONS_POLL_HZ 25
81 #ifndef DCONS_POLL_IDLE
82 #define DCONS_POLL_IDLE 256
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 */
94 static char bssbuf[DCONS_BUF_SIZE]; /* buf in bss */
98 static struct dcons_global dg;
99 struct dcons_global *dcons_conf;
100 static int poll_hz = DCONS_POLL_HZ;
101 static u_int poll_idle = DCONS_POLL_HZ * DCONS_POLL_IDLE;
103 static struct dcons_softc sc[DCONS_NPORT];
105 static SYSCTL_NODE(_kern, OID_AUTO, dcons, CTLFLAG_RD, 0, "Dumb Console");
106 SYSCTL_INT(_kern_dcons, OID_AUTO, poll_hz, CTLFLAG_RW, &poll_hz, 0,
107 "dcons polling rate");
109 static int drv_init = 0;
110 static struct callout dcons_callout;
111 struct dcons_buf *dcons_buf; /* for local dconschat */
113 static void dcons_timeout(void *);
114 static int dcons_drv_init(int);
116 static cn_probe_t dcons_cnprobe;
117 static cn_init_t dcons_cninit;
118 static cn_term_t dcons_cnterm;
119 static cn_getc_t dcons_cngetc;
120 static cn_putc_t dcons_cnputc;
121 static cn_grab_t dcons_cngrab;
122 static cn_ungrab_t dcons_cnungrab;
124 CONSOLE_DRIVER(dcons);
127 static gdb_probe_f dcons_dbg_probe;
128 static gdb_init_f dcons_dbg_init;
129 static gdb_term_f dcons_dbg_term;
130 static gdb_getc_f dcons_dbg_getc;
131 static gdb_putc_f dcons_dbg_putc;
133 GDB_DBGPORT(dcons, dcons_dbg_probe, dcons_dbg_init, dcons_dbg_term,
134 dcons_dbg_getc, dcons_dbg_putc);
136 extern struct gdb_dbgport *gdb_cur;
139 static tsw_outwakeup_t dcons_outwakeup;
140 static tsw_free_t dcons_free;
142 static struct ttydevsw dcons_ttydevsw = {
143 .tsw_flags = TF_NOPREFIX,
144 .tsw_outwakeup = dcons_outwakeup,
145 .tsw_free = dcons_free,
148 static int dcons_close_refs;
150 #if (defined(GDB) || defined(DDB))
152 dcons_check_break(struct dcons_softc *dc, int c)
159 if ((dc->flags & DC_GDB) != 0 && gdb_cur == &dcons_gdb_dbgport)
160 kdb_alt_break_gdb(c, &dc->brk_state);
163 kdb_alt_break(c, &dc->brk_state);
168 #define dcons_check_break(dc, c) (c)
172 dcons_os_checkc_nopoll(struct dcons_softc *dc)
176 if (dg.dma_tag != NULL)
177 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
179 c = dcons_check_break(dc, dcons_checkc(dc));
181 if (dg.dma_tag != NULL)
182 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
188 dcons_os_checkc(struct dcons_softc *dc)
190 EVENTHANDLER_INVOKE(dcons_poll, 0);
191 return (dcons_os_checkc_nopoll(dc));
195 dcons_os_putc(struct dcons_softc *dc, int c)
197 if (dg.dma_tag != NULL)
198 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
202 if (dg.dma_tag != NULL)
203 bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
207 dcons_free(void *xsc __unused)
210 /* Our deferred free has arrived, now we're waiting for one fewer. */
211 atomic_subtract_rel_int(&dcons_close_refs, 1);
215 dcons_outwakeup(struct tty *tp)
217 struct dcons_softc *dc;
222 while (ttydisc_getc(tp, &ch, sizeof ch) != 0)
223 dcons_os_putc(dc, ch);
227 dcons_timeout(void *v)
230 struct dcons_softc *dc;
233 for (i = 0; i < DCONS_NPORT; i ++) {
238 while ((c = dcons_os_checkc_nopoll(dc)) != -1) {
239 ttydisc_rint(tp, c, 0);
242 ttydisc_rint_done(tp);
247 if (poll_idle <= (poll_hz * DCONS_POLL_IDLE))
249 callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
253 dcons_cnprobe(struct consdev *cp)
255 sprintf(cp->cn_name, "dcons");
256 #if DCONS_FORCE_CONSOLE
257 cp->cn_pri = CN_REMOTE;
259 cp->cn_pri = CN_NORMAL;
264 dcons_cninit(struct consdev *cp)
267 cp->cn_arg = (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
271 dcons_cnterm(struct consdev *cp)
276 dcons_cngrab(struct consdev *cp)
281 dcons_cnungrab(struct consdev *cp)
286 dcons_cngetc(struct consdev *cp)
288 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
289 return (dcons_os_checkc(dc));
293 dcons_cnputc(struct consdev *cp, int c)
295 struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
296 dcons_os_putc(dc, c);
300 dcons_drv_init(int stage)
302 #if defined(__i386__) || defined(__amd64__)
311 bzero(&dg, sizeof(dg));
313 dg.cdev = &dcons_consdev;
315 dg.size = DCONS_BUF_SIZE;
317 #if defined(__i386__) || defined(__amd64__)
318 if (getenv_quad("dcons.addr", &addr) > 0 &&
319 getenv_quad("dcons.size", &size) > 0) {
323 * Allow read/write access to dcons buffer.
325 for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
326 pmap_ksetrw(PMAP_MAP_LOW + pa);
331 dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
333 dg.buf = (struct dcons_buf *)((vm_offset_t)PMAP_MAP_LOW +
337 if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
345 if (stage == 0) { /* XXX or cold */
347 * DCONS_FORCE_CONSOLE == 1 and statically linked.
348 * called from cninit(). can't use contigmalloc yet .
350 dg.buf = (struct dcons_buf *) bssbuf;
351 dcons_init(dg.buf, dg.size, sc);
356 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
357 * if the module is loaded after boot,
358 * bssbuf could be non-continuous.
360 dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
361 M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
364 dcons_init(dg.buf, dg.size, sc);
377 dcons_attach_port(int port, char *name, int flags)
379 struct dcons_softc *dc;
383 tp = tty_alloc(&dcons_ttydevsw, dc);
386 tty_init_console(tp, 0);
387 tty_makedev(tp, NULL, "%s", name);
396 dcons_attach_port(DCONS_CON, "dcons", 0);
397 dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
398 callout_init(&dcons_callout, 1);
399 polltime = hz / poll_hz;
400 callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
405 dcons_detach(int port)
408 struct dcons_softc *dc;
413 /* tty_rel_gone() schedules a deferred free callback, count it. */
414 atomic_add_int(&dcons_close_refs, 1);
422 dcons_modevent(module_t mode, int type, void *data)
428 ret = dcons_drv_init(1);
432 dcons_cnprobe(&dcons_consdev);
433 dcons_cninit(&dcons_consdev);
434 cnadd(&dcons_consdev);
438 printf("dcons: unload\n");
440 callout_stop(&dcons_callout);
441 cnremove(&dcons_consdev);
442 dcons_detach(DCONS_CON);
443 dcons_detach(DCONS_GDB);
446 contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
449 /* Wait for tty deferred free callbacks to complete. */
450 while (atomic_load_acq_int(&dcons_close_refs) > 0)
451 pause_sbt("dcunld", mstosbt(50), mstosbt(10), 0);
454 #if 0 /* Keep connection after halt */
466 /* Debugger interface */
469 dcons_os_getc(struct dcons_softc *dc)
473 while ((c = dcons_os_checkc(dc)) == -1);
479 dcons_dbg_probe(void)
483 if (getenv_int("dcons_gdb", &dcons_gdb) == 0)
499 dcons_dbg_putc(int c)
501 struct dcons_softc *dc = &sc[DCONS_GDB];
502 dcons_os_putc(dc, c);
508 struct dcons_softc *dc = &sc[DCONS_GDB];
509 return (dcons_os_getc(dc));
513 DEV_MODULE(dcons, dcons_modevent, NULL);
514 MODULE_VERSION(dcons, DCONS_VERSION);