2 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
3 * Copyright (c) 1992-1998 Søren Schmidt
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer as
11 * the first lines of this file unmodified.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include "opt_syscons.h"
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/consio.h>
37 #include <machine/pc/display.h>
39 #include <dev/syscons/syscons.h>
40 #include <dev/syscons/sctermvar.h>
42 #ifndef SC_DUMB_TERMINAL
48 u_short fg; /* foreground color */
49 u_short bg; /* background color */
54 #define SCTERM_BUSY (1 << 0)
58 int param[MAX_ESC_PAR];
61 int attr_mask; /* current logical attr mask */
62 #define NORMAL_ATTR 0x00
63 #define BLINK_ATTR 0x01
64 #define BOLD_ATTR 0x02
65 #define UNDERLINE_ATTR 0x04
66 #define REVERSE_ATTR 0x08
67 #define FG_CHANGED 0x10
68 #define BG_CHANGED 0x20
69 int cur_attr; /* current hardware attr word */
70 color_t cur_color; /* current hardware color */
71 color_t std_color; /* normal hardware color */
72 color_t rev_color; /* reverse hardware color */
73 color_t dflt_std_color; /* default normal color */
74 color_t dflt_rev_color; /* default reverse color */
77 static sc_term_init_t scterm_init;
78 static sc_term_term_t scterm_term;
79 static sc_term_puts_t scterm_puts;
80 static sc_term_ioctl_t scterm_ioctl;
81 static sc_term_reset_t scterm_reset;
82 static sc_term_default_attr_t scterm_default_attr;
83 static sc_term_clear_t scterm_clear;
84 static sc_term_notify_t scterm_notify;
85 static sc_term_input_t scterm_input;
87 static sc_term_sw_t sc_term_sc = {
89 "sc", /* emulator name */
90 "syscons terminal", /* description */
91 "*", /* matching renderer, any :-) */
92 sizeof(term_stat), /* softc size */
105 SCTERM_MODULE(sc, sc_term_sc);
107 static term_stat reserved_term_stat;
108 static void scterm_scan_esc(scr_stat *scp, term_stat *tcp,
110 static int mask2attr(term_stat *tcp);
113 scterm_init(scr_stat *scp, void **softc, int code)
117 if (*softc == NULL) {
118 if (reserved_term_stat.flags & SCTERM_BUSY)
120 *softc = &reserved_term_stat;
125 case SC_TE_COLD_INIT:
126 bzero(tcp, sizeof(*tcp));
127 tcp->flags = SCTERM_BUSY;
129 tcp->saved_xpos = -1;
130 tcp->saved_ypos = -1;
131 tcp->attr_mask = NORMAL_ATTR;
133 tcp->dflt_std_color.fg = SC_NORM_ATTR & 0x0f;
134 tcp->dflt_std_color.bg = (SC_NORM_ATTR >> 4) & 0x0f;
135 tcp->dflt_rev_color.fg = SC_NORM_REV_ATTR & 0x0f;
136 tcp->dflt_rev_color.bg = (SC_NORM_REV_ATTR >> 4) & 0x0f;
137 tcp->std_color = tcp->dflt_std_color;
138 tcp->rev_color = tcp->dflt_rev_color;
139 tcp->cur_color = tcp->std_color;
140 tcp->cur_attr = mask2attr(tcp);
141 ++sc_term_sc.te_refcount;
144 case SC_TE_WARM_INIT:
146 tcp->saved_xpos = -1;
147 tcp->saved_ypos = -1;
149 tcp->std_color = tcp->dflt_std_color;
150 tcp->rev_color = tcp->dflt_rev_color;
152 tcp->cur_color = tcp->std_color;
153 tcp->cur_attr = mask2attr(tcp);
161 scterm_term(scr_stat *scp, void **softc)
163 if (*softc == &reserved_term_stat) {
165 bzero(&reserved_term_stat, sizeof(reserved_term_stat));
167 --sc_term_sc.te_refcount;
172 scterm_scan_esc(scr_stat *scp, term_stat *tcp, u_char c)
174 static u_char ansi_col[16] = {
177 * DEC is evil. They switch the red and blue attributes in
178 * the palette in the system console. As a simple work-around,
179 * re-map the ANSI colors appropriately.
181 FG_BLACK, FG_BLUE, FG_GREEN, FG_CYAN,
182 FG_RED, FG_MAGENTA, FG_BROWN, FG_LIGHTGREY,
183 FG_DARKGREY, FG_LIGHTBLUE, FG_LIGHTGREEN, FG_LIGHTCYAN,
184 FG_LIGHTRED, FG_LIGHTMAGENTA, FG_YELLOW, FG_WHITE
186 FG_BLACK, FG_RED, FG_GREEN, FG_BROWN,
187 FG_BLUE, FG_MAGENTA, FG_CYAN, FG_LIGHTGREY,
188 FG_DARKGREY, FG_LIGHTRED, FG_LIGHTGREEN, FG_YELLOW,
189 FG_LIGHTBLUE, FG_LIGHTMAGENTA, FG_LIGHTCYAN, FG_WHITE
192 static int cattrs[] = {
194 CONS_BLINK_CURSOR, /* blinking block */
195 CONS_CHAR_CURSOR, /* underline */
196 CONS_CHAR_CURSOR | CONS_BLINK_CURSOR, /* blinking underline */
197 CONS_RESET_CURSOR, /* reset to default */
198 CONS_HIDDEN_CURSOR, /* hide cursor */
200 static int tcattrs[] = {
201 CONS_RESET_CURSOR | CONS_LOCAL_CURSOR, /* normal */
202 CONS_HIDDEN_CURSOR | CONS_LOCAL_CURSOR, /* invisible */
203 CONS_BLINK_CURSOR | CONS_LOCAL_CURSOR, /* very visible */
211 if (tcp->esc == 1) { /* seen ESC */
214 case '7': /* Save cursor position */
215 tcp->saved_xpos = scp->xpos;
216 tcp->saved_ypos = scp->ypos;
219 case '8': /* Restore saved cursor position */
220 if (tcp->saved_xpos >= 0 && tcp->saved_ypos >= 0)
221 sc_move_cursor(scp, tcp->saved_xpos,
225 case '[': /* Start ESC [ sequence */
227 tcp->last_param = -1;
228 for (i = tcp->num_param; i < MAX_ESC_PAR; i++)
233 case 'M': /* Move cursor up 1 line, scroll if at top */
234 sc_term_up_scroll(scp, 1, sc->scr_map[0x20],
235 tcp->cur_attr, 0, 0);
242 case 'c': /* reset */
243 tcp->attr_mask = NORMAL_ATTR;
244 tcp->cur_color = tcp->std_color
245 = tcp->dflt_std_color;
246 tcp->rev_color = tcp->dflt_rev_color;
247 tcp->cur_attr = mask2attr(tcp);
248 sc_change_cursor_shape(scp,
249 CONS_RESET_CURSOR | CONS_LOCAL_CURSOR, -1, -1);
250 sc_clear_screen(scp);
253 case '(': /* iso-2022: designate 94 character set to G0 */
257 } else if (tcp->esc == 2) { /* seen ESC [ */
258 if (c >= '0' && c <= '9') {
259 if (tcp->num_param < MAX_ESC_PAR) {
260 if (tcp->last_param != tcp->num_param) {
261 tcp->last_param = tcp->num_param;
262 tcp->param[tcp->num_param] = 0;
264 tcp->param[tcp->num_param] *= 10;
266 tcp->param[tcp->num_param] += c - '0';
270 tcp->num_param = tcp->last_param + 1;
274 if (tcp->num_param < MAX_ESC_PAR)
280 tcp->last_param = -1;
281 for (i = tcp->num_param; i < MAX_ESC_PAR; i++)
286 case 'A': /* up n rows */
287 sc_term_up(scp, tcp->param[0], 0);
290 case 'B': /* down n rows */
291 sc_term_down(scp, tcp->param[0], 0);
294 case 'C': /* right n columns */
295 sc_term_right(scp, tcp->param[0]);
298 case 'D': /* left n columns */
299 sc_term_left(scp, tcp->param[0]);
302 case 'E': /* cursor to start of line n lines down */
306 sc_move_cursor(scp, 0, scp->ypos + n);
309 case 'F': /* cursor to start of line n lines up */
313 sc_move_cursor(scp, 0, scp->ypos - n);
316 case 'f': /* Cursor move */
318 if (tcp->num_param == 0)
319 sc_move_cursor(scp, 0, 0);
320 else if (tcp->num_param == 2)
321 sc_move_cursor(scp, tcp->param[1] - 1,
325 case 'J': /* Clear all or part of display */
326 if (tcp->num_param == 0)
330 sc_term_clr_eos(scp, n, sc->scr_map[0x20],
334 case 'K': /* Clear all or part of line */
335 if (tcp->num_param == 0)
339 sc_term_clr_eol(scp, n, sc->scr_map[0x20],
343 case 'L': /* Insert n lines */
344 sc_term_ins_line(scp, scp->ypos, tcp->param[0],
345 sc->scr_map[0x20], tcp->cur_attr, 0);
348 case 'M': /* Delete n lines */
349 sc_term_del_line(scp, scp->ypos, tcp->param[0],
350 sc->scr_map[0x20], tcp->cur_attr, 0);
353 case 'P': /* Delete n chars */
354 sc_term_del_char(scp, tcp->param[0],
355 sc->scr_map[0x20], tcp->cur_attr);
358 case '@': /* Insert n chars */
359 sc_term_ins_char(scp, tcp->param[0],
360 sc->scr_map[0x20], tcp->cur_attr);
363 case 'S': /* scroll up n lines */
364 sc_term_del_line(scp, 0, tcp->param[0],
365 sc->scr_map[0x20], tcp->cur_attr, 0);
368 case 'T': /* scroll down n lines */
369 sc_term_ins_line(scp, 0, tcp->param[0],
370 sc->scr_map[0x20], tcp->cur_attr, 0);
373 case 'X': /* erase n characters in line */
377 if (n > scp->xsize - scp->xpos)
378 n = scp->xsize - scp->xpos;
379 sc_vtb_erase(&scp->vtb, scp->cursor_pos, n,
380 sc->scr_map[0x20], tcp->cur_attr);
381 mark_for_update(scp, scp->cursor_pos);
382 mark_for_update(scp, scp->cursor_pos + n - 1);
385 case 'Z': /* move n tabs backwards */
386 sc_term_backtab(scp, tcp->param[0]);
389 case '`': /* move cursor to column n */
390 sc_term_col(scp, tcp->param[0]);
393 case 'a': /* move cursor n columns to the right */
394 sc_term_right(scp, tcp->param[0]);
397 case 'd': /* move cursor to row n */
398 sc_term_row(scp, tcp->param[0]);
401 case 'e': /* move cursor n rows down */
402 sc_term_down(scp, tcp->param[0], 0);
405 case 'm': /* change attribute */
406 if (tcp->num_param == 0) {
407 tcp->attr_mask = NORMAL_ATTR;
408 tcp->cur_color = tcp->std_color;
409 tcp->cur_attr = mask2attr(tcp);
412 for (i = 0; i < tcp->num_param; i++) {
413 switch (n = tcp->param[i]) {
414 case 0: /* back to normal */
415 tcp->attr_mask = NORMAL_ATTR;
416 tcp->cur_color = tcp->std_color;
417 tcp->cur_attr = mask2attr(tcp);
420 tcp->attr_mask |= BOLD_ATTR;
421 tcp->cur_attr = mask2attr(tcp);
423 case 4: /* underline */
424 tcp->attr_mask |= UNDERLINE_ATTR;
425 tcp->cur_attr = mask2attr(tcp);
428 tcp->attr_mask |= BLINK_ATTR;
429 tcp->cur_attr = mask2attr(tcp);
431 case 7: /* reverse */
432 tcp->attr_mask |= REVERSE_ATTR;
433 tcp->cur_attr = mask2attr(tcp);
435 case 22: /* remove bold (or dim) */
436 tcp->attr_mask &= ~BOLD_ATTR;
437 tcp->cur_attr = mask2attr(tcp);
439 case 24: /* remove underline */
440 tcp->attr_mask &= ~UNDERLINE_ATTR;
441 tcp->cur_attr = mask2attr(tcp);
443 case 25: /* remove blink */
444 tcp->attr_mask &= ~BLINK_ATTR;
445 tcp->cur_attr = mask2attr(tcp);
447 case 27: /* remove reverse */
448 tcp->attr_mask &= ~REVERSE_ATTR;
449 tcp->cur_attr = mask2attr(tcp);
451 case 30: case 31: /* set ansi fg color */
452 case 32: case 33: case 34:
453 case 35: case 36: case 37:
454 tcp->attr_mask |= FG_CHANGED;
455 tcp->cur_color.fg = ansi_col[n - 30];
456 tcp->cur_attr = mask2attr(tcp);
458 case 39: /* restore fg color back to normal */
459 tcp->attr_mask &= ~(FG_CHANGED|BOLD_ATTR);
460 tcp->cur_color.fg = tcp->std_color.fg;
461 tcp->cur_attr = mask2attr(tcp);
463 case 40: case 41: /* set ansi bg color */
464 case 42: case 43: case 44:
465 case 45: case 46: case 47:
466 tcp->attr_mask |= BG_CHANGED;
467 tcp->cur_color.bg = ansi_col[n - 40];
468 tcp->cur_attr = mask2attr(tcp);
470 case 49: /* restore bg color back to normal */
471 tcp->attr_mask &= ~BG_CHANGED;
472 tcp->cur_color.bg = tcp->std_color.bg;
473 tcp->cur_attr = mask2attr(tcp);
479 case 's': /* Save cursor position */
480 tcp->saved_xpos = scp->xpos;
481 tcp->saved_ypos = scp->ypos;
484 case 'u': /* Restore saved cursor position */
485 if (tcp->saved_xpos >= 0 && tcp->saved_ypos >= 0)
486 sc_move_cursor(scp, tcp->saved_xpos,
491 if (tcp->num_param == 0)
496 case 0: /* reset colors and attributes back to normal */
497 tcp->attr_mask = NORMAL_ATTR;
498 tcp->cur_color = tcp->std_color
499 = tcp->dflt_std_color;
500 tcp->rev_color = tcp->dflt_rev_color;
501 tcp->cur_attr = mask2attr(tcp);
503 case 1: /* set ansi background */
504 tcp->attr_mask &= ~BG_CHANGED;
505 tcp->cur_color.bg = tcp->std_color.bg
506 = ansi_col[tcp->param[1] & 0x0f];
507 tcp->cur_attr = mask2attr(tcp);
509 case 2: /* set ansi foreground */
510 tcp->attr_mask &= ~FG_CHANGED;
511 tcp->cur_color.fg = tcp->std_color.fg
512 = ansi_col[tcp->param[1] & 0x0f];
513 tcp->cur_attr = mask2attr(tcp);
515 case 3: /* set adapter attribute directly */
516 tcp->attr_mask &= ~(FG_CHANGED | BG_CHANGED);
517 tcp->cur_color.fg = tcp->std_color.fg
518 = tcp->param[1] & 0x0f;
519 tcp->cur_color.bg = tcp->std_color.bg
520 = (tcp->param[1] >> 4) & 0x0f;
521 tcp->cur_attr = mask2attr(tcp);
523 case 5: /* set ansi reverse background */
524 tcp->rev_color.bg = ansi_col[tcp->param[1] & 0x0f];
525 tcp->cur_attr = mask2attr(tcp);
527 case 6: /* set ansi reverse foreground */
528 tcp->rev_color.fg = ansi_col[tcp->param[1] & 0x0f];
529 tcp->cur_attr = mask2attr(tcp);
531 case 7: /* set adapter reverse attribute directly */
532 tcp->rev_color.fg = tcp->param[1] & 0x0f;
533 tcp->rev_color.bg = (tcp->param[1] >> 4) & 0x0f;
534 tcp->cur_attr = mask2attr(tcp);
539 case 'z': /* switch to (virtual) console n */
540 if (tcp->num_param == 1)
541 sc_switch_scr(sc, tcp->param[0]);
544 } else if (tcp->esc == 3) { /* seen ESC [0-9]+ = */
545 if (c >= '0' && c <= '9') {
546 if (tcp->num_param < MAX_ESC_PAR) {
547 if (tcp->last_param != tcp->num_param) {
548 tcp->last_param = tcp->num_param;
549 tcp->param[tcp->num_param] = 0;
551 tcp->param[tcp->num_param] *= 10;
553 tcp->param[tcp->num_param] += c - '0';
557 tcp->num_param = tcp->last_param + 1;
561 if (tcp->num_param < MAX_ESC_PAR)
565 case 'A': /* set display border color */
566 if (tcp->num_param == 1) {
567 scp->border=tcp->param[0] & 0xff;
568 if (scp == sc->cur_scp)
569 sc_set_border(scp, scp->border);
573 case 'B': /* set bell pitch and duration */
574 if (tcp->num_param == 2) {
575 scp->bell_pitch = tcp->param[0];
577 (tcp->param[1] * hz + 99) / 100;
581 case 'C': /* set global/parmanent cursor type & shape */
588 case 1: /* flags only */
589 if (v0 < sizeof(cattrs)/sizeof(cattrs[0]))
591 else /* backward compatibility */
592 v0 = cattrs[v0 & 0x3];
593 sc_change_cursor_shape(scp, v0, -1, -1);
597 v0 &= 0x1f; /* backward compatibility */
600 case 3: /* base and height */
601 if (v2 == 0) /* count from top */
602 sc_change_cursor_shape(scp, -1,
603 scp->font_size - v1 - 1,
605 else if (v2 == 1) /* count from bottom */
606 sc_change_cursor_shape(scp, -1,
613 case 'F': /* set adapter foreground */
614 if (tcp->num_param == 1) {
615 tcp->attr_mask &= ~FG_CHANGED;
616 tcp->cur_color.fg = tcp->std_color.fg
617 = tcp->param[0] & 0x0f;
618 tcp->cur_attr = mask2attr(tcp);
622 case 'G': /* set adapter background */
623 if (tcp->num_param == 1) {
624 tcp->attr_mask &= ~BG_CHANGED;
625 tcp->cur_color.bg = tcp->std_color.bg
626 = tcp->param[0] & 0x0f;
627 tcp->cur_attr = mask2attr(tcp);
631 case 'H': /* set adapter reverse foreground */
632 if (tcp->num_param == 1) {
633 tcp->rev_color.fg = tcp->param[0] & 0x0f;
634 tcp->cur_attr = mask2attr(tcp);
638 case 'I': /* set adapter reverse background */
639 if (tcp->num_param == 1) {
640 tcp->rev_color.bg = tcp->param[0] & 0x0f;
641 tcp->cur_attr = mask2attr(tcp);
645 case 'S': /* set local/temporary cursor type & shape */
654 if (v0 < sizeof(tcattrs)/sizeof(tcattrs[0]))
655 sc_change_cursor_shape(scp,
656 tcattrs[v0], -1, -1);
663 } else if (tcp->esc == 4) { /* seen ESC Q */
666 } else if (tcp->esc == 5) { /* seen ESC ( */
668 case 'B': /* iso-2022: desginate ASCII into G0 */
670 /* other items to be filled */
679 scterm_puts(scr_stat *scp, u_char *buf, int len)
685 scp->sc->write_in_progress++;
688 scterm_scan_esc(scp, tcp, *buf);
700 sc_term_gen_print(scp, &buf, &len, tcp->cur_attr);
705 sc_term_gen_scroll(scp, scp->sc->scr_map[0x20], tcp->cur_attr);
707 scp->sc->write_in_progress--;
713 scterm_ioctl(scr_stat *scp, struct tty *tp, u_long cmd, caddr_t data,
714 int flag, struct thread *td)
716 term_stat *tcp = scp->ts;
720 case GIO_ATTR: /* get current attributes */
722 *(int*)data = (tcp->cur_attr >> 8) & 0xff;
724 case CONS_GETINFO: /* get current (virtual) console info */
725 vi = (vid_info_t *)data;
726 if (vi->size != sizeof(struct vid_info))
728 vi->mv_norm.fore = tcp->std_color.fg;
729 vi->mv_norm.back = tcp->std_color.bg;
730 vi->mv_rev.fore = tcp->rev_color.fg;
731 vi->mv_rev.back = tcp->rev_color.bg;
733 * The other fields are filled by the upper routine. XXX
741 scterm_reset(scr_stat *scp, int code)
748 scterm_default_attr(scr_stat *scp, int color, int rev_color)
750 term_stat *tcp = scp->ts;
752 tcp->dflt_std_color.fg = color & 0x0f;
753 tcp->dflt_std_color.bg = (color >> 4) & 0x0f;
754 tcp->dflt_rev_color.fg = rev_color & 0x0f;
755 tcp->dflt_rev_color.bg = (rev_color >> 4) & 0x0f;
756 tcp->std_color = tcp->dflt_std_color;
757 tcp->rev_color = tcp->dflt_rev_color;
758 tcp->cur_color = tcp->std_color;
759 tcp->cur_attr = mask2attr(tcp);
763 scterm_clear(scr_stat *scp)
765 term_stat *tcp = scp->ts;
767 sc_move_cursor(scp, 0, 0);
768 sc_vtb_clear(&scp->vtb, scp->sc->scr_map[0x20], tcp->cur_attr);
773 scterm_notify(scr_stat *scp, int event)
776 case SC_TE_NOTIFY_VTSWITCH_IN:
778 case SC_TE_NOTIFY_VTSWITCH_OUT:
784 scterm_input(scr_stat *scp, int c, struct tty *tp)
790 * Calculate hardware attributes word using logical attributes mask and
796 mask2attr(term_stat *tcp)
798 int attr, mask = tcp->attr_mask;
800 if (mask & REVERSE_ATTR) {
801 attr = ((mask & FG_CHANGED) ?
802 tcp->cur_color.bg : tcp->rev_color.fg) |
803 (((mask & BG_CHANGED) ?
804 tcp->cur_color.fg : tcp->rev_color.bg) << 4);
806 attr = tcp->cur_color.fg | (tcp->cur_color.bg << 4);
808 /* XXX: underline mapping for Hercules adapter can be better */
809 if (mask & (BOLD_ATTR | UNDERLINE_ATTR))
811 if (mask & BLINK_ATTR)
817 #endif /* SC_DUMB_TERMINAL */