Diff: z80.h

Revision:

0:b612024f5aee

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/z80.h	Thu Mar 10 20:32:59 2011 +0000
@@ -0,0 +1,127 @@
+/* =============================================================================
+ *  libz80 - Z80 emulation library
+ * =============================================================================
+ *
+ * (C) Gabriel Gambetta (ggambett@adinet.com.uy) 2000 - 2002
+ *
+ * Version 1.99
+ *
+ * -----------------------------------------------------------------------------
+ *
+ *  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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+#ifndef _Z80_H_
+#define _Z80_H_
+
+#include "stdio.h"
+
+typedef unsigned short ushort;
+typedef unsigned char byte;
+
+
+/** Function type to emulate data read. */
+typedef byte (*Z80DataIn)     (int param, ushort address);
+
+
+/** Function type to emulate data write. */
+typedef void (*Z80DataOut)    (int param, ushort address, byte data);
+
+
+/** 
+ * A Z80 register set.
+ * An union is used since we want independent access to the high and low bytes of the 16-bit registers.
+ */
+typedef union 
+{
+    /** Word registers. */
+    struct
+    {
+        ushort AF, BC, DE, HL, IX, IY, SP;
+    } wr;
+    
+    /** Byte registers. Note that SP can't be accesed partially. */
+    struct
+    {
+        byte F, A, C, B, E, D, L, H, IXl, IXh, IYl, IYh;
+    } br;
+} Z80Regs;
+
+
+/** The Z80 flags */
+typedef enum 
+{
+    F_  = 0,
+    F_C  = 1, /**< Carry */
+    F_N  = 2, /**< Sub / Add */
+    F_PV = 4, /**< Parity / Overflow */
+    F_3  = 8, /**< Reserved */
+    F_H  = 16, /**< Half carry */
+    F_5  = 32, /**< Reserved */
+    F_Z  = 64, /**< Zero */
+    F_S  = 128  /**< Sign */
+} Z80Flags;
+
+
+/** A Z80 execution context. */
+typedef struct
+{
+    Z80Regs    R1;        /**< Main register set (R) */
+    Z80Regs R2;        /**< Alternate register set (R') */
+    ushort    PC;        /**< Program counter */
+    byte    R;        /**< Refresh */
+    byte    I;
+    byte    IFF1;    /**< Interrupt Flipflop 1 */
+    byte    IFF2;    /**< Interrupt Flipflop 2 */
+    byte    IM;        /**< Instruction mode */
+    
+    Z80DataIn    memRead;
+    Z80DataOut    memWrite;
+    int            memParam;
+    
+    Z80DataIn    ioRead;
+    Z80DataOut    ioWrite;
+    int            ioParam;
+} Z80Context;
+
+
+/** Execute the next instruction. */
+void Z80Execute (Z80Context* ctx);
+
+/** Decode the next instruction to be executed.
+ * dump and decode can be NULL if such information is not needed
+ *
+ * @param dump A buffer which receives the hex dump
+ * @param decode A buffer which receives the decoded instruction
+ */
+void Z80Debug (Z80Context* ctx, char* dump, char* decode);
+
+/** Resets the processor. */
+void Z80RESET (Z80Context* ctx);
+
+/** Generates a hardware interrupt.
+ * Some interrupt modes read a value from the data bus; this value must be provided in this function call, even
+ * if the processor ignores that value in the current interrupt mode.
+ *
+ * @param value The value to read from the data bus
+ */
+void Z80INT (Z80Context* ctx, byte value);
+
+
+/** Generates a non-maskable interrupt. */
+void Z80NMI (Z80Context* ctx);
+
+
+#endif
\ No newline at end of file