xref: /netbsd-src/sys/arch/sparc/dev/kd.c (revision 88ab7da936c561aba9ff7492617ffb08f8d08ece) 
1 /*	$NetBSD: kd.c,v 1.44 2007/07/09 20:52:29 ad Exp $	*/
2 
3 /*-
4  * Copyright (c) 1996 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Gordon W. Ross.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * Console driver based on PROM primitives.
41  *
42  * This driver exists to provide a tty device that the indirect
43  * console driver can point to. It also provides a hook that
44  * allows another device to serve console input. This will normally
45  * be a keyboard driver (see sys/dev/sun/kbd.c)
46  */
47 
48 #include <sys/cdefs.h>
49 __KERNEL_RCSID(0, "$NetBSD: kd.c,v 1.44 2007/07/09 20:52:29 ad Exp $");
50 
51 #include "opt_kgdb.h"
52 #include "fb.h"
53 
54 #include <sys/param.h>
55 #include <sys/proc.h>
56 #include <sys/systm.h>
57 #include <sys/kernel.h>
58 #include <sys/ioctl.h>
59 #include <sys/tty.h>
60 #include <sys/file.h>
61 #include <sys/conf.h>
62 #include <sys/device.h>
63 #include <sys/kauth.h>
64 
65 #include <machine/bsd_openprom.h>
66 #include <machine/promlib.h>
67 #include <machine/eeprom.h>
68 #include <machine/psl.h>
69 #include <machine/cpu.h>
70 #include <machine/kbd.h>
71 #include <machine/autoconf.h>
72 
73 #if defined(RASTERCONSOLE) && NFB > 0
74 #include <dev/sun/fbio.h>
75 #include <dev/sun/fbvar.h>
76 #endif
77 
78 #include <dev/cons.h>
79 #include <sparc/dev/cons.h>
80 
81 #include <dev/sun/event_var.h>
82 #include <dev/sun/kbd_xlate.h>
83 #include <dev/sun/kbdvar.h>
84 
85 #define PUT_WSIZE	64
86 
87 struct kd_softc {
88 	struct	device kd_dev;		/* required first: base device */
89 	struct  tty *kd_tty;
90 	int rows, cols;
91 
92 	/* Console input hook */
93 	struct cons_channel *kd_in;
94 };
95 
96 /*
97  * There is no point in pretending there might be
98  * more than one keyboard/display device.
99  */
100 static struct kd_softc kd_softc;
101 
102 /* For keyboard driver to register itself as console input */
103 void kd_attach_input(struct cons_channel *);
104 
105 static void kd_init(struct kd_softc *);
106 static void kdstart(struct tty *);
107 static void kd_later(void *);
108 static void kd_putfb(struct tty *);
109 static int kdparam(struct tty *, struct termios *);
110 static void kd_cons_input(int);
111 
112 dev_type_open(kdopen);
113 dev_type_close(kdclose);
114 dev_type_read(kdread);
115 dev_type_write(kdwrite);
116 dev_type_ioctl(kdioctl);
117 dev_type_tty(kdtty);
118 dev_type_poll(kdpoll);
119 
120 const struct cdevsw kd_cdevsw = {
121 	kdopen, kdclose, kdread, kdwrite, kdioctl,
122 	nostop, kdtty, kdpoll, nommap, ttykqfilter, D_TTY
123 };
124 
125 /*
126  * Prepare the console tty; called on first open of /dev/console
127  */
128 static void
129 kd_init(struct kd_softc *kd)
130 {
131 	struct tty *tp;
132 
133 	tp = ttymalloc();
134 	tp->t_oproc = kdstart;
135 	tp->t_param = kdparam;
136 	tp->t_dev = makedev(cdevsw_lookup_major(&kd_cdevsw), 0);
137 
138 	tty_attach(tp);
139 	kd->kd_tty = tp;
140 
141 	/*
142 	 * Get the console struct winsize.
143 	 */
144 #if defined(RASTERCONSOLE) && NFB > 0
145 	/* If the raster console driver is attached, copy its size */
146 	kd->rows = fbrcons_rows();
147 	kd->cols = fbrcons_cols();
148 	rcons_ttyinit(tp);
149 #endif
150 
151 	/* else, consult the PROM */
152 	switch (prom_version()) {
153 	char prop[6+1];		/* Enough for six digits */
154 	struct eeprom *ep;
155 	case PROM_OLDMON:
156 		if ((ep = (struct eeprom *)eeprom_va) == NULL)
157 			break;
158 		if (kd->rows == 0)
159 			kd->rows = (u_short)ep->eeTtyRows;
160 		if (kd->cols == 0)
161 			kd->cols = (u_short)ep->eeTtyCols;
162 		break;
163 
164 	case PROM_OBP_V0:
165 	case PROM_OBP_V2:
166 	case PROM_OBP_V3:
167 	case PROM_OPENFIRM:
168 		if (kd->rows == 0 &&
169 		    prom_getoption("screen-#rows", prop, sizeof prop) == 0)
170 			kd->rows = strtoul(prop, NULL, 10);
171 
172 		if (kd->cols == 0 &&
173 		    prom_getoption("screen-#columns", prop, sizeof prop) == 0)
174 			kd->cols = strtoul(prop, NULL, 10);
175 
176 		break;
177 	}
178 
179 	return;
180 }
181 
182 struct tty *
183 kdtty(dev_t dev)
184 {
185 	struct kd_softc *kd;
186 
187 	kd = &kd_softc; 	/* XXX */
188 	return (kd->kd_tty);
189 }
190 
191 int
192 kdopen(dev_t dev, int flag, int mode, struct lwp *l)
193 {
194 	struct kd_softc *kd;
195 	int error, s, unit;
196 	struct tty *tp;
197 static	int firstopen = 1;
198 
199 	unit = minor(dev);
200 	if (unit != 0)
201 		return ENXIO;
202 
203 	kd = &kd_softc; 	/* XXX */
204 	if (firstopen) {
205 		kd_init(kd);
206 		firstopen = 0;
207 	}
208 
209 	tp = kd->kd_tty;
210 
211 	/* It's simpler to do this up here. */
212 	if (kauth_authorize_device_tty(l->l_cred, KAUTH_DEVICE_TTY_OPEN, tp))
213 		return (EBUSY);
214 
215 	s = spltty();
216 	if ((tp->t_state & TS_ISOPEN) == 0) {
217 		/* First open. */
218 
219 		/* Notify the input device that serves us */
220 		struct cons_channel *cc = kd->kd_in;
221 		if (cc != NULL &&
222 		    (error = (*cc->cc_iopen)(cc)) != 0) {
223 			return (error);
224 		}
225 
226 		ttychars(tp);
227 		tp->t_iflag = TTYDEF_IFLAG;
228 		tp->t_oflag = TTYDEF_OFLAG;
229 		tp->t_cflag = TTYDEF_CFLAG;
230 		tp->t_lflag = TTYDEF_LFLAG;
231 		tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
232 		(void) kdparam(tp, &tp->t_termios);
233 		ttsetwater(tp);
234 		tp->t_winsize.ws_row = kd->rows;
235 		tp->t_winsize.ws_col = kd->cols;
236 		/* Flush pending input?  Clear translator? */
237 		/* This (pseudo)device always has SOFTCAR */
238 		tp->t_state |= TS_CARR_ON;
239 	}
240 
241 	splx(s);
242 
243 	return ((*tp->t_linesw->l_open)(dev, tp));
244 }
245 
246 int
247 kdclose(dev_t dev, int flag, int mode, struct lwp *l)
248 {
249 	struct kd_softc *kd;
250 	struct tty *tp;
251 	struct cons_channel *cc;
252 
253 	kd = &kd_softc; 	/* XXX */
254 	tp = kd->kd_tty;
255 
256 	/* XXX This is for cons.c. */
257 	if ((tp->t_state & TS_ISOPEN) == 0)
258 		return 0;
259 
260 	(*tp->t_linesw->l_close)(tp, flag);
261 	ttyclose(tp);
262 
263 	if ((cc = kd->kd_in) != NULL)
264 		(void)(*cc->cc_iclose)(cc);
265 
266 	return (0);
267 }
268 
269 int
270 kdread(dev_t dev, struct uio *uio, int flag)
271 {
272 	struct kd_softc *kd;
273 	struct tty *tp;
274 
275 	kd = &kd_softc; 	/* XXX */
276 	tp = kd->kd_tty;
277 
278 	return ((*tp->t_linesw->l_read)(tp, uio, flag));
279 }
280 
281 int
282 kdwrite(dev_t dev, struct uio *uio, int flag)
283 {
284 	struct kd_softc *kd;
285 	struct tty *tp;
286 
287 	kd = &kd_softc; 	/* XXX */
288 	tp = kd->kd_tty;
289 
290 	return ((*tp->t_linesw->l_write)(tp, uio, flag));
291 }
292 
293 int
294 kdpoll(dev_t dev, int events, struct lwp *l)
295 {
296 	struct kd_softc *kd;
297 	struct tty *tp;
298 
299 	kd = &kd_softc; 	/* XXX */
300 	tp = kd->kd_tty;
301 
302 	return ((*tp->t_linesw->l_poll)(tp, events, l));
303 }
304 
305 int
306 kdioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
307 {
308 	struct kd_softc *kd;
309 	struct tty *tp;
310 	int error;
311 
312 	kd = &kd_softc; 	/* XXX */
313 	tp = kd->kd_tty;
314 
315 	error = (*tp->t_linesw->l_ioctl)(tp, cmd, data, flag, l);
316 	if (error != EPASSTHROUGH)
317 		return error;
318 
319 	error = ttioctl(tp, cmd, data, flag, l);
320 	if (error != EPASSTHROUGH)
321 		return error;
322 
323 	/* Handle any ioctl commands specific to kbd/display. */
324 	/* XXX - Send KB* ioctls to kbd module? */
325 	/* XXX - Send FB* ioctls to fb module?  */
326 
327 	return EPASSTHROUGH;
328 }
329 
330 static int
331 kdparam(struct tty *tp, struct termios *t)
332 {
333 
334 	/* XXX - These are ignored... */
335 	tp->t_ispeed = t->c_ispeed;
336 	tp->t_ospeed = t->c_ospeed;
337 	tp->t_cflag = t->c_cflag;
338 	return 0;
339 }
340 
341 static void
342 kdstart(struct tty *tp)
343 {
344 	struct clist *cl;
345 	int s1, s2;
346 
347 	s1 = splsoftclock();
348 	s2 = spltty();
349 	if (tp->t_state & (TS_BUSY|TS_TTSTOP|TS_TIMEOUT))
350 		goto out;
351 
352 	cl = &tp->t_outq;
353 	if (cl->c_cc) {
354 		tp->t_state |= TS_BUSY;
355 		if ((s1 & PSR_PIL) == 0) {
356 			/* called at level zero - update screen now. */
357 			splx(s2);
358 			kd_putfb(tp);
359 			s2 = spltty();
360 			tp->t_state &= ~TS_BUSY;
361 		} else {
362 			/* called at interrupt level - do it later */
363 			callout_reset(&tp->t_rstrt_ch, 0, kd_later, tp);
364 		}
365 	}
366 	if (cl->c_cc <= tp->t_lowat) {
367 		if (tp->t_state & TS_ASLEEP) {
368 			tp->t_state &= ~TS_ASLEEP;
369 			wakeup((void *)cl);
370 		}
371 		selwakeup(&tp->t_wsel);
372 	}
373 out:
374 	splx(s2);
375 	splx(s1);
376 }
377 
378 /*
379  * Timeout function to do delayed writes to the screen.
380  * Called at splsoftclock when requested by kdstart.
381  */
382 static void
383 kd_later(void *arg)
384 {
385 	struct tty *tp = arg;
386 	int s;
387 
388 	kd_putfb(tp);
389 
390 	s = spltty();
391 	tp->t_state &= ~TS_BUSY;
392 	(*tp->t_linesw->l_start)(tp);
393 	splx(s);
394 }
395 
396 /*
397  * Put text on the screen using the PROM monitor.
398  * This can take a while, so to avoid missing
399  * interrupts, this is called at splsoftclock.
400  */
401 static void
402 kd_putfb(struct tty *tp)
403 {
404 	char buf[PUT_WSIZE];
405 	struct clist *cl = &tp->t_outq;
406 	char *p, *end;
407 	int len;
408 
409 	while ((len = q_to_b(cl, buf, PUT_WSIZE-1)) > 0) {
410 		/* PROM will barf if high bits are set. */
411 		p = buf;
412 		end = buf + len;
413 		while (p < end)
414 			*p++ &= 0x7f;
415 
416 		/* Now let the PROM print it. */
417 		prom_putstr(buf, len);
418 	}
419 }
420 
421 /*
422  * Our "interrupt" routine for input. This is called by
423  * the keyboard driver (dev/sun/kbd.c) at spltty.
424  */
425 static void
426 kd_cons_input(int c)
427 {
428 	struct kd_softc *kd = &kd_softc;
429 	struct tty *tp;
430 
431 	/* XXX: Make sure the device is open. */
432 	tp = kd->kd_tty;
433 	if (tp == NULL)
434 		return;
435 	if ((tp->t_state & TS_ISOPEN) == 0)
436 		return;
437 
438 	(*tp->t_linesw->l_rint)(c, tp);
439 }
440 
441 void
442 cons_attach_input(struct cons_channel *cc, struct consdev *cn)
443 {
444 	struct kd_softc *kd = &kd_softc;
445 
446 	kd->kd_in = cc;
447 	cc->cc_upstream = kd_cons_input;
448 }
449 
450 void
451 kd_attach_input(struct cons_channel *cc)
452 {
453 	struct kd_softc *kd = &kd_softc;
454 
455 	kd->kd_in = cc;
456 	cc->cc_upstream = kd_cons_input;
457 }
458 
459 /*
460  * Default PROM-based console input stream
461  * Since the PROM does not notify us when data is available on the
462  * input channel these functions periodically poll the PROM.
463  */
464 static int kd_rom_iopen(struct cons_channel *);
465 static int kd_rom_iclose(struct cons_channel *);
466 static void kd_rom_intr(void *);
467 
468 static struct cons_channel prom_cons_channel = {
469 	NULL,			/* no private data */
470 	kd_rom_iopen,
471 	kd_rom_iclose,
472 	NULL			/* will be set by kd driver */
473 };
474 
475 static struct callout prom_cons_callout;
476 
477 static int
478 kd_rom_iopen(struct cons_channel *cc)
479 {
480 	static bool callo;
481 
482 	if (!callo) {
483 		callout_init(&prom_cons_callout, 0);
484 		callo = true;
485 	}
486 
487 	/* Poll for ROM input 4 times per second */
488 	callout_reset(&prom_cons_callout, hz / 4, kd_rom_intr, cc);
489 	return (0);
490 }
491 
492 static int
493 kd_rom_iclose(struct cons_channel *cc)
494 {
495 
496 	callout_stop(&prom_cons_callout);
497 	return (0);
498 }
499 
500 /*
501  * "Interrupt" routine for input through ROM vectors
502  */
503 static void
504 kd_rom_intr(void *arg)
505 {
506 	struct cons_channel *cc = arg;
507 	int s, c;
508 
509 	callout_schedule(&prom_cons_callout, hz / 4);
510 
511 	s = spltty();
512 
513 	while ((c = prom_peekchar()) >= 0)
514 		(*cc->cc_upstream)(c);
515 
516 	splx(s);
517 }
518 
519 /*****************************************************************/
520 
521 int prom_stdin_node;
522 int prom_stdout_node;
523 char prom_stdin_args[16];
524 char prom_stdout_args[16];
525 
526 static void prom_cnprobe(struct consdev *);
527 static void prom_cninit(struct consdev *);
528 int  prom_cngetc(dev_t);	/* XXX: for sunkbd_wskbd_cngetc */
529 static void prom_cnputc(dev_t, int);
530 static void prom_cnpollc(dev_t, int);
531 
532 /*
533  * The console is set to this one initially,
534  * which lets us use the PROM until consinit()
535  * is called to select a real console.
536  */
537 struct consdev consdev_prom = {
538 	prom_cnprobe,
539 	prom_cninit,
540 	prom_cngetc,
541 	prom_cnputc,
542 	prom_cnpollc,
543 	NULL,
544 };
545 
546 /*
547  * The console table pointer is statically initialized
548  * to point to the PROM table, so that early calls to printf will work.
549  */
550 struct consdev *cn_tab = &consdev_prom;
551 
552 static void
553 prom_cnprobe(struct consdev *cn)
554 {
555 }
556 
557 static void
558 prom_cninit(struct consdev *cn)
559 {
560 }
561 
562 static void
563 prom_cnpollc(dev_t dev, int on)
564 {
565 
566 	if (on) {
567 		/* Entering debugger. */
568 #if NFB > 0
569 		fb_unblank();
570 #endif
571 	} else {
572 		/* Resuming kernel. */
573 	}
574 }
575 
576 
577 /*
578  * PROM console input putchar.
579  */
580 int
581 prom_cngetc(dev_t dev)
582 {
583 	int s, c;
584 
585 	s = splhigh();
586 	c = prom_getchar();
587 	splx(s);
588 	return (c);
589 }
590 
591 /*
592  * PROM console output putchar.
593  */
594 static void
595 prom_cnputc(dev_t dev, int c)
596 {
597 
598 	prom_putchar(c);
599 }
600 
601 
602 /*****************************************************************/
603 
604 static void prom_get_device_args(const char *, char *, unsigned int);
605 
606 static void
607 prom_get_device_args(const char *prop, char *args, unsigned int sz)
608 {
609 	const char *cp;
610 	char buffer[128];
611 
612 	cp = prom_getpropstringA(findroot(), prop, buffer, sizeof buffer);
613 
614 	/*
615 	 * Extract device-specific arguments from a PROM device path (if any)
616 	 */
617 	cp = buffer + strlen(buffer);
618 	while (cp >= buffer) {
619 		if (*cp == ':') {
620 			strncpy(args, cp+1, sz);
621 			break;
622 		}
623 		cp--;
624 	}
625 }
626 
627 /*
628  *
629  */
630 void
631 consinit(void)
632 {
633 	int inSource, outSink;
634 
635 	switch (prom_version()) {
636 	case PROM_OLDMON:
637 	case PROM_OBP_V0:
638 		/* The stdio handles identify the device type */
639 		inSource = prom_stdin();
640 		outSink  = prom_stdout();
641 		break;
642 
643 	case PROM_OBP_V2:
644 	case PROM_OBP_V3:
645 	case PROM_OPENFIRM:
646 
647 		/* Save PROM arguments for device matching */
648 		prom_get_device_args("stdin-path", prom_stdin_args,
649 				     sizeof(prom_stdin_args));
650 		prom_get_device_args("stdout-path", prom_stdout_args,
651 				    sizeof(prom_stdout_args));
652 
653 		/*
654 		 * Translate the STDIO package instance (`ihandle') -- that
655 		 * the PROM has already opened for us -- to a device tree
656 		 * node (i.e. a `phandle').
657 		 */
658 
659 		prom_stdin_node = prom_instance_to_package(prom_stdin());
660 		if (prom_stdin_node == 0)
661 			printf("consinit: cannot convert stdin ihandle\n");
662 
663 		prom_stdout_node = prom_instance_to_package(prom_stdout());
664 		if (prom_stdout_node == 0) {
665 			printf("consinit: cannot convert stdout ihandle\n");
666 			break;
667 		}
668 
669 		break;
670 
671 	default:
672 		break;
673 	}
674 
675 	/* Wire up /dev/console */
676 	cn_tab->cn_dev = makedev(cdevsw_lookup_major(&kd_cdevsw), 0);
677 	cn_tab->cn_pri = CN_INTERNAL;
678 
679 	/* Set up initial PROM input channel for /dev/console */
680 	cons_attach_input(&prom_cons_channel, cn_tab);
681 
682 #ifdef	KGDB
683 	zs_kgdb_init();	/* XXX */
684 #endif
685 }
686