xref: /freebsd/sys/dev/cfe/cfe_console.c (revision a9148abd9da5db2f1c682fb17bed791845fc41c9)
1 /*-
2  * Copyright (c) 2007 Bruce M. Simpson.
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 THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include "opt_comconsole.h"
31 
32 #include <sys/param.h>
33 #include <sys/kdb.h>
34 #include <sys/kernel.h>
35 #include <sys/priv.h>
36 #include <sys/systm.h>
37 #include <sys/types.h>
38 #include <sys/conf.h>
39 #include <sys/cons.h>
40 #include <sys/consio.h>
41 #include <sys/tty.h>
42 
43 #include <dev/cfe/cfe_api.h>
44 #include <dev/cfe/cfe_error.h>
45 
46 #include <ddb/ddb.h>
47 
48 #ifndef	CFECONS_POLL_HZ
49 #define	CFECONS_POLL_HZ	4
50 #endif
51 #define CFEBURSTLEN	128	/* max number of bytes to write in one chunk */
52 
53 static tsw_open_t cfe_tty_open;
54 static tsw_close_t cfe_tty_close;
55 static tsw_outwakeup_t cfe_tty_outwakeup;
56 
57 static struct ttydevsw cfe_ttydevsw = {
58 	.tsw_flags	= TF_NOPREFIX,
59 	.tsw_open	= cfe_tty_open,
60 	.tsw_close	= cfe_tty_close,
61 	.tsw_outwakeup	= cfe_tty_outwakeup,
62 };
63 
64 static int			conhandle = -1;
65 static struct tty		*cfe_tp = NULL;
66 /* XXX does cfe have to poll? */
67 static int			polltime;
68 static struct callout_handle	cfe_timeouthandle
69     = CALLOUT_HANDLE_INITIALIZER(&cfe_timeouthandle);
70 
71 #if defined(KDB) && defined(ALT_BREAK_TO_DEBUGGER)
72 static int			alt_break_state;
73 #endif
74 
75 static void	cfe_timeout(void *);
76 
77 static cn_probe_t	cfe_cnprobe;
78 static cn_init_t	cfe_cninit;
79 static cn_term_t	cfe_cnterm;
80 static cn_getc_t	cfe_cngetc;
81 static cn_putc_t	cfe_cnputc;
82 
83 CONSOLE_DRIVER(cfe);
84 
85 static void
86 cn_drvinit(void *unused)
87 {
88 	char output[32];
89 	struct tty *tp;
90 
91 	if (cfe_consdev.cn_pri != CN_DEAD &&
92 	    cfe_consdev.cn_name[0] != '\0') {
93 		tp = tty_alloc(&cfe_ttydevsw, NULL, NULL);
94 		tty_makedev(tp, NULL, "%s", output);
95 		tty_makealias(tp, "cfecons");
96 	}
97 }
98 
99 static int
100 cfe_tty_open(struct tty *tp)
101 {
102 	polltime = hz / CFECONS_POLL_HZ;
103 	if (polltime < 1)
104 		polltime = 1;
105 	cfe_timeouthandle = timeout(cfe_timeout, tp, polltime);
106 
107 	return (0);
108 }
109 
110 static void
111 cfe_tty_close(struct tty *tp)
112 {
113 
114 	/* XXX Should be replaced with callout_stop(9) */
115 	untimeout(cfe_timeout, tp, cfe_timeouthandle);
116 }
117 
118 static void
119 cfe_tty_outwakeup(struct tty *tp)
120 {
121 	int len;
122 	u_char buf[CFEBURSTLEN];
123 
124 	for (;;) {
125 		len = ttydisc_getc(tp, buf, sizeof buf);
126 		if (len == 0)
127 			break;
128 		while (cfe_write(conhandle, buf, len) == 0)
129 			continue;
130 	}
131 }
132 
133 static void
134 cfe_timeout(void *v)
135 {
136 	struct	tty *tp;
137 	int 	c;
138 
139 	tp = (struct tty *)v;
140 
141 	tty_lock(tp);
142 	while ((c = cfe_cngetc(NULL)) != -1)
143 		ttydisc_rint(tp, c, 0);
144 	ttydisc_rint_done(tp);
145 	tty_unlock(tp);
146 
147 	cfe_timeouthandle = timeout(cfe_timeout, tp, polltime);
148 }
149 
150 static void
151 cfe_cnprobe(struct consdev *cp)
152 {
153 
154 	conhandle = cfe_getstdhandle(CFE_STDHANDLE_CONSOLE);
155 	if (conhandle < 0) {
156 		cp->cn_pri = CN_DEAD;
157 		return;
158 	}
159 
160 	/* XXX */
161 	if (bootverbose) {
162 		char *bootmsg = "Using CFE firmware console.\n";
163 		int i;
164 
165 		for (i = 0; i < strlen(bootmsg); i++)
166 			cfe_cnputc(cp, bootmsg[i]);
167 	}
168 
169 	cp->cn_pri = CN_LOW;
170 }
171 
172 static void
173 cfe_cninit(struct consdev *cp)
174 {
175 
176 	strcpy(cp->cn_name, "cfecons");
177 }
178 
179 static void
180 cfe_cnterm(struct consdev *cp)
181 {
182 
183 }
184 
185 static int
186 cfe_cngetc(struct consdev *cp)
187 {
188 	int result;
189 	unsigned char ch;
190 
191 	while ((result = cfe_read(conhandle, &ch, 1)) == 0)
192 		continue;
193 
194 	if (result > 0) {
195 #if defined(KDB) && defined(ALT_BREAK_TO_DEBUGGER)
196 		int kdb_brk;
197 
198 		if ((kdb_brk = kdb_alt_break(ch, &alt_break_state)) != 0) {
199 			switch (kdb_brk) {
200 			case KDB_REQ_DEBUGGER:
201 				kdb_enter(KDB_WHY_BREAK,
202 				    "Break sequence on console");
203 				break;
204 			case KDB_REQ_PANIC:
205 				kdb_panic("Panic sequence on console");
206 				break;
207 			case KDB_REQ_REBOOT:
208 				kdb_reboot();
209 				break;
210 
211 			}
212 		}
213 #endif
214 		return (ch);
215 	}
216 
217 	return (-1);
218 }
219 
220 static void
221 cfe_cnputc(struct consdev *cp, int c)
222 {
223 	char cbuf;
224 
225 	if (c == '\n')
226 		cfe_cnputc(cp, '\r');
227 
228 	cbuf = c;
229 	while (cfe_write(conhandle, &cbuf, 1) == 0)
230 		continue;
231 }
232 
233 SYSINIT(cndev, SI_SUB_CONFIGURE, SI_ORDER_MIDDLE, cn_drvinit, NULL);
234