xref: /dragonfly/sys/dev/video/fb/fbreg.h (revision e98bdfd3)
1 /*-
2  * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer as
10  *    the first lines of this file unmodified.
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  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/dev/fb/fbreg.h,v 1.6 1999/12/29 04:35:36 peter Exp $
27  */
28 
29 #ifndef _DEV_FB_FBREG_H_
30 #define _DEV_FB_FBREG_H_
31 
32 #ifdef _KERNEL
33 
34 #define V_MAX_ADAPTERS		8		/* XXX */
35 
36 /* some macros */
37 #if defined(__x86_64__)
38 #define bcopy_io(s, d, c)	generic_bcopy((void *)(s), (void *)(d), (c))
39 #define bcopy_toio(s, d, c)	generic_bcopy((void *)(s), (void *)(d), (c))
40 #define bcopy_fromio(s, d, c)	generic_bcopy((void *)(s), (void *)(d), (c))
41 #define bzero_io(d, c)		bzero((void *)(d), (c))
42 #define fill_io(p, d, c)	fill((p), (void *)(d), (c))
43 #define fillw_io(p, d, c)	fillw((p), (void *)(d), (c))
44 void generic_bcopy(const void *s, void *d, size_t c);
45 #else /* !__x86_64__ */
46 #define bcopy_io(s, d, c)	memcpy_io((d), (s), (c))
47 #define bcopy_toio(s, d, c)	memcpy_toio((d), (void *)(s), (c))
48 #define bcopy_fromio(s, d, c)	memcpy_fromio((void *)(d), (s), (c))
49 #define bzero_io(d, c)		memset_io((d), 0, (c))
50 #define fill_io(p, d, c)	memset_io((d), (p), (c))
51 #define fillw(p, d, c)		memsetw((d), (p), (c))
52 #define fillw_io(p, d, c)	memsetw_io((d), (p), (c))
53 #endif /* !__x86_64__ */
54 
55 /* video function table */
56 typedef int vi_probe_t(int unit, video_adapter_t **adpp, void *arg, int flags);
57 typedef int vi_init_t(int unit, video_adapter_t *adp, int flags);
58 typedef int vi_get_info_t(video_adapter_t *adp, int mode, video_info_t *info);
59 typedef int vi_query_mode_t(video_adapter_t *adp, video_info_t *info);
60 typedef int vi_set_mode_t(video_adapter_t *adp, int mode);
61 typedef int vi_save_font_t(video_adapter_t *adp, int page, int size,
62 			   u_char *data, int c, int count);
63 typedef int vi_load_font_t(video_adapter_t *adp, int page, int size,
64 			   u_char *data, int c, int count);
65 typedef int vi_show_font_t(video_adapter_t *adp, int page);
66 typedef int vi_save_palette_t(video_adapter_t *adp, u_char *palette);
67 typedef int vi_load_palette_t(video_adapter_t *adp, const u_char *palette);
68 typedef int vi_set_border_t(video_adapter_t *adp, int border);
69 typedef int vi_save_state_t(video_adapter_t *adp, void *p, size_t size);
70 typedef int vi_load_state_t(video_adapter_t *adp, void *p);
71 typedef int vi_set_win_org_t(video_adapter_t *adp, off_t offset);
72 typedef int vi_read_hw_cursor_t(video_adapter_t *adp, int *col, int *row);
73 typedef int vi_set_hw_cursor_t(video_adapter_t *adp, int col, int row);
74 typedef int vi_set_hw_cursor_shape_t(video_adapter_t *adp, int base,
75 				     int height, int celsize, int blink);
76 typedef int vi_blank_display_t(video_adapter_t *adp, int mode);
77 #define V_DISPLAY_ON		0
78 #define V_DISPLAY_STAND_BY	(1<<0)
79 #define V_DISPLAY_SUSPEND	(1<<1)
80 #define V_DISPLAY_OFF		(1<<2)
81 typedef int vi_mmap_t(video_adapter_t *adp, vm_offset_t offset, int prot);
82 typedef int vi_ioctl_t(video_adapter_t *adp, u_long cmd, caddr_t data);
83 typedef int vi_clear_t(video_adapter_t *adp);
84 typedef int vi_fill_rect_t(video_adapter_t *adp, int val, int x, int y,
85 			   int cx, int cy);
86 typedef int vi_bitblt_t(video_adapter_t *adp,...);
87 typedef int vi_diag_t(video_adapter_t *adp, int level);
88 
89 typedef struct video_switch {
90     vi_probe_t		*probe;
91     vi_init_t		*init;
92     vi_get_info_t	*get_info;
93     vi_query_mode_t	*query_mode;
94     vi_set_mode_t	*set_mode;
95     vi_save_font_t	*save_font;
96     vi_load_font_t	*load_font;
97     vi_show_font_t	*show_font;
98     vi_save_palette_t	*save_palette;
99     vi_load_palette_t	*load_palette;
100     vi_set_border_t	*set_border;
101     vi_save_state_t	*save_state;
102     vi_load_state_t	*load_state;
103     vi_set_win_org_t	*set_win_org;
104     vi_read_hw_cursor_t	*read_hw_cursor;
105     vi_set_hw_cursor_t	*set_hw_cursor;
106     vi_set_hw_cursor_shape_t *set_hw_cursor_shape;
107     vi_blank_display_t	*blank_display;
108     vi_mmap_t		*mmap;
109     vi_ioctl_t		*ioctl;
110     vi_clear_t		*clear;
111     vi_fill_rect_t	*fill_rect;
112     vi_bitblt_t		*bitblt;
113     int			(*reserved1)(void);
114     int			(*reserved2)(void);
115     vi_diag_t		*diag;
116 } video_switch_t;
117 
118 #define save_palette(adp, pal)				\
119 	do {						\
120 		lwkt_gettoken(&tty_token);		\
121 		(*vidsw[(adp)->va_index]->save_palette)((adp), (pal)); \
122 		lwkt_reltoken(&tty_token);		\
123 	} while (0)
124 
125 #define load_palette(adp, pal)				\
126 	do {						\
127 		lwkt_gettoken(&tty_token);		\
128 		(*vidsw[(adp)->va_index]->load_palette)((adp), (pal)); \
129 		lwkt_reltoken(&tty_token);		\
130 	} while (0)
131 
132 #define get_mode_info(adp, mode, buf)			\
133 	(*vidsw[(adp)->va_index]->get_info)((adp), (mode), (buf))
134 
135 #define set_video_mode(adp, mode)			\
136 	(*vidsw[(adp)->va_index]->set_mode)((adp), (mode))
137 
138 #if 0 /* XXX conflicts with syscons' set_border() */
139 #define set_border(adp, border)				\
140 	do {						\
141 		lwkt_gettoken(&tty_token);		\
142 		(*vidsw[(adp)->va_index]->set_border)((adp), (border)); \
143 		lwkt_reltoken(&tty_token);		\
144 	} while (0)
145 #endif
146 
147 #define set_origin(adp, o)				\
148 	do {						\
149 		lwkt_gettoken(&tty_token);		\
150 		(*vidsw[(adp)->va_index]->set_win_org)(adp, o); \
151 		lwkt_reltoken(&tty_token);		\
152 	} while (0)
153 
154 /* XXX - add more macros */
155 
156 /* video driver */
157 typedef struct video_driver {
158     char		*name;
159     video_switch_t	*vidsw;
160     int			(*configure)(int); /* backdoor for the console driver */
161 } video_driver_t;
162 
163 #define VIDEO_DRIVER(name, sw, config)			\
164 	static struct video_driver name##_driver = {	\
165 		#name, &sw, config			\
166 	};						\
167 	DATA_SET(videodriver_set, name##_driver);
168 
169 /* global variables */
170 extern struct video_switch **vidsw;
171 
172 /* functions for the video card driver */
173 int		vid_register(video_adapter_t *adp);
174 int		vid_unregister(video_adapter_t *adp);
175 video_switch_t	*vid_get_switch(char *name);
176 void		vid_init_struct(video_adapter_t *adp, char *name, int type,
177 				int unit);
178 
179 /* functions for the video card client */
180 int		vid_allocate(char *driver, int unit, void *id);
181 int		vid_release(video_adapter_t *adp, void *id);
182 int		vid_find_adapter(char *driver, int unit);
183 video_adapter_t	*vid_get_adapter(int index);
184 
185 /* a backdoor for the console driver to tickle the video driver XXX */
186 int		vid_configure(int flags);
187 #define VIO_PROBE_ONLY	(1 << 0)	/* probe only, don't initialize */
188 
189 #ifdef FB_INSTALL_CDEV
190 
191 /* virtual frame buffer driver functions */
192 int		fb_attach(cdev_t dev, video_adapter_t *adp);
193 int		fb_detach(cdev_t dev, video_adapter_t *adp);
194 
195 /* generic frame buffer cdev driver functions */
196 
197 typedef struct genfb_softc {
198 	int		gfb_flags;	/* flag/status bits */
199 #define FB_OPEN		(1 << 0)
200 } genfb_softc_t;
201 
202 int		genfbopen(genfb_softc_t *sc, video_adapter_t *adp,
203 			  int flag, int mode, struct ucred *cred);
204 int		genfbclose(genfb_softc_t *sc, video_adapter_t *adp,
205 			   int flag, int mode);
206 int		genfbread(genfb_softc_t *sc, video_adapter_t *adp,
207 			  struct uio *uio, int flag);
208 int		genfbwrite(genfb_softc_t *sc, video_adapter_t *adp,
209 			   struct uio *uio, int flag);
210 int		genfbioctl(genfb_softc_t *sc, video_adapter_t *adp,
211 			   u_long cmd, caddr_t arg, int flag,
212 			   struct ucred *cred);
213 int		genfbmmap(genfb_softc_t *sc, video_adapter_t *adp,
214 			  vm_offset_t offset, int prot);
215 
216 #endif /* FB_INSTALL_CDEV */
217 
218 /* generic low-level driver functions */
219 
220 void		fb_dump_adp_info(char *driver, video_adapter_t *adp, int level);
221 void		fb_dump_mode_info(char *driver, video_adapter_t *adp,
222 				  video_info_t *info, int level);
223 int		fb_type(int adp_type);
224 int		fb_commonioctl(video_adapter_t *adp, u_long cmd, caddr_t arg);
225 
226 #endif /* _KERNEL */
227 
228 #endif /* !_DEV_FB_FBREG_H_ */
229