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