AArch64: Refactor err_type.
[external/binutils.git] / opcodes / h8300-dis.c
1 /* Disassemble h8300 instructions.
2    Copyright (C) 1993-2018 Free Software Foundation, Inc.
3
4    This file is part of the GNU opcodes library.
5
6    This library is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3, or (at your option)
9    any later version.
10
11    It is distributed in the hope that it will be useful, but WITHOUT
12    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13    or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
14    License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
19    MA 02110-1301, USA.  */
20
21 #define DEFINE_TABLE
22
23 #include "sysdep.h"
24 #define h8_opcodes h8ops
25 #include "opcode/h8300.h"
26 #include "disassemble.h"
27 #include "opintl.h"
28 #include "libiberty.h"
29
30 struct h8_instruction
31 {
32   int length;
33   const struct h8_opcode *opcode;
34 };
35
36 struct h8_instruction *h8_instructions;
37
38 /* Run through the opcodes and sort them into order to make them easy
39    to disassemble.  */
40
41 static void
42 bfd_h8_disassemble_init (void)
43 {
44   unsigned int i;
45   unsigned int nopcodes;
46   const struct h8_opcode *p;
47   struct h8_instruction *pi;
48
49   nopcodes = sizeof (h8_opcodes) / sizeof (struct h8_opcode);
50
51   h8_instructions = xmalloc (nopcodes * sizeof (struct h8_instruction));
52
53   for (p = h8_opcodes, pi = h8_instructions; p->name; p++, pi++)
54     {
55       /* Just make sure there are an even number of nibbles in it, and
56          that the count is the same as the length.  */
57       for (i = 0; p->data.nib[i] != (op_type) E; i++)
58         ;
59
60       if (i & 1)
61         {
62           /* xgettext:c-format */
63           opcodes_error_handler (_("internal error, h8_disassemble_init"));
64           abort ();
65         }
66
67       pi->length = i / 2;
68       pi->opcode = p;
69     }
70
71   /* Add entry for the NULL vector terminator.  */
72   pi->length = 0;
73   pi->opcode = p;
74 }
75
76 static void
77 extract_immediate (FILE *stream,
78                    op_type looking_for,
79                    int thisnib,
80                    unsigned char *data,
81                    int *cst,
82                    int *len,
83                    const struct h8_opcode *q)
84 {
85   switch (looking_for & SIZE)
86     {
87     case L_2:
88       *len = 2;
89       *cst = thisnib & 3;
90
91       /* DISP2 special treatment.  */
92       if ((looking_for & MODE) == DISP)
93         {
94           if (OP_KIND (q->how) == O_MOVAB
95               || OP_KIND (q->how) == O_MOVAW
96               || OP_KIND (q->how) == O_MOVAL)
97             {
98               /* Handling for mova insn.  */
99               switch (q->args.nib[0] & MODE)
100                 {
101                 case INDEXB:
102                 default:
103                   break;
104                 case INDEXW:
105                   *cst *= 2;
106                   break;
107                 case INDEXL:
108                   *cst *= 4;
109                   break;
110                 }
111             }
112           else
113             {
114               /* Handling for non-mova insn.  */
115               switch (OP_SIZE (q->how))
116                 {
117                 default: break;
118                 case SW:
119                   *cst *= 2;
120                   break;
121                 case SL:
122                   *cst *= 4;
123                   break;
124                 }
125             }
126         }
127       break;
128     case L_8:
129       *len = 8;
130       *cst = data[0];
131       break;
132     case L_16:
133     case L_16U:
134       *len = 16;
135       *cst = (data[0] << 8) + data [1];
136 #if 0
137       if ((looking_for & SIZE) == L_16)
138         *cst = (short) *cst;    /* Sign extend.  */
139 #endif
140       break;
141     case L_32:
142       *len = 32;
143       *cst = (data[0] << 24) + (data[1] << 16) + (data[2] << 8) + data[3];
144       break;
145     default:
146       *len = 0;
147       *cst = 0;
148       fprintf (stream, "DISP bad size\n");
149       break;
150     }
151 }
152
153 static const char *regnames[] =
154 {
155   "r0h", "r1h", "r2h", "r3h", "r4h", "r5h", "r6h", "r7h",
156   "r0l", "r1l", "r2l", "r3l", "r4l", "r5l", "r6l", "r7l"
157 };
158 static const char *wregnames[] =
159 {
160   "r0", "r1", "r2", "r3", "r4", "r5", "r6", "r7",
161   "e0", "e1", "e2", "e3", "e4", "e5", "e6", "e7"
162 };
163 static const char *lregnames[] =
164 {
165   "er0", "er1", "er2", "er3", "er4", "er5", "er6", "er7",
166   "er0", "er1", "er2", "er3", "er4", "er5", "er6", "er7"
167 };
168 static const char *cregnames[] =
169 {
170   "ccr", "exr", "mach", "macl", "", "", "vbr", "sbr"
171 };
172
173 static void
174 print_one_arg (disassemble_info *info,
175                bfd_vma addr,
176                op_type x,
177                int cst,
178                int cstlen,
179                int rdisp_n,
180                int rn,
181                const char **pregnames,
182                int len)
183 {
184   void * stream = info->stream;
185   fprintf_ftype outfn = info->fprintf_func;
186
187   if ((x & SIZE) == L_3 || (x & SIZE) == L_3NZ)
188     outfn (stream, "#0x%x", (unsigned) cst);
189   else if ((x & MODE) == IMM)
190     outfn (stream, "#0x%x", (unsigned) cst);
191   else if ((x & MODE) == DBIT || (x & MODE) == KBIT)
192     outfn (stream, "#%d", (unsigned) cst);
193   else if ((x & MODE) == CONST_2)
194     outfn (stream, "#2");
195   else if ((x & MODE) == CONST_4)
196     outfn (stream, "#4");
197   else if ((x & MODE) == CONST_8)
198     outfn (stream, "#8");
199   else if ((x & MODE) == CONST_16)
200     outfn (stream, "#16");
201   else if ((x & MODE) == REG)
202     {
203       switch (x & SIZE)
204         {
205         case L_8:
206           outfn (stream, "%s", regnames[rn]);
207           break;
208         case L_16:
209         case L_16U:
210           outfn (stream, "%s", wregnames[rn]);
211           break;
212         case L_P:
213         case L_32:
214           outfn (stream, "%s", lregnames[rn]);
215           break;
216         }
217     }
218   else if ((x & MODE) == LOWREG)
219     {
220       switch (x & SIZE)
221         {
222         case L_8:
223           /* Always take low half of reg.  */
224           outfn (stream, "%s.b", regnames[rn < 8 ? rn + 8 : rn]);
225           break;
226         case L_16:
227         case L_16U:
228           /* Always take low half of reg.  */
229           outfn (stream, "%s.w", wregnames[rn < 8 ? rn : rn - 8]);
230           break;
231         case L_P:
232         case L_32:
233           outfn (stream, "%s.l", lregnames[rn]);
234           break;
235         }
236     }
237   else if ((x & MODE) == POSTINC)
238     outfn (stream, "@%s+", pregnames[rn]);
239
240   else if ((x & MODE) == POSTDEC)
241     outfn (stream, "@%s-", pregnames[rn]);
242
243   else if ((x & MODE) == PREINC)
244     outfn (stream, "@+%s", pregnames[rn]);
245
246   else if ((x & MODE) == PREDEC)
247     outfn (stream, "@-%s", pregnames[rn]);
248
249   else if ((x & MODE) == IND)
250     outfn (stream, "@%s", pregnames[rn]);
251
252   else if ((x & MODE) == ABS || (x & ABSJMP))
253     outfn (stream, "@0x%x:%d", (unsigned) cst, cstlen);
254
255   else if ((x & MODE) == MEMIND)
256     outfn (stream, "@@%d (0x%x)", cst, cst);
257
258   else if ((x & MODE) == VECIND)
259     {
260       /* FIXME Multiplier should be 2 or 4, depending on processor mode,
261          by which is meant "normal" vs. "middle", "advanced", "maximum".  */
262
263       int offset = (cst + 0x80) * 4;
264       outfn (stream, "@@%d (0x%x)", offset, offset);
265     }
266   else if ((x & MODE) == PCREL)
267     {
268       if ((x & SIZE) == L_16 ||
269           (x & SIZE) == L_16U)
270         {
271           outfn (stream, ".%s%d (0x%lx)",
272                    (short) cst > 0 ? "+" : "",
273                    (short) cst,
274                    (long)(addr + (short) cst + len));
275         }
276       else
277         {
278           outfn (stream, ".%s%d (0x%lx)",
279                    (char) cst > 0 ? "+" : "",
280                    (char) cst,
281                    (long)(addr + (char) cst + len));
282         }
283     }
284   else if ((x & MODE) == DISP)
285     outfn (stream, "@(0x%x:%d,%s)", cst, cstlen, pregnames[rdisp_n]);
286
287   else if ((x & MODE) == INDEXB)
288     /* Always take low half of reg.  */
289     outfn (stream, "@(0x%x:%d,%s.b)", cst, cstlen,
290            regnames[rdisp_n < 8 ? rdisp_n + 8 : rdisp_n]);
291
292   else if ((x & MODE) == INDEXW)
293     /* Always take low half of reg.  */
294     outfn (stream, "@(0x%x:%d,%s.w)", cst, cstlen,
295            wregnames[rdisp_n < 8 ? rdisp_n : rdisp_n - 8]);
296
297   else if ((x & MODE) == INDEXL)
298     outfn (stream, "@(0x%x:%d,%s.l)", cst, cstlen, lregnames[rdisp_n]);
299
300   else if (x & CTRL)
301     outfn (stream, "%s", cregnames[rn]);
302
303   else if ((x & MODE) == CCR)
304     outfn (stream, "ccr");
305
306   else if ((x & MODE) == EXR)
307     outfn (stream, "exr");
308
309   else if ((x & MODE) == MACREG)
310     outfn (stream, "mac%c", cst ? 'l' : 'h');
311
312   else
313     /* xgettext:c-format */
314     outfn (stream, _("Hmmmm 0x%x"), x);
315 }
316
317 static unsigned int
318 bfd_h8_disassemble (bfd_vma addr, disassemble_info *info, int mach)
319 {
320   /* Find the first entry in the table for this opcode.  */
321   int regno[3] = { 0, 0, 0 };
322   int dispregno[3] = { 0, 0, 0 };
323   int cst[3] = { 0, 0, 0 };
324   int cstlen[3] = { 0, 0, 0 };
325   static bfd_boolean init = 0;
326   const struct h8_instruction *qi;
327   char const **pregnames = mach != 0 ? lregnames : wregnames;
328   int status;
329   unsigned int l;
330   unsigned char data[MAX_CODE_NIBBLES];
331   void *stream = info->stream;
332   fprintf_ftype outfn = info->fprintf_func;
333
334   if (!init)
335     {
336       bfd_h8_disassemble_init ();
337       init = 1;
338     }
339
340   status = info->read_memory_func (addr, data, 2, info);
341   if (status != 0)
342     {
343       info->memory_error_func (status, addr, info);
344       return -1;
345     }
346
347   for (l = 2; status == 0 && l < sizeof (data) / 2; l += 2)
348     status = info->read_memory_func (addr + l, data + l, 2, info);
349
350   /* Find the exact opcode/arg combo.  */
351   for (qi = h8_instructions; qi->opcode->name; qi++)
352     {
353       const struct h8_opcode *q = qi->opcode;
354       const op_type *nib = q->data.nib;
355       unsigned int len = 0;
356
357       while (1)
358         {
359           op_type looking_for = *nib;
360           int thisnib = data[len / 2];
361           int opnr;
362
363           thisnib = (len & 1) ? (thisnib & 0xf) : ((thisnib / 16) & 0xf);
364           opnr = ((looking_for & OP3) == OP3 ? 2
365                   : (looking_for & DST) == DST ? 1 : 0);
366
367           if (looking_for < 16 && looking_for >= 0)
368             {
369               if (looking_for != thisnib)
370                 goto fail;
371             }
372           else
373             {
374               if ((int) looking_for & (int) B31)
375                 {
376                   if (!((thisnib & 0x8) != 0))
377                     goto fail;
378
379                   looking_for = (op_type) ((int) looking_for & ~(int) B31);
380                   thisnib &= 0x7;
381                 }
382               else if ((int) looking_for & (int) B30)
383                 {
384                   if (!((thisnib & 0x8) == 0))
385                     goto fail;
386
387                   looking_for = (op_type) ((int) looking_for & ~(int) B30);
388                 }
389
390               if ((int) looking_for & (int) B21)
391                 {
392                   if (!((thisnib & 0x4) != 0))
393                     goto fail;
394
395                   looking_for = (op_type) ((int) looking_for & ~(int) B21);
396                   thisnib &= 0xb;
397                 }
398               else if ((int) looking_for & (int) B20)
399                 {
400                   if (!((thisnib & 0x4) == 0))
401                     goto fail;
402
403                   looking_for = (op_type) ((int) looking_for & ~(int) B20);
404                 }
405               if ((int) looking_for & (int) B11)
406                 {
407                   if (!((thisnib & 0x2) != 0))
408                     goto fail;
409
410                   looking_for = (op_type) ((int) looking_for & ~(int) B11);
411                   thisnib &= 0xd;
412                 }
413               else if ((int) looking_for & (int) B10)
414                 {
415                   if (!((thisnib & 0x2) == 0))
416                     goto fail;
417
418                   looking_for = (op_type) ((int) looking_for & ~(int) B10);
419                 }
420
421               if ((int) looking_for & (int) B01)
422                 {
423                   if (!((thisnib & 0x1) != 0))
424                     goto fail;
425
426                   looking_for = (op_type) ((int) looking_for & ~(int) B01);
427                   thisnib &= 0xe;
428                 }
429               else if ((int) looking_for & (int) B00)
430                 {
431                   if (!((thisnib & 0x1) == 0))
432                     goto fail;
433
434                   looking_for = (op_type) ((int) looking_for & ~(int) B00);
435                 }
436
437               if (looking_for & IGNORE)
438                 {
439                   /* Hitachi has declared that IGNORE must be zero.  */
440                   if (thisnib != 0)
441                     goto fail;
442                 }
443               else if ((looking_for & MODE) == DATA)
444                 {
445                   ;                     /* Skip embedded data.  */
446                 }
447               else if ((looking_for & MODE) == DBIT)
448                 {
449                   /* Exclude adds/subs by looking at bit 0 and 2, and
450                      make sure the operand size, either w or l,
451                      matches by looking at bit 1.  */
452                   if ((looking_for & 7) != (thisnib & 7))
453                     goto fail;
454
455                   cst[opnr] = (thisnib & 0x8) ? 2 : 1;
456                 }
457               else if ((looking_for & MODE) == DISP
458                        || (looking_for & MODE) == ABS
459                        || (looking_for & MODE) == PCREL
460                        || (looking_for & MODE) == INDEXB
461                        || (looking_for & MODE) == INDEXW
462                        || (looking_for & MODE) == INDEXL)
463                 {
464                   extract_immediate (stream, looking_for, thisnib,
465                                      data + len / 2, cst + opnr,
466                                      cstlen + opnr, q);
467                   /* Even address == bra, odd == bra/s.  */
468                   if (q->how == O (O_BRAS, SB))
469                     cst[opnr] -= 1;
470                 }
471               else if ((looking_for & MODE) == REG
472                        || (looking_for & MODE) == LOWREG
473                        || (looking_for & MODE) == IND
474                        || (looking_for & MODE) == PREINC
475                        || (looking_for & MODE) == POSTINC
476                        || (looking_for & MODE) == PREDEC
477                        || (looking_for & MODE) == POSTDEC)
478                 {
479                   regno[opnr] = thisnib;
480                 }
481               else if (looking_for & CTRL)      /* Control Register.  */
482                 {
483                   thisnib &= 7;
484                   if (((looking_for & MODE) == CCR  && (thisnib != C_CCR))
485                       || ((looking_for & MODE) == EXR  && (thisnib != C_EXR))
486                       || ((looking_for & MODE) == MACH && (thisnib != C_MACH))
487                       || ((looking_for & MODE) == MACL && (thisnib != C_MACL))
488                       || ((looking_for & MODE) == VBR  && (thisnib != C_VBR))
489                       || ((looking_for & MODE) == SBR  && (thisnib != C_SBR)))
490                     goto fail;
491                   if (((looking_for & MODE) == CCR_EXR
492                        && (thisnib != C_CCR && thisnib != C_EXR))
493                       || ((looking_for & MODE) == VBR_SBR
494                           && (thisnib != C_VBR && thisnib != C_SBR))
495                       || ((looking_for & MODE) == MACREG
496                           && (thisnib != C_MACH && thisnib != C_MACL)))
497                     goto fail;
498                   if (((looking_for & MODE) == CC_EX_VB_SB
499                        && (thisnib != C_CCR && thisnib != C_EXR
500                            && thisnib != C_VBR && thisnib != C_SBR)))
501                     goto fail;
502
503                   regno[opnr] = thisnib;
504                 }
505               else if ((looking_for & SIZE) == L_5)
506                 {
507                   cst[opnr] = data[len / 2] & 31;
508                   cstlen[opnr] = 5;
509                 }
510               else if ((looking_for & SIZE) == L_4)
511                 {
512                   cst[opnr] = thisnib;
513                   cstlen[opnr] = 4;
514                 }
515               else if ((looking_for & SIZE) == L_16
516                        || (looking_for & SIZE) == L_16U)
517                 {
518                   cst[opnr] = (data[len / 2]) * 256 + data[(len + 2) / 2];
519                   cstlen[opnr] = 16;
520                 }
521               else if ((looking_for & MODE) == MEMIND)
522                 {
523                   cst[opnr] = data[1];
524                 }
525               else if ((looking_for & MODE) == VECIND)
526                 {
527                   cst[opnr] = data[1] & 0x7f;
528                 }
529               else if ((looking_for & SIZE) == L_32)
530                 {
531                   int i = len / 2;
532
533                   cst[opnr] = ((data[i] << 24)
534                                | (data[i + 1] << 16)
535                                | (data[i + 2] << 8)
536                                | (data[i + 3]));
537
538                   cstlen[opnr] = 32;
539                 }
540               else if ((looking_for & SIZE) == L_24)
541                 {
542                   int i = len / 2;
543
544                   cst[opnr] =
545                     (data[i] << 16) | (data[i + 1] << 8) | (data[i + 2]);
546                   cstlen[opnr] = 24;
547                 }
548               else if (looking_for & DISPREG)
549                 {
550                   dispregno[opnr] = thisnib & 7;
551                 }
552               else if ((looking_for & MODE) == KBIT)
553                 {
554                   switch (thisnib)
555                     {
556                     case 9:
557                       cst[opnr] = 4;
558                       break;
559                     case 8:
560                       cst[opnr] = 2;
561                       break;
562                     case 0:
563                       cst[opnr] = 1;
564                       break;
565                     default:
566                       goto fail;
567                     }
568                 }
569               else if ((looking_for & SIZE) == L_8)
570                 {
571                   cstlen[opnr] = 8;
572                   cst[opnr] = data[len / 2];
573                 }
574               else if ((looking_for & SIZE) == L_3
575                        || (looking_for & SIZE) == L_3NZ)
576                 {
577                   cst[opnr] = thisnib & 0x7;
578                   if (cst[opnr] == 0 && (looking_for & SIZE) == L_3NZ)
579                     goto fail;
580                 }
581               else if ((looking_for & SIZE) == L_2)
582                 {
583                   cstlen[opnr] = 2;
584                   cst[opnr] = thisnib & 0x3;
585                 }
586               else if ((looking_for & MODE) == MACREG)
587                 {
588                   cst[opnr] = (thisnib == 3);
589                 }
590               else if (looking_for == (op_type) E)
591                 {
592                   outfn (stream, "%s\t", q->name);
593
594                   /* Gross.  Disgusting.  */
595                   if (strcmp (q->name, "ldm.l") == 0)
596                     {
597                       int count, high;
598
599                       count = (data[1] / 16) & 0x3;
600                       high = regno[1];
601
602                       outfn (stream, "@sp+,er%d-er%d", high - count, high);
603                       return qi->length;
604                     }
605
606                   if (strcmp (q->name, "stm.l") == 0)
607                     {
608                       int count, low;
609
610                       count = (data[1] / 16) & 0x3;
611                       low = regno[0];
612
613                       outfn (stream, "er%d-er%d,@-sp", low, low + count);
614                       return qi->length;
615                     }
616                   if (strcmp (q->name, "rte/l") == 0
617                       || strcmp (q->name, "rts/l") == 0)
618                     {
619                       if (regno[0] == 0)
620                         outfn (stream, "er%d", regno[1]);
621                       else
622                         outfn (stream, "er%d-er%d", regno[1] - regno[0],
623                                regno[1]);
624                       return qi->length;
625                     }
626                   if (CONST_STRNEQ (q->name, "mova"))
627                     {
628                       const op_type *args = q->args.nib;
629
630                       if (args[1] == (op_type) E)
631                         {
632                           /* Short form.  */
633                           print_one_arg (info, addr, args[0], cst[0],
634                                          cstlen[0], dispregno[0], regno[0],
635                                          pregnames, qi->length);
636                           outfn (stream, ",er%d", dispregno[0]);
637                         }
638                       else
639                         {
640                           outfn (stream, "@(0x%x:%d,", cst[0], cstlen[0]);
641                           print_one_arg (info, addr, args[1], cst[1],
642                                          cstlen[1], dispregno[1], regno[1],
643                                          pregnames, qi->length);
644                           outfn (stream, ".%c),",
645                                  (args[0] & MODE) == INDEXB ? 'b' : 'w');
646                           print_one_arg (info, addr, args[2], cst[2],
647                                          cstlen[2], dispregno[2], regno[2],
648                                          pregnames, qi->length);
649                         }
650                       return qi->length;
651                     }
652                   /* Fill in the args.  */
653                   {
654                     const op_type *args = q->args.nib;
655                     int hadone = 0;
656                     int nargs;
657
658                     /* Special case handling for the adds and subs instructions
659                        since in H8 mode thay can only take the r0-r7 registers
660                        but in other (higher) modes they can take the er0-er7
661                        registers as well.  */
662                     if (strcmp (qi->opcode->name, "adds") == 0
663                         || strcmp (qi->opcode->name, "subs") == 0)
664                       {
665                         outfn (stream, "#%d,%s", cst[0], pregnames[regno[1] & 0x7]);
666                         return qi->length;
667                       }
668
669                     for (nargs = 0;
670                          nargs < 3 && args[nargs] != (op_type) E;
671                          nargs++)
672                       {
673                         int x = args[nargs];
674
675                         if (hadone)
676                           outfn (stream, ",");
677
678                         print_one_arg (info, addr, x,
679                                        cst[nargs], cstlen[nargs],
680                                        dispregno[nargs], regno[nargs],
681                                        pregnames, qi->length);
682
683                         hadone = 1;
684                       }
685                   }
686
687                   return qi->length;
688                 }
689               else
690                 /* xgettext:c-format */
691                 outfn (stream, _("Don't understand 0x%x \n"), looking_for);
692             }
693
694           len++;
695           nib++;
696         }
697
698     fail:
699       ;
700     }
701
702   /* Fell off the end.  */
703   outfn (stream, ".word\tH'%x,H'%x", data[0], data[1]);
704   return 2;
705 }
706
707 int
708 print_insn_h8300 (bfd_vma addr, disassemble_info *info)
709 {
710   return bfd_h8_disassemble (addr, info, 0);
711 }
712
713 int
714 print_insn_h8300h (bfd_vma addr, disassemble_info *info)
715 {
716   return bfd_h8_disassemble (addr, info, 1);
717 }
718
719 int
720 print_insn_h8300s (bfd_vma addr, disassemble_info *info)
721 {
722   return bfd_h8_disassemble (addr, info, 2);
723 }