src/libzymosis/zymosis_utils.h

   1 /*
   2  * Zymosis: Z80 CPU emulation engine v0.1.2.1
   3  * coded by Ketmar // Invisible Vector (ketmar@ketmar.no-ip.org)
   4  * Understanding is not required. Only obedience.
   5  *
   6  * This program is free software. It comes without any warranty, to
   7  * the extent permitted by applicable law. You can redistribute it
   8  * and/or modify it under the terms of the Do What The Fuck You Want
   9  * To Public License, Version 2, as published by Sam Hocevar. See
  10  * http://www.wtfpl.net/txt/copying/ for more details.
  11  */
  12 #ifndef ZYMOSIS_UTILS_H
  13 #define ZYMOSIS_UTILS_H
  14
  15 #include "zymosis.h"
  16
  17
  18 /******************************************************************************/
  19 /* very simple instruction info extractor */
  20 /******************************************************************************/
  21 enum {
  22   ZYM_COND_NONE = -1,
  23   ZYM_COND_NZ,
  24   ZYM_COND_Z,
  25   ZYM_COND_NC,
  26   ZYM_COND_C,
  27   ZYM_COND_PO,
  28   ZYM_COND_PE,
  29   ZYM_COND_P,
  30   ZYM_COND_M,
  31   ZYM_COND_BCNZ,
  32   ZYM_COND_BNZ,
  33   ZYM_COND_RETI,
  34   ZYM_COND_RETN
  35 };
  36
  37
  38 enum {
  39   ZYM_MEMIO_NONE = -666,
  40   ZYM_MEMIO_SP = -6,
  41   ZYM_MEMIO_BC = -5,
  42   ZYM_MEMIO_DE = -4,
  43   ZYM_MEMIO_IY = -3,
  44   ZYM_MEMIO_IX = -2,
  45   ZYM_MEMIO_HL = -1
  46 };
  47
  48
  49 enum {
  50   ZYM_JUMP_NONE = -666,
  51   ZYM_JUMP_RET = -4,
  52   ZYM_JUMP_IY = -3,
  53   ZYM_JUMP_IX = -2,
  54   ZYM_JUMP_HL = -1
  55 };
  56
  57
  58 enum {
  59   ZYM_PORTIO_NONE = -666,
  60   ZYM_PORTIO_BC = -1,
  61   ZYM_PORTIO_BCM1 = -2  /* (B-1)C, for OUT* */
  62 };
  63
  64
  65 enum {
  66   ZYM_STK_NONE = -666,
  67   ZYM_STK_BC = 0,
  68   ZYM_STK_DE,
  69   ZYM_STK_HL,
  70   ZYM_STK_AF,
  71   ZYM_STK_IX,
  72   ZYM_STK_IY,
  73   ZYM_STK_PC
  74 };
  75
  76
  77 /* there can be DD/FD prefix followed by ED/CB, hence the bitset */
  78 /* note that ED totally ignores IX/IY prefix, and CB with IX/IY is a strange beast */
  79 enum {
  80   ZYM_PFX_NONE = 0u,
  81   ZYM_PFX_IX = 1u<<0,
  82   ZYM_PFX_IY = 1u<<1,
  83   ZYM_PFX_ED = 1u<<2,
  84   ZYM_PFX_CB = 1u<<3,
  85 };
  86
  87
  88 /* registers affected by the instruction. not fully tested yet, may be buggy */
  89 /* note that EXX and EX AF,AFX doesn't "affect" registers, and have separate flags*/
  90 /* NOT IMPLEMENTED YET! */
  91 /*
  92 enum {
  93   ZYM_REGMOD_NONE = 0u,
  94   ZYM_REGMOD_B = 1u<<0,
  95   ZYM_REGMOD_C = 1u<<1,
  96   ZYM_REGMOD_D = 1u<<2,
  97   ZYM_REGMOD_E = 1u<<3,
  98   ZYM_REGMOD_H = 1u<<4,
  99   ZYM_REGMOD_L = 1u<<5,
 100   ZYM_REGMOD_F = 1u<<6,
 101   ZYM_REGMOD_A = 1u<<7,
 102   ZYM_REGMOD_XH = 1u<<8,
 103   ZYM_REGMOD_XL = 1u<<9,
 104   ZYM_REGMOD_YH = 1u<<10,
 105   ZYM_REGMOD_YL = 1u<<11,
 106   ZYM_REGMOD_SP = 1u<<12,
 107   // EXX
 108   ZYM_REGMOD_EXX = 1u<<13,
 109   // EX AF,AFX
 110   ZYM_REGMOD_EXAF = 1u<<14,
 111   ZYM_REGMOD_I = 1u<<15,
 112   ZYM_REGMOD_R = 1u<<16,
 113
 114   // convenient masks
 115   ZYM_REGMOD_BC = ZYM_REGMOD_B|ZYM_REGMOD_C,
 116   ZYM_REGMOD_DE = ZYM_REGMOD_D|ZYM_REGMOD_E,
 117   ZYM_REGMOD_HL = ZYM_REGMOD_H|ZYM_REGMOD_L,
 118   ZYM_REGMOD_AF = ZYM_REGMOD_A|ZYM_REGMOD_F,
 119   ZYM_REGMOD_IX = ZYM_REGMOD_XH|ZYM_REGMOD_XL,
 120   ZYM_REGMOD_IY = ZYM_REGMOD_YH|ZYM_REGMOD_YL,
 121 };
 122 */
 123
 124 typedef struct {
 125   int inslen; /* instruction length */
 126   zym_bool memrwword; /* !0: reading word (if reading anything at all) */
 127   int memread; /* ZYM_MEMIO_xxx or addr */
 128   int memwrite; /* ZYM_MEMIO_xxx or addr */
 129   int jump; /* Z80_JUMP_xxx or addr */
 130   int cond; /* Z80_COND_xxx */
 131   int portread; /* Z80_PORTIO_xxx or addr; if addr is specified, high byte must be taken from A */
 132   int portwrite; /* Z80_PORTIO_xxx or addr; if addr is specified, high byte must be taken from A */
 133   int push; /* Z80_STK_xxx; CALL/RST will set ZYM_STK_PC */
 134   int pop; /* Z80_STK_xxx; RET will set ZYM_STK_PC */
 135   int disp; /* for (IX+n) / (IY+n), else 0xffff */
 136   int trap; /* slt and other trap opcode or -1 */
 137   unsigned prefix; /* ZYM_PFX_XXX */
 138   /* NOT IMPLEMENTED YET! */
 139   /*unsigned regread;*/ /* registers read by this instruction */
 140   /*unsigned regwrite;*/ /* registers wrote by this instruction */
 141 } zym_op_meminfo_t;
 142
 143
 144 void zym_op_meminfo (zym_cpu_t *z80, zym_op_meminfo_t *nfo, uint16_t pc);
 145
 146
 147 /******************************************************************************/
 148 /* very simple disassembler */
 149 /******************************************************************************/
 150 // disasm flags
 151 enum {
 152   ZYM_DIS_FLAGS_DEFAULT     = 0u,
 153   // use lower-cased text for mnemonics
 154   ZYM_DIS_FLAG_LOCASE_MNEMO = 1u<<0,
 155   // use lower-cased text for arguments
 156   ZYM_DIS_FLAG_LOCASE_ARGS  = 1u<<1,
 157   // use lower-cased text for hex numbers
 158   ZYM_DIS_FLAG_LOCASE_HEX   = 1u<<2,
 159   // use decimal numbers instead of hex?
 160   ZYM_DIS_FLAG_DECIMAL      = 1u<<3,
 161   // if hex, use "0x" instead of "#"?
 162   ZYM_DIS_FLAG_HEX_CLIKE    = 1u<<4,
 163 };
 164
 165 typedef struct  {
 166   int inslen; // instruction length in bytes (NOT disassembly string length!)
 167   char disbuf[128]; // buffer that holds disassembled text; mnemonic is separated by '\t'
 168   const char *mnemo; // points into disbuf
 169   int mnemolen;
 170   const char *args[3]; // points into disbuf
 171   int argslen[3];
 172   int tstates[2]; // tstates for taken/not taken; equal for non-branch commands
 173   // disassembler options
 174   unsigned flags; // see above
 175 } zym_disop_t;
 176
 177
 178 /* size: 1 or 2 -- size in bytes */
 179 /* asaddr: !0 if this is for CALL/JP */
 180 enum {
 181   ZYM_DIS_ATYPE_BYTE = 0, /* immediate byte value */
 182   ZYM_DIS_ATYPE_WORD = 1, /* immediate word value */
 183   ZYM_DIS_ATYPE_PC_ADDR = 2, /* CALL/JP/JR/DJNZ address */
 184   ZYM_DIS_ATYPE_DATA_ADDR = 3, /* LD (nnn) address */
 185   ZYM_DIS_ATYPE_PORT8 = 4,
 186   ZYM_DIS_ATYPE_OFFSET = 5, /* LD (ix+n) address */
 187 };
 188
 189 // for offsets, value is signed 2-complement
 190 typedef const char *(*zym_disasm_getlabel_fn) (uint16_t value, int type/*ZYM_DIS_ATYPE_XXX*/);
 191 extern zym_disasm_getlabel_fn zym_disasm_getlabel;
 192
 193 extern const char *zym_disasm_mnemo_end; /* default is NULL ("\t") */
 194 extern const char *zym_disasm_num_start; /* default is NULL */
 195 extern const char *zym_disasm_num_end; /* default is NULL */
 196
 197 /* you may skip calling this, and only set `flags` */
 198 void zym_disasm_init (zym_disop_t *nfo);
 199
 200 void zym_disasm_one_ex (zym_disop_t *nfo, const uint8_t mem[8], uint16_t pc);
 201 void zym_disasm_one (zym_cpu_t *z80, zym_disop_t *nfo, uint16_t pc);
 202
 203
 204 #ifdef __cplusplus
 205 }
 206 #endif
 207 #endif