Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* KISS, YAGNI, DRY
*
* (c) Copyright 2006-2017, Peter Jakubčo
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
package emulib.plugins.cpu;
import emulib.plugins.Plugin;
import javax.swing.JPanel;
/**
* Interface that covers CPU common operations.
*
* This is the main interface that CPU plug-in has to implement.
*/
public interface CPU extends Plugin {
/**
* The run state of the CPU.
*/
enum RunState {
/**
* CPU is stopped (naturally or by user) and should not be run until its
* reset.
*/
STATE_STOPPED_NORMAL("stopped"),
/**
* CPU is in breakpoint state (paused).
*/
STATE_STOPPED_BREAK("breakpoint"),
/**
* CPU is stopped because of address fallout error. It should not be
* run until its reset.
*/
STATE_STOPPED_ADDR_FALLOUT("stopped (address fallout)"),
/**
* CPU is stopped because of instruction fallout (unknown instruction)
* error. It should not be run until its reset.
*/
STATE_STOPPED_BAD_INSTR("stopped (instruction fallout)"),
/**
* CPU is running.
*/
STATE_RUNNING("running");
private final String name;
RunState(String name) {
this.name = name;
}
@Override
public String toString() {
return this.name;
}
}
/**
* The listener interface for receiving CPU events. The class that is
* interested in processing a CPU event implements this interface, and the
* object created with that class is registered with a CPU, using the CPU's
* addCPUListener method.
* When the CPU event occurs, that:
*
*
if the event is CPU's state change, then object's internalStateChanged()
* method is invoked.
*
if the event is CPU's run state change, then object's runStateChanged()
* method is invoked.
*
*
* CONTRACT: Never call further actions on CPU (start,stop,step,reset) from the same thread as from which these
* methods are called.
*/
@SuppressWarnings("unused")
interface CPUListener {
/**
* Invoked when an CPU's run state changes.
* @param runState new run state of the CPU
*/
void runStateChanged (RunState runState);
/**
* Invoked when an CPU's internal state changes. The state can be register change,
* flags change, or other CPU's internal state change.
*/
void internalStateChanged ();
}
/**
* Adds the specified CPU listener to receive CPU events from this CPU.
*
* CPU events occur when CPU changes its state, or run state. CPU state
* events don't occur if CPU is running, only happens with run state changes.
* If listener is null, no exception is thrown and no action is
* performed.
*
* @param listener the CPU listener
* @return true if the listener was added, false otherwise
*/
boolean addCPUListener (CPUListener listener);
/**
* Removes the specified CPU listener so that it no longer receives CPU
* events from this CPU.
*
* CPU events occur when CPU changes its state, or run
* state. CPU state events don't occur if CPU is running, only happens with
* run state changes. If listener is null, no exception is
* thrown and no action is performed.
*
* @param listener the CPU listener to be removed
* @return true if the listener was removed, false otherwise
*/
boolean removeCPUListener (CPUListener listener);
/**
* Perform one step of CPU emulation. It means that one instruction should
* be executed. CPU state changes to state "running", then it executes one
* instruction, and then it should return to state "breakpoint" or "stopped".
* Correct timing of executed instruction isn't so important.
*/
void step ();
/**
* Runs CPU emulation. Change state of CPU to "running" and start
* instruction fetch/decode/execute loop.
*
* The emuStudio creates separate thread for this purpose.
*
* While CPU is running, the emuStudio will not allow to call method
* step().
*
* A good CPU should performs right timing for instructions here.
* Debug window should not be updated after each instruction execution,
* in order to the execution loop would be faster.
*/
void execute ();
/**
* Pauses the CPU emulation. If a thread was used for CPU execution
* and is running, then it should be stopped (destroyed) but the CPU state
* has to be saved for future run. CPU changes it state to "breakpoint".
*/
void pause ();
/**
* Stops the CPU emulation. If a thread was used for CPU execution
* and is running, then it should be stopped (destroyed) but the CPU state
* can be saved. CPU changes its state to "stopped" and main module should
* now forbid execution any of methods step(), pause(),
* execute() until user resets the CPU. Debug window in main
* module should be updated with saved CPU state.
*/
void stop ();
/**
* Get CPU status panel.
*
* Each CPU plugin must have a status panel that shows some important CPU status (e.g. registers, flags,
* run state, etc.) and allows to manage some settings (e.g. a runtime frequency, etc.).
*
* This panel is located on the right side in the "emulation" panel of the main module.
*
* CPU itself should take care about updating the panel when it is appropriate.
*
* @return CPU status panel
*/
@SuppressWarnings("unused")
JPanel getStatusPanel ();
/**
* Determine whether breakpoints are supported by CPU.
* @return true if breakpoints are supported, false otherwise
*/
boolean isBreakpointSupported ();
/**
* Set a breakpoint at a memory location.
*
* Does nothing if breakpoints are not supported.
* @param memLocation memory location where the breakpoint will be set
* @see CPU#isBreakpointSupported
*/
void setBreakpoint (int memLocation);
/**
* Unset a breakpoint at a memory location.
*
* Does nothing if breakpoints are not supported.
* @param memLocation memory location from where the breakpoint will be unset
* @see CPU#isBreakpointSupported
*/
void unsetBreakpoint (int memLocation);
/**
* Determine if a breakpoint is set at a memory location.
*
* @param memLocation memory location, from where the breakpoint will be determined
* @return true if breakpoint is set in the location, false otherwise or if breakpoints are not supported.
* @see CPU#isBreakpointSupported
*/
boolean isBreakpointSet (int memLocation);
/**
* Perform reset of the CPU with specific starting address. This is used
* when program starting address is known. Otherwise it is used standard
* Plugin.reset() method
*
* @param startAddress Starting address/memory position of the program counter
*/
void reset(int startAddress);
/**
* Get actual instruction position (before its execution). Can be said,
* that this method should return PC (program counter) register (if CPU
* has one).
*
* @return memory position (address) of next instruction
*/
int getInstructionPosition ();
/**
* Set new actual instruction position (that will be executed as next). It
* can be said, that a parameter represents new value of PC (program counter),
* if CPU has one. Otherwise CPU should interpret the position in the right
* manner.
*
* This method is called by main module when user perform "jump to address"
* operation.
* @param pos new address of actual instruction
* @return true if operation was successful, false otherwise
*/
boolean setInstructionPosition (int pos);
/**
* Get disassembler object. EmuStudio uses this for creating debug table.
*
* @return disassembler object
*/
Disassembler getDisassembler();
}
