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.7 2006/10/25 20:55:54 dillon 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 #if __FreeBSD_version >= 500101
91 #if __FreeBSD_version < 502122
92 static struct consdev gdbconsdev
;
96 #define CDEV_MAJOR 184
98 static d_open_t dcons_open
;
99 static d_close_t dcons_close
;
100 static d_ioctl_t dcons_ioctl
;
102 static struct dev_ops dcons_ops
= {
103 { "dcons", CDEV_MAJOR
, D_TTY
},
104 .d_open
= dcons_open
,
105 .d_close
= dcons_close
,
108 .d_ioctl
= dcons_ioctl
,
113 static char bssbuf
[DCONS_BUF_SIZE
]; /* buf in bss */
117 static struct dcons_global dg
;
118 struct dcons_global
*dcons_conf
;
119 static int poll_hz
= DCONS_POLL_HZ
;
121 static struct dcons_softc sc
[DCONS_NPORT
];
123 SYSCTL_NODE(_kern
, OID_AUTO
, dcons
, CTLFLAG_RD
, 0, "Dumb Console");
124 SYSCTL_INT(_kern_dcons
, OID_AUTO
, poll_hz
, CTLFLAG_RW
, &poll_hz
, 0,
125 "dcons polling rate");
127 static int drv_init
= 0;
128 static struct callout dcons_callout
;
129 struct dcons_buf
*dcons_buf
; /* for local dconschat */
133 #define THREAD d_thread_t
134 #elif __FreeBSD_version < 500000
136 #define THREAD struct proc
138 #define DEV struct cdev *
139 #define THREAD struct thread
143 static void dcons_tty_start(struct tty
*);
144 static int dcons_tty_param(struct tty
*, struct termios
*);
145 static void dcons_timeout(void *);
146 static int dcons_drv_init(int);
148 static cn_probe_t dcons_cnprobe
;
149 static cn_init_t dcons_cninit
;
150 static cn_getc_t dcons_cngetc
;
151 static cn_checkc_t dcons_cncheckc
;
152 static cn_putc_t dcons_cnputc
;
154 CONS_DRIVER(dcons
, dcons_cnprobe
, dcons_cninit
, NULL
, dcons_cngetc
,
155 dcons_cncheckc
, dcons_cnputc
, NULL
);
157 #if __FreeBSD_version >= 502122
158 static gdb_probe_f dcons_dbg_probe
;
159 static gdb_init_f dcons_dbg_init
;
160 static gdb_term_f dcons_dbg_term
;
161 static gdb_getc_f dcons_dbg_getc
;
162 static gdb_checkc_f dcons_dbg_checkc
;
163 static gdb_putc_f dcons_dbg_putc
;
165 GDB_DBGPORT(dcons
, dcons_dbg_probe
, dcons_dbg_init
, dcons_dbg_term
,
166 dcons_dbg_checkc
, dcons_dbg_getc
, dcons_dbg_putc
);
168 extern struct gdb_dbgport
*gdb_cur
;
171 #if (KDB || DDB) && ALT_BREAK_TO_DEBUGGER
173 dcons_check_break(struct dcons_softc
*dc
, int c
)
178 #if __FreeBSD_version >= 502122
179 if (kdb_alt_break(c
, &dc
->brk_state
)) {
180 if ((dc
->flags
& DC_GDB
) != 0) {
181 if (gdb_cur
== &dcons_gdb_dbgport
) {
182 kdb_dbbe_select("gdb");
189 switch (dc
->brk_state
) {
192 dc
->brk_state
= STATE2
;
194 dc
->brk_state
= STATE0
;
197 dc
->brk_state
= STATE0
;
198 if (c
== KEY_CTRLB
) {
200 if (dc
->flags
& DC_GDB
)
207 dc
->brk_state
= STATE1
;
212 #define dcons_check_break(dc, c) (c)
216 dcons_os_checkc(struct dcons_softc
*dc
)
220 if (dg
.dma_tag
!= NULL
)
221 bus_dmamap_sync(dg
.dma_tag
, dg
.dma_map
, BUS_DMASYNC_POSTREAD
);
223 c
= dcons_check_break(dc
, dcons_checkc(dc
));
225 if (dg
.dma_tag
!= NULL
)
226 bus_dmamap_sync(dg
.dma_tag
, dg
.dma_map
, BUS_DMASYNC_PREREAD
);
232 dcons_os_getc(struct dcons_softc
*dc
)
236 while ((c
= dcons_os_checkc(dc
)) == -1);
242 dcons_os_putc(struct dcons_softc
*dc
, int c
)
244 if (dg
.dma_tag
!= NULL
)
245 bus_dmamap_sync(dg
.dma_tag
, dg
.dma_map
, BUS_DMASYNC_POSTWRITE
);
249 if (dg
.dma_tag
!= NULL
)
250 bus_dmamap_sync(dg
.dma_tag
, dg
.dma_map
, BUS_DMASYNC_PREWRITE
);
253 dcons_open(struct dev_open_args
*ap
)
255 cdev_t dev
= ap
->a_head
.a_dev
;
263 tp
= dev
->si_tty
= ttymalloc(dev
->si_tty
);
264 tp
->t_oproc
= dcons_tty_start
;
265 tp
->t_param
= dcons_tty_param
;
266 tp
->t_stop
= nottystop
;
272 if ((tp
->t_state
& TS_ISOPEN
) == 0) {
273 tp
->t_state
|= TS_CARR_ON
;
275 tp
->t_iflag
= TTYDEF_IFLAG
;
276 tp
->t_oflag
= TTYDEF_OFLAG
;
277 tp
->t_cflag
= TTYDEF_CFLAG
|CLOCAL
;
278 tp
->t_lflag
= TTYDEF_LFLAG
;
279 tp
->t_ispeed
= tp
->t_ospeed
= TTYDEF_SPEED
;
281 } else if ((tp
->t_state
& TS_XCLUDE
) && suser_cred(ap
->a_cred
, 0)) {
287 #if __FreeBSD_version < 502113
288 error
= (*linesw
[tp
->t_line
].l_open
)(dev
, tp
);
290 error
= ttyld_open(tp
, dev
);
297 dcons_close(struct dev_close_args
*ap
)
299 cdev_t dev
= ap
->a_head
.a_dev
;
308 if (tp
->t_state
& TS_ISOPEN
) {
309 (*linesw
[tp
->t_line
].l_close
)(tp
, ap
->a_fflag
);
317 dcons_ioctl(struct dev_ioctl_args
*ap
)
319 cdev_t dev
= ap
->a_head
.a_dev
;
329 error
= (*linesw
[tp
->t_line
].l_ioctl
)(tp
, ap
->a_cmd
, ap
->a_data
, ap
->a_fflag
, ap
->a_cred
);
330 if (error
!= ENOIOCTL
)
333 error
= ttioctl(tp
, ap
->a_cmd
, ap
->a_data
, ap
->a_fflag
);
334 if (error
!= ENOIOCTL
)
341 dcons_tty_param(struct tty
*tp
, struct termios
*t
)
343 tp
->t_ispeed
= t
->c_ispeed
;
344 tp
->t_ospeed
= t
->c_ospeed
;
345 tp
->t_cflag
= t
->c_cflag
;
350 dcons_tty_start(struct tty
*tp
)
352 struct dcons_softc
*dc
;
354 dc
= (struct dcons_softc
*)tp
->t_dev
->si_drv1
;
356 if (tp
->t_state
& (TS_TIMEOUT
| TS_TTSTOP
)) {
361 tp
->t_state
|= TS_BUSY
;
362 while (tp
->t_outq
.c_cc
!= 0)
363 dcons_os_putc(dc
, clist_getc(&tp
->t_outq
));
364 tp
->t_state
&= ~TS_BUSY
;
371 dcons_timeout(void *v
)
374 struct dcons_softc
*dc
;
377 for (i
= 0; i
< DCONS_NPORT
; i
++) {
379 tp
= ((DEV
)dc
->dev
)->si_tty
;
380 while ((c
= dcons_os_checkc(dc
)) != -1)
381 if (tp
->t_state
& TS_ISOPEN
)
382 #if __FreeBSD_version < 502113
383 (*linesw
[tp
->t_line
].l_rint
)(c
, tp
);
388 polltime
= hz
/ poll_hz
;
391 callout_reset(&dcons_callout
, polltime
, dcons_timeout
, tp
);
395 dcons_cnprobe(struct consdev
*cp
)
398 cp
->cn_dev
= make_dev(&dcons_ops
, DCONS_CON
,
399 UID_ROOT
, GID_WHEEL
, 0600, "dcons");
400 #elif __FreeBSD_version >= 501109
401 sprintf(cp
->cn_name
, "dcons");
403 cp
->cn_dev
= makedev(CDEV_MAJOR
, DCONS_CON
);
405 #if DCONS_FORCE_CONSOLE
406 cp
->cn_pri
= CN_REMOTE
;
408 cp
->cn_pri
= CN_NORMAL
;
413 dcons_cninit(struct consdev
*cp
)
421 = (void *)&sc
[DCONS_CON
]; /* share port0 with unit0 */
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(DEV dev
)
447 struct dcons_softc
*dc
= (struct dcons_softc
*)dev
->si_drv1
;
448 return (dcons_os_getc(dc
));
451 dcons_cncheckc(DEV dev
)
453 struct dcons_softc
*dc
= (struct dcons_softc
*)dev
->si_drv1
;
454 return (dcons_os_checkc(dc
));
457 dcons_cnputc(DEV dev
, int c
)
459 struct dcons_softc
*dc
= (struct dcons_softc
*)dev
->si_drv1
;
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 *vtopte(KERNBASE
+ pa
) |= PG_RW
;
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 __FreeBSD_version < 502122
527 #if DDB && DCONS_FORCE_GDB
529 gdbconsdev
.cn_arg
= (void *)&sc
[DCONS_GDB
];
530 #if __FreeBSD_version >= 501109
531 sprintf(gdbconsdev
.cn_name
, "dgdb");
533 gdb_arg
= &gdbconsdev
;
534 #elif defined(__DragonFly__)
535 gdbdev
= make_dev(&dcons_ops
, DCONS_GDB
,
536 UID_ROOT
, GID_WHEEL
, 0600, "dgdb");
538 gdbdev
= makedev(CDEV_MAJOR
, DCONS_GDB
);
540 gdb_getc
= dcons_cngetc
;
541 gdb_putc
= dcons_cnputc
;
551 dcons_attach_port(int port
, char *name
, int flags
)
553 struct dcons_softc
*dc
;
559 dev
= make_dev(&dcons_ops
, port
,
560 UID_ROOT
, GID_WHEEL
, 0600, name
);
561 dc
->dev
= (void *)dev
;
562 tp
= ttymalloc(NULL
);
564 dev
->si_drv1
= (void *)dc
;
567 tp
->t_oproc
= dcons_tty_start
;
568 tp
->t_param
= dcons_tty_param
;
569 tp
->t_stop
= nottystop
;
581 dev_ops_add(&dcons_ops
, -1, 0);
583 dcons_attach_port(DCONS_CON
, "dcons", 0);
584 dcons_attach_port(DCONS_GDB
, "dgdb", DC_GDB
);
585 #if __FreeBSD_version < 500000
586 callout_init(&dcons_callout
);
588 callout_init(&dcons_callout
, 0);
590 polltime
= hz
/ poll_hz
;
593 callout_reset(&dcons_callout
, polltime
, dcons_timeout
, NULL
);
598 dcons_detach(int port
)
601 struct dcons_softc
*dc
;
605 tp
= ((DEV
)dc
->dev
)->si_tty
;
607 if (tp
->t_state
& TS_ISOPEN
) {
608 printf("dcons: still opened\n");
609 #if __FreeBSD_version < 502113
610 (*linesw
[tp
->t_line
].l_close
)(tp
, 0);
621 * must wait until all device are closed.
624 tsleep((void *)dc
, 0, "dcodtc", hz
/4);
626 tsleep((void *)dc
, PWAIT
, "dcodtc", hz
/4);
628 destroy_dev(dc
->dev
);
634 /* cnXXX works only for FreeBSD-5 */
636 dcons_modevent(module_t mode
, int type
, void *data
)
642 ret
= dcons_drv_init(1);
644 #if __FreeBSD_version >= 500000
646 dcons_cnprobe(&dcons_consdev
);
647 dcons_cninit(&dcons_consdev
);
648 cnadd(&dcons_consdev
);
653 printf("dcons: unload\n");
654 callout_stop(&dcons_callout
);
655 #if __FreeBSD_version < 502122
656 #if DDB && DCONS_FORCE_GDB
664 #if __FreeBSD_version >= 500000
665 cnremove(&dcons_consdev
);
667 dcons_detach(DCONS_CON
);
668 dcons_detach(DCONS_GDB
);
671 contigfree(dg
.buf
, DCONS_BUF_SIZE
, M_DEVBUF
);
684 #if __FreeBSD_version >= 502122
685 /* Debugger interface */
688 dcons_dbg_probe(void)
690 return(DCONS_FORCE_GDB
);
704 dcons_dbg_putc(int c
)
706 struct dcons_softc
*dc
= &sc
[DCONS_GDB
];
707 dcons_os_putc(dc
, c
);
711 dcons_dbg_checkc(void)
713 struct dcons_softc
*dc
= &sc
[DCONS_GDB
];
714 return (dcons_os_checkc(dc
));
720 struct dcons_softc
*dc
= &sc
[DCONS_GDB
];
721 return (dcons_os_getc(dc
));
725 DEV_MODULE(dcons
, dcons_modevent
, NULL
);
726 MODULE_VERSION(dcons
, DCONS_VERSION
);