Switch the license of all .c files to GPLv3.
[external/binutils.git] / gdb / ppc-tdep.h
1 /* Target-dependent code for GDB, the GNU debugger.
2
3    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2007
4    Free Software Foundation, Inc.
5
6    This file is part of GDB.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
20
21 #ifndef PPC_TDEP_H
22 #define PPC_TDEP_H
23
24 struct gdbarch;
25 struct frame_info;
26 struct value;
27 struct regcache;
28 struct type;
29
30 /* From ppc-linux-tdep.c... */
31 enum return_value_convention ppc_sysv_abi_return_value (struct gdbarch *gdbarch,
32                                                         struct type *valtype,
33                                                         struct regcache *regcache,
34                                                         gdb_byte *readbuf,
35                                                         const gdb_byte *writebuf);
36 enum return_value_convention ppc_sysv_abi_broken_return_value (struct gdbarch *gdbarch,
37                                                                struct type *valtype,
38                                                                struct regcache *regcache,
39                                                                gdb_byte *readbuf,
40                                                                const gdb_byte *writebuf);
41 CORE_ADDR ppc_sysv_abi_push_dummy_call (struct gdbarch *gdbarch,
42                                         struct value *function,
43                                         struct regcache *regcache,
44                                         CORE_ADDR bp_addr, int nargs,
45                                         struct value **args, CORE_ADDR sp,
46                                         int struct_return,
47                                         CORE_ADDR struct_addr);
48 CORE_ADDR ppc64_sysv_abi_push_dummy_call (struct gdbarch *gdbarch,
49                                           struct value *function,
50                                           struct regcache *regcache,
51                                           CORE_ADDR bp_addr, int nargs,
52                                           struct value **args, CORE_ADDR sp,
53                                           int struct_return,
54                                           CORE_ADDR struct_addr);
55 CORE_ADDR ppc64_sysv_abi_adjust_breakpoint_address (struct gdbarch *gdbarch,
56                                                     CORE_ADDR bpaddr);
57 int ppc_linux_memory_remove_breakpoint (struct bp_target_info *bp_tgt);
58 struct link_map_offsets *ppc_linux_svr4_fetch_link_map_offsets (void);
59 void ppc_linux_supply_gregset (struct regcache *regcache,
60                                int regnum, const void *gregs, size_t size,
61                                int wordsize);
62 void ppc_linux_supply_fpregset (const struct regset *regset,
63                                 struct regcache *regcache,
64                                 int regnum, const void *gregs, size_t size);
65
66 enum return_value_convention ppc64_sysv_abi_return_value (struct gdbarch *gdbarch,
67                                                           struct type *valtype,
68                                                           struct regcache *regcache,
69                                                           gdb_byte *readbuf,
70                                                           const gdb_byte *writebuf);
71
72 /* From rs6000-tdep.c... */
73 int altivec_register_p (int regno);
74 int spe_register_p (int regno);
75
76 /* Return non-zero if the architecture described by GDBARCH has
77    floating-point registers (f0 --- f31 and fpscr).  */
78 int ppc_floating_point_unit_p (struct gdbarch *gdbarch);
79
80 /* Register set description.  */
81
82 struct ppc_reg_offsets
83 {
84   /* General-purpose registers.  */
85   int r0_offset;
86   int pc_offset;
87   int ps_offset;
88   int cr_offset;
89   int lr_offset;
90   int ctr_offset;
91   int xer_offset;
92   int mq_offset;
93
94   /* Floating-point registers.  */
95   int f0_offset;
96   int fpscr_offset;
97
98   /* AltiVec registers.  */
99   int vr0_offset;
100   int vscr_offset;
101   int vrsave_offset;
102 };
103
104 /* Supply register REGNUM in the general-purpose register set REGSET
105    from the buffer specified by GREGS and LEN to register cache
106    REGCACHE.  If REGNUM is -1, do this for all registers in REGSET.  */
107
108 extern void ppc_supply_gregset (const struct regset *regset,
109                                 struct regcache *regcache,
110                                 int regnum, const void *gregs, size_t len);
111
112 /* Supply register REGNUM in the floating-point register set REGSET
113    from the buffer specified by FPREGS and LEN to register cache
114    REGCACHE.  If REGNUM is -1, do this for all registers in REGSET.  */
115
116 extern void ppc_supply_fpregset (const struct regset *regset,
117                                  struct regcache *regcache,
118                                  int regnum, const void *fpregs, size_t len);
119
120 /* Collect register REGNUM in the general-purpose register set
121    REGSET. from register cache REGCACHE into the buffer specified by
122    GREGS and LEN.  If REGNUM is -1, do this for all registers in
123    REGSET.  */
124
125 extern void ppc_collect_gregset (const struct regset *regset,
126                                  const struct regcache *regcache,
127                                  int regnum, void *gregs, size_t len);
128
129 /* Collect register REGNUM in the floating-point register set
130    REGSET. from register cache REGCACHE into the buffer specified by
131    FPREGS and LEN.  If REGNUM is -1, do this for all registers in
132    REGSET.  */
133
134 extern void ppc_collect_fpregset (const struct regset *regset,
135                                   const struct regcache *regcache,
136                                   int regnum, void *fpregs, size_t len);
137
138 /* Private data that this module attaches to struct gdbarch. */
139
140 struct gdbarch_tdep
141   {
142     int wordsize;              /* size in bytes of fixed-point word */
143     const struct reg *regs;    /* from current variant */
144     int ppc_gp0_regnum;         /* GPR register 0 */
145     int ppc_toc_regnum;         /* TOC register */
146     int ppc_ps_regnum;          /* Processor (or machine) status (%msr) */
147     int ppc_cr_regnum;          /* Condition register */
148     int ppc_lr_regnum;          /* Link register */
149     int ppc_ctr_regnum;         /* Count register */
150     int ppc_xer_regnum;         /* Integer exception register */
151
152     /* Not all PPC and RS6000 variants will have the registers
153        represented below.  A -1 is used to indicate that the register
154        is not present in this variant.  */
155
156     /* Floating-point registers.  */
157     int ppc_fp0_regnum;         /* floating-point register 0 */
158     int ppc_fpscr_regnum;       /* fp status and condition register */
159
160     /* Segment registers.  */
161     int ppc_sr0_regnum;         /* segment register 0 */
162
163     /* Multiplier-Quotient Register (older POWER architectures only).  */
164     int ppc_mq_regnum;
165
166     /* Altivec registers.  */
167     int ppc_vr0_regnum;         /* First AltiVec register */
168     int ppc_vrsave_regnum;      /* Last AltiVec register */
169
170     /* SPE registers.  */
171     int ppc_ev0_upper_regnum;   /* First GPR upper half register */
172     int ppc_ev0_regnum;         /* First ev register */
173     int ppc_ev31_regnum;        /* Last ev register */
174     int ppc_acc_regnum;         /* SPE 'acc' register */
175     int ppc_spefscr_regnum;     /* SPE 'spefscr' register */
176
177     /* Offset to ABI specific location where link register is saved.  */
178     int lr_frame_offset;        
179
180     /* An array of integers, such that sim_regno[I] is the simulator
181        register number for GDB register number I, or -1 if the
182        simulator does not implement that register.  */
183     int *sim_regno;
184
185     /* Minimum possible text address.  */
186     CORE_ADDR text_segment_base;
187
188     /* ISA-specific types.  */
189     struct type *ppc_builtin_type_vec64;
190     struct type *ppc_builtin_type_vec128;
191 };
192
193
194 /* Constants for register set sizes.  */
195 enum
196   {
197     ppc_num_gprs = 32,          /* 32 general-purpose registers */
198     ppc_num_fprs = 32,          /* 32 floating-point registers */
199     ppc_num_srs = 16,           /* 16 segment registers */
200     ppc_num_vrs = 32            /* 32 Altivec vector registers */
201   };
202
203
204 /* Constants for SPR register numbers.  These are *not* GDB register
205    numbers: they are the numbers used in the PowerPC ISA itself to
206    refer to these registers.
207
208    This table includes all the SPRs from all the variants I could find
209    documentation for.
210
211    There may be registers from different PowerPC variants assigned the
212    same number, but that's fine: GDB and the SIM always use the
213    numbers in the context of a particular variant, so it's not
214    ambiguous.
215
216    We need to deviate from the naming pattern when variants have
217    special-purpose registers of the same name, but with different
218    numbers.  Fortunately, this is rare: look below to see how we
219    handle the 'tcr' registers on the 403/403GX and 602.  */
220
221 enum
222   {
223     ppc_spr_mq        =    0,
224     ppc_spr_xer       =    1,
225     ppc_spr_rtcu      =    4,
226     ppc_spr_rtcl      =    5,
227     ppc_spr_lr        =    8,
228     ppc_spr_ctr       =    9,
229     ppc_spr_cnt       =    9,
230     ppc_spr_dsisr     =   18,
231     ppc_spr_dar       =   19,
232     ppc_spr_dec       =   22,
233     ppc_spr_sdr1      =   25,
234     ppc_spr_srr0      =   26,
235     ppc_spr_srr1      =   27,
236     ppc_spr_eie       =   80,
237     ppc_spr_eid       =   81,
238     ppc_spr_nri       =   82,
239     ppc_spr_sp        =  102,
240     ppc_spr_cmpa      =  144,
241     ppc_spr_cmpb      =  145,
242     ppc_spr_cmpc      =  146,
243     ppc_spr_cmpd      =  147,
244     ppc_spr_icr       =  148,
245     ppc_spr_der       =  149,
246     ppc_spr_counta    =  150,
247     ppc_spr_countb    =  151,
248     ppc_spr_cmpe      =  152,
249     ppc_spr_cmpf      =  153,
250     ppc_spr_cmpg      =  154,
251     ppc_spr_cmph      =  155,
252     ppc_spr_lctrl1    =  156,
253     ppc_spr_lctrl2    =  157,
254     ppc_spr_ictrl     =  158,
255     ppc_spr_bar       =  159,
256     ppc_spr_vrsave    =  256,
257     ppc_spr_sprg0     =  272,
258     ppc_spr_sprg1     =  273,
259     ppc_spr_sprg2     =  274,
260     ppc_spr_sprg3     =  275,
261     ppc_spr_asr       =  280,
262     ppc_spr_ear       =  282,
263     ppc_spr_tbl       =  284,
264     ppc_spr_tbu       =  285,
265     ppc_spr_pvr       =  287,
266     ppc_spr_spefscr   =  512,
267     ppc_spr_ibat0u    =  528,
268     ppc_spr_ibat0l    =  529,
269     ppc_spr_ibat1u    =  530,
270     ppc_spr_ibat1l    =  531,
271     ppc_spr_ibat2u    =  532,
272     ppc_spr_ibat2l    =  533,
273     ppc_spr_ibat3u    =  534,
274     ppc_spr_ibat3l    =  535,
275     ppc_spr_dbat0u    =  536,
276     ppc_spr_dbat0l    =  537,
277     ppc_spr_dbat1u    =  538,
278     ppc_spr_dbat1l    =  539,
279     ppc_spr_dbat2u    =  540,
280     ppc_spr_dbat2l    =  541,
281     ppc_spr_dbat3u    =  542,
282     ppc_spr_dbat3l    =  543,
283     ppc_spr_ic_cst    =  560,
284     ppc_spr_ic_adr    =  561,
285     ppc_spr_ic_dat    =  562,
286     ppc_spr_dc_cst    =  568,
287     ppc_spr_dc_adr    =  569,
288     ppc_spr_dc_dat    =  570,
289     ppc_spr_dpdr      =  630,
290     ppc_spr_dpir      =  631,
291     ppc_spr_immr      =  638,
292     ppc_spr_mi_ctr    =  784,
293     ppc_spr_mi_ap     =  786,
294     ppc_spr_mi_epn    =  787,
295     ppc_spr_mi_twc    =  789,
296     ppc_spr_mi_rpn    =  790,
297     ppc_spr_mi_cam    =  816,
298     ppc_spr_mi_ram0   =  817,
299     ppc_spr_mi_ram1   =  818,
300     ppc_spr_md_ctr    =  792,
301     ppc_spr_m_casid   =  793,
302     ppc_spr_md_ap     =  794,
303     ppc_spr_md_epn    =  795,
304     ppc_spr_m_twb     =  796,
305     ppc_spr_md_twc    =  797,
306     ppc_spr_md_rpn    =  798,
307     ppc_spr_m_tw      =  799,
308     ppc_spr_mi_dbcam  =  816,
309     ppc_spr_mi_dbram0 =  817,
310     ppc_spr_mi_dbram1 =  818,
311     ppc_spr_md_dbcam  =  824,
312     ppc_spr_md_cam    =  824,
313     ppc_spr_md_dbram0 =  825,
314     ppc_spr_md_ram0   =  825,
315     ppc_spr_md_dbram1 =  826,
316     ppc_spr_md_ram1   =  826,
317     ppc_spr_ummcr0    =  936,
318     ppc_spr_upmc1     =  937,
319     ppc_spr_upmc2     =  938,
320     ppc_spr_usia      =  939,
321     ppc_spr_ummcr1    =  940,
322     ppc_spr_upmc3     =  941,
323     ppc_spr_upmc4     =  942,
324     ppc_spr_zpr       =  944,
325     ppc_spr_pid       =  945,
326     ppc_spr_mmcr0     =  952,
327     ppc_spr_pmc1      =  953,
328     ppc_spr_sgr       =  953,
329     ppc_spr_pmc2      =  954,
330     ppc_spr_dcwr      =  954,
331     ppc_spr_sia       =  955,
332     ppc_spr_mmcr1     =  956,
333     ppc_spr_pmc3      =  957,
334     ppc_spr_pmc4      =  958,
335     ppc_spr_sda       =  959,
336     ppc_spr_tbhu      =  972,
337     ppc_spr_tblu      =  973,
338     ppc_spr_dmiss     =  976,
339     ppc_spr_dcmp      =  977,
340     ppc_spr_hash1     =  978,
341     ppc_spr_hash2     =  979,
342     ppc_spr_icdbdr    =  979,
343     ppc_spr_imiss     =  980,
344     ppc_spr_esr       =  980,
345     ppc_spr_icmp      =  981,
346     ppc_spr_dear      =  981,
347     ppc_spr_rpa       =  982,
348     ppc_spr_evpr      =  982,
349     ppc_spr_cdbcr     =  983,
350     ppc_spr_tsr       =  984,
351     ppc_spr_602_tcr   =  984,
352     ppc_spr_403_tcr   =  986,
353     ppc_spr_ibr       =  986,
354     ppc_spr_pit       =  987,
355     ppc_spr_esasrr    =  988,
356     ppc_spr_tbhi      =  988,
357     ppc_spr_tblo      =  989,
358     ppc_spr_srr2      =  990,
359     ppc_spr_sebr      =  990,
360     ppc_spr_srr3      =  991,
361     ppc_spr_ser       =  991,
362     ppc_spr_hid0      = 1008,
363     ppc_spr_dbsr      = 1008,
364     ppc_spr_hid1      = 1009,
365     ppc_spr_iabr      = 1010,
366     ppc_spr_dbcr      = 1010,
367     ppc_spr_iac1      = 1012,
368     ppc_spr_dabr      = 1013,
369     ppc_spr_iac2      = 1013,
370     ppc_spr_dac1      = 1014,
371     ppc_spr_dac2      = 1015,
372     ppc_spr_l2cr      = 1017,
373     ppc_spr_dccr      = 1018,
374     ppc_spr_ictc      = 1019,
375     ppc_spr_iccr      = 1019,
376     ppc_spr_thrm1     = 1020,
377     ppc_spr_pbl1      = 1020,
378     ppc_spr_thrm2     = 1021,
379     ppc_spr_pbu1      = 1021,
380     ppc_spr_thrm3     = 1022,
381     ppc_spr_pbl2      = 1022,
382     ppc_spr_fpecr     = 1022,
383     ppc_spr_lt        = 1022,
384     ppc_spr_pir       = 1023,
385     ppc_spr_pbu2      = 1023
386   };
387
388 /* Instruction size.  */
389 #define PPC_INSN_SIZE 4
390
391 /* Estimate for the maximum number of instrctions in a function epilogue.  */
392 #define PPC_MAX_EPILOGUE_INSTRUCTIONS  52
393
394 #endif /* ppc-tdep.h */