xref: /freebsd/sys/dev/syscons/syscons.h (revision a7dea1671b87c07d2d266f836bfa8b58efc7c134)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1995-1998 Søren Schmidt
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The DragonFly Project
8  * by Sascha Wildner <saw@online.de>
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer,
15  *    without modification, immediately at the beginning of the file.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. The name of the author may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * $FreeBSD$
34  */
35 
36 #ifndef _DEV_SYSCONS_SYSCONS_H_
37 #define	_DEV_SYSCONS_SYSCONS_H_
38 
39 #include <sys/kdb.h>		/* XXX */
40 #include <sys/_lock.h>
41 #include <sys/_mutex.h>
42 
43 /* default values for configuration options */
44 
45 #ifndef MAXCONS
46 #define MAXCONS		16
47 #endif
48 
49 #ifdef SC_NO_SYSMOUSE
50 #undef SC_NO_CUTPASTE
51 #define SC_NO_CUTPASTE	1
52 #endif
53 
54 #ifdef SC_NO_MODE_CHANGE
55 #undef SC_PIXEL_MODE
56 #endif
57 
58 /* Always load font data if the pixel (raster text) mode is to be used. */
59 #ifdef SC_PIXEL_MODE
60 #undef SC_NO_FONT_LOADING
61 #endif
62 
63 /*
64  * If font data is not available, the `arrow'-shaped mouse cursor cannot
65  * be drawn.  Use the alternative drawing method.
66  */
67 #ifdef SC_NO_FONT_LOADING
68 #undef SC_ALT_MOUSE_IMAGE
69 #define SC_ALT_MOUSE_IMAGE 1
70 #endif
71 
72 #ifndef SC_CURSOR_CHAR
73 #define SC_CURSOR_CHAR	7
74 #endif
75 
76 #ifndef SC_MOUSE_CHAR
77 #define SC_MOUSE_CHAR	8
78 #endif
79 
80 #if SC_MOUSE_CHAR <= SC_CURSOR_CHAR && SC_CURSOR_CHAR < (SC_MOUSE_CHAR + 4)
81 #undef SC_CURSOR_CHAR
82 #define SC_CURSOR_CHAR	(SC_MOUSE_CHAR + 4)
83 #endif
84 
85 #ifndef SC_DEBUG_LEVEL
86 #define SC_DEBUG_LEVEL	0
87 #endif
88 
89 #define DPRINTF(l, p)	if (SC_DEBUG_LEVEL >= (l)) printf p
90 
91 #ifndef __sparc64__
92 #define SC_DRIVER_NAME	"sc"
93 #else
94 /*
95  * Use a different driver name on sparc64 so it does not get confused
96  * with the system controller devices which are also termed 'sc' in OFW.
97  */
98 #define SC_DRIVER_NAME	"syscons"
99 #endif
100 #define SC_VTY(dev)	(((sc_ttysoftc *)tty_softc(tp))->st_index)
101 #define SC_DEV(sc, vty)	((sc)->dev[(vty) - (sc)->first_vty])
102 #define SC_STAT(tp)	(*((scr_stat **)&((sc_ttysoftc *)tty_softc(tp))->st_stat))
103 
104 /* printable chars */
105 #ifndef PRINTABLE
106 #define PRINTABLE(ch)	((ch) > 0x1b || ((ch) > 0x0d && (ch) < 0x1b) \
107 			 || (ch) < 0x07)
108 #endif
109 
110 /* macros for "intelligent" screen update */
111 #define mark_for_update(scp, x)	{\
112 			  	    if ((x) < scp->start) scp->start = (x);\
113 				    else if ((x) > scp->end) scp->end = (x);\
114 				}
115 #define mark_all(scp)		{\
116 				    scp->start = 0;\
117 				    scp->end = scp->xsize * scp->ysize - 1;\
118 				}
119 
120 /* vty status flags (scp->status) */
121 #define UNKNOWN_MODE	0x00010		/* unknown video mode */
122 #define SWITCH_WAIT_REL	0x00080		/* waiting for vty release */
123 #define SWITCH_WAIT_ACQ	0x00100		/* waiting for vty ack */
124 #define BUFFER_SAVED	0x00200		/* vty buffer is saved */
125 #define CURSOR_ENABLED 	0x00400		/* text cursor is enabled */
126 #define MOUSE_MOVED	0x01000		/* mouse cursor has moved */
127 #define MOUSE_CUTTING	0x02000		/* mouse cursor is cutting text */
128 #define MOUSE_VISIBLE	0x04000		/* mouse cursor is showing */
129 #define GRAPHICS_MODE	0x08000		/* vty is in a graphics mode */
130 #define PIXEL_MODE	0x10000		/* vty is in a raster text mode */
131 #define SAVER_RUNNING	0x20000		/* screen saver is running */
132 #define VR_CURSOR_BLINK	0x40000		/* blinking text cursor */
133 #define VR_CURSOR_ON	0x80000		/* text cursor is on */
134 #define MOUSE_HIDDEN	0x100000	/* mouse cursor is temporarily hidden */
135 
136 /* misc defines */
137 #define FALSE		0
138 #define TRUE		1
139 
140 /*
141    The following #defines are hard-coded for a maximum text
142    resolution corresponding to a maximum framebuffer
143    resolution of 1920x1200 with an 8x8 font...
144 */
145 #define	COL		240
146 #define	ROW		150
147 
148 #define PCBURST		128
149 
150 #ifndef BELL_DURATION
151 #define BELL_DURATION	((5 * hz + 99) / 100)
152 #define BELL_PITCH	800
153 #endif
154 
155 /* virtual terminal buffer */
156 typedef struct sc_vtb {
157 	int		vtb_flags;
158 #define VTB_VALID	(1 << 0)
159 #define VTB_ALLOCED	(1 << 1)
160 	int		vtb_type;
161 #define VTB_INVALID	0
162 #define VTB_MEMORY	1
163 #define VTB_FRAMEBUFFER	2
164 #define VTB_RINGBUFFER	3
165 	int		vtb_cols;
166 	int		vtb_rows;
167 	int		vtb_size;
168 	vm_offset_t	vtb_buffer;
169 	int		vtb_tail;	/* valid for VTB_RINGBUFFER only */
170 } sc_vtb_t;
171 
172 /* text and some mouse cursor attributes */
173 struct cursor_attr {
174 	u_char		flags;
175 	u_char		base;
176 	u_char		height;
177 	u_char		bg[3];
178 	u_char		mouse_ba;
179 	u_char		mouse_ia;
180 };
181 
182 /* softc */
183 
184 struct keyboard;
185 struct video_adapter;
186 struct scr_stat;
187 struct tty;
188 
189 struct sc_cnstate {
190 	u_char		kbd_locked;
191 	u_char		kdb_locked;
192 	u_char		mtx_locked;
193 	u_char		kbd_opened;
194 	u_char		scr_opened;
195 };
196 
197 typedef struct sc_softc {
198 	int		unit;			/* unit # */
199 	int		config;			/* configuration flags */
200 #define SC_VESAMODE	(1 << 7)
201 #define SC_AUTODETECT_KBD (1 << 8)
202 #define SC_KERNEL_CONSOLE (1 << 9)
203 
204 	int		flags;			/* status flags */
205 #define SC_VISUAL_BELL	(1 << 0)
206 #define SC_QUIET_BELL	(1 << 1)
207 #if 0 /* not used anymore */
208 #define SC_BLINK_CURSOR	(1 << 2)
209 #define SC_CHAR_CURSOR	(1 << 3)
210 #endif
211 #define SC_MOUSE_ENABLED (1 << 4)
212 #define	SC_SCRN_IDLE	(1 << 5)
213 #define	SC_SCRN_BLANKED	(1 << 6)
214 #define	SC_SAVER_FAILED	(1 << 7)
215 #define	SC_SCRN_VTYLOCK	(1 << 8)
216 
217 #define	SC_INIT_DONE	(1 << 16)
218 #define	SC_SPLASH_SCRN	(1 << 17)
219 
220 	struct keyboard	*kbd;			/* NULL if unavailable. */
221 
222 	int		adapter;
223 	struct video_adapter *adp;
224 	int		initial_mode;		/* initial video mode */
225 
226 	int		first_vty;
227 	int		vtys;
228 	struct tty **dev;
229 	struct scr_stat	*cur_scp;
230 	struct scr_stat	*new_scp;
231 	struct scr_stat	*old_scp;
232 	int     	delayed_next_scr;
233 
234 	char        	font_loading_in_progress;
235 	char        	switch_in_progress;
236 	char        	write_in_progress;
237 	char        	blink_in_progress;
238 	int		grab_level;
239 	/* 2 is just enough for kdb to grab for stepping normal grabbing: */
240 	struct sc_cnstate grab_state[2];
241 	int		kbd_open_level;
242 	struct mtx	video_mtx;
243 
244 	long		scrn_time_stamp;
245 
246 	struct cursor_attr dflt_curs_attr;
247 	struct cursor_attr curs_attr;
248 
249 	u_char      	scr_map[256];
250 	u_char      	scr_rmap[256];
251 
252 #ifdef _SC_MD_SOFTC_DECLARED_
253 	sc_md_softc_t	md;			/* machine dependent vars */
254 #endif
255 
256 #ifndef SC_NO_PALETTE_LOADING
257 	u_char		palette[256 * 3];
258 #ifdef SC_PIXEL_MODE
259 	u_char		palette2[256 * 3];
260 #endif
261 #endif
262 
263 #ifndef SC_NO_FONT_LOADING
264 	int     	fonts_loaded;
265 #define FONT_8		2
266 #define FONT_14		4
267 #define FONT_16		8
268 #define FONT_22		8
269 	u_char		*font_8;
270 	u_char		*font_14;
271 	u_char		*font_16;
272 	u_char		*font_22;
273 #endif
274 
275 	u_char		cursor_char;
276 	u_char		mouse_char;
277 
278 #ifdef KDB
279 	int		sc_altbrk;
280 #endif
281 	struct callout	ctimeout;
282 	struct callout	cblink;
283 } sc_softc_t;
284 
285 /* virtual screen */
286 typedef struct scr_stat {
287 	int		index;			/* index of this vty */
288 	struct sc_softc *sc;			/* pointer to softc */
289 	struct sc_rndr_sw *rndr;		/* renderer */
290 #ifndef __sparc64__
291 	sc_vtb_t	scr;
292 #endif
293 	sc_vtb_t	vtb;
294 
295 	int 		xpos;			/* current X position */
296 	int 		ypos;			/* current Y position */
297 	int 		xsize;			/* X text size */
298 	int 		ysize;			/* Y text size */
299 	int 		xpixel;			/* X graphics size */
300 	int 		ypixel;			/* Y graphics size */
301 	int		xoff;			/* X offset in pixel mode */
302 	int		yoff;			/* Y offset in pixel mode */
303 
304 	u_char		*font;			/* current font */
305 	int		font_size;		/* fontsize in Y direction */
306 	int		font_width;		/* fontsize in X direction */
307 
308 	int		start;			/* modified area start */
309 	int		end;			/* modified area end */
310 
311 	struct sc_term_sw *tsw;
312 	void		*ts;
313 
314 	int	 	status;			/* status (bitfield) */
315 	int		kbd_mode;		/* keyboard I/O mode */
316 
317 	int		cursor_pos;		/* cursor buffer position */
318 	int		cursor_oldpos;		/* cursor old buffer position */
319 	struct cursor_attr dflt_curs_attr;
320 	struct cursor_attr base_curs_attr;
321 	struct cursor_attr curs_attr;
322 
323 	int		mouse_pos;		/* mouse buffer position */
324 	int		mouse_oldpos;		/* mouse old buffer position */
325 	short		mouse_xpos;		/* mouse x coordinate */
326 	short		mouse_ypos;		/* mouse y coordinate */
327 	short		mouse_oldxpos;		/* mouse previous x coordinate */
328 	short		mouse_oldypos;		/* mouse previous y coordinate */
329 	short		mouse_buttons;		/* mouse buttons */
330 	int		mouse_cut_start;	/* mouse cut start pos */
331 	int		mouse_cut_end;		/* mouse cut end pos */
332 	int		mouse_level;		/* xterm mouse protocol */
333 	struct proc 	*mouse_proc;		/* proc* of controlling proc */
334 	pid_t 		mouse_pid;		/* pid of controlling proc */
335 	int		mouse_signal;		/* signal # to report with */
336 	const void	*mouse_data;		/* renderer (pixmap) data */
337 
338 	u_short		bell_duration;
339 	u_short		bell_pitch;
340 
341 	u_char		border;			/* border color */
342 	int	 	mode;			/* mode */
343 	pid_t 		pid;			/* pid of controlling proc */
344 	struct proc 	*proc;			/* proc* of controlling proc */
345 	struct vt_mode 	smode;			/* switch mode */
346 
347 	sc_vtb_t	*history;		/* circular history buffer */
348 	int		history_pos;		/* position shown on screen */
349 	int		history_size;		/* size of history buffer */
350 
351 	int		splash_save_mode;	/* saved mode for splash screen */
352 	int		splash_save_status;	/* saved status for splash screen */
353 #ifdef _SCR_MD_STAT_DECLARED_
354 	scr_md_stat_t	md;			/* machine dependent vars */
355 #endif
356 } scr_stat;
357 
358 /* TTY softc. */
359 typedef struct sc_ttysoftc {
360 	int		st_index;
361 	scr_stat	*st_stat;
362 } sc_ttysoftc;
363 
364 #ifndef SC_NORM_ATTR
365 #define SC_NORM_ATTR		(FG_LIGHTGREY | BG_BLACK)
366 #endif
367 #ifndef SC_NORM_REV_ATTR
368 #define SC_NORM_REV_ATTR	(FG_BLACK | BG_LIGHTGREY)
369 #endif
370 #ifndef SC_KERNEL_CONS_ATTR
371 #define SC_KERNEL_CONS_ATTR	(FG_WHITE | BG_BLACK)
372 #endif
373 #ifndef SC_KERNEL_CONS_REV_ATTR
374 #define SC_KERNEL_CONS_REV_ATTR	(FG_BLACK | BG_LIGHTGREY)
375 #endif
376 
377 /* terminal emulator */
378 
379 #ifndef SC_DFLT_TERM
380 #define SC_DFLT_TERM	"scteken"
381 #endif
382 
383 typedef int	sc_term_init_t(scr_stat *scp, void **tcp, int code);
384 #define SC_TE_COLD_INIT	0
385 #define SC_TE_WARM_INIT	1
386 typedef int	sc_term_term_t(scr_stat *scp, void **tcp);
387 typedef void	sc_term_puts_t(scr_stat *scp, u_char *buf, int len);
388 typedef int	sc_term_ioctl_t(scr_stat *scp, struct tty *tp, u_long cmd,
389 				caddr_t data, struct thread *td);
390 typedef int	sc_term_reset_t(scr_stat *scp, int code);
391 #define SC_TE_HARD_RESET 0
392 #define SC_TE_SOFT_RESET 1
393 typedef void	sc_term_default_attr_t(scr_stat *scp, int norm, int rev);
394 typedef void	sc_term_clear_t(scr_stat *scp);
395 typedef void	sc_term_notify_t(scr_stat *scp, int event);
396 #define SC_TE_NOTIFY_VTSWITCH_IN	0
397 #define SC_TE_NOTIFY_VTSWITCH_OUT	1
398 typedef int	sc_term_input_t(scr_stat *scp, int c, struct tty *tp);
399 typedef const char *sc_term_fkeystr_t(scr_stat *scp, int c);
400 typedef void sc_term_sync_t(scr_stat *scp);
401 
402 typedef struct sc_term_sw {
403 	LIST_ENTRY(sc_term_sw)	link;
404 	char 			*te_name;	/* name of the emulator */
405 	char 			*te_desc;	/* description */
406 	char 			*te_renderer;	/* matching renderer */
407 	size_t			te_size;	/* size of internal buffer */
408 	int			te_refcount;	/* reference counter */
409 	sc_term_init_t		*te_init;
410 	sc_term_term_t		*te_term;
411 	sc_term_puts_t		*te_puts;
412 	sc_term_ioctl_t		*te_ioctl;
413 	sc_term_reset_t		*te_reset;
414 	sc_term_default_attr_t	*te_default_attr;
415 	sc_term_clear_t		*te_clear;
416 	sc_term_notify_t	*te_notify;
417 	sc_term_input_t		*te_input;
418 	sc_term_fkeystr_t	*te_fkeystr;
419 	sc_term_sync_t		*te_sync;
420 } sc_term_sw_t;
421 
422 #define SCTERM_MODULE(name, sw)					\
423 	DATA_SET(scterm_set, sw);				\
424 	static int						\
425 	scterm_##name##_event(module_t mod, int type, void *data) \
426 	{							\
427 		switch (type) {					\
428 		case MOD_LOAD:					\
429 			return sc_term_add(&sw);		\
430 		case MOD_UNLOAD:				\
431 			if (sw.te_refcount > 0)			\
432 				return EBUSY;			\
433 			return sc_term_remove(&sw);		\
434 		default:					\
435 			return EOPNOTSUPP;			\
436 			break;					\
437 		}						\
438 		return 0;					\
439 	}							\
440 	static moduledata_t scterm_##name##_mod = {		\
441 		"scterm-" #name,				\
442 		scterm_##name##_event,				\
443 		NULL,						\
444 	};							\
445 	DECLARE_MODULE(scterm_##name, scterm_##name##_mod,	\
446 		       SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
447 
448 /* renderer function table */
449 typedef void	vr_init_t(scr_stat *scp);
450 typedef void	vr_clear_t(scr_stat *scp, int c, int attr);
451 typedef void	vr_draw_border_t(scr_stat *scp, int color);
452 typedef void	vr_draw_t(scr_stat *scp, int from, int count, int flip);
453 typedef void	vr_set_cursor_t(scr_stat *scp, int base, int height, int blink);
454 typedef void	vr_draw_cursor_t(scr_stat *scp, int at, int blink,
455 				 int on, int flip);
456 typedef void	vr_blink_cursor_t(scr_stat *scp, int at, int flip);
457 typedef void	vr_set_mouse_t(scr_stat *scp);
458 typedef void	vr_draw_mouse_t(scr_stat *scp, int x, int y, int on);
459 
460 typedef struct sc_rndr_sw {
461 	vr_init_t		*init;
462 	vr_clear_t		*clear;
463 	vr_draw_border_t	*draw_border;
464 	vr_draw_t		*draw;
465 	vr_set_cursor_t		*set_cursor;
466 	vr_draw_cursor_t	*draw_cursor;
467 	vr_blink_cursor_t	*blink_cursor;
468 	vr_set_mouse_t		*set_mouse;
469 	vr_draw_mouse_t		*draw_mouse;
470 } sc_rndr_sw_t;
471 
472 typedef struct sc_renderer {
473 	char			*name;
474 	int			mode;
475 	sc_rndr_sw_t		*rndrsw;
476 	LIST_ENTRY(sc_renderer)	link;
477 } sc_renderer_t;
478 
479 #define RENDERER(name, mode, sw, set)				\
480 	static struct sc_renderer scrndr_##name##_##mode = {	\
481 		#name, mode, &sw				\
482 	};							\
483 	DATA_SET(scrndr_set, scrndr_##name##_##mode);		\
484 	DATA_SET(set, scrndr_##name##_##mode)
485 
486 #define RENDERER_MODULE(name, set)				\
487 	SET_DECLARE(set, sc_renderer_t);			\
488 	static int						\
489 	scrndr_##name##_event(module_t mod, int type, void *data) \
490 	{							\
491 		sc_renderer_t **list;				\
492 		int error = 0;					\
493 		switch (type) {					\
494 		case MOD_LOAD:					\
495 			SET_FOREACH(list, set) {		\
496 				error = sc_render_add(*list);	\
497 				if (error)			\
498 					break;			\
499 			}					\
500 			break;					\
501 		case MOD_UNLOAD:				\
502 			SET_FOREACH(list, set) {		\
503 				error = sc_render_remove(*list);\
504 				if (error)			\
505 					break;			\
506 			}					\
507 			break;					\
508 		default:					\
509 			return EOPNOTSUPP;			\
510 			break;					\
511 		}						\
512 		return error;					\
513 	}							\
514 	static moduledata_t scrndr_##name##_mod = {		\
515 		"scrndr-" #name,				\
516 		scrndr_##name##_event,				\
517 		NULL,						\
518 	};							\
519 	DECLARE_MODULE(scrndr_##name, scrndr_##name##_mod, 	\
520 		       SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
521 
522 typedef struct {
523 	int		shift_state;
524 	int		bell_pitch;
525 } bios_values_t;
526 
527 /* other macros */
528 #define ISTEXTSC(scp)	(!((scp)->status 				\
529 			  & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE)))
530 #define ISGRAPHSC(scp)	(((scp)->status 				\
531 			  & (UNKNOWN_MODE | GRAPHICS_MODE)))
532 #define ISPIXELSC(scp)	(((scp)->status 				\
533 			  & (UNKNOWN_MODE | GRAPHICS_MODE | PIXEL_MODE))\
534 			  == PIXEL_MODE)
535 #define ISUNKNOWNSC(scp) ((scp)->status & UNKNOWN_MODE)
536 
537 #define ISMOUSEAVAIL(af) ((af) & V_ADP_FONT)
538 #define ISFONTAVAIL(af)	((af) & V_ADP_FONT)
539 #define ISPALAVAIL(af)	((af) & V_ADP_PALETTE)
540 
541 #define ISSIGVALID(sig)	((sig) > 0 && (sig) < NSIG)
542 
543 #define SC_VIDEO_LOCKINIT(sc)						\
544 		mtx_init(&(sc)->video_mtx, "syscons video lock", NULL,	\
545 		    MTX_SPIN | MTX_RECURSE);
546 #define SC_VIDEO_LOCK(sc)						\
547 		do {							\
548 			if (!kdb_active)				\
549 				mtx_lock_spin(&(sc)->video_mtx);	\
550 		} while(0)
551 #define SC_VIDEO_UNLOCK(sc)						\
552 		do {							\
553 			if (!kdb_active)				\
554 				mtx_unlock_spin(&(sc)->video_mtx);	\
555 		} while(0)
556 
557 /* syscons.c */
558 extern int 	(*sc_user_ioctl)(struct tty *tp, u_long cmd, caddr_t data,
559 				 struct thread *td);
560 
561 int		sc_probe_unit(int unit, int flags);
562 int		sc_attach_unit(int unit, int flags);
563 
564 int		set_mode(scr_stat *scp);
565 
566 void		sc_set_border(scr_stat *scp, int color);
567 void		sc_load_font(scr_stat *scp, int page, int size, int width,
568 			     u_char *font, int base, int count);
569 void		sc_save_font(scr_stat *scp, int page, int size, int width,
570 			     u_char *font, int base, int count);
571 void		sc_show_font(scr_stat *scp, int page);
572 
573 void		sc_touch_scrn_saver(void);
574 void		sc_draw_cursor_image(scr_stat *scp);
575 void		sc_remove_cursor_image(scr_stat *scp);
576 void		sc_set_cursor_image(scr_stat *scp);
577 void		sc_change_cursor_shape(scr_stat *scp, int flags,
578 				       int base, int height);
579 int		sc_clean_up(scr_stat *scp);
580 int		sc_switch_scr(sc_softc_t *sc, u_int next_scr);
581 void		sc_alloc_scr_buffer(scr_stat *scp, int wait, int discard);
582 int		sc_init_emulator(scr_stat *scp, char *name);
583 void		sc_paste(scr_stat *scp, const u_char *p, int count);
584 void		sc_respond(scr_stat *scp, const u_char *p,
585 			   int count, int wakeup);
586 void		sc_bell(scr_stat *scp, int pitch, int duration);
587 
588 /* schistory.c */
589 #ifndef SC_NO_HISTORY
590 int		sc_alloc_history_buffer(scr_stat *scp, int lines,
591 					int prev_ysize, int wait);
592 void		sc_free_history_buffer(scr_stat *scp, int prev_ysize);
593 void		sc_hist_save(scr_stat *scp);
594 #define		sc_hist_save_one_line(scp, from)	\
595 		sc_vtb_append(&(scp)->vtb, (from), (scp)->history, (scp)->xsize)
596 int		sc_hist_restore(scr_stat *scp);
597 void		sc_hist_home(scr_stat *scp);
598 void		sc_hist_end(scr_stat *scp);
599 int		sc_hist_up_line(scr_stat *scp);
600 int		sc_hist_down_line(scr_stat *scp);
601 int		sc_hist_ioctl(struct tty *tp, u_long cmd, caddr_t data,
602 			      struct thread *td);
603 #endif /* SC_NO_HISTORY */
604 
605 /* scmouse.c */
606 #ifndef SC_NO_CUTPASTE
607 void		sc_alloc_cut_buffer(scr_stat *scp, int wait);
608 void		sc_draw_mouse_image(scr_stat *scp);
609 void		sc_remove_mouse_image(scr_stat *scp);
610 int		sc_inside_cutmark(scr_stat *scp, int pos);
611 void		sc_remove_cutmarking(scr_stat *scp);
612 void		sc_remove_all_cutmarkings(sc_softc_t *scp);
613 void		sc_remove_all_mouse(sc_softc_t *scp);
614 void		sc_mouse_paste(scr_stat *scp);
615 #else
616 #define		sc_draw_mouse_image(scp)
617 #define		sc_remove_mouse_image(scp)
618 #define		sc_inside_cutmark(scp, pos)	FALSE
619 #define		sc_remove_cutmarking(scp)
620 #define		sc_remove_all_cutmarkings(scp)
621 #define		sc_remove_all_mouse(scp)
622 #define		sc_mouse_paste(scp)
623 #endif /* SC_NO_CUTPASTE */
624 #ifndef SC_NO_SYSMOUSE
625 void		sc_mouse_move(scr_stat *scp, int x, int y);
626 int		sc_mouse_ioctl(struct tty *tp, u_long cmd, caddr_t data,
627 			       struct thread *td);
628 #endif /* SC_NO_SYSMOUSE */
629 
630 /* scvidctl.c */
631 int		sc_set_text_mode(scr_stat *scp, struct tty *tp, int mode,
632 				 int xsize, int ysize, int fontsize,
633 				 int font_width);
634 int		sc_set_graphics_mode(scr_stat *scp, struct tty *tp, int mode);
635 int		sc_set_pixel_mode(scr_stat *scp, struct tty *tp, int xsize,
636 				  int ysize, int fontsize, int font_width);
637 int		sc_support_pixel_mode(void *arg);
638 int		sc_vid_ioctl(struct tty *tp, u_long cmd, caddr_t data,
639 			     struct thread *td);
640 
641 int		sc_render_add(sc_renderer_t *rndr);
642 int		sc_render_remove(sc_renderer_t *rndr);
643 sc_rndr_sw_t	*sc_render_match(scr_stat *scp, char *name, int mode);
644 
645 /* scvtb.c */
646 void		sc_vtb_init(sc_vtb_t *vtb, int type, int cols, int rows,
647 			    void *buffer, int wait);
648 void		sc_vtb_destroy(sc_vtb_t *vtb);
649 size_t		sc_vtb_size(int cols, int rows);
650 void		sc_vtb_clear(sc_vtb_t *vtb, int c, int attr);
651 
652 int		sc_vtb_getc(sc_vtb_t *vtb, int at);
653 int		sc_vtb_geta(sc_vtb_t *vtb, int at);
654 void		sc_vtb_putc(sc_vtb_t *vtb, int at, int c, int a);
655 vm_offset_t	sc_vtb_putchar(sc_vtb_t *vtb, vm_offset_t p, int c, int a);
656 vm_offset_t	sc_vtb_pointer(sc_vtb_t *vtb, int at);
657 int		sc_vtb_pos(sc_vtb_t *vtb, int pos, int offset);
658 
659 #define		sc_vtb_tail(vtb)	((vtb)->vtb_tail)
660 #define		sc_vtb_rows(vtb)	((vtb)->vtb_rows)
661 #define		sc_vtb_cols(vtb)	((vtb)->vtb_cols)
662 
663 void		sc_vtb_copy(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2, int to,
664 			    int count);
665 void		sc_vtb_append(sc_vtb_t *vtb1, int from, sc_vtb_t *vtb2,
666 			      int count);
667 void		sc_vtb_seek(sc_vtb_t *vtb, int pos);
668 void		sc_vtb_erase(sc_vtb_t *vtb, int at, int count, int c, int attr);
669 void		sc_vtb_move(sc_vtb_t *vtb, int from, int to, int count);
670 void		sc_vtb_delete(sc_vtb_t *vtb, int at, int count, int c, int attr);
671 void		sc_vtb_ins(sc_vtb_t *vtb, int at, int count, int c, int attr);
672 
673 /* sysmouse.c */
674 int		sysmouse_event(mouse_info_t *info);
675 
676 /* scterm.c */
677 void		sc_move_cursor(scr_stat *scp, int x, int y);
678 void		sc_clear_screen(scr_stat *scp);
679 int		sc_term_add(sc_term_sw_t *sw);
680 int		sc_term_remove(sc_term_sw_t *sw);
681 sc_term_sw_t	*sc_term_match(char *name);
682 sc_term_sw_t	*sc_term_match_by_number(int index);
683 
684 /* machine dependent functions */
685 int		sc_max_unit(void);
686 sc_softc_t	*sc_get_softc(int unit, int flags);
687 sc_softc_t	*sc_find_softc(struct video_adapter *adp, struct keyboard *kbd);
688 int		sc_get_cons_priority(int *unit, int *flags);
689 void		sc_get_bios_values(bios_values_t *values);
690 int		sc_tone(int herz);
691 
692 #endif /* !_DEV_SYSCONS_SYSCONS_H_ */
693