mirror of
https://github.com/RetroDECK/Supermodel.git
synced 2024-11-23 06:15:37 +00:00
319 lines
11 KiB
C++
319 lines
11 KiB
C++
/**
|
|
** Supermodel
|
|
** A Sega Model 3 Arcade Emulator.
|
|
** Copyright 2011-2021 Bart Trzynadlowski, Nik Henson, Ian Curtis,
|
|
** Harry Tuttle, and Spindizzi
|
|
**
|
|
** This file is part of Supermodel.
|
|
**
|
|
** Supermodel is free software: you can redistribute it and/or modify it under
|
|
** the terms of the GNU General Public License as published by the Free
|
|
** Software Foundation, either version 3 of the License, or (at your option)
|
|
** any later version.
|
|
**
|
|
** Supermodel is distributed in the hope that it will be useful, but WITHOUT
|
|
** ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
** FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
** more details.
|
|
**
|
|
** You should have received a copy of the GNU General Public License along
|
|
** with Supermodel. If not, see <http://www.gnu.org/licenses/>.
|
|
**/
|
|
|
|
/*
|
|
* Model3.h
|
|
*
|
|
* Header file defining the CModel3 and CModel3Config classes.
|
|
*/
|
|
|
|
#ifndef INCLUDED_MODEL3_H
|
|
#define INCLUDED_MODEL3_H
|
|
|
|
#include "Model3/IEmulator.h"
|
|
#include "Model3/JTAG.h"
|
|
#include "Model3/Crypto.h"
|
|
#ifdef NET_BOARD
|
|
#include "Network/INetBoard.h"
|
|
#endif // NET_BOARD
|
|
#include "Util/NewConfig.h"
|
|
|
|
/*
|
|
* FrameTimings
|
|
*
|
|
* Timings within a frame, for debugging purposes
|
|
*/
|
|
struct FrameTimings
|
|
{
|
|
UINT32 ppcTicks;
|
|
UINT32 syncSize;
|
|
UINT32 syncTicks;
|
|
UINT32 renderTicks;
|
|
UINT32 sndTicks;
|
|
UINT32 drvTicks;
|
|
#ifdef NET_BOARD
|
|
UINT32 netTicks;
|
|
#endif
|
|
UINT32 frameTicks;
|
|
};
|
|
|
|
/*
|
|
* CModel3:
|
|
*
|
|
* A complete Model 3 system.
|
|
*
|
|
* Inherits IBus in order to pass the address space handlers to devices that
|
|
* may need them (CPU, DMA, etc.)
|
|
*
|
|
* NOTE: Currently NOT re-entrant due to a non-OOP PowerPC core. Do NOT create
|
|
* create more than one CModel3 object!
|
|
*/
|
|
class CModel3: public IEmulator, public IBus, public IPCIDevice
|
|
{
|
|
public:
|
|
// IEmulator interface
|
|
bool PauseThreads(void);
|
|
bool ResumeThreads(void);
|
|
void SaveState(CBlockFile *SaveState);
|
|
void LoadState(CBlockFile *SaveState);
|
|
void SaveNVRAM(CBlockFile *NVRAM);
|
|
void LoadNVRAM(CBlockFile *NVRAM);
|
|
void ClearNVRAM(void);
|
|
void RunFrame(void);
|
|
void RenderFrame(void);
|
|
void Reset(void);
|
|
const Game &GetGame(void) const;
|
|
void AttachRenderers(CRender2D *Render2DPtr, IRender3D *Render3DPtr);
|
|
void AttachInputs(CInputs *InputsPtr);
|
|
void AttachOutputs(COutputs *OutputsPtr);
|
|
bool Init(void);
|
|
|
|
// IPCIDevice interface
|
|
UINT32 ReadPCIConfigSpace(unsigned device, unsigned reg, unsigned bits, unsigned width);
|
|
void WritePCIConfigSpace(unsigned device, unsigned reg, unsigned bits, unsigned width, UINT32 data);
|
|
|
|
// IBus interface
|
|
UINT8 Read8(UINT32 addr);
|
|
UINT16 Read16(UINT32 addr);
|
|
UINT32 Read32(UINT32 addr);
|
|
UINT64 Read64(UINT32 addr);
|
|
void Write8(UINT32 addr, UINT8 data);
|
|
void Write16(UINT32 addr, UINT16 data);
|
|
void Write32(UINT32 addr, UINT32 data);
|
|
void Write64(UINT32 addr, UINT64 data);
|
|
|
|
/*
|
|
* LoadGame(game, rom_set):
|
|
*
|
|
* Loads a game, copying in the provided ROMs and setting the hardware
|
|
* stepping.
|
|
*
|
|
* Parameters:
|
|
* game Game information.
|
|
* rom_set ROMs.
|
|
*
|
|
* Returns:
|
|
* OKAY if successful, FAIL otherwise. Prints errors.
|
|
*/
|
|
bool LoadGame(const Game &game, const ROMSet &rom_set);
|
|
|
|
/*
|
|
* GetSoundBoard(void):
|
|
*
|
|
* Returns a reference to the sound board.
|
|
*
|
|
* Returns:
|
|
* Pointer to CSoundBoard object.
|
|
*/
|
|
CSoundBoard *GetSoundBoard(void);
|
|
|
|
/*
|
|
* GetDriveBoard(void):
|
|
*
|
|
* Returns a reference to the drive board.
|
|
|
|
* Returns:
|
|
* Pointer to CDriveBoard object.
|
|
*/
|
|
CDriveBoard *GetDriveBoard(void);
|
|
|
|
#ifdef NET_BOARD
|
|
/*
|
|
* GetNetBoard(void):
|
|
*
|
|
* Returns a reference to the net board.
|
|
|
|
* Returns:
|
|
* Pointer to CNetBoard or CSimNetBoard object.
|
|
*/
|
|
INetBoard * GetNetBoard(void);
|
|
#endif
|
|
|
|
/*
|
|
* DumpTimings(void):
|
|
*
|
|
* Prints all timings for the most recent frame to the console, for debugging purposes.
|
|
*/
|
|
void DumpTimings(void);
|
|
|
|
/*
|
|
* GetTimings(void):
|
|
*
|
|
* Returns timings for the most recent frame, for debugging purposes.
|
|
*/
|
|
FrameTimings GetTimings(void);
|
|
|
|
/*
|
|
* CModel3(config):
|
|
* ~CModel3(void):
|
|
*
|
|
* Constructor and destructor for Model 3 class. Constructor performs a
|
|
* bare-bones initialization of object; does not perform any memory
|
|
* allocation or any actions that can fail. The destructor will deallocate
|
|
* memory and free resources used by the object (and its child objects).
|
|
*
|
|
* Paramters:
|
|
* config Run-time configuration. The reference should be held because
|
|
* this changes at run-time.
|
|
*/
|
|
CModel3(const Util::Config::Node &config);
|
|
~CModel3(void);
|
|
|
|
/*
|
|
* Private Property.
|
|
* Tresspassers will be shot! ;)
|
|
*/
|
|
private:
|
|
// Private member functions
|
|
UINT8 ReadInputs(unsigned reg);
|
|
void WriteInputs(unsigned reg, UINT8 data);
|
|
uint16_t ReadSecurityRAM(uint32_t addr);
|
|
UINT32 ReadSecurity(unsigned reg);
|
|
void WriteSecurity(unsigned reg, UINT32 data);
|
|
void SetCROMBank(unsigned idx);
|
|
UINT8 ReadSystemRegister(unsigned reg);
|
|
void WriteSystemRegister(unsigned reg, UINT8 data);
|
|
|
|
void RunMainBoardFrame(void); // Runs PPC main board for a frame
|
|
void SyncGPUs(void); // Sync's up GPUs in preparation for rendering - must be called when PPC is not running
|
|
bool RunSoundBoardFrame(void); // Runs sound board for a frame
|
|
void RunDriveBoardFrame(void); // Runs drive board for a frame
|
|
#ifdef NET_BOARD
|
|
void RunNetBoardFrame(void); // Runs net board for a frame
|
|
#endif
|
|
|
|
bool StartThreads(void); // Starts all threads
|
|
bool StopThreads(void); // Stops all threads
|
|
void DeleteThreadObjects(void); // Deletes all threads and synchronization objects
|
|
|
|
static int StartMainBoardThread(void *data); // Callback to start PPC main board thread
|
|
static int StartSoundBoardThread(void *data); // Callback to start sound board thread (unsync'd)
|
|
static int StartSoundBoardThreadSyncd(void *data); // Callback to start sound board thread (sync'd)
|
|
static int StartDriveBoardThread(void *data); // Callback to start drive board thread
|
|
|
|
static void AudioCallback(void *data); // Audio buffer callback
|
|
|
|
bool WakeSoundBoardThread(void); // Used by audio callback to wake sound board thread (when not sync'd with render thread)
|
|
int RunMainBoardThread(void); // Runs PPC main board thread (sync'd in step with render thread)
|
|
int RunSoundBoardThread(void); // Runs sound board thread (not sync'd in step with render thread, ie running at full speed)
|
|
int RunSoundBoardThreadSyncd(void); // Runs sound board thread (sync'd in step with render thread)
|
|
int RunDriveBoardThread(void); // Runs drive board thread (sync'd in step with render thread)
|
|
|
|
// Runtime configuration
|
|
const Util::Config::Node &m_config;
|
|
bool m_multiThreaded;
|
|
bool m_gpuMultiThreaded;
|
|
|
|
// Game and hardware information
|
|
Game m_game;
|
|
|
|
// Game inputs and outputs
|
|
CInputs *Inputs;
|
|
COutputs *Outputs;
|
|
|
|
// Input registers (game controls)
|
|
UINT8 inputBank;
|
|
UINT8 serialFIFO1, serialFIFO2;
|
|
UINT8 gunReg;
|
|
int adcChannel;
|
|
|
|
// MIDI port
|
|
UINT8 midiCtrlPort; // controls MIDI (SCSP) IRQ behavior
|
|
|
|
// Emulated core Model 3 memory regions
|
|
UINT8 *memoryPool; // single allocated region for all ROM and system RAM
|
|
UINT8 *ram; // 8 MB PowerPC RAM
|
|
UINT8 *crom; // 8+128 MB CROM (fixed CROM first, then 64MB of banked CROMs -- Daytona2 might need extra?)
|
|
UINT8 *vrom; // 64 MB VROM (video ROM, visible only to Real3D)
|
|
UINT8 *soundROM; // 512 KB sound ROM (68K program)
|
|
UINT8 *sampleROM; // 8 MB samples (68K)
|
|
UINT8 *dsbROM; // 128 KB DSB ROM (Z80 program)
|
|
UINT8 *mpegROM; // 8 MB DSB MPEG ROM
|
|
UINT8 *backupRAM; // 128 KB Backup RAM (battery backed)
|
|
UINT8 *securityRAM; // 128 KB Security Board RAM
|
|
UINT8 *driveROM; // 32 KB drive board ROM (Z80 program) (optional)
|
|
UINT8 *netRAM; // 128KB RAM
|
|
UINT8 *netBuffer; // 128KB buffer
|
|
|
|
// Banked CROM
|
|
UINT8 *cromBank; // currently mapped in CROM bank
|
|
unsigned cromBankReg; // the CROM bank register
|
|
|
|
// Security device
|
|
bool m_securityFirstRead = true;
|
|
unsigned securityPtr; // pointer to current offset in security data
|
|
|
|
// PowerPC
|
|
PPC_FETCH_REGION PPCFetchRegions[3];
|
|
|
|
// Multiple threading
|
|
bool gpusReady; // True if GPUs are ready to render
|
|
bool startedThreads; // True if threads have been created and started
|
|
bool pauseThreads; // True if threads should pause
|
|
bool stopThreads; // True if threads should stop
|
|
bool syncSndBrdThread; // True if sound board thread should be sync'd in step with render thread
|
|
CThread *ppcBrdThread; // PPC main board thread
|
|
CThread *sndBrdThread; // Sound board thread
|
|
CThread *drvBrdThread; // Drive board thread
|
|
bool ppcBrdThreadRunning; // Flag to indicate PPC main board thread is currently processing
|
|
bool ppcBrdThreadDone; // Flag to indicate PPC main board thread has finished processing
|
|
bool sndBrdThreadRunning; // Flag to indicate sound board thread is currently processing
|
|
bool sndBrdThreadDone; // Flag to indicate sound board thread has finished processing
|
|
bool sndBrdWakeNotify; // Flag to indicate that sound board thread has been woken by audio callback (when not sync'd with render thread)
|
|
bool drvBrdThreadRunning; // Flag to indicate drive board thread is currently processing
|
|
bool drvBrdThreadDone; // Flag to indicate drive board thread has finished processing
|
|
|
|
// Thread synchronization objects
|
|
CSemaphore *ppcBrdThreadSync;
|
|
CSemaphore *sndBrdThreadSync;
|
|
CMutex *sndBrdNotifyLock;
|
|
CCondVar *sndBrdNotifySync;
|
|
CSemaphore *drvBrdThreadSync;
|
|
CMutex *notifyLock;
|
|
CCondVar *notifySync;
|
|
|
|
// Frame timings
|
|
FrameTimings timings;
|
|
|
|
// Other devices
|
|
CIRQ IRQ; // Model 3 IRQ controller
|
|
CMPC10x PCIBridge; // MPC10x PCI/bridge/memory controller
|
|
CPCIBus PCIBus; // Model 3's PCI bus
|
|
C53C810 SCSI; // NCR 53C810 SCSI controller
|
|
CRTC72421 RTC; // Epson RTC-72421 real-time clock
|
|
C93C46 EEPROM; // 93C46 EEPROM
|
|
CTileGen TileGen; // Sega 2D tile generator
|
|
CReal3D GPU; // Real3D graphics hardware
|
|
CSoundBoard SoundBoard; // Sound board
|
|
CDSB *DSB; // Digital Sound Board (type determined dynamically at load time)
|
|
CDriveBoard *DriveBoard; // Drive board
|
|
CCrypto m_cryptoDevice; // Encryption device
|
|
CJTAG m_jtag; // JTAG interface
|
|
#ifdef NET_BOARD
|
|
INetBoard *NetBoard; // Net board
|
|
bool m_runNetBoard;
|
|
#endif
|
|
|
|
};
|
|
|
|
|
|
#endif // INCLUDED_MODEL3_H
|