1/*-
2 * Copyright (c) 2009 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Ed Schouten under sponsorship from the
6 * FreeBSD Foundation.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD: user/ed/newcons/sys/kern/subr_terminal.c 256143 2013-10-08 12:01:17Z ray $");
32
33#include <sys/param.h>
34#include <sys/cons.h>
35#include <sys/consio.h>
36#include <sys/kernel.h>
37#include <sys/lock.h>
38#include <sys/malloc.h>
39#include <sys/mutex.h>
40#include <sys/systm.h>
41#include <sys/terminal.h>
42#include <sys/tty.h>
43
44#include <machine/stdarg.h>
45
46static MALLOC_DEFINE(M_TERMINAL, "terminal", "terminal device");
47
48/*
49 * Locking.
50 *
51 * Normally we don't need to lock down the terminal emulator, because
52 * the TTY lock is already held when calling teken_input().
53 * Unfortunately this is not the case when the terminal acts as a
54 * console device, because cnputc() can be called at the same time.
55 * This means terminals may need to be locked down using a spin lock.
56 */
57#define TERMINAL_LOCK(tm) do { \
58 if ((tm)->tm_flags & TF_CONS) \
59 mtx_lock_spin(&(tm)->tm_mtx); \
60 else if ((tm)->tm_tty != NULL) \
61 tty_lock((tm)->tm_tty); \
62} while (0)
63#define TERMINAL_UNLOCK(tm) do { \
64 if ((tm)->tm_flags & TF_CONS) \
65 mtx_unlock_spin(&(tm)->tm_mtx); \
66 else if ((tm)->tm_tty != NULL) \
67 tty_unlock((tm)->tm_tty); \
68} while (0)
69#define TERMINAL_LOCK_TTY(tm) do { \
70 if ((tm)->tm_flags & TF_CONS) \
71 mtx_lock_spin(&(tm)->tm_mtx); \
72} while (0)
73#define TERMINAL_UNLOCK_TTY(tm) do { \
74 if ((tm)->tm_flags & TF_CONS) \
75 mtx_unlock_spin(&(tm)->tm_mtx); \
76} while (0)
77#define TERMINAL_LOCK_CONS(tm) mtx_lock_spin(&(tm)->tm_mtx)
78#define TERMINAL_UNLOCK_CONS(tm) mtx_unlock_spin(&(tm)->tm_mtx)
79
80/*
81 * TTY routines.
82 */
83
84static tsw_open_t termtty_open;
85static tsw_close_t termtty_close;
86static tsw_outwakeup_t termtty_outwakeup;
87static tsw_ioctl_t termtty_ioctl;
88
89static struct ttydevsw terminal_tty_class = {
90 .tsw_open = termtty_open,
91 .tsw_close = termtty_close,
92 .tsw_outwakeup = termtty_outwakeup,
93 .tsw_ioctl = termtty_ioctl,
94};
95
96/*
97 * Terminal emulator routines.
98 */
99
100static tf_bell_t termteken_bell;
101static tf_cursor_t termteken_cursor;
102static tf_putchar_t termteken_putchar;
103static tf_fill_t termteken_fill;
104static tf_copy_t termteken_copy;
105static tf_param_t termteken_param;
106static tf_respond_t termteken_respond;
107
108static teken_funcs_t terminal_drawmethods = {
109 .tf_bell = termteken_bell,
110 .tf_cursor = termteken_cursor,
111 .tf_putchar = termteken_putchar,
112 .tf_fill = termteken_fill,
113 .tf_copy = termteken_copy,
114 .tf_param = termteken_param,
115 .tf_respond = termteken_respond,
116};
117
118/* Kernel message formatting. */
119static const teken_attr_t kernel_message = {
120 .ta_fgcolor = TC_WHITE,
121 .ta_bgcolor = TC_BLACK,
122 .ta_format = TF_BOLD,
123};
124
125static const teken_attr_t default_message = {
126 .ta_fgcolor = TC_WHITE,
127 .ta_bgcolor = TC_BLACK,
128};
129
130#define TCHAR_CREATE(c, a) ((c) | \
131 (a)->ta_format << 22 | \
132 teken_256to8((a)->ta_fgcolor) << 26 | \
133 teken_256to8((a)->ta_bgcolor) << 29)
134
135static void
136terminal_init(struct terminal *tm)
137{
138
139 if (tm->tm_flags & TF_CONS)
140 mtx_init(&tm->tm_mtx, "trmlck", NULL, MTX_SPIN);
141 teken_init(&tm->tm_emulator, &terminal_drawmethods, tm);
142 teken_set_defattr(&tm->tm_emulator, &default_message);
143}
144
145struct terminal *
146terminal_alloc(const struct terminal_class *tc, void *softc)
147{
148 struct terminal *tm;
149
150 tm = malloc(sizeof(struct terminal), M_TERMINAL, M_WAITOK|M_ZERO);
151 terminal_init(tm);
152
153 tm->tm_class = tc;
154 tm->tm_softc = softc;
155
156 return (tm);
157}
158
159static void
160terminal_sync_ttysize(struct terminal *tm)
161{
162 struct tty *tp;
163
164 tp = tm->tm_tty;
165 if (tp == NULL)
166 return;
167
168 tty_lock(tp);
169 tty_set_winsize(tp, &tm->tm_winsize);
170 tty_unlock(tp);
171}
172
173void
174terminal_maketty(struct terminal *tm, const char *fmt, ...)
175{
176 struct tty *tp;
177 char name[8];
178 va_list ap;
179
180 va_start(ap, fmt);
181 vsnrprintf(name, sizeof name, 32, fmt, ap);
182 va_end(ap);
183
184 tp = tty_alloc(&terminal_tty_class, tm);
185 tty_makedev(tp, NULL, "%s", name);
186 tm->tm_tty = tp;
187 terminal_sync_ttysize(tm);
188}
189
190void
191terminal_set_winsize(struct terminal *tm, const struct winsize *size)
192{
193 term_rect_t r;
194
195 tm->tm_winsize = *size;
196
197 r.tr_begin.tp_row = r.tr_begin.tp_col = 0;
198 r.tr_end.tp_row = size->ws_row;
199 r.tr_end.tp_col = size->ws_col;
200
201 TERMINAL_LOCK(tm);
202 teken_set_winsize(&tm->tm_emulator, &r.tr_end);
203 TERMINAL_UNLOCK(tm);
204
205 /* Blank screen. */
206 tm->tm_class->tc_fill(tm, &r,
207 TCHAR_CREATE((teken_char_t)' ', &default_message));
208
209 terminal_sync_ttysize(tm);
210}
211
212/*
213 * XXX: This function is a kludge. Drivers like vt(4) need to
214 * temporarily stop input when resizing, etc. This should ideally be
215 * handled within the driver.
216 */
217
218void
219terminal_mute(struct terminal *tm, int yes)
220{
221
222 TERMINAL_LOCK(tm);
223 if (yes)
224 tm->tm_flags |= TF_MUTE;
225 else
226 tm->tm_flags &= ~TF_MUTE;
227 TERMINAL_UNLOCK(tm);
228}
229
230void
231terminal_input_char(struct terminal *tm, term_char_t c)
232{
233 struct tty *tp;
234
235 tp = tm->tm_tty;
236 if (tp == NULL)
237 return;
238
239 /* Strip off any attributes. */
240 c = TCHAR_CHARACTER(c);
241
242 tty_lock(tp);
243 /*
244 * Conversion to UTF-8.
245 */
246 if (c < 0x80) {
247 ttydisc_rint(tp, c, 0);
248 } else if (c < 0x800) {
249 char str[2] = {
250 0xc0 | (c >> 6),
251 0x80 | (c & 0x3f)
252 };
253
254 ttydisc_rint_simple(tp, str, sizeof str);
255 } else if (c < 0x10000) {
256 char str[3] = {
257 0xe0 | (c >> 12),
258 0x80 | ((c >> 6) & 0x3f),
259 0x80 | (c & 0x3f)
260 };
261
262 ttydisc_rint_simple(tp, str, sizeof str);
263 } else {
264 char str[4] = {
265 0xf0 | (c >> 18),
266 0x80 | ((c >> 12) & 0x3f),
267 0x80 | ((c >> 6) & 0x3f),
268 0x80 | (c & 0x3f)
269 };
270
271 ttydisc_rint_simple(tp, str, sizeof str);
272 }
273 ttydisc_rint_done(tp);
274 tty_unlock(tp);
275}
276
277void
278terminal_input_raw(struct terminal *tm, char c)
279{
280 struct tty *tp;
281
282 tp = tm->tm_tty;
283 if (tp == NULL)
284 return;
285
286 tty_lock(tp);
287 ttydisc_rint(tp, c, 0);
288 ttydisc_rint_done(tp);
289 tty_unlock(tp);
290}
291
292void
293terminal_input_special(struct terminal *tm, unsigned int k)
294{
295 struct tty *tp;
296 const char *str;
297
298 tp = tm->tm_tty;
299 if (tp == NULL)
300 return;
301
302 str = teken_get_sequence(&tm->tm_emulator, k);
303 if (str == NULL)
304 return;
305
306 tty_lock(tp);
307 ttydisc_rint_simple(tp, str, strlen(str));
308 ttydisc_rint_done(tp);
309 tty_unlock(tp);
310}
311
312/*
313 * Binding with the TTY layer.
314 */
315
316static int
317termtty_open(struct tty *tp)
318{
319 struct terminal *tm = tty_softc(tp);
320
321 tm->tm_class->tc_opened(tm, 1);
322 return (0);
323}
324
325static void
326termtty_close(struct tty *tp)
327{
328 struct terminal *tm = tty_softc(tp);
329
330 tm->tm_class->tc_opened(tm, 0);
331}
332
333static void
334termtty_outwakeup(struct tty *tp)
335{
336 struct terminal *tm = tty_softc(tp);
337 char obuf[128];
338 size_t olen;
339 unsigned int flags = 0;
340
341 while ((olen = ttydisc_getc(tp, obuf, sizeof obuf)) > 0) {
342 TERMINAL_LOCK_TTY(tm);
343 if (!(tm->tm_flags & TF_MUTE)) {
344 tm->tm_flags &= ~TF_BELL;
345 teken_input(&tm->tm_emulator, obuf, olen);
346 flags |= tm->tm_flags;
347 }
348 TERMINAL_UNLOCK_TTY(tm);
349 }
350
351 tm->tm_class->tc_done(tm);
352 if (flags & TF_BELL)
353 tm->tm_class->tc_bell(tm);
354}
355
356static int
357termtty_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
358{
359 struct terminal *tm = tty_softc(tp);
360 int error;
361
362 switch (cmd) {
363 case CONS_GETINFO: {
364 vid_info_t *vi = (vid_info_t *)data;
365 const teken_pos_t *p;
366 int fg, bg;
367
368 if (vi->size != sizeof(vid_info_t))
369 return (EINVAL);
370
371 /* Already help the console driver by filling in some data. */
372 p = teken_get_cursor(&tm->tm_emulator);
373 vi->mv_row = p->tp_row;
374 vi->mv_col = p->tp_col;
375
376 p = teken_get_winsize(&tm->tm_emulator);
377 vi->mv_rsz = p->tp_row;
378 vi->mv_csz = p->tp_col;
379
380 teken_get_defattr_cons25(&tm->tm_emulator, &fg, &bg);
381 vi->mv_norm.fore = fg;
382 vi->mv_norm.back = bg;
383 /* XXX: keep vidcontrol happy; bold backgrounds. */
384 vi->mv_rev.fore = bg;
385 vi->mv_rev.back = fg & 0x7;
386 break;
387 }
388 }
389
390 /*
391 * Unlike various other drivers, this driver will never
392 * deallocate TTYs. This means it's safe to temporarily unlock
393 * the TTY when handling ioctls.
394 */
395 tty_unlock(tp);
396 error = tm->tm_class->tc_ioctl(tm, cmd, data, td);
397 tty_lock(tp);
398 return (error);
399}
400
401/*
402 * Binding with the kernel and debug console.
403 */
404
405static cn_probe_t termcn_cnprobe;
406static cn_init_t termcn_cninit;
407static cn_term_t termcn_cnterm;
408static cn_getc_t termcn_cngetc;
409static cn_putc_t termcn_cnputc;
410static cn_grab_t termcn_cngrab;
411static cn_ungrab_t termcn_cnungrab;
412
413const struct consdev_ops termcn_cnops = {
414 .cn_probe = termcn_cnprobe,
415 .cn_init = termcn_cninit,
416 .cn_term = termcn_cnterm,
417 .cn_getc = termcn_cngetc,
418 .cn_putc = termcn_cnputc,
419 .cn_grab = termcn_cngrab,
420 .cn_ungrab = termcn_cnungrab,
421};
422
423void
424termcn_cnregister(struct terminal *tm)
425{
426 struct consdev *cp;
427
428 cp = tm->consdev;
429 if (cp == NULL) {
430 cp = malloc(sizeof(struct consdev), M_TERMINAL,
431 M_WAITOK|M_ZERO);
432 cp->cn_ops = &termcn_cnops;
433 cp->cn_arg = tm;
434 cp->cn_pri = CN_INTERNAL;
435 sprintf(cp->cn_name, "ttyv0");
436
437 tm->tm_flags = TF_CONS;
438 tm->consdev = cp;
439
440 terminal_init(tm);
441 }
442
443 /* Attach terminal as console. */
444 cnadd(cp);
445}
446
447static void
448termcn_cngrab(struct consdev *cp)
449{
450
451}
452
453static void
454termcn_cnungrab(struct consdev *cp)
455{
456
457}
458
459static void
460termcn_cnprobe(struct consdev *cp)
461{
462 struct terminal *tm = cp->cn_arg;
463
464 if (tm == NULL) {
465 cp->cn_pri = CN_DEAD;
466 return;
467 }
468
469 tm->consdev = cp;
470 terminal_init(tm);
471
472 tm->tm_class->tc_cnprobe(tm, cp);
473}
474
475static void
476termcn_cninit(struct consdev *cp)
477{
478
479}
480
481static void
482termcn_cnterm(struct consdev *cp)
483{
484
485}
486
487static int
488termcn_cngetc(struct consdev *cp)
489{
490 struct terminal *tm = cp->cn_arg;
491
492 return (tm->tm_class->tc_cngetc(tm));
493}
494
495static void
496termcn_cnputc(struct consdev *cp, int c)
497{
498 struct terminal *tm = cp->cn_arg;
499 teken_attr_t backup;
500 char cv = c;
501
502 TERMINAL_LOCK_CONS(tm);
503 if (!(tm->tm_flags & TF_MUTE)) {
504 backup = *teken_get_curattr(&tm->tm_emulator);
505 teken_set_curattr(&tm->tm_emulator, &kernel_message);
506 teken_input(&tm->tm_emulator, &cv, 1);
507 teken_set_curattr(&tm->tm_emulator, &backup);
508 }
509 TERMINAL_UNLOCK_CONS(tm);
510
511 tm->tm_class->tc_done(tm);
512}
513
514/*
515 * Binding with the terminal emulator.
516 */
517
518static void
519termteken_bell(void *softc)
520{
521 struct terminal *tm = softc;
522
523 tm->tm_flags |= TF_BELL;
524}
525
526static void
527termteken_cursor(void *softc, const teken_pos_t *p)
528{
529 struct terminal *tm = softc;
530
531 tm->tm_class->tc_cursor(tm, p);
532}
533
534static void
535termteken_putchar(void *softc, const teken_pos_t *p, teken_char_t c,
536 const teken_attr_t *a)
537{
538 struct terminal *tm = softc;
539
540 tm->tm_class->tc_putchar(tm, p, TCHAR_CREATE(c, a));
541}
542
543static void
544termteken_fill(void *softc, const teken_rect_t *r, teken_char_t c,
545 const teken_attr_t *a)
546{
547 struct terminal *tm = softc;
548
549 tm->tm_class->tc_fill(tm, r, TCHAR_CREATE(c, a));
550}
551
552static void
553termteken_copy(void *softc, const teken_rect_t *r, const teken_pos_t *p)
554{
555 struct terminal *tm = softc;
556
557 tm->tm_class->tc_copy(tm, r, p);
558}
559
560static void
561termteken_param(void *softc, int cmd, unsigned int arg)
562{
563 struct terminal *tm = softc;
564
565 tm->tm_class->tc_param(tm, cmd, arg);
566}
567
568static void
569termteken_respond(void *softc, const void *buf, size_t len)
570{
571#if 0
572 struct terminal *tm = softc;
573 struct tty *tp;
574
575 /*
576 * Only inject a response into the TTY if the data actually
577 * originated from the TTY.
578 *
579 * XXX: This cannot be done right now. The TTY could pick up
580 * other locks. It could also in theory cause loops, when the
581 * TTY performs echoing of a command that generates even more
582 * input.
583 */
584 tp = tm->tm_tty;
585 if (tp == NULL)
586 return;
587
588 ttydisc_rint_simple(tp, buf, len);
589 ttydisc_rint_done(tp);
590#endif
591}
2 * Copyright (c) 2009 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Ed Schouten under sponsorship from the
6 * FreeBSD Foundation.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD: user/ed/newcons/sys/kern/subr_terminal.c 256143 2013-10-08 12:01:17Z ray $");
32
33#include <sys/param.h>
34#include <sys/cons.h>
35#include <sys/consio.h>
36#include <sys/kernel.h>
37#include <sys/lock.h>
38#include <sys/malloc.h>
39#include <sys/mutex.h>
40#include <sys/systm.h>
41#include <sys/terminal.h>
42#include <sys/tty.h>
43
44#include <machine/stdarg.h>
45
46static MALLOC_DEFINE(M_TERMINAL, "terminal", "terminal device");
47
48/*
49 * Locking.
50 *
51 * Normally we don't need to lock down the terminal emulator, because
52 * the TTY lock is already held when calling teken_input().
53 * Unfortunately this is not the case when the terminal acts as a
54 * console device, because cnputc() can be called at the same time.
55 * This means terminals may need to be locked down using a spin lock.
56 */
57#define TERMINAL_LOCK(tm) do { \
58 if ((tm)->tm_flags & TF_CONS) \
59 mtx_lock_spin(&(tm)->tm_mtx); \
60 else if ((tm)->tm_tty != NULL) \
61 tty_lock((tm)->tm_tty); \
62} while (0)
63#define TERMINAL_UNLOCK(tm) do { \
64 if ((tm)->tm_flags & TF_CONS) \
65 mtx_unlock_spin(&(tm)->tm_mtx); \
66 else if ((tm)->tm_tty != NULL) \
67 tty_unlock((tm)->tm_tty); \
68} while (0)
69#define TERMINAL_LOCK_TTY(tm) do { \
70 if ((tm)->tm_flags & TF_CONS) \
71 mtx_lock_spin(&(tm)->tm_mtx); \
72} while (0)
73#define TERMINAL_UNLOCK_TTY(tm) do { \
74 if ((tm)->tm_flags & TF_CONS) \
75 mtx_unlock_spin(&(tm)->tm_mtx); \
76} while (0)
77#define TERMINAL_LOCK_CONS(tm) mtx_lock_spin(&(tm)->tm_mtx)
78#define TERMINAL_UNLOCK_CONS(tm) mtx_unlock_spin(&(tm)->tm_mtx)
79
80/*
81 * TTY routines.
82 */
83
84static tsw_open_t termtty_open;
85static tsw_close_t termtty_close;
86static tsw_outwakeup_t termtty_outwakeup;
87static tsw_ioctl_t termtty_ioctl;
88
89static struct ttydevsw terminal_tty_class = {
90 .tsw_open = termtty_open,
91 .tsw_close = termtty_close,
92 .tsw_outwakeup = termtty_outwakeup,
93 .tsw_ioctl = termtty_ioctl,
94};
95
96/*
97 * Terminal emulator routines.
98 */
99
100static tf_bell_t termteken_bell;
101static tf_cursor_t termteken_cursor;
102static tf_putchar_t termteken_putchar;
103static tf_fill_t termteken_fill;
104static tf_copy_t termteken_copy;
105static tf_param_t termteken_param;
106static tf_respond_t termteken_respond;
107
108static teken_funcs_t terminal_drawmethods = {
109 .tf_bell = termteken_bell,
110 .tf_cursor = termteken_cursor,
111 .tf_putchar = termteken_putchar,
112 .tf_fill = termteken_fill,
113 .tf_copy = termteken_copy,
114 .tf_param = termteken_param,
115 .tf_respond = termteken_respond,
116};
117
118/* Kernel message formatting. */
119static const teken_attr_t kernel_message = {
120 .ta_fgcolor = TC_WHITE,
121 .ta_bgcolor = TC_BLACK,
122 .ta_format = TF_BOLD,
123};
124
125static const teken_attr_t default_message = {
126 .ta_fgcolor = TC_WHITE,
127 .ta_bgcolor = TC_BLACK,
128};
129
130#define TCHAR_CREATE(c, a) ((c) | \
131 (a)->ta_format << 22 | \
132 teken_256to8((a)->ta_fgcolor) << 26 | \
133 teken_256to8((a)->ta_bgcolor) << 29)
134
135static void
136terminal_init(struct terminal *tm)
137{
138
139 if (tm->tm_flags & TF_CONS)
140 mtx_init(&tm->tm_mtx, "trmlck", NULL, MTX_SPIN);
141 teken_init(&tm->tm_emulator, &terminal_drawmethods, tm);
142 teken_set_defattr(&tm->tm_emulator, &default_message);
143}
144
145struct terminal *
146terminal_alloc(const struct terminal_class *tc, void *softc)
147{
148 struct terminal *tm;
149
150 tm = malloc(sizeof(struct terminal), M_TERMINAL, M_WAITOK|M_ZERO);
151 terminal_init(tm);
152
153 tm->tm_class = tc;
154 tm->tm_softc = softc;
155
156 return (tm);
157}
158
159static void
160terminal_sync_ttysize(struct terminal *tm)
161{
162 struct tty *tp;
163
164 tp = tm->tm_tty;
165 if (tp == NULL)
166 return;
167
168 tty_lock(tp);
169 tty_set_winsize(tp, &tm->tm_winsize);
170 tty_unlock(tp);
171}
172
173void
174terminal_maketty(struct terminal *tm, const char *fmt, ...)
175{
176 struct tty *tp;
177 char name[8];
178 va_list ap;
179
180 va_start(ap, fmt);
181 vsnrprintf(name, sizeof name, 32, fmt, ap);
182 va_end(ap);
183
184 tp = tty_alloc(&terminal_tty_class, tm);
185 tty_makedev(tp, NULL, "%s", name);
186 tm->tm_tty = tp;
187 terminal_sync_ttysize(tm);
188}
189
190void
191terminal_set_winsize(struct terminal *tm, const struct winsize *size)
192{
193 term_rect_t r;
194
195 tm->tm_winsize = *size;
196
197 r.tr_begin.tp_row = r.tr_begin.tp_col = 0;
198 r.tr_end.tp_row = size->ws_row;
199 r.tr_end.tp_col = size->ws_col;
200
201 TERMINAL_LOCK(tm);
202 teken_set_winsize(&tm->tm_emulator, &r.tr_end);
203 TERMINAL_UNLOCK(tm);
204
205 /* Blank screen. */
206 tm->tm_class->tc_fill(tm, &r,
207 TCHAR_CREATE((teken_char_t)' ', &default_message));
208
209 terminal_sync_ttysize(tm);
210}
211
212/*
213 * XXX: This function is a kludge. Drivers like vt(4) need to
214 * temporarily stop input when resizing, etc. This should ideally be
215 * handled within the driver.
216 */
217
218void
219terminal_mute(struct terminal *tm, int yes)
220{
221
222 TERMINAL_LOCK(tm);
223 if (yes)
224 tm->tm_flags |= TF_MUTE;
225 else
226 tm->tm_flags &= ~TF_MUTE;
227 TERMINAL_UNLOCK(tm);
228}
229
230void
231terminal_input_char(struct terminal *tm, term_char_t c)
232{
233 struct tty *tp;
234
235 tp = tm->tm_tty;
236 if (tp == NULL)
237 return;
238
239 /* Strip off any attributes. */
240 c = TCHAR_CHARACTER(c);
241
242 tty_lock(tp);
243 /*
244 * Conversion to UTF-8.
245 */
246 if (c < 0x80) {
247 ttydisc_rint(tp, c, 0);
248 } else if (c < 0x800) {
249 char str[2] = {
250 0xc0 | (c >> 6),
251 0x80 | (c & 0x3f)
252 };
253
254 ttydisc_rint_simple(tp, str, sizeof str);
255 } else if (c < 0x10000) {
256 char str[3] = {
257 0xe0 | (c >> 12),
258 0x80 | ((c >> 6) & 0x3f),
259 0x80 | (c & 0x3f)
260 };
261
262 ttydisc_rint_simple(tp, str, sizeof str);
263 } else {
264 char str[4] = {
265 0xf0 | (c >> 18),
266 0x80 | ((c >> 12) & 0x3f),
267 0x80 | ((c >> 6) & 0x3f),
268 0x80 | (c & 0x3f)
269 };
270
271 ttydisc_rint_simple(tp, str, sizeof str);
272 }
273 ttydisc_rint_done(tp);
274 tty_unlock(tp);
275}
276
277void
278terminal_input_raw(struct terminal *tm, char c)
279{
280 struct tty *tp;
281
282 tp = tm->tm_tty;
283 if (tp == NULL)
284 return;
285
286 tty_lock(tp);
287 ttydisc_rint(tp, c, 0);
288 ttydisc_rint_done(tp);
289 tty_unlock(tp);
290}
291
292void
293terminal_input_special(struct terminal *tm, unsigned int k)
294{
295 struct tty *tp;
296 const char *str;
297
298 tp = tm->tm_tty;
299 if (tp == NULL)
300 return;
301
302 str = teken_get_sequence(&tm->tm_emulator, k);
303 if (str == NULL)
304 return;
305
306 tty_lock(tp);
307 ttydisc_rint_simple(tp, str, strlen(str));
308 ttydisc_rint_done(tp);
309 tty_unlock(tp);
310}
311
312/*
313 * Binding with the TTY layer.
314 */
315
316static int
317termtty_open(struct tty *tp)
318{
319 struct terminal *tm = tty_softc(tp);
320
321 tm->tm_class->tc_opened(tm, 1);
322 return (0);
323}
324
325static void
326termtty_close(struct tty *tp)
327{
328 struct terminal *tm = tty_softc(tp);
329
330 tm->tm_class->tc_opened(tm, 0);
331}
332
333static void
334termtty_outwakeup(struct tty *tp)
335{
336 struct terminal *tm = tty_softc(tp);
337 char obuf[128];
338 size_t olen;
339 unsigned int flags = 0;
340
341 while ((olen = ttydisc_getc(tp, obuf, sizeof obuf)) > 0) {
342 TERMINAL_LOCK_TTY(tm);
343 if (!(tm->tm_flags & TF_MUTE)) {
344 tm->tm_flags &= ~TF_BELL;
345 teken_input(&tm->tm_emulator, obuf, olen);
346 flags |= tm->tm_flags;
347 }
348 TERMINAL_UNLOCK_TTY(tm);
349 }
350
351 tm->tm_class->tc_done(tm);
352 if (flags & TF_BELL)
353 tm->tm_class->tc_bell(tm);
354}
355
356static int
357termtty_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
358{
359 struct terminal *tm = tty_softc(tp);
360 int error;
361
362 switch (cmd) {
363 case CONS_GETINFO: {
364 vid_info_t *vi = (vid_info_t *)data;
365 const teken_pos_t *p;
366 int fg, bg;
367
368 if (vi->size != sizeof(vid_info_t))
369 return (EINVAL);
370
371 /* Already help the console driver by filling in some data. */
372 p = teken_get_cursor(&tm->tm_emulator);
373 vi->mv_row = p->tp_row;
374 vi->mv_col = p->tp_col;
375
376 p = teken_get_winsize(&tm->tm_emulator);
377 vi->mv_rsz = p->tp_row;
378 vi->mv_csz = p->tp_col;
379
380 teken_get_defattr_cons25(&tm->tm_emulator, &fg, &bg);
381 vi->mv_norm.fore = fg;
382 vi->mv_norm.back = bg;
383 /* XXX: keep vidcontrol happy; bold backgrounds. */
384 vi->mv_rev.fore = bg;
385 vi->mv_rev.back = fg & 0x7;
386 break;
387 }
388 }
389
390 /*
391 * Unlike various other drivers, this driver will never
392 * deallocate TTYs. This means it's safe to temporarily unlock
393 * the TTY when handling ioctls.
394 */
395 tty_unlock(tp);
396 error = tm->tm_class->tc_ioctl(tm, cmd, data, td);
397 tty_lock(tp);
398 return (error);
399}
400
401/*
402 * Binding with the kernel and debug console.
403 */
404
405static cn_probe_t termcn_cnprobe;
406static cn_init_t termcn_cninit;
407static cn_term_t termcn_cnterm;
408static cn_getc_t termcn_cngetc;
409static cn_putc_t termcn_cnputc;
410static cn_grab_t termcn_cngrab;
411static cn_ungrab_t termcn_cnungrab;
412
413const struct consdev_ops termcn_cnops = {
414 .cn_probe = termcn_cnprobe,
415 .cn_init = termcn_cninit,
416 .cn_term = termcn_cnterm,
417 .cn_getc = termcn_cngetc,
418 .cn_putc = termcn_cnputc,
419 .cn_grab = termcn_cngrab,
420 .cn_ungrab = termcn_cnungrab,
421};
422
423void
424termcn_cnregister(struct terminal *tm)
425{
426 struct consdev *cp;
427
428 cp = tm->consdev;
429 if (cp == NULL) {
430 cp = malloc(sizeof(struct consdev), M_TERMINAL,
431 M_WAITOK|M_ZERO);
432 cp->cn_ops = &termcn_cnops;
433 cp->cn_arg = tm;
434 cp->cn_pri = CN_INTERNAL;
435 sprintf(cp->cn_name, "ttyv0");
436
437 tm->tm_flags = TF_CONS;
438 tm->consdev = cp;
439
440 terminal_init(tm);
441 }
442
443 /* Attach terminal as console. */
444 cnadd(cp);
445}
446
447static void
448termcn_cngrab(struct consdev *cp)
449{
450
451}
452
453static void
454termcn_cnungrab(struct consdev *cp)
455{
456
457}
458
459static void
460termcn_cnprobe(struct consdev *cp)
461{
462 struct terminal *tm = cp->cn_arg;
463
464 if (tm == NULL) {
465 cp->cn_pri = CN_DEAD;
466 return;
467 }
468
469 tm->consdev = cp;
470 terminal_init(tm);
471
472 tm->tm_class->tc_cnprobe(tm, cp);
473}
474
475static void
476termcn_cninit(struct consdev *cp)
477{
478
479}
480
481static void
482termcn_cnterm(struct consdev *cp)
483{
484
485}
486
487static int
488termcn_cngetc(struct consdev *cp)
489{
490 struct terminal *tm = cp->cn_arg;
491
492 return (tm->tm_class->tc_cngetc(tm));
493}
494
495static void
496termcn_cnputc(struct consdev *cp, int c)
497{
498 struct terminal *tm = cp->cn_arg;
499 teken_attr_t backup;
500 char cv = c;
501
502 TERMINAL_LOCK_CONS(tm);
503 if (!(tm->tm_flags & TF_MUTE)) {
504 backup = *teken_get_curattr(&tm->tm_emulator);
505 teken_set_curattr(&tm->tm_emulator, &kernel_message);
506 teken_input(&tm->tm_emulator, &cv, 1);
507 teken_set_curattr(&tm->tm_emulator, &backup);
508 }
509 TERMINAL_UNLOCK_CONS(tm);
510
511 tm->tm_class->tc_done(tm);
512}
513
514/*
515 * Binding with the terminal emulator.
516 */
517
518static void
519termteken_bell(void *softc)
520{
521 struct terminal *tm = softc;
522
523 tm->tm_flags |= TF_BELL;
524}
525
526static void
527termteken_cursor(void *softc, const teken_pos_t *p)
528{
529 struct terminal *tm = softc;
530
531 tm->tm_class->tc_cursor(tm, p);
532}
533
534static void
535termteken_putchar(void *softc, const teken_pos_t *p, teken_char_t c,
536 const teken_attr_t *a)
537{
538 struct terminal *tm = softc;
539
540 tm->tm_class->tc_putchar(tm, p, TCHAR_CREATE(c, a));
541}
542
543static void
544termteken_fill(void *softc, const teken_rect_t *r, teken_char_t c,
545 const teken_attr_t *a)
546{
547 struct terminal *tm = softc;
548
549 tm->tm_class->tc_fill(tm, r, TCHAR_CREATE(c, a));
550}
551
552static void
553termteken_copy(void *softc, const teken_rect_t *r, const teken_pos_t *p)
554{
555 struct terminal *tm = softc;
556
557 tm->tm_class->tc_copy(tm, r, p);
558}
559
560static void
561termteken_param(void *softc, int cmd, unsigned int arg)
562{
563 struct terminal *tm = softc;
564
565 tm->tm_class->tc_param(tm, cmd, arg);
566}
567
568static void
569termteken_respond(void *softc, const void *buf, size_t len)
570{
571#if 0
572 struct terminal *tm = softc;
573 struct tty *tp;
574
575 /*
576 * Only inject a response into the TTY if the data actually
577 * originated from the TTY.
578 *
579 * XXX: This cannot be done right now. The TTY could pick up
580 * other locks. It could also in theory cause loops, when the
581 * TTY performs echoing of a command that generates even more
582 * input.
583 */
584 tp = tm->tm_tty;
585 if (tp == NULL)
586 return;
587
588 ttydisc_rint_simple(tp, buf, len);
589 ttydisc_rint_done(tp);
590#endif
591}