1 /* Disassembler code for CR16.
2 Copyright (C) 2007-2024 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)))
39 /* Structure to map valid 'cinv' instruction options. */
43 /* Cinv printed string. */
45 /* Value corresponding to the string. */
50 /* CR16 'cinv' options mapping. */
51 static const cinv_entry cr16_cinvs
[] =
53 {"cinv[i]", "cinv [i]"},
54 {"cinv[i,u]", "cinv [i,u]"},
55 {"cinv[d]", "cinv [d]"},
56 {"cinv[d,u]", "cinv [d,u]"},
57 {"cinv[d,i]", "cinv [d,i]"},
58 {"cinv[d,i,u]", "cinv [d,i,u]"}
61 /* Number of valid 'cinv' instruction options. */
62 static int NUMCINVS
= ARRAY_SIZE (cr16_cinvs
);
64 /* Enum to distinguish different registers argument types. */
65 typedef enum REG_ARG_TYPE
67 /* General purpose register (r<N>). */
69 /*Processor register */
74 /* Current opcode table entry we're disassembling. */
75 static const inst
*instruction
;
76 /* Current instruction we're disassembling. */
77 static ins cr16_currInsn
;
78 /* The current instruction is read into 3 consecutive words. */
79 static wordU cr16_words
[3];
80 /* Contains all words in appropriate order. */
81 static ULONGLONG cr16_allWords
;
82 /* Holds the current processed argument number. */
83 static int processing_argument_number
;
84 /* Nonzero means a IMM4 instruction. */
86 /* Nonzero means the instruction's original size is
87 incremented (escape sequence is used). */
88 static int size_changed
;
91 /* Print the constant expression length. */
94 print_exp_len (int size
)
117 /* Retrieve the number of operands for the current assembled instruction. */
120 get_number_of_operands (void)
124 for (i
= 0; instruction
->operands
[i
].op_type
&& i
< MAX_OPERANDS
; i
++)
130 /* Return the bit size for a given operand. */
133 getbits (operand_type op
)
136 return cr16_optab
[op
].bit_size
;
141 /* Return the argument type of a given operand. */
144 getargtype (operand_type op
)
147 return cr16_optab
[op
].arg_type
;
152 /* Given a 'CC' instruction constant operand, return its corresponding
153 string. This routine is used when disassembling the 'CC' instruction. */
156 getccstring (unsigned cc_insn
)
158 return (char *) cr16_b_cond_tab
[cc_insn
];
162 /* Given a 'cinv' instruction constant operand, return its corresponding
163 string. This routine is used when disassembling the 'cinv' instruction. */
166 getcinvstring (const char *str
)
168 const cinv_entry
*cinv
;
170 for (cinv
= cr16_cinvs
; cinv
< (cr16_cinvs
+ NUMCINVS
); cinv
++)
171 if (strcmp (cinv
->istr
, str
) == 0)
177 /* Given the trap index in dispatch table, return its name.
178 This routine is used when disassembling the 'excp' instruction. */
181 gettrapstring (unsigned int trap_index
)
183 const trap_entry
*trap
;
185 for (trap
= cr16_traps
; trap
< cr16_traps
+ NUMTRAPS
; trap
++)
186 if (trap
->entry
== trap_index
)
192 /* Given a register enum value, retrieve its name. */
197 const reg_entry
* regentry
= cr16_regtab
+ r
;
199 if (regentry
->type
!= CR16_R_REGTYPE
)
202 return regentry
->name
;
205 /* Given a register pair enum value, retrieve its name. */
210 const reg_entry
* regentry
= cr16_regptab
+ r
;
212 if (regentry
->type
!= CR16_RP_REGTYPE
)
215 return regentry
->name
;
218 /* Given a index register pair enum value, retrieve its name. */
221 getidxregpname (reg r
)
223 const reg_entry
* regentry
;
227 case 0: r
= 0; break;
228 case 1: r
= 2; break;
229 case 2: r
= 4; break;
230 case 3: r
= 6; break;
231 case 4: r
= 8; break;
232 case 5: r
= 10; break;
233 case 6: r
= 3; break;
234 case 7: r
= 5; break;
239 regentry
= cr16_regptab
+ r
;
241 if (regentry
->type
!= CR16_RP_REGTYPE
)
244 return regentry
->name
;
247 /* Getting a processor register name. */
250 getprocregname (int reg_index
)
254 for (r
= cr16_pregtab
; r
< cr16_pregtab
+ NUMPREGS
; r
++)
255 if (r
->image
== reg_index
)
258 return "ILLEGAL REGISTER";
261 /* Getting a processor register name - 32 bit size. */
264 getprocpregname (int reg_index
)
268 for (r
= cr16_pregptab
; r
< cr16_pregptab
+ NUMPREGPS
; r
++)
269 if (r
->image
== reg_index
)
272 return "ILLEGAL REGISTER";
275 /* START and END are relating 'cr16_allWords' struct, which is 48 bits size.
278 +---------+---------+---------+---------+
280 +---------+---------+---------+---------+
285 makelongparameter (ULONGLONG val
, int start
, int end
)
287 return EXTRACT (val
, 48 - end
, end
- start
);
290 /* Build a mask of the instruction's 'constant' opcode,
291 based on the instruction's printing flags. */
296 unsigned long mask
= SBM (instruction
->match_bits
);
298 /* Adjust mask for bcond with 32-bit size instruction. */
299 if ((IS_INSN_MNEMONIC("b") && instruction
->size
== 2))
305 /* Search for a matching opcode. Return 1 for success, 0 for failure. */
308 cr16_match_opcode (void)
311 /* The instruction 'constant' opcode doesn't exceed 32 bits. */
312 unsigned long doubleWord
= cr16_words
[1] + ((unsigned) cr16_words
[0] << 16);
314 /* Start searching from end of instruction table. */
315 instruction
= &cr16_instruction
[NUMOPCODES
- 2];
317 /* Loop over instruction table until a full match is found. */
318 while (instruction
>= cr16_instruction
)
320 mask
= build_mask ();
322 if ((doubleWord
& mask
) == BIN (instruction
->match
,
323 instruction
->match_bits
))
331 /* Set the proper parameter value for different type of arguments. */
334 make_argument (argument
* a
, int start_bits
)
339 if ((instruction
->size
== 3) && a
->size
>= 16)
347 p
= makelongparameter (cr16_allWords
,
348 inst_bit_size
- (start_bits
+ a
->size
),
349 inst_bit_size
- start_bits
);
354 p
= makelongparameter (cr16_allWords
,
355 inst_bit_size
- (start_bits
+ a
->size
),
356 inst_bit_size
- start_bits
);
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 if (IS_INSN_TYPE (CSTBIT_INS
) && instruction
->mnemonic
[4] == 'b')
390 p
= makelongparameter (cr16_allWords
, 8, 9);
392 p
= makelongparameter (cr16_allWords
, 9, 10);
394 p
= makelongparameter (cr16_allWords
,
395 inst_bit_size
- a
->size
, inst_bit_size
);
400 p
= makelongparameter (cr16_allWords
, start_bits
+ 12, start_bits
+ 13);
402 p
= makelongparameter (cr16_allWords
, start_bits
+ 13, start_bits
+ 16);
404 if (inst_bit_size
> 32)
406 p
= makelongparameter (cr16_allWords
, inst_bit_size
- start_bits
- 12,
408 a
->constant
= (p
& 0xffff) | (p
>> 8 & 0xf0000);
410 else if (instruction
->size
== 2)
412 p
= makelongparameter (cr16_allWords
, inst_bit_size
- 22,
414 a
->constant
= ((p
& 0xf) | (((p
>> 20) & 0x3) << 4)
415 | ((p
>> 14 & 0x3) << 6) | (((p
>>7) & 0x1f) << 7));
417 else if (instruction
->size
== 1 && a
->size
== 0)
423 p
= makelongparameter (cr16_allWords
, inst_bit_size
, inst_bit_size
);
425 p
= makelongparameter (cr16_allWords
, inst_bit_size
- (start_bits
+ 4),
426 inst_bit_size
- start_bits
);
431 p
= makelongparameter (cr16_allWords
, start_bits
+ 12, start_bits
+ 16);
433 p
= makelongparameter (cr16_allWords
, inst_bit_size
- 28, inst_bit_size
);
434 a
->constant
= ((p
>> 8) & 0xf0000) | (p
& 0xffff);
438 if (instruction
->size
== 1)
439 p
= makelongparameter (cr16_allWords
, 12, 16);
441 p
= makelongparameter (cr16_allWords
, start_bits
+ 12, start_bits
+ 16);
444 if (inst_bit_size
> 32)
446 p
= makelongparameter (cr16_allWords
, inst_bit_size
- start_bits
- 12,
448 a
->constant
= ((p
& 0xffff) | (p
>> 8 & 0xf0000));
450 else if (instruction
->size
== 2)
452 p
= makelongparameter (cr16_allWords
, inst_bit_size
- 16,
456 else if (instruction
->size
== 1 && a
->size
!= 0)
458 p
= makelongparameter (cr16_allWords
, 4, 8);
459 if (IS_INSN_MNEMONIC ("loadw")
460 || IS_INSN_MNEMONIC ("loadd")
461 || IS_INSN_MNEMONIC ("storw")
462 || IS_INSN_MNEMONIC ("stord"))
467 else /* below case for 0x0(reg pair) */
474 if ((IS_INSN_TYPE (BRANCH_INS
))
475 || (IS_INSN_MNEMONIC ("bal"))
476 || (IS_INSN_TYPE (CSTBIT_INS
))
477 || (IS_INSN_TYPE (LD_STOR_INS
)))
482 p
= makelongparameter (cr16_allWords
, 0, start_bits
);
483 a
->constant
= ((p
& 0xf00) >> 4) | (p
& 0xf);
487 if (instruction
->size
== 3)
489 p
= makelongparameter (cr16_allWords
, 16, inst_bit_size
);
490 a
->constant
= ((((p
>> 16) & 0xf) << 20)
491 | (((p
>> 24) & 0xf) << 16)
494 else if (instruction
->size
== 2)
496 p
= makelongparameter (cr16_allWords
, 8, inst_bit_size
);
502 p
= makelongparameter (cr16_allWords
,
503 inst_bit_size
- (start_bits
+ a
->size
),
504 inst_bit_size
- start_bits
);
511 p
= makelongparameter (cr16_allWords
,
512 inst_bit_size
- (start_bits
+ a
->size
),
513 inst_bit_size
- start_bits
);
523 /* Print a single argument. */
526 print_arg (argument
*a
, bfd_vma memaddr
, struct disassemble_info
*info
)
528 LONGLONG longdisp
, mask
;
532 void *stream
= info
->stream
;
533 fprintf_ftype func
= info
->fprintf_func
;
538 func (stream
, "%s", getregname (a
->r
));
542 func (stream
, "%s", getregpname (a
->rp
));
546 func (stream
, "%s", getprocregname (a
->pr
));
550 func (stream
, "%s", getprocpregname (a
->prp
));
554 func (stream
, "%s", getccstring (a
->cc
));
555 func (stream
, "%s", "\t");
559 if (IS_INSN_MNEMONIC ("excp"))
561 func (stream
, "%s", gettrapstring (a
->constant
));
564 else if ((IS_INSN_TYPE (ARITH_INS
) || IS_INSN_TYPE (ARITH_BYTE_INS
))
565 && ((instruction
->size
== 1) && (a
->constant
== 9)))
566 func (stream
, "$%d", -1);
567 else if (INST_HAS_REG_LIST
)
568 func (stream
, "$0x%lx", a
->constant
+1);
569 else if (IS_INSN_TYPE (SHIFT_INS
))
571 longdisp
= a
->constant
;
572 mask
= ((LONGLONG
)1 << a
->size
) - 1;
573 if (longdisp
& ((LONGLONG
)1 << (a
->size
-1)))
576 longdisp
= ~(longdisp
) + 1;
578 a
->constant
= (unsigned long int) (longdisp
& mask
);
579 func (stream
, "$%d", ((int)(sign_flag
? -a
->constant
:
583 func (stream
, "$0x%lx", a
->constant
);
586 case 4 : case 5 : case 6 : case 8 :
587 func (stream
, "%s", ":s"); break;
588 case 16 : case 20 : func (stream
, "%s", ":m"); break;
589 case 24 : case 32 : func (stream
, "%s", ":l"); break;
595 if (a
->i_r
== 0) func (stream
, "[r12]");
596 if (a
->i_r
== 1) func (stream
, "[r13]");
597 func (stream
, "0x%lx", a
->constant
);
598 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
602 if (a
->i_r
== 0) func (stream
, "[r12]");
603 if (a
->i_r
== 1) func (stream
, "[r13]");
604 func (stream
, "0x%lx", a
->constant
);
605 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
606 func (stream
, "%s", getidxregpname (a
->rp
));
610 func (stream
, "(%s)", getregname (a
->r
));
614 func (stream
, "0x%lx", a
->constant
);
615 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
616 func (stream
, "(%s)", getregname (a
->r
));
620 func (stream
, "0x%lx", a
->constant
);
621 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
622 func (stream
, "%s", getregpname (a
->rp
));
626 /*Removed the *2 part as because implicit zeros are no more required.
627 Have to fix this as this needs a bit of extension in terms of branch
629 if (IS_INSN_TYPE (BRANCH_INS
) || IS_INSN_MNEMONIC ("bal"))
632 longdisp
= a
->constant
;
633 /* REVISIT: To sync with WinIDEA and CR16 4.1tools, the below
635 /* longdisp <<= 1; */
636 mask
= ((LONGLONG
)1 << a
->size
) - 1;
642 if (longdisp
& ((LONGLONG
)1 << a
->size
))
645 longdisp
= ~(longdisp
) + 1;
655 longdisp
= ~(longdisp
) + 1;
660 func (stream
, "Wrong offset used in branch/bal instruction");
663 a
->constant
= (unsigned long int) (longdisp
& mask
);
665 /* For branch Neq instruction it is 2*offset + 2. */
666 else if (IS_INSN_TYPE (BRANCH_NEQ_INS
))
667 a
->constant
= 2 * a
->constant
+ 2;
669 if ((!IS_INSN_TYPE (CSTBIT_INS
)) && (!IS_INSN_TYPE (LD_STOR_INS
)))
670 (sign_flag
) ? func (stream
, "%s", "*-"): func (stream
, "%s","*+");
672 /* PR 10173: Avoid printing the 0x prefix twice. */
673 if (info
->symtab_size
> 0)
674 func (stream
, "%s", "0x");
675 number
= ((relative
? memaddr
: 0) +
676 (sign_flag
? ((- a
->constant
) & 0xffffffe) : a
->constant
));
678 (*info
->print_address_func
) ((number
& ((1 << 24) - 1)), info
);
680 func (stream
, "%s", print_exp_len (instruction
->size
* 16));
688 /* Print all the arguments of CURRINSN instruction. */
691 print_arguments (ins
*currentInsn
, bfd_vma memaddr
, struct disassemble_info
*info
)
695 /* For "pop/push/popret RA instruction only. */
696 if ((IS_INSN_MNEMONIC ("pop")
697 || (IS_INSN_MNEMONIC ("popret")
698 || (IS_INSN_MNEMONIC ("push"))))
699 && currentInsn
->nargs
== 1)
701 info
->fprintf_func (info
->stream
, "RA");
705 for (i
= 0; i
< currentInsn
->nargs
; i
++)
707 processing_argument_number
= i
;
709 /* For "bal (ra), disp17" instruction only. */
710 if ((IS_INSN_MNEMONIC ("bal")) && (i
== 0) && instruction
->size
== 2)
712 info
->fprintf_func (info
->stream
, "(ra),");
716 if ((INST_HAS_REG_LIST
) && (i
== 2))
717 info
->fprintf_func (info
->stream
, "RA");
719 print_arg (¤tInsn
->arg
[i
], memaddr
, info
);
721 if ((i
!= currentInsn
->nargs
- 1) && (!IS_INSN_MNEMONIC ("b")))
722 info
->fprintf_func (info
->stream
, ",");
726 /* Build the instruction's arguments. */
729 cr16_make_instruction (void)
734 for (i
= 0; i
< cr16_currInsn
.nargs
; i
++)
738 memset (&a
, 0, sizeof (a
));
739 a
.type
= getargtype (instruction
->operands
[i
].op_type
);
740 a
.size
= getbits (instruction
->operands
[i
].op_type
);
741 shift
= instruction
->operands
[i
].shift
;
743 make_argument (&a
, shift
);
744 cr16_currInsn
.arg
[i
] = a
;
747 /* Calculate instruction size (in bytes). */
748 cr16_currInsn
.size
= instruction
->size
+ (size_changed
? 1 : 0);
750 cr16_currInsn
.size
*= 2;
753 /* Retrieve a single word from a given memory address. */
756 get_word_at_PC (bfd_vma memaddr
, struct disassemble_info
*info
)
762 status
= info
->read_memory_func (memaddr
, buffer
, 2, info
);
765 insn
= (wordU
) bfd_getl16 (buffer
);
770 /* Retrieve multiple words (3) from a given memory address. */
773 get_words_at_PC (bfd_vma memaddr
, struct disassemble_info
*info
)
778 for (i
= 0, mem
= memaddr
; i
< 3; i
++, mem
+= 2)
779 cr16_words
[i
] = get_word_at_PC (mem
, info
);
781 cr16_allWords
= ((ULONGLONG
) cr16_words
[0] << 32)
782 + ((unsigned long) cr16_words
[1] << 16) + cr16_words
[2];
785 /* Prints the instruction by calling print_arguments after proper matching. */
788 print_insn_cr16 (bfd_vma memaddr
, struct disassemble_info
*info
)
790 int is_decoded
; /* Nonzero means instruction has a match. */
792 /* Initialize global variables. */
796 /* Retrieve the encoding from current memory location. */
797 get_words_at_PC (memaddr
, info
);
798 /* Find a matching opcode in table. */
799 is_decoded
= cr16_match_opcode ();
800 /* If found, print the instruction's mnemonic and arguments. */
801 if (is_decoded
> 0 && (cr16_words
[0] != 0 || cr16_words
[1] != 0))
803 if (startswith (instruction
->mnemonic
, "cinv"))
804 info
->fprintf_func (info
->stream
,"%s",
805 getcinvstring (instruction
->mnemonic
));
807 info
->fprintf_func (info
->stream
, "%s", instruction
->mnemonic
);
809 if (((cr16_currInsn
.nargs
= get_number_of_operands ()) != 0)
810 && ! (IS_INSN_MNEMONIC ("b")))
811 info
->fprintf_func (info
->stream
, "\t");
812 cr16_make_instruction ();
813 /* For push/pop/pushrtn with RA instructions. */
814 if ((INST_HAS_REG_LIST
) && ((cr16_words
[0] >> 7) & 0x1))
815 cr16_currInsn
.nargs
+=1;
816 print_arguments (&cr16_currInsn
, memaddr
, info
);
817 return cr16_currInsn
.size
;
820 /* No match found. */
821 info
->fprintf_func (info
->stream
,"%s ",ILLEGAL
);