1 /* Disassembler code for CR16.
2 Copyright (C) 2007-2018 Free Software Foundation, Inc.
3 Contributed by M R Swami Reddy (MR.Swami.Reddy@nsc.com).
5 This file is part of GAS, GDB and the GNU binutils.
7 This program is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3, or (at your option)
12 This program is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software Foundation,
19 Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
22 #include "disassemble.h"
23 #include "opcode/cr16.h"
24 #include "libiberty.h"
26 /* String to print when opcode was not matched. */
27 #define ILLEGAL "illegal"
28 /* Escape to 16-bit immediate. */
29 #define ESCAPE_16_BIT 0xB
31 /* Extract 'n_bits' from 'a' starting from offset 'offs'. */
32 #define EXTRACT(a, offs, n_bits) \
33 (n_bits == 32 ? (((a) >> (offs)) & 0xffffffffL) \
34 : (((a) >> (offs)) & ((1 << (n_bits)) -1)))
36 /* Set Bit Mask - a mask to set all bits starting from offset 'offs'. */
37 #define SBM(offs) ((((1 << (32 - offs)) -1) << (offs)))
45 /* Structure to map valid 'cinv' instruction options. */
49 /* Cinv printed string. */
51 /* Value corresponding to the string. */
56 /* CR16 'cinv' options mapping. */
57 static const cinv_entry cr16_cinvs[] =
59 {"cinv[i]", "cinv [i]"},
60 {"cinv[i,u]", "cinv [i,u]"},
61 {"cinv[d]", "cinv [d]"},
62 {"cinv[d,u]", "cinv [d,u]"},
63 {"cinv[d,i]", "cinv [d,i]"},
64 {"cinv[d,i,u]", "cinv [d,i,u]"}
67 /* Number of valid 'cinv' instruction options. */
68 static int NUMCINVS = ARRAY_SIZE (cr16_cinvs);
70 /* Enum to distinguish different registers argument types. */
71 typedef enum REG_ARG_TYPE
73 /* General purpose register (r<N>). */
75 /*Processor register */
80 /* Current opcode table entry we're disassembling. */
81 static const inst *instruction;
82 /* Current instruction we're disassembling. */
83 static ins cr16_currInsn;
84 /* The current instruction is read into 3 consecutive words. */
85 static wordU cr16_words[3];
86 /* Contains all words in appropriate order. */
87 static ULONGLONG cr16_allWords;
88 /* Holds the current processed argument number. */
89 static int processing_argument_number;
90 /* Nonzero means a IMM4 instruction. */
92 /* Nonzero means the instruction's original size is
93 incremented (escape sequence is used). */
94 static int size_changed;
97 /* Print the constant expression length. */
100 print_exp_len (int size)
123 /* Retrieve the number of operands for the current assembled instruction. */
126 get_number_of_operands (void)
130 for (i = 0; instruction->operands[i].op_type && i < MAX_OPERANDS; i++)
136 /* Return the bit size for a given operand. */
139 getbits (operand_type op)
142 return cr16_optab[op].bit_size;
147 /* Return the argument type of a given operand. */
150 getargtype (operand_type op)
153 return cr16_optab[op].arg_type;
158 /* Given a 'CC' instruction constant operand, return its corresponding
159 string. This routine is used when disassembling the 'CC' instruction. */
162 getccstring (unsigned cc_insn)
164 return (char *) cr16_b_cond_tab[cc_insn];
168 /* Given a 'cinv' instruction constant operand, return its corresponding
169 string. This routine is used when disassembling the 'cinv' instruction. */
172 getcinvstring (const char *str)
174 const cinv_entry *cinv;
176 for (cinv = cr16_cinvs; cinv < (cr16_cinvs + NUMCINVS); cinv++)
177 if (strcmp (cinv->istr, str) == 0)
183 /* Given the trap index in dispatch table, return its name.
184 This routine is used when disassembling the 'excp' instruction. */
187 gettrapstring (unsigned int trap_index)
189 const trap_entry *trap;
191 for (trap = cr16_traps; trap < cr16_traps + NUMTRAPS; trap++)
192 if (trap->entry == trap_index)
198 /* Given a register enum value, retrieve its name. */
203 const reg_entry * regentry = cr16_regtab + r;
205 if (regentry->type != CR16_R_REGTYPE)
208 return regentry->name;
211 /* Given a register pair enum value, retrieve its name. */
216 const reg_entry * regentry = cr16_regptab + r;
218 if (regentry->type != CR16_RP_REGTYPE)
221 return regentry->name;
224 /* Given a index register pair enum value, retrieve its name. */
227 getidxregpname (reg r)
229 const reg_entry * regentry;
233 case 0: r = 0; break;
234 case 1: r = 2; break;
235 case 2: r = 4; break;
236 case 3: r = 6; break;
237 case 4: r = 8; break;
238 case 5: r = 10; break;
239 case 6: r = 3; break;
240 case 7: r = 5; break;
245 regentry = cr16_regptab + r;
247 if (regentry->type != CR16_RP_REGTYPE)
250 return regentry->name;
253 /* Getting a processor register name. */
256 getprocregname (int reg_index)
260 for (r = cr16_pregtab; r < cr16_pregtab + NUMPREGS; r++)
261 if (r->image == reg_index)
264 return "ILLEGAL REGISTER";
267 /* Getting a processor register name - 32 bit size. */
270 getprocpregname (int reg_index)
274 for (r = cr16_pregptab; r < cr16_pregptab + NUMPREGPS; r++)
275 if (r->image == reg_index)
278 return "ILLEGAL REGISTER";
281 /* START and END are relating 'cr16_allWords' struct, which is 48 bits size.
284 +---------+---------+---------+---------+
286 +---------+---------+---------+---------+
291 makelongparameter (ULONGLONG val, int start, int end)
295 p.val = (dwordU) EXTRACT (val, 48 - end, end - start);
296 p.nbits = end - start;
300 /* Build a mask of the instruction's 'constant' opcode,
301 based on the instruction's printing flags. */
306 unsigned long mask = SBM (instruction->match_bits);
308 /* Adjust mask for bcond with 32-bit size instruction. */
309 if ((IS_INSN_MNEMONIC("b") && instruction->size == 2))
315 /* Search for a matching opcode. Return 1 for success, 0 for failure. */
318 cr16_match_opcode (void)
321 /* The instruction 'constant' opcode doesn't exceed 32 bits. */
322 unsigned long doubleWord = (cr16_words[1]
323 + (cr16_words[0] << 16)) & 0xffffffff;
325 /* Start searching from end of instruction table. */
326 instruction = &cr16_instruction[NUMOPCODES - 2];
328 /* Loop over instruction table until a full match is found. */
329 while (instruction >= cr16_instruction)
331 mask = build_mask ();
332 /* Adjust mask for bcond with 32-bit size instruction */
333 if ((IS_INSN_MNEMONIC("b") && instruction->size == 2))
336 if ((doubleWord & mask) == BIN (instruction->match,
337 instruction->match_bits))
345 /* Set the proper parameter value for different type of arguments. */
348 make_argument (argument * a, int start_bits)
353 if ((instruction->size == 3) && a->size >= 16)
361 p = makelongparameter (cr16_allWords,
362 inst_bit_size - (start_bits + a->size),
363 inst_bit_size - start_bits);
368 p = makelongparameter (cr16_allWords,
369 inst_bit_size - (start_bits + a->size),
370 inst_bit_size - start_bits);
375 p = makelongparameter (cr16_allWords,
376 inst_bit_size - (start_bits + a->size),
377 inst_bit_size - start_bits);
382 p = makelongparameter (cr16_allWords,
383 inst_bit_size - (start_bits + a->size),
384 inst_bit_size - start_bits);
389 p = makelongparameter (cr16_allWords,
390 inst_bit_size - (start_bits + a->size),
391 inst_bit_size - start_bits);
396 p = makelongparameter (cr16_allWords,
397 inst_bit_size - (start_bits + a->size),
398 inst_bit_size - start_bits);
404 if ((IS_INSN_MNEMONIC ("cbitb"))
405 || (IS_INSN_MNEMONIC ("sbitb"))
406 || (IS_INSN_MNEMONIC ("tbitb")))
407 p = makelongparameter (cr16_allWords, 8, 9);
409 p = makelongparameter (cr16_allWords, 9, 10);
411 p = makelongparameter (cr16_allWords,
412 inst_bit_size - a->size, inst_bit_size);
417 p = makelongparameter (cr16_allWords, start_bits + 12, start_bits + 13);
419 p = makelongparameter (cr16_allWords, start_bits + 13, start_bits + 16);
421 if (inst_bit_size > 32)
423 p = makelongparameter (cr16_allWords, inst_bit_size - start_bits - 12,
425 a->constant = ((p.val & 0xffff) | (p.val >> 8 & 0xf0000));
427 else if (instruction->size == 2)
429 p = makelongparameter (cr16_allWords, inst_bit_size - 22,
431 a->constant = (p.val & 0xf) | (((p.val >>20) & 0x3) << 4)
432 | ((p.val >>14 & 0x3) << 6) | (((p.val >>7) & 0x1f) <<7);
434 else if (instruction->size == 1 && a->size == 0)
440 p = makelongparameter (cr16_allWords, inst_bit_size, inst_bit_size);
442 p = makelongparameter (cr16_allWords, inst_bit_size - (start_bits + 4),
443 inst_bit_size - start_bits);
448 p = makelongparameter (cr16_allWords, start_bits + 12, start_bits + 16);
450 p = makelongparameter (cr16_allWords, inst_bit_size - 16, inst_bit_size);
455 if (instruction->size == 1)
456 p = makelongparameter (cr16_allWords, 12, 16);
458 p = makelongparameter (cr16_allWords, start_bits + 12, start_bits + 16);
461 if (inst_bit_size > 32)
463 p = makelongparameter (cr16_allWords, inst_bit_size - start_bits - 12,
465 a->constant = ((p.val & 0xffff) | (p.val >> 8 & 0xf0000));
467 else if (instruction->size == 2)
469 p = makelongparameter (cr16_allWords, inst_bit_size - 16,
473 else if (instruction->size == 1 && a->size != 0)
475 p = makelongparameter (cr16_allWords, 4, 8);
476 if (IS_INSN_MNEMONIC ("loadw")
477 || IS_INSN_MNEMONIC ("loadd")
478 || IS_INSN_MNEMONIC ("storw")
479 || IS_INSN_MNEMONIC ("stord"))
480 a->constant = (p.val * 2);
484 else /* below case for 0x0(reg pair) */
491 if ((IS_INSN_TYPE (BRANCH_INS))
492 || (IS_INSN_MNEMONIC ("bal"))
493 || (IS_INSN_TYPE (CSTBIT_INS))
494 || (IS_INSN_TYPE (LD_STOR_INS)))
499 p = makelongparameter (cr16_allWords, 0, start_bits);
500 a->constant = ((((p.val&0xf00)>>4)) | (p.val&0xf));
504 if (instruction->size == 3)
506 p = makelongparameter (cr16_allWords, 16, inst_bit_size);
507 a->constant = ((((p.val>>16)&0xf) << 20)
508 | (((p.val>>24)&0xf) << 16)
511 else if (instruction->size == 2)
513 p = makelongparameter (cr16_allWords, 8, inst_bit_size);
519 p = makelongparameter (cr16_allWords,
520 inst_bit_size - (start_bits + a->size),
521 inst_bit_size - start_bits);
528 p = makelongparameter (cr16_allWords,
529 inst_bit_size - (start_bits + a->size),
530 inst_bit_size - start_bits);
540 /* Print a single argument. */
543 print_arg (argument *a, bfd_vma memaddr, struct disassemble_info *info)
545 LONGLONG longdisp, mask;
549 PTR stream = info->stream;
550 fprintf_ftype func = info->fprintf_func;
555 func (stream, "%s", getregname (a->r));
559 func (stream, "%s", getregpname (a->rp));
563 func (stream, "%s", getprocregname (a->pr));
567 func (stream, "%s", getprocpregname (a->prp));
571 func (stream, "%s", getccstring (a->cc));
572 func (stream, "%s", "\t");
576 if (IS_INSN_MNEMONIC ("excp"))
578 func (stream, "%s", gettrapstring (a->constant));
581 else if ((IS_INSN_TYPE (ARITH_INS) || IS_INSN_TYPE (ARITH_BYTE_INS))
582 && ((instruction->size == 1) && (a->constant == 9)))
583 func (stream, "$%d", -1);
584 else if (INST_HAS_REG_LIST)
585 func (stream, "$0x%lx", a->constant +1);
586 else if (IS_INSN_TYPE (SHIFT_INS))
588 longdisp = a->constant;
589 mask = ((LONGLONG)1 << a->size) - 1;
590 if (longdisp & ((LONGLONG)1 << (a->size -1)))
593 longdisp = ~(longdisp) + 1;
595 a->constant = (unsigned long int) (longdisp & mask);
596 func (stream, "$%d", ((int)(sign_flag ? -a->constant :
600 func (stream, "$0x%lx", a->constant);
603 case 4 : case 5 : case 6 : case 8 :
604 func (stream, "%s", ":s"); break;
605 case 16 : case 20 : func (stream, "%s", ":m"); break;
606 case 24 : case 32 : func (stream, "%s", ":l"); break;
612 if (a->i_r == 0) func (stream, "[r12]");
613 if (a->i_r == 1) func (stream, "[r13]");
614 func (stream, "0x%lx", a->constant);
615 func (stream, "%s", print_exp_len (instruction->size * 16));
619 if (a->i_r == 0) func (stream, "[r12]");
620 if (a->i_r == 1) func (stream, "[r13]");
621 func (stream, "0x%lx", a->constant);
622 func (stream, "%s", print_exp_len (instruction->size * 16));
623 func (stream, "%s", getidxregpname (a->rp));
627 func (stream, "(%s)", getregname (a->r));
631 func (stream, "0x%lx", a->constant);
632 func (stream, "%s", print_exp_len (instruction->size * 16));
633 func (stream, "(%s)", getregname (a->r));
637 func (stream, "0x%lx", a->constant);
638 func (stream, "%s", print_exp_len (instruction->size * 16));
639 func (stream, "%s", getregpname (a->rp));
643 /*Removed the *2 part as because implicit zeros are no more required.
644 Have to fix this as this needs a bit of extension in terms of branch
646 if (IS_INSN_TYPE (BRANCH_INS) || IS_INSN_MNEMONIC ("bal"))
649 longdisp = a->constant;
650 /* REVISIT: To sync with WinIDEA and CR16 4.1tools, the below
652 /* longdisp <<= 1; */
653 mask = ((LONGLONG)1 << a->size) - 1;
659 if (longdisp & ((LONGLONG)1 << a->size))
662 longdisp = ~(longdisp) + 1;
672 longdisp = ~(longdisp) + 1;
677 func (stream, "Wrong offset used in branch/bal instruction");
680 a->constant = (unsigned long int) (longdisp & mask);
682 /* For branch Neq instruction it is 2*offset + 2. */
683 else if (IS_INSN_TYPE (BRANCH_NEQ_INS))
684 a->constant = 2 * a->constant + 2;
686 if ((!IS_INSN_TYPE (CSTBIT_INS)) && (!IS_INSN_TYPE (LD_STOR_INS)))
687 (sign_flag) ? func (stream, "%s", "*-"): func (stream, "%s","*+");
689 /* PR 10173: Avoid printing the 0x prefix twice. */
690 if (info->symtab_size > 0)
691 func (stream, "%s", "0x");
692 number = ((relative ? memaddr : 0) +
693 (sign_flag ? ((- a->constant) & 0xffffffe) : a->constant));
695 (*info->print_address_func) ((number & ((1 << 24) - 1)), info);
697 func (stream, "%s", print_exp_len (instruction->size * 16));
705 /* Print all the arguments of CURRINSN instruction. */
708 print_arguments (ins *currentInsn, bfd_vma memaddr, struct disassemble_info *info)
712 /* For "pop/push/popret RA instruction only. */
713 if ((IS_INSN_MNEMONIC ("pop")
714 || (IS_INSN_MNEMONIC ("popret")
715 || (IS_INSN_MNEMONIC ("push"))))
716 && currentInsn->nargs == 1)
718 info->fprintf_func (info->stream, "RA");
722 for (i = 0; i < currentInsn->nargs; i++)
724 processing_argument_number = i;
726 /* For "bal (ra), disp17" instruction only. */
727 if ((IS_INSN_MNEMONIC ("bal")) && (i == 0) && instruction->size == 2)
729 info->fprintf_func (info->stream, "(ra),");
733 if ((INST_HAS_REG_LIST) && (i == 2))
734 info->fprintf_func (info->stream, "RA");
736 print_arg (¤tInsn->arg[i], memaddr, info);
738 if ((i != currentInsn->nargs - 1) && (!IS_INSN_MNEMONIC ("b")))
739 info->fprintf_func (info->stream, ",");
743 /* Build the instruction's arguments. */
746 cr16_make_instruction (void)
751 for (i = 0; i < cr16_currInsn.nargs; i++)
755 memset (&a, 0, sizeof (a));
756 a.type = getargtype (instruction->operands[i].op_type);
757 a.size = getbits (instruction->operands[i].op_type);
758 shift = instruction->operands[i].shift;
760 make_argument (&a, shift);
761 cr16_currInsn.arg[i] = a;
764 /* Calculate instruction size (in bytes). */
765 cr16_currInsn.size = instruction->size + (size_changed ? 1 : 0);
767 cr16_currInsn.size *= 2;
770 /* Retrieve a single word from a given memory address. */
773 get_word_at_PC (bfd_vma memaddr, struct disassemble_info *info)
779 status = info->read_memory_func (memaddr, buffer, 2, info);
782 insn = (wordU) bfd_getl16 (buffer);
787 /* Retrieve multiple words (3) from a given memory address. */
790 get_words_at_PC (bfd_vma memaddr, struct disassemble_info *info)
795 for (i = 0, mem = memaddr; i < 3; i++, mem += 2)
796 cr16_words[i] = get_word_at_PC (mem, info);
798 cr16_allWords = ((ULONGLONG) cr16_words[0] << 32)
799 + ((unsigned long) cr16_words[1] << 16) + cr16_words[2];
802 /* Prints the instruction by calling print_arguments after proper matching. */
805 print_insn_cr16 (bfd_vma memaddr, struct disassemble_info *info)
807 int is_decoded; /* Nonzero means instruction has a match. */
809 /* Initialize global variables. */
813 /* Retrieve the encoding from current memory location. */
814 get_words_at_PC (memaddr, info);
815 /* Find a matching opcode in table. */
816 is_decoded = cr16_match_opcode ();
817 /* If found, print the instruction's mnemonic and arguments. */
818 if (is_decoded > 0 && (cr16_words[0] != 0 || cr16_words[1] != 0))
820 if (strneq (instruction->mnemonic, "cinv", 4))
821 info->fprintf_func (info->stream,"%s", getcinvstring (instruction->mnemonic));
823 info->fprintf_func (info->stream, "%s", instruction->mnemonic);
825 if (((cr16_currInsn.nargs = get_number_of_operands ()) != 0)
826 && ! (IS_INSN_MNEMONIC ("b")))
827 info->fprintf_func (info->stream, "\t");
828 cr16_make_instruction ();
829 /* For push/pop/pushrtn with RA instructions. */
830 if ((INST_HAS_REG_LIST) && ((cr16_words[0] >> 7) & 0x1))
831 cr16_currInsn.nargs +=1;
832 print_arguments (&cr16_currInsn, memaddr, info);
833 return cr16_currInsn.size;
836 /* No match found. */
837 info->fprintf_func (info->stream,"%s ",ILLEGAL);