xref: /freebsd/sys/dev/fb/fbreg.h (revision 729362425c09cf6b362366aabc6fb547eee8035a)
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$
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 #ifdef __i386__
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)		generic_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 void generic_bzero(void *d, size_t c);
46 #else /* !__i386__ */
47 #define bcopy_io(s, d, c)	memcpy_io((d), (s), (c))
48 #define bcopy_toio(s, d, c)	memcpy_toio((d), (void *)(s), (c))
49 #define bcopy_fromio(s, d, c)	memcpy_fromio((void *)(d), (s), (c))
50 #define bzero_io(d, c)		memset_io((d), 0, (c))
51 #define fill_io(p, d, c)	memset_io((d), (p), (c))
52 #define fillw(p, d, c)		memsetw((d), (p), (c))
53 #define fillw_io(p, d, c)	memsetw_io((d), (p), (c))
54 #endif /* !__i386__ */
55 
56 /* video function table */
57 typedef int vi_probe_t(int unit, video_adapter_t **adpp, void *arg, int flags);
58 typedef int vi_init_t(int unit, video_adapter_t *adp, int flags);
59 typedef int vi_get_info_t(video_adapter_t *adp, int mode, video_info_t *info);
60 typedef int vi_query_mode_t(video_adapter_t *adp, video_info_t *info);
61 typedef int vi_set_mode_t(video_adapter_t *adp, int mode);
62 typedef int vi_save_font_t(video_adapter_t *adp, int page, int size,
63 			   u_char *data, int c, int count);
64 typedef int vi_load_font_t(video_adapter_t *adp, int page, int size,
65 			   u_char *data, int c, int count);
66 typedef int vi_show_font_t(video_adapter_t *adp, int page);
67 typedef int vi_save_palette_t(video_adapter_t *adp, u_char *palette);
68 typedef int vi_load_palette_t(video_adapter_t *adp, u_char *palette);
69 typedef int vi_set_border_t(video_adapter_t *adp, int border);
70 typedef int vi_save_state_t(video_adapter_t *adp, void *p, size_t size);
71 typedef int vi_load_state_t(video_adapter_t *adp, void *p);
72 typedef int vi_set_win_org_t(video_adapter_t *adp, off_t offset);
73 typedef int vi_read_hw_cursor_t(video_adapter_t *adp, int *col, int *row);
74 typedef int vi_set_hw_cursor_t(video_adapter_t *adp, int col, int row);
75 typedef int vi_set_hw_cursor_shape_t(video_adapter_t *adp, int base,
76 				     int height, int celsize, int blink);
77 typedef int vi_blank_display_t(video_adapter_t *adp, int mode);
78 /* defined in sys/fbio.h
79 #define V_DISPLAY_ON		0
80 #define V_DISPLAY_BLANK		1
81 #define V_DISPLAY_STAND_BY	2
82 #define V_DISPLAY_SUSPEND	3
83 */
84 typedef int vi_mmap_t(video_adapter_t *adp, vm_offset_t offset,
85 		      vm_paddr_t *paddr, int prot);
86 typedef int vi_ioctl_t(video_adapter_t *adp, u_long cmd, caddr_t data);
87 typedef int vi_clear_t(video_adapter_t *adp);
88 typedef int vi_fill_rect_t(video_adapter_t *adp, int val, int x, int y,
89 			   int cx, int cy);
90 typedef int vi_bitblt_t(video_adapter_t *adp, ...);
91 typedef int vi_diag_t(video_adapter_t *adp, int level);
92 typedef int vi_save_cursor_palette_t(video_adapter_t *adp, u_char *palette);
93 typedef int vi_load_cursor_palette_t(video_adapter_t *adp, u_char *palette);
94 typedef int vi_copy_t(video_adapter_t *adp, vm_offset_t src, vm_offset_t dst,
95 		      int n);
96 typedef int vi_putp_t(video_adapter_t *adp, vm_offset_t off, u_int32_t p,
97 		       u_int32_t a, int size, int bpp, int bit_ltor,
98 		       int byte_ltor);
99 typedef int vi_putc_t(video_adapter_t *adp, vm_offset_t off, u_int8_t c,
100 		      u_int8_t a);
101 typedef int vi_puts_t(video_adapter_t *adp, vm_offset_t off, u_int16_t *s,
102 		       int len);
103 typedef int vi_putm_t(video_adapter_t *adp, int x, int y,
104 		      u_int8_t *pixel_image, u_int32_t pixel_mask, int size);
105 
106 typedef struct video_switch {
107     vi_probe_t		*probe;
108     vi_init_t		*init;
109     vi_get_info_t	*get_info;
110     vi_query_mode_t	*query_mode;
111     vi_set_mode_t	*set_mode;
112     vi_save_font_t	*save_font;
113     vi_load_font_t	*load_font;
114     vi_show_font_t	*show_font;
115     vi_save_palette_t	*save_palette;
116     vi_load_palette_t	*load_palette;
117     vi_set_border_t	*set_border;
118     vi_save_state_t	*save_state;
119     vi_load_state_t	*load_state;
120     vi_set_win_org_t	*set_win_org;
121     vi_read_hw_cursor_t	*read_hw_cursor;
122     vi_set_hw_cursor_t	*set_hw_cursor;
123     vi_set_hw_cursor_shape_t *set_hw_cursor_shape;
124     vi_blank_display_t	*blank_display;
125     vi_mmap_t		*mmap;
126     vi_ioctl_t		*ioctl;
127     vi_clear_t		*clear;
128     vi_fill_rect_t	*fill_rect;
129     vi_bitblt_t		*bitblt;
130     int			(*reserved1)(void);
131     int			(*reserved2)(void);
132     vi_diag_t		*diag;
133     vi_save_cursor_palette_t	*save_cursor_palette;
134     vi_load_cursor_palette_t	*load_cursor_palette;
135     vi_copy_t		*copy;
136     vi_putp_t		*putp;
137     vi_putc_t		*putc;
138     vi_puts_t		*puts;
139     vi_putm_t		*putm;
140 } video_switch_t;
141 
142 #define save_palette(adp, pal)				\
143 	(*vidsw[(adp)->va_index]->save_palette)((adp), (pal))
144 #define load_palette(adp, pal)				\
145 	(*vidsw[(adp)->va_index]->load_palette)((adp), (pal))
146 #define get_mode_info(adp, mode, buf)			\
147 	(*vidsw[(adp)->va_index]->get_info)((adp), (mode), (buf))
148 #define set_video_mode(adp, mode)			\
149 	(*vidsw[(adp)->va_index]->set_mode)((adp), (mode))
150 #define set_border(adp, border)				\
151 	(*vidsw[(adp)->va_index]->set_border)((adp), (border))
152 #define set_origin(adp, o)				\
153 	(*vidsw[(adp)->va_index]->set_win_org)(adp, o)
154 
155 /* XXX - add more macros */
156 
157 /* video driver */
158 typedef struct video_driver {
159     char		*name;
160     video_switch_t	*vidsw;
161     int			(*configure)(int); /* backdoor for the console driver */
162 } video_driver_t;
163 
164 #define VIDEO_DRIVER(name, sw, config)			\
165 	static struct video_driver name##_driver = {	\
166 		#name, &sw, config			\
167 	};						\
168 	DATA_SET(videodriver_set, name##_driver);
169 
170 /* global variables */
171 extern struct video_switch **vidsw;
172 
173 /* functions for the video card driver */
174 int		vid_register(video_adapter_t *adp);
175 int		vid_unregister(video_adapter_t *adp);
176 video_switch_t	*vid_get_switch(char *name);
177 void		vid_init_struct(video_adapter_t *adp, char *name, int type,
178 				int unit);
179 
180 /* functions for the video card client */
181 int		vid_allocate(char *driver, int unit, void *id);
182 int		vid_release(video_adapter_t *adp, void *id);
183 int		vid_find_adapter(char *driver, int unit);
184 video_adapter_t	*vid_get_adapter(int index);
185 
186 /* a backdoor for the console driver to tickle the video driver XXX */
187 int		vid_configure(int flags);
188 #define VIO_PROBE_ONLY	(1 << 0)	/* probe only, don't initialize */
189 
190 #ifdef FB_INSTALL_CDEV
191 
192 /* virtual frame buffer driver functions */
193 int		fb_attach(dev_t dev, video_adapter_t *adp,
194 			  struct cdevsw *cdevsw);
195 int		fb_detach(dev_t dev, video_adapter_t *adp,
196 			  struct cdevsw *cdevsw);
197 
198 /* generic frame buffer cdev driver functions */
199 
200 typedef struct genfb_softc {
201 	int		gfb_flags;	/* flag/status bits */
202 #define FB_OPEN		(1 << 0)
203 } genfb_softc_t;
204 
205 int		genfbopen(genfb_softc_t *sc, video_adapter_t *adp,
206 			  int flag, int mode, struct thread *td);
207 int		genfbclose(genfb_softc_t *sc, video_adapter_t *adp,
208 			   int flag, int mode, struct thread *td);
209 int		genfbread(genfb_softc_t *sc, video_adapter_t *adp,
210 			  struct uio *uio, int flag);
211 int		genfbwrite(genfb_softc_t *sc, video_adapter_t *adp,
212 			   struct uio *uio, int flag);
213 int		genfbioctl(genfb_softc_t *sc, video_adapter_t *adp,
214 			   u_long cmd, caddr_t arg, int flag, struct thread *td);
215 int		genfbmmap(genfb_softc_t *sc, video_adapter_t *adp,
216 			  vm_offset_t offset, vm_offset_t *paddr, int prot);
217 
218 #endif /* FB_INSTALL_CDEV */
219 
220 /* generic low-level driver functions */
221 
222 void		fb_dump_adp_info(char *driver, video_adapter_t *adp, int level);
223 void		fb_dump_mode_info(char *driver, video_adapter_t *adp,
224 				  video_info_t *info, int level);
225 int		fb_type(int adp_type);
226 int		fb_commonioctl(video_adapter_t *adp, u_long cmd, caddr_t arg);
227 
228 #endif /* _KERNEL */
229 
230 #endif /* !_DEV_FB_FBREG_H_ */
231