2 * Copyright (c) 1995-1998 Søren Schmidt
5 * This code is derived from software contributed to The DragonFly Project
6 * by Sascha Wildner <saw@online.de>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer,
13 * without modification, immediately at the beginning of the file.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _DEV_SYSCONS_SYSCONS_H_
35 #define _DEV_SYSCONS_SYSCONS_H_
37 #include <sys/kdb.h> /* XXX */
38 #include <sys/_lock.h>
39 #include <sys/_mutex.h>
41 /* default values for configuration options */
49 #define SC_NO_CUTPASTE 1
52 #ifdef SC_NO_MODE_CHANGE
56 /* Always load font data if the pixel (raster text) mode is to be used. */
58 #undef SC_NO_FONT_LOADING
62 * If font data is not available, the `arrow'-shaped mouse cursor cannot
63 * be drawn. Use the alternative drawing method.
65 #ifdef SC_NO_FONT_LOADING
66 #undef SC_ALT_MOUSE_IMAGE
67 #define SC_ALT_MOUSE_IMAGE 1
70 #ifndef SC_CURSOR_CHAR
71 #define SC_CURSOR_CHAR 7
75 #define SC_MOUSE_CHAR 8
78 #if SC_MOUSE_CHAR <= SC_CURSOR_CHAR && SC_CURSOR_CHAR < (SC_MOUSE_CHAR + 4)
80 #define SC_CURSOR_CHAR (SC_MOUSE_CHAR + 4)
83 #ifndef SC_DEBUG_LEVEL
84 #define SC_DEBUG_LEVEL 0
87 #define DPRINTF(l, p) if (SC_DEBUG_LEVEL >= (l)) printf p
90 #define SC_DRIVER_NAME "sc"
93 * Use a different driver name on sparc64 so it does not get confused
94 * with the system controller devices which are also termed 'sc' in OFW.
96 #define SC_DRIVER_NAME "syscons"
98 #define SC_VTY(dev) (((sc_ttysoftc *)tty_softc(tp))->st_index)
99 #define SC_DEV(sc, vty) ((sc)->dev[(vty) - (sc)->first_vty])
100 #define SC_STAT(tp) (*((scr_stat **)&((sc_ttysoftc *)tty_softc(tp))->st_stat))
102 /* printable chars */
104 #define PRINTABLE(ch) ((ch) > 0x1b || ((ch) > 0x0d && (ch) < 0x1b) \
108 /* macros for "intelligent" screen update */
109 #define mark_for_update(scp, x) {\
110 if ((x) < scp->start) scp->start = (x);\
111 else if ((x) > scp->end) scp->end = (x);\
113 #define mark_all(scp) {\
115 scp->end = scp->xsize * scp->ysize - 1;\
118 /* vty status flags (scp->status) */
119 #define UNKNOWN_MODE 0x00010 /* unknown video mode */
120 #define SWITCH_WAIT_REL 0x00080 /* waiting for vty release */
121 #define SWITCH_WAIT_ACQ 0x00100 /* waiting for vty ack */
122 #define BUFFER_SAVED 0x00200 /* vty buffer is saved */
123 #define CURSOR_ENABLED 0x00400 /* text cursor is enabled */
124 #define MOUSE_MOVED 0x01000 /* mouse cursor has moved */
125 #define MOUSE_CUTTING 0x02000 /* mouse cursor is cutting text */
126 #define MOUSE_VISIBLE 0x04000 /* mouse cursor is showing */
127 #define GRAPHICS_MODE 0x08000 /* vty is in a graphics mode */
128 #define PIXEL_MODE 0x10000 /* vty is in a raster text mode */
129 #define SAVER_RUNNING 0x20000 /* screen saver is running */
130 #define VR_CURSOR_BLINK 0x40000 /* blinking text cursor */
131 #define VR_CURSOR_ON 0x80000 /* text cursor is on */
132 #define MOUSE_HIDDEN 0x100000 /* mouse cursor is temporarily hidden */
139 The following #defines are hard-coded for a maximum text
140 resolution corresponding to a maximum framebuffer
141 resolution of 1920x1200 with an 8x8 font...
148 #ifndef BELL_DURATION
149 #define BELL_DURATION ((5 * hz + 99) / 100)
150 #define BELL_PITCH 800
153 /* virtual terminal buffer */
154 typedef struct sc_vtb {
156 #define VTB_VALID (1 << 0)
157 #define VTB_ALLOCED (1 << 1)
159 #define VTB_INVALID 0
161 #define VTB_FRAMEBUFFER 2
162 #define VTB_RINGBUFFER 3
166 vm_offset_t vtb_buffer;
167 int vtb_tail; /* valid for VTB_RINGBUFFER only */
170 /* text cursor attributes */
180 struct video_adapter;
192 typedef struct sc_softc {
193 int unit; /* unit # */
194 int config; /* configuration flags */
195 #define SC_VESAMODE (1 << 7)
196 #define SC_AUTODETECT_KBD (1 << 8)
197 #define SC_KERNEL_CONSOLE (1 << 9)
199 int flags; /* status flags */
200 #define SC_VISUAL_BELL (1 << 0)
201 #define SC_QUIET_BELL (1 << 1)
202 #if 0 /* not used anymore */
203 #define SC_BLINK_CURSOR (1 << 2)
204 #define SC_CHAR_CURSOR (1 << 3)
206 #define SC_MOUSE_ENABLED (1 << 4)
207 #define SC_SCRN_IDLE (1 << 5)
208 #define SC_SCRN_BLANKED (1 << 6)
209 #define SC_SAVER_FAILED (1 << 7)
210 #define SC_SCRN_VTYLOCK (1 << 8)
212 #define SC_INIT_DONE (1 << 16)
213 #define SC_SPLASH_SCRN (1 << 17)
215 int keyboard; /* -1 if unavailable */
216 struct keyboard *kbd;
219 struct video_adapter *adp;
220 int initial_mode; /* initial video mode */
225 struct scr_stat *cur_scp;
226 struct scr_stat *new_scp;
227 struct scr_stat *old_scp;
228 int delayed_next_scr;
230 char font_loading_in_progress;
231 char switch_in_progress;
232 char write_in_progress;
233 char blink_in_progress;
235 /* 2 is just enough for kdb to grab for stepping normal grabbing: */
236 struct sc_cnstate grab_state[2];
238 struct mtx video_mtx;
240 long scrn_time_stamp;
242 struct cursor_attr dflt_curs_attr;
243 struct cursor_attr curs_attr;
246 u_char scr_rmap[256];
248 #ifdef _SC_MD_SOFTC_DECLARED_
249 sc_md_softc_t md; /* machine dependent vars */
252 #ifndef SC_NO_PALETTE_LOADING
253 u_char palette[256 * 3];
255 u_char palette2[256 * 3];
259 #ifndef SC_NO_FONT_LOADING
277 struct callout ctimeout;
278 struct callout cblink;
282 typedef struct scr_stat {
283 int index; /* index of this vty */
284 struct sc_softc *sc; /* pointer to softc */
285 struct sc_rndr_sw *rndr; /* renderer */
291 int xpos; /* current X position */
292 int ypos; /* current Y position */
293 int xsize; /* X text size */
294 int ysize; /* Y text size */
295 int xpixel; /* X graphics size */
296 int ypixel; /* Y graphics size */
297 int xoff; /* X offset in pixel mode */
298 int yoff; /* Y offset in pixel mode */
300 u_char *font; /* current font */
301 int font_size; /* fontsize in Y direction */
302 int font_width; /* fontsize in X direction */
304 int start; /* modified area start */
305 int end; /* modified area end */
307 struct sc_term_sw *tsw;
310 int status; /* status (bitfield) */
311 int kbd_mode; /* keyboard I/O mode */
313 int cursor_pos; /* cursor buffer position */
314 int cursor_oldpos; /* cursor old buffer position */
315 struct cursor_attr dflt_curs_attr;
316 struct cursor_attr curr_curs_attr;
317 struct cursor_attr curs_attr;
319 int mouse_pos; /* mouse buffer position */
320 int mouse_oldpos; /* mouse old buffer position */
321 short mouse_xpos; /* mouse x coordinate */
322 short mouse_ypos; /* mouse y coordinate */
323 short mouse_oldxpos; /* mouse previous x coordinate */
324 short mouse_oldypos; /* mouse previous y coordinate */
325 short mouse_buttons; /* mouse buttons */
326 int mouse_cut_start; /* mouse cut start pos */
327 int mouse_cut_end; /* mouse cut end pos */
328 int mouse_level; /* xterm mouse protocol */
329 struct proc *mouse_proc; /* proc* of controlling proc */
330 pid_t mouse_pid; /* pid of controlling proc */
331 int mouse_signal; /* signal # to report with */
333 u_short bell_duration;
336 u_char border; /* border color */
338 pid_t pid; /* pid of controlling proc */
339 struct proc *proc; /* proc* of controlling proc */
340 struct vt_mode smode; /* switch mode */
342 sc_vtb_t *history; /* circular history buffer */
343 int history_pos; /* position shown on screen */
344 int history_size; /* size of history buffer */
346 int splash_save_mode; /* saved mode for splash screen */
347 int splash_save_status; /* saved status for splash screen */
348 #ifdef _SCR_MD_STAT_DECLARED_
349 scr_md_stat_t md; /* machine dependent vars */
354 typedef struct sc_ttysoftc {
360 #define SC_NORM_ATTR (FG_LIGHTGREY | BG_BLACK)
362 #ifndef SC_NORM_REV_ATTR
363 #define SC_NORM_REV_ATTR (FG_BLACK | BG_LIGHTGREY)
365 #ifndef SC_KERNEL_CONS_ATTR
366 #define SC_KERNEL_CONS_ATTR (FG_WHITE | BG_BLACK)
368 #ifndef SC_KERNEL_CONS_REV_ATTR
369 #define SC_KERNEL_CONS_REV_ATTR (FG_BLACK | BG_LIGHTGREY)
372 /* terminal emulator */
375 #define SC_DFLT_TERM "*" /* any */
378 typedef int sc_term_init_t(scr_stat *scp, void **tcp, int code);
379 #define SC_TE_COLD_INIT 0
380 #define SC_TE_WARM_INIT 1
381 typedef int sc_term_term_t(scr_stat *scp, void **tcp);
382 typedef void sc_term_puts_t(scr_stat *scp, u_char *buf, int len);
383 typedef int sc_term_ioctl_t(scr_stat *scp, struct tty *tp, u_long cmd,
384 caddr_t data, struct thread *td);
385 typedef int sc_term_reset_t(scr_stat *scp, int code);
386 #define SC_TE_HARD_RESET 0
387 #define SC_TE_SOFT_RESET 1
388 typedef void sc_term_default_attr_t(scr_stat *scp, int norm, int rev);
389 typedef void sc_term_clear_t(scr_stat *scp);
390 typedef void sc_term_notify_t(scr_stat *scp, int event);
391 #define SC_TE_NOTIFY_VTSWITCH_IN 0
392 #define SC_TE_NOTIFY_VTSWITCH_OUT 1
393 typedef int sc_term_input_t(scr_stat *scp, int c, struct tty *tp);
394 typedef const char *sc_term_fkeystr_t(scr_stat *scp, int c);
395 typedef void sc_term_sync_t(scr_stat *scp);
397 typedef struct sc_term_sw {
398 LIST_ENTRY(sc_term_sw) link;
399 char *te_name; /* name of the emulator */
400 char *te_desc; /* description */
401 char *te_renderer; /* matching renderer */
402 size_t te_size; /* size of internal buffer */
403 int te_refcount; /* reference counter */
404 sc_term_init_t *te_init;
405 sc_term_term_t *te_term;
406 sc_term_puts_t *te_puts;
407 sc_term_ioctl_t *te_ioctl;
408 sc_term_reset_t *te_reset;
409 sc_term_default_attr_t *te_default_attr;
410 sc_term_clear_t *te_clear;
411 sc_term_notify_t *te_notify;
412 sc_term_input_t *te_input;
413 sc_term_fkeystr_t *te_fkeystr;
414 sc_term_sync_t *te_sync;
417 #define SCTERM_MODULE(name, sw) \
418 DATA_SET(scterm_set, sw); \
420 scterm_##name##_event(module_t mod, int type, void *data) \
424 return sc_term_add(&sw); \
426 if (sw.te_refcount > 0) \
428 return sc_term_remove(&sw); \
435 static moduledata_t scterm_##name##_mod = { \
437 scterm_##name##_event, \
440 DECLARE_MODULE(scterm_##name, scterm_##name##_mod, \
441 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
443 /* renderer function table */
444 typedef void vr_init_t(scr_stat *scp);
445 typedef void vr_clear_t(scr_stat *scp, int c, int attr);
446 typedef void vr_draw_border_t(scr_stat *scp, int color);
447 typedef void vr_draw_t(scr_stat *scp, int from, int count, int flip);
448 typedef void vr_set_cursor_t(scr_stat *scp, int base, int height, int blink);
449 typedef void vr_draw_cursor_t(scr_stat *scp, int at, int blink,
451 typedef void vr_blink_cursor_t(scr_stat *scp, int at, int flip);
452 typedef void vr_set_mouse_t(scr_stat *scp);
453 typedef void vr_draw_mouse_t(scr_stat *scp, int x, int y, int on);
455 typedef struct sc_rndr_sw {
458 vr_draw_border_t *draw_border;
460 vr_set_cursor_t *set_cursor;
461 vr_draw_cursor_t *draw_cursor;
462 vr_blink_cursor_t *blink_cursor;
463 vr_set_mouse_t *set_mouse;
464 vr_draw_mouse_t *draw_mouse;
467 typedef struct sc_renderer {
470 sc_rndr_sw_t *rndrsw;
471 LIST_ENTRY(sc_renderer) link;
474 #define RENDERER(name, mode, sw, set) \
475 static struct sc_renderer scrndr_##name##_##mode = { \
478 DATA_SET(scrndr_set, scrndr_##name##_##mode); \
479 DATA_SET(set, scrndr_##name##_##mode)
481 #define RENDERER_MODULE(name, set) \
482 SET_DECLARE(set, sc_renderer_t); \
484 scrndr_##name##_event(module_t mod, int type, void *data) \
486 sc_renderer_t **list; \
490 SET_FOREACH(list, set) { \
491 error = sc_render_add(*list); \
497 SET_FOREACH(list, set) { \
498 error = sc_render_remove(*list);\
509 static moduledata_t scrndr_##name##_mod = { \
511 scrndr_##name##_event, \
514 DECLARE_MODULE(scrndr_##name, scrndr_##name##_mod, \
515 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
525 #define ISTEXTSC(scp) (!((scp)->status \
526 & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE)))
527 #define ISGRAPHSC(scp) (((scp)->status \
528 & (UNKNOWN_MODE | GRAPHICS_MODE)))
529 #define ISPIXELSC(scp) (((scp)->status \
530 & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE))\
532 #define ISUNKNOWNSC(scp) ((scp)->status & UNKNOWN_MODE)
534 #define ISMOUSEAVAIL(af) ((af) & V_ADP_FONT)
535 #define ISFONTAVAIL(af) ((af) & V_ADP_FONT)
536 #define ISPALAVAIL(af) ((af) & V_ADP_PALETTE)
538 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
540 #define SC_VIDEO_LOCKINIT(sc) \
541 mtx_init(&(sc)->video_mtx, "syscons video lock", NULL, \
542 MTX_SPIN | MTX_RECURSE);
543 #define SC_VIDEO_LOCK(sc) \
546 mtx_lock_spin(&(sc)->video_mtx); \
548 #define SC_VIDEO_UNLOCK(sc) \
551 mtx_unlock_spin(&(sc)->video_mtx); \
555 extern int (*sc_user_ioctl)(struct tty *tp, u_long cmd, caddr_t data,
558 int sc_probe_unit(int unit, int flags);
559 int sc_attach_unit(int unit, int flags);
561 int set_mode(scr_stat *scp);
563 void sc_set_border(scr_stat *scp, int color);
564 void sc_load_font(scr_stat *scp, int page, int size, int width,
565 u_char *font, int base, int count);
566 void sc_save_font(scr_stat *scp, int page, int size, int width,
567 u_char *font, int base, int count);
568 void sc_show_font(scr_stat *scp, int page);
570 void sc_touch_scrn_saver(void);
571 void sc_draw_cursor_image(scr_stat *scp);
572 void sc_remove_cursor_image(scr_stat *scp);
573 void sc_set_cursor_image(scr_stat *scp);
574 void sc_change_cursor_shape(scr_stat *scp, int flags,
575 int base, int height);
576 int sc_clean_up(scr_stat *scp);
577 int sc_switch_scr(sc_softc_t *sc, u_int next_scr);
578 void sc_alloc_scr_buffer(scr_stat *scp, int wait, int discard);
579 int sc_init_emulator(scr_stat *scp, char *name);
580 void sc_paste(scr_stat *scp, const u_char *p, int count);
581 void sc_respond(scr_stat *scp, const u_char *p,
582 int count, int wakeup);
583 void sc_bell(scr_stat *scp, int pitch, int duration);
586 #ifndef SC_NO_HISTORY
587 int sc_alloc_history_buffer(scr_stat *scp, int lines,
588 int prev_ysize, int wait);
589 void sc_free_history_buffer(scr_stat *scp, int prev_ysize);
590 void sc_hist_save(scr_stat *scp);
591 #define sc_hist_save_one_line(scp, from) \
592 sc_vtb_append(&(scp)->vtb, (from), (scp)->history, (scp)->xsize)
593 int sc_hist_restore(scr_stat *scp);
594 void sc_hist_home(scr_stat *scp);
595 void sc_hist_end(scr_stat *scp);
596 int sc_hist_up_line(scr_stat *scp);
597 int sc_hist_down_line(scr_stat *scp);
598 int sc_hist_ioctl(struct tty *tp, u_long cmd, caddr_t data,
600 #endif /* SC_NO_HISTORY */
603 #ifndef SC_NO_CUTPASTE
604 void sc_alloc_cut_buffer(scr_stat *scp, int wait);
605 void sc_draw_mouse_image(scr_stat *scp);
606 void sc_remove_mouse_image(scr_stat *scp);
607 int sc_inside_cutmark(scr_stat *scp, int pos);
608 void sc_remove_cutmarking(scr_stat *scp);
609 void sc_remove_all_cutmarkings(sc_softc_t *scp);
610 void sc_remove_all_mouse(sc_softc_t *scp);
611 void sc_mouse_paste(scr_stat *scp);
613 #define sc_draw_mouse_image(scp)
614 #define sc_remove_mouse_image(scp)
615 #define sc_inside_cutmark(scp, pos) FALSE
616 #define sc_remove_cutmarking(scp)
617 #define sc_remove_all_cutmarkings(scp)
618 #define sc_remove_all_mouse(scp)
619 #define sc_mouse_paste(scp)
620 #endif /* SC_NO_CUTPASTE */
621 #ifndef SC_NO_SYSMOUSE
622 void sc_mouse_move(scr_stat *scp, int x, int y);
623 int sc_mouse_ioctl(struct tty *tp, u_long cmd, caddr_t data,
625 #endif /* SC_NO_SYSMOUSE */
628 int sc_set_text_mode(scr_stat *scp, struct tty *tp, int mode,
629 int xsize, int ysize, int fontsize,
631 int sc_set_graphics_mode(scr_stat *scp, struct tty *tp, int mode);
632 int sc_set_pixel_mode(scr_stat *scp, struct tty *tp, int xsize,
633 int ysize, int fontsize, int font_width);
634 int sc_support_pixel_mode(void *arg);
635 int sc_vid_ioctl(struct tty *tp, u_long cmd, caddr_t data,
638 int sc_render_add(sc_renderer_t *rndr);
639 int sc_render_remove(sc_renderer_t *rndr);
640 sc_rndr_sw_t *sc_render_match(scr_stat *scp, char *name, int mode);
643 void sc_vtb_init(sc_vtb_t *vtb, int type, int cols, int rows,
644 void *buffer, int wait);
645 void sc_vtb_destroy(sc_vtb_t *vtb);
646 size_t sc_vtb_size(int cols, int rows);
647 void sc_vtb_clear(sc_vtb_t *vtb, int c, int attr);
649 int sc_vtb_getc(sc_vtb_t *vtb, int at);
650 int sc_vtb_geta(sc_vtb_t *vtb, int at);
651 void sc_vtb_putc(sc_vtb_t *vtb, int at, int c, int a);
652 vm_offset_t sc_vtb_putchar(sc_vtb_t *vtb, vm_offset_t p, int c, int a);
653 vm_offset_t sc_vtb_pointer(sc_vtb_t *vtb, int at);
654 int sc_vtb_pos(sc_vtb_t *vtb, int pos, int offset);
656 #define sc_vtb_tail(vtb) ((vtb)->vtb_tail)
657 #define sc_vtb_rows(vtb) ((vtb)->vtb_rows)
658 #define sc_vtb_cols(vtb) ((vtb)->vtb_cols)
660 void sc_vtb_copy(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2, int to,
662 void sc_vtb_append(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2,
664 void sc_vtb_seek(sc_vtb_t *vtb, int pos);
665 void sc_vtb_erase(sc_vtb_t *vtb, int at, int count, int c, int attr);
666 void sc_vtb_move(sc_vtb_t *vtb, int from, int to, int count);
667 void sc_vtb_delete(sc_vtb_t *vtb, int at, int count, int c, int attr);
668 void sc_vtb_ins(sc_vtb_t *vtb, int at, int count, int c, int attr);
671 int sysmouse_event(mouse_info_t *info);
674 void sc_move_cursor(scr_stat *scp, int x, int y);
675 void sc_clear_screen(scr_stat *scp);
676 int sc_term_add(sc_term_sw_t *sw);
677 int sc_term_remove(sc_term_sw_t *sw);
678 sc_term_sw_t *sc_term_match(char *name);
679 sc_term_sw_t *sc_term_match_by_number(int index);
681 /* machine dependent functions */
682 int sc_max_unit(void);
683 sc_softc_t *sc_get_softc(int unit, int flags);
684 sc_softc_t *sc_find_softc(struct video_adapter *adp, struct keyboard *kbd);
685 int sc_get_cons_priority(int *unit, int *flags);
686 void sc_get_bios_values(bios_values_t *values);
687 int sc_tone(int herz);
689 #endif /* !_DEV_SYSCONS_SYSCONS_H_ */