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_
38 #include <sys/mutex.h>
40 /* machine-dependent part of the header */
43 #include <pc98/cbus/sc_machdep.h>
44 #elif defined(__i386__)
45 /* nothing for the moment */
48 /* default values for configuration options */
56 #define SC_NO_CUTPASTE 1
59 #ifdef SC_NO_MODE_CHANGE
63 /* Always load font data if the pixel (raster text) mode is to be used. */
65 #undef SC_NO_FONT_LOADING
69 * If font data is not available, the `arrow'-shaped mouse cursor cannot
70 * be drawn. Use the alternative drawing method.
72 #ifdef SC_NO_FONT_LOADING
73 #undef SC_ALT_MOUSE_IMAGE
74 #define SC_ALT_MOUSE_IMAGE 1
77 #ifndef SC_CURSOR_CHAR
78 #define SC_CURSOR_CHAR (0x07)
82 #define SC_MOUSE_CHAR (0xd0)
85 #if SC_MOUSE_CHAR <= SC_CURSOR_CHAR && SC_CURSOR_CHAR < (SC_MOUSE_CHAR + 4)
87 #define SC_CURSOR_CHAR (SC_MOUSE_CHAR + 4)
90 #ifndef SC_DEBUG_LEVEL
91 #define SC_DEBUG_LEVEL 0
94 #define DPRINTF(l, p) if (SC_DEBUG_LEVEL >= (l)) printf p
97 #define SC_DRIVER_NAME "sc"
100 * Use a different driver name on sparc64 so it does not get confused
101 * with the system controller devices which are also termed 'sc' in OFW.
103 #define SC_DRIVER_NAME "syscons"
105 #define SC_VTY(dev) (((sc_ttysoftc *)tty_softc(tp))->st_index)
106 #define SC_DEV(sc, vty) ((sc)->dev[(vty) - (sc)->first_vty])
107 #define SC_STAT(tp) (*((scr_stat **)&((sc_ttysoftc *)tty_softc(tp))->st_stat))
109 /* printable chars */
111 #define PRINTABLE(ch) ((ch) > 0x1b || ((ch) > 0x0d && (ch) < 0x1b) \
115 /* macros for "intelligent" screen update */
116 #define mark_for_update(scp, x) {\
117 if ((x) < scp->start) scp->start = (x);\
118 else if ((x) > scp->end) scp->end = (x);\
120 #define mark_all(scp) {\
122 scp->end = scp->xsize * scp->ysize - 1;\
125 /* vty status flags (scp->status) */
126 #define UNKNOWN_MODE 0x00010 /* unknown video mode */
127 #define SWITCH_WAIT_REL 0x00080 /* waiting for vty release */
128 #define SWITCH_WAIT_ACQ 0x00100 /* waiting for vty ack */
129 #define BUFFER_SAVED 0x00200 /* vty buffer is saved */
130 #define CURSOR_ENABLED 0x00400 /* text cursor is enabled */
131 #define MOUSE_MOVED 0x01000 /* mouse cursor has moved */
132 #define MOUSE_CUTTING 0x02000 /* mouse cursor is cutting text */
133 #define MOUSE_VISIBLE 0x04000 /* mouse cursor is showing */
134 #define GRAPHICS_MODE 0x08000 /* vty is in a graphics mode */
135 #define PIXEL_MODE 0x10000 /* vty is in a raster text mode */
136 #define SAVER_RUNNING 0x20000 /* screen saver is running */
137 #define VR_CURSOR_BLINK 0x40000 /* blinking text cursor */
138 #define VR_CURSOR_ON 0x80000 /* text cursor is on */
139 #define MOUSE_HIDDEN 0x100000 /* mouse cursor is temporarily hidden */
146 The following #defines are hard-coded for a maximum text
147 resolution corresponding to a maximum framebuffer
148 resolution of 1920x1200 with an 8x8 font...
155 #ifndef BELL_DURATION
156 #define BELL_DURATION ((5 * hz + 99) / 100)
157 #define BELL_PITCH 800
160 /* virtual terminal buffer */
161 typedef struct sc_vtb {
163 #define VTB_VALID (1 << 0)
164 #define VTB_ALLOCED (1 << 1)
166 #define VTB_INVALID 0
168 #define VTB_FRAMEBUFFER 2
169 #define VTB_RINGBUFFER 3
173 vm_offset_t vtb_buffer;
174 int vtb_tail; /* valid for VTB_RINGBUFFER only */
177 /* text cursor attributes */
187 struct video_adapter;
191 typedef struct sc_softc {
192 int unit; /* unit # */
193 int config; /* configuration flags */
194 #define SC_VESAMODE (1 << 7)
195 #define SC_AUTODETECT_KBD (1 << 8)
196 #define SC_KERNEL_CONSOLE (1 << 9)
198 int flags; /* status flags */
199 #define SC_VISUAL_BELL (1 << 0)
200 #define SC_QUIET_BELL (1 << 1)
201 #if 0 /* not used anymore */
202 #define SC_BLINK_CURSOR (1 << 2)
203 #define SC_CHAR_CURSOR (1 << 3)
205 #define SC_MOUSE_ENABLED (1 << 4)
206 #define SC_SCRN_IDLE (1 << 5)
207 #define SC_SCRN_BLANKED (1 << 6)
208 #define SC_SAVER_FAILED (1 << 7)
209 #define SC_SCRN_VTYLOCK (1 << 8)
211 #define SC_INIT_DONE (1 << 16)
212 #define SC_SPLASH_SCRN (1 << 17)
214 int keyboard; /* -1 if unavailable */
215 struct keyboard *kbd;
218 struct video_adapter *adp;
219 int initial_mode; /* initial video mode */
224 struct scr_stat *cur_scp;
225 struct scr_stat *new_scp;
226 struct scr_stat *old_scp;
227 int delayed_next_scr;
229 char font_loading_in_progress;
230 char switch_in_progress;
231 char write_in_progress;
232 char blink_in_progress;
233 struct mtx video_mtx;
235 long scrn_time_stamp;
237 struct cursor_attr dflt_curs_attr;
238 struct cursor_attr curs_attr;
241 u_char scr_rmap[256];
243 #ifdef _SC_MD_SOFTC_DECLARED_
244 sc_md_softc_t md; /* machine dependent vars */
247 #ifndef SC_NO_PALETTE_LOADING
248 u_char palette[256 * 3];
250 u_char palette2[256 * 3];
254 #ifndef SC_NO_FONT_LOADING
272 struct callout ctimeout;
273 struct callout cblink;
277 typedef struct scr_stat {
278 int index; /* index of this vty */
279 struct sc_softc *sc; /* pointer to softc */
280 struct sc_rndr_sw *rndr; /* renderer */
286 int xpos; /* current X position */
287 int ypos; /* current Y position */
288 int xsize; /* X text size */
289 int ysize; /* Y text size */
290 int xpixel; /* X graphics size */
291 int ypixel; /* Y graphics size */
292 int xoff; /* X offset in pixel mode */
293 int yoff; /* Y offset in pixel mode */
295 u_char *font; /* current font */
296 int font_size; /* fontsize in Y direction */
297 int font_width; /* fontsize in X direction */
299 int start; /* modified area start */
300 int end; /* modified area end */
302 struct sc_term_sw *tsw;
305 int status; /* status (bitfield) */
307 int kbd_mode; /* keyboard I/O mode */
308 int kbd_prev_mode; /* keyboard I/O mode */
310 int cursor_pos; /* cursor buffer position */
311 int cursor_oldpos; /* cursor old buffer position */
312 u_short cursor_saveunder_char; /* saved char under cursor */
313 u_short cursor_saveunder_attr; /* saved attr under cursor */
314 struct cursor_attr dflt_curs_attr;
315 struct cursor_attr curr_curs_attr;
316 struct cursor_attr curs_attr;
318 int mouse_pos; /* mouse buffer position */
319 int mouse_oldpos; /* mouse old buffer position */
320 short mouse_xpos; /* mouse x coordinate */
321 short mouse_ypos; /* mouse y coordinate */
322 short mouse_oldxpos; /* mouse previous x coordinate */
323 short mouse_oldypos; /* mouse previous y coordinate */
324 short mouse_buttons; /* mouse buttons */
325 int mouse_cut_start; /* mouse cut start pos */
326 int mouse_cut_end; /* mouse cut end pos */
327 int mouse_level; /* xterm mouse protocol */
328 struct proc *mouse_proc; /* proc* of controlling proc */
329 pid_t mouse_pid; /* pid of controlling proc */
330 int mouse_signal; /* signal # to report with */
332 u_short bell_duration;
335 u_char border; /* border color */
337 pid_t pid; /* pid of controlling proc */
338 struct proc *proc; /* proc* of controlling proc */
339 struct vt_mode smode; /* switch mode */
341 sc_vtb_t *history; /* circular history buffer */
342 int history_pos; /* position shown on screen */
343 int history_size; /* size of history buffer */
345 int splash_save_mode; /* saved mode for splash screen */
346 int splash_save_status; /* saved status for splash screen */
347 struct mtx scr_lock; /* mutex for sc_puts() */
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, int kernel);
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);
396 typedef struct sc_term_sw {
397 LIST_ENTRY(sc_term_sw) link;
398 char *te_name; /* name of the emulator */
399 char *te_desc; /* description */
400 char *te_renderer; /* matching renderer */
401 size_t te_size; /* size of internal buffer */
402 int te_refcount; /* reference counter */
403 sc_term_init_t *te_init;
404 sc_term_term_t *te_term;
405 sc_term_puts_t *te_puts;
406 sc_term_ioctl_t *te_ioctl;
407 sc_term_reset_t *te_reset;
408 sc_term_default_attr_t *te_default_attr;
409 sc_term_clear_t *te_clear;
410 sc_term_notify_t *te_notify;
411 sc_term_input_t *te_input;
412 sc_term_fkeystr_t *te_fkeystr;
415 #define SCTERM_MODULE(name, sw) \
416 DATA_SET(scterm_set, sw); \
418 scterm_##name##_event(module_t mod, int type, void *data) \
422 return sc_term_add(&sw); \
424 if (sw.te_refcount > 0) \
426 return sc_term_remove(&sw); \
433 static moduledata_t scterm_##name##_mod = { \
435 scterm_##name##_event, \
438 DECLARE_MODULE(scterm_##name, scterm_##name##_mod, \
439 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
441 /* renderer function table */
442 typedef void vr_init_t(scr_stat *scp);
443 typedef void vr_clear_t(scr_stat *scp, int c, int attr);
444 typedef void vr_draw_border_t(scr_stat *scp, int color);
445 typedef void vr_draw_t(scr_stat *scp, int from, int count, int flip);
446 typedef void vr_set_cursor_t(scr_stat *scp, int base, int height, int blink);
447 typedef void vr_draw_cursor_t(scr_stat *scp, int at, int blink,
449 typedef void vr_blink_cursor_t(scr_stat *scp, int at, int flip);
450 typedef void vr_set_mouse_t(scr_stat *scp);
451 typedef void vr_draw_mouse_t(scr_stat *scp, int x, int y, int on);
453 typedef struct sc_rndr_sw {
456 vr_draw_border_t *draw_border;
458 vr_set_cursor_t *set_cursor;
459 vr_draw_cursor_t *draw_cursor;
460 vr_blink_cursor_t *blink_cursor;
461 vr_set_mouse_t *set_mouse;
462 vr_draw_mouse_t *draw_mouse;
465 typedef struct sc_renderer {
468 sc_rndr_sw_t *rndrsw;
469 LIST_ENTRY(sc_renderer) link;
472 #define RENDERER(name, mode, sw, set) \
473 static struct sc_renderer scrndr_##name##_##mode = { \
476 DATA_SET(scrndr_set, scrndr_##name##_##mode); \
477 DATA_SET(set, scrndr_##name##_##mode)
479 #define RENDERER_MODULE(name, set) \
480 SET_DECLARE(set, sc_renderer_t); \
482 scrndr_##name##_event(module_t mod, int type, void *data) \
484 sc_renderer_t **list; \
488 SET_FOREACH(list, set) { \
489 error = sc_render_add(*list); \
495 SET_FOREACH(list, set) { \
496 error = sc_render_remove(*list);\
507 static moduledata_t scrndr_##name##_mod = { \
509 scrndr_##name##_event, \
512 DECLARE_MODULE(scrndr_##name, scrndr_##name##_mod, \
513 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
523 #define ISTEXTSC(scp) (!((scp)->status \
524 & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE)))
525 #define ISGRAPHSC(scp) (((scp)->status \
526 & (UNKNOWN_MODE | GRAPHICS_MODE)))
527 #define ISPIXELSC(scp) (((scp)->status \
528 & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE))\
530 #define ISUNKNOWNSC(scp) ((scp)->status & UNKNOWN_MODE)
532 #define ISMOUSEAVAIL(af) ((af) & V_ADP_FONT)
533 #define ISFONTAVAIL(af) ((af) & V_ADP_FONT)
534 #define ISPALAVAIL(af) ((af) & V_ADP_PALETTE)
536 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
538 #define SC_VIDEO_LOCKINIT(sc) \
539 mtx_init(&(sc)->video_mtx, "syscons video lock", NULL, \
540 MTX_SPIN | MTX_RECURSE);
541 #define SC_VIDEO_LOCK(sc) \
544 mtx_lock_spin(&(sc)->video_mtx); \
546 #define SC_VIDEO_UNLOCK(sc) \
549 mtx_unlock_spin(&(sc)->video_mtx); \
553 extern int (*sc_user_ioctl)(struct tty *tp, u_long cmd, caddr_t data,
556 int sc_probe_unit(int unit, int flags);
557 int sc_attach_unit(int unit, int flags);
559 int set_mode(scr_stat *scp);
561 void sc_set_border(scr_stat *scp, int color);
562 void sc_load_font(scr_stat *scp, int page, int size, int width,
563 u_char *font, int base, int count);
564 void sc_save_font(scr_stat *scp, int page, int size, int width,
565 u_char *font, int base, int count);
566 void sc_show_font(scr_stat *scp, int page);
568 void sc_touch_scrn_saver(void);
569 void sc_draw_cursor_image(scr_stat *scp);
570 void sc_remove_cursor_image(scr_stat *scp);
571 void sc_set_cursor_image(scr_stat *scp);
572 void sc_change_cursor_shape(scr_stat *scp, int flags,
573 int base, int height);
574 int sc_clean_up(scr_stat *scp);
575 int sc_switch_scr(sc_softc_t *sc, u_int next_scr);
576 void sc_alloc_scr_buffer(scr_stat *scp, int wait, int discard);
577 int sc_init_emulator(scr_stat *scp, char *name);
578 void sc_paste(scr_stat *scp, const u_char *p, int count);
579 void sc_respond(scr_stat *scp, const u_char *p,
580 int count, int wakeup);
581 void sc_bell(scr_stat *scp, int pitch, int duration);
584 #ifndef SC_NO_HISTORY
585 int sc_alloc_history_buffer(scr_stat *scp, int lines,
586 int prev_ysize, int wait);
587 void sc_free_history_buffer(scr_stat *scp, int prev_ysize);
588 void sc_hist_save(scr_stat *scp);
589 #define sc_hist_save_one_line(scp, from) \
590 sc_vtb_append(&(scp)->vtb, (from), (scp)->history, (scp)->xsize)
591 int sc_hist_restore(scr_stat *scp);
592 void sc_hist_home(scr_stat *scp);
593 void sc_hist_end(scr_stat *scp);
594 int sc_hist_up_line(scr_stat *scp);
595 int sc_hist_down_line(scr_stat *scp);
596 int sc_hist_ioctl(struct tty *tp, u_long cmd, caddr_t data,
598 #endif /* SC_NO_HISTORY */
601 #ifndef SC_NO_CUTPASTE
602 void sc_alloc_cut_buffer(scr_stat *scp, int wait);
603 void sc_draw_mouse_image(scr_stat *scp);
604 void sc_remove_mouse_image(scr_stat *scp);
605 int sc_inside_cutmark(scr_stat *scp, int pos);
606 void sc_remove_cutmarking(scr_stat *scp);
607 void sc_remove_all_cutmarkings(sc_softc_t *scp);
608 void sc_remove_all_mouse(sc_softc_t *scp);
609 void sc_mouse_paste(scr_stat *scp);
611 #define sc_draw_mouse_image(scp)
612 #define sc_remove_mouse_image(scp)
613 #define sc_inside_cutmark(scp, pos) FALSE
614 #define sc_remove_cutmarking(scp)
615 #define sc_remove_all_cutmarkings(scp)
616 #define sc_remove_all_mouse(scp)
617 #define sc_mouse_paste(scp)
618 #endif /* SC_NO_CUTPASTE */
619 #ifndef SC_NO_SYSMOUSE
620 void sc_mouse_move(scr_stat *scp, int x, int y);
621 int sc_mouse_ioctl(struct tty *tp, u_long cmd, caddr_t data,
623 #endif /* SC_NO_SYSMOUSE */
626 int sc_set_text_mode(scr_stat *scp, struct tty *tp, int mode,
627 int xsize, int ysize, int fontsize,
629 int sc_set_graphics_mode(scr_stat *scp, struct tty *tp, int mode);
630 int sc_set_pixel_mode(scr_stat *scp, struct tty *tp, int xsize,
631 int ysize, int fontsize, int font_width);
632 int sc_support_pixel_mode(void *arg);
633 int sc_vid_ioctl(struct tty *tp, u_long cmd, caddr_t data,
636 int sc_render_add(sc_renderer_t *rndr);
637 int sc_render_remove(sc_renderer_t *rndr);
638 sc_rndr_sw_t *sc_render_match(scr_stat *scp, char *name, int mode);
641 void sc_vtb_init(sc_vtb_t *vtb, int type, int cols, int rows,
642 void *buffer, int wait);
643 void sc_vtb_destroy(sc_vtb_t *vtb);
644 size_t sc_vtb_size(int cols, int rows);
645 void sc_vtb_clear(sc_vtb_t *vtb, int c, int attr);
647 int sc_vtb_getc(sc_vtb_t *vtb, int at);
648 int sc_vtb_geta(sc_vtb_t *vtb, int at);
649 void sc_vtb_putc(sc_vtb_t *vtb, int at, int c, int a);
650 vm_offset_t sc_vtb_putchar(sc_vtb_t *vtb, vm_offset_t p, int c, int a);
651 vm_offset_t sc_vtb_pointer(sc_vtb_t *vtb, int at);
652 int sc_vtb_pos(sc_vtb_t *vtb, int pos, int offset);
654 #define sc_vtb_tail(vtb) ((vtb)->vtb_tail)
655 #define sc_vtb_rows(vtb) ((vtb)->vtb_rows)
656 #define sc_vtb_cols(vtb) ((vtb)->vtb_cols)
658 void sc_vtb_copy(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2, int to,
660 void sc_vtb_append(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2,
662 void sc_vtb_seek(sc_vtb_t *vtb, int pos);
663 void sc_vtb_erase(sc_vtb_t *vtb, int at, int count, int c, int attr);
664 void sc_vtb_move(sc_vtb_t *vtb, int from, int to, int count);
665 void sc_vtb_delete(sc_vtb_t *vtb, int at, int count, int c, int attr);
666 void sc_vtb_ins(sc_vtb_t *vtb, int at, int count, int c, int attr);
669 int sysmouse_event(mouse_info_t *info);
672 void sc_move_cursor(scr_stat *scp, int x, int y);
673 void sc_clear_screen(scr_stat *scp);
674 int sc_term_add(sc_term_sw_t *sw);
675 int sc_term_remove(sc_term_sw_t *sw);
676 sc_term_sw_t *sc_term_match(char *name);
677 sc_term_sw_t *sc_term_match_by_number(int index);
679 /* machine dependent functions */
680 int sc_max_unit(void);
681 sc_softc_t *sc_get_softc(int unit, int flags);
682 sc_softc_t *sc_find_softc(struct video_adapter *adp, struct keyboard *kbd);
683 int sc_get_cons_priority(int *unit, int *flags);
684 void sc_get_bios_values(bios_values_t *values);
685 int sc_tone(int herz);
687 #endif /* !_DEV_SYSCONS_SYSCONS_H_ */