1 /*****************************************************************************/
5 /* Internal include file, do not use directly */
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) */
19 /* (C) 2000 Freddy Offenga <taf_offenga@yahoo.com> */
20 /* 24-Jan-2011: Christian Krueger: Added defines for Antic instruction set */
21 /* 2019-01-12: Bill Kendrick <nbs@sonic.net>: More defines for registers */
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. */
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: */
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 */
41 /*****************************************************************************/
47 /* Define a structure with the ANTIC coprocessor's register offsets */
49 unsigned char dmactl; /* (W) direct memory access control */
51 /* Playfield modes: */
52 #define DMACTL_PLAYFIELD_NONE 0x00
53 #define DMACTL_PLAYFIELD_NARROW 0x01 /* e.g., 32 bytes per scanline with thick borders */
54 #define DMACTL_PLAYFIELD_NORMAL 0x02 /* e.g., 40 bytes per scanline with normal borders */
55 #define DMACTL_PLAYFIELD_WIDE 0x03 /* e.g., 48 bytes per scanline with no borders (overscan) */
57 #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 */
58 #define DMACTL_DMA_PLAYERS 0x08 /* (ditto, using GTIA's GRAFM for missile shapes...) */
59 #define DMACTL_PMG_SINGLELINE 0x10 /* if not set, default is double-scanline resolution PMGs */
60 #define DMACTL_DMA_FETCH 0x20 /* if not set, disables ANTIC operation since it cannot fetch Display List instructions */
61 /* Initialized to 0x22 (DMA fetch, normal playfield, no PMG DMA, double-line PMGs) */
64 unsigned char chactl; /* (W) character mode control */
66 /* Inverted (upside-down) characters */
67 #define CHACTL_CHAR_NORMAL 0x00
68 #define CHACTL_CHAR_INVERTED 0x04
69 /* Inverse (reverse-video) characters */
70 #define CHACTL_INV_TRANS 0x00 /* chars with high-bit shown */
71 #define CHACTL_INV_OPAQUE 0x01 /* chars with high-bit appear as space */
72 #define CHACTL_INV_PRESENT 0x02 /* chars with high-bit are reverse-video */
73 /* N.B. Default is "CHACTL_CHAR_NORMAL | CHACTL_INV_PRESENT", aka decimal 2 */
76 unsigned char dlistl; /* display list pointer low-byte */
77 unsigned char dlisth; /* display list pointer high-byte */
78 unsigned char hscrol; /* (W) horizontal scroll enable */
79 unsigned char vscrol; /* (W) vertical scroll enable */
80 unsigned char unuse0; /* unused */
81 unsigned char pmbase; /* (W) msb of p/m base address (for when DMACTL has player and/or missile DMA enabled) */
82 unsigned char unuse1; /* unused */
83 unsigned char chbase; /* (W) character set base address */
84 unsigned char wsync; /* (W) wait for horizontal synchronization */
85 unsigned char vcount; /* (R) vertical line counter */
86 unsigned char penh; /* (R) light pen horizontal position */
87 unsigned char penv; /* (R) light pen vertical position */
89 unsigned char nmien; /* (W) non-maskable interrupt enable */
92 #define NMIEN_DLI 0x80 /* see also: DL_DLI */
93 #define NMIEN_VBI 0x40
94 #define NMIEN_RESET 0x20
96 unsigned char nmires; /* (W) ("NMIRES") nmi reset; (R) ("NMIST") nmi status */
100 /* ANTIC instruction set */
102 /* Absolute instructions (non mode lines) */
103 #define DL_JMP ((unsigned char) 1)
104 #define DL_JVB ((unsigned char) 65)
106 #define DL_BLK1 ((unsigned char) 0) /* 1 blank scanline */
107 #define DL_BLK2 ((unsigned char) 16) /* 2 blank scanlines */
108 #define DL_BLK3 ((unsigned char) 32) /* ...etc. */
109 #define DL_BLK4 ((unsigned char) 48)
110 #define DL_BLK5 ((unsigned char) 64)
111 #define DL_BLK6 ((unsigned char) 80)
112 #define DL_BLK7 ((unsigned char) 96)
113 #define DL_BLK8 ((unsigned char) 112)
115 /* Absolute instructions (mode lines) */
116 /* Note: Actual width varies (e.g., 40 vs 32 vs 48) depending on normal vs narrow vs wide (overscan) playfield setting; see DMACTL */
118 /* Character modes (text, tile graphics, etc.) */
119 #define DL_CHR40x8x1 ((unsigned char) 2) /* monochrome, 40 character & 8 scanlines per mode line (aka Atari BASIC GRAPHICS 0 via OS's CIO routines) */
120 #define DL_CHR40x10x1 ((unsigned char) 3) /* monochrome, 40 character & 10 scanlines per mode line (like GR. 0, with descenders) */
121 #define DL_CHR40x8x4 ((unsigned char) 4) /* colour, 40 character & 8 scanlines per mode line (GR. 12) */
122 #define DL_CHR40x16x4 ((unsigned char) 5) /* colour, 40 character & 16 scanlines per mode line (GR. 13) */
123 #define DL_CHR20x8x2 ((unsigned char) 6) /* colour (duochrome per character), 20 character & 8 scanlines per mode line (GR. 1) */
124 #define DL_CHR20x16x2 ((unsigned char) 7) /* colour (duochrome per character), 20 character & 16 scanlines per mode line (GR. 2) */
127 #define DL_MAP40x8x4 ((unsigned char) 8) /* colour, 40 pixel & 8 scanlines per mode line (GR. 3) */
128 #define DL_MAP80x4x2 ((unsigned char) 9) /* 'duochrome', 80 pixel & 4 scanlines per mode line (GR.4) */
129 #define DL_MAP80x4x4 ((unsigned char) 10) /* colour, 80 pixel & 4 scanlines per mode line (GR.5) */
130 #define DL_MAP160x2x2 ((unsigned char) 11) /* 'duochrome', 160 pixel & 2 scanlines per mode line (GR.6) */
131 #define DL_MAP160x1x2 ((unsigned char) 12) /* 'duochrome', 160 pixel & 1 scanline per mode line (GR.14) */
132 #define DL_MAP160x2x4 ((unsigned char) 13) /* 4 colours, 160 pixel & 2 scanlines per mode line (GR.7) */
133 #define DL_MAP160x1x4 ((unsigned char) 14) /* 4 colours, 160 pixel & 1 scanline per mode line (GR.15) */
134 #define DL_MAP320x1x1 ((unsigned char) 15) /* monochrome, 320 pixel & 1 scanline per mode line (GR.8) */
136 /* Equivalents, for people familiar with Atari 8-bit OS */
137 #define DL_GRAPHICS0 DL_CHR40x8x1
138 #define DL_GRAPHICS1 DL_CHR20x8x2
139 #define DL_GRAPHICS2 DL_CHR20x16x2
140 #define DL_GRAPHICS3 DL_MAP40x8x4
141 #define DL_GRAPHICS4 DL_MAP80x4x2
142 #define DL_GRAPHICS5 DL_MAP80x4x4
143 #define DL_GRAPHICS6 DL_MAP160x2x2
144 #define DL_GRAPHICS7 DL_MAP160x2x4
145 #define DL_GRAPHICS8 DL_MAP320x1x1
146 #define DL_GRAPHICS9 DL_MAP320x1x1 /* N.B.: GRAPHICS 9, 10, and 11 also involve GTIA's PRIOR register */
147 #define DL_GRAPHICS10 DL_MAP320x1x1
148 #define DL_GRAPHICS11 DL_MAP320x1x1
149 #define DL_GRAPHICS12 DL_CHR40x8x4 /* N.B.: Atari 400/800 OS didn't have GRAPHICS 12 or 13 */
150 #define DL_GRAPHICS13 DL_CHR40x16x4
151 #define DL_GRAPHICS14 DL_MAP160x1x2
152 #define DL_GRAPHICS15 DL_MAP160x1x4
154 /* Atari 400/800 OS didn't have GRAPHICS 14 or 15, so they were known by "6+" and "7+" */
155 #define DL_GRAPHICS6PLUS DL_GRAPHICS14
156 #define DL_GRAPHICS7PLUS DL_GRAPHICS15
158 /* Neither Atari 400/800 nor XL OS supported 10-scanline (descenders) text mode via CIO */
159 #define DL_GRAPHICS0_DESCENDERS DL_CHR40x10x1
161 /* Modifiers to mode lines */
162 #define DL_HSCROL(x) ((unsigned char)((x) | 16)) /* enable smooth horizontal scrolling on this line; see HSCROL */
163 #define DL_VSCROL(x) ((unsigned char)((x) | 32)) /* enable smooth vertical scrolling on this line; see VSCROL */
164 #define DL_LMS(x) ((unsigned char)((x) | 64)) /* Load Memory Scan (next two bytes must be the LSB/MSB of the data to load */
166 /* General modifier */
167 #define DL_DLI(x) ((unsigned char)((x) | 128)) /* enable Display List Interrupt on this mode line; requires NMIEN set to enable DLIs */
170 /* Macros for the beginning and end of functions used as Display List Interrupts */
171 #define DLI_START asm("pha"); asm("txa"); asm("pha"); asm("tya"); asm("pha");
172 #define DLI_END asm("pla"); asm("tay"); asm("pla"); asm("tax"); asm("pla"); asm("rti");
174 /* End of _antic.h */
175 #endif /* #ifndef __ANTIC_H */