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.
31 * $FreeBSD: src/sys/dev/syscons/syscons.h,v 1.60.2.6 2002/09/15 22:30:45 dd Exp $
34 #ifndef _DEV_SYSCONS_SYSCONS_H_
35 #define _DEV_SYSCONS_SYSCONS_H_
37 #include <sys/malloc.h>
39 MALLOC_DECLARE(M_SYSCONS);
41 /* default values for configuration options */
44 #define MAXCONS 16 /* power of 2 */
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 (0x07)
75 #define SC_MOUSE_CHAR (0xd0)
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)) kprintf p
89 #define SC_DRIVER_NAME "sc"
90 #define SC_VTY(dev) minor(dev)
91 #define SC_DEV(sc, vty) ((sc)->dev ? (sc)->dev[(vty) - (sc)->first_vty] : NULL)
92 #define SC_STAT(dev) ((scr_stat *)(dev)->si_drv1)
96 #define PRINTABLE(ch) ((ch) > 0x1b || ((ch) > 0x0d && (ch) < 0x1b) \
100 /* macros for "intelligent" screen update */
101 #define mark_for_update(scp, x) {\
102 if ((x) < scp->start) scp->start = (x);\
103 else if ((x) > scp->end) scp->end = (x);\
105 #define mark_all(scp) {\
107 scp->end = scp->xsize * scp->ysize - 1;\
110 /* macro for calculating the drawing position in video memory */
112 #define VIDEO_MEMORY_POS(scp, pos, x) \
113 ((scp)->sc->adp->va_window + \
114 (x) * (scp)->xoff + \
115 (scp)->yoff * (scp)->font_height * (scp)->sc->adp->va_line_width +\
116 (x) * ((pos) % (scp)->xsize) + \
117 (scp)->font_height * (scp)->sc->adp->va_line_width * \
118 (pos / (scp)->xsize))
121 /* vty status flags (scp->status) */
122 #define UNKNOWN_MODE 0x00010 /* unknown video mode */
123 #define SWITCH_WAIT_REL 0x00080 /* waiting for vty release */
124 #define SWITCH_WAIT_ACQ 0x00100 /* waiting for vty ack */
125 #define BUFFER_SAVED 0x00200 /* vty buffer is saved */
126 #define CURSOR_ENABLED 0x00400 /* text cursor is enabled */
127 #define MOUSE_MOVED 0x01000 /* mouse cursor has moved */
128 #define MOUSE_CUTTING 0x02000 /* mouse cursor is cutting text */
129 #define MOUSE_VISIBLE 0x04000 /* mouse cursor is showing */
130 #define GRAPHICS_MODE 0x08000 /* vty is in a graphics mode */
131 #define PIXEL_MODE 0x10000 /* vty is in a raster text mode */
132 #define SAVER_RUNNING 0x20000 /* screen saver is running */
133 #define VR_CURSOR_BLINK 0x40000 /* blinking text cursor */
134 #define VR_CURSOR_ON 0x80000 /* text cursor is on */
135 #define MOUSE_HIDDEN 0x100000 /* mouse cursor is temporarily hidden */
144 #ifndef BELL_DURATION
145 #define BELL_DURATION ((5 * hz + 99) / 100)
146 #define BELL_PITCH 800
149 /* virtual terminal buffer */
150 typedef struct sc_vtb {
152 #define VTB_VALID (1 << 0)
153 #define VTB_ALLOCED (1 << 1)
155 #define VTB_INVALID 0
157 #define VTB_FRAMEBUFFER 2
158 #define VTB_RINGBUFFER 3
162 uint16_t *vtb_buffer;
163 int vtb_tail; /* valid for VTB_RINGBUFFER only */
169 struct video_adapter;
172 struct dev_ioctl_args;
174 typedef struct sc_softc {
175 int unit; /* unit # */
176 int config; /* configuration flags */
177 #define SC_AUTODETECT_KBD (1 << 8)
178 #define SC_KERNEL_CONSOLE (1 << 9)
180 int flags; /* status flags */
181 #define SC_VISUAL_BELL (1 << 0)
182 #define SC_QUIET_BELL (1 << 1)
183 #define SC_BLINK_CURSOR (1 << 2)
184 #define SC_CHAR_CURSOR (1 << 3)
185 #define SC_MOUSE_ENABLED (1 << 4)
186 #define SC_SCRN_IDLE (1 << 5)
187 #define SC_SCRN_BLANKED (1 << 6)
188 #define SC_SAVER_FAILED (1 << 7)
189 #define SC_SCRN_VTYLOCK (1 << 8)
191 #define SC_INIT_DONE (1 << 16)
192 #define SC_SPLASH_SCRN (1 << 17)
194 int keyboard; /* -1 if unavailable */
195 struct keyboard *kbd;
198 struct video_adapter *adp;
199 int initial_mode; /* initial video mode */
206 struct scr_stat *console_scp;
207 struct scr_stat *cur_scp;
208 struct scr_stat *new_scp;
209 struct scr_stat *old_scp;
210 int delayed_next_scr;
211 int videoio_in_progress;
213 char font_loading_in_progress;
214 char switch_in_progress;
215 char write_in_progress;
216 char blink_in_progress;
218 long scrn_time_stamp;
219 struct callout scrn_timer_ch;
225 u_char scr_rmap[256];
227 #ifdef _SC_MD_SOFTC_DECLARED_
228 sc_md_softc_t md; /* machine dependent vars */
231 #ifndef SC_NO_PALETTE_LOADING
232 u_char palette[256*3];
235 #ifndef SC_NO_FONT_LOADING
251 typedef struct scr_stat {
252 int index; /* index of this vty */
253 struct sc_softc *sc; /* pointer to softc */
254 struct sc_rndr_sw *rndr; /* renderer */
259 int xpos; /* current X position */
260 int ypos; /* current Y position */
261 int xsize; /* X text size */
262 int ysize; /* Y text size */
263 int xpixel; /* X graphics size */
264 int ypixel; /* Y graphics size */
265 int xoff; /* X offset in pixel mode */
266 int yoff; /* Y offset in pixel mode */
268 u_char *font; /* current font */
269 int font_height; /* font source Y pixels */
270 int font_width; /* font source X pixels */
271 int blk_height; /* fbtarget Y pixels */
272 int blk_width; /* fbtarget X pixels */
274 int start; /* modified area start */
275 int end; /* modified area end */
276 int show_cursor; /* used by async scrn_update */
278 struct sc_term_sw *tsw;
281 int status; /* status (bitfield) */
282 int kbd_mode; /* keyboard I/O mode */
284 int cursor_pos; /* cursor buffer position */
285 int cursor_oldpos; /* cursor old buffer position */
286 u_short cursor_saveunder_char; /* saved char under cursor */
287 u_short cursor_saveunder_attr; /* saved attr under cursor */
288 char cursor_base; /* cursor base line # */
289 char cursor_height; /* cursor height */
291 int mouse_pos; /* mouse buffer position */
292 int mouse_oldpos; /* mouse old buffer position */
293 short mouse_xpos; /* mouse x coordinate */
294 short mouse_ypos; /* mouse y coordinate */
295 short mouse_oldxpos; /* mouse previous x coordinate */
296 short mouse_oldypos; /* mouse previous y coordinate */
297 short mouse_buttons; /* mouse buttons */
298 int mouse_cut_start; /* mouse cut start pos */
299 int mouse_cut_end; /* mouse cut end pos */
300 struct proc *mouse_proc; /* proc* of controlling proc */
301 pid_t mouse_pid; /* pid of controlling proc */
302 int mouse_signal; /* signal # to report with */
304 u_short bell_duration;
307 struct callout blink_screen_ch;
309 uint32_t ega_palette[16]; /* ega palette */
310 u_char border; /* border color */
312 int model; /* memory model */
313 pid_t pid; /* pid of controlling proc */
314 struct proc *proc; /* proc* of controlling proc */
315 struct vt_mode smode; /* switch mode */
317 sc_vtb_t *history; /* circular history buffer */
318 int history_pos; /* position shown on screen */
319 int history_size; /* size of history buffer */
321 int splash_save_mode; /* saved mode for splash scr */
322 int splash_save_status; /* saved status for splash scr*/
324 struct thread *asynctd;
325 #ifdef _SCR_MD_STAT_DECLARED_
326 scr_md_stat_t md; /* machine dependent vars */
331 #define SC_NORM_ATTR (FG_LIGHTGREY | BG_BLACK)
333 #ifndef SC_NORM_REV_ATTR
334 #define SC_NORM_REV_ATTR (FG_BLACK | BG_LIGHTGREY)
336 #ifndef SC_KERNEL_CONS_ATTR
337 #define SC_KERNEL_CONS_ATTR (FG_WHITE | BG_BLACK)
339 #ifndef SC_KERNEL_CONS_REV_ATTR
340 #define SC_KERNEL_CONS_REV_ATTR (FG_BLACK | BG_LIGHTGREY)
343 /* terminal emulator */
346 #define SC_DFLT_TERM "*" /* any */
349 typedef int sc_term_init_t(scr_stat *scp, void **tcp, int code);
350 #define SC_TE_COLD_INIT 0
351 #define SC_TE_WARM_INIT 1
352 typedef int sc_term_term_t(scr_stat *scp, void **tcp);
353 typedef void sc_term_puts_t(scr_stat *scp, u_char *buf, int len);
354 typedef int sc_term_ioctl_t(scr_stat *scp, struct tty *tp, u_long cmd,
355 caddr_t data, int flag);
356 typedef int sc_term_reset_t(scr_stat *scp, int code);
357 #define SC_TE_HARD_RESET 0
358 #define SC_TE_SOFT_RESET 1
359 typedef void sc_term_default_attr_t(scr_stat *scp, int norm, int rev);
360 typedef void sc_term_clear_t(scr_stat *scp);
361 typedef void sc_term_notify_t(scr_stat *scp, int event);
362 #define SC_TE_NOTIFY_VTSWITCH_IN 0
363 #define SC_TE_NOTIFY_VTSWITCH_OUT 1
364 typedef int sc_term_input_t(scr_stat *scp, int c, struct tty *tp);
366 typedef struct sc_term_sw {
367 LIST_ENTRY(sc_term_sw) link;
368 char *te_name; /* name of the emulator */
369 char *te_desc; /* description */
370 char *te_renderer; /* matching renderer */
371 size_t te_size; /* size of internal buffer */
372 int te_refcount; /* reference counter */
373 sc_term_init_t *te_init;
374 sc_term_term_t *te_term;
375 sc_term_puts_t *te_puts;
376 sc_term_ioctl_t *te_ioctl;
377 sc_term_reset_t *te_reset;
378 sc_term_default_attr_t *te_default_attr;
379 sc_term_clear_t *te_clear;
380 sc_term_notify_t *te_notify;
381 sc_term_input_t *te_input;
384 extern struct linker_set scterm_set;
386 #define SCTERM_MODULE(name, sw) \
387 DATA_SET(scterm_set, sw); \
389 scterm_##name##_event(module_t mod, int type, void *data) \
393 return sc_term_add(&sw); \
395 if (sw.te_refcount > 0) \
397 return sc_term_remove(&sw); \
403 static moduledata_t scterm_##name##_mod = { \
405 scterm_##name##_event, \
408 DECLARE_MODULE(scterm_##name, scterm_##name##_mod, \
409 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
411 /* renderer function table */
412 typedef void vr_draw_border_t(scr_stat *scp, int color);
413 typedef void vr_draw_t(scr_stat *scp, int from, int count, int flip);
414 typedef void vr_set_cursor_t(scr_stat *scp, int base, int height, int blink);
415 typedef void vr_draw_cursor_t(scr_stat *scp, int at, int blink,
417 typedef void vr_blink_cursor_t(scr_stat *scp, int at, int flip);
418 typedef void vr_set_mouse_t(scr_stat *scp);
419 typedef void vr_draw_mouse_t(scr_stat *scp, int x, int y, int on);
421 typedef struct sc_rndr_sw {
422 vr_draw_border_t *draw_border;
424 vr_set_cursor_t *set_cursor;
425 vr_draw_cursor_t *draw_cursor;
426 vr_blink_cursor_t *blink_cursor;
427 vr_draw_mouse_t *draw_mouse;
430 typedef struct sc_renderer {
433 sc_rndr_sw_t *rndrsw;
434 LIST_ENTRY(sc_renderer) link;
437 extern struct linker_set scrndr_set;
439 #define RENDERER(name, model, sw, set) \
440 static struct sc_renderer scrndr_##name##_##model = { \
443 DATA_SET(scrndr_set, scrndr_##name##_##model); \
444 DATA_SET(set, scrndr_##name##_##model)
446 #define RENDERER_MODULE(name, set) \
447 SET_DECLARE(set, sc_renderer_t); \
449 scrndr_##name##_event(module_t mod, int type, void *data) \
451 sc_renderer_t **list; \
455 SET_FOREACH(list, set) { \
456 error = sc_render_add(*list); \
462 SET_FOREACH(list, set) { \
463 error = sc_render_remove(*list); \
473 static moduledata_t scrndr_##name##_mod = { \
475 scrndr_##name##_event, \
478 DECLARE_MODULE(scrndr_##name, scrndr_##name##_mod, \
479 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
489 #define ISTEXTSC(scp) (!((scp)->status \
490 & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE)))
491 #define ISGRAPHSC(scp) (((scp)->status \
492 & (UNKNOWN_MODE | GRAPHICS_MODE)))
493 #define ISPIXELSC(scp) (((scp)->status \
494 & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE))\
496 #define ISUNKNOWNSC(scp) ((scp)->status & UNKNOWN_MODE)
498 #define ISMOUSEAVAIL(af) ((af) & V_ADP_FONT)
499 #define ISFONTAVAIL(af) ((af) & V_ADP_FONT)
500 #define ISPALAVAIL(af) ((af) & V_ADP_PALETTE)
502 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
505 int sc_probe_unit(int unit, int flags);
506 int sc_attach_unit(int unit, int flags);
508 int set_mode(scr_stat *scp);
509 void refresh_ega_palette(scr_stat *scp);
511 void sc_set_border(scr_stat *scp, int color);
512 void sc_load_font(scr_stat *scp, int page, int size, u_char *font,
513 int base, int count);
514 void sc_save_font(scr_stat *scp, int page, int size, u_char *font,
515 int base, int count);
516 void sc_show_font(scr_stat *scp, int page);
518 void sc_touch_scrn_saver(void);
519 void sc_draw_cursor_image(scr_stat *scp);
520 void sc_remove_cursor_image(scr_stat *scp);
521 void sc_set_cursor_image(scr_stat *scp);
522 int sc_clean_up(scr_stat *scp);
523 int sc_switch_scr(sc_softc_t *sc, u_int next_scr);
524 void sc_alloc_scr_buffer(scr_stat *scp, int wait, int discard);
525 int sc_init_emulator(scr_stat *scp, char *name);
526 void sc_paste(scr_stat *scp, u_char *p, int count);
527 void sc_bell(scr_stat *scp, int pitch, int duration);
528 void sc_font_scale(scr_stat *scp, int max_cols, int max_rows);
531 #ifndef SC_NO_HISTORY
532 int sc_alloc_history_buffer(scr_stat *scp, int lines,
533 int prev_ysize, int wait);
534 void sc_free_history_buffer(scr_stat *scp, int prev_ysize);
535 void sc_hist_save(scr_stat *scp);
536 #define sc_hist_save_one_line(scp, from) \
537 sc_vtb_append(&(scp)->vtb, (from), (scp)->history, (scp)->xsize)
538 int sc_hist_restore(scr_stat *scp);
539 void sc_hist_home(scr_stat *scp);
540 void sc_hist_getback(scr_stat *scp, int old_ysize);
541 void sc_hist_end(scr_stat *scp);
542 int sc_hist_up_line(scr_stat *scp);
543 int sc_hist_down_line(scr_stat *scp);
544 int sc_hist_ioctl(struct tty *tp, u_long cmd, caddr_t data,
546 #endif /* SC_NO_HISTORY */
549 #ifndef SC_NO_CUTPASTE
550 void sc_alloc_cut_buffer(scr_stat *scp, int wait);
551 void sc_draw_mouse_image(scr_stat *scp);
552 void sc_remove_mouse_image(scr_stat *scp);
553 int sc_inside_cutmark(scr_stat *scp, int pos);
554 void sc_remove_cutmarking(scr_stat *scp);
555 void sc_remove_all_cutmarkings(sc_softc_t *scp);
556 void sc_remove_all_mouse(sc_softc_t *scp);
558 #define sc_draw_mouse_image(scp)
559 #define sc_remove_mouse_image(scp)
560 #define sc_inside_cutmark(scp, pos) FALSE
561 #define sc_remove_cutmarking(scp)
562 #define sc_remove_all_cutmarkings(scp)
563 #define sc_remove_all_mouse(scp)
564 #endif /* SC_NO_CUTPASTE */
565 #ifndef SC_NO_SYSMOUSE
566 void sc_mouse_move(scr_stat *scp, int x, int y);
567 int sc_mouse_ioctl(struct tty *tp, u_long cmd, caddr_t data,
569 #endif /* SC_NO_SYSMOUSE */
572 int sc_set_text_mode(scr_stat *scp, struct tty *tp, int mode,
573 int xsize, int ysize, int fontsize);
574 int sc_set_graphics_mode(scr_stat *scp, struct tty *tp, int mode);
575 int sc_set_pixel_mode(scr_stat *scp, struct tty *tp,
576 int xsize, int ysize, int fontsize);
577 int sc_vid_ioctl(struct tty *tp, u_long cmd, caddr_t data,
580 int sc_render_add(sc_renderer_t *rndr);
581 int sc_render_remove(sc_renderer_t *rndr);
582 sc_rndr_sw_t *sc_render_match(scr_stat *scp, char *name, int model);
583 void sc_update_render(scr_stat *scp);
586 void sc_vtb_init(sc_vtb_t *vtb, int type, int cols, int rows,
587 void *buffer, int wait);
588 void sc_vtb_destroy(sc_vtb_t *vtb);
589 size_t sc_vtb_size(int cols, int rows);
590 void sc_vtb_clear(sc_vtb_t *vtb, int c, int attr);
592 int sc_vtb_getc(sc_vtb_t *vtb, int at);
593 int sc_vtb_geta(sc_vtb_t *vtb, int at);
594 void sc_vtb_putc(sc_vtb_t *vtb, int at, int c, int a);
595 uint16_t *sc_vtb_putchar(sc_vtb_t *vtb, uint16_t *p, int c, int a);
596 int sc_vtb_pos(sc_vtb_t *vtb, int pos, int offset);
598 #define sc_vtb_tail(vtb) ((vtb)->vtb_tail)
599 #define sc_vtb_rows(vtb) ((vtb)->vtb_rows)
600 #define sc_vtb_cols(vtb) ((vtb)->vtb_cols)
602 void sc_vtb_copy(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2, int to,
604 void sc_vtb_append(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2,
606 void sc_vtb_seek(sc_vtb_t *vtb, int pos);
607 void sc_vtb_erase(sc_vtb_t *vtb, int at, int count, int c, int attr);
608 void sc_vtb_move(sc_vtb_t *vtb, int from, int to, int count);
609 void sc_vtb_delete(sc_vtb_t *vtb, int at, int count, int c, int attr);
610 void sc_vtb_ins(sc_vtb_t *vtb, int at, int count, int c, int attr);
613 int sysmouse_event(mouse_info_t *info);
616 void sc_move_cursor(scr_stat *scp, int x, int y);
617 void sc_clear_screen(scr_stat *scp);
618 int sc_term_add(sc_term_sw_t *sw);
619 int sc_term_remove(sc_term_sw_t *sw);
620 sc_term_sw_t *sc_term_match(char *name);
621 sc_term_sw_t *sc_term_match_by_number(int index);
623 /* machine dependent functions */
624 int sc_max_unit(void);
625 sc_softc_t *sc_get_softc(int unit, int flags);
626 sc_softc_t *sc_find_softc(struct video_adapter *adp, struct keyboard *kbd);
627 int sc_get_cons_priority(int *unit, int *flags);
628 void sc_get_bios_values(bios_values_t *values);
629 int sc_tone(int hertz);
631 #endif /* !_DEV_SYSCONS_SYSCONS_H_ */