nkeynes@31: /**
nkeynes@437:  * $Id: dream.h,v 1.15 2007-10-11 08:22:03 nkeynes Exp $
nkeynes@31:  *
nkeynes@31:  * Miscellaneous application-wide declarations (mainly logging atm)
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@1:  */
nkeynes@31: 
nkeynes@1: #ifndef dream_H
nkeynes@1: #define dream_H 1
nkeynes@1: 
nkeynes@35: #include <stdio.h>
nkeynes@9: #include <stdlib.h>
nkeynes@2: #include <stdint.h>
nkeynes@9: #include <string.h>
nkeynes@30: #include <glib/gtypes.h>
nkeynes@2: 
nkeynes@1: #ifdef __cplusplus
nkeynes@1: extern "C" {
nkeynes@1: #endif
nkeynes@35: 
nkeynes@180: #define APP_NAME "lxDream"
nkeynes@435: #define APP_VERSION "0.8"
nkeynes@180: 
nkeynes@35: /************************ Modules ********************************/
nkeynes@35: /**
nkeynes@35:  * Basic module structure defining the common operations across all
nkeynes@35:  * modules, ie start, stop, reset, etc. 
nkeynes@35:  */
nkeynes@35: typedef struct dreamcast_module {
nkeynes@35:     char *name;
nkeynes@35:     /**
nkeynes@35:      * Perform all initial module setup (ie register / allocate any
nkeynes@180:      * memory required, etc). Only called once during system startup
nkeynes@35:      */
nkeynes@35:     void (*init)();
nkeynes@35:     /**
nkeynes@35:      * Reset the module into it's initial system boot state. Will be called
nkeynes@35:      * once after init(), as well as whenever the user requests a reset.
nkeynes@35:      */
nkeynes@35:     void (*reset)();
nkeynes@35:     /**
nkeynes@35:      * Set the module into a running state (may be NULL)
nkeynes@35:      */
nkeynes@35:     void (*start)();
nkeynes@35:     /**
nkeynes@35:      * Execute one time-slice worth of operations, for the given number of
nkeynes@35:      * nanoseconds.
nkeynes@35:      * @return Number of nanoseconds actually executed
nkeynes@35:      */
nkeynes@35:     uint32_t (*run_time_slice)( uint32_t nanosecs );
nkeynes@35:     /**
nkeynes@35:      * Set the module into a stopped state (may be NULL)
nkeynes@35:      */
nkeynes@35:     void (*stop)();
nkeynes@35:     /**
nkeynes@35:      * Save the module state to the FILE stream. May be NULL, in which case
nkeynes@35:      * the module is considered to have no state.
nkeynes@35:      */
nkeynes@35:     void (*save)(FILE *);
nkeynes@35:     /**
nkeynes@35:      * Load the saved module state from the FILE stream. May be NULL, in which
nkeynes@35:      * case reset() will be called instead.
nkeynes@35:      * @return 0 on success, nonzero on failure.
nkeynes@35:      */
nkeynes@35:     int (*load)(FILE *);
nkeynes@35: } *dreamcast_module_t;
nkeynes@35: 
nkeynes@35: void dreamcast_register_module( dreamcast_module_t );
nkeynes@35: 
nkeynes@35: extern struct dreamcast_module mem_module;
nkeynes@35: extern struct dreamcast_module sh4_module;
nkeynes@35: extern struct dreamcast_module asic_module;
nkeynes@35: extern struct dreamcast_module pvr2_module;
nkeynes@35: extern struct dreamcast_module aica_module;
nkeynes@35: extern struct dreamcast_module ide_module;
nkeynes@35: extern struct dreamcast_module maple_module;
nkeynes@35: extern struct dreamcast_module pvr2_module;
nkeynes@35: extern struct dreamcast_module gui_module;
nkeynes@265: extern struct dreamcast_module eventq_module;
nkeynes@35: extern struct dreamcast_module unknown_module;
nkeynes@35: 
nkeynes@35: /*************************** Logging **************************/
nkeynes@1: 
nkeynes@1: #define EMIT_FATAL 0
nkeynes@1: #define EMIT_ERR 1
nkeynes@1: #define EMIT_WARN 2
nkeynes@1: #define EMIT_INFO 3
nkeynes@1: #define EMIT_DEBUG 4
nkeynes@1: #define EMIT_TRACE 5
nkeynes@1: 
nkeynes@35: #ifndef MODULE
nkeynes@35: #define MODULE unknown_module
nkeynes@1: #endif
nkeynes@1: 
nkeynes@437: void log_message( void *, int level, const char *source, const char *msg, ... );
nkeynes@1: 
nkeynes@437: #define FATAL( ... ) log_message( NULL, EMIT_FATAL, MODULE.name, __VA_ARGS__ )
nkeynes@437: #define ERROR( ... ) log_message( NULL, EMIT_ERR, MODULE.name, __VA_ARGS__ )
nkeynes@437: #define WARN( ... ) log_message( NULL, EMIT_WARN, MODULE.name, __VA_ARGS__ )
nkeynes@437: #define INFO( ... ) log_message( NULL, EMIT_INFO, MODULE.name, __VA_ARGS__ )
nkeynes@437: #define DEBUG( ... ) log_message( NULL, EMIT_DEBUG, MODULE.name, __VA_ARGS__ )
nkeynes@437: #define TRACE( ... ) log_message( NULL, EMIT_TRACE, MODULE.name, __VA_ARGS__ )
nkeynes@1: 
nkeynes@422: void fwrite_string( const char *s, FILE *f );
nkeynes@35: int fread_string( char *s, int maxlen, FILE *f );
nkeynes@220: void fwrite_dump( unsigned char *buf, unsigned int length, FILE *f );
nkeynes@220: void fwrite_dump32( unsigned int *buf, unsigned int length, FILE *f );
nkeynes@220: void fwrite_dump32v( unsigned int *buf, unsigned int length, int wordsPerLine, FILE *f );
nkeynes@35: 
nkeynes@422: typedef uint32_t sh4addr_t;
nkeynes@422: 
nkeynes@135: #ifndef max
nkeynes@135: #define max(a,b) ( (a) > (b) ? (a) : (b) )
nkeynes@135: #endif
nkeynes@135: 
nkeynes@1: #ifdef __cplusplus
nkeynes@1: }
nkeynes@1: #endif
nkeynes@1: #endif