xref: /netbsd-src/sys/dev/wscons/wsdisplay_vconsvar.h (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: wsdisplay_vconsvar.h,v 1.8 2007/08/06 03:11:32 macallan Exp $ */
2 
3 /*-
4  * Copyright (c) 2005, 2006 Michael Lorenz
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *        This product includes software developed by the NetBSD
18  *        Foundation, Inc. and its contributors.
19  * 4. Neither the name of The NetBSD Foundation nor the names of its
20  *    contributors may be used to endorse or promote products derived
21  *    from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 #ifndef _WSDISPLAY_VCONS_H_
37 #define _WSDISPLAY_VCONS_H_
38 
39 #include "opt_wsdisplay_compat.h"
40 #include "opt_vcons.h"
41 
42 struct vcons_data;
43 
44 struct vcons_screen {
45 	struct rasops_info scr_ri;
46 	LIST_ENTRY(vcons_screen) next;
47 	void *scr_cookie;
48 	struct vcons_data *scr_vd;
49 	struct vcons_data *scr_origvd;
50 	const struct wsscreen_descr *scr_type;
51 	uint16_t *scr_chars;
52 	long *scr_attrs;
53 	long scr_defattr;
54 	/* static flags set by the driver */
55 	uint32_t scr_flags;
56 #define VCONS_NO_REDRAW		1	/* don't readraw in switch_screen */
57 #define	VCONS_SCREEN_IS_STATIC	2	/* don't free() this vcons_screen */
58 #define VCONS_SWITCH_NEEDS_POLLING 4	/* rasops can overlap so we need to
59 					 * poll the busy flag when switching
60 					 * - for drivers that use software
61 					 * drawing */
62 #define VCONS_DONT_DRAW		8	/* don't draw on this screen at all */
63 	/* status flags used by vcons */
64 	uint32_t scr_status;
65 #define VCONS_IS_VISIBLE	1	/* this screen is currently visible */
66 	/* non zero when some rasops operation is in progress */
67 	int scr_busy;
68 #ifdef WSDISPLAY_SCROLLSUPPORT
69 	int scr_lines_in_buffer;
70 	int scr_current_line;
71 	int scr_line_wanted;
72 	int scr_offset_to_zero;
73 	int scr_current_offset;
74 #endif
75 };
76 
77 #define SCREEN_IS_VISIBLE(scr) (((scr)->scr_status & VCONS_IS_VISIBLE) != 0)
78 #define SCREEN_IS_BUSY(scr) ((scr)->scr_busy != 0)
79 #define SCREEN_CAN_DRAW(scr) (((scr)->scr_flags & VCONS_DONT_DRAW) == 0)
80 #define SCREEN_BUSY(scr) ((scr)->scr_busy = 1)
81 #define SCREEN_IDLE(scr) ((scr)->scr_busy = 0)
82 #define SCREEN_VISIBLE(scr) ((scr)->scr_status |= VCONS_IS_VISIBLE)
83 #define SCREEN_INVISIBLE(scr) ((scr)->scr_status &= ~VCONS_IS_VISIBLE)
84 #define SCREEN_DISABLE_DRAWING(scr) ((scr)->scr_flags |= VCONS_DONT_DRAW)
85 #define SCREEN_ENABLE_DRAWING(scr) ((scr)->scr_flags &= ~VCONS_DONT_DRAW)
86 
87 struct vcons_data {
88 	/* usually the drivers softc */
89 	void *cookie;
90 
91 	/*
92 	 * setup the rasops part of the passed vcons_screen, like
93 	 * geometry, framebuffer address, font, characters, acceleration.
94 	 * we pass the cookie as 1st parameter
95 	 */
96 	void (*init_screen)(void *, struct vcons_screen *, int,
97 	    long *);
98 
99 	/* accessops */
100 	int (*ioctl)(void *, void *, u_long, void *, int, struct lwp *);
101 
102 	/* rasops */
103 	void (*copycols)(void *, int, int, int, int);
104 	void (*erasecols)(void *, int, int, int, long);
105 	void (*copyrows)(void *, int, int, int);
106 	void (*eraserows)(void *, int, int, long);
107 	void (*putchar)(void *, int, int, u_int, long);
108 	void (*cursor)(void *, int, int, int);
109 	/* called before vcons_redraw_screen */
110 	void (*show_screen_cb)(struct vcons_screen *);
111 	/* virtual screen management stuff */
112 	void (*switch_cb)(void *, int, int);
113 	void *switch_cb_arg;
114 #ifdef VCONS_SWITCH_ASYNC
115 	lwp_t *redraw_thread;
116 	int start_drawing, done_drawing;	/* for the drawing thread */
117 #endif
118 	struct callout switch_callout;
119 	uint32_t switch_pending;
120 	LIST_HEAD(, vcons_screen) screens;
121 	struct vcons_screen *active, *wanted;
122 	const struct wsscreen_descr *currenttype;
123 	int switch_poll_count;
124 };
125 
126 int	vcons_init(struct vcons_data *, void *cookie, struct wsscreen_descr *,
127     struct wsdisplay_accessops *);
128 
129 int	vcons_init_screen(struct vcons_data *, struct vcons_screen *, int,
130     long *);
131 
132 void	vcons_redraw_screen(struct vcons_screen *);
133 
134 
135 
136 #endif /* _WSDISPLAY_VCONS_H_ */
137