1 /*****************************************************************************/
5 /* Internal include file, do not use directly */
7 /* "GTIA, Graphic Television Interface Adaptor, is a custom chip used in the */
8 /* Atari 8-bit family of computers and in the Atari 5200 console. In these */
9 /* systems, GTIA chip works together with ANTIC to produce video display. */
10 /* ANTIC generates the playfield graphics (text and bitmap) while GTIA */
11 /* provides the color for the playfield and adds overlay objects known as */
12 /* player/missile graphics (sprites)" - Wikipedia article on "GTIA" */
15 /* (C) 2000 Freddy Offenga <taf_offenga@yahoo.com> */
16 /* 2019-01-16: Bill Kendrick <nbs@sonic.net>: More defines for registers */
19 /* This software is provided 'as-is', without any expressed or implied */
20 /* warranty. In no event will the authors be held liable for any damages */
21 /* arising from the use of this software. */
23 /* Permission is granted to anyone to use this software for any purpose, */
24 /* including commercial applications, and to alter it and redistribute it */
25 /* freely, subject to the following restrictions: */
27 /* 1. The origin of this software must not be misrepresented; you must not */
28 /* claim that you wrote the original software. If you use this software */
29 /* in a product, an acknowledgment in the product documentation would be */
30 /* appreciated but is not required. */
31 /* 2. Altered source versions must be plainly marked as such, and must not */
32 /* be misrepresented as being the original software. */
33 /* 3. This notice may not be removed or altered from any source */
36 /*****************************************************************************/
42 /*****************************************************************************/
43 /* Define a structure with the GTIA register offsets for write (W) */
44 /*****************************************************************************/
47 unsigned char hposp0; /* 0x00: horizontal position of player 0 */
48 unsigned char hposp1; /* 0x01: horizontal position of player 1 */
49 unsigned char hposp2; /* 0x02: horizontal position of player 2 */
50 unsigned char hposp3; /* 0x03: horizontal position of player 3 */
51 unsigned char hposm0; /* 0x04: horizontal position of missile 0 */
52 unsigned char hposm1; /* 0x05: horizontal position of missile 1 */
53 unsigned char hposm2; /* 0x06: horizontal position of missile 2 */
54 unsigned char hposm3; /* 0x07: horizontal position of missile 3 */
56 unsigned char sizep0; /* 0x08: size of player 0 */
57 unsigned char sizep1; /* 0x09: size of player 1 */
58 unsigned char sizep2; /* 0x0A: size of player 2 */
59 unsigned char sizep3; /* 0x0B: size of player 3 */
60 unsigned char sizem; /* 0x0C: size of missiles */
62 unsigned char grafp0; /* 0x0D: graphics shape player 0 (used when ANTIC is not instructed to use DMA; see DMACTL) */
63 unsigned char grafp1; /* 0x0E: graphics shape player 1 */
64 unsigned char grafp2; /* 0x0F: graphics shape player 2 */
65 unsigned char grafp3; /* 0x10: graphics shape player 3 */
66 unsigned char grafm; /* 0x11: graphics shape missiles */
68 unsigned char colpm0; /* 0x12: color player and missile 0 */
69 unsigned char colpm1; /* 0x13: color player and missile 1 */
70 unsigned char colpm2; /* 0x14: color player and missile 2 */
71 unsigned char colpm3; /* 0x15: color player and missile 3 */
72 unsigned char colpf0; /* 0x16: color playfield 0 */
73 unsigned char colpf1; /* 0x17: color playfield 1 */
74 unsigned char colpf2; /* 0x18: color playfield 2 */
75 unsigned char colpf3; /* 0x19: color playfield 3 */
76 unsigned char colbk; /* 0x1A: color background */
78 unsigned char prior; /* 0x1B: priority selection */
81 /* 0x1C: vertical delay -- one-line resolution movement of
82 ** vertical position of an object when two line resolution display is enabled
85 unsigned char gractl; /* 0x1D: stick/paddle latch, p/m control */
87 unsigned char hitclr; /* 0x1E: clear p/m collision */
88 unsigned char consol; /* 0x1F: builtin speaker */
92 /*****************************************************************************/
93 /* (W) Values for SIZEP0-SIZEP3 and SIZEM registers: */
94 /*****************************************************************************/
96 #define PMG_SIZE_NORMAL 0x0 /* one color clock per pixel */
97 #define PMG_SIZE_DOUBLE 0x1 /* two color clocks per pixel */
98 #define PMG_SIZE_QUAD 0x2 /* four color clocks per pixel */
101 /* COLPM0-COLPM3, COLPF0-COLPF3, COLBK color registers */
103 /*****************************************************************************/
104 /* Color definitions */
105 /*****************************************************************************/
107 /* Make a GTIA color value */
108 #define _gtia_mkcolor(hue,lum) (((hue) << 4) | ((lum) << 1))
110 /* Luminance values go from 0 (black) to 7 (white) */
113 /* (These can vary depending on TV standard (NTSC vs PAL),
114 ** tint potentiometer settings, TV tint settings, emulator palette, etc.)
118 #define HUE_GOLDORANGE 2
119 #define HUE_REDORANGE 3
121 #define HUE_MAGENTA 5
126 #define HUE_BLUEGREEN 10
127 #define HUE_BLUEGREEN2 11
129 #define HUE_YELLOWGREEN 13
130 #define HUE_YELLOW 14
131 #define HUE_YELLOWRED 15
133 /* Color defines, similar to c64 colors (untested) */
134 /* Hardware palette values (for GTIA colxxx registers) */
135 #define GTIA_COLOR_BLACK _gtia_mkcolor(HUE_GREY,0)
136 #define GTIA_COLOR_WHITE _gtia_mkcolor(HUE_GREY,7)
137 #define GTIA_COLOR_RED _gtia_mkcolor(HUE_REDORANGE,1)
138 #define GTIA_COLOR_CYAN _gtia_mkcolor(HUE_CYAN,3)
139 #define GTIA_COLOR_VIOLET _gtia_mkcolor(HUE_PURPLE,4)
140 #define GTIA_COLOR_GREEN _gtia_mkcolor(HUE_GREEN,2)
141 #define GTIA_COLOR_BLUE _gtia_mkcolor(HUE_BLUE,2)
142 #define GTIA_COLOR_YELLOW _gtia_mkcolor(HUE_YELLOW,7)
143 #define GTIA_COLOR_ORANGE _gtia_mkcolor(HUE_ORANGE,5)
144 #define GTIA_COLOR_BROWN _gtia_mkcolor(HUE_YELLOW,2)
145 #define GTIA_COLOR_LIGHTRED _gtia_mkcolor(HUE_REDORANGE,6)
146 #define GTIA_COLOR_GRAY1 _gtia_mkcolor(HUE_GREY,2)
147 #define GTIA_COLOR_GRAY2 _gtia_mkcolor(HUE_GREY,3)
148 #define GTIA_COLOR_LIGHTGREEN _gtia_mkcolor(HUE_GREEN,6)
149 #define GTIA_COLOR_LIGHTBLUE _gtia_mkcolor(HUE_BLUE,6)
150 #define GTIA_COLOR_GRAY3 _gtia_mkcolor(HUE_GREY,5)
153 /*****************************************************************************/
154 /* (W) PRIOR register values */
155 /*****************************************************************************/
157 #define PRIOR_P03_PF03 0x01 /* Players 0-3, then Playfields 0-3, then background */
158 #define PRIOR_P01_PF03_P23 0x02 /* Players 0-1, then Playfields 0-3, then Players 2-3, then background */
159 #define PRIOR_PF03_P03 0x04 /* Playfields 0-3, then Players 0-3, then background */
160 #define PRIOR_PF01_P03_PF23 0x08 /* Playfields 0-1, then Players 0-3, then Playfields 2-3, then background */
162 #define PRIOR_5TH_PLAYER 0x10 /* Four missiles combine to be a 5th player (uses COLPF3) */
164 /* Causes overlap of players 0 & 1 and of players 2 & 3 to result in a third color,
165 ** the logical OR of the two players' colors, and other overlaps (e.g., players 0 and 2)
166 ** to result in black (0x00).
168 #define PRIOR_OVERLAP_3RD_COLOR 0x20
171 /*****************************************************************************/
172 /* (W) GTIA special graphics mode options for GPRIOR */
173 /*****************************************************************************/
175 /* Pixels are 2 color clocks wide, and one scanline tall
176 ** (so 80x192 in normal playfield width).
177 ** May be used with both bitmap and character modelines.
180 /* 16 shade shades of the background (COLBK) hue;
181 ** Note: brightnesses other than 0 (darkest) in COLBK cause additional effects
183 #define PRIOR_GFX_MODE_9 0x40
185 /* 9 color palette mode;
186 ** COLPM0 (acts as background) thru COLPM3, followed by COLPF0 thru COLPF3, and COLBK
188 #define PRIOR_GFX_MODE_10 0x80
190 /* 16 hues of the background (COLBK) brightness;
191 ** Note: hues other than 0 (greys) in COLBK caus additional effects
193 #define PRIOR_GFX_MODE_11 0xC0
196 /*****************************************************************************/
197 /* (W) VDELAY register values */
198 /*****************************************************************************/
200 #define VDELAY_MISSILE0 0x01
201 #define VDELAY_MISSILE1 0x02
202 #define VDELAY_MISSILE2 0x04
203 #define VDELAY_MISSILE3 0x08
204 #define VDELAY_PLAYER0 0x10
205 #define VDELAY_PLAYER1 0x20
206 #define VDELAY_PLAYER2 0x40
207 #define VDELAY_PLAYER3 0x80
210 /*****************************************************************************/
211 /* (W) GRACTL register values */
212 /*****************************************************************************/
214 #define GRACTL_MISSLES 0x01 /* enable missiles */
215 #define GRACTL_PLAYERS 0x02 /* enable players */
217 /* "Latch" triggers; once pressed, will give a continuous
218 ** pressed input until this bit is cleared
220 #define GRACTL_LATCH_TRIGGER_INPUTS 0x04
223 /*****************************************************************************/
224 /* Define a structure with the GTIA register offsets for read (R) */
225 /*****************************************************************************/
228 unsigned char m0pf; /* 0x00: missile 0 to playfield collision */
229 unsigned char m1pf; /* 0x01: missile 1 to playfield collision */
230 unsigned char m2pf; /* 0x02: missile 2 to playfield collision */
231 unsigned char m3pf; /* 0x03: missile 3 to playfield collision */
232 unsigned char p0pf; /* 0x04: player 0 to playfield collision */
233 unsigned char p1pf; /* 0x05: player 1 to playfield collision */
234 unsigned char p2pf; /* 0x06: player 2 to playfield collision */
235 unsigned char p3pf; /* 0x07: player 3 to playfield collision */
236 unsigned char m0pl; /* 0x08: missile 0 to player collision */
237 unsigned char m1pl; /* 0x09: missile 1 to player collision */
238 unsigned char m2pl; /* 0x0A: missile 2 to player collision */
239 unsigned char m3pl; /* 0x0B: missile 3 to player collision */
240 unsigned char p0pl; /* 0x0C: player 0 to player collision */
241 unsigned char p1pl; /* 0x0D: player 1 to player collision */
242 unsigned char p2pl; /* 0x0E: player 2 to player collision */
243 unsigned char p3pl; /* 0x0F: player 3 to player collision */
245 unsigned char trig0; /* 0x10: joystick trigger 0 (0=pressed, 1=released) */
246 unsigned char trig1; /* 0x11: joystick trigger 1 */
247 unsigned char trig2; /* 0x12: joystick trigger 2 */
248 unsigned char trig3; /* 0x13: joystick trigger 3 */
250 unsigned char pal; /* 0x14: pal/ntsc flag */
252 unsigned char unused[10];
254 unsigned char consol; /* 0x1F: console buttons */
258 /*****************************************************************************/
259 /* (R) PAL register possible values */
260 /*****************************************************************************/
262 /* Note: This only tells you whether the GTIA is PAL or NTSC; some NTSC
263 ** systems are modded with PAL ANTIC chips; testing VCOUNT limits can be
264 ** done to check for that. Seems like it's not possible to test for SECAM
267 #define TV_STD_PAL 0x1
268 #define TV_STD_NTSC 0xE
271 /*****************************************************************************/
272 /* Macros for reading console keys (Start/Select/Option) via CONSOL register */
273 /*****************************************************************************/
275 #define CONSOL_START(x) !((unsigned char)((x) & 1)) /* true if Start pressed */
276 #define CONSOL_SELECT(x) !((unsigned char)((x) & 2)) /* true if Select pressed */
277 #define CONSOL_OPTION(x) !((unsigned char)((x) & 4)) /* true if Option pressed */
281 #endif /* #ifndef __GTIA_H */