1 /* Disassembler code for CR16.
2 Copyright (C) 2007-2020 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 (((a) >> (offs)) & ((1ul << ((n_bits) - 1) << 1) - 1))
35 /* Set Bit Mask - a mask to set all bits in a 32-bit word starting
36 from offset 'offs'. */
37 #define SBM(offs) ((1ul << 31 << 1) - (1ul << (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] + ((unsigned) cr16_words
[0] << 16);
324 /* Start searching from end of instruction table. */
325 instruction
= &cr16_instruction
[NUMOPCODES
- 2];
327 /* Loop over instruction table until a full match is found. */
328 while (instruction
>= cr16_instruction
)
330 mask
= build_mask ();
332 if ((doubleWord
& mask
) == BIN (instruction
->match
,
333 instruction
->match_bits
))
341 /* Set the proper parameter value for different type of arguments. */
344 make_argument (argument
* a
, int start_bits
)
349 if ((instruction
->size
== 3) && a
->size
>= 16)
357 p
= makelongparameter (cr16_allWords
,
358 inst_bit_size
- (start_bits
+ a
->size
),
359 inst_bit_size
- start_bits
);
364 p
= makelongparameter (cr16_allWords
,
365 inst_bit_size
- (start_bits
+ a
->size
),
366 inst_bit_size
- start_bits
);
371 p
= makelongparameter (cr16_allWords
,
372 inst_bit_size
- (start_bits
+ a
->size
),
373 inst_bit_size
- start_bits
);
378 p
= makelongparameter (cr16_allWords
,
379 inst_bit_size
- (start_bits
+ a
->size
),
380 inst_bit_size
- start_bits
);
385 p
= makelongparameter (cr16_allWords
,
386 inst_bit_size
- (start_bits
+ a
->size
),
387 inst_bit_size
- start_bits
);
392 p
= makelongparameter (cr16_allWords
,
393 inst_bit_size
- (start_bits
+ a
->size
),
394 inst_bit_size
- start_bits
);
400 if ((IS_INSN_MNEMONIC ("cbitb"))
401 || (IS_INSN_MNEMONIC ("sbitb"))
402 || (IS_INSN_MNEMONIC ("tbitb")))
403 p
= makelongparameter (cr16_allWords
, 8, 9);
405 p
= makelongparameter (cr16_allWords
, 9, 10);
407 p
= makelongparameter (cr16_allWords
,
408 inst_bit_size
- a
->size
, inst_bit_size
);
413 p
= makelongparameter (cr16_allWords
, start_bits
+ 12, start_bits
+ 13);
415 p
= makelongparameter (cr16_allWords
, start_bits
+ 13, start_bits
+ 16);
417 if (inst_bit_size
> 32)
419 p
= makelongparameter (cr16_allWords
, inst_bit_size
- start_bits
- 12,
421 a
->constant
= ((p
.val
& 0xffff) | (p
.val
>> 8 & 0xf0000));
423 else if (instruction
->size
== 2)
425 p
= makelongparameter (cr16_allWords
, inst_bit_size
- 22,
427 a
->constant
= (p
.val
& 0xf) | (((p
.val
>>20) & 0x3) << 4)
428 | ((p
.val
>>14 & 0x3) << 6) | (((p
.val
>>7) & 0x1f) <<7);
430 else if (instruction
->size
== 1 && a
->size
== 0)
436 p
= makelongparameter (cr16_allWords
, inst_bit_size
, inst_bit_size
);
438 p
= makelongparameter (cr16_allWords
, inst_bit_size
- (start_bits
+ 4),
439 inst_bit_size
- start_bits
);
444 p
= makelongparameter (cr16_allWords
, start_bits
+ 12, start_bits
+ 16);
446 p
= makelongparameter (cr16_allWords
, inst_bit_size
- 16, inst_bit_size
);
451 if (instruction
->size
== 1)
452 p
= makelongparameter (cr16_allWords
, 12, 16);
454 p
= makelongparameter (cr16_allWords
, start_bits
+ 12, start_bits
+ 16);
457 if (inst_bit_size
> 32)
459 p
= makelongparameter (cr16_allWords
, inst_bit_size
- start_bits
- 12,
461 a
->constant
= ((p
.val
& 0xffff) | (p
.val
>> 8 & 0xf0000));
463 else if (instruction
->size
== 2)
465 p
= makelongparameter (cr16_allWords
, inst_bit_size
- 16,
469 else if (instruction
->size
== 1 && a
->size
!= 0)
471 p
= makelongparameter (cr16_allWords
, 4, 8);
472 if (IS_INSN_MNEMONIC ("loadw")
473 || IS_INSN_MNEMONIC ("loadd")
474 || IS_INSN_MNEMONIC ("storw")
475 || IS_INSN_MNEMONIC ("stord"))
476 a
->constant
= (p
.val
* 2);
480 else /* below case for 0x0(reg pair) */
487 if ((IS_INSN_TYPE (BRANCH_INS
))
488 || (IS_INSN_MNEMONIC ("bal"))
489 || (IS_INSN_TYPE (CSTBIT_INS
))
490 || (IS_INSN_TYPE (LD_STOR_INS
)))
495 p
= makelongparameter (cr16_allWords
, 0, start_bits
);
496 a
->constant
= ((((p
.val
&0xf00)>>4)) | (p
.val
&0xf));
500 if (instruction
->size
== 3)
502 p
= makelongparameter (cr16_allWords
, 16, inst_bit_size
);
503 a
->constant
= ((((p
.val
>>16)&0xf) << 20)
504 | (((p
.val
>>24)&0xf) << 16)
507 else if (instruction
->size
== 2)
509 p
= makelongparameter (cr16_allWords
, 8, inst_bit_size
);
515 p
= makelongparameter (cr16_allWords
,
516 inst_bit_size
- (start_bits
+ a
->size
),
517 inst_bit_size
- start_bits
);
524 p
= makelongparameter (cr16_allWords
,
525 inst_bit_size
- (start_bits
+ a
->size
),
526 inst_bit_size
- start_bits
);
536 /* Print a single argument. */
539 print_arg (argument
*a
, bfd_vma memaddr
, struct disassemble_info
*info
)
541 LONGLONG longdisp
, mask
;
545 PTR stream
= info
->stream
;
546 fprintf_ftype func
= info
->fprintf_func
;
551 func (stream
, "%s", getregname (a
->r
));
555 func (stream
, "%s", getregpname (a
->rp
));
559 func (stream
, "%s", getprocregname (a
->pr
));
563 func (stream
, "%s", getprocpregname (a
->prp
));
567 func (stream
, "%s", getccstring (a
->cc
));
568 func (stream
, "%s", "\t");
572 if (IS_INSN_MNEMONIC ("excp"))
574 func (stream
, "%s", gettrapstring (a
->constant
));
577 else if ((IS_INSN_TYPE (ARITH_INS
) || IS_INSN_TYPE (ARITH_BYTE_INS
))
578 && ((instruction
->size
== 1) && (a
->constant
== 9)))
579 func (stream
, "$%d", -1);
580 else if (INST_HAS_REG_LIST
)
581 func (stream
, "$0x%lx", a
->constant
+1);
582 else if (IS_INSN_TYPE (SHIFT_INS
))
584 longdisp
= a
->constant
;
585 mask
= ((LONGLONG
)1 << a
->size
) - 1;
586 if (longdisp
& ((LONGLONG
)1 << (a
->size
-1)))
589 longdisp
= ~(longdisp
) + 1;
591 a
->constant
= (unsigned long int) (longdisp
& mask
);
592 func (stream
, "$%d", ((int)(sign_flag
? -a
->constant
:
596 func (stream
, "$0x%lx", a
->constant
);
599 case 4 : case 5 : case 6 : case 8 :
600 func (stream
, "%s", ":s"); break;
601 case 16 : case 20 : func (stream
, "%s", ":m"); break;
602 case 24 : case 32 : func (stream
, "%s", ":l"); break;
608 if (a
->i_r
== 0) func (stream
, "[r12]");
609 if (a
->i_r
== 1) func (stream
, "[r13]");
610 func (stream
, "0x%lx", a
->constant
);
611 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
615 if (a
->i_r
== 0) func (stream
, "[r12]");
616 if (a
->i_r
== 1) func (stream
, "[r13]");
617 func (stream
, "0x%lx", a
->constant
);
618 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
619 func (stream
, "%s", getidxregpname (a
->rp
));
623 func (stream
, "(%s)", getregname (a
->r
));
627 func (stream
, "0x%lx", a
->constant
);
628 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
629 func (stream
, "(%s)", getregname (a
->r
));
633 func (stream
, "0x%lx", a
->constant
);
634 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
635 func (stream
, "%s", getregpname (a
->rp
));
639 /*Removed the *2 part as because implicit zeros are no more required.
640 Have to fix this as this needs a bit of extension in terms of branch
642 if (IS_INSN_TYPE (BRANCH_INS
) || IS_INSN_MNEMONIC ("bal"))
645 longdisp
= a
->constant
;
646 /* REVISIT: To sync with WinIDEA and CR16 4.1tools, the below
648 /* longdisp <<= 1; */
649 mask
= ((LONGLONG
)1 << a
->size
) - 1;
655 if (longdisp
& ((LONGLONG
)1 << a
->size
))
658 longdisp
= ~(longdisp
) + 1;
668 longdisp
= ~(longdisp
) + 1;
673 func (stream
, "Wrong offset used in branch/bal instruction");
676 a
->constant
= (unsigned long int) (longdisp
& mask
);
678 /* For branch Neq instruction it is 2*offset + 2. */
679 else if (IS_INSN_TYPE (BRANCH_NEQ_INS
))
680 a
->constant
= 2 * a
->constant
+ 2;
682 if ((!IS_INSN_TYPE (CSTBIT_INS
)) && (!IS_INSN_TYPE (LD_STOR_INS
)))
683 (sign_flag
) ? func (stream
, "%s", "*-"): func (stream
, "%s","*+");
685 /* PR 10173: Avoid printing the 0x prefix twice. */
686 if (info
->symtab_size
> 0)
687 func (stream
, "%s", "0x");
688 number
= ((relative
? memaddr
: 0) +
689 (sign_flag
? ((- a
->constant
) & 0xffffffe) : a
->constant
));
691 (*info
->print_address_func
) ((number
& ((1 << 24) - 1)), info
);
693 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
701 /* Print all the arguments of CURRINSN instruction. */
704 print_arguments (ins
*currentInsn
, bfd_vma memaddr
, struct disassemble_info
*info
)
708 /* For "pop/push/popret RA instruction only. */
709 if ((IS_INSN_MNEMONIC ("pop")
710 || (IS_INSN_MNEMONIC ("popret")
711 || (IS_INSN_MNEMONIC ("push"))))
712 && currentInsn
->nargs
== 1)
714 info
->fprintf_func (info
->stream
, "RA");
718 for (i
= 0; i
< currentInsn
->nargs
; i
++)
720 processing_argument_number
= i
;
722 /* For "bal (ra), disp17" instruction only. */
723 if ((IS_INSN_MNEMONIC ("bal")) && (i
== 0) && instruction
->size
== 2)
725 info
->fprintf_func (info
->stream
, "(ra),");
729 if ((INST_HAS_REG_LIST
) && (i
== 2))
730 info
->fprintf_func (info
->stream
, "RA");
732 print_arg (¤tInsn
->arg
[i
], memaddr
, info
);
734 if ((i
!= currentInsn
->nargs
- 1) && (!IS_INSN_MNEMONIC ("b")))
735 info
->fprintf_func (info
->stream
, ",");
739 /* Build the instruction's arguments. */
742 cr16_make_instruction (void)
747 for (i
= 0; i
< cr16_currInsn
.nargs
; i
++)
751 memset (&a
, 0, sizeof (a
));
752 a
.type
= getargtype (instruction
->operands
[i
].op_type
);
753 a
.size
= getbits (instruction
->operands
[i
].op_type
);
754 shift
= instruction
->operands
[i
].shift
;
756 make_argument (&a
, shift
);
757 cr16_currInsn
.arg
[i
] = a
;
760 /* Calculate instruction size (in bytes). */
761 cr16_currInsn
.size
= instruction
->size
+ (size_changed
? 1 : 0);
763 cr16_currInsn
.size
*= 2;
766 /* Retrieve a single word from a given memory address. */
769 get_word_at_PC (bfd_vma memaddr
, struct disassemble_info
*info
)
775 status
= info
->read_memory_func (memaddr
, buffer
, 2, info
);
778 insn
= (wordU
) bfd_getl16 (buffer
);
783 /* Retrieve multiple words (3) from a given memory address. */
786 get_words_at_PC (bfd_vma memaddr
, struct disassemble_info
*info
)
791 for (i
= 0, mem
= memaddr
; i
< 3; i
++, mem
+= 2)
792 cr16_words
[i
] = get_word_at_PC (mem
, info
);
794 cr16_allWords
= ((ULONGLONG
) cr16_words
[0] << 32)
795 + ((unsigned long) cr16_words
[1] << 16) + cr16_words
[2];
798 /* Prints the instruction by calling print_arguments after proper matching. */
801 print_insn_cr16 (bfd_vma memaddr
, struct disassemble_info
*info
)
803 int is_decoded
; /* Nonzero means instruction has a match. */
805 /* Initialize global variables. */
809 /* Retrieve the encoding from current memory location. */
810 get_words_at_PC (memaddr
, info
);
811 /* Find a matching opcode in table. */
812 is_decoded
= cr16_match_opcode ();
813 /* If found, print the instruction's mnemonic and arguments. */
814 if (is_decoded
> 0 && (cr16_words
[0] != 0 || cr16_words
[1] != 0))
816 if (strneq (instruction
->mnemonic
, "cinv", 4))
817 info
->fprintf_func (info
->stream
,"%s", getcinvstring (instruction
->mnemonic
));
819 info
->fprintf_func (info
->stream
, "%s", instruction
->mnemonic
);
821 if (((cr16_currInsn
.nargs
= get_number_of_operands ()) != 0)
822 && ! (IS_INSN_MNEMONIC ("b")))
823 info
->fprintf_func (info
->stream
, "\t");
824 cr16_make_instruction ();
825 /* For push/pop/pushrtn with RA instructions. */
826 if ((INST_HAS_REG_LIST
) && ((cr16_words
[0] >> 7) & 0x1))
827 cr16_currInsn
.nargs
+=1;
828 print_arguments (&cr16_currInsn
, memaddr
, info
);
829 return cr16_currInsn
.size
;
832 /* No match found. */
833 info
->fprintf_func (info
->stream
,"%s ",ILLEGAL
);