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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                _antic.h                                   */
   4 /*                                                                           */
   5 /*                  Internal include file, do not use directly               */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /* "ANTIC, Alphanumeric Television Interface Controller, is responsible for  */
   9 /* the generation of playfield graphics which is delivered as a datastream   */
  10 /* to the related CTIA/GTIA chip. The CTIA/GTIA provides the coloring of the */
  11 /* playfield graphics, and is responsible for adding overlaid sprite         */
  12 /* (referred to as "Player/Missile graphics" by Atari).  Atari advertised it */
  13 /* as a true microprocessor, in that it has an instruction set to run        */
  14 /* programs (called display lists) to process data.  ANTIC has no capacity   */
  15 /* for writing back computed values to memory, it merely reads data from     */
  16 /* memory and processes it for output to the screen, therefore it is not     */
  17 /* Turing complete." - Wikipedia article on "ANTIC" (with edits)             */
  18 /*                                                                           */
  19 /* (C) 2000 Freddy Offenga <taf_offenga@yahoo.com>                           */
  20 /* 24-Jan-2011: Christian Krueger: Added defines for Antic instruction set   */
  21 /* 2019-01-16: Bill Kendrick <nbs@sonic.net>: More defines for registers     */
  22 /*                                                                           */
  23 /*                                                                           */
  24 /* This software is provided 'as-is', without any expressed or implied       */
  25 /* warranty.  In no event will the authors be held liable for any damages    */
  26 /* arising from the use of this software.                                    */
  27 /*                                                                           */
  28 /* Permission is granted to anyone to use this software for any purpose,     */
  29 /* including commercial applications, and to alter it and redistribute it    */
  30 /* freely, subject to the following restrictions:                            */
  31 /*                                                                           */
  32 /* 1. The origin of this software must not be misrepresented; you must not   */
  33 /*    claim that you wrote the original software. If you use this software   */
  34 /*    in a product, an acknowledgment in the product documentation would be  */
  35 /*    appreciated but is not required.                                       */
  36 /* 2. Altered source versions must be plainly marked as such, and must not   */
  37 /*    be misrepresented as being the original software.                      */
  38 /* 3. This notice may not be removed or altered from any source              */
  39 /*    distribution.                                                          */
  40 /*                                                                           */
  41 /*****************************************************************************/
  42
  43
  44 #ifndef __ANTIC_H
  45 #define __ANTIC_H
  46
  47 /*****************************************************************************/
  48 /* Define a structure with the ANTIC coprocessor's register offsets          */
  49 /*****************************************************************************/
  50
  51 struct __antic {
  52     unsigned char   dmactl; /* (W) direct memory access control */
  53     unsigned char   chactl; /* (W) character mode control */
  54     unsigned char   dlistl; /* display list pointer low-byte */
  55     unsigned char   dlisth; /* display list pointer high-byte */
  56     unsigned char   hscrol; /* (W) horizontal scroll enable */
  57     unsigned char   vscrol; /* (W) vertical scroll enable */
  58     unsigned char   unuse0; /* unused */
  59     unsigned char   pmbase; /* (W) msb of p/m base address (for when DMACTL has player and/or missile DMA enabled) */
  60     unsigned char   unuse1; /* unused */
  61     unsigned char   chbase; /* (W) msb of character set base address */
  62     unsigned char   wsync;  /* (W) wait for horizontal synchronization */
  63     unsigned char   vcount; /* (R) vertical line counter */
  64     unsigned char   penh;   /* (R) light pen horizontal position */
  65     unsigned char   penv;   /* (R) light pen vertical position */
  66     unsigned char   nmien;  /* (W) non-maskable interrupt enable */
  67     unsigned char   nmires;
  68     /* (W) ("NMIRES") nmi reset -- clears the interrupt request register; resets all of the NMI status together
  69     ** (R) ("NMIST") nmi status -- holds cause for the NMI interrupt
  70     */
  71 };
  72
  73
  74 /*****************************************************************************/
  75 /* DMACTL register options                                                   */
  76 /*****************************************************************************/
  77
  78 /* Initialized to 0x22: DMA fetch, normal playfield, no PMG DMA, double-line PMGs */
  79
  80 /* Playfield modes: */
  81 #define DMACTL_PLAYFIELD_NONE     0x00
  82 #define DMACTL_PLAYFIELD_NARROW   0x01 /* e.g., 32 bytes per scanline with thick borders */
  83 #define DMACTL_PLAYFIELD_NORMAL   0x02 /* e.g., 40 bytes per scanline with normal borders */
  84 #define DMACTL_PLAYFIELD_WIDE     0x03 /* e.g., 48 bytes per scanline with no borders (overscan) */
  85
  86 /* Other options: */
  87
  88 /* If not set, GTIA's GRAFP0 thru GRAFP3, and/or GRAFM registers are used for
  89 ** player & missile shapes, respectively.  (Modify the registers during the horizontal blank
  90 ** (Display List Interrupt), a la "racing the beam" on an Atari VCS/2600, )
  91 ** if set, ANTIC's PMBASE will be used to fetch shapes from memory via DMA.
  92 */
  93 #define DMACTL_DMA_MISSILES    0x04
  94 #define DMACTL_DMA_PLAYERS     0x08
  95
  96 /* Unless set, PMGs (as fetched via DMA) will be double-scanline resolution */
  97 #define DMACTL_PMG_SINGLELINE  0x10
  98
  99 /* Unless set, ANTIC operation is disabled, since it cannot fetch
 100 ** Display List instructions
 101 */
 102 #define DMACTL_DMA_FETCH       0x20
 103
 104
 105 /*****************************************************************************/
 106 /* CHACTL register options                                                   */
 107 /*****************************************************************************/
 108
 109 /* Initialized to 2 (CHACTL_CHAR_NORMAL | CHACTL_INV_PRESENT) */
 110
 111 /* Inverted (upside-down) characters */
 112 #define CHACTL_CHAR_NORMAL    0x00
 113 #define CHACTL_CHAR_INVERTED  0x04
 114
 115 /* Inverse (reverse-video) characters */
 116 #define CHACTL_INV_TRANS      0x00 /* chars with high-bit shown */
 117 #define CHACTL_INV_OPAQUE     0x01 /* chars with high-bit appear as space */
 118 #define CHACTL_INV_PRESENT    0x02 /* chars with high-bit are reverse-video */
 119
 120
 121 /*****************************************************************************/
 122 /* Values for NMIEN (enabling interrupts) & NMIST (cause for the interrupt)  */
 123 /*****************************************************************************/
 124
 125 /* Display List Interrupts
 126 ** Called on a modeline when "DL_DLI" bit is set the ANTIC instruction,
 127 ** and jumps through VDSLST vector.
 128 */
 129 #define NMIEN_DLI   0x80
 130
 131 /* Vertical Blank Interrupt
 132 ** Called during every vertical blank; see SYSVBV, VVBLKI, CRITIC, and VVBLKD,
 133 ** as well as the SETVBV routine.
 134 */
 135 #define NMIEN_VBI   0x40
 136
 137 /* [Reset] key pressed */
 138 #define NMIEN_RESET 0x20
 139
 140
 141 /*****************************************************************************/
 142 /* ANTIC instruction set                                                     */
 143 /*****************************************************************************/
 144
 145 /* Absolute instructions (non mode lines) */
 146 #define DL_JMP  ((unsigned char) 1)
 147 #define DL_JVB  ((unsigned char) 65)
 148
 149 #define DL_BLK1 ((unsigned char) 0)   /* 1 blank scanline */
 150 #define DL_BLK2 ((unsigned char) 16)  /* 2 blank scanlines */
 151 #define DL_BLK3 ((unsigned char) 32)  /* ...etc. */
 152 #define DL_BLK4 ((unsigned char) 48)
 153 #define DL_BLK5 ((unsigned char) 64)
 154 #define DL_BLK6 ((unsigned char) 80)
 155 #define DL_BLK7 ((unsigned char) 96)
 156 #define DL_BLK8 ((unsigned char) 112)
 157
 158
 159 /* Absolute instructions (mode lines) */
 160
 161 /* Note: Actual width varies (e.g., 40 vs 32 vs 48) depending on
 162 ** normal vs narrow vs wide (overscan) playfield setting; see DMACTL
 163 */
 164
 165 /* Character modes (text, tile graphics, etc.) */
 166
 167 /* monochrome, 40 character & 8 scanlines per mode line (aka Atari BASIC GRAPHICS 0 via OS's CIO routines) */
 168 #define DL_CHR40x8x1    ((unsigned char) 2)
 169
 170 /* monochrome, 40 character & 10 scanlines per mode line (like GR. 0, with descenders) */
 171 #define DL_CHR40x10x1   ((unsigned char) 3)
 172
 173 /* colour, 40 character & 8 scanlines per mode line (GR. 12) */
 174 #define DL_CHR40x8x4    ((unsigned char) 4)
 175
 176 /* colour, 40 character & 16 scanlines per mode line (GR. 13) */
 177 #define DL_CHR40x16x4   ((unsigned char) 5)
 178
 179 /* colour (duochrome per character), 20 character & 8 scanlines per mode line (GR. 1) */
 180 #define DL_CHR20x8x2    ((unsigned char) 6)
 181
 182 /* colour (duochrome per character), 20 character & 16 scanlines per mode line (GR. 2) */
 183 #define DL_CHR20x16x2   ((unsigned char) 7)
 184
 185
 186 /* Bitmap modes */
 187
 188 /* colour, 40 pixel & 8 scanlines per mode line (GR. 3) */
 189 #define DL_MAP40x8x4    ((unsigned char) 8)
 190
 191 /* 'duochrome', 80 pixel & 4 scanlines per mode line (GR.4) */
 192 #define DL_MAP80x4x2    ((unsigned char) 9)
 193
 194 /* colour, 80 pixel & 4 scanlines per mode line (GR.5) */
 195 #define DL_MAP80x4x4    ((unsigned char) 10)
 196
 197 /* 'duochrome', 160 pixel & 2 scanlines per mode line (GR.6) */
 198 #define DL_MAP160x2x2   ((unsigned char) 11)
 199
 200 /* 'duochrome', 160 pixel & 1 scanline per mode line (GR.14) */
 201 #define DL_MAP160x1x2   ((unsigned char) 12)
 202
 203 /* 4 colours, 160 pixel & 2 scanlines per mode line (GR.7) */
 204 #define DL_MAP160x2x4   ((unsigned char) 13)
 205
 206 /* 4 colours, 160 pixel & 1 scanline per mode line (GR.15) */
 207 #define DL_MAP160x1x4   ((unsigned char) 14)
 208
 209 /* monochrome, 320 pixel & 1 scanline per mode line (GR.8) */
 210 #define DL_MAP320x1x1   ((unsigned char) 15)
 211
 212
 213 /* Equivalents, for people familiar with Atari 8-bit OS */
 214
 215 #define DL_GRAPHICS0    DL_CHR40x8x1
 216 #define DL_GRAPHICS1    DL_CHR20x8x2
 217 #define DL_GRAPHICS2    DL_CHR20x16x2
 218 #define DL_GRAPHICS3    DL_MAP40x8x4
 219 #define DL_GRAPHICS4    DL_MAP80x4x2
 220 #define DL_GRAPHICS5    DL_MAP80x4x4
 221 #define DL_GRAPHICS6    DL_MAP160x2x2
 222 #define DL_GRAPHICS7    DL_MAP160x2x4
 223 #define DL_GRAPHICS8    DL_MAP320x1x1
 224 #define DL_GRAPHICS9    DL_MAP320x1x1  /* N.B.: GRAPHICS 9, 10, and 11 also involve GTIA's PRIOR register */
 225 #define DL_GRAPHICS10   DL_MAP320x1x1
 226 #define DL_GRAPHICS11   DL_MAP320x1x1
 227 #define DL_GRAPHICS12   DL_CHR40x8x4   /* N.B.: Atari 400/800 OS didn't have GRAPHICS 12 or 13 */
 228 #define DL_GRAPHICS13   DL_CHR40x16x4
 229 #define DL_GRAPHICS14   DL_MAP160x1x2
 230 #define DL_GRAPHICS15   DL_MAP160x1x4
 231
 232 /* Atari 400/800 OS didn't have GRAPHICS 14 or 15, so they were known by "6+" and "7+" */
 233 #define DL_GRAPHICS6PLUS DL_GRAPHICS14
 234 #define DL_GRAPHICS7PLUS DL_GRAPHICS15
 235
 236 /* Neither Atari 400/800 nor XL OS supported 10-scanline (descenders) text mode via CIO */
 237 #define DL_GRAPHICS0_DESCENDERS  DL_CHR40x10x1
 238
 239 /* Modifiers to mode lines */
 240 #define DL_HSCROL(x)    ((unsigned char)((x) | 16)) /* enable smooth horizontal scrolling on this line; see HSCROL */
 241 #define DL_VSCROL(x)    ((unsigned char)((x) | 32)) /* enable smooth vertical scrolling on this line; see VSCROL */
 242 #define DL_LMS(x)       ((unsigned char)((x) | 64)) /* Load Memory Scan (next two bytes must be the LSB/MSB of the data to load) */
 243
 244 /* General modifier */
 245 #define DL_DLI(x)       ((unsigned char)((x) | 128)) /* enable Display List Interrupt on this mode line */
 246
 247
 248 /* End of _antic.h */
 249 #endif /* #ifndef __ANTIC_H */