xref: /freebsd/sys/dev/cfe/cfe_console.c (revision 884a2a699669ec61e2366e3e358342dbc94be24a)
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 /* XXX does cfe have to poll? */
66 static int			polltime;
67 static struct callout_handle	cfe_timeouthandle
68     = CALLOUT_HANDLE_INITIALIZER(&cfe_timeouthandle);
69 
70 #if defined(KDB) && defined(ALT_BREAK_TO_DEBUGGER)
71 static int			alt_break_state;
72 #endif
73 
74 static void	cfe_timeout(void *);
75 
76 static cn_probe_t	cfe_cnprobe;
77 static cn_init_t	cfe_cninit;
78 static cn_term_t	cfe_cnterm;
79 static cn_getc_t	cfe_cngetc;
80 static cn_putc_t	cfe_cnputc;
81 
82 CONSOLE_DRIVER(cfe);
83 
84 static void
85 cn_drvinit(void *unused)
86 {
87 	struct tty *tp;
88 
89 	if (cfe_consdev.cn_pri != CN_DEAD &&
90 	    cfe_consdev.cn_name[0] != '\0') {
91 		tp = tty_alloc(&cfe_ttydevsw, NULL);
92 		tty_makedev(tp, NULL, "cfecons");
93 	}
94 }
95 
96 static int
97 cfe_tty_open(struct tty *tp)
98 {
99 	polltime = hz / CFECONS_POLL_HZ;
100 	if (polltime < 1)
101 		polltime = 1;
102 	cfe_timeouthandle = timeout(cfe_timeout, tp, polltime);
103 
104 	return (0);
105 }
106 
107 static void
108 cfe_tty_close(struct tty *tp)
109 {
110 
111 	/* XXX Should be replaced with callout_stop(9) */
112 	untimeout(cfe_timeout, tp, cfe_timeouthandle);
113 }
114 
115 static void
116 cfe_tty_outwakeup(struct tty *tp)
117 {
118 	int len, written, rc;
119 	u_char buf[CFEBURSTLEN];
120 
121 	for (;;) {
122 		len = ttydisc_getc(tp, buf, sizeof buf);
123 		if (len == 0)
124 			break;
125 
126 		written = 0;
127 		while (written < len) {
128 			rc = cfe_write(conhandle, &buf[written], len - written);
129 			if (rc < 0)
130 				break;
131 			written += rc;
132 		}
133 	}
134 }
135 
136 static void
137 cfe_timeout(void *v)
138 {
139 	struct	tty *tp;
140 	int 	c;
141 
142 	tp = (struct tty *)v;
143 
144 	tty_lock(tp);
145 	while ((c = cfe_cngetc(NULL)) != -1)
146 		ttydisc_rint(tp, c, 0);
147 	ttydisc_rint_done(tp);
148 	tty_unlock(tp);
149 
150 	cfe_timeouthandle = timeout(cfe_timeout, tp, polltime);
151 }
152 
153 static void
154 cfe_cnprobe(struct consdev *cp)
155 {
156 
157 	conhandle = cfe_getstdhandle(CFE_STDHANDLE_CONSOLE);
158 	if (conhandle < 0) {
159 		cp->cn_pri = CN_DEAD;
160 		return;
161 	}
162 
163 	/* XXX */
164 	if (bootverbose) {
165 		char *bootmsg = "Using CFE firmware console.\n";
166 		int i;
167 
168 		for (i = 0; i < strlen(bootmsg); i++)
169 			cfe_cnputc(cp, bootmsg[i]);
170 	}
171 
172 	cp->cn_pri = CN_LOW;
173 }
174 
175 static void
176 cfe_cninit(struct consdev *cp)
177 {
178 
179 	strcpy(cp->cn_name, "cfecons");
180 }
181 
182 static void
183 cfe_cnterm(struct consdev *cp)
184 {
185 
186 }
187 
188 static int
189 cfe_cngetc(struct consdev *cp)
190 {
191 	unsigned char ch;
192 
193 	if (cfe_read(conhandle, &ch, 1) == 1) {
194 #if defined(KDB) && defined(ALT_BREAK_TO_DEBUGGER)
195 		int kdb_brk;
196 
197 		if ((kdb_brk = kdb_alt_break(ch, &alt_break_state)) != 0) {
198 			switch (kdb_brk) {
199 			case KDB_REQ_DEBUGGER:
200 				kdb_enter(KDB_WHY_BREAK,
201 				    "Break sequence on console");
202 				break;
203 			case KDB_REQ_PANIC:
204 				kdb_panic("Panic sequence on console");
205 				break;
206 			case KDB_REQ_REBOOT:
207 				kdb_reboot();
208 				break;
209 
210 			}
211 		}
212 #endif
213 		return (ch);
214 	}
215 
216 	return (-1);
217 }
218 
219 static void
220 cfe_cnputc(struct consdev *cp, int c)
221 {
222 	char cbuf;
223 
224 	if (c == '\n')
225 		cfe_cnputc(cp, '\r');
226 
227 	cbuf = c;
228 	while (cfe_write(conhandle, &cbuf, 1) == 0)
229 		continue;
230 }
231 
232 SYSINIT(cndev, SI_SUB_CONFIGURE, SI_ORDER_MIDDLE, cn_drvinit, NULL);
233