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