git.sur5r.net Git - cc65/blob - include/_gtia.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 _gtia.h                                   */
   4 /*                                                                           */
   5 /*                  Internal include file, do not use directly               */
   6 /*                                                                           */
   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"          */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* (C) 2000 Freddy Offenga <taf_offenga@yahoo.com>                           */
  16 /* 2019-01-16: Bill Kendrick <nbs@sonic.net>: More defines for registers     */
  17 /*                                                                           */
  18 /*                                                                           */
  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.                                    */
  22 /*                                                                           */
  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:                            */
  26 /*                                                                           */
  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              */
  34 /*    distribution.                                                          */
  35 /*                                                                           */
  36 /*****************************************************************************/
  37
  38
  39 #ifndef __GTIA_H
  40 #define __GTIA_H
  41
  42 /*****************************************************************************/
  43 /* Define a structure with the GTIA register offsets for write (W)           */
  44 /*****************************************************************************/
  45
  46 struct __gtia_write {
  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 */
  55
  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 */
  61
  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 */
  67
  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 */
  77
  78     unsigned char   prior;  /* 0x1B: priority selection */
  79
  80     unsigned char   vdelay;
  81     /* 0x1C: vertical delay -- one-line resolution movement of
  82     ** vertical position of an object when two line resolution display is enabled
  83     */
  84
  85     unsigned char   gractl; /* 0x1D: stick/paddle latch, p/m control */
  86
  87     unsigned char   hitclr; /* 0x1E: clear p/m collision */
  88     unsigned char   consol; /* 0x1F: builtin speaker */
  89 };
  90
  91
  92 /*****************************************************************************/
  93 /* (W) Values for SIZEP0-SIZEP3 and SIZEM registers:                         */
  94 /*****************************************************************************/
  95
  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 */
  99
 100
 101 /* COLPM0-COLPM3, COLPF0-COLPF3, COLBK color registers:
 102 ** See the "HUE_..." #defines in "atari.h" for the hue values;
 103 ** Bitwise OR (|) with 0x00 (darkest) through 0x0F (lightest) (only even values are unique)
 104 */
 105
 106
 107 /*****************************************************************************/
 108 /* (W) PRIOR register values                                                 */
 109 /*****************************************************************************/
 110
 111 #define PRIOR_P03_PF03          0x01 /* Players 0-3, then Playfields 0-3, then background */
 112 #define PRIOR_P01_PF03_P23      0x02 /* Players 0-1, then Playfields 0-3, then Players 2-3, then background */
 113 #define PRIOR_PF03_P03          0x04 /* Playfields 0-3, then Players 0-3, then background */
 114 #define PRIOR_PF01_P03_PF23     0x08 /* Playfields 0-1, then Players 0-3, then Playfields 2-3, then background */
 115
 116 #define PRIOR_5TH_PLAYER        0x10 /* Four missiles combine to be a 5th player (uses COLPF3) */
 117
 118 /* Causes overlap of players 0 & 1 and of players 2 & 3 to result in a third color,
 119 ** the logical OR of the two players' colors, and other overlaps (e.g., players 0 and 2)
 120 ** to result in black (0x00).
 121 */
 122 #define PRIOR_OVERLAP_3RD_COLOR 0x20
 123
 124
 125 /*****************************************************************************/
 126 /* (W) GTIA special graphics mode options for GPRIOR                         */
 127 /*****************************************************************************/
 128
 129 /* Pixels are 2 color clocks wide, and one scanline tall
 130 ** (so 80x192 in normal playfield width).
 131 ** May be used with both bitmap and character modelines.
 132 */
 133
 134 /* 16 shade shades of the background (COLBK) hue;
 135 ** Note: brightnesses other than 0 (darkest) in COLBK cause additional effects
 136 */
 137 #define PRIOR_GFX_MODE_9        0x40
 138
 139 /* 9 color palette mode;
 140 ** COLPM0 (acts as background) thru COLPM3, followed by COLPF0 thru COLPF3, and COLBK
 141 */
 142 #define PRIOR_GFX_MODE_10       0x80
 143
 144 /* 16 hues of the background (COLBK) brightness;
 145 ** Note: hues other than 0 (greys) in COLBK caus additional effects
 146 */
 147 #define PRIOR_GFX_MODE_11       0xC0
 148
 149
 150 /*****************************************************************************/
 151 /* (W) VDELAY register values                                                */
 152 /*****************************************************************************/
 153
 154 #define VDELAY_MISSILE0 0x01
 155 #define VDELAY_MISSILE1 0x02
 156 #define VDELAY_MISSILE2 0x04
 157 #define VDELAY_MISSILE3 0x08
 158 #define VDELAY_PLAYER0  0x10
 159 #define VDELAY_PLAYER1  0x20
 160 #define VDELAY_PLAYER2  0x40
 161 #define VDELAY_PLAYER3  0x80
 162
 163
 164 /*****************************************************************************/
 165 /* (W) GRACTL register values                                                */
 166 /*****************************************************************************/
 167
 168 #define GRACTL_MISSLES              0x01 /* enable missiles */
 169 #define GRACTL_PLAYERS              0x02 /* enable players */
 170
 171 /* "Latch" triggers; once pressed, will give a continuous
 172 ** pressed input until this bit is cleared
 173 */
 174 #define GRACTL_LATCH_TRIGGER_INPUTS 0x04
 175
 176
 177 /*****************************************************************************/
 178 /* Define a structure with the GTIA register offsets for read (R)            */
 179 /*****************************************************************************/
 180
 181 struct __gtia_read {
 182     unsigned char   m0pf;       /* 0x00: missile 0 to playfield collision */
 183     unsigned char   m1pf;       /* 0x01: missile 1 to playfield collision */
 184     unsigned char   m2pf;       /* 0x02: missile 2 to playfield collision */
 185     unsigned char   m3pf;       /* 0x03: missile 3 to playfield collision */
 186     unsigned char   p0pf;       /* 0x04: player 0 to playfield collision */
 187     unsigned char   p1pf;       /* 0x05: player 1 to playfield collision */
 188     unsigned char   p2pf;       /* 0x06: player 2 to playfield collision */
 189     unsigned char   p3pf;       /* 0x07: player 3 to playfield collision */
 190     unsigned char   m0pl;       /* 0x08: missile 0 to player collision */
 191     unsigned char   m1pl;       /* 0x09: missile 1 to player collision */
 192     unsigned char   m2pl;       /* 0x0A: missile 2 to player collision */
 193     unsigned char   m3pl;       /* 0x0B: missile 3 to player collision */
 194     unsigned char   p0pl;       /* 0x0C: player 0 to player collision */
 195     unsigned char   p1pl;       /* 0x0D: player 1 to player collision */
 196     unsigned char   p2pl;       /* 0x0E: player 2 to player collision */
 197     unsigned char   p3pl;       /* 0x0F: player 3 to player collision */
 198
 199     unsigned char   trig0;      /* 0x10: joystick trigger 0 (0=pressed, 1=released) */
 200     unsigned char   trig1;      /* 0x11: joystick trigger 1 */
 201     unsigned char   trig2;      /* 0x12: joystick trigger 2 */
 202     unsigned char   trig3;      /* 0x13: joystick trigger 3 */
 203
 204     unsigned char   pal;        /* 0x14: pal/ntsc flag */
 205
 206     unsigned char   unused[10];
 207
 208     unsigned char   consol;     /* 0x1F: console buttons */
 209 };
 210
 211
 212 /*****************************************************************************/
 213 /* (R) PAL register possible values                                          */
 214 /*****************************************************************************/
 215
 216 /* Note: This only tells you whether the GTIA is PAL or NTSC; some NTSC
 217 ** systems are modded with PAL ANTIC chips; testing VCOUNT limits can be
 218 ** done to check for that.  Seems like it's not possible to test for SECAM
 219 */
 220
 221 #define TV_STD_PAL  0x1
 222 #define TV_STD_NTSC 0xE
 223
 224
 225 /*****************************************************************************/
 226 /* Macros for reading console keys (Start/Select/Option) via CONSOL register */
 227 /*****************************************************************************/
 228
 229 #define CONSOL_START(x)     !((unsigned char)((x) & 1)) /* true if Start pressed */
 230 #define CONSOL_SELECT(x)    !((unsigned char)((x) & 2)) /* true if Select pressed */
 231 #define CONSOL_OPTION(x)    !((unsigned char)((x) & 4)) /* true if Option pressed */
 232
 233
 234 /* End of _gtia.h */
 235 #endif /* #ifndef __GTIA_H */