xref: /netbsd/sys/arch/amiga/dev/grfioctl.h (revision 6550d01e)
1 /*	$NetBSD: grfioctl.h,v 1.19 2007/03/04 05:59:20 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 1990 The Regents of the University of California.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * the Systems Programming Group of the University of Utah Computer
9  * Science Department.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
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. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  * from: Utah $Hdr: grfioctl.h 1.1 90/07/09$
36  *
37  *	@(#)grfioctl.h	7.2 (Berkeley) 11/4/90
38  */
39 /*
40  * Copyright (c) 1988 University of Utah.
41  *
42  * This code is derived from software contributed to Berkeley by
43  * the Systems Programming Group of the University of Utah Computer
44  * Science Department.
45  *
46  * Redistribution and use in source and binary forms, with or without
47  * modification, are permitted provided that the following conditions
48  * are met:
49  * 1. Redistributions of source code must retain the above copyright
50  *    notice, this list of conditions and the following disclaimer.
51  * 2. Redistributions in binary form must reproduce the above copyright
52  *    notice, this list of conditions and the following disclaimer in the
53  *    documentation and/or other materials provided with the distribution.
54  * 3. All advertising materials mentioning features or use of this software
55  *    must display the following acknowledgement:
56  *	This product includes software developed by the University of
57  *	California, Berkeley and its contributors.
58  * 4. Neither the name of the University nor the names of its contributors
59  *    may be used to endorse or promote products derived from this software
60  *    without specific prior written permission.
61  *
62  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
63  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
64  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
65  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
66  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
67  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
68  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
69  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
70  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
71  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
72  * SUCH DAMAGE.
73  *
74  * from: Utah $Hdr: grfioctl.h 1.1 90/07/09$
75  *
76  *	@(#)grfioctl.h	7.2 (Berkeley) 11/4/90
77  */
78 
79 
80 /* these are changeable values, encapsulated in their own structure, so
81    no the whole thing has to be copied when setting parameters. */
82 struct grfdyninfo {
83 	int	gdi_fbx;		/* frame buffer x offset */
84 	int	gdi_fby;		/* frame buffer y offset */
85 	int	gdi_dwidth;		/* displayed part width */
86 	int	gdi_dheight;		/* displayed part height */
87 	int	gdi_dx;			/* displayed part x offset */
88 	int	gdi_dy;			/* displayed part y offset */
89 };
90 
91 struct	grfinfo {
92 	void *	gd_regaddr;		/* control registers physaddr */
93 	int	gd_regsize;		/* control registers size */
94 	void *	gd_fbaddr;		/* frame buffer physaddr */
95 	int	gd_fbsize;		/* frame buffer size */
96 	short	gd_colors;		/* number of colors */
97 	short	gd_planes;		/* number of planes */
98 
99 	int	gd_fbwidth;		/* frame buffer width */
100 	int	gd_fbheight;		/* frame buffer height */
101 
102 	struct grfdyninfo gd_dyn;	/* everything changable by GRFIOCSINFO */
103 /* compatibility... */
104 #define gd_fbx		gd_dyn.gdi_fbx
105 #define gd_fby		gd_dyn.gdi_fby
106 #define gd_dwidth 	gd_dyn.gdi_dwidth
107 #define gd_dheight	gd_dyn.gdi_dheight
108 #define gd_dx		gd_dyn.gdi_dx
109 #define gd_dy		gd_dyn.gdi_dy
110 
111 	/* new for banked pager support */
112 	int	gd_bank_size;		/* size of a bank (or 0) */
113 };
114 
115 
116 /* video mode, should be display-independent, but it might need
117    modifications in the future to really become hardware-independent. */
118 
119 struct grfvideo_mode {
120 	u_char	mode_num;		/* index in mode table */
121 	char	mode_descr[80];		/* description of mode */
122 	u_long	pixel_clock;		/* in Hz. */
123 	u_short	disp_width;		/* width of displayed video (incl overscan) */
124 	u_short	disp_height;		/* height "" */
125 	u_short	depth;			/* number of bitplanes resp. bits per pixel */
126 	u_short	hblank_start;
127 	u_short	hsync_start;		/* video-parameters, take care not to   */
128 	u_short	hsync_stop;		/* use parameters that violete specs of */
129 	u_short	htotal;			/* your monitor !                       */
130 	u_short	vblank_start;
131 	u_short	vsync_start;
132 	u_short	vsync_stop;
133 	u_short	vtotal;
134 	u_short	disp_flags;		/* GRF_FLAGS_xxxx */
135 };
136 
137 /* values for grfvideo_mode->disp_flags */
138 #define	GRF_FLAGS_DEFAULT	0x00	/* default */
139 #define	GRF_FLAGS_DBLSCAN	0x01	/* doublescan */
140 #define	GRF_FLAGS_LACE		0x02	/* interlace */
141 #define	GRF_FLAGS_PHSYNC	0x04	/* +hsync */
142 #define	GRF_FLAGS_NHSYNC	0x08	/* -hsync */
143 #define	GRF_FLAGS_PVSYNC	0x10	/* +vsync */
144 #define	GRF_FLAGS_NVSYNC	0x20	/* -vsync */
145 #define	GRF_FLAGS_SYNC_ON_GREEN	0x40	/* sync-on-green */
146 
147 /*
148  * BSD ioctls
149  */
150 #define OGRFIOCGINFO	0x40344700		/* to keep compat for a while... */
151 #define	GRFIOCGINFO	_IOR('G', 0, struct grfinfo) /* get info on device */
152 #define	GRFIOCON	_IO('G', 1)		/* turn graphics on */
153 #define	GRFIOCOFF	_IO('G', 2)		/* turn graphics off */
154 #define GRFIOCMAP	_IOWR('G', 5, int)	/* map in regs+framebuffer */
155 #define GRFIOCUNMAP	_IOW('G', 6, int)	/* unmap regs+framebuffer */
156 
157 /* amiga addons */
158 	/* set info on device */
159 #define	GRFIOCSINFO	_IOW('G', 40, struct grfdyninfo)
160 	/* get video_mode. mode_num==0 gets current mode. */
161 #define GRFGETVMODE	_IOWR('G', 41, struct grfvideo_mode)
162 	/* set video_mode. */
163 #define GRFSETVMODE	_IOW('G', 42, int)
164 	/* get number of configured video modes */
165 #define GRFGETNUMVM	_IOR('G', 43, int)
166 	/* toggle between Cirrus and ECS, ill */
167 #define GRFTOGGLE	_IO('G', 44)
168 	/* load in a display mode */
169 #define GRFIOCSETMON	_IOW('G', 45, struct grfvideo_mode)
170 
171 /*
172  * generic framebuffer-related ioctls. These are somewhat
173  * similar to SunOS fb-ioctls since I liked them reading
174  * thru the X11-server code.
175  */
176 
177 /*
178  * colormap related information. Every grf has an associated
179  * colormap. Depending on the capabilities of the hardware, more
180  * or less of the information provided may be used.
181  * Maxium value of "index" can be deduced from grfinfo->gd_colors.
182  */
183 struct grf_colormap {
184 	unsigned int	index;		/* start at red[index],green[index],blue[index] */
185 	unsigned int	count;		/* till < red[index+count],... */
186 	u_char	*red;
187 	u_char	*green;
188 	u_char	*blue;
189 };
190 
191 /* write the selected slots into the active colormap */
192 #define GRFIOCPUTCMAP	_IOW('G', 50, struct grf_colormap)
193 
194 /* retrieve the selected slots from the active colormap */
195 #define GRFIOCGETCMAP	_IOWR('G', 51, struct grf_colormap)
196 
197 
198 /*
199  * support a possibly available hardware sprite. calls just fail
200  * if a given grf doesn't implement hardware sprites.
201  */
202 struct grf_position {
203 	u_short	x, y;		/* 0,0 is upper left corner */
204 };
205 #define GRFIOCSSPRITEPOS _IOW('G', 52, struct grf_position)
206 #define GRFIOCGSPRITEPOS _IOR('G', 53, struct grf_position)
207 
208 struct grf_spriteinfo {
209 	u_short	set;
210 #define GRFSPRSET_ENABLE  (1<<0)
211 #define GRFSPRSET_POS	  (1<<1)
212 #define GRFSPRSET_HOT	  (1<<2)
213 #define GRFSPRSET_CMAP	  (1<<3)
214 #define GRFSPRSET_SHAPE	  (1<<4)
215 #define GRFSPRSET_ALL	  0x1f
216 	u_short	enable;			/* sprite is displayed if == 1 */
217 	struct	grf_position pos;	/* sprite location */
218 	struct	grf_position hot;	/* sprite hot spot */
219 	struct	grf_colormap cmap;	/* colormap for the sprite. */
220 	struct	grf_position size;	/* x == width, y == height */
221 	u_char	*image, *mask;		/* sprite bitmap and mask */
222 };
223 
224 #define GRFIOCSSPRITEINF _IOW('G', 54, struct grf_spriteinfo)
225 #define GRFIOCGSPRITEINF _IOR('G', 55, struct grf_spriteinfo)
226 
227 /* get maximum sprite size hardware can display */
228 #define GRFIOCGSPRITEMAX _IOR('G', 56, struct grf_position)
229 
230 
231 /* support for a BitBlt operation. The op-codes are identical
232    to X11 GCs */
233 #define	GRFBBOPclear		0x0	/* 0 */
234 #define GRFBBOPand		0x1	/* src AND dst */
235 #define GRFBBOPandReverse	0x2	/* src AND NOT dst */
236 #define GRFBBOPcopy		0x3	/* src */
237 #define GRFBBOPandInverted	0x4	/* NOT src AND dst */
238 #define	GRFBBOPnoop		0x5	/* dst */
239 #define GRFBBOPxor		0x6	/* src XOR dst */
240 #define GRFBBOPor		0x7	/* src OR dst */
241 #define GRFBBOPnor		0x8	/* NOT src AND NOT dst */
242 #define GRFBBOPequiv		0x9	/* NOT src XOR dst */
243 #define GRFBBOPinvert		0xa	/* NOT dst */
244 #define GRFBBOPorReverse	0xb	/* src OR NOT dst */
245 #define GRFBBOPcopyInverted	0xc	/* NOT src */
246 #define GRFBBOPorInverted	0xd	/* NOT src OR dst */
247 #define GRFBBOPnand		0xe	/* NOT src OR NOT dst */
248 #define GRFBBOPset		0xf	/* 1 */
249 
250 struct grf_bitblt {
251 	u_short	op;		/* see above */
252 	u_short	src_x, src_y;	/* upper left corner of source-region */
253 	u_short	dst_x, dst_y;	/* upper left corner of dest-region */
254 	u_short	w, h;		/* width, height of region */
255 	u_short	mask;		/* bitmask to apply */
256 };
257 
258 #define GRFIOCBITBLT	_IOW('G', 57, struct grf_bitblt)
259 
260 /* can't use IOCON/OFF because that would turn ite on */
261 #define GRFIOCBLANK	_IOW('G', 58, int)
262 
263 #define GRFIOCBLANK_LIVE	1
264 #define GRFIOCBLANK_DARK	0
265