dcons_os.c revision 170043 
1/*-
2 * Copyright (C) 2003,2004
3 * 	Hidetoshi Shimokawa. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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:
15 *
16 *	This product includes software developed by Hidetoshi Shimokawa.
17 *
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.
21 *
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
32 * SUCH DAMAGE.
33 *
34 * $FreeBSD: head/sys/dev/dcons/dcons_os.c 170043 2007-05-28 02:20:40Z simokawa $
35 */
36
37#include <sys/param.h>
38#if __FreeBSD_version >= 502122
39#include <sys/kdb.h>
40#include <gdb/gdb.h>
41#endif
42#include <sys/kernel.h>
43#include <sys/module.h>
44#include <sys/systm.h>
45#include <sys/types.h>
46#include <sys/conf.h>
47#include <sys/cons.h>
48#include <sys/consio.h>
49#include <sys/tty.h>
50#include <sys/malloc.h>
51#include <sys/priv.h>
52#include <sys/proc.h>
53#include <sys/ucred.h>
54
55#include <machine/bus.h>
56
57#ifdef __DragonFly__
58#include "dcons.h"
59#include "dcons_os.h"
60#else
61#include <dev/dcons/dcons.h>
62#include <dev/dcons/dcons_os.h>
63#endif
64
65#include <ddb/ddb.h>
66#include <sys/reboot.h>
67
68#include <sys/sysctl.h>
69
70#include <vm/vm.h>
71#include <vm/vm_param.h>
72#include <vm/pmap.h>
73
74#include "opt_comconsole.h"
75#include "opt_dcons.h"
76#include "opt_kdb.h"
77#include "opt_gdb.h"
78#include "opt_ddb.h"
79
80
81#ifndef DCONS_POLL_HZ
82#define DCONS_POLL_HZ	100
83#endif
84
85#ifndef DCONS_BUF_SIZE
86#define DCONS_BUF_SIZE (16*1024)
87#endif
88
89#ifndef DCONS_FORCE_CONSOLE
90#define DCONS_FORCE_CONSOLE	0	/* Mostly for FreeBSD-4/DragonFly */
91#endif
92
93#ifndef DCONS_FORCE_GDB
94#define DCONS_FORCE_GDB	1
95#endif
96
97#if __FreeBSD_version >= 500101
98#define CONS_NODEV	1
99#if __FreeBSD_version < 502122
100static struct consdev gdbconsdev;
101#endif
102#endif
103
104static d_open_t		dcons_open;
105static d_close_t	dcons_close;
106#if defined(__DragonFly__) || __FreeBSD_version < 500104
107static d_ioctl_t	dcons_ioctl;
108#endif
109
110static struct cdevsw dcons_cdevsw = {
111#ifdef __DragonFly__
112#define CDEV_MAJOR      184
113	"dcons", CDEV_MAJOR, D_TTY, NULL, 0,
114	dcons_open, dcons_close, ttyread, ttywrite, dcons_ioctl,
115	ttypoll, nommap, nostrategy, nodump, nopsize,
116#elif __FreeBSD_version >= 500104
117	.d_version =	D_VERSION,
118	.d_open =	dcons_open,
119	.d_close =	dcons_close,
120	.d_name =	"dcons",
121	.d_flags =	D_TTY | D_NEEDGIANT,
122#else
123#define CDEV_MAJOR      184
124	/* open */	dcons_open,
125	/* close */	dcons_close,
126	/* read */	ttyread,
127	/* write */	ttywrite,
128	/* ioctl */	dcons_ioctl,
129	/* poll */	ttypoll,
130	/* mmap */	nommap,
131	/* strategy */	nostrategy,
132	/* name */	"dcons",
133	/* major */	CDEV_MAJOR,
134	/* dump */	nodump,
135	/* psize */	nopsize,
136	/* flags */	D_TTY,
137#endif
138};
139
140#ifndef KLD_MODULE
141static char bssbuf[DCONS_BUF_SIZE];	/* buf in bss */
142#endif
143
144/* global data */
145static struct dcons_global dg;
146struct dcons_global *dcons_conf;
147static int poll_hz = DCONS_POLL_HZ;
148
149static struct dcons_softc sc[DCONS_NPORT];
150
151SYSCTL_NODE(_kern, OID_AUTO, dcons, CTLFLAG_RD, 0, "Dumb Console");
152SYSCTL_INT(_kern_dcons, OID_AUTO, poll_hz, CTLFLAG_RW, &poll_hz, 0,
153				"dcons polling rate");
154
155static int drv_init = 0;
156static struct callout dcons_callout;
157struct dcons_buf *dcons_buf;		/* for local dconschat */
158
159#ifdef __DragonFly__
160#define DEV	dev_t
161#define THREAD	d_thread_t
162#elif __FreeBSD_version < 500000
163#define DEV	dev_t
164#define THREAD	struct proc
165#else
166#define DEV	struct cdev *
167#define THREAD	struct thread
168#endif
169
170
171static void	dcons_tty_start(struct tty *);
172static int	dcons_tty_param(struct tty *, struct termios *);
173static void	dcons_timeout(void *);
174static int	dcons_drv_init(int);
175
176static cn_probe_t	dcons_cnprobe;
177static cn_init_t	dcons_cninit;
178static cn_term_t	dcons_cnterm;
179static cn_getc_t	dcons_cngetc;
180static cn_putc_t	dcons_cnputc;
181
182CONSOLE_DRIVER(dcons);
183
184#if defined(GDB) && (__FreeBSD_version >= 502122)
185static gdb_probe_f dcons_dbg_probe;
186static gdb_init_f dcons_dbg_init;
187static gdb_term_f dcons_dbg_term;
188static gdb_getc_f dcons_dbg_getc;
189static gdb_putc_f dcons_dbg_putc;
190
191GDB_DBGPORT(dcons, dcons_dbg_probe, dcons_dbg_init, dcons_dbg_term,
192    dcons_dbg_getc, dcons_dbg_putc);
193
194extern struct gdb_dbgport *gdb_cur;
195#endif
196
197#if (defined(GDB) || defined(DDB)) && defined(ALT_BREAK_TO_DEBUGGER)
198static int
199dcons_check_break(struct dcons_softc *dc, int c)
200{
201	if (c < 0)
202		return (c);
203
204#if __FreeBSD_version >= 502122
205	if (kdb_alt_break(c, &dc->brk_state)) {
206		if ((dc->flags & DC_GDB) != 0) {
207#ifdef GDB
208			if (gdb_cur == &dcons_gdb_dbgport) {
209				kdb_dbbe_select("gdb");
210				breakpoint();
211			}
212#endif
213		} else
214			breakpoint();
215	}
216#else
217	switch (dc->brk_state) {
218	case STATE1:
219		if (c == KEY_TILDE)
220			dc->brk_state = STATE2;
221		else
222			dc->brk_state = STATE0;
223		break;
224	case STATE2:
225		dc->brk_state = STATE0;
226		if (c == KEY_CTRLB) {
227#if DCONS_FORCE_GDB
228			if (dc->flags & DC_GDB)
229				boothowto |= RB_GDB;
230#endif
231			breakpoint();
232		}
233	}
234	if (c == KEY_CR)
235		dc->brk_state = STATE1;
236#endif
237	return (c);
238}
239#else
240#define	dcons_check_break(dc, c)	(c)
241#endif
242
243static int
244dcons_os_checkc(struct dcons_softc *dc)
245{
246	int c;
247
248	if (dg.dma_tag != NULL)
249		bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTREAD);
250
251	c = dcons_check_break(dc, dcons_checkc(dc));
252
253	if (dg.dma_tag != NULL)
254		bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREREAD);
255
256	return (c);
257}
258
259#if defined(GDB) || !defined(CONS_NODEV)
260static int
261dcons_os_getc(struct dcons_softc *dc)
262{
263	int c;
264
265	while ((c = dcons_os_checkc(dc)) == -1);
266
267	return (c & 0xff);
268}
269#endif
270
271static void
272dcons_os_putc(struct dcons_softc *dc, int c)
273{
274	if (dg.dma_tag != NULL)
275		bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_POSTWRITE);
276
277	dcons_putc(dc, c);
278
279	if (dg.dma_tag != NULL)
280		bus_dmamap_sync(dg.dma_tag, dg.dma_map, BUS_DMASYNC_PREWRITE);
281}
282static int
283dcons_open(DEV dev, int flag, int mode, THREAD *td)
284{
285	struct tty *tp;
286	int unit, error, s;
287
288	unit = minor(dev);
289	if (unit != 0)
290		return (ENXIO);
291
292	tp = dev->si_tty;
293	tp->t_oproc = dcons_tty_start;
294	tp->t_param = dcons_tty_param;
295	tp->t_stop = nottystop;
296	tp->t_dev = dev;
297
298	error = 0;
299
300	s = spltty();
301	if ((tp->t_state & TS_ISOPEN) == 0) {
302		tp->t_state |= TS_CARR_ON;
303		ttyconsolemode(tp, 0);
304	} else if ((tp->t_state & TS_XCLUDE) &&
305	    priv_check(td, PRIV_TTY_EXCLUSIVE)) {
306		splx(s);
307		return (EBUSY);
308	}
309	splx(s);
310
311#if __FreeBSD_version < 502113
312	error = (*linesw[tp->t_line].l_open)(dev, tp);
313#else
314	error = ttyld_open(tp, dev);
315#endif
316
317	return (error);
318}
319
320static int
321dcons_close(DEV dev, int flag, int mode, THREAD *td)
322{
323	int	unit;
324	struct	tty *tp;
325
326	unit = minor(dev);
327	if (unit != 0)
328		return (ENXIO);
329
330	tp = dev->si_tty;
331	if (tp->t_state & TS_ISOPEN) {
332#if __FreeBSD_version < 502113
333		(*linesw[tp->t_line].l_close)(tp, flag);
334		ttyclose(tp);
335#else
336		ttyld_close(tp, flag);
337		tty_close(tp);
338#endif
339	}
340
341	return (0);
342}
343
344#if defined(__DragonFly__) || __FreeBSD_version < 500104
345static int
346dcons_ioctl(DEV dev, u_long cmd, caddr_t data, int flag, THREAD *td)
347{
348	int	unit;
349	struct	tty *tp;
350	int	error;
351
352	unit = minor(dev);
353	if (unit != 0)
354		return (ENXIO);
355
356	tp = dev->si_tty;
357	error = (*linesw[tp->t_line].l_ioctl)(tp, cmd, data, flag, td);
358	if (error != ENOIOCTL)
359		return (error);
360
361	error = ttioctl(tp, cmd, data, flag);
362	if (error != ENOIOCTL)
363		return (error);
364
365	return (ENOTTY);
366}
367#endif
368
369static int
370dcons_tty_param(struct tty *tp, struct termios *t)
371{
372	tp->t_ispeed = t->c_ispeed;
373	tp->t_ospeed = t->c_ospeed;
374	tp->t_cflag = t->c_cflag;
375	return 0;
376}
377
378static void
379dcons_tty_start(struct tty *tp)
380{
381	struct dcons_softc *dc;
382	int s;
383
384	dc = (struct dcons_softc *)tp->t_dev->si_drv1;
385	s = spltty();
386	if (tp->t_state & (TS_TIMEOUT | TS_TTSTOP)) {
387		ttwwakeup(tp);
388		return;
389	}
390
391	tp->t_state |= TS_BUSY;
392	while (tp->t_outq.c_cc != 0)
393		dcons_os_putc(dc, getc(&tp->t_outq));
394	tp->t_state &= ~TS_BUSY;
395
396	ttwwakeup(tp);
397	splx(s);
398}
399
400static void
401dcons_timeout(void *v)
402{
403	struct	tty *tp;
404	struct dcons_softc *dc;
405	int i, c, polltime;
406
407	for (i = 0; i < DCONS_NPORT; i ++) {
408		dc = &sc[i];
409		tp = ((DEV)dc->dev)->si_tty;
410		while ((c = dcons_os_checkc(dc)) != -1)
411			if (tp->t_state & TS_ISOPEN)
412#if __FreeBSD_version < 502113
413				(*linesw[tp->t_line].l_rint)(c, tp);
414#else
415				ttyld_rint(tp, c);
416#endif
417	}
418	polltime = hz / poll_hz;
419	if (polltime < 1)
420		polltime = 1;
421	callout_reset(&dcons_callout, polltime, dcons_timeout, tp);
422}
423
424static void
425dcons_cnprobe(struct consdev *cp)
426{
427#ifdef __DragonFly__
428	cp->cn_dev = make_dev(&dcons_cdevsw, DCONS_CON,
429	    UID_ROOT, GID_WHEEL, 0600, "dcons");
430#elif __FreeBSD_version >= 501109
431	sprintf(cp->cn_name, "dcons");
432#else
433	cp->cn_dev = makedev(CDEV_MAJOR, DCONS_CON);
434#endif
435#if DCONS_FORCE_CONSOLE
436	cp->cn_pri = CN_REMOTE;
437#else
438	cp->cn_pri = CN_NORMAL;
439#endif
440}
441
442static void
443dcons_cninit(struct consdev *cp)
444{
445	dcons_drv_init(0);
446#if CONS_NODEV
447	cp->cn_arg
448#else
449	cp->cn_dev->si_drv1
450#endif
451		= (void *)&sc[DCONS_CON]; /* share port0 with unit0 */
452}
453
454static void
455dcons_cnterm(struct consdev *cp)
456{
457}
458
459#if CONS_NODEV
460static int
461dcons_cngetc(struct consdev *cp)
462{
463	struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
464	return (dcons_os_checkc(dc));
465}
466static void
467dcons_cnputc(struct consdev *cp, int c)
468{
469	struct dcons_softc *dc = (struct dcons_softc *)cp->cn_arg;
470	dcons_os_putc(dc, c);
471}
472#else
473static int
474dcons_cngetc(DEV dev)
475{
476	struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
477	return (dcons_os_getc(dc));
478}
479static int
480dcons_cncheckc(DEV dev)
481{
482	struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
483	return (dcons_os_checkc(dc));
484}
485static void
486dcons_cnputc(DEV dev, int c)
487{
488	struct dcons_softc *dc = (struct dcons_softc *)dev->si_drv1;
489	dcons_os_putc(dc, c);
490}
491#endif
492
493static int
494dcons_drv_init(int stage)
495{
496#if defined(__i386__) || defined(__amd64__)
497	quad_t addr, size;
498#endif
499
500	if (drv_init)
501		return(drv_init);
502
503	drv_init = -1;
504
505	bzero(&dg, sizeof(dg));
506	dcons_conf = &dg;
507	dg.cdev = &dcons_consdev;
508	dg.buf = NULL;
509	dg.size = DCONS_BUF_SIZE;
510
511#if defined(__i386__) || defined(__amd64__)
512	if (getenv_quad("dcons.addr", &addr) > 0 &&
513	    getenv_quad("dcons.size", &size) > 0) {
514#ifdef __i386__
515		vm_paddr_t pa;
516		/*
517		 * Allow read/write access to dcons buffer.
518		 */
519		for (pa = trunc_page(addr); pa < addr + size; pa += PAGE_SIZE)
520			*vtopte(KERNBASE + pa) |= PG_RW;
521		invltlb();
522#endif
523		/* XXX P to V */
524		dg.buf = (struct dcons_buf *)(vm_offset_t)(KERNBASE + addr);
525		dg.size = size;
526		if (dcons_load_buffer(dg.buf, dg.size, sc) < 0)
527			dg.buf = NULL;
528	}
529#endif
530	if (dg.buf != NULL)
531		goto ok;
532
533#ifndef KLD_MODULE
534	if (stage == 0) { /* XXX or cold */
535		/*
536		 * DCONS_FORCE_CONSOLE == 1 and statically linked.
537		 * called from cninit(). can't use contigmalloc yet .
538		 */
539		dg.buf = (struct dcons_buf *) bssbuf;
540		dcons_init(dg.buf, dg.size, sc);
541	} else
542#endif
543	{
544		/*
545		 * DCONS_FORCE_CONSOLE == 0 or kernel module case.
546		 * if the module is loaded after boot,
547		 * bssbuf could be non-continuous.
548		 */
549		dg.buf = (struct dcons_buf *) contigmalloc(dg.size,
550			M_DEVBUF, 0, 0x10000, 0xffffffff, PAGE_SIZE, 0ul);
551		dcons_init(dg.buf, dg.size, sc);
552	}
553
554ok:
555	dcons_buf = dg.buf;
556
557#if __FreeBSD_version < 502122
558#if defined(DDB) && DCONS_FORCE_GDB
559#if CONS_NODEV
560	gdbconsdev.cn_arg = (void *)&sc[DCONS_GDB];
561#if __FreeBSD_version >= 501109
562	sprintf(gdbconsdev.cn_name, "dgdb");
563#endif
564	gdb_arg = &gdbconsdev;
565#elif defined(__DragonFly__)
566	gdbdev = make_dev(&dcons_cdevsw, DCONS_GDB,
567	    UID_ROOT, GID_WHEEL, 0600, "dgdb");
568#else
569	gdbdev = makedev(CDEV_MAJOR, DCONS_GDB);
570#endif
571	gdb_getc = dcons_cngetc;
572	gdb_putc = dcons_cnputc;
573#endif
574#endif
575	drv_init = 1;
576
577	return 0;
578}
579
580
581static int
582dcons_attach_port(int port, char *name, int flags)
583{
584	struct dcons_softc *dc;
585	struct tty *tp;
586	DEV dev;
587
588	dc = &sc[port];
589	dc->flags = flags;
590	dev = make_dev(&dcons_cdevsw, port,
591			UID_ROOT, GID_WHEEL, 0600, name);
592	dc->dev = (void *)dev;
593	tp = ttyalloc();
594
595	dev->si_drv1 = (void *)dc;
596	dev->si_tty = tp;
597
598	tp->t_oproc = dcons_tty_start;
599	tp->t_param = dcons_tty_param;
600	tp->t_stop = nottystop;
601	tp->t_dev = dc->dev;
602
603	return(0);
604}
605
606static int
607dcons_attach(void)
608{
609	int polltime;
610
611#ifdef __DragonFly__
612	cdevsw_add(&dcons_cdevsw, -1, 0);
613#endif
614	dcons_attach_port(DCONS_CON, "dcons", 0);
615	dcons_attach_port(DCONS_GDB, "dgdb", DC_GDB);
616#if __FreeBSD_version < 500000
617	callout_init(&dcons_callout);
618#else
619	callout_init(&dcons_callout, 0);
620#endif
621	polltime = hz / poll_hz;
622	if (polltime < 1)
623		polltime = 1;
624	callout_reset(&dcons_callout, polltime, dcons_timeout, NULL);
625	return(0);
626}
627
628static int
629dcons_detach(int port)
630{
631	struct	tty *tp;
632	struct dcons_softc *dc;
633
634	dc = &sc[port];
635
636	tp = ((DEV)dc->dev)->si_tty;
637
638	if (tp->t_state & TS_ISOPEN) {
639		printf("dcons: still opened\n");
640#if __FreeBSD_version < 502113
641		(*linesw[tp->t_line].l_close)(tp, 0);
642		tp->t_gen++;
643		ttyclose(tp);
644		ttwakeup(tp);
645		ttwwakeup(tp);
646#else
647		ttyld_close(tp, 0);
648		tty_close(tp);
649#endif
650	}
651	/* XXX
652	 * must wait until all device are closed.
653	 */
654#ifdef __DragonFly__
655	tsleep((void *)dc, 0, "dcodtc", hz/4);
656#else
657	tsleep((void *)dc, PWAIT, "dcodtc", hz/4);
658#endif
659	destroy_dev(dc->dev);
660
661	return(0);
662}
663
664
665/* cnXXX works only for FreeBSD-5 */
666static int
667dcons_modevent(module_t mode, int type, void *data)
668{
669	int err = 0, ret;
670
671	switch (type) {
672	case MOD_LOAD:
673		ret = dcons_drv_init(1);
674		dcons_attach();
675#if __FreeBSD_version >= 500000
676		if (ret == 0) {
677			dcons_cnprobe(&dcons_consdev);
678			dcons_cninit(&dcons_consdev);
679			cnadd(&dcons_consdev);
680		}
681#endif
682		break;
683	case MOD_UNLOAD:
684		printf("dcons: unload\n");
685		callout_stop(&dcons_callout);
686#if __FreeBSD_version < 502122
687#if defined(DDB) && DCONS_FORCE_GDB
688#if CONS_NODEV
689		gdb_arg = NULL;
690#else
691		gdbdev = NULL;
692#endif
693#endif
694#endif
695#if __FreeBSD_version >= 500000
696		cnremove(&dcons_consdev);
697#endif
698		dcons_detach(DCONS_CON);
699		dcons_detach(DCONS_GDB);
700		dg.buf->magic = 0;
701
702		contigfree(dg.buf, DCONS_BUF_SIZE, M_DEVBUF);
703
704		break;
705	case MOD_SHUTDOWN:
706		dg.buf->magic = 0;
707		break;
708	default:
709		err = EOPNOTSUPP;
710		break;
711	}
712	return(err);
713}
714
715#if defined(GDB) && (__FreeBSD_version >= 502122)
716/* Debugger interface */
717
718static int
719dcons_dbg_probe(void)
720{
721	return(DCONS_FORCE_GDB);
722}
723
724static void
725dcons_dbg_init(void)
726{
727}
728
729static void
730dcons_dbg_term(void)
731{
732}
733
734static void
735dcons_dbg_putc(int c)
736{
737	struct dcons_softc *dc = &sc[DCONS_GDB];
738	dcons_os_putc(dc, c);
739}
740
741static int
742dcons_dbg_getc(void)
743{
744	struct dcons_softc *dc = &sc[DCONS_GDB];
745	return (dcons_os_getc(dc));
746}
747#endif
748
749DEV_MODULE(dcons, dcons_modevent, NULL);
750MODULE_VERSION(dcons, DCONS_VERSION);
751