3 * Central switchboard for the system. This pulls all the individual modules
4 * together into some kind of coherent structure. This is also where you'd
5 * add Naomi support, if I ever get a board to play with...
7 * Copyright (c) 2005 Nathan Keynes.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
27 #include "dreamcast.h"
31 #include "aica/aica.h"
32 #include "gdrom/ide.h"
33 #include "maple/maple.h"
34 #include "pvr2/pvr2.h"
36 #include "sh4/sh4core.h"
37 #include "vmu/vmulist.h"
40 * Current state of the DC virtual machine
42 typedef enum { STATE_UNINIT=0, STATE_RUNNING,
43 STATE_STOPPING, STATE_STOPPED } dreamcast_state_t;
45 static volatile dreamcast_state_t dreamcast_state = STATE_UNINIT;
46 static gboolean dreamcast_has_bios = FALSE;
47 static gboolean dreamcast_has_flash = FALSE;
48 static gboolean dreamcast_exit_on_stop = FALSE;
49 static gchar *dreamcast_program_name = NULL;
50 static sh4addr_t dreamcast_entry_point = 0xA0000000;
51 static uint32_t timeslice_length = DEFAULT_TIMESLICE_LENGTH;
52 static uint64_t run_time_nanosecs = 0;
53 static unsigned int quick_save_state = -1;
55 #define MAX_MODULES 32
56 static int num_modules = 0;
57 dreamcast_module_t modules[MAX_MODULES];
60 * The unknown module is used for logging files without an actual module
63 struct dreamcast_module unknown_module = { "****", NULL, NULL, NULL, NULL,
66 extern struct mem_region_fn mem_region_sdram;
67 extern struct mem_region_fn mem_region_vram32;
68 extern struct mem_region_fn mem_region_vram64;
69 extern struct mem_region_fn mem_region_audioram;
70 extern struct mem_region_fn mem_region_audioscratch;
71 extern struct mem_region_fn mem_region_flashram;
72 extern struct mem_region_fn mem_region_bootrom;
73 extern struct mem_region_fn mem_region_pvr2ta;
74 extern struct mem_region_fn mem_region_pvr2yuv;
75 extern struct mem_region_fn mem_region_pvr2vdma1;
76 extern struct mem_region_fn mem_region_pvr2vdma2;
78 unsigned char dc_main_ram[16 MB];
79 unsigned char dc_boot_rom[2 MB];
80 unsigned char dc_flash_ram[128 KB];
83 * This function is responsible for defining how all the pieces of the
84 * dreamcast actually fit together.
86 * Note currently the locations of the various MMIO pages are hard coded in
87 * the MMIO definitions - they should probably be moved here.
89 void dreamcast_configure( )
91 char *bios_path = lxdream_get_global_config_path_value(CONFIG_BIOS_PATH);
92 char *flash_path = lxdream_get_global_config_path_value(CONFIG_FLASH_PATH);
94 dreamcast_register_module( &eventq_module );
95 /* Register the memory framework */
96 dreamcast_register_module( &mem_module );
98 /* Setup standard memory map */
99 mem_map_region( dc_boot_rom, 0x00000000, 2 MB, MEM_REGION_BIOS, &mem_region_bootrom, MEM_FLAG_ROM, 2 MB, 0 );
100 mem_map_region( dc_flash_ram, 0x00200000, 128 KB, MEM_REGION_FLASH, &mem_region_flashram, MEM_FLAG_RAM, 128 KB, 0 );
101 mem_map_region( aica_main_ram, 0x00800000, 2 MB, MEM_REGION_AUDIO, &mem_region_audioram, MEM_FLAG_RAM, 2 MB, 0 );
102 mem_map_region( aica_scratch_ram,0x00703000, 8 KB, MEM_REGION_AUDIO_SCRATCH,&mem_region_audioscratch, MEM_FLAG_RAM, 8 KB, 0 );
103 mem_map_region( NULL, 0x04000000, 8 MB, MEM_REGION_VIDEO64, &mem_region_vram64, 0, 8 MB, 0 );
104 mem_map_region( pvr2_main_ram, 0x05000000, 8 MB, MEM_REGION_VIDEO, &mem_region_vram32, MEM_FLAG_RAM, 8 MB, 0 );
105 mem_map_region( dc_main_ram, 0x0C000000, 16 MB, MEM_REGION_MAIN, &mem_region_sdram, MEM_FLAG_RAM, 0x01000000, 0x0F000000 );
106 mem_map_region( NULL, 0x10000000, 8 MB, MEM_REGION_PVR2TA, &mem_region_pvr2ta, 0, 0x02000000, 0x12000000 );
107 mem_map_region( NULL, 0x10800000, 8 MB, MEM_REGION_PVR2YUV, &mem_region_pvr2yuv, 0, 0x02000000, 0x12800000 );
108 mem_map_region( NULL, 0x11000000, 16 MB, MEM_REGION_PVR2VDMA1, &mem_region_pvr2vdma1, 0, 16 MB, 0 );
109 mem_map_region( NULL, 0x13000000, 16 MB, MEM_REGION_PVR2VDMA2, &mem_region_pvr2vdma2, 0, 16 MB, 0 );
111 dreamcast_has_bios = mem_load_rom( dc_boot_rom, bios_path, 2 MB, 0x89f2b1a1 );
112 if( flash_path != NULL && flash_path[0] != '\0' ) {
113 mem_load_block( flash_path, 0x00200000, 0x00020000 );
115 dreamcast_has_flash = TRUE;
117 /* Load in the rest of the core modules */
118 dreamcast_register_module( &sh4_module );
119 dreamcast_register_module( &asic_module );
120 dreamcast_register_module( &pvr2_module );
121 dreamcast_register_module( &aica_module );
122 dreamcast_register_module( &maple_module );
123 dreamcast_register_module( &ide_module );
129 gboolean dreamcast_load_bios( const gchar *filename )
131 dreamcast_has_bios = mem_load_rom( dc_boot_rom, filename, 2 MB, 0x89f2b1a1 );
132 return dreamcast_has_bios;
135 gboolean dreamcast_load_flash( const gchar *filename )
137 if( filename != NULL && filename[0] != '\0' ) {
138 return mem_load_block( filename, 0x00200000, 0x00020000 ) == 0;
144 gboolean dreamcast_config_changed(void *data, struct lxdream_config_group *group, unsigned item,
145 const gchar *oldval, const gchar *newval)
149 case CONFIG_BIOS_PATH:
150 tmp = get_expanded_path(newval);
151 dreamcast_load_bios(tmp);
154 case CONFIG_FLASH_PATH:
155 tmp = get_expanded_path(newval);
156 dreamcast_load_flash(tmp);
164 void dreamcast_save_flash()
166 if( dreamcast_has_flash ) {
167 char *file = lxdream_get_global_config_path_value(CONFIG_FLASH_PATH);
168 mem_save_block( file, 0x00200000, 0x00020000 );
174 * Constructs a system configuration for the AICA in standalone mode,
175 * ie sound chip only.
177 void dreamcast_configure_aica_only( )
179 dreamcast_register_module( &mem_module );
180 mem_map_region( aica_main_ram, 0x00800000, 2 MB, MEM_REGION_AUDIO, &mem_region_audioram, MEM_FLAG_RAM, 2 MB, 0 );
181 mem_map_region( aica_scratch_ram, 0x00703000, 8 KB, MEM_REGION_AUDIO_SCRATCH, &mem_region_audioscratch, MEM_FLAG_RAM, 8 KB, 0 );
182 dreamcast_register_module( &aica_module );
184 dreamcast_state = STATE_STOPPED;
187 void dreamcast_register_module( dreamcast_module_t module )
189 modules[num_modules++] = module;
190 if( module->init != NULL )
194 void dreamcast_set_run_time( uint32_t secs, uint32_t nanosecs )
196 run_time_nanosecs = (((uint64_t)secs) * 1000000000) + nanosecs;
199 void dreamcast_set_exit_on_stop( gboolean flag )
201 dreamcast_exit_on_stop = flag;
204 void dreamcast_init( void )
206 dreamcast_configure();
207 dreamcast_state = STATE_STOPPED;
210 void dreamcast_reset( void )
212 sh4_core_exit(CORE_EXIT_SYSRESET);
214 for( i=0; i<num_modules; i++ ) {
215 if( modules[i]->reset != NULL )
220 void dreamcast_run( void )
224 if( !dreamcast_can_run() ) {
225 ERROR(_("No program is loaded, and no BIOS is configured (required to boot a CD image). To continue, either load a binary program, or set the path to your BIOS file in the Path Preferences"));
229 if( dreamcast_state != STATE_RUNNING ) {
230 for( i=0; i<num_modules; i++ ) {
231 if( modules[i]->start != NULL )
236 if( maple_should_grab() ) {
237 gui_set_use_grab(TRUE);
240 dreamcast_state = STATE_RUNNING;
242 if( run_time_nanosecs != 0 ) {
243 while( dreamcast_state == STATE_RUNNING ) {
244 uint32_t time_to_run = timeslice_length;
245 if( run_time_nanosecs < time_to_run ) {
246 time_to_run = (uint32_t)run_time_nanosecs;
249 for( i=0; i<num_modules; i++ ) {
250 if( modules[i]->run_time_slice != NULL )
251 time_to_run = modules[i]->run_time_slice( time_to_run );
254 if( run_time_nanosecs > time_to_run ) {
255 run_time_nanosecs -= time_to_run;
257 run_time_nanosecs = 0; // Finished
262 while( dreamcast_state == STATE_RUNNING ) {
263 int time_to_run = timeslice_length;
264 for( i=0; i<num_modules; i++ ) {
265 if( modules[i]->run_time_slice != NULL )
266 time_to_run = modules[i]->run_time_slice( time_to_run );
272 gui_set_use_grab(FALSE);
274 for( i=0; i<num_modules; i++ ) {
275 if( modules[i]->stop != NULL )
280 dreamcast_state = STATE_STOPPED;
282 if( dreamcast_exit_on_stop ) {
283 dreamcast_shutdown();
288 void dreamcast_stop( void )
290 sh4_core_exit(CORE_EXIT_HALT); // returns only if not inside SH4 core
291 if( dreamcast_state == STATE_RUNNING )
292 dreamcast_state = STATE_STOPPING;
295 void dreamcast_shutdown()
297 // Don't do a dreamcast_stop - if we're calling this out of SH4 code,
298 // it's a shutdown-and-quit event
299 if( dreamcast_state == STATE_RUNNING )
300 dreamcast_state = STATE_STOPPING;
301 dreamcast_save_flash();
303 #ifdef ENABLE_SH4STATS
304 sh4_stats_print(stdout);
308 void dreamcast_program_loaded( const gchar *name, sh4addr_t entry_point )
310 if( dreamcast_program_name != NULL ) {
311 g_free(dreamcast_program_name);
313 dreamcast_program_name = g_strdup(name);
314 dreamcast_entry_point = entry_point;
315 sh4_set_pc(entry_point);
316 sh4_write_sr( sh4_read_sr() & (~SR_BL) ); /* Unmask interrupts */
322 gboolean dreamcast_is_running( void )
324 return dreamcast_state == STATE_RUNNING;
327 gboolean dreamcast_can_run(void)
329 return dreamcast_state != STATE_UNINIT &&
330 (dreamcast_has_bios || dreamcast_program_name != NULL);
333 /********************************* Save States *****************************/
335 struct save_state_header {
338 uint32_t module_count;
341 struct chunk_header {
342 char marker[4]; /* Always BLCK */
343 char name[8]; /* Block (module) name */
344 uint32_t block_length;
348 * Check the save state header to ensure that it is a valid, supported
350 * @return the number of blocks following, or 0 if the file is invalid.
352 int dreamcast_read_save_state_header( FILE *f, char *error, int errorlen )
354 struct save_state_header header;
355 if( fread( &header, sizeof(header), 1, f ) != 1 ) {
358 if( strncmp( header.magic, DREAMCAST_SAVE_MAGIC, 16 ) != 0 ) {
360 snprintf( error, errorlen, _("File is not a %s save state"), APP_NAME );
363 if( header.version != DREAMCAST_SAVE_VERSION ) {
365 snprintf( error, errorlen, _("Unsupported %s save state version"), APP_NAME );
368 if( header.module_count > MAX_MODULES ) {
370 snprintf( error, errorlen, _("%s save state is corrupted (bad module count)"), APP_NAME );
373 return header.module_count;
376 int dreamcast_write_chunk_header( const gchar *name, uint32_t length, FILE *f )
378 struct chunk_header head;
380 memcpy( head.marker, "BLCK", 4 );
381 memset( head.name, 0, 8 );
382 memcpy( head.name, name, strlen(name) );
383 head.block_length = length;
384 return fwrite( &head, sizeof(head), 1, f );
388 frame_buffer_t dreamcast_load_preview( const gchar *filename )
391 FILE *f = fopen( filename, "r" );
392 if( f == NULL ) return NULL;
394 int module_count = dreamcast_read_save_state_header(f, NULL, 0);
395 if( module_count <= 0 ) {
399 for( i=0; i<module_count; i++ ) {
400 struct chunk_header head;
401 if( fread( &head, sizeof(head), 1, f ) != 1 ) {
405 if( memcmp("BLCK", head.marker, 4) != 0 ) {
410 if( strcmp("PVR2", head.name) == 0 ) {
413 fread( &buf_count, sizeof(buf_count), 1, f );
414 fread( &has_front, sizeof(has_front), 1, f );
415 if( buf_count != 0 && has_front ) {
416 frame_buffer_t result = read_png_from_stream(f);
422 fseek( f, head.block_length, SEEK_CUR );
428 int dreamcast_load_state( const gchar *filename )
433 int have_read[MAX_MODULES];
435 FILE *f = fopen( filename, "r" );
436 if( f == NULL ) return errno;
438 module_count = dreamcast_read_save_state_header(f, error, sizeof(error));
439 if( module_count <= 0 ) {
445 for( i=0; i<MAX_MODULES; i++ ) {
449 for( i=0; i<module_count; i++ ) {
450 struct chunk_header chunk;
451 fread( &chunk, sizeof(chunk), 1, f );
452 if( strncmp(chunk.marker, "BLCK", 4) != 0 ) {
453 ERROR( "%s save state is corrupted (missing block header %d)", APP_NAME, i );
458 /* Find the matching module by name */
459 for( j=0; j<num_modules; j++ ) {
460 if( strcmp(modules[j]->name,chunk.name) == 0 ) {
462 if( modules[j]->load == NULL ) {
463 ERROR( "%s save state is corrupted (no loader for %s)", APP_NAME, modules[j]->name );
466 } else if( modules[j]->load(f) != 0 ) {
467 ERROR( "%s save state is corrupted (%s failed)", APP_NAME, modules[j]->name );
474 if( j == num_modules ) {
476 ERROR( "%s save state contains unrecognized section", APP_NAME );
481 /* Any modules that we didn't load - reset to the default state.
482 * (ie it's not an error to skip a module if you don't actually
483 * care about its state).
485 for( j=0; j<num_modules; j++ ) {
486 if( have_read[j] == 0 && modules[j]->reset != NULL ) {
491 INFO( "Save state read from %s", filename );
495 int dreamcast_save_state( const gchar *filename )
499 struct save_state_header header;
501 f = fopen( filename, "w" );
504 strcpy( header.magic, DREAMCAST_SAVE_MAGIC );
505 header.version = DREAMCAST_SAVE_VERSION;
506 header.module_count = 0;
508 for( i=0; i<num_modules; i++ ) {
509 if( modules[i]->save != NULL )
510 header.module_count++;
512 fwrite( &header, sizeof(header), 1, f );
513 for( i=0; i<num_modules; i++ ) {
514 if( modules[i]->save != NULL ) {
515 uint32_t blocklen, posn1, posn2;
516 dreamcast_write_chunk_header( modules[i]->name, 0, f );
520 blocklen = posn2 - posn1;
521 fseek( f, posn1-4, SEEK_SET );
522 fwrite( &blocklen, sizeof(blocklen), 1, f );
523 fseek( f, posn2, SEEK_SET );
527 INFO( "Save state written to %s", filename );
531 /********************** Quick save state support ***********************/
532 /* This section doesn't necessarily belong here, but it probably makes the
533 * most sense here next to the regular save/load functions
536 static gchar *get_quick_state_filename( int state )
538 gchar *path = lxdream_get_global_config_path_value(CONFIG_SAVE_PATH);
539 gchar *str = g_strdup_printf( QUICK_STATE_FILENAME, path, state );
545 static void dreamcast_quick_state_init()
547 const char *state = lxdream_get_global_config_value(CONFIG_QUICK_STATE);
548 if( state != NULL ) {
549 quick_save_state = atoi(state);
550 if( quick_save_state > MAX_QUICK_STATE ) {
551 quick_save_state = 0;
554 quick_save_state = 0;
558 void dreamcast_quick_save()
560 if( quick_save_state == -1 )
561 dreamcast_quick_state_init();
562 gchar *str = get_quick_state_filename(quick_save_state);
563 dreamcast_save_state(str);
567 void dreamcast_quick_load()
569 if( quick_save_state == -1 )
570 dreamcast_quick_state_init();
571 gchar *str = get_quick_state_filename(quick_save_state);
572 dreamcast_load_state(str);
576 unsigned int dreamcast_get_quick_state( )
578 if( quick_save_state == -1 )
579 dreamcast_quick_state_init();
580 return quick_save_state;
583 void dreamcast_set_quick_state( unsigned int state )
585 if( state <= MAX_QUICK_STATE && state != quick_save_state ) {
586 quick_save_state = state;
588 sprintf( buf, "%d", quick_save_state );
589 lxdream_set_global_config_value(CONFIG_QUICK_STATE, buf);
590 lxdream_save_config();
594 gboolean dreamcast_has_quick_state( unsigned int state )
596 gchar *str = get_quick_state_filename(state);
597 int result = access(str, R_OK);
599 return result == 0 ? TRUE : FALSE;
602 /********************* The Boot ROM address space **********************/
603 static int32_t FASTCALL ext_bootrom_read_long( sh4addr_t addr )
605 return *((int32_t *)(dc_boot_rom + (addr&0x001FFFFF)));
607 static int32_t FASTCALL ext_bootrom_read_word( sh4addr_t addr )
609 return SIGNEXT16(*((int16_t *)(dc_boot_rom + (addr&0x001FFFFF))));
611 static int32_t FASTCALL ext_bootrom_read_byte( sh4addr_t addr )
613 return SIGNEXT8(*((int16_t *)(dc_boot_rom + (addr&0x001FFFFF))));
615 static void FASTCALL ext_bootrom_read_burst( unsigned char *dest, sh4addr_t addr )
617 memcpy( dest, dc_boot_rom +(addr&0x001FFFFF), 32 );
620 struct mem_region_fn mem_region_bootrom = {
621 ext_bootrom_read_long, unmapped_write_long,
622 ext_bootrom_read_word, unmapped_write_long,
623 ext_bootrom_read_byte, unmapped_write_long,
624 ext_bootrom_read_burst, unmapped_write_burst };
626 /********************* The Flash RAM address space **********************/
627 static int32_t FASTCALL ext_flashram_read_long( sh4addr_t addr )
629 return *((int32_t *)(dc_flash_ram + (addr&0x0001FFFF)));
631 static int32_t FASTCALL ext_flashram_read_word( sh4addr_t addr )
633 return SIGNEXT16(*((int16_t *)(dc_flash_ram + (addr&0x0001FFFF))));
635 static int32_t FASTCALL ext_flashram_read_byte( sh4addr_t addr )
637 return SIGNEXT8(*((int16_t *)(dc_flash_ram + (addr&0x0001FFFF))));
639 static void FASTCALL ext_flashram_write_long( sh4addr_t addr, uint32_t val )
641 *(uint32_t *)(dc_flash_ram + (addr&0x0001FFFF)) = val;
642 asic_g2_write_word();
644 static void FASTCALL ext_flashram_write_word( sh4addr_t addr, uint32_t val )
646 *(uint16_t *)(dc_flash_ram + (addr&0x0001FFFF)) = (uint16_t)val;
647 asic_g2_write_word();
649 static void FASTCALL ext_flashram_write_byte( sh4addr_t addr, uint32_t val )
651 *(uint8_t *)(dc_flash_ram + (addr&0x0001FFFF)) = (uint8_t)val;
652 asic_g2_write_word();
654 static void FASTCALL ext_flashram_read_burst( unsigned char *dest, sh4addr_t addr )
656 memcpy( dest, dc_flash_ram+(addr&0x0001FFFF), 32 );
658 static void FASTCALL ext_flashram_write_burst( sh4addr_t addr, unsigned char *src )
660 memcpy( dc_flash_ram+(addr&0x0001FFFF), src, 32 );
663 struct mem_region_fn mem_region_flashram = { ext_flashram_read_long, ext_flashram_write_long,
664 ext_flashram_read_word, ext_flashram_write_word,
665 ext_flashram_read_byte, ext_flashram_write_byte,
666 ext_flashram_read_burst, ext_flashram_write_burst };
.