nkeynes@31: /**
nkeynes@586:  * $Id$
nkeynes@31:  *
nkeynes@31:  * mem is responsible for creating and maintaining the overall system memory
nkeynes@31:  * map, as visible from the SH4 processor. (Note the ARM has a different map)
nkeynes@31:  *
nkeynes@31:  * Copyright (c) 2005 Nathan Keynes.
nkeynes@31:  *
nkeynes@31:  * This program is free software; you can redistribute it and/or modify
nkeynes@31:  * it under the terms of the GNU General Public License as published by
nkeynes@31:  * the Free Software Foundation; either version 2 of the License, or
nkeynes@31:  * (at your option) any later version.
nkeynes@31:  *
nkeynes@31:  * This program is distributed in the hope that it will be useful,
nkeynes@31:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
nkeynes@31:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
nkeynes@31:  * GNU General Public License for more details.
nkeynes@31:  */
nkeynes@31: 
nkeynes@736: #ifndef lxdream_mem_H
nkeynes@736: #define lxdream_mem_H 1
nkeynes@10: 
nkeynes@10: #include <stdint.h>
nkeynes@477: #include "lxdream.h"
nkeynes@10: 
nkeynes@10: #ifdef __cplusplus
nkeynes@10: extern "C" {
nkeynes@10: #endif
nkeynes@10: 
nkeynes@10: typedef struct mem_region {
nkeynes@10:     uint32_t base;
nkeynes@10:     uint32_t size;
nkeynes@422:     const char *name;
nkeynes@502:     sh4ptr_t mem;
nkeynes@510:     uint32_t flags;
nkeynes@10: } *mem_region_t;
nkeynes@10: 
nkeynes@10: #define MAX_IO_REGIONS 24
nkeynes@10: #define MAX_MEM_REGIONS 8
nkeynes@10: 
nkeynes@180: #define MEM_REGION_BIOS "Bios ROM"
nkeynes@10: #define MEM_REGION_MAIN "System RAM"
nkeynes@10: #define MEM_REGION_VIDEO "Video RAM"
nkeynes@10: #define MEM_REGION_AUDIO "Audio RAM"
nkeynes@10: #define MEM_REGION_AUDIO_SCRATCH "Audio Scratch RAM"
nkeynes@146: #define MEM_REGION_FLASH "System Flash"
nkeynes@10: 
nkeynes@422: void *mem_create_ram_region( uint32_t base, uint32_t size, const char *name );
nkeynes@422: void *mem_create_repeating_ram_region( uint32_t base, uint32_t size, const char *name, 
nkeynes@146: 				       uint32_t repeat_offset, uint32_t last_repeat );
nkeynes@543: /**
nkeynes@543:  * Load a ROM image from the specified filename. If the memory region has not
nkeynes@543:  * been allocated, it is created now, otherwise the existing region is reused.
nkeynes@543:  * If the CRC check fails, a warning will be printed.
nkeynes@543:  * @return TRUE if the image was loaded successfully (irrespective of CRC failure).
nkeynes@543:  */
nkeynes@543: gboolean mem_load_rom( const gchar *filename, uint32_t base, uint32_t size, 
nkeynes@543: 		       uint32_t crc, const gchar *region_name );
nkeynes@19: void *mem_alloc_pages( int n );
nkeynes@502: sh4ptr_t mem_get_region( uint32_t addr );
nkeynes@502: sh4ptr_t mem_get_region_by_name( const char *name );
nkeynes@10: int mem_has_page( uint32_t addr );
nkeynes@502: sh4ptr_t mem_get_page( uint32_t addr );
nkeynes@146: int mem_load_block( const gchar *filename, uint32_t base, uint32_t size );
nkeynes@146: int mem_save_block( const gchar *filename, uint32_t base, uint32_t size );
nkeynes@586: void mem_set_trace( const gchar *tracelist, int flag );
nkeynes@10: void mem_init( void );
nkeynes@10: void mem_reset( void );
nkeynes@502: void mem_copy_from_sh4( sh4ptr_t dest, sh4addr_t src, size_t count );
nkeynes@502: void mem_copy_to_sh4( sh4addr_t dest, sh4ptr_t src, size_t count );
nkeynes@10: 
nkeynes@669: /**
nkeynes@669:  * Write a long value directly to SH4-addressable memory.
nkeynes@669:  * @param dest a valid, writable physical memory address, relative to the SH4
nkeynes@669:  * @param value the value to write.
nkeynes@669:  */
nkeynes@669: void mem_write_long( sh4addr_t dest, uint32_t value );
nkeynes@669: 
nkeynes@43: #define ENABLE_DEBUG_MODE 1
nkeynes@43: 
nkeynes@586: typedef enum { BREAK_NONE=0, BREAK_ONESHOT=1, BREAK_KEEP=2 } breakpoint_type_t;
nkeynes@586: 
nkeynes@43: struct breakpoint_struct {
nkeynes@43:     uint32_t address;
nkeynes@586:     breakpoint_type_t type;
nkeynes@43: };
nkeynes@43: 
nkeynes@43: #define MAX_BREAKPOINTS 32
nkeynes@43: 
nkeynes@586: 
nkeynes@586: #define MEM_FLAG_ROM 4 /* Mem region is ROM-based */
nkeynes@586: #define MEM_FLAG_RAM 6 
nkeynes@10: 
nkeynes@10: #define WATCH_WRITE 1
nkeynes@10: #define WATCH_READ  2
nkeynes@10: #define WATCH_EXEC  3  /* AKA Breakpoint :) */
nkeynes@10: 
nkeynes@10: typedef struct watch_point *watch_point_t;
nkeynes@10: 
nkeynes@10: watch_point_t mem_new_watch( uint32_t start, uint32_t end, int flags );
nkeynes@10: void mem_delete_watch( watch_point_t watch );
nkeynes@10: watch_point_t mem_is_watched( uint32_t addr, int size, int op );
nkeynes@10: 
nkeynes@502: extern sh4ptr_t *page_map;
nkeynes@736: 
nkeynes@10: #ifdef __cplusplus
nkeynes@10: }
nkeynes@10: #endif
nkeynes@736: 
nkeynes@736: #endif /* !lxdream_mem_H */