1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
|
/*
* viciitypes.h - A cycle-exact event-driven MOS6569 (VIC-II) emulation.
*
* Written by
* Ettore Perazzoli <ettore@comm2000.it>
* Andreas Boose <viceteam@t-online.de>
*
* DTV sections written by
* Hannu Nuotio <hannu.nuotio@tut.fi>
* Daniel Kahlin <daniel@kahlin.net>
*
* This file is part of VICE, the Versatile Commodore Emulator.
* See README for copyright notice.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
* 02111-1307 USA.
*
*/
#ifndef _VICIITYPES_H
#define _VICIITYPES_H
#include "raster.h"
#include "types.h"
/* Screen constants. */
#define VICII_SCREEN_XPIX 320
#define VICII_SCREEN_YPIX 200
#define VICII_SCREEN_TEXTCOLS 40
#define VICII_SCREEN_TEXTLINES 25
#define VICII_SCREEN_CHARHEIGHT 8
#define VICII_40COL_START_PIXEL vicii.screen_leftborderwidth
#define VICII_40COL_STOP_PIXEL (vicii.screen_leftborderwidth + VICII_SCREEN_XPIX)
/* these are one pixel 'off' on the DTV */
#define VICII_38COL_START_PIXEL (vicii.screen_leftborderwidth + 7 + vicii.viciidtv)
#define VICII_38COL_STOP_PIXEL (vicii.screen_leftborderwidth + 311 + vicii.viciidtv)
#define VICII_NUM_SPRITES 8
#define VICII_MAX_SPRITE_WIDTH 56 /* expanded sprite in bug area */
#define VICII_NUM_COLORS 16
#define VICIIDTV_NUM_COLORS 256
/* Available video modes. The number is given by
((vicii.regs[0x11] & 0x60) | (vicii.regs[0x16] & 0x10)) >> 4. */
/* Also for DTV:
| (vicii.regs[0x3c] & 0x04)<<1 | (vicii.regs[0x3c] & 0x01)<<3
+ FRED/FRED2, CHUNKY/PIXEL/ILLEGAL_LINEAR separation */
enum vicii_video_mode_s {
VICII_NORMAL_TEXT_MODE,
VICII_MULTICOLOR_TEXT_MODE,
VICII_HIRES_BITMAP_MODE,
VICII_MULTICOLOR_BITMAP_MODE,
VICII_EXTENDED_TEXT_MODE,
VICII_ILLEGAL_TEXT_MODE,
VICII_ILLEGAL_BITMAP_MODE_1,
VICII_ILLEGAL_BITMAP_MODE_2,
/* DTV modes */
VICII_8BPP_NORMAL_TEXT_MODE,
VICII_8BPP_MULTICOLOR_TEXT_MODE,
VICII_8BPP_HIRES_BITMAP_MODE, /* TODO: doesn't exist */
VICII_8BPP_MULTICOLOR_BITMAP_MODE,
VICII_8BPP_EXTENDED_TEXT_MODE,
VICII_8BPP_CHUNKY_MODE,
VICII_8BPP_TWO_PLANE_BITMAP_MODE,
VICII_8BPP_FRED_MODE,
VICII_8BPP_FRED2_MODE,
VICII_8BPP_PIXEL_CELL_MODE,
VICII_ILLEGAL_LINEAR_MODE,
VICII_IDLE_MODE, /* Special mode for idle state. */
VICII_NUM_VMODES /* valid for DTV only */
};
typedef enum vicii_video_mode_s vicii_video_mode_t;
#define VICII_IS_ILLEGAL_MODE(x) ((x) >= VICII_ILLEGAL_TEXT_MODE \
&& (x) <= VICII_ILLEGAL_BITMAP_MODE_2)
#define VICII_IS_BITMAP_MODE(x) ((x) & 0x02)
#define VICII_IS_TEXT_MODE(x) ((x) == VICII_NORMAL_TEXT_MODE \
|| (x) == VICII_MULTICOLOR_TEXT_MODE \
|| (x) == VICII_EXTENDED_TEXT_MODE)
/* The actual modes with modulo bug (possibly incomplete) */
/*
#define VICII_MODULO_BUG(x) ((x) == VICII_8BPP_FRED_MODE \
|| (x) == VICII_8BPP_FRED2_MODE \
|| (x) == VICII_ILLEGAL_TEXT_MODE \
|| (x) == VICII_8BPP_TWO_PLANE_BITMAP_MODE)
*/
/* Temporary list to keep all demos running correctly */
#define VICII_MODULO_BUG(x) ((x) == VICII_ILLEGAL_TEXT_MODE)
/* These timings are taken from the ``VIC Article'' by Christian Bauer
<bauec002@goofy.zdv.uni-mainz.de>. Thanks Christian!
Note: we measure cycles from 0 to 62, not from 1 to 63 as he does. */
/* Cycle # at which the VIC takes the bus in a bad line (BA goes low). */
#define VICII_FETCH_CYCLE 11
/* Delay for the raster line interrupt. This is not due to the VIC-II, since
it triggers the IRQ line at the beginning of the line, but to the 6510
that needs at least 2 cycles to detect it. */
#define VICII_RASTER_IRQ_DELAY 2
/* Current char being drawn by the raster. < 0 or >= VICII_SCREEN_TEXTCOLS
if outside the visible range. */
#define VICII_RASTER_CHAR(cycle) ((int)(cycle) - 15)
/* Current horizontal position (in pixels) of the raster. < 0 or >=
SCREEN_WIDTH if outside the visible range. */
#define VICII_RASTER_X(cycle) (((int)(cycle) - 17) * 8 + vicii.screen_leftborderwidth)
/* Adjusted RASTER_X position to account for -2 pixel difference on some
C64DTV stores */
#define VICIIDTV_RASTER_X_ADJ(cycle) (VICII_RASTER_X(cycle) - 2)
/* Current vertical position of the raster. Unlike `rasterline', which is
only accurate if a pending drawing event has been served, this is
guarranteed to be always correct. It is a bit slow, though. */
#define VICII_RASTER_Y(clk) ((unsigned int)((clk) \
/ vicii.cycles_per_line) \
% vicii.screen_height)
/* Cycle # within the current line. */
#define VICII_RASTER_CYCLE(clk) ((unsigned int)((clk) \
% vicii.cycles_per_line))
/* DTV Cycle # within the current line.
Handles the "hole" on PAL systems at cycles 54-55 and the 1 cycle shift */
#define VICIIDTV_RASTER_CYCLE(clk) ((unsigned int)( (((clk)-1) % vicii.cycles_per_line) + ((vicii.cycles_per_line == 63 && (((clk)-1) % vicii.cycles_per_line) > 53)?2:0)) )
/* `clk' value for the beginning of the current line. */
#define VICII_LINE_START_CLK(clk) (((clk) / vicii.cycles_per_line) \
* vicii.cycles_per_line)
/* # of the previous and next raster line. Handles wrap over. */
#define VICII_PREVIOUS_LINE(line) (((line) > 0) \
? (line) - 1 : vicii.screen_height - 1)
#define VICII_NEXT_LINE(line) (((line) + 1) % vicii.screen_height)
/* VIC-II structures. This is meant to be used by VIC-II modules
*exclusively*! */
struct vicii_light_pen_s {
int triggered;
int x, y;
};
typedef struct vicii_light_pen_s vicii_light_pen_t;
enum vicii_fetch_idx_s {
VICII_FETCH_MATRIX,
VICII_CHECK_SPRITE_DMA,
VICII_FETCH_SPRITE
};
typedef enum vicii_fetch_idx_s vicii_fetch_idx_t;
enum vicii_idle_data_location_s {
IDLE_NONE,
IDLE_3FFF,
IDLE_39FF
};
typedef enum vicii_idle_data_location_s vicii_idle_data_location_t;
struct idle_3fff_s {
CLOCK cycle;
BYTE value;
};
typedef struct idle_3fff_s idle_3fff_t;
struct alarm_s;
struct video_chip_cap_s;
struct vicii_s {
/* Flag: Are we initialized? */
int initialized; /* = 0; */
/* VIC-II raster. */
raster_t raster;
/* VIC-II registers. */
int regs[0x50];
/* DTV Linear Counters */
int counta;
int counta_mod;
int counta_step;
int countb;
int countb_mod;
int countb_step;
/* DTV Palette lookup */
BYTE dtvpalette[256];
/* DTV raster IRQ */
int raster_irq_offset;
int raster_irq_prevent;
/* Interrupt register. */
int irq_status; /* = 0; */
/* Line for raster compare IRQ. */
unsigned int raster_irq_line;
/* Pointer to the base of RAM seen by the VIC-II. */
/* address is base of 64k bank. vbank adds 0/16k/32k/48k to get actual
video address */
BYTE *ram_base_phi1; /* = VIC-II address during Phi1; */
BYTE *ram_base_phi2; /* = VIC-II address during Phi2; */
/* valid VIC-II address bits for Phi1 and Phi2. After masking
the address, it is or'd with the offset value to set always-1 bits */
WORD vaddr_mask_phi1; /* mask of valid address bits */
WORD vaddr_mask_phi2; /* mask of valid address bits */
WORD vaddr_offset_phi1; /* mask of address bits always set */
WORD vaddr_offset_phi2; /* mask of address bits always set */
/* Those two values determine where in the address space the chargen
ROM is mapped. Use mask=0x7000, value=0x1000 for the C64. */
WORD vaddr_chargen_mask_phi1; /* address bits to comp. for chargen */
WORD vaddr_chargen_mask_phi2; /* address bits to comp. for chargen */
WORD vaddr_chargen_value_phi1; /* compare value for chargen */
WORD vaddr_chargen_value_phi2; /* compare value for chargen */
/* Video memory pointers. Changed for drawing. */
BYTE *screen_ptr;
BYTE *chargen_ptr;
/* Pointer to the bitmap (lower part) */
BYTE *bitmap_low_ptr;
/* Pointer to the bitmap (higher part) */
BYTE *bitmap_high_ptr;
/* Video memory pointers. Changed immediately. */
BYTE *screen_base_phi1;
BYTE *screen_base_phi2;
/* Offset to the vbuf/cbuf buffer */
int buf_offset;
/* Screen memory buffers (chars and color). */
BYTE vbuf[VICII_SCREEN_TEXTCOLS];
BYTE cbuf[VICII_SCREEN_TEXTCOLS];
/* If this flag is set, bad lines (DMA's) can happen. */
int allow_bad_lines;
/* Sprite-sprite and sprite-background collision registers. */
BYTE sprite_sprite_collisions;
BYTE sprite_background_collisions;
/* Extended background colors (1, 2 and 3). */
int ext_background_color[3];
/* Current video mode. */
int video_mode;
/* Flag: are we in idle state? */
int idle_state;
/* Flag: should we force display (i.e. non-idle) state for the following
line? */
int force_display_state;
/* This flag is set if a memory fetch has already happened on the current
line. FIXME: Value of 2?... */
int memory_fetch_done;
/* Internal memory pointer (VCBASE). */
int memptr;
/* Internal memory counter (VC). */
int mem_counter;
/* Value to add to `mem_counter' after the graphics has been painted. */
int mem_counter_inc;
/* Flag: is the current line a `bad' line? */
int bad_line;
/* Flag: Check for raster.ycounter reset already done on this line?
(cycle 13) */
int ycounter_reset_checked;
/* Flag: Does the currently selected video mode force the overscan
background color to be black? (This happens with the hires bitmap and
illegal modes.) */
int force_black_overscan_background_color;
/* Background color source */
int background_color_source;
/* Light pen. */
vicii_light_pen_t light_pen;
/* Start of the memory bank seen by the VIC-II. */
int vbank_phi1; /* = 0; */
int vbank_phi2; /* = 0; */
/* Pointer to the start of the video bank. */
/* BYTE *vbank_ptr; - never used, only set */
/* Data to display in idle state. */
int idle_data;
/* left border idle data */
int idle_data_l[4];
/* middle idle data */
int idle_data_m[4];
/* right border idle data */
int idle_data_r[4];
/* Where do we currently fetch idle state from? If `IDLE_NONE', we are
not in idle state and thus do not need to update `idle_data'. */
vicii_idle_data_location_t idle_data_location;
/* All the VIC-II logging goes here. */
signed int log;
/* VIC-II alarms. */
struct alarm_s *raster_fetch_alarm;
struct alarm_s *raster_draw_alarm;
struct alarm_s *raster_irq_alarm;
/* What do we do when the `A_RASTERFETCH' event happens? */
vicii_fetch_idx_t fetch_idx;
/* Number of sprite being DMA fetched. */
unsigned int sprite_fetch_idx;
/* Mask for sprites being fetched at DMA. */
unsigned int sprite_fetch_msk;
/* Clock cycle for the next "raster fetch" alarm. */
CLOCK fetch_clk;
/* Clock cycle for the next "raster draw" alarm. */
CLOCK draw_clk;
/* Clock value for raster compare IRQ. */
CLOCK raster_irq_clk;
/* FIXME: Bad name. FIXME: Has to be initialized. */
CLOCK last_emulate_line_clk;
/* Clock cycle for the next sprite fetch. */
CLOCK sprite_fetch_clk;
/* Geometry and timing parameters of the selected VIC-II emulation. */
unsigned int screen_height;
int first_displayed_line;
int last_displayed_line;
unsigned int row_25_start_line;
unsigned int row_25_stop_line;
unsigned int row_24_start_line;
unsigned int row_24_stop_line;
int screen_leftborderwidth;
int screen_rightborderwidth;
int cycles_per_line;
int draw_cycle;
int sprite_fetch_cycle;
int sprite_wrap_x;
unsigned int first_dma_line;
unsigned int last_dma_line;
/* Flag backgroundcolor in hires mode or extended text mode. */
int get_background_from_vbuf;
/* Value to store before DMA. */
CLOCK store_clk;
WORD store_addr;
BYTE store_value;
/* Stores to 0x3fff idle location (used for idle sprite fetch). */
unsigned int num_idle_3fff;
idle_3fff_t *idle_3fff;
unsigned int num_idle_3fff_old;
idle_3fff_t *idle_3fff_old;
/* Flag: Enable VIC-IIe features. */
unsigned int viciie;
/* Flag: Enable DTV VIC-II features. */
unsigned int viciidtv;
/* VIC-IIe clock mode. */
unsigned int fastmode;
/* C128 2mhz cycle counter */
int half_cycles;
/* Last value read from VICII (used for RMW access). */
BYTE last_read;
/* Video chip capabilities. */
struct video_chip_cap_s *video_chip_cap;
unsigned int int_num;
/* Flag: DTV extended register enable */
unsigned int extended_enable;
/* Flag: DTV extended register lockout */
unsigned int extended_lockout;
/* Flag: DTV badline disable */
unsigned int badline_disable;
/* Flag: DTV colorfetch disable */
unsigned int colorfetch_disable;
/* Flag: DTV overscan */
unsigned int overscan;
/* Flag: DTV high color */
unsigned int high_color;
/* Flag: DTV border off */
unsigned int border_off;
/* Pointer to color ram */
BYTE *color_ram_ptr;
};
typedef struct vicii_s vicii_t;
extern vicii_t vicii;
/* Private function calls, used by the other VIC-II modules. */
extern void vicii_update_memory_ptrs(unsigned int cycle);
extern void vicii_update_video_mode(unsigned int cycle);
extern void vicii_raster_draw_alarm_handler(CLOCK offset, void *data);
extern void vicii_handle_pending_alarms(int num_write_cycles);
extern void vicii_delay_clk(void);
extern void vicii_delay_oldclk(CLOCK num);
/* Debugging options. */
/* #define VICII_VMODE_DEBUG */
/* #define VICII_RASTER_DEBUG */
/* #define VICII_REGISTERS_DEBUG */
#ifdef VICII_VMODE_DEBUG
#define VICII_DEBUG_VMODE(x) log_debug x
#else
#define VICII_DEBUG_VMODE(x)
#endif
#ifdef VICII_RASTER_DEBUG
#define VICII_DEBUG_RASTER(x) log_debug x
#else
#define VICII_DEBUG_RASTER(x)
#endif
#ifdef VICII_REGISTERS_DEBUG
#define VICII_DEBUG_REGISTER(x) log_debug x
#else
#define VICII_DEBUG_REGISTER(x)
#endif
#endif
|