e0b1b12392bffec99775efffc5504d9eca7c8770
[fw/sdcc] / sim / ucsim / z80.src / z80.cc
1 /*
2  * Simulator of microcontrollers (z80.cc)
3  *
4  * some z80 code base from Karl Bongers karl@turbobit.com
5  * 
6  * Copyright (C) 1999,99 Drotos Daniel, Talker Bt.
7  * 
8  * To contact author send email to drdani@mazsola.iit.uni-miskolc.hu
9  *
10  */
11
12 /* This file is part of microcontroller simulator: ucsim.
13
14 UCSIM is free software; you can redistribute it and/or modify
15 it under the terms of the GNU General Public License as published by
16 the Free Software Foundation; either version 2 of the License, or
17 (at your option) any later version.
18
19 UCSIM is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 GNU General Public License for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with UCSIM; see the file COPYING.  If not, write to the Free
26 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
27 02111-1307, USA. */
28 /*@1@*/
29
30 #include "ddconfig.h"
31
32 #include <stdarg.h> /* for va_list */
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <ctype.h>
36 #include "i_string.h"
37
38 // prj
39 #include "pobjcl.h"
40
41 // sim
42 #include "simcl.h"
43
44 // local
45 #include "z80cl.h"
46 #include "glob.h"
47 #include "regsz80.h"
48
49 #define uint32 t_addr
50 #define uint8 unsigned char
51 #define int8 char
52
53 /*******************************************************************/
54
55
56 /*
57  * Base type of Z80 controllers
58  */
59
60 cl_z80::cl_z80(class cl_sim *asim):
61   cl_uc(asim)
62 {
63   type= CPU_Z80;
64 }
65
66 int
67 cl_z80::init(void)
68 {
69   cl_uc::init(); /* Memories now exist */
70
71   rom= mem(MEM_ROM);
72 //  ram= mem(MEM_XRAM);
73   ram= rom;
74
75   // zero out ram(this is assumed in regression tests)
76   for (int i=0x8000; i<0x10000; i++) {
77     ram->set((t_addr) i, 0);
78   }
79
80   return(0);
81 }
82
83 char *
84 cl_z80::id_string(void)
85 {
86   return("unspecified Z80");
87 }
88
89
90 /*
91  * Making elements of the controller
92  */
93
94 t_addr
95 cl_z80::get_mem_size(enum mem_class type)
96 {
97   switch(type)
98     {
99     case MEM_ROM: return(0x10000);
100     case MEM_XRAM: return(0x10000);
101     default: return(0);
102     }
103  return(cl_uc::get_mem_size(type));
104 }
105
106 void
107 cl_z80::mk_hw_elements(void)
108 {
109   //class cl_base *o;
110   /* t_uc::mk_hw() does nothing */
111 }
112
113
114 /*
115  * Help command interpreter
116  */
117
118 struct dis_entry *
119 cl_z80::dis_tbl(void)
120 {
121   return(disass_z80);
122 }
123
124 /*struct name_entry *
125 cl_z80::sfr_tbl(void)
126 {
127   return(0);
128 }*/
129
130 /*struct name_entry *
131 cl_z80::bit_tbl(void)
132 {
133   //FIXME
134   return(0);
135 }*/
136
137 int
138 cl_z80::inst_length(t_addr addr)
139 {
140   int len = 0;
141   char *s;
142
143   s = get_disasm_info(addr, &len, NULL, NULL);
144
145   return len;
146 }
147
148 int
149 cl_z80::inst_branch(t_addr addr)
150 {
151   int b;
152   char *s;
153
154   s = get_disasm_info(addr, NULL, &b, NULL);
155
156   return b;
157 }
158
159 int
160 cl_z80::longest_inst(void)
161 {
162   return 4;
163 }
164
165
166 char *
167 cl_z80::get_disasm_info(t_addr addr,
168                         int *ret_len,
169                         int *ret_branch,
170                         int *immed_offset)
171 {
172   char *b = NULL;
173   uint code;
174   int len = 0;
175   int immed_n = 0;
176   int i;
177   int start_addr = addr;
178   struct dis_entry *dis_e;
179
180   code= get_mem(MEM_ROM, addr++);
181   dis_e = NULL;
182
183   switch(code) {
184     case 0xcb:  /* ESC code to lots of op-codes, all 2-byte */
185       code= get_mem(MEM_ROM, addr++);
186       i= 0;
187       while ((code & disass_z80_cb[i].mask) != disass_z80_cb[i].code &&
188         disass_z80_cb[i].mnemonic)
189         i++;
190       dis_e = &disass_z80_cb[i];
191       b= disass_z80_cb[i].mnemonic;
192       if (b != NULL)
193         len += (disass_z80_cb[i].length + 1);
194     break;
195
196     case 0xed: /* ESC code to about 80 opcodes of various lengths */
197       code= get_mem(MEM_ROM, addr++);
198       i= 0;
199       while ((code & disass_z80_ed[i].mask) != disass_z80_ed[i].code &&
200         disass_z80_ed[i].mnemonic)
201         i++;
202       dis_e = &disass_z80_ed[i];
203       b= disass_z80_ed[i].mnemonic;
204       if (b != NULL)
205         len += (disass_z80_ed[i].length + 1);
206     break;
207
208     case 0xdd: /* ESC codes,about 284, vary lengths, IX centric */
209       code= get_mem(MEM_ROM, addr++);
210       if (code == 0xcb) {
211         immed_n = 2;
212         addr++;  // pass up immed data
213         code= get_mem(MEM_ROM, addr++);
214         i= 0;
215         while ((code & disass_z80_ddcb[i].mask) != disass_z80_ddcb[i].code &&
216           disass_z80_ddcb[i].mnemonic)
217           i++;
218         dis_e = &disass_z80_ddcb[i];
219         b= disass_z80_ddcb[i].mnemonic;
220         if (b != NULL)
221           len += (disass_z80_ddcb[i].length + 2);
222       } else {
223         i= 0;
224         while ((code & disass_z80_dd[i].mask) != disass_z80_dd[i].code &&
225           disass_z80_dd[i].mnemonic)
226           i++;
227         dis_e = &disass_z80_dd[i];
228         b= disass_z80_dd[i].mnemonic;
229         if (b != NULL)
230           len += (disass_z80_dd[i].length + 1);
231       }
232     break;
233
234     case 0xfd: /* ESC codes,sme as dd but IY centric */
235       code= get_mem(MEM_ROM, addr++);
236       if (code == 0xcb) {
237         immed_n = 2;
238         addr++;  // pass up immed data
239         code= get_mem(MEM_ROM, addr++);
240         i= 0;
241         while ((code & disass_z80_fdcb[i].mask) != disass_z80_fdcb[i].code &&
242           disass_z80_fdcb[i].mnemonic)
243           i++;
244         dis_e = &disass_z80_fdcb[i];
245         b= disass_z80_fdcb[i].mnemonic;
246         if (b != NULL)
247           len += (disass_z80_fdcb[i].length + 2);
248       } else {
249         i= 0;
250         while ((code & disass_z80_fd[i].mask) != disass_z80_fd[i].code &&
251           disass_z80_fd[i].mnemonic)
252           i++;
253         dis_e = &disass_z80_fd[i];
254         b= disass_z80_fd[i].mnemonic;
255         if (b != NULL)
256           len += (disass_z80_fd[i].length + 1);
257       }
258     break;
259
260     default:
261       i= 0;
262       while ((code & disass_z80[i].mask) != disass_z80[i].code &&
263              disass_z80[i].mnemonic)
264         i++;
265       dis_e = &disass_z80[i];
266       b= disass_z80[i].mnemonic;
267       if (b != NULL)
268         len += (disass_z80[i].length);
269     break;
270   }
271
272
273   if (ret_branch) {
274     *ret_branch = dis_e->branch;
275   }
276
277   if (immed_offset) {
278     if (immed_n > 0)
279          *immed_offset = immed_n;
280     else *immed_offset = (addr - start_addr);
281   }
282
283   if (len == 0)
284     len = 1;
285
286   if (ret_len)
287     *ret_len = len;
288
289   return b;
290 }
291
292 char *
293 cl_z80::disass(t_addr addr, char *sep)
294 {
295   char work[256], temp[20];
296   char *buf, *p, *b, *t;
297   int len = 0;
298   int immed_offset = 0;
299
300   p= work;
301
302   b = get_disasm_info(addr, &len, NULL, &immed_offset);
303   
304   if (b == NULL) {
305     buf= (char*)malloc(30);
306     strcpy(buf, "UNKNOWN/INVALID");
307     return(buf);
308   }
309
310   while (*b)
311     {
312       if (*b == '%')
313         {
314           b++;
315           switch (*(b++))
316             {
317             case 'd': // d    jump relative target, signed? byte immediate operand
318               sprintf(temp, "#%d", (char)get_mem(MEM_ROM, addr+immed_offset));
319               ++immed_offset;
320               break;
321             case 'w': // w    word immediate operand
322               sprintf(temp, "#0x%04x",
323                  (uint)((get_mem(MEM_ROM, addr+immed_offset)) |
324                         (get_mem(MEM_ROM, addr+immed_offset+1)<<8)) );
325               ++immed_offset;
326               ++immed_offset;
327               break;
328             case 'b': // b    byte immediate operand
329               sprintf(temp, "#0x%02x", (uint)get_mem(MEM_ROM, addr+immed_offset));
330               ++immed_offset;
331               break;
332             default:
333               strcpy(temp, "?");
334               break;
335             }
336           t= temp;
337           while (*t)
338             *(p++)= *(t++);
339         }
340       else
341         *(p++)= *(b++);
342     }
343   *p= '\0';
344
345   p= strchr(work, ' ');
346   if (!p)
347     {
348       buf= strdup(work);
349       return(buf);
350     }
351   if (sep == NULL)
352     buf= (char *)malloc(6+strlen(p)+1);
353   else
354     buf= (char *)malloc((p-work)+strlen(sep)+strlen(p)+1);
355   for (p= work, b= buf; *p != ' '; p++, b++)
356     *b= *p;
357   p++;
358   *b= '\0';
359   if (sep == NULL)
360     {
361       while (strlen(buf) < 6)
362         strcat(buf, " ");
363     }
364   else
365     strcat(buf, sep);
366   strcat(buf, p);
367   return(buf);
368 }
369
370
371 void
372 cl_z80::print_regs(class cl_console *con)
373 {
374   con->dd_printf("SZ-A--P-C  Flags= 0x%02x %3d %c  ",
375                  regs.F, regs.F, isprint(regs.F)?regs.F:'.');
376   con->dd_printf("A= 0x%02x %3d %c\n",
377                  regs.A, regs.A, isprint(regs.A)?regs.A:'.');
378   con->dd_printf("%c%c-%c--%c-%c\n",
379                  (regs.F&BIT_S)?'1':'0',
380                  (regs.F&BIT_Z)?'1':'0',
381                  (regs.F&BIT_A)?'1':'0',
382                  (regs.F&BIT_P)?'1':'0',
383                  (regs.F&BIT_C)?'1':'0');
384   con->dd_printf("BC= 0x%04x [BC]= %02x %3d %c  ",
385                  regs.BC, ram->get(regs.BC), ram->get(regs.BC),
386                  isprint(ram->get(regs.BC))?ram->get(regs.BC):'.');
387   con->dd_printf("DE= 0x%04x [DE]= %02x %3d %c  ",
388                  regs.DE, ram->get(regs.DE), ram->get(regs.DE),
389                  isprint(ram->get(regs.DE))?ram->get(regs.DE):'.');
390   con->dd_printf("HL= 0x%04x [HL]= %02x %3d %c\n",
391                  regs.HL, ram->get(regs.HL), ram->get(regs.HL),
392                  isprint(ram->get(regs.HL))?ram->get(regs.HL):'.');
393   con->dd_printf("IX= 0x%04x [IX]= %02x %3d %c  ",
394                  regs.IX, ram->get(regs.IX), ram->get(regs.IX),
395                  isprint(ram->get(regs.IX))?ram->get(regs.IX):'.');
396   con->dd_printf("IY= 0x%04x [IY]= %02x %3d %c  ",
397                  regs.IY, ram->get(regs.IY), ram->get(regs.IY),
398                  isprint(ram->get(regs.IY))?ram->get(regs.IY):'.');
399   con->dd_printf("SP= 0x%04x [SP]= %02x %3d %c\n",
400                  regs.SP, ram->get(regs.SP), ram->get(regs.SP),
401                  isprint(ram->get(regs.SP))?ram->get(regs.SP):'.');
402   
403   print_disass(PC, con);
404 }
405
406 /*
407  * Execution
408  */
409
410 int
411 cl_z80::exec_inst(void)
412 {
413   t_mem code;
414
415   if (fetch(&code))
416     return(resBREAKPOINT);
417   tick(1);
418   switch (code)
419     {
420     case 0x00: return(inst_nop(code));
421     case 0x01: case 0x02: case 0x06: return(inst_ld(code));
422     case 0x03: case 0x04: return(inst_inc(code));
423     case 0x05: return(inst_dec(code));
424     case 0x07: return(inst_rlca(code));
425
426     case 0x08: return(inst_ex(code));
427     case 0x09: return(inst_add(code));
428     case 0x0a: case 0x0e: return(inst_ld(code));
429     case 0x0b: case 0x0d: return(inst_dec(code));
430     case 0x0c: return(inst_inc(code));
431     case 0x0f: return(inst_rrca(code));
432
433
434     case 0x10: return(inst_djnz(code));
435     case 0x11: case 0x12: case 0x16: return(inst_ld(code));
436     case 0x13: case 0x14: return(inst_inc(code));
437     case 0x15: return(inst_dec(code));
438     case 0x17: return(inst_rla(code));
439
440     case 0x18: return(inst_jr(code));
441     case 0x19: return(inst_add(code));
442     case 0x1a: case 0x1e: return(inst_ld(code));
443     case 0x1b: case 0x1d: return(inst_dec(code));
444     case 0x1c: return(inst_inc(code));
445     case 0x1f: return(inst_rra(code));
446
447
448     case 0x20: return(inst_jr(code));
449     case 0x21: case 0x22: case 0x26: return(inst_ld(code));
450     case 0x23: case 0x24: return(inst_inc(code));
451     case 0x25: return(inst_dec(code));
452     case 0x27: return(inst_daa(code));
453
454     case 0x28: return(inst_jr(code));
455     case 0x29: return(inst_add(code));
456     case 0x2a: case 0x2e: return(inst_ld(code));
457     case 0x2b: case 0x2d: return(inst_dec(code));
458     case 0x2c: return(inst_inc(code));
459     case 0x2f: return(inst_cpl(code));
460
461
462     case 0x30: return(inst_jr(code));
463     case 0x31: case 0x32: case 0x36: return(inst_ld(code));
464     case 0x33: case 0x34: return(inst_inc(code));
465     case 0x35: return(inst_dec(code));
466     case 0x37: return(inst_scf(code));
467
468     case 0x38: return(inst_jr(code));
469     case 0x39: return(inst_add(code));
470     case 0x3a: case 0x3e: return(inst_ld(code));
471     case 0x3b: case 0x3d: return(inst_dec(code));
472     case 0x3c: return(inst_inc(code));
473     case 0x3f: return(inst_ccf(code));
474
475     case 0x40: case 0x41: case 0x42: case 0x43: case 0x44: case 0x45: case 0x46: case 0x47:
476     case 0x48: case 0x49: case 0x4a: case 0x4b: case 0x4c: case 0x4d: case 0x4e: case 0x4f:
477       return(inst_ld(code));
478
479     case 0x50: case 0x51: case 0x52: case 0x53: case 0x54: case 0x55: case 0x56: case 0x57:
480     case 0x58: case 0x59: case 0x5a: case 0x5b: case 0x5c: case 0x5d: case 0x5e: case 0x5f:
481       return(inst_ld(code));
482
483     case 0x60: case 0x61: case 0x62: case 0x63: case 0x64: case 0x65: case 0x66: case 0x67:
484     case 0x68: case 0x69: case 0x6a: case 0x6b: case 0x6c: case 0x6d: case 0x6e: case 0x6f:
485       return(inst_ld(code));
486
487     case 0x70: case 0x71: case 0x72: case 0x73: case 0x74: case 0x75: case 0x77:
488     case 0x78: case 0x79: case 0x7a: case 0x7b: case 0x7c: case 0x7d: case 0x7e: case 0x7f:
489       return(inst_ld(code));
490     case 0x76: 
491       return(inst_halt(code));
492
493     case 0x80: case 0x81: case 0x82: case 0x83: case 0x84: case 0x85: case 0x86: case 0x87:
494       return(inst_add(code));
495     case 0x88: case 0x89: case 0x8a: case 0x8b: case 0x8c: case 0x8d: case 0x8e: case 0x8f:
496       return(inst_adc(code));
497
498     case 0x90: case 0x91: case 0x92: case 0x93: case 0x94: case 0x95: case 0x96: case 0x97:
499       return(inst_sub(code));
500     case 0x98: case 0x99: case 0x9a: case 0x9b: case 0x9c: case 0x9d: case 0x9e: case 0x9f:
501       return(inst_sbc(code));
502
503     case 0xa0: case 0xa1: case 0xa2: case 0xa3: case 0xa4: case 0xa5: case 0xa6: case 0xa7:
504       return(inst_and(code));
505     case 0xa8: case 0xa9: case 0xaa: case 0xab: case 0xac: case 0xad: case 0xae: case 0xaf:
506       return(inst_xor(code));
507
508     case 0xb0: case 0xb1: case 0xb2: case 0xb3: case 0xb4: case 0xb5: case 0xb6: case 0xb7:
509       return(inst_or(code));
510     case 0xb8: case 0xb9: case 0xba: case 0xbb: case 0xbc: case 0xbd: case 0xbe: case 0xbf:
511       return(inst_cp(code));
512
513     case 0xc0: return(inst_ret(code));
514     case 0xc1: return(inst_pop(code));
515     case 0xc2: case 0xc3: return(inst_jp(code));
516     case 0xc4: return(inst_call(code));
517     case 0xc5: return(inst_push(code));
518     case 0xc6: return(inst_add(code));
519     case 0xc7: return(inst_rst(code));
520
521     case 0xc8: case 0xc9: return(inst_ret(code));
522     case 0xca: return(inst_jp(code));
523
524       /* CB escapes out to 2 byte opcodes(CB include), opcodes
525          to do register bit manipulations */
526     case 0xcb: return(inst_cb());
527     case 0xcc: case 0xcd: return(inst_call(code));
528     case 0xce: return(inst_adc(code));
529     case 0xcf: return(inst_rst(code));
530
531
532     case 0xd0: return(inst_ret(code));
533     case 0xd1: return(inst_pop(code));
534     case 0xd2: return(inst_jp(code));
535     case 0xd3: return(inst_out(code));
536     case 0xd4: return(inst_call(code));
537     case 0xd5: return(inst_push(code));
538     case 0xd6: return(inst_sub(code));
539     case 0xd7: return(inst_rst(code));
540
541     case 0xd8: return(inst_ret(code));
542     case 0xd9: return(inst_exx(code));
543     case 0xda: return(inst_jp(code));
544     case 0xdb: return(inst_in(code));
545     case 0xdc: return(inst_call(code));
546       /* DD escapes out to 2 to 4 byte opcodes(DD included)
547         with a variety of uses.  It can precede the CB escape
548         sequence to extend CB codes with IX+immed_byte */
549     case 0xdd: return(inst_dd());
550     case 0xde: return(inst_sbc(code));
551     case 0xdf: return(inst_rst(code));
552
553
554     case 0xe0: return(inst_ret(code));
555     case 0xe1: return(inst_pop(code));
556     case 0xe2: return(inst_jp(code));
557     case 0xe3: return(inst_ex(code));
558     case 0xe4: return(inst_call(code));
559     case 0xe5: return(inst_push(code));
560     case 0xe6: return(inst_and(code));
561     case 0xe7: return(inst_rst(code));
562
563     case 0xe8: return(inst_ret(code));
564     case 0xe9: return(inst_jp(code));
565     case 0xea: return(inst_jp(code));
566     case 0xeb: return(inst_ex(code));
567     case 0xec: return(inst_call(code));
568       /* ED escapes out to misc IN, OUT and other oddball opcodes */
569     case 0xed: return(inst_ed());
570     case 0xee: return(inst_xor(code));
571     case 0xef: return(inst_rst(code));
572
573
574     case 0xf0: return(inst_ret(code));
575     case 0xf1: return(inst_pop(code));
576     case 0xf2: return(inst_jp(code));
577     case 0xf3: return(inst_di(code));
578     case 0xf4: return(inst_call(code));
579     case 0xf5: return(inst_push(code));
580     case 0xf6: return(inst_or(code));
581     case 0xf7: return(inst_rst(code));
582
583     case 0xf8: return(inst_ret(code));
584     case 0xf9: return(inst_ld(code));
585     case 0xfa: return(inst_jp(code));
586     case 0xfb: return(inst_ei(code));
587     case 0xfc: return(inst_call(code));
588       /* DD escapes out to 2 to 4 byte opcodes(DD included)
589         with a variety of uses.  It can precede the CB escape
590         sequence to extend CB codes with IX+immed_byte */
591     case 0xfd: return(inst_fd());
592     case 0xfe: return(inst_cp(code));
593     case 0xff: return(inst_rst(code));
594     }
595
596   if (PC)
597     PC--;
598   else
599     PC= get_mem_size(MEM_ROM)-1;
600
601   sim->stop(resINV_INST);
602   return(resINV_INST);
603 }
604
605
606 /* End of z80.src/z80.cc */