Preprocesor condition fix; README.
This commit is contained in:
redcode
106
README.md
106
README.md
@@ -2,7 +2,7 @@
|
||||
Copyright © 1999-2016 Manuel Sainz de Baranda y Goñi.
|
||||
Released under the terms of the [GNU General Public License v3](http://www.gnu.org/copyleft/gpl.html).
|
||||
|
||||
This is a very accurate [Z80](http://en.wikipedia.org/wiki/Zilog_Z80) [emulator](http://en.wikipedia.org/wiki/Emulator) I wrote many years ago. It has been used in several machine emulators by other people and has been extensivelly tested. It is very fast and small (although there are faster ones written in assembly), its structure is very clear and the code is commented.
|
||||
This is a very accurate [Z80](http://en.wikipedia.org/wiki/Zilog_Z80) [emulator](http://en.wikipedia.org/wiki/Emulator) I wrote many years ago. It has been used in several machine emulators by other people and it has been extensivelly tested. It's very fast and small (although there are faster ones written in assembly), its structure is very clear and the code is commented.
|
||||
|
||||
If you are looking for an accurate Zilog Z80 CPU emulator for your project maybe you have found the correct one. I use this core in the [ZX Spectrum emulator](http://github.com/redcode/mZX) I started as hobby.
|
||||
|
||||
@@ -41,95 +41,141 @@ CPU_Z80_HIDE_ABI | Makes the `abi_emulation_cpu_z80` private.
|
||||
CPU_Z80_USE_LOCAL_HEADER | Use this if you have imported _Z80.h_ and _Z80.c_ to your project. _Z80.c_ will include `"Z80.h"` instead of `<emulation/CPU/Z80.h>`.
|
||||
|
||||
|
||||
## Callbacks
|
||||
|
||||
|
||||
## API
|
||||
|
||||
### `z80_run`
|
||||
|
||||
***Description***
|
||||
**Description**
|
||||
Runs the core for the given amount of ```cycles```.
|
||||
|
||||
***Declaration***
|
||||
**Prototype**
|
||||
```C
|
||||
zsize z80_run(Z80 *object, zsize cycles);
|
||||
```
|
||||
|
||||
***Parameters***
|
||||
**Parameters**
|
||||
`object`: A pointer to an emulator instance.
|
||||
`cycles`: The number of cycles to be executed.
|
||||
|
||||
***Return value***
|
||||
The actual number of cycles executed.
|
||||
**Return value**
|
||||
The number of cycles executed.
|
||||
|
||||
***Discusion***
|
||||
**Discusion**
|
||||
Given the fact that one Z80 instruction needs between 4 and 23 cycles to be executed, it is not always possible to run the core the exact number of cycles specfified.
|
||||
|
||||
### `z80_power`
|
||||
|
||||
***Description***
|
||||
**Description**
|
||||
Switchs the core power status.
|
||||
|
||||
***Declaration***
|
||||
**Prototype**
|
||||
```C
|
||||
void z80_power(Z80 *object, zboolean state);
|
||||
```
|
||||
***Parameters***
|
||||
**Parameters**
|
||||
`object`: A pointer to an emulator instance.
|
||||
`state`: `ON` / `OFF`
|
||||
|
||||
***Return value***
|
||||
none.
|
||||
**Return value**
|
||||
None.
|
||||
|
||||
### `z80_reset`
|
||||
|
||||
***Description***
|
||||
**Description**
|
||||
Resets the core by reinitializing its variables and sets its registers to the state they would be in a real Z80 CPU after a pulse in the `RESET` line.
|
||||
|
||||
***Declaration***
|
||||
**Prototype**
|
||||
```C
|
||||
void z80_reset(Z80 *object);
|
||||
```
|
||||
|
||||
***Parameters***
|
||||
**Parameters**
|
||||
`object`: A pointer to an emulator instance.
|
||||
|
||||
***Return value***
|
||||
none.
|
||||
**Return value**
|
||||
None.
|
||||
|
||||
### `z80_nmi`
|
||||
|
||||
***Description***
|
||||
**Description**
|
||||
Performs a non-maskable interrupt. This is equivalent to a pulse in the `NMI` line of a real Z80 CPU.
|
||||
|
||||
***Declaration***
|
||||
**Prototype**
|
||||
```C
|
||||
void z80_nmi(Z80 *object);
|
||||
```
|
||||
|
||||
***Parameters***
|
||||
**Parameters**
|
||||
`object`: A pointer to an emulator instance.
|
||||
|
||||
***Return value***
|
||||
none.
|
||||
**Return value**
|
||||
None.
|
||||
|
||||
### `z80_int`
|
||||
|
||||
***Description***
|
||||
**Description**
|
||||
Switchs the state of the maskable interrupt. This is equivalent to a change in the `INT` line of a real Z80 CPU.
|
||||
|
||||
***Declaration***
|
||||
**Prototype**
|
||||
```C
|
||||
void z80_int(Z80 *object, zboolean state);
|
||||
```
|
||||
|
||||
***Parameters***
|
||||
**Parameters**
|
||||
`object`: A pointer to an emulator instance.
|
||||
`state`: `ON` = set line high, `OFF` = set line low
|
||||
|
||||
***Return value***
|
||||
none.
|
||||
**Return value**
|
||||
None.
|
||||
|
||||
|
||||
## Callbacks
|
||||
|
||||
### `read`
|
||||
|
||||
**Description**
|
||||
Called when the CPU needs to read 8 bits from memory.
|
||||
|
||||
**Prototype**
|
||||
```C
|
||||
typedef zuint8 (* ZContext16BitAddressRead8Bit)(void *context, zuint16 address);
|
||||
ZContext16BitAddressRead8Bit read;
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
`context`: A pointer to the calling emulator instance.
|
||||
`address`: The memory address to read.
|
||||
|
||||
**Return value**
|
||||
The 8 bits read from memory.
|
||||
|
||||
### `write`
|
||||
|
||||
**Description**
|
||||
Called when the CPU needs to write 8 bits to memory.
|
||||
|
||||
**Prototype**
|
||||
```C
|
||||
typedef void (* ZContext16BitAddressWrite8Bit)(void *context, zuint16 address, zuint8 value);
|
||||
ZContext16BitAddressWrite8Bit write;
|
||||
```
|
||||
|
||||
**Parameters**
|
||||
`context`: A pointer to the emulator instance.
|
||||
`address`: The memory address to write.
|
||||
`value`: The value to write in `address`.
|
||||
|
||||
**Return value**
|
||||
None.
|
||||
|
||||
### `in`
|
||||
|
||||
### `out`
|
||||
|
||||
### `int_data`
|
||||
|
||||
### `halt`
|
||||
|
||||
|
||||
## History
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
6428A5751AAFC6DF00634F5D /* Z80.h in Headers */ = {isa = PBXBuildFile; fileRef = 6428A5741AAFC6DF00634F5D /* Z80.h */; settings = {ATTRIBUTES = (Public, ); }; };
|
||||
6428A5771AAFC72900634F5D /* Z80.c in Sources */ = {isa = PBXBuildFile; fileRef = 6428A5761AAFC72900634F5D /* Z80.c */; settings = {COMPILER_FLAGS = "-DCPU_Z80_DYNAMIC"; }; };
|
||||
6428A5801AAFEF1D00634F5D /* Z80.c in Sources */ = {isa = PBXBuildFile; fileRef = 6428A5761AAFC72900634F5D /* Z80.c */; };
|
||||
648C13AF1CCDFA8D00C8DCE1 /* Z80.c in Sources */ = {isa = PBXBuildFile; fileRef = 6428A5761AAFC72900634F5D /* Z80.c */; settings = {COMPILER_FLAGS = "-DCPU_Z80_DYNAMIC -DCPU_Z80_BUILD_MODULE_ABI -DCPU_Z80_USE_SLOTS"; }; };
|
||||
648C13AF1CCDFA8D00C8DCE1 /* Z80.c in Sources */ = {isa = PBXBuildFile; fileRef = 6428A5761AAFC72900634F5D /* Z80.c */; settings = {COMPILER_FLAGS = "-DCPU_Z80_DYNAMIC -DCPU_Z80_BUILD_MODULE_ABI"; }; };
|
||||
648C13B21CCDFA8D00C8DCE1 /* Z80.h in Headers */ = {isa = PBXBuildFile; fileRef = 6428A5741AAFC6DF00634F5D /* Z80.h */; settings = {ATTRIBUTES = (Public, ); }; };
|
||||
648C13C31CCDFBEF00C8DCE1 /* Z80.c in Sources */ = {isa = PBXBuildFile; fileRef = 6428A5761AAFC72900634F5D /* Z80.c */; settings = {COMPILER_FLAGS = "-DCPU_Z80_BUILD_ABI"; }; };
|
||||
648C13CC1CCDFC7700C8DCE1 /* Z80.c in Sources */ = {isa = PBXBuildFile; fileRef = 6428A5761AAFC72900634F5D /* Z80.c */; settings = {COMPILER_FLAGS = "-DCPU_Z80_BUILD_ABI -DCPU_Z80_HIDE_API"; }; };
|
||||
|
||||
@@ -10,7 +10,7 @@ Released under the terms of the GNU General Public License v3. */
|
||||
#include <Z/macros/value.h>
|
||||
#include <Z/macros/pointer.h>
|
||||
|
||||
#define DEFINED(what) (defined CPU_Z80_##what)
|
||||
#define DEFINED(WHAT) (defined CPU_Z80_##WHAT)
|
||||
|
||||
#if !DEFINED(USE_SLOTS) && (DEFINED(BUILD_ABI) || DEFINED(BUILD_MODULE_ABI))
|
||||
# define CPU_Z80_USE_SLOTS
|
||||
@@ -1601,7 +1601,7 @@ CPU_Z80_API void z80_int(Z80 *object, zboolean state) {INT = state;}
|
||||
|
||||
/* MARK: - ABI */
|
||||
|
||||
#if DEFINED(BUILD_ABI) || DEFINED(MODULE_ABI)
|
||||
#if DEFINED(BUILD_ABI) || DEFINED(BUILD_MODULE_ABI)
|
||||
|
||||
static void will_read_state(Z80 *object) {R = R_ALL;}
|
||||
static void did_write_state(Z80 *object) {R7 = R; }
|
||||
|
||||
Reference in New Issue
Block a user