xref: /netbsd-src/sys/dev/sun/cgsixreg.h (revision 9373d84081d01a8e3e6e16e393ac7d6c8f9dd784)
1 /*	$NetBSD: cgsixreg.h,v 1.10 2013/05/28 15:25:37 macallan Exp $ */
2 
3 /*
4  * Copyright (c) 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This software was developed by the Computer Systems Engineering group
8  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
9  * contributed to Berkeley.
10  *
11  * All advertising materials mentioning features or use of this software
12  * must display the following acknowledgement:
13  *	This product includes software developed by the University of
14  *	California, Lawrence Berkeley Laboratory.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  *
40  *	@(#)cgsixreg.h	8.4 (Berkeley) 1/21/94
41  */
42 
43 /*
44  * CG6 display registers.  (Note, I got tired of writing `cgsix' about
45  * halfway through and changed everything to cg6, but I probably missed
46  * some.  Unfortunately, the way config works, we need to spell out `six'
47  * in some places anyway.)
48  *
49  * The cg6 is a complicated beastie.  We have been unable to extract any
50  * documentation and most of the following are guesses based on a limited
51  * amount of reverse engineering.
52  *
53  * A cg6 is composed of numerous groups of control registers, all with TLAs:
54  *	FBC - frame buffer control?
55  *	FHC - fbc hardware configuration / control? register (32 bits)
56  *	DHC - ???
57  *	TEC - transform engine control?
58  *	THC - TEC Hardware Configuration
59  *	ROM - a 64Kbyte ROM with who knows what in it.
60  *	colormap - see below
61  *	frame buffer memory (video RAM)
62  *	possible other stuff
63  *
64  * Like the cg3, the cg6 uses a Brooktree Video DAC (see btreg.h).
65  *
66  * Various revisions of the cgsix have various hardware bugs.  So far,
67  * we have only seen rev 1 & 2.
68  */
69 
70 /* Control register banks offsets */
71 #define CGSIX_ROM_OFFSET	0x000000
72 #define CGSIX_BT_OFFSET		0x200000
73 #define CGSIX_DHC_OFFSET	0x240000
74 #define CGSIX_ALT_OFFSET	0x280000
75 #define CGSIX_FHC_OFFSET	0x300000
76 #define CGSIX_THC_OFFSET	0x301000
77 #define CGSIX_FBC_OFFSET	0x700000
78 #define CGSIX_TEC_OFFSET	0x701000
79 #define CGSIX_RAM_OFFSET	0x800000
80 
81 /* bits in FHC register */
82 #define	FHC_FBID_MASK	0xff000000	/* bits 24..31 are frame buffer ID */
83 #define	FHC_FBID_SHIFT	24
84 #define	FHC_REV_MASK	0x00f00000	/* bits 20..23 are revision */
85 #define	FHC_REV_SHIFT	20
86 #define	FHC_FROP_DISABLE 0x00080000	/* disable fast rasterops */
87 #define	FHC_ROW_DISABLE	0x00040000	/* disable row cache */
88 #define	FHC_SRC_DISABLE	0x00020000	/* disable source cache */
89 #define	FHC_DST_DISABLE	0x00010000	/* disable destination cache */
90 #define	FHC_RESET	0x00008000	/* reset FBC */
91 #define	FHC_XXX0	0x00004000	/* unused */
92 #define	FHC_LEBO	0x00002000	/* set little endian byte order */
93 #define	FHC_RES_MASK	0x00001800	/* bits 11&12 are resolution */
94 #define	FHC_RES_1024	 0x00000000		/* res = 1024x768 */
95 #define	FHC_RES_1152	 0x00000800		/* res = 1152x900 */
96 #define	FHC_RES_1280	 0x00001000		/* res = 1280x1024 */
97 #define	FHC_RES_1600	 0x00001800		/* res = 1600x1200 */
98 #define	FHC_CPU_MASK	0x00000600	/* bits 9&10 are cpu type */
99 #define	FHC_CPU_SPARC	 0x00000000		/* cpu = sparc */
100 #define	FHC_CPU_68020	 0x00000200		/* cpu = 68020 */
101 #define	FHC_CPU_386	 0x00000400		/* cpu = 80386 */
102 #define	FHC_CPU_XXX	 0x00000600		/* unused */
103 #define	FHC_TEST	0x00000100	/* modify TESTX and TESTY */
104 #define	FHC_TESTX_MASK	0x000000f0	/* bits 4..7 are test window X */
105 #define	FHC_TESTX_SHIFT	4
106 #define	FHC_TESTY_MASK	0x0000000f	/* bits 0..3 are test window Y */
107 #define	FHC_TESTY_SHIFT	0
108 
109 /*
110  * The layout of the THC.
111  */
112 struct cg6_thc {
113 	u_int32_t	thc_xxx0[512];	/* ??? */
114 	u_int32_t	thc_hsync1;	/* horizontal sync timing */
115 	u_int32_t	thc_hsync2;	/* more hsync timing */
116 	u_int32_t	thc_hsync3;	/* yet more hsync timing */
117 	u_int32_t	thc_vsync1;	/* vertical sync timing */
118 	u_int32_t	thc_vsync2;	/* only two of these */
119 	u_int32_t	thc_refresh;	/* refresh counter */
120 	u_int32_t	thc_misc;	/* miscellaneous control & status */
121 	u_int32_t	thc_xxx1[56];	/* ??? */
122 	u_int32_t	thc_cursxy;	/* cursor x,y position (16 bits each) */
123 	u_int32_t	thc_cursmask[32];/* cursor mask bits */
124 	u_int32_t	thc_cursbits[32];/* what to show where mask enabled */
125 };
126 
127 /* bits in thc_misc */
128 #define	THC_MISC_XXX0		0xfff00000	/* unused */
129 #define	THC_MISC_REVMASK	0x000f0000	/* cg6 revision? */
130 #define	THC_MISC_REVSHIFT	16
131 #define	THC_MISC_XXX1		0x0000e000	/* unused */
132 #define	THC_MISC_RESET		0x00001000	/* ??? */
133 #define	THC_MISC_XXX2		0x00000800	/* unused */
134 #define	THC_MISC_VIDEN		0x00000400	/* video enable */
135 #define	THC_MISC_SYNC		0x00000200	/* sync status */
136 #define	THC_MISC_VSYNC		0x00000100	/* vsync status */
137 #define	THC_MISC_SYNCEN		0x00000080	/* sync enable */
138 #define	THC_MISC_CURSRES	0x00000040	/* cursor resolution */
139 #define	THC_MISC_INTEN		0x00000020	/* v.retrace intr enable */
140 #define	THC_MISC_INTR		0x00000010	/* intr pending / ack bit */
141 #define	THC_MISC_XXX		0x0000000f	/* ??? */
142 
143 /* cursor x / y position value for `off' */
144 #define	THC_CURSOFF	(65536-32)	/* i.e., USHRT_MAX+1-32 */
145 
146 /*
147  * Partial description of TEC (needed to get around FHC rev 1 bugs).
148  */
149 struct cg6_tec_xxx {
150 	u_int32_t	tec_mv;		/* matrix stuff */
151 	u_int32_t	tec_clip;	/* clipping stuff */
152 	u_int32_t	tec_vdc;	/* ??? */
153 };
154 
155 /*
156  * Partial description of FBC
157  *
158  * Most of this we don't care about; here are only the portions
159  * we need, most notably the blitter.  Comments are merely my
160  * best guesses as to register functions, based largely on the
161  * X11R6.4 sunGX code.  Some of these are here only so we can
162  * stuff canned values in them (eg, offx).
163  */
164 struct cg6_fbc {
165 	u_int32_t fbc_config;		/* r/o CONFIG register */
166 	volatile u_int32_t fbc_mode;	/* mode setting */
167 	u_int32_t fbc_clip;		/* TEC clip check */
168 	u_int32_t fbc_pad2[1];
169 	u_int32_t fbc_s;		/* global status */
170 	u_int32_t fbc_draw;		/* drawing pipeline status */
171 	u_int32_t fbc_blit;		/* blitter status */
172 	u_int32_t fbc_font;		/* pixel transfer register */
173 	u_int32_t fbc_pad3[24];
174 	u_int32_t fbc_x0;		/* blitter, src llx */
175 	u_int32_t fbc_y0;		/* blitter, src lly */
176 	u_int32_t fbc_pad4[2];
177 	u_int32_t fbc_x1;		/* blitter, src urx */
178 	u_int32_t fbc_y1;		/* blitter, src ury */
179 	u_int32_t fbc_pad5[2];
180 	u_int32_t fbc_x2;		/* blitter, dst llx */
181 	u_int32_t fbc_y2;		/* blitter, dst lly */
182 	u_int32_t fbc_pad6[2];
183 	u_int32_t fbc_x3;		/* blitter, dst urx */
184 	u_int32_t fbc_y3;		/* blitter, dst ury */
185 	u_int32_t fbc_pad7[2];
186 	u_int32_t fbc_offx;		/* x offset for drawing */
187 	u_int32_t fbc_offy;		/* y offset for drawing */
188 	u_int32_t fbc_pad8[2];
189 	u_int32_t fbc_incx;		/* x offset for drawing */
190 	u_int32_t fbc_incy;		/* y offset for drawing */
191 	u_int32_t fbc_pad81[2];
192 	u_int32_t fbc_clipminx;		/* clip rectangle llx */
193 	u_int32_t fbc_clipminy;		/* clip rectangle lly */
194 	u_int32_t fbc_pad9[2];
195 	u_int32_t fbc_clipmaxx;		/* clip rectangle urx */
196 	u_int32_t fbc_clipmaxy;		/* clip rectangle ury */
197 	u_int32_t fbc_pad10[2];
198 	u_int32_t fbc_fg;		/* fg value for rop */
199 	u_int32_t fbc_bg;
200 	u_int32_t fbc_alu;		/* operation to be performed */
201 	u_int32_t fbc_pad12[509];
202 	u_int32_t fbc_arectx;		/* rectangle drawing, x coord */
203 	u_int32_t fbc_arecty;		/* rectangle drawing, y coord */
204 	/* actually much more, but nothing more we need */
205 };
206 
207 /* FBC mode definitions (from XFree86) */
208 #define CG6_FBC_BLIT_IGNORE		0x00000000
209 #define CG6_FBC_BLIT_NOSRC		0x00100000
210 #define CG6_FBC_BLIT_SRC		0x00200000
211 #define CG6_FBC_BLIT_ILLEGAL		0x00300000
212 #define CG6_FBC_BLIT_MASK		0x00300000
213 
214 #define CG6_FBC_VBLANK			0x00080000
215 
216 #define CG6_FBC_MODE_IGNORE		0x00000000
217 #define CG6_FBC_MODE_COLOR8		0x00020000
218 #define CG6_FBC_MODE_COLOR1		0x00040000
219 #define CG6_FBC_MODE_HRMONO		0x00060000
220 #define CG6_FBC_MODE_MASK		0x00060000
221 
222 #define CG6_FBC_DRAW_IGNORE		0x00000000
223 #define CG6_FBC_DRAW_RENDER		0x00008000
224 #define CG6_FBC_DRAW_PICK		0x00010000
225 #define CG6_FBC_DRAW_ILLEGAL		0x00018000
226 #define CG6_FBC_DRAW_MASK		0x00018000
227 
228 #define CG6_FBC_BWRITE0_IGNORE		0x00000000
229 #define CG6_FBC_BWRITE0_ENABLE		0x00002000
230 #define CG6_FBC_BWRITE0_DISABLE		0x00004000
231 #define CG6_FBC_BWRITE0_ILLEGAL		0x00006000
232 #define CG6_FBC_BWRITE0_MASK		0x00006000
233 
234 #define CG6_FBC_BWRITE1_IGNORE		0x00000000
235 #define CG6_FBC_BWRITE1_ENABLE		0x00000800
236 #define CG6_FBC_BWRITE1_DISABLE		0x00001000
237 #define CG6_FBC_BWRITE1_ILLEGAL		0x00001800
238 #define CG6_FBC_BWRITE1_MASK		0x00001800
239 
240 #define CG6_FBC_BREAD_IGNORE		0x00000000
241 #define CG6_FBC_BREAD_0			0x00000200
242 #define CG6_FBC_BREAD_1			0x00000400
243 #define CG6_FBC_BREAD_ILLEGAL		0x00000600
244 #define CG6_FBC_BREAD_MASK		0x00000600
245 
246 #define CG6_FBC_BDISP_IGNORE		0x00000000
247 #define CG6_FBC_BDISP_0			0x00000080
248 #define CG6_FBC_BDISP_1			0x00000100
249 #define CG6_FBC_BDISP_ILLEGAL		0x00000180
250 #define CG6_FBC_BDISP_MASK		0x00000180
251 
252 #define CG6_FBC_INDEX_MOD		0x00000040
253 #define CG6_FBC_INDEX_MASK		0x00000030
254 
255 /* rasterops */
256 #define GX_ROP_CLEAR        0x0
257 #define GX_ROP_INVERT       0x1
258 #define GX_ROP_NOOP         0x2
259 #define GX_ROP_SET          0x3
260 
261 #define GX_ROP_00_0(rop)    ((rop) << 0)
262 #define GX_ROP_00_1(rop)    ((rop) << 2)
263 #define GX_ROP_01_0(rop)    ((rop) << 4)
264 #define GX_ROP_01_1(rop)    ((rop) << 6)
265 #define GX_ROP_10_0(rop)    ((rop) << 8)
266 #define GX_ROP_10_1(rop)    ((rop) << 10)
267 #define GX_ROP_11_0(rop)    ((rop) << 12)
268 #define GX_ROP_11_1(rop)    ((rop) << 14)
269 #define GX_PLOT_PLOT        0x00000000
270 #define GX_PLOT_UNPLOT      0x00020000
271 #define GX_RAST_BOOL        0x00000000
272 #define GX_RAST_LINEAR      0x00040000
273 #define GX_ATTR_UNSUPP      0x00400000
274 #define GX_ATTR_SUPP        0x00800000
275 #define GX_POLYG_OVERLAP    0x01000000
276 #define GX_POLYG_NONOVERLAP 0x02000000
277 #define GX_PATTERN_ZEROS    0x04000000
278 #define GX_PATTERN_ONES     0x08000000
279 #define GX_PATTERN_MASK     0x0c000000
280 #define GX_PIXEL_ZEROS      0x10000000
281 #define GX_PIXEL_ONES       0x20000000
282 #define GX_PIXEL_MASK       0x30000000
283 #define GX_PLANE_ZEROS      0x40000000
284 #define GX_PLANE_ONES       0x80000000
285 #define GX_PLANE_MASK       0xc0000000
286 /* rops for bit blit / copy area
287    with:
288        Plane Mask - use plane mask reg.
289        Pixel Mask - use all ones.
290        Patt  Mask - use all ones.
291 */
292 
293 #define POLY_O          GX_POLYG_OVERLAP
294 #define POLY_N          GX_POLYG_NONOVERLAP
295 
296 #define ROP_STANDARD    (GX_PLANE_MASK |\
297                         GX_PIXEL_ONES |\
298                         GX_ATTR_SUPP |\
299                         GX_RAST_BOOL |\
300                         GX_PLOT_PLOT)
301 
302 /* fg = don't care  bg = don't care */
303 
304 #define ROP_BLIT(O,I)   (ROP_STANDARD | \
305                         GX_PATTERN_ONES |\
306                         GX_ROP_11_1(I) |\
307                         GX_ROP_11_0(O) |\
308                         GX_ROP_10_1(I) |\
309                         GX_ROP_10_0(O) |\
310                         GX_ROP_01_1(I) |\
311                         GX_ROP_01_0(O) |\
312                         GX_ROP_00_1(I) |\
313                         GX_ROP_00_0(O))
314 
315 /* fg = fgPixel     bg = don't care */
316 
317 #define ROP_FILL(O,I)   (ROP_STANDARD | \
318                         GX_PATTERN_ONES |\
319                         GX_ROP_11_1(I) |\
320                         GX_ROP_11_0(I) |\
321                         GX_ROP_10_1(I) |\
322                         GX_ROP_10_0(I) | \
323                         GX_ROP_01_1(O) |\
324                         GX_ROP_01_0(O) |\
325                         GX_ROP_00_1(O) |\
326                         GX_ROP_00_0(O))
327 
328 /* fg = fgPixel     bg = don't care */
329 
330 #define ROP_STIP(O,I)   (ROP_STANDARD |\
331                         GX_ROP_11_1(I) |\
332                         GX_ROP_11_0(GX_ROP_NOOP) |\
333                         GX_ROP_10_1(I) |\
334                         GX_ROP_10_0(GX_ROP_NOOP) | \
335                         GX_ROP_01_1(O) |\
336                         GX_ROP_01_0(GX_ROP_NOOP) |\
337                         GX_ROP_00_1(O) |\
338                         GX_ROP_00_0(GX_ROP_NOOP))
339 
340 /* fg = fgPixel     bg = bgPixel */
341 
342 #define ROP_OSTP(O,I)   (ROP_STANDARD |\
343                         GX_ROP_11_1(I) |\
344                         GX_ROP_11_0(I) |\
345                         GX_ROP_10_1(I) |\
346                         GX_ROP_10_0(O) |\
347                         GX_ROP_01_1(O) |\
348                         GX_ROP_01_0(I) |\
349                         GX_ROP_00_1(O) |\
350                         GX_ROP_00_0(O))
351 
352 #define GX_ROP_USE_PIXELMASK    0x30000000
353 
354 #define GX_BLT_INPROGRESS       0x20000000
355 
356 /* status register(s) */
357 #define GX_EXCEPTION		0x80000000
358 #define GX_TEC_EXCEPTION	0x40000000
359 #define GX_FULL                 0x20000000
360 #define GX_INPROGRESS           0x10000000
361 #define GX_UNSUPPORTED_ATTR	0x02000000
362 #define GX_HRMONO		0x01000000
363 #define GX_OVERFLOW		0x00200000
364 #define GX_PICK			0x00100000
365 #define GX_TEC_HIDDEN		0x00040000
366 #define GX_TEC_INTERSECT	0x00020000
367 #define GX_TEC_VISIBLE		0x00010000
368 #define GX_BLIT_HARDWARE	0x00008000	/* hardware can blit this */
369 #define GX_BLIT_SOFTWARE	0x00004000	/* software must blit this */
370 #define GX_BLIT_SRC_HIDDEN	0x00002000
371 #define GX_BLIT_SRC_INTERSECT	0x00001000
372 #define GX_BLIT_SRC_VISIBLE	0x00000800
373 #define GX_BLIT_DST_HIDDEN	0x00000400
374 #define GX_BLIT_DST_INTERSECT	0x00000200
375 #define GX_BLIT_DST_VISIBLE	0x00000100
376 #define GX_DRAW_HARDWARE	0x00000010	/* hardware can draw this */
377 #define GX_DRAW_SOFTAWRE	0x00000008	/* software must draw this */
378 #define GX_DRAW_HIDDEN		0x00000004
379 #define GX_DRAW_INTERSECT	0x00000002
380 #define GX_DRAW_VISIBLE		0x00000001
381 
382 /* MISC register */
383 #define GX_INDEX(n)         ((n) << 4)
384 #define GX_INDEX_ALL        0x00000030
385 #define GX_INDEX_MOD        0x00000040
386 #define GX_BDISP_0          0x00000080
387 #define GX_BDISP_1          0x00000100
388 #define GX_BDISP_ALL        0x00000180
389 #define GX_BREAD_0          0x00000200
390 #define GX_BREAD_1          0x00000400
391 #define GX_BREAD_ALL        0x00000600
392 #define GX_BWRITE1_ENABLE   0x00000800
393 #define GX_BWRITE1_DISABLE  0x00001000
394 #define GX_BWRITE1_ALL      0x00001800
395 #define GX_BWRITE0_ENABLE   0x00002000
396 #define GX_BWRITE0_DISABLE  0x00004000
397 #define GX_BWRITE0_ALL      0x00006000
398 #define GX_DRAW_RENDER      0x00008000
399 #define GX_DRAW_PICK        0x00010000
400 #define GX_DRAW_ALL         0x00018000
401 #define GX_MODE_COLOR8      0x00020000
402 #define GX_MODE_COLOR1      0x00040000
403 #define GX_MODE_HRMONO      0x00060000
404 #define GX_MODE_ALL         0x00060000
405 #define GX_VBLANK           0x00080000
406 #define GX_BLIT_NOSRC       0x00100000
407 #define GX_BLIT_SRC         0x00200000
408 #define GX_BLIT_ALL         0x00300000
409 
410 #if _CG6_LAYOUT_NOT_USED_ANYMORE
411 /*
412  * This structure exists only to compute the layout of the CG6
413  * hardware.  Each of the individual substructures lives on a
414  * separate `page' (where a `page' is at least 4K), and many are
415  * very far apart.  We avoid large offsets (which make for lousy
416  * code) by using pointers to the individual interesting pieces,
417  * and map them in independently (to avoid using up PTEs unnecessarily).
418  */
419 struct cg6_layout {
420 	/* ROM at 0 */
421 	union {
422 		int un_id;		/* ID = ?? */
423 		char un_rom[65536];	/* 64K rom */
424 		char un_pad[0x200000];
425 	} cg6_rom_un;
426 
427 	/* Brooktree DAC at 0x200000 */
428 	union {
429 		struct bt_regs un_btregs;
430 		char un_pad[0x040000];
431 	} cg6_bt_un;
432 
433 	/* DHC, whatever that is, at 0x240000 */
434 	union {
435 		char un_pad[0x40000];
436 	} cg6_dhc_un;
437 
438 	/* ALT, whatever that is, at 0x280000 */
439 	union {
440 		char un_pad[0x80000];
441 	} cg6_alt_un;
442 
443 	/* FHC register at 0x300000 */
444 	union {
445 		int un_fhc;
446 		char un_pad[0x1000];
447 	} cg6_fhc_un;
448 
449 	/* THC at 0x301000 */
450 	union {
451 		struct cg6_thc un_thc;
452 		char un_pad[0x400000 - 0x1000];
453 	} cg6_thc_un;
454 
455 	/* FBC at 0x700000 */
456 	union {
457 		char un_pad[0x1000];
458 	} cg6_fbc_un;
459 
460 	/* TEC at 0x701000 */
461 	union {
462 		char un_pad[0x100000 - 0x1000];
463 		struct cg6_tec_xxx un_tec;
464 	} cg6_tec_un;
465 
466 	/* Video RAM at 0x800000 */
467 	char	cg6_ram[1024 * 1024];	/* approx.? */
468 };
469 #endif
470