ofw_console.c revision 331722 
1/*-
2 * Copyright (C) 2001 Benno Rice.
3 * 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 *
14 * THIS SOFTWARE IS PROVIDED BY Benno Rice ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
22 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
23 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#include <sys/cdefs.h>
27__FBSDID("$FreeBSD: stable/11/sys/dev/ofw/ofw_console.c 331722 2018-03-29 02:50:57Z eadler $");
28
29#include "opt_ofw.h"
30
31#include <sys/param.h>
32#include <sys/kdb.h>
33#include <sys/kernel.h>
34#include <sys/priv.h>
35#include <sys/systm.h>
36#include <sys/types.h>
37#include <sys/conf.h>
38#include <sys/cons.h>
39#include <sys/consio.h>
40#include <sys/tty.h>
41
42#include <dev/ofw/openfirm.h>
43
44#include <ddb/ddb.h>
45
46#ifndef	OFWCONS_POLL_HZ
47#define	OFWCONS_POLL_HZ	4	/* 50-100 works best on Ultra2 */
48#endif
49#define OFBURSTLEN	128	/* max number of bytes to write in one chunk */
50
51static tsw_open_t ofwtty_open;
52static tsw_close_t ofwtty_close;
53static tsw_outwakeup_t ofwtty_outwakeup;
54
55static struct ttydevsw ofw_ttydevsw = {
56	.tsw_flags	= TF_NOPREFIX,
57	.tsw_open	= ofwtty_open,
58	.tsw_close	= ofwtty_close,
59	.tsw_outwakeup	= ofwtty_outwakeup,
60};
61
62static int			polltime;
63static struct callout		ofw_timer;
64
65#if defined(KDB)
66static int			alt_break_state;
67#endif
68
69static void	ofw_timeout(void *);
70
71static cn_probe_t	ofw_cnprobe;
72static cn_init_t	ofw_cninit;
73static cn_term_t	ofw_cnterm;
74static cn_getc_t	ofw_cngetc;
75static cn_putc_t	ofw_cnputc;
76static cn_grab_t	ofw_cngrab;
77static cn_ungrab_t	ofw_cnungrab;
78
79CONSOLE_DRIVER(ofw);
80
81static void
82cn_drvinit(void *unused)
83{
84	phandle_t options;
85	char output[32];
86	struct tty *tp;
87
88	if (ofw_consdev.cn_pri != CN_DEAD &&
89	    ofw_consdev.cn_name[0] != '\0') {
90		tp = tty_alloc(&ofw_ttydevsw, NULL);
91		tty_makedev(tp, NULL, "%s", "ofwcons");
92
93		/*
94		 * XXX: This is a hack and it may result in two /dev/ttya
95		 * XXX: devices on platforms where the sab driver works.
96		 */
97		if ((options = OF_finddevice("/options")) == -1 ||
98		    OF_getprop(options, "output-device", output,
99		    sizeof(output)) == -1)
100			return;
101		if (strlen(output) > 0)
102			tty_makealias(tp, "%s", output);
103		callout_init_mtx(&ofw_timer, tty_getlock(tp), 0);
104	}
105}
106
107SYSINIT(cndev, SI_SUB_CONFIGURE, SI_ORDER_MIDDLE, cn_drvinit, NULL);
108
109static pcell_t	stdin;
110static pcell_t	stdout;
111
112static int
113ofwtty_open(struct tty *tp)
114{
115	polltime = hz / OFWCONS_POLL_HZ;
116	if (polltime < 1)
117		polltime = 1;
118
119	callout_reset(&ofw_timer, polltime, ofw_timeout, tp);
120
121	return (0);
122}
123
124static void
125ofwtty_close(struct tty *tp)
126{
127
128	callout_stop(&ofw_timer);
129}
130
131static void
132ofwtty_outwakeup(struct tty *tp)
133{
134	int len;
135	u_char buf[OFBURSTLEN];
136
137	for (;;) {
138		len = ttydisc_getc(tp, buf, sizeof buf);
139		if (len == 0)
140			break;
141		OF_write(stdout, buf, len);
142	}
143}
144
145static void
146ofw_timeout(void *v)
147{
148	struct	tty *tp;
149	int 	c;
150
151	tp = (struct tty *)v;
152
153	tty_lock_assert(tp, MA_OWNED);
154	while ((c = ofw_cngetc(NULL)) != -1)
155		ttydisc_rint(tp, c, 0);
156	ttydisc_rint_done(tp);
157
158	callout_schedule(&ofw_timer, polltime);
159}
160
161static void
162ofw_cnprobe(struct consdev *cp)
163{
164	int chosen;
165
166	if ((chosen = OF_finddevice("/chosen")) == -1) {
167		cp->cn_pri = CN_DEAD;
168		return;
169	}
170
171	if (OF_getencprop(chosen, "stdin", &stdin, sizeof(stdin)) == -1) {
172		cp->cn_pri = CN_DEAD;
173		return;
174	}
175
176	if (OF_getencprop(chosen, "stdout", &stdout, sizeof(stdout)) == -1) {
177		cp->cn_pri = CN_DEAD;
178		return;
179	}
180
181	cp->cn_pri = CN_LOW;
182}
183
184static void
185ofw_cninit(struct consdev *cp)
186{
187
188	/* XXX: This is the alias, but that should be good enough */
189	strcpy(cp->cn_name, "ofwcons");
190}
191
192static void
193ofw_cnterm(struct consdev *cp)
194{
195}
196
197static void
198ofw_cngrab(struct consdev *cp)
199{
200}
201
202static void
203ofw_cnungrab(struct consdev *cp)
204{
205}
206
207static int
208ofw_cngetc(struct consdev *cp)
209{
210	unsigned char ch;
211
212	if (OF_read(stdin, &ch, 1) > 0) {
213#if defined(KDB)
214		kdb_alt_break(ch, &alt_break_state);
215#endif
216		return (ch);
217	}
218
219	return (-1);
220}
221
222static void
223ofw_cnputc(struct consdev *cp, int c)
224{
225	char cbuf;
226
227	if (c == '\n') {
228		cbuf = '\r';
229		OF_write(stdout, &cbuf, 1);
230	}
231
232	cbuf = c;
233	OF_write(stdout, &cbuf, 1);
234}
235