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_use_bios = TRUE;
47 static gboolean dreamcast_has_bios = FALSE;
48 static gboolean dreamcast_has_flash = FALSE;
49 static gboolean dreamcast_exit_on_stop = FALSE;
50 static gchar *dreamcast_program_name = NULL;
51 static sh4addr_t dreamcast_entry_point = 0xA0000000;
52 static uint32_t timeslice_length = DEFAULT_TIMESLICE_LENGTH;
53 static uint64_t run_time_nanosecs = 0;
54 static unsigned int quick_save_state = -1;
56 #define MAX_MODULES 32
57 static int num_modules = 0;
58 dreamcast_module_t modules[MAX_MODULES];
61 * The unknown module is used for logging files without an actual module
64 struct dreamcast_module unknown_module = { "****", NULL, NULL, NULL, NULL,
67 extern struct mem_region_fn mem_region_sdram;
68 extern struct mem_region_fn mem_region_vram32;
69 extern struct mem_region_fn mem_region_vram64;
70 extern struct mem_region_fn mem_region_audioram;
71 extern struct mem_region_fn mem_region_audioscratch;
72 extern struct mem_region_fn mem_region_flashram;
73 extern struct mem_region_fn mem_region_bootrom;
74 extern struct mem_region_fn mem_region_pvr2ta;
75 extern struct mem_region_fn mem_region_pvr2yuv;
76 extern struct mem_region_fn mem_region_pvr2vdma1;
77 extern struct mem_region_fn mem_region_pvr2vdma2;
79 unsigned char dc_main_ram[16 MB];
80 unsigned char dc_boot_rom[2 MB];
81 unsigned char dc_flash_ram[128 KB];
84 * This function is responsible for defining how all the pieces of the
85 * dreamcast actually fit together.
87 * Note currently the locations of the various MMIO pages are hard coded in
88 * the MMIO definitions - they should probably be moved here.
90 void dreamcast_configure( gboolean use_bootrom )
92 char *bios_path = lxdream_get_global_config_path_value(CONFIG_BIOS_PATH);
93 char *flash_path = lxdream_get_global_config_path_value(CONFIG_FLASH_PATH);
95 /* Initialize the event queue first */
98 /* Register the memory framework */
99 dreamcast_register_module( &mem_module );
101 /* Setup standard memory map */
102 mem_map_region( dc_boot_rom, 0x00000000, 2 MB, MEM_REGION_BIOS, &mem_region_bootrom, MEM_FLAG_ROM, 2 MB, 0 );
103 mem_map_region( dc_flash_ram, 0x00200000, 128 KB, MEM_REGION_FLASH, &mem_region_flashram, MEM_FLAG_RAM, 128 KB, 0 );
104 mem_map_region( aica_main_ram, 0x00800000, 2 MB, MEM_REGION_AUDIO, &mem_region_audioram, MEM_FLAG_RAM, 2 MB, 0 );
105 mem_map_region( aica_scratch_ram,0x00703000, 8 KB, MEM_REGION_AUDIO_SCRATCH,&mem_region_audioscratch, MEM_FLAG_RAM, 8 KB, 0 );
106 mem_map_region( NULL, 0x04000000, 8 MB, MEM_REGION_VIDEO64, &mem_region_vram64, 0, 8 MB, 0 );
107 mem_map_region( pvr2_main_ram, 0x05000000, 8 MB, MEM_REGION_VIDEO, &mem_region_vram32, MEM_FLAG_RAM, 8 MB, 0 );
108 mem_map_region( dc_main_ram, 0x0C000000, 16 MB, MEM_REGION_MAIN, &mem_region_sdram, MEM_FLAG_RAM, 0x01000000, 0x0F000000 );
109 mem_map_region( NULL, 0x10000000, 8 MB, MEM_REGION_PVR2TA, &mem_region_pvr2ta, 0, 0x02000000, 0x12000000 );
110 mem_map_region( NULL, 0x10800000, 8 MB, MEM_REGION_PVR2YUV, &mem_region_pvr2yuv, 0, 0x02000000, 0x12800000 );
111 mem_map_region( NULL, 0x11000000, 16 MB, MEM_REGION_PVR2VDMA1, &mem_region_pvr2vdma1, 0, 16 MB, 0 );
112 mem_map_region( NULL, 0x13000000, 16 MB, MEM_REGION_PVR2VDMA2, &mem_region_pvr2vdma2, 0, 16 MB, 0 );
114 dreamcast_use_bios = use_bootrom;
115 dreamcast_has_bios = dreamcast_load_bios( bios_path );
116 if( !dreamcast_has_bios ) {
117 dreamcast_load_fakebios();
120 if( flash_path != NULL && flash_path[0] != '\0' ) {
121 mem_load_block( flash_path, 0x00200000, 0x00020000 );
123 dreamcast_has_flash = TRUE;
125 /* Load in the rest of the core modules */
126 dreamcast_register_module( &sh4_module );
127 dreamcast_register_module( &asic_module );
128 dreamcast_register_module( &pvr2_module );
129 dreamcast_register_module( &aica_module );
130 dreamcast_register_module( &maple_module );
131 dreamcast_register_module( &ide_module );
132 dreamcast_register_module( &eventq_module );
138 gboolean dreamcast_load_bios( const gchar *filename )
140 if( dreamcast_use_bios ) {
141 dreamcast_has_bios = mem_load_rom( dc_boot_rom, filename, 2 MB, 0x89f2b1a1 );
143 dreamcast_has_bios = FALSE;
145 return dreamcast_has_bios;
148 static const char fakebios[] = {
149 0x00, 0xd1, /* movl $+4, r1 */
150 0x2b, 0x41, /* jmp @r1 */
151 0xa0, 0xff, /* .long 0xffffffa0 */
153 gboolean dreamcast_load_fakebios( )
155 memset( dc_boot_rom, 0, 2 MB );
156 memcpy( dc_boot_rom, fakebios, sizeof(fakebios) );
157 syscall_add_hook( 0xA0, bios_boot );
158 dreamcast_has_bios = TRUE;
162 gboolean dreamcast_load_flash( const gchar *filename )
164 if( filename != NULL && filename[0] != '\0' ) {
165 return mem_load_block( filename, 0x00200000, 0x00020000 ) == 0;
171 gboolean dreamcast_config_changed(void *data, struct lxdream_config_group *group, unsigned item,
172 const gchar *oldval, const gchar *newval)
176 case CONFIG_BIOS_PATH:
177 tmp = get_expanded_path(newval);
178 dreamcast_load_bios(tmp);
181 case CONFIG_FLASH_PATH:
182 tmp = get_expanded_path(newval);
183 dreamcast_load_flash(tmp);
191 void dreamcast_save_flash()
193 if( dreamcast_has_flash ) {
194 char *file = lxdream_get_global_config_path_value(CONFIG_FLASH_PATH);
195 mem_save_block( file, 0x00200000, 0x00020000 );
201 * Constructs a system configuration for the AICA in standalone mode,
202 * ie sound chip only.
204 void dreamcast_configure_aica_only( )
206 dreamcast_register_module( &mem_module );
207 mem_map_region( aica_main_ram, 0x00800000, 2 MB, MEM_REGION_AUDIO, &mem_region_audioram, MEM_FLAG_RAM, 2 MB, 0 );
208 mem_map_region( aica_scratch_ram, 0x00703000, 8 KB, MEM_REGION_AUDIO_SCRATCH, &mem_region_audioscratch, MEM_FLAG_RAM, 8 KB, 0 );
209 dreamcast_register_module( &aica_module );
211 dreamcast_state = STATE_STOPPED;
214 void dreamcast_register_module( dreamcast_module_t module )
216 assert( num_modules < MAX_MODULES );
217 modules[num_modules++] = module;
218 if( module->init != NULL )
222 void dreamcast_set_run_time( uint32_t secs, uint32_t nanosecs )
224 run_time_nanosecs = (((uint64_t)secs) * 1000000000) + nanosecs;
227 void dreamcast_set_exit_on_stop( gboolean flag )
229 dreamcast_exit_on_stop = flag;
232 void dreamcast_init( gboolean use_bootrom )
234 dreamcast_configure( use_bootrom );
235 dreamcast_state = STATE_STOPPED;
238 void dreamcast_reset( void )
240 sh4_core_exit(CORE_EXIT_SYSRESET);
242 for( i=0; i<num_modules; i++ ) {
243 if( modules[i]->reset != NULL )
248 void dreamcast_run( void )
252 if( !dreamcast_can_run() ) {
253 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"));
257 if( dreamcast_state != STATE_RUNNING ) {
258 for( i=0; i<num_modules; i++ ) {
259 if( modules[i]->start != NULL )
264 if( maple_should_grab() ) {
265 gui_set_use_grab(TRUE);
268 dreamcast_state = STATE_RUNNING;
270 if( run_time_nanosecs != 0 ) {
271 while( dreamcast_state == STATE_RUNNING ) {
272 uint32_t time_to_run = timeslice_length;
273 if( run_time_nanosecs < time_to_run ) {
274 time_to_run = (uint32_t)run_time_nanosecs;
277 for( i=0; i<num_modules; i++ ) {
278 if( modules[i]->run_time_slice != NULL )
279 time_to_run = modules[i]->run_time_slice( time_to_run );
282 if( run_time_nanosecs > time_to_run ) {
283 run_time_nanosecs -= time_to_run;
285 run_time_nanosecs = 0; // Finished
290 while( dreamcast_state == STATE_RUNNING ) {
291 int time_to_run = timeslice_length;
292 for( i=0; i<num_modules; i++ ) {
293 if( modules[i]->run_time_slice != NULL )
294 time_to_run = modules[i]->run_time_slice( time_to_run );
300 gui_set_use_grab(FALSE);
302 for( i=0; i<num_modules; i++ ) {
303 if( modules[i]->stop != NULL )
308 dreamcast_state = STATE_STOPPED;
310 if( dreamcast_exit_on_stop ) {
311 dreamcast_shutdown();
316 void dreamcast_stop( void )
318 sh4_core_exit(CORE_EXIT_HALT); // returns only if not inside SH4 core
319 if( dreamcast_state == STATE_RUNNING )
320 dreamcast_state = STATE_STOPPING;
323 void dreamcast_shutdown()
325 // Don't do a dreamcast_stop - if we're calling this out of SH4 code,
326 // it's a shutdown-and-quit event
327 if( dreamcast_state == STATE_RUNNING )
328 dreamcast_state = STATE_STOPPING;
329 dreamcast_save_flash();
331 #ifdef ENABLE_SH4STATS
332 sh4_stats_print(stdout);
336 void dreamcast_program_loaded( const gchar *name, sh4addr_t entry_point )
338 if( dreamcast_program_name != NULL ) {
339 g_free(dreamcast_program_name);
341 dreamcast_program_name = g_strdup(name);
342 dreamcast_entry_point = entry_point;
343 sh4_set_pc(entry_point);
344 sh4_write_sr( sh4_read_sr() & (~SR_BL) ); /* Unmask interrupts */
350 gboolean dreamcast_is_running( void )
352 return dreamcast_state == STATE_RUNNING;
355 gboolean dreamcast_can_run(void)
357 return dreamcast_state != STATE_UNINIT;
360 /********************************* Save States *****************************/
362 struct save_state_header {
365 uint32_t module_count;
368 struct chunk_header {
369 char marker[4]; /* Always BLCK */
370 char name[8]; /* Block (module) name */
371 uint32_t block_length;
375 * Check the save state header to ensure that it is a valid, supported
377 * @return the number of blocks following, or 0 if the file is invalid.
379 int dreamcast_read_save_state_header( FILE *f, char *error, int errorlen )
381 struct save_state_header header;
382 if( fread( &header, sizeof(header), 1, f ) != 1 ) {
385 if( strncmp( header.magic, DREAMCAST_SAVE_MAGIC, 16 ) != 0 ) {
387 snprintf( error, errorlen, _("File is not a %s save state"), APP_NAME );
390 if( header.version != DREAMCAST_SAVE_VERSION ) {
392 snprintf( error, errorlen, _("Unsupported %s save state version"), APP_NAME );
395 if( header.module_count > MAX_MODULES ) {
397 snprintf( error, errorlen, _("%s save state is corrupted (bad module count)"), APP_NAME );
400 return header.module_count;
403 int dreamcast_write_chunk_header( const gchar *name, uint32_t length, FILE *f )
405 struct chunk_header head;
407 memcpy( head.marker, "BLCK", 4 );
408 memset( head.name, 0, 8 );
409 memcpy( head.name, name, strlen(name) );
410 head.block_length = length;
411 return fwrite( &head, sizeof(head), 1, f );
415 frame_buffer_t dreamcast_load_preview( const gchar *filename )
418 FILE *f = fopen( filename, "r" );
419 if( f == NULL ) return NULL;
421 int module_count = dreamcast_read_save_state_header(f, NULL, 0);
422 if( module_count <= 0 ) {
426 for( i=0; i<module_count; i++ ) {
427 struct chunk_header head;
428 if( fread( &head, sizeof(head), 1, f ) != 1 ) {
432 if( memcmp("BLCK", head.marker, 4) != 0 ) {
437 if( strcmp("PVR2", head.name) == 0 ) {
440 fread( &buf_count, sizeof(buf_count), 1, f );
441 fread( &has_front, sizeof(has_front), 1, f );
442 if( buf_count != 0 && has_front ) {
443 frame_buffer_t result = read_png_from_stream(f);
449 fseek( f, head.block_length, SEEK_CUR );
455 gboolean dreamcast_load_state( const gchar *filename )
460 int have_read[MAX_MODULES];
462 FILE *f = fopen( filename, "r" );
463 if( f == NULL ) return FALSE;
465 module_count = dreamcast_read_save_state_header(f, error, sizeof(error));
466 if( module_count <= 0 ) {
472 for( i=0; i<MAX_MODULES; i++ ) {
476 for( i=0; i<module_count; i++ ) {
477 struct chunk_header chunk;
478 fread( &chunk, sizeof(chunk), 1, f );
479 if( strncmp(chunk.marker, "BLCK", 4) != 0 ) {
480 ERROR( "%s save state is corrupted (missing block header %d)", APP_NAME, i );
485 /* Find the matching module by name */
486 for( j=0; j<num_modules; j++ ) {
487 if( strcmp(modules[j]->name,chunk.name) == 0 ) {
489 if( modules[j]->load == NULL ) {
490 ERROR( "%s save state is corrupted (no loader for %s)", APP_NAME, modules[j]->name );
493 } else if( modules[j]->load(f) != 0 ) {
494 ERROR( "%s save state is corrupted (%s failed)", APP_NAME, modules[j]->name );
501 if( j == num_modules ) {
503 ERROR( "%s save state contains unrecognized section", APP_NAME );
508 /* Any modules that we didn't load - reset to the default state.
509 * (ie it's not an error to skip a module if you don't actually
510 * care about its state).
512 for( j=0; j<num_modules; j++ ) {
513 if( have_read[j] == 0 && modules[j]->reset != NULL ) {
518 INFO( "Save state read from %s", filename );
522 int dreamcast_save_state( const gchar *filename )
526 struct save_state_header header;
528 f = fopen( filename, "w" );
531 strcpy( header.magic, DREAMCAST_SAVE_MAGIC );
532 header.version = DREAMCAST_SAVE_VERSION;
533 header.module_count = 0;
535 for( i=0; i<num_modules; i++ ) {
536 if( modules[i]->save != NULL )
537 header.module_count++;
539 fwrite( &header, sizeof(header), 1, f );
540 for( i=0; i<num_modules; i++ ) {
541 if( modules[i]->save != NULL ) {
542 uint32_t blocklen, posn1, posn2;
543 dreamcast_write_chunk_header( modules[i]->name, 0, f );
547 blocklen = posn2 - posn1;
548 fseek( f, posn1-4, SEEK_SET );
549 fwrite( &blocklen, sizeof(blocklen), 1, f );
550 fseek( f, posn2, SEEK_SET );
554 INFO( "Save state written to %s", filename );
558 /********************** Quick save state support ***********************/
559 /* This section doesn't necessarily belong here, but it probably makes the
560 * most sense here next to the regular save/load functions
563 static gchar *get_quick_state_filename( int state )
565 gchar *path = lxdream_get_global_config_path_value(CONFIG_SAVE_PATH);
566 gchar *str = g_strdup_printf( QUICK_STATE_FILENAME, path, state );
572 static void dreamcast_quick_state_init()
574 const char *state = lxdream_get_global_config_value(CONFIG_QUICK_STATE);
575 if( state != NULL ) {
576 quick_save_state = atoi(state);
577 if( quick_save_state > MAX_QUICK_STATE ) {
578 quick_save_state = 0;
581 quick_save_state = 0;
585 void dreamcast_quick_save()
587 if( quick_save_state == -1 )
588 dreamcast_quick_state_init();
589 gchar *str = get_quick_state_filename(quick_save_state);
590 dreamcast_save_state(str);
594 void dreamcast_quick_load()
596 if( quick_save_state == -1 )
597 dreamcast_quick_state_init();
598 gchar *str = get_quick_state_filename(quick_save_state);
599 dreamcast_load_state(str);
603 unsigned int dreamcast_get_quick_state( )
605 if( quick_save_state == -1 )
606 dreamcast_quick_state_init();
607 return quick_save_state;
610 void dreamcast_set_quick_state( unsigned int state )
612 if( state <= MAX_QUICK_STATE && state != quick_save_state ) {
613 quick_save_state = state;
615 sprintf( buf, "%d", quick_save_state );
616 lxdream_set_global_config_value(CONFIG_QUICK_STATE, buf);
617 lxdream_save_config();
621 gboolean dreamcast_has_quick_state( unsigned int state )
623 gchar *str = get_quick_state_filename(state);
624 int result = access(str, R_OK);
626 return result == 0 ? TRUE : FALSE;
629 /********************* The Boot ROM address space **********************/
630 static int32_t FASTCALL ext_bootrom_read_long( sh4addr_t addr )
632 return *((int32_t *)(dc_boot_rom + (addr&0x001FFFFF)));
634 static int32_t FASTCALL ext_bootrom_read_word( sh4addr_t addr )
636 return SIGNEXT16(*((int16_t *)(dc_boot_rom + (addr&0x001FFFFF))));
638 static int32_t FASTCALL ext_bootrom_read_byte( sh4addr_t addr )
640 return SIGNEXT8(*((int16_t *)(dc_boot_rom + (addr&0x001FFFFF))));
642 static void FASTCALL ext_bootrom_read_burst( unsigned char *dest, sh4addr_t addr )
644 memcpy( dest, dc_boot_rom +(addr&0x001FFFFF), 32 );
647 struct mem_region_fn mem_region_bootrom = {
648 ext_bootrom_read_long, unmapped_write_long,
649 ext_bootrom_read_word, unmapped_write_long,
650 ext_bootrom_read_byte, unmapped_write_long,
651 ext_bootrom_read_burst, unmapped_write_burst };
653 /********************* The Flash RAM address space **********************/
654 static int32_t FASTCALL ext_flashram_read_long( sh4addr_t addr )
656 return *((int32_t *)(dc_flash_ram + (addr&0x0001FFFF)));
658 static int32_t FASTCALL ext_flashram_read_word( sh4addr_t addr )
660 return SIGNEXT16(*((int16_t *)(dc_flash_ram + (addr&0x0001FFFF))));
662 static int32_t FASTCALL ext_flashram_read_byte( sh4addr_t addr )
664 return SIGNEXT8(*((int16_t *)(dc_flash_ram + (addr&0x0001FFFF))));
666 static void FASTCALL ext_flashram_write_long( sh4addr_t addr, uint32_t val )
668 *(uint32_t *)(dc_flash_ram + (addr&0x0001FFFF)) = val;
669 asic_g2_write_word();
671 static void FASTCALL ext_flashram_write_word( sh4addr_t addr, uint32_t val )
673 *(uint16_t *)(dc_flash_ram + (addr&0x0001FFFF)) = (uint16_t)val;
674 asic_g2_write_word();
676 static void FASTCALL ext_flashram_write_byte( sh4addr_t addr, uint32_t val )
678 *(uint8_t *)(dc_flash_ram + (addr&0x0001FFFF)) = (uint8_t)val;
679 asic_g2_write_word();
681 static void FASTCALL ext_flashram_read_burst( unsigned char *dest, sh4addr_t addr )
683 memcpy( dest, dc_flash_ram+(addr&0x0001FFFF), 32 );
685 static void FASTCALL ext_flashram_write_burst( sh4addr_t addr, unsigned char *src )
687 memcpy( dc_flash_ram+(addr&0x0001FFFF), src, 32 );
690 struct mem_region_fn mem_region_flashram = { ext_flashram_read_long, ext_flashram_write_long,
691 ext_flashram_read_word, ext_flashram_write_word,
692 ext_flashram_read_byte, ext_flashram_write_byte,
693 ext_flashram_read_burst, ext_flashram_write_burst };
.