2 * Copyright (c) 1995-1998 Søren Schmidt
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer,
10 * without modification, immediately at the beginning of the file.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef _DEV_SYSCONS_SYSCONS_H_
32 #define _DEV_SYSCONS_SYSCONS_H_
34 /* machine-dependent part of the header */
37 #include <pc98/pc98/sc_machdep.h>
38 #elif defined(__i386__)
39 /* nothing for the moment */
40 #elif defined(__alpha__)
41 /* nothing for the moment */
44 /* default values for configuration options */
52 #define SC_NO_CUTPASTE 1
55 #ifdef SC_NO_MODE_CHANGE
59 /* Always load font data if the pixel (raster text) mode is to be used. */
61 #undef SC_NO_FONT_LOADING
65 * If font data is not available, the `arrow'-shaped mouse cursor cannot
66 * be drawn. Use the alternative drawing method.
68 #ifdef SC_NO_FONT_LOADING
69 #undef SC_ALT_MOUSE_IMAGE
70 #define SC_ALT_MOUSE_IMAGE 1
73 #ifndef SC_CURSOR_CHAR
74 #define SC_CURSOR_CHAR (0x07)
78 #define SC_MOUSE_CHAR (0xd0)
81 #if SC_MOUSE_CHAR <= SC_CURSOR_CHAR && SC_CURSOR_CHAR < (SC_MOUSE_CHAR + 4)
83 #define SC_CURSOR_CHAR (SC_MOUSE_CHAR + 4)
86 #ifndef SC_DEBUG_LEVEL
87 #define SC_DEBUG_LEVEL 0
90 #define DPRINTF(l, p) if (SC_DEBUG_LEVEL >= (l)) printf p
92 #define SC_DRIVER_NAME "sc"
93 #define SC_VTY(dev) minor(dev)
94 #define SC_DEV(sc, vty) ((sc)->dev[(vty) - (sc)->first_vty])
95 #define SC_STAT(dev) ((scr_stat *)(dev)->si_drv1)
99 #define PRINTABLE(ch) ((ch) > 0x1b || ((ch) > 0x0d && (ch) < 0x1b) \
103 /* macros for "intelligent" screen update */
104 #define mark_for_update(scp, x) {\
105 if ((x) < scp->start) scp->start = (x);\
106 else if ((x) > scp->end) scp->end = (x);\
108 #define mark_all(scp) {\
110 scp->end = scp->xsize * scp->ysize - 1;\
113 /* vty status flags (scp->status) */
114 #define UNKNOWN_MODE 0x00010 /* unknown video mode */
115 #define SWITCH_WAIT_REL 0x00080 /* waiting for vty release */
116 #define SWITCH_WAIT_ACQ 0x00100 /* waiting for vty ack */
117 #define BUFFER_SAVED 0x00200 /* vty buffer is saved */
118 #define CURSOR_ENABLED 0x00400 /* text cursor is enabled */
119 #define MOUSE_MOVED 0x01000 /* mouse cursor has moved */
120 #define MOUSE_CUTTING 0x02000 /* mouse cursor is cutting text */
121 #define MOUSE_VISIBLE 0x04000 /* mouse cursor is showing */
122 #define GRAPHICS_MODE 0x08000 /* vty is in a graphics mode */
123 #define PIXEL_MODE 0x10000 /* vty is in a raster text mode */
124 #define SAVER_RUNNING 0x20000 /* screen saver is running */
125 #define VR_CURSOR_BLINK 0x40000 /* blinking text cursor */
126 #define VR_CURSOR_ON 0x80000 /* text cursor is on */
127 #define MOUSE_HIDDEN 0x100000 /* mouse cursor is temporarily hidden */
134 The following #defines are hard-coded for a maximum text
135 resolution corresponding to a maximum framebuffer
136 resolution of 1600x1200 with an 8x8 font...
143 #ifndef BELL_DURATION
144 #define BELL_DURATION ((5 * hz + 99) / 100)
145 #define BELL_PITCH 800
148 /* virtual terminal buffer */
149 typedef struct sc_vtb {
151 #define VTB_VALID (1 << 0)
152 #define VTB_ALLOCED (1 << 1)
154 #define VTB_INVALID 0
156 #define VTB_FRAMEBUFFER 2
157 #define VTB_RINGBUFFER 3
161 vm_offset_t vtb_buffer;
162 int vtb_tail; /* valid for VTB_RINGBUFFER only */
165 /* text cursor attributes */
175 struct video_adapter;
179 typedef struct sc_softc {
180 int unit; /* unit # */
181 int config; /* configuration flags */
182 #define SC_VESA800X600 (1 << 7)
183 #define SC_AUTODETECT_KBD (1 << 8)
184 #define SC_KERNEL_CONSOLE (1 << 9)
186 int flags; /* status flags */
187 #define SC_VISUAL_BELL (1 << 0)
188 #define SC_QUIET_BELL (1 << 1)
189 #if 0 /* not used anymore */
190 #define SC_BLINK_CURSOR (1 << 2)
191 #define SC_CHAR_CURSOR (1 << 3)
193 #define SC_MOUSE_ENABLED (1 << 4)
194 #define SC_SCRN_IDLE (1 << 5)
195 #define SC_SCRN_BLANKED (1 << 6)
196 #define SC_SAVER_FAILED (1 << 7)
197 #define SC_SCRN_VTYLOCK (1 << 8)
199 #define SC_INIT_DONE (1 << 16)
200 #define SC_SPLASH_SCRN (1 << 17)
202 int keyboard; /* -1 if unavailable */
203 struct keyboard *kbd;
206 struct video_adapter *adp;
207 int initial_mode; /* initial video mode */
212 struct scr_stat *cur_scp;
213 struct scr_stat *new_scp;
214 struct scr_stat *old_scp;
215 int delayed_next_scr;
217 char font_loading_in_progress;
218 char switch_in_progress;
219 char videoio_in_progress;
220 char write_in_progress;
221 char blink_in_progress;
223 long scrn_time_stamp;
225 struct cursor_attr dflt_curs_attr;
226 struct cursor_attr curs_attr;
229 u_char scr_rmap[256];
231 #ifdef _SC_MD_SOFTC_DECLARED_
232 sc_md_softc_t md; /* machine dependent vars */
235 #ifndef SC_NO_PALETTE_LOADING
236 u_char palette[256*3];
239 #ifndef SC_NO_FONT_LOADING
255 typedef struct scr_stat {
256 int index; /* index of this vty */
257 struct sc_softc *sc; /* pointer to softc */
258 struct sc_rndr_sw *rndr; /* renderer */
262 int xpos; /* current X position */
263 int ypos; /* current Y position */
264 int xsize; /* X text size */
265 int ysize; /* Y text size */
266 int xpixel; /* X graphics size */
267 int ypixel; /* Y graphics size */
268 int xoff; /* X offset in pixel mode */
269 int yoff; /* Y offset in pixel mode */
271 u_char *font; /* current font */
272 int font_size; /* fontsize in Y direction */
274 int start; /* modified area start */
275 int end; /* modified area end */
277 struct sc_term_sw *tsw;
280 int status; /* status (bitfield) */
281 int kbd_mode; /* keyboard I/O mode */
283 int cursor_pos; /* cursor buffer position */
284 int cursor_oldpos; /* cursor old buffer position */
285 u_short cursor_saveunder_char; /* saved char under cursor */
286 u_short cursor_saveunder_attr; /* saved attr under cursor */
287 struct cursor_attr dflt_curs_attr;
288 struct cursor_attr curr_curs_attr;
289 struct cursor_attr curs_attr;
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 u_char border; /* border color */
309 pid_t pid; /* pid of controlling proc */
310 struct proc *proc; /* proc* of controlling proc */
311 struct vt_mode smode; /* switch mode */
313 sc_vtb_t *history; /* circular history buffer */
314 int history_pos; /* position shown on screen */
315 int history_size; /* size of history buffer */
317 int splash_save_mode; /* saved mode for splash screen */
318 int splash_save_status; /* saved status for splash screen */
319 #ifdef _SCR_MD_STAT_DECLARED_
320 scr_md_stat_t md; /* machine dependent vars */
325 #define SC_NORM_ATTR (FG_LIGHTGREY | BG_BLACK)
327 #ifndef SC_NORM_REV_ATTR
328 #define SC_NORM_REV_ATTR (FG_BLACK | BG_LIGHTGREY)
330 #ifndef SC_KERNEL_CONS_ATTR
331 #define SC_KERNEL_CONS_ATTR (FG_WHITE | BG_BLACK)
333 #ifndef SC_KERNEL_CONS_REV_ATTR
334 #define SC_KERNEL_CONS_REV_ATTR (FG_BLACK | BG_LIGHTGREY)
337 /* terminal emulator */
340 #define SC_DFLT_TERM "*" /* any */
343 typedef int sc_term_init_t(scr_stat *scp, void **tcp, int code);
344 #define SC_TE_COLD_INIT 0
345 #define SC_TE_WARM_INIT 1
346 typedef int sc_term_term_t(scr_stat *scp, void **tcp);
347 typedef void sc_term_puts_t(scr_stat *scp, u_char *buf, int len);
348 typedef int sc_term_ioctl_t(scr_stat *scp, struct tty *tp, u_long cmd,
349 caddr_t data, int flag, struct thread *td);
350 typedef int sc_term_reset_t(scr_stat *scp, int code);
351 #define SC_TE_HARD_RESET 0
352 #define SC_TE_SOFT_RESET 1
353 typedef void sc_term_default_attr_t(scr_stat *scp, int norm, int rev);
354 typedef void sc_term_clear_t(scr_stat *scp);
355 typedef void sc_term_notify_t(scr_stat *scp, int event);
356 #define SC_TE_NOTIFY_VTSWITCH_IN 0
357 #define SC_TE_NOTIFY_VTSWITCH_OUT 1
358 typedef int sc_term_input_t(scr_stat *scp, int c, struct tty *tp);
360 typedef struct sc_term_sw {
361 LIST_ENTRY(sc_term_sw) link;
362 char *te_name; /* name of the emulator */
363 char *te_desc; /* description */
364 char *te_renderer; /* matching renderer */
365 size_t te_size; /* size of internal buffer */
366 int te_refcount; /* reference counter */
367 sc_term_init_t *te_init;
368 sc_term_term_t *te_term;
369 sc_term_puts_t *te_puts;
370 sc_term_ioctl_t *te_ioctl;
371 sc_term_reset_t *te_reset;
372 sc_term_default_attr_t *te_default_attr;
373 sc_term_clear_t *te_clear;
374 sc_term_notify_t *te_notify;
375 sc_term_input_t *te_input;
378 #define SCTERM_MODULE(name, sw) \
379 DATA_SET(scterm_set, sw); \
381 scterm_##name##_event(module_t mod, int type, void *data) \
385 return sc_term_add(&sw); \
387 if (sw.te_refcount > 0) \
389 return sc_term_remove(&sw); \
395 static moduledata_t scterm_##name##_mod = { \
397 scterm_##name##_event, \
400 DECLARE_MODULE(scterm_##name, scterm_##name##_mod, \
401 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
403 /* renderer function table */
404 typedef void vr_clear_t(scr_stat *scp, int c, int attr);
405 typedef void vr_draw_border_t(scr_stat *scp, int color);
406 typedef void vr_draw_t(scr_stat *scp, int from, int count, int flip);
407 typedef void vr_set_cursor_t(scr_stat *scp, int base, int height, int blink);
408 typedef void vr_draw_cursor_t(scr_stat *scp, int at, int blink,
410 typedef void vr_blink_cursor_t(scr_stat *scp, int at, int flip);
411 typedef void vr_set_mouse_t(scr_stat *scp);
412 typedef void vr_draw_mouse_t(scr_stat *scp, int x, int y, int on);
414 typedef struct sc_rndr_sw {
416 vr_draw_border_t *draw_border;
418 vr_set_cursor_t *set_cursor;
419 vr_draw_cursor_t *draw_cursor;
420 vr_blink_cursor_t *blink_cursor;
421 vr_set_mouse_t *set_mouse;
422 vr_draw_mouse_t *draw_mouse;
425 typedef struct sc_renderer {
428 sc_rndr_sw_t *rndrsw;
429 LIST_ENTRY(sc_renderer) link;
432 #define RENDERER(name, mode, sw, set) \
433 static struct sc_renderer scrndr_##name##_##mode = { \
436 DATA_SET(scrndr_set, scrndr_##name##_##mode); \
437 DATA_SET(set, scrndr_##name##_##mode)
439 #define RENDERER_MODULE(name, set) \
440 SET_DECLARE(set, sc_renderer_t); \
442 scrndr_##name##_event(module_t mod, int type, void *data) \
444 sc_renderer_t **list; \
448 SET_FOREACH(list, set) { \
449 error = sc_render_add(*list); \
455 SET_FOREACH(list, set) { \
456 error = sc_render_remove(*list);\
466 static moduledata_t scrndr_##name##_mod = { \
468 scrndr_##name##_event, \
471 DECLARE_MODULE(scrndr_##name, scrndr_##name##_mod, \
472 SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
482 #define ISTEXTSC(scp) (!((scp)->status \
483 & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE)))
484 #define ISGRAPHSC(scp) (((scp)->status \
485 & (UNKNOWN_MODE | GRAPHICS_MODE)))
486 #define ISPIXELSC(scp) (((scp)->status \
487 & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE))\
489 #define ISUNKNOWNSC(scp) ((scp)->status & UNKNOWN_MODE)
491 #define ISMOUSEAVAIL(af) ((af) & V_ADP_FONT)
492 #define ISFONTAVAIL(af) ((af) & V_ADP_FONT)
493 #define ISPALAVAIL(af) ((af) & V_ADP_PALETTE)
495 #define ISSIGVALID(sig) ((sig) > 0 && (sig) < NSIG)
497 #define kbd_read_char(kbd, wait) \
498 (*kbdsw[(kbd)->kb_index]->read_char)((kbd), (wait))
499 #define kbd_check_char(kbd) \
500 (*kbdsw[(kbd)->kb_index]->check_char)((kbd))
501 #define kbd_enable(kbd) \
502 (*kbdsw[(kbd)->kb_index]->enable)((kbd))
503 #define kbd_disable(kbd) \
504 (*kbdsw[(kbd)->kb_index]->disable)((kbd))
505 #define kbd_lock(kbd, lockf) \
506 (*kbdsw[(kbd)->kb_index]->lock)((kbd), (lockf))
507 #define kbd_ioctl(kbd, cmd, arg) \
509 ENODEV : (*kbdsw[(kbd)->kb_index]->ioctl)((kbd), (cmd), (arg)))
510 #define kbd_clear_state(kbd) \
511 (*kbdsw[(kbd)->kb_index]->clear_state)((kbd))
512 #define kbd_get_fkeystr(kbd, fkey, len) \
513 (*kbdsw[(kbd)->kb_index]->get_fkeystr)((kbd), (fkey), (len))
514 #define kbd_poll(kbd, on) \
515 (*kbdsw[(kbd)->kb_index]->poll)((kbd), (on))
518 extern int (*sc_user_ioctl)(dev_t dev, u_long cmd, caddr_t data,
519 int flag, struct thread *td);
521 int sc_probe_unit(int unit, int flags);
522 int sc_attach_unit(int unit, int flags);
524 int set_mode(scr_stat *scp);
526 void sc_set_border(scr_stat *scp, int color);
527 void sc_load_font(scr_stat *scp, int page, int size, u_char *font,
528 int base, int count);
529 void sc_save_font(scr_stat *scp, int page, int size, u_char *font,
530 int base, int count);
531 void sc_show_font(scr_stat *scp, int page);
533 void sc_touch_scrn_saver(void);
534 void sc_puts(scr_stat *scp, u_char *buf, int len);
535 void sc_draw_cursor_image(scr_stat *scp);
536 void sc_remove_cursor_image(scr_stat *scp);
537 void sc_set_cursor_image(scr_stat *scp);
538 void sc_change_cursor_shape(scr_stat *scp, int flags,
539 int base, int height);
540 int sc_clean_up(scr_stat *scp);
541 int sc_switch_scr(sc_softc_t *sc, u_int next_scr);
542 void sc_alloc_scr_buffer(scr_stat *scp, int wait, int discard);
543 int sc_init_emulator(scr_stat *scp, char *name);
544 void sc_paste(scr_stat *scp, u_char *p, int count);
545 void sc_bell(scr_stat *scp, int pitch, int duration);
548 #ifndef SC_NO_HISTORY
549 int sc_alloc_history_buffer(scr_stat *scp, int lines,
550 int prev_ysize, int wait);
551 void sc_free_history_buffer(scr_stat *scp, int prev_ysize);
552 void sc_hist_save(scr_stat *scp);
553 #define sc_hist_save_one_line(scp, from) \
554 sc_vtb_append(&(scp)->vtb, (from), (scp)->history, (scp)->xsize)
555 int sc_hist_restore(scr_stat *scp);
556 void sc_hist_home(scr_stat *scp);
557 void sc_hist_end(scr_stat *scp);
558 int sc_hist_up_line(scr_stat *scp);
559 int sc_hist_down_line(scr_stat *scp);
560 int sc_hist_ioctl(struct tty *tp, u_long cmd, caddr_t data,
561 int flag, struct thread *td);
562 #endif /* SC_NO_HISTORY */
565 #ifndef SC_NO_CUTPASTE
566 void sc_alloc_cut_buffer(scr_stat *scp, int wait);
567 void sc_draw_mouse_image(scr_stat *scp);
568 void sc_remove_mouse_image(scr_stat *scp);
569 int sc_inside_cutmark(scr_stat *scp, int pos);
570 void sc_remove_cutmarking(scr_stat *scp);
571 void sc_remove_all_cutmarkings(sc_softc_t *scp);
572 void sc_remove_all_mouse(sc_softc_t *scp);
573 void sc_mouse_paste(scr_stat *scp);
575 #define sc_draw_mouse_image(scp)
576 #define sc_remove_mouse_image(scp)
577 #define sc_inside_cutmark(scp, pos) FALSE
578 #define sc_remove_cutmarking(scp)
579 #define sc_remove_all_cutmarkings(scp)
580 #define sc_remove_all_mouse(scp)
581 #define sc_mouse_paste(scp)
582 #endif /* SC_NO_CUTPASTE */
583 #ifndef SC_NO_SYSMOUSE
584 void sc_mouse_move(scr_stat *scp, int x, int y);
585 int sc_mouse_ioctl(struct tty *tp, u_long cmd, caddr_t data,
586 int flag, struct thread *td);
587 #endif /* SC_NO_SYSMOUSE */
590 int sc_set_text_mode(scr_stat *scp, struct tty *tp, int mode,
591 int xsize, int ysize, int fontsize);
592 int sc_set_graphics_mode(scr_stat *scp, struct tty *tp, int mode);
593 int sc_set_pixel_mode(scr_stat *scp, struct tty *tp,
594 int xsize, int ysize, int fontsize);
595 int sc_vid_ioctl(struct tty *tp, u_long cmd, caddr_t data, int flag,
598 int sc_render_add(sc_renderer_t *rndr);
599 int sc_render_remove(sc_renderer_t *rndr);
600 sc_rndr_sw_t *sc_render_match(scr_stat *scp, char *name, int mode);
603 void sc_vtb_init(sc_vtb_t *vtb, int type, int cols, int rows,
604 void *buffer, int wait);
605 void sc_vtb_destroy(sc_vtb_t *vtb);
606 size_t sc_vtb_size(int cols, int rows);
607 void sc_vtb_clear(sc_vtb_t *vtb, int c, int attr);
609 int sc_vtb_getc(sc_vtb_t *vtb, int at);
610 int sc_vtb_geta(sc_vtb_t *vtb, int at);
611 void sc_vtb_putc(sc_vtb_t *vtb, int at, int c, int a);
612 vm_offset_t sc_vtb_putchar(sc_vtb_t *vtb, vm_offset_t p, int c, int a);
613 vm_offset_t sc_vtb_pointer(sc_vtb_t *vtb, int at);
614 int sc_vtb_pos(sc_vtb_t *vtb, int pos, int offset);
616 #define sc_vtb_tail(vtb) ((vtb)->vtb_tail)
617 #define sc_vtb_rows(vtb) ((vtb)->vtb_rows)
618 #define sc_vtb_cols(vtb) ((vtb)->vtb_cols)
620 void sc_vtb_copy(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2, int to,
622 void sc_vtb_append(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2,
624 void sc_vtb_seek(sc_vtb_t *vtb, int pos);
625 void sc_vtb_erase(sc_vtb_t *vtb, int at, int count, int c, int attr);
626 void sc_vtb_move(sc_vtb_t *vtb, int from, int to, int count);
627 void sc_vtb_delete(sc_vtb_t *vtb, int at, int count, int c, int attr);
628 void sc_vtb_ins(sc_vtb_t *vtb, int at, int count, int c, int attr);
631 int sysmouse_event(mouse_info_t *info);
634 void sc_move_cursor(scr_stat *scp, int x, int y);
635 void sc_clear_screen(scr_stat *scp);
636 int sc_term_add(sc_term_sw_t *sw);
637 int sc_term_remove(sc_term_sw_t *sw);
638 sc_term_sw_t *sc_term_match(char *name);
639 sc_term_sw_t *sc_term_match_by_number(int index);
641 /* machine dependent functions */
642 int sc_max_unit(void);
643 sc_softc_t *sc_get_softc(int unit, int flags);
644 sc_softc_t *sc_find_softc(struct video_adapter *adp, struct keyboard *kbd);
645 int sc_get_cons_priority(int *unit, int *flags);
646 void sc_get_bios_values(bios_values_t *values);
647 int sc_tone(int herz);
649 #endif /* !_DEV_SYSCONS_SYSCONS_H_ */