xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/mips-tdep.h (revision 8ecbf5f02b752fcb7debe1a8fab1dc82602bc760)
1 /* Target-dependent header for the MIPS architecture, for GDB, the GNU Debugger.
2 
3    Copyright (C) 2002-2017 Free Software Foundation, Inc.
4 
5    This file is part of GDB.
6 
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11 
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16 
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19 
20 #ifndef MIPS_TDEP_H
21 #define MIPS_TDEP_H
22 
23 #include "objfiles.h"
24 
25 struct gdbarch;
26 
27 /* All the possible MIPS ABIs.  */
28 enum mips_abi
29   {
30     MIPS_ABI_UNKNOWN = 0,
31     MIPS_ABI_N32,
32     MIPS_ABI_O32,
33     MIPS_ABI_N64,
34     MIPS_ABI_O64,
35     MIPS_ABI_EABI32,
36     MIPS_ABI_EABI64,
37     MIPS_ABI_LAST
38   };
39 
40 /* Return the MIPS ABI associated with GDBARCH.  */
41 enum mips_abi mips_abi (struct gdbarch *gdbarch);
42 
43 /* Base and compressed MIPS ISA variations.  */
44 enum mips_isa
45   {
46     ISA_MIPS = -1,		/* mips_compression_string depends on it.  */
47     ISA_MIPS16,
48     ISA_MICROMIPS
49   };
50 
51 /* Corresponding MSYMBOL_TARGET_FLAG aliases.  */
52 #define MSYMBOL_TARGET_FLAG_MIPS16 MSYMBOL_TARGET_FLAG_1
53 #define MSYMBOL_TARGET_FLAG_MICROMIPS MSYMBOL_TARGET_FLAG_2
54 
55 /* Return the MIPS ISA's register size.  Just a short cut to the BFD
56    architecture's word size.  */
57 extern int mips_isa_regsize (struct gdbarch *gdbarch);
58 
59 /* Return the current index for various MIPS registers.  */
60 struct mips_regnum
61 {
62   int pc;
63   int fp0;
64   int fp_implementation_revision;
65   int fp_control_status;
66   int badvaddr;		/* Bad vaddr for addressing exception.  */
67   int cause;		/* Describes last exception.  */
68   int hi;		/* Multiply/divide temp.  */
69   int lo;		/* ...  */
70   int dspacc;		/* SmartMIPS/DSP accumulators.  */
71   int dspctl;		/* DSP control.  */
72 };
73 extern const struct mips_regnum *mips_regnum (struct gdbarch *gdbarch);
74 
75 /* Some MIPS boards don't support floating point while others only
76    support single-precision floating-point operations.  */
77 
78 enum mips_fpu_type
79 {
80   MIPS_FPU_DOUBLE,		/* Full double precision floating point.  */
81   MIPS_FPU_SINGLE,		/* Single precision floating point (R4650).  */
82   MIPS_FPU_NONE			/* No floating point.  */
83 };
84 
85 /* MIPS specific per-architecture information.  */
86 struct gdbarch_tdep
87 {
88   /* from the elf header */
89   int elf_flags;
90 
91   /* mips options */
92   enum mips_abi mips_abi;
93   enum mips_abi found_abi;
94   enum mips_isa mips_isa;
95   enum mips_fpu_type mips_fpu_type;
96   int mips_last_arg_regnum;
97   int mips_last_fp_arg_regnum;
98   int default_mask_address_p;
99   /* Is the target using 64-bit raw integer registers but only
100      storing a left-aligned 32-bit value in each?  */
101   int mips64_transfers_32bit_regs_p;
102   /* Indexes for various registers.  IRIX and embedded have
103      different values.  This contains the "public" fields.  Don't
104      add any that do not need to be public.  */
105   const struct mips_regnum *regnum;
106   /* Register names table for the current register set.  */
107   const char **mips_processor_reg_names;
108 
109   /* The size of register data available from the target, if known.
110      This doesn't quite obsolete the manual
111      mips64_transfers_32bit_regs_p, since that is documented to force
112      left alignment even for big endian (very strange).  */
113   int register_size_valid_p;
114   int register_size;
115 
116   /* Return the expected next PC if FRAME is stopped at a syscall
117      instruction.  */
118   CORE_ADDR (*syscall_next_pc) (struct frame_info *frame);
119 };
120 
121 /* Register numbers of various important registers.  */
122 
123 enum
124 {
125   MIPS_ZERO_REGNUM = 0,		/* Read-only register, always 0.  */
126   MIPS_AT_REGNUM = 1,
127   MIPS_V0_REGNUM = 2,		/* Function integer return value.  */
128   MIPS_A0_REGNUM = 4,		/* Loc of first arg during a subr call.  */
129   MIPS_S0_REGNUM = 16,
130   MIPS_S1_REGNUM = 17,
131   MIPS_S2_REGNUM = 18,		/* Contains return address in MIPS16 thunks. */
132   MIPS_S3_REGNUM = 19,
133   MIPS_S4_REGNUM = 20,
134   MIPS_S5_REGNUM = 21,
135   MIPS_S6_REGNUM = 22,
136   MIPS_S7_REGNUM = 23,
137   MIPS_T8_REGNUM = 24,
138   MIPS_T9_REGNUM = 25,		/* Contains address of callee in PIC.  */
139   MIPS_GP_REGNUM = 28,
140   MIPS_SP_REGNUM = 29,
141   MIPS_S8_REGNUM = 30,
142   MIPS_RA_REGNUM = 31,
143   MIPS_PS_REGNUM = 32,		/* Contains processor status.  */
144   MIPS_EMBED_LO_REGNUM = 33,
145   MIPS_EMBED_HI_REGNUM = 34,
146   MIPS_EMBED_BADVADDR_REGNUM = 35,
147   MIPS_EMBED_CAUSE_REGNUM = 36,
148   MIPS_EMBED_PC_REGNUM = 37,
149   MIPS_EMBED_FP0_REGNUM = 38,
150   MIPS_UNUSED_REGNUM = 73,	/* Never used, FIXME.  */
151   MIPS_FIRST_EMBED_REGNUM = 74,	/* First CP0 register for embedded use.  */
152   MIPS_PRID_REGNUM = 89,	/* Processor ID.  */
153   MIPS_LAST_EMBED_REGNUM = 89	/* Last one.  */
154 };
155 
156 /* Instruction sizes and other useful constants.  */
157 enum
158 {
159   MIPS_INSN16_SIZE = 2,
160   MIPS_INSN32_SIZE = 4,
161   /* The number of floating-point or integer registers.  */
162   MIPS_NUMREGS = 32
163 };
164 
165 /* Single step based on where the current instruction will take us.  */
166 extern VEC (CORE_ADDR) *mips_software_single_step (struct regcache *regcache);
167 
168 /* Strip the ISA (compression) bit off from ADDR.  */
169 extern CORE_ADDR mips_unmake_compact_addr (CORE_ADDR addr);
170 
171 /* Tell if the program counter value in MEMADDR is in a standard
172    MIPS function.  */
173 extern int mips_pc_is_mips (bfd_vma memaddr);
174 
175 /* Tell if the program counter value in MEMADDR is in a MIPS16
176    function.  */
177 extern int mips_pc_is_mips16 (struct gdbarch *gdbarch, bfd_vma memaddr);
178 
179 /* Tell if the program counter value in MEMADDR is in a microMIPS
180    function.  */
181 extern int mips_pc_is_micromips (struct gdbarch *gdbarch, bfd_vma memaddr);
182 
183 /* Return the currently configured (or set) saved register size.  */
184 extern unsigned int mips_abi_regsize (struct gdbarch *gdbarch);
185 
186 /* Make PC the address of the next instruction to execute.  */
187 extern void mips_write_pc (struct regcache *regcache, CORE_ADDR pc);
188 
189 /* Target descriptions which only indicate the size of general
190    registers.  */
191 extern struct target_desc *mips_tdesc_gp32;
192 extern struct target_desc *mips_tdesc_gp64;
193 
194 /* Return non-zero if PC is in a MIPS SVR4 lazy binding stub section.  */
195 
196 static inline int
197 in_mips_stubs_section (CORE_ADDR pc)
198 {
199   return pc_in_section (pc, ".MIPS.stubs");
200 }
201 
202 #endif /* MIPS_TDEP_H */
203