xref: /netbsd/sys/arch/atari/dev/grfioctl.h (revision 6550d01e)
1 /*	$NetBSD: grfioctl.h,v 1.8 2007/03/04 05:59:40 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 #ifndef _MACHINE_GRFIOCTL_H_
80 #define _MACHINE_GRFIOCTL_H_
81 
82 /* these are changeable values, encapsulated in their own structure, so
83    no the whole thing has to be copied when setting parameters. */
84 struct grfdyninfo {
85 	int	gdi_fbx;	/* frame buffer x offset	*/
86 	int	gdi_fby;	/* frame buffer y offset	*/
87 	int	gdi_dwidth;	/* displayed part width		*/
88 	int	gdi_dheight;	/* displayed part height	*/
89 	int	gdi_dx;		/* displayed part x offset	*/
90 	int	gdi_dy;		/* displayed part y offset	*/
91 };
92 
93 struct	grfinfo {
94 	void *	gd_fbaddr;	/* frame buffer linear physaddr	*/
95 	int	gd_fbsize;	/* frame buffer linear size	*/
96 	int	gd_linbase;	/* frame buffer linear base	*/
97 	void *	gd_regaddr;	/* register area physaddr	*/
98 	int	gd_regsize;	/* register area size		*/
99 	void *gd_vgaaddr;	/* vga area physaddr		*/
100 	int	gd_vgasize;	/* vga area size		*/
101 	int	gd_vgabase;	/* vga area base		*/
102 	short	gd_colors;	/* number of colors		*/
103 	short	gd_planes;	/* number of planes		*/
104 
105 	int	gd_fbwidth;	/* frame buffer width		*/
106 	int	gd_fbheight;	/* frame buffer height		*/
107 
108 	struct grfdyninfo gd_dyn; /* everything changable by GRFIOCSINFO */
109 /* compatibility... */
110 #define gd_fbx		gd_dyn.gdi_fbx
111 #define gd_fby		gd_dyn.gdi_fby
112 #define gd_dwidth 	gd_dyn.gdi_dwidth
113 #define gd_dheight	gd_dyn.gdi_dheight
114 #define gd_dx		gd_dyn.gdi_dx
115 #define gd_dy		gd_dyn.gdi_dy
116 
117 	/* new for banked pager support */
118 	int	gd_bank_size;		/* size of a bank (or 0) */
119 };
120 
121 
122 /* video mode, should be display-independent, but it might need
123    modifications in the future to really become hardware-independent. */
124 
125 struct grfvideo_mode {
126   u_char  mode_num;		/* index in mode table */
127   char	  mode_descr[80];	/* description of mode */
128   u_long  pixel_clock;		/* in Hz. */
129   u_short disp_width;		/* width of displayed video (incl overscan) */
130   u_short disp_height;		/* height "" */
131   u_short depth;		/* number of bitplanes resp. bits per pixel */
132   u_short hblank_start;
133   u_short hblank_stop;
134   u_short hsync_start;		/* video-parameters, take care not to   */
135   u_short hsync_stop;		/* use parameters that violete specs of */
136   u_short htotal;		/* your monitor !                       */
137   u_short vblank_start;
138   u_short vblank_stop;
139   u_short vsync_start;
140   u_short vsync_stop;
141   u_short vtotal;
142 };
143 
144 
145 /*
146  * BSD ioctls
147  */
148 #define OGRFIOCGINFO	0x40344700		/* to keep compat for a while... */
149 #define	GRFIOCGINFO	_IOR('G', 0, struct grfinfo) /* get info on device */
150 #define	GRFIOCON	_IO('G', 1)		/* turn graphics on */
151 #define	GRFIOCOFF	_IO('G', 2)		/* turn graphics off */
152 #define GRFIOCMAP	_IOWR('G', 5, int)	/* map in regs+framebuffer */
153 #define GRFIOCUNMAP	_IOW('G', 6, int)	/* unmap regs+framebuffer */
154 
155 /* amiga addons */
156 	/* set info on device */
157 #define	GRFIOCSINFO	_IOW('G', 40, struct grfdyninfo)
158 	/* get video_mode. mode_num==0 gets current mode. */
159 #define GRFGETVMODE	_IOWR('G', 41, struct grfvideo_mode)
160 	/* set video_mode. */
161 #define GRFSETVMODE	_IOW('G', 42, int)
162 	/* get number of configured video modes */
163 #define GRFGETNUMVM	_IOR('G', 43, int)
164 
165 
166 /*
167  * generic framebuffer-related ioctls. These are somewhat
168  * similar to SunOS fb-ioctls since I liked them reading
169  * thru the X11-server code.
170  */
171 
172 /*
173  * colormap related information. Every grf has an associated
174  * colormap. Depending on the capabilities of the hardware, more
175  * or less of the information provided may be used.
176  * Maxium value of "index" can be deduced from grfinfo->gd_colors.
177  */
178 struct grf_colormap {
179   int	 index;	    /* start at red[index],green[index],blue[index] */
180   int	 count;	    /* till < red[index+count],... */
181   u_char *red;
182   u_char *green;
183   u_char *blue;
184 };
185 
186 /* write the selected slots into the active colormap */
187 #define GRFIOCPUTCMAP	_IOW('G', 50, struct grf_colormap)
188 
189 /* retrieve the selected slots from the active colormap */
190 #define GRFIOCGETCMAP	_IOWR('G', 51, struct grf_colormap)
191 
192 
193 /*
194  * support a possibly available hardware sprite. calls just fail
195  * if a given grf doesn't implement hardware sprites.
196  */
197 struct grf_position {
198   u_short x, y;		/* 0,0 is upper left corner */
199 };
200 #define GRFIOCSSPRITEPOS _IOW('G', 52, struct grf_position)
201 #define GRFIOCGSPRITEPOS _IOR('G', 53, struct grf_position)
202 
203 struct grf_spriteinfo {
204   u_short  set;
205 #define GRFSPRSET_ENABLE  (1<<0)
206 #define GRFSPRSET_POS	  (1<<1)
207 #define GRFSPRSET_HOT	  (1<<2)
208 #define GRFSPRSET_CMAP	  (1<<3)
209 #define GRFSPRSET_SHAPE	  (1<<4)
210 #define GRFSPRSET_ALL	  0x1f
211   u_short  enable;	    /* sprite is displayed if == 1 */
212   struct grf_position pos;  /* sprite location */
213   struct grf_position hot;  /* sprite hot spot */
214   struct grf_colormap cmap; /* colormap for the sprite. */
215   struct grf_position size; /* x == width, y == height */
216   u_char *image, *mask;	    /* sprite bitmap and mask */
217 };
218 
219 #define GRFIOCSSPRITEINF _IOW('G', 54, struct grf_spriteinfo)
220 #define GRFIOCGSPRITEINF _IOR('G', 55, struct grf_spriteinfo)
221 
222 /* get maximum sprite size hardware can display */
223 #define GRFIOCGSPRITEMAX _IOR('G', 56, struct grf_position)
224 
225 
226 /* support for a BitBlt operation. The op-codes are identical
227    to X11 GCs */
228 #define	GRFBBOPclear		0x0	/* 0 */
229 #define GRFBBOPand		0x1	/* src AND dst */
230 #define GRFBBOPandReverse	0x2	/* src AND NOT dst */
231 #define GRFBBOPcopy		0x3	/* src */
232 #define GRFBBOPandInverted	0x4	/* NOT src AND dst */
233 #define	GRFBBOPnoop		0x5	/* dst */
234 #define GRFBBOPxor		0x6	/* src XOR dst */
235 #define GRFBBOPor		0x7	/* src OR dst */
236 #define GRFBBOPnor		0x8	/* NOT src AND NOT dst */
237 #define GRFBBOPequiv		0x9	/* NOT src XOR dst */
238 #define GRFBBOPinvert		0xa	/* NOT dst */
239 #define GRFBBOPorReverse	0xb	/* src OR NOT dst */
240 #define GRFBBOPcopyInverted	0xc	/* NOT src */
241 #define GRFBBOPorInverted	0xd	/* NOT src OR dst */
242 #define GRFBBOPnand		0xe	/* NOT src OR NOT dst */
243 #define GRFBBOPset		0xf	/* 1 */
244 
245 struct grf_bitblt {
246   u_short op;		/* see above */
247   u_short src_x, src_y;	/* upper left corner of source-region */
248   u_short dst_x, dst_y;	/* upper left corner of dest-region */
249   u_short w, h;		/* width, height of region */
250   u_short mask;		/* bitmask to apply */
251 };
252 
253 #define GRFIOCBITBLT	_IOR('G', 57, struct grf_bitblt)
254 
255 #endif /* _MACHINE_GRFIOCTL_H_ */
256