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 is responsible for the generation of playfield graphics which is   */
   9 /* delivered as a datastream to the related CTIA/GTIA chip. The CTIA/GTIA    */
  10 /* provides the coloring of the playfield graphics, and is responsible for   */
  11 /* adding overlaid sprites referred to as "Player/Missile graphics" by       */
  12 /* Atari.  Atari advertised it as a true microprocessor, in that it has an   */
  13 /* instruction set to run programs (called display lists) to process data.   */
  14 /* ANTIC has no capacity for writing back computed values to memory, it      */
  15 /* merely reads data from memory and processes it for output to the screen,  */
  16 /* therefore it is not Turing complete." - Wikipedia article on "ANTIC"      */
  17 /*                                                                           */
  18 /* (C) 2000 Freddy Offenga <taf_offenga@yahoo.com>                           */
  19 /* 24-Jan-2011: Christian Krueger: Added defines for Antic instruction set   */
  20 /* 2019-01-12: Bill Kendrick <nbs@sonic.net>: More defines for registers     */
  21 /*                                                                           */
  22 /*                                                                           */
  23 /* This software is provided 'as-is', without any expressed or implied       */
  24 /* warranty.  In no event will the authors be held liable for any damages    */
  25 /* arising from the use of this software.                                    */
  26 /*                                                                           */
  27 /* Permission is granted to anyone to use this software for any purpose,     */
  28 /* including commercial applications, and to alter it and redistribute it    */
  29 /* freely, subject to the following restrictions:                            */
  30 /*                                                                           */
  31 /* 1. The origin of this software must not be misrepresented; you must not   */
  32 /*    claim that you wrote the original software. If you use this software   */
  33 /*    in a product, an acknowledgment in the product documentation would be  */
  34 /*    appreciated but is not required.                                       */
  35 /* 2. Altered source versions must be plainly marked as such, and must not   */
  36 /*    be misrepresented as being the original software.                      */
  37 /* 3. This notice may not be removed or altered from any source              */
  38 /*    distribution.                                                          */
  39 /*                                                                           */
  40 /*****************************************************************************/
  41
  42
  43 #ifndef __ANTIC_H
  44 #define __ANTIC_H
  45
  46 /* Define a structure with the ANTIC coprocessor's register offsets */
  47 struct __antic {
  48     unsigned char   dmactl; /* (W) direct memory access control */
  49
  50 /* Playfield modes: */
  51 #define DMACTL_PLAYFIELD_NONE     0x00
  52 #define DMACTL_PLAYFIELD_NARROW   0x01 /* e.g., 32 bytes per scanline with thick borders */
  53 #define DMACTL_PLAYFIELD_NORMAL   0x02 /* e.g., 40 bytes per scanline with normal borders */
  54 #define DMACTL_PLAYFIELD_WIDE     0x03 /* e.g., 48 bytes per scanline with no borders (overscan) */
  55 /* Other options: */
  56 #define DMACTL_DMA_MISSILES    0x04 /* if not set, GTIA's GRAFP0 thru GRAFP3 used for player shapes; if set, ANTIC's PMBASE will be used to fetch shapes via DMA */
  57 #define DMACTL_DMA_PLAYERS     0x08 /* (ditto, using GTIA's GRAFM for missile shapes...) */
  58 #define DMACTL_PMG_SINGLELINE  0x10 /* if not set, default is double-scanline resolution PMGs */
  59 #define DMACTL_DMA_FETCH       0x20 /* if not set, disables ANTIC operation since it cannot fetch Display List instructions */
  60 /* Initialized to 0x22 (DMA fetch, normal playfield, no PMG DMA, double-line PMGs) */
  61
  62
  63     unsigned char   chactl; /* (W) character mode control */
  64
  65 /* Inverted (upside-down) characters */
  66 #define CHACTL_CHAR_NORMAL    0x00
  67 #define CHACTL_CHAR_INVERTED  0x04
  68 /* Inverse (reverse-video) characters */
  69 #define CHACTL_INV_TRANS      0x00 /* chars with high-bit shown */
  70 #define CHACTL_INV_OPAQUE     0x01 /* chars with high-bit appear as space */
  71 #define CHACTL_INV_PRESENT    0x02 /* chars with high-bit are reverse-video */
  72 /* N.B. Default is "CHACTL_CHAR_NORMAL | CHACTL_INV_PRESENT", aka decimal 2 */
  73
  74
  75     unsigned char   dlistl; /* display list pointer low-byte */
  76     unsigned char   dlisth; /* display list pointer high-byte */
  77     unsigned char   hscrol; /* (W) horizontal scroll enable */
  78     unsigned char   vscrol; /* (W) vertical scroll enable */
  79     unsigned char   unuse0; /* unused */
  80     unsigned char   pmbase; /* (W) msb of p/m base address (for when DMACTL has player and/or missile DMA enabled) */
  81     unsigned char   unuse1; /* unused */
  82     unsigned char   chbase; /* (W) character set base address */
  83     unsigned char   wsync;  /* (W) wait for horizontal synchronization */
  84     unsigned char   vcount; /* (R) vertical line counter */
  85     unsigned char   penh;   /* (R) light pen horizontal position */
  86     unsigned char   penv;   /* (R) light pen vertical position */
  87
  88     unsigned char   nmien;  /* (W) non-maskable interrupt enable */
  89
  90 /* NMIEN settings: */
  91 #define NMIEN_DLI   0x80 /* see also: DL_DLI */
  92 #define NMIEN_VBI   0x40
  93 #define NMIEN_RESET 0x20
  94
  95     unsigned char   nmires; /* (W) ("NMIRES") nmi reset; (R) ("NMIST") nmi status */
  96 };
  97
  98
  99 /* ANTIC instruction set */
 100
 101 /* Absolute instructions (non mode lines) */
 102 #define DL_JMP  ((unsigned char) 1)
 103 #define DL_JVB  ((unsigned char) 65)
 104
 105 #define DL_BLK1 ((unsigned char) 0)   /* 1 blank scanline */
 106 #define DL_BLK2 ((unsigned char) 16)  /* 2 blank scanlines */
 107 #define DL_BLK3 ((unsigned char) 32)  /* ...etc. */
 108 #define DL_BLK4 ((unsigned char) 48)
 109 #define DL_BLK5 ((unsigned char) 64)
 110 #define DL_BLK6 ((unsigned char) 80)
 111 #define DL_BLK7 ((unsigned char) 96)
 112 #define DL_BLK8 ((unsigned char) 112)
 113
 114 /* Absolute instructions (mode lines) */
 115 /* Note: Actual width varies (e.g., 40 vs 32 vs 48) depending on normal vs narrow vs wide (overscan) playfield setting; see DMACTL */
 116
 117 /* Character modes (text, tile graphics, etc.) */
 118 #define DL_CHR40x8x1    ((unsigned char) 2)      /* monochrome, 40 character & 8 scanlines per mode line (aka Atari BASIC GRAPHICS 0 via OS's CIO routines) */
 119 #define DL_CHR40x10x1   ((unsigned char) 3)      /* monochrome, 40 character & 10 scanlines per mode line (like GR. 0, with descenders) */
 120 #define DL_CHR40x8x4    ((unsigned char) 4)      /* colour, 40 character & 8 scanlines per mode line (GR. 12) */
 121 #define DL_CHR40x16x4   ((unsigned char) 5)      /* colour, 40 character & 16 scanlines per mode line (GR. 13) */
 122 #define DL_CHR20x8x2    ((unsigned char) 6)      /* colour (duochrome per character), 20 character & 8 scanlines per mode line (GR. 1) */
 123 #define DL_CHR20x16x2   ((unsigned char) 7)      /* colour (duochrome per character), 20 character & 16 scanlines per mode line (GR. 2) */
 124
 125 /* Bitmap modes */
 126 #define DL_MAP40x8x4    ((unsigned char) 8)      /* colour, 40 pixel & 8 scanlines per mode line (GR. 3) */
 127 #define DL_MAP80x4x2    ((unsigned char) 9)      /* 'duochrome', 80 pixel & 4 scanlines per mode line (GR.4) */
 128 #define DL_MAP80x4x4    ((unsigned char) 10)     /* colour, 80 pixel & 4 scanlines per mode line (GR.5) */
 129 #define DL_MAP160x2x2   ((unsigned char) 11)     /* 'duochrome', 160 pixel & 2 scanlines per mode line (GR.6) */
 130 #define DL_MAP160x1x2   ((unsigned char) 12)     /* 'duochrome', 160 pixel & 1 scanline per mode line (GR.14) */
 131 #define DL_MAP160x2x4   ((unsigned char) 13)     /* 4 colours, 160 pixel & 2 scanlines per mode line (GR.7) */
 132 #define DL_MAP160x1x4   ((unsigned char) 14)     /* 4 colours, 160 pixel & 1 scanline per mode line (GR.15) */
 133 #define DL_MAP320x1x1   ((unsigned char) 15)     /* monochrome, 320 pixel & 1 scanline per mode line (GR.8) */
 134
 135 /* Equivalents, for people familiar with Atari 8-bit OS */
 136 #define DL_GRAPHICS0    DL_CHR40x8x1
 137 #define DL_GRAPHICS1    DL_CHR20x8x2
 138 #define DL_GRAPHICS2    DL_CHR20x16x2
 139 #define DL_GRAPHICS3    DL_MAP40x8x4
 140 #define DL_GRAPHICS4    DL_MAP80x4x2
 141 #define DL_GRAPHICS5    DL_MAP80x4x4
 142 #define DL_GRAPHICS6    DL_MAP160x2x2
 143 #define DL_GRAPHICS7    DL_MAP160x2x4
 144 #define DL_GRAPHICS8    DL_MAP320x1x1
 145 #define DL_GRAPHICS9    DL_MAP320x1x1  /* N.B.: GRAPHICS 9, 10, and 11 also involve GTIA's PRIOR register */
 146 #define DL_GRAPHICS10   DL_MAP320x1x1
 147 #define DL_GRAPHICS11   DL_MAP320x1x1
 148 #define DL_GRAPHICS12   DL_CHR40x8x4   /* N.B.: Atari 400/800 OS didn't have GRAPHICS 12 or 13 */
 149 #define DL_GRAPHICS13   DL_CHR40x16x4
 150 #define DL_GRAPHICS14   DL_MAP160x1x2
 151 #define DL_GRAPHICS15   DL_MAP160x1x4
 152
 153 /* Atari 400/800 OS didn't have GRAPHICS 14 or 15, so they were known by "6+" and "7+" */
 154 #define DL_GRAPHICS6PLUS DL_GRAPHICS14
 155 #define DL_GRAPHICS7PLUS DL_GRAPHICS15
 156
 157 /* Neither Atari 400/800 nor XL OS supported 10-scanline (descenders) text mode via CIO */
 158 #define DL_GRAPHICS0_DESCENDERS  DL_CHR40x10x1
 159
 160 /* Modifiers to mode lines */
 161 #define DL_HSCROL(x)    ((unsigned char)((x) | 16)) /* enable smooth horizontal scrolling on this line; see HSCROL */
 162 #define DL_VSCROL(x)    ((unsigned char)((x) | 32)) /* enable smooth vertical scrolling on this line; see VSCROL */
 163 #define DL_LMS(x)       ((unsigned char)((x) | 64)) /* Load Memory Scan (next two bytes must be the LSB/MSB of the data to load */
 164
 165 /* General modifier */
 166 #define DL_DLI(x)       ((unsigned char)((x) | 128)) /* enable Display List Interrupt on this mode line; requires NMIEN set to enable DLIs */
 167
 168
 169 /* Macros for the beginning and end of functions used as Display List Interrupts */
 170 #define DLI_START asm("pha"); asm("txa"); asm("pha"); asm("tya"); asm("pha");
 171 #define DLI_END asm("pla"); asm("tay"); asm("pla"); asm("tax"); asm("pla"); asm("rti");
 172
 173 /* End of _antic.h */
 174 #endif /* #ifndef __ANTIC_H */