xref: /freebsd/sys/dev/fb/fbreg.h (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
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, int prot);
85 typedef int vi_ioctl_t(video_adapter_t *adp, u_long cmd, caddr_t data);
86 typedef int vi_clear_t(video_adapter_t *adp);
87 typedef int vi_fill_rect_t(video_adapter_t *adp, int val, int x, int y,
88 			   int cx, int cy);
89 typedef int vi_bitblt_t(video_adapter_t *adp,...);
90 typedef int vi_diag_t(video_adapter_t *adp, int level);
91 
92 typedef struct video_switch {
93     vi_probe_t		*probe;
94     vi_init_t		*init;
95     vi_get_info_t	*get_info;
96     vi_query_mode_t	*query_mode;
97     vi_set_mode_t	*set_mode;
98     vi_save_font_t	*save_font;
99     vi_load_font_t	*load_font;
100     vi_show_font_t	*show_font;
101     vi_save_palette_t	*save_palette;
102     vi_load_palette_t	*load_palette;
103     vi_set_border_t	*set_border;
104     vi_save_state_t	*save_state;
105     vi_load_state_t	*load_state;
106     vi_set_win_org_t	*set_win_org;
107     vi_read_hw_cursor_t	*read_hw_cursor;
108     vi_set_hw_cursor_t	*set_hw_cursor;
109     vi_set_hw_cursor_shape_t *set_hw_cursor_shape;
110     vi_blank_display_t	*blank_display;
111     vi_mmap_t		*mmap;
112     vi_ioctl_t		*ioctl;
113     vi_clear_t		*clear;
114     vi_fill_rect_t	*fill_rect;
115     vi_bitblt_t		*bitblt;
116     int			(*reserved1)(void);
117     int			(*reserved2)(void);
118     vi_diag_t		*diag;
119 } video_switch_t;
120 
121 #define save_palette(adp, pal)				\
122 	(*vidsw[(adp)->va_index]->save_palette)((adp), (pal))
123 #define load_palette(adp, pal)				\
124 	(*vidsw[(adp)->va_index]->load_palette)((adp), (pal))
125 #define get_mode_info(adp, mode, buf)			\
126 	(*vidsw[(adp)->va_index]->get_info)((adp), (mode), (buf))
127 #define set_video_mode(adp, mode)			\
128 	(*vidsw[(adp)->va_index]->set_mode)((adp), (mode))
129 #if 0 /* XXX conflicts with syscons' set_border() */
130 #define set_border(adp, border)				\
131 	(*vidsw[(adp)->va_index]->set_border)((adp), (border))
132 #endif
133 #define set_origin(adp, o)				\
134 	(*vidsw[(adp)->va_index]->set_win_org)(adp, o)
135 
136 /* XXX - add more macros */
137 
138 /* video driver */
139 typedef struct video_driver {
140     char		*name;
141     video_switch_t	*vidsw;
142     int			(*configure)(int); /* backdoor for the console driver */
143 } video_driver_t;
144 
145 #define VIDEO_DRIVER(name, sw, config)			\
146 	static struct video_driver name##_driver = {	\
147 		#name, &sw, config			\
148 	};						\
149 	DATA_SET(videodriver_set, name##_driver);
150 
151 /* global variables */
152 extern struct video_switch **vidsw;
153 
154 /* functions for the video card driver */
155 int		vid_register(video_adapter_t *adp);
156 int		vid_unregister(video_adapter_t *adp);
157 video_switch_t	*vid_get_switch(char *name);
158 void		vid_init_struct(video_adapter_t *adp, char *name, int type,
159 				int unit);
160 
161 /* functions for the video card client */
162 int		vid_allocate(char *driver, int unit, void *id);
163 int		vid_release(video_adapter_t *adp, void *id);
164 int		vid_find_adapter(char *driver, int unit);
165 video_adapter_t	*vid_get_adapter(int index);
166 
167 /* a backdoor for the console driver to tickle the video driver XXX */
168 int		vid_configure(int flags);
169 #define VIO_PROBE_ONLY	(1 << 0)	/* probe only, don't initialize */
170 
171 #ifdef FB_INSTALL_CDEV
172 
173 /* virtual frame buffer driver functions */
174 int		fb_attach(dev_t dev, video_adapter_t *adp,
175 			  struct cdevsw *cdevsw);
176 int		fb_detach(dev_t dev, video_adapter_t *adp,
177 			  struct cdevsw *cdevsw);
178 
179 /* generic frame buffer cdev driver functions */
180 
181 typedef struct genfb_softc {
182 	int		gfb_flags;	/* flag/status bits */
183 #define FB_OPEN		(1 << 0)
184 } genfb_softc_t;
185 
186 int		genfbopen(genfb_softc_t *sc, video_adapter_t *adp,
187 			  int flag, int mode, struct thread *td);
188 int		genfbclose(genfb_softc_t *sc, video_adapter_t *adp,
189 			   int flag, int mode, struct thread *td);
190 int		genfbread(genfb_softc_t *sc, video_adapter_t *adp,
191 			  struct uio *uio, int flag);
192 int		genfbwrite(genfb_softc_t *sc, video_adapter_t *adp,
193 			   struct uio *uio, int flag);
194 int		genfbioctl(genfb_softc_t *sc, video_adapter_t *adp,
195 			   u_long cmd, caddr_t arg, int flag, struct thread *td);
196 int		genfbmmap(genfb_softc_t *sc, video_adapter_t *adp,
197 			  vm_offset_t offset, int prot);
198 
199 #endif /* FB_INSTALL_CDEV */
200 
201 /* generic low-level driver functions */
202 
203 void		fb_dump_adp_info(char *driver, video_adapter_t *adp, int level);
204 void		fb_dump_mode_info(char *driver, video_adapter_t *adp,
205 				  video_info_t *info, int level);
206 int		fb_type(int adp_type);
207 int		fb_commonioctl(video_adapter_t *adp, u_long cmd, caddr_t arg);
208 
209 #endif /* _KERNEL */
210 
211 #endif /* !_DEV_FB_FBREG_H_ */
212