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