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 void dreamcast_config_changed(void)
131 char *bios_path = lxdream_get_global_config_path_value(CONFIG_BIOS_PATH);
132 char *flash_path = lxdream_get_global_config_path_value(CONFIG_FLASH_PATH);
133 dreamcast_has_bios = mem_load_rom( dc_boot_rom, bios_path, 2 MB, 0x89f2b1a1 );
134 if( flash_path != NULL && flash_path[0] != '\0' ) {
135 mem_load_block( flash_path, 0x00200000, 0x00020000 );
142 void dreamcast_save_flash()
144 if( dreamcast_has_flash ) {
145 char *file = lxdream_get_global_config_path_value(CONFIG_FLASH_PATH);
146 mem_save_block( file, 0x00200000, 0x00020000 );
152 * Constructs a system configuration for the AICA in standalone mode,
153 * ie sound chip only.
155 void dreamcast_configure_aica_only( )
157 dreamcast_register_module( &mem_module );
158 mem_map_region( aica_main_ram, 0x00800000, 2 MB, MEM_REGION_AUDIO, &mem_region_audioram, MEM_FLAG_RAM, 2 MB, 0 );
159 mem_map_region( aica_scratch_ram, 0x00703000, 8 KB, MEM_REGION_AUDIO_SCRATCH, &mem_region_audioscratch, MEM_FLAG_RAM, 8 KB, 0 );
160 dreamcast_register_module( &aica_module );
162 dreamcast_state = STATE_STOPPED;
165 void dreamcast_register_module( dreamcast_module_t module )
167 modules[num_modules++] = module;
168 if( module->init != NULL )
172 void dreamcast_set_run_time( uint32_t secs, uint32_t nanosecs )
174 run_time_nanosecs = (((uint64_t)secs) * 1000000000) + nanosecs;
177 void dreamcast_set_exit_on_stop( gboolean flag )
179 dreamcast_exit_on_stop = flag;
182 void dreamcast_init( void )
184 dreamcast_configure();
185 dreamcast_state = STATE_STOPPED;
188 void dreamcast_reset( void )
190 sh4_core_exit(CORE_EXIT_SYSRESET);
192 for( i=0; i<num_modules; i++ ) {
193 if( modules[i]->reset != NULL )
198 void dreamcast_run( void )
202 if( !dreamcast_can_run() ) {
203 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"));
207 if( dreamcast_state != STATE_RUNNING ) {
208 for( i=0; i<num_modules; i++ ) {
209 if( modules[i]->start != NULL )
214 if( maple_should_grab() ) {
215 gui_set_use_grab(TRUE);
218 dreamcast_state = STATE_RUNNING;
220 if( run_time_nanosecs != 0 ) {
221 while( dreamcast_state == STATE_RUNNING ) {
222 uint32_t time_to_run = timeslice_length;
223 if( run_time_nanosecs < time_to_run ) {
224 time_to_run = (uint32_t)run_time_nanosecs;
227 for( i=0; i<num_modules; i++ ) {
228 if( modules[i]->run_time_slice != NULL )
229 time_to_run = modules[i]->run_time_slice( time_to_run );
232 if( run_time_nanosecs > time_to_run ) {
233 run_time_nanosecs -= time_to_run;
235 run_time_nanosecs = 0; // Finished
240 while( dreamcast_state == STATE_RUNNING ) {
241 int time_to_run = timeslice_length;
242 for( i=0; i<num_modules; i++ ) {
243 if( modules[i]->run_time_slice != NULL )
244 time_to_run = modules[i]->run_time_slice( time_to_run );
250 gui_set_use_grab(FALSE);
252 for( i=0; i<num_modules; i++ ) {
253 if( modules[i]->stop != NULL )
258 dreamcast_state = STATE_STOPPED;
260 if( dreamcast_exit_on_stop ) {
261 dreamcast_shutdown();
266 void dreamcast_stop( void )
268 sh4_core_exit(CORE_EXIT_HALT); // returns only if not inside SH4 core
269 if( dreamcast_state == STATE_RUNNING )
270 dreamcast_state = STATE_STOPPING;
273 void dreamcast_shutdown()
275 // Don't do a dreamcast_stop - if we're calling this out of SH4 code,
276 // it's a shutdown-and-quit event
277 if( dreamcast_state == STATE_RUNNING )
278 dreamcast_state = STATE_STOPPING;
279 dreamcast_save_flash();
281 #ifdef ENABLE_SH4STATS
282 sh4_stats_print(stdout);
286 void dreamcast_program_loaded( const gchar *name, sh4addr_t entry_point )
288 if( dreamcast_program_name != NULL ) {
289 g_free(dreamcast_program_name);
291 dreamcast_program_name = g_strdup(name);
292 dreamcast_entry_point = entry_point;
293 sh4_set_pc(entry_point);
294 sh4_write_sr( sh4_read_sr() & (~SR_BL) ); /* Unmask interrupts */
300 gboolean dreamcast_is_running( void )
302 return dreamcast_state == STATE_RUNNING;
305 gboolean dreamcast_can_run(void)
307 return dreamcast_state != STATE_UNINIT &&
308 (dreamcast_has_bios || dreamcast_program_name != NULL);
311 /********************************* Save States *****************************/
313 struct save_state_header {
316 uint32_t module_count;
319 struct chunk_header {
320 char marker[4]; /* Always BLCK */
321 char name[8]; /* Block (module) name */
322 uint32_t block_length;
326 * Check the save state header to ensure that it is a valid, supported
328 * @return the number of blocks following, or 0 if the file is invalid.
330 int dreamcast_read_save_state_header( FILE *f, char *error, int errorlen )
332 struct save_state_header header;
333 if( fread( &header, sizeof(header), 1, f ) != 1 ) {
336 if( strncmp( header.magic, DREAMCAST_SAVE_MAGIC, 16 ) != 0 ) {
338 snprintf( error, errorlen, _("File is not a %s save state"), APP_NAME );
341 if( header.version != DREAMCAST_SAVE_VERSION ) {
343 snprintf( error, errorlen, _("Unsupported %s save state version"), APP_NAME );
346 if( header.module_count > MAX_MODULES ) {
348 snprintf( error, errorlen, _("%s save state is corrupted (bad module count)"), APP_NAME );
351 return header.module_count;
354 int dreamcast_write_chunk_header( const gchar *name, uint32_t length, FILE *f )
356 struct chunk_header head;
358 memcpy( head.marker, "BLCK", 4 );
359 memset( head.name, 0, 8 );
360 memcpy( head.name, name, strlen(name) );
361 head.block_length = length;
362 return fwrite( &head, sizeof(head), 1, f );
366 frame_buffer_t dreamcast_load_preview( const gchar *filename )
369 FILE *f = fopen( filename, "r" );
370 if( f == NULL ) return NULL;
372 int module_count = dreamcast_read_save_state_header(f, NULL, 0);
373 if( module_count <= 0 ) {
377 for( i=0; i<module_count; i++ ) {
378 struct chunk_header head;
379 if( fread( &head, sizeof(head), 1, f ) != 1 ) {
383 if( memcmp("BLCK", head.marker, 4) != 0 ) {
388 if( strcmp("PVR2", head.name) == 0 ) {
391 fread( &buf_count, sizeof(buf_count), 1, f );
392 fread( &has_front, sizeof(has_front), 1, f );
393 if( buf_count != 0 && has_front ) {
394 frame_buffer_t result = read_png_from_stream(f);
400 fseek( f, head.block_length, SEEK_CUR );
406 int dreamcast_load_state( const gchar *filename )
411 int have_read[MAX_MODULES];
413 FILE *f = fopen( filename, "r" );
414 if( f == NULL ) return errno;
416 module_count = dreamcast_read_save_state_header(f, error, sizeof(error));
417 if( module_count <= 0 ) {
423 for( i=0; i<MAX_MODULES; i++ ) {
427 for( i=0; i<module_count; i++ ) {
428 struct chunk_header chunk;
429 fread( &chunk, sizeof(chunk), 1, f );
430 if( strncmp(chunk.marker, "BLCK", 4) != 0 ) {
431 ERROR( "%s save state is corrupted (missing block header %d)", APP_NAME, i );
436 /* Find the matching module by name */
437 for( j=0; j<num_modules; j++ ) {
438 if( strcmp(modules[j]->name,chunk.name) == 0 ) {
440 if( modules[j]->load == NULL ) {
441 ERROR( "%s save state is corrupted (no loader for %s)", APP_NAME, modules[j]->name );
444 } else if( modules[j]->load(f) != 0 ) {
445 ERROR( "%s save state is corrupted (%s failed)", APP_NAME, modules[j]->name );
452 if( j == num_modules ) {
454 ERROR( "%s save state contains unrecognized section", APP_NAME );
459 /* Any modules that we didn't load - reset to the default state.
460 * (ie it's not an error to skip a module if you don't actually
461 * care about its state).
463 for( j=0; j<num_modules; j++ ) {
464 if( have_read[j] == 0 && modules[j]->reset != NULL ) {
469 INFO( "Save state read from %s", filename );
473 int dreamcast_save_state( const gchar *filename )
477 struct save_state_header header;
479 f = fopen( filename, "w" );
482 strcpy( header.magic, DREAMCAST_SAVE_MAGIC );
483 header.version = DREAMCAST_SAVE_VERSION;
484 header.module_count = 0;
486 for( i=0; i<num_modules; i++ ) {
487 if( modules[i]->save != NULL )
488 header.module_count++;
490 fwrite( &header, sizeof(header), 1, f );
491 for( i=0; i<num_modules; i++ ) {
492 if( modules[i]->save != NULL ) {
493 uint32_t blocklen, posn1, posn2;
494 dreamcast_write_chunk_header( modules[i]->name, 0, f );
498 blocklen = posn2 - posn1;
499 fseek( f, posn1-4, SEEK_SET );
500 fwrite( &blocklen, sizeof(blocklen), 1, f );
501 fseek( f, posn2, SEEK_SET );
505 INFO( "Save state written to %s", filename );
509 /********************** Quick save state support ***********************/
510 /* This section doesn't necessarily belong here, but it probably makes the
511 * most sense here next to the regular save/load functions
514 static gchar *get_quick_state_filename( int state )
516 gchar *path = lxdream_get_global_config_path_value(CONFIG_SAVE_PATH);
517 gchar *str = g_strdup_printf( QUICK_STATE_FILENAME, path, state );
523 static void dreamcast_quick_state_init()
525 const char *state = lxdream_get_global_config_value(CONFIG_QUICK_STATE);
526 if( state != NULL ) {
527 quick_save_state = atoi(state);
528 if( quick_save_state > MAX_QUICK_STATE ) {
529 quick_save_state = 0;
532 quick_save_state = 0;
536 void dreamcast_quick_save()
538 if( quick_save_state == -1 )
539 dreamcast_quick_state_init();
540 gchar *str = get_quick_state_filename(quick_save_state);
541 dreamcast_save_state(str);
545 void dreamcast_quick_load()
547 if( quick_save_state == -1 )
548 dreamcast_quick_state_init();
549 gchar *str = get_quick_state_filename(quick_save_state);
550 dreamcast_load_state(str);
554 unsigned int dreamcast_get_quick_state( )
556 if( quick_save_state == -1 )
557 dreamcast_quick_state_init();
558 return quick_save_state;
561 void dreamcast_set_quick_state( unsigned int state )
563 if( state <= MAX_QUICK_STATE && state != quick_save_state ) {
564 quick_save_state = state;
566 sprintf( buf, "%d", quick_save_state );
567 lxdream_set_global_config_value(CONFIG_QUICK_STATE, buf);
568 lxdream_save_config();
572 gboolean dreamcast_has_quick_state( unsigned int state )
574 gchar *str = get_quick_state_filename(state);
575 int result = access(str, R_OK);
577 return result == 0 ? TRUE : FALSE;
580 /********************* The Boot ROM address space **********************/
581 static int32_t FASTCALL ext_bootrom_read_long( sh4addr_t addr )
583 return *((int32_t *)(dc_boot_rom + (addr&0x001FFFFF)));
585 static int32_t FASTCALL ext_bootrom_read_word( sh4addr_t addr )
587 return SIGNEXT16(*((int16_t *)(dc_boot_rom + (addr&0x001FFFFF))));
589 static int32_t FASTCALL ext_bootrom_read_byte( sh4addr_t addr )
591 return SIGNEXT8(*((int16_t *)(dc_boot_rom + (addr&0x001FFFFF))));
593 static void FASTCALL ext_bootrom_read_burst( unsigned char *dest, sh4addr_t addr )
595 memcpy( dest, dc_boot_rom +(addr&0x001FFFFF), 32 );
598 struct mem_region_fn mem_region_bootrom = {
599 ext_bootrom_read_long, unmapped_write_long,
600 ext_bootrom_read_word, unmapped_write_long,
601 ext_bootrom_read_byte, unmapped_write_long,
602 ext_bootrom_read_burst, unmapped_write_burst };
604 /********************* The Flash RAM address space **********************/
605 static int32_t FASTCALL ext_flashram_read_long( sh4addr_t addr )
607 return *((int32_t *)(dc_flash_ram + (addr&0x0001FFFF)));
609 static int32_t FASTCALL ext_flashram_read_word( sh4addr_t addr )
611 return SIGNEXT16(*((int16_t *)(dc_flash_ram + (addr&0x0001FFFF))));
613 static int32_t FASTCALL ext_flashram_read_byte( sh4addr_t addr )
615 return SIGNEXT8(*((int16_t *)(dc_flash_ram + (addr&0x0001FFFF))));
617 static void FASTCALL ext_flashram_write_long( sh4addr_t addr, uint32_t val )
619 *(uint32_t *)(dc_flash_ram + (addr&0x0001FFFF)) = val;
620 asic_g2_write_word();
622 static void FASTCALL ext_flashram_write_word( sh4addr_t addr, uint32_t val )
624 *(uint16_t *)(dc_flash_ram + (addr&0x0001FFFF)) = (uint16_t)val;
625 asic_g2_write_word();
627 static void FASTCALL ext_flashram_write_byte( sh4addr_t addr, uint32_t val )
629 *(uint8_t *)(dc_flash_ram + (addr&0x0001FFFF)) = (uint8_t)val;
630 asic_g2_write_word();
632 static void FASTCALL ext_flashram_read_burst( unsigned char *dest, sh4addr_t addr )
634 memcpy( dest, dc_flash_ram+(addr&0x0001FFFF), 32 );
636 static void FASTCALL ext_flashram_write_burst( sh4addr_t addr, unsigned char *src )
638 memcpy( dc_flash_ram+(addr&0x0001FFFF), src, 32 );
641 struct mem_region_fn mem_region_flashram = { ext_flashram_read_long, ext_flashram_write_long,
642 ext_flashram_read_word, ext_flashram_write_word,
643 ext_flashram_read_byte, ext_flashram_write_byte,
644 ext_flashram_read_burst, ext_flashram_write_burst };
.