[deliverable/binutils-gdb.git] / gdb / xtensa-tdep.h

/* Target-dependent code for the Xtensa port of GDB, the GNU debugger.

   Copyright (C) 2003, 2005, 2006, 2007 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */


/* XTENSA_TDEP_VERSION can/should be changed along with XTENSA_CONFIG_VERSION
   whenever the "tdep" structure changes in an incompatible way.  */

#define XTENSA_TDEP_VERSION 0x60

/*  Xtensa register type.  */

typedef enum 
{
  xtRegisterTypeArRegfile = 1,	/* Register File ar0..arXX.  */
  xtRegisterTypeSpecialReg,	/* CPU states, such as PS, Booleans, (rsr).  */
  xtRegisterTypeUserReg,	/* User defined registers (rur).  */
  xtRegisterTypeTieRegfile,	/* User define register files.  */
  xtRegisterTypeTieState,	/* TIE States (mapped on user regs).  */
  xtRegisterTypeMapped,		/* Mapped on Special Registers.  */
  xtRegisterTypeUnmapped,	/* Special case of masked registers.  */
  xtRegisterTypeWindow,		/* Live window registers (a0..a15).  */
  xtRegisterTypeVirtual,	/* PC, FP.  */
  xtRegisterTypeUnknown
} xtensa_register_type_t;


/*  Xtensa register group.  */

#define XTENSA_MAX_COPROCESSOR	0x08  /* Number of Xtensa coprocessors.  */

typedef enum 
{
  xtRegisterGroupUnknown = 0,
  xtRegisterGroupRegFile	= 0x0001,    /* Register files without ARx.  */
  xtRegisterGroupAddrReg	= 0x0002,    /* ARx.  */
  xtRegisterGroupSpecialReg	= 0x0004,    /* SRxx.  */
  xtRegisterGroupUserReg	= 0x0008,    /* URxx.  */
  xtRegisterGroupState 		= 0x0010,    /* States.  */

  xtRegisterGroupGeneral	= 0x0100,    /* General registers, Ax, SR.  */
  xtRegisterGroupUser		= 0x0200,    /* User registers.  */
  xtRegisterGroupFloat		= 0x0400,    /* Floating Point.  */
  xtRegisterGroupVectra		= 0x0800,    /* Vectra.  */
  xtRegisterGroupSystem		= 0x1000,    /* System.  */

  xtRegisterGroupCP0	    = 0x01000000,    /* CP0.  */
  xtRegisterGroupCP1	    = 0x02000000,    /* CP1.  */
  xtRegisterGroupCP2	    = 0x04000000,    /* CP2.  */
  xtRegisterGroupCP3	    = 0x08000000,    /* CP3.  */
  xtRegisterGroupCP4	    = 0x10000000,    /* CP4.  */
  xtRegisterGroupCP5	    = 0x20000000,    /* CP5.  */
  xtRegisterGroupCP6	    = 0x40000000,    /* CP6.  */
  xtRegisterGroupCP7	    = 0x80000000,    /* CP7.  */

} xtensa_register_group_t;


/*  Xtensa target flags.  */

typedef enum 
{
  xtTargetFlagsNonVisibleRegs	= 0x0001,
  xtTargetFlagsUseFetchStore	= 0x0002,
} xtensa_target_flags_t;


/* Xtensa ELF core file register set representation ('.reg' section). 
   Copied from target-side ELF header <xtensa/elf.h>.  */

typedef unsigned long xtensa_elf_greg_t;

typedef struct
{
  xtensa_elf_greg_t xchal_config_id0;
  xtensa_elf_greg_t xchal_config_id1;
  xtensa_elf_greg_t cpux;
  xtensa_elf_greg_t cpuy;
  xtensa_elf_greg_t pc;
  xtensa_elf_greg_t ps;
  xtensa_elf_greg_t exccause;
  xtensa_elf_greg_t excvaddr;
  xtensa_elf_greg_t windowbase;
  xtensa_elf_greg_t windowstart;
  xtensa_elf_greg_t lbeg;
  xtensa_elf_greg_t lend;
  xtensa_elf_greg_t lcount;
  xtensa_elf_greg_t sar;
  xtensa_elf_greg_t syscall;
  xtensa_elf_greg_t ar[0];	/* variable size (per config).  */
} xtensa_elf_gregset_t;

#define SIZEOF_GREGSET (sizeof (xtensa_elf_gregset_t) + gdbarch_tdep (current_gdbarch)->num_aregs * 4)
#define XTENSA_ELF_NGREG (SIZEOF_GREGSET / sizeof(xtensa_elf_greg_t))


/*  Mask.  */

typedef struct 
{
  int reg_num;
  int bit_start;
  int bit_size;
} xtensa_reg_mask_t;

typedef struct 
{
  int count;
  xtensa_reg_mask_t *mask;
} xtensa_mask_t;


/*  Xtensa register representation.  */

typedef struct 
{
  char* name;             	/* Register name.  */
  int offset;             	/* Offset.  */
  xtensa_register_type_t type;  /* Register type.  */
  xtensa_register_group_t group;/* Register group.  */
  struct type* ctype;		/* C-type.  */
  int bit_size;  		/* The actual bit size in the target.  */
  int byte_size;          	/* Actual space allocated in registers[].  */
  int align;			/* Alignment for this register.  */

  unsigned int target_number;	/* Register target number.  */

  int flags;			/* Flags.  */

  const xtensa_mask_t *mask;	/* Register is a compilation of other regs.  */
  const char *fetch;		/* Instruction sequence to fetch register.  */
  const char *store;		/* Instruction sequence to store register.  */
} xtensa_register_t;


#define XTENSA_REGISTER_FLAGS_PRIVILEDGED	0x0001
#define XTENSA_REGISTER_FLAGS_READABLE		0x0002
#define XTENSA_REGISTER_FLAGS_WRITABLE		0x0004
#define XTENSA_REGISTER_FLAGS_VOLATILE		0x0008


/*  Call-ABI for stack frame.  */

typedef enum 
{
  CallAbiDefault = 0,		/* Any 'callX' instructions; default stack.  */
  CallAbiCall0Only,		/* Only 'call0' instructions; flat stack.  */
} call_abi_t;


/*  Xtensa-specific target dependencies.  */

struct gdbarch_tdep
{
  unsigned int target_flags;

  /* Spill location for TIE register files under ocd.  */

  unsigned int spill_location;
  unsigned int spill_size;

  char *unused;				/* Placeholder for compatibility.  */
  call_abi_t call_abi;			/* Calling convention.  */

  /* CPU configuration.  */

  unsigned int debug_interrupt_level;

  unsigned int icache_line_bytes;
  unsigned int dcache_line_bytes;
  unsigned int dcache_writeback;

  unsigned int isa_use_windowed_registers;
  unsigned int isa_use_density_instructions;
  unsigned int isa_use_exceptions;
  unsigned int isa_use_ext_l32r;
  unsigned int isa_max_insn_size;	/* Maximum instruction length.  */
  unsigned int debug_num_ibreaks;	/* Number of IBREAKs.  */
  unsigned int debug_num_dbreaks;

  /* Register map.  */

  xtensa_register_t* regmap;

  unsigned int num_regs;	/* Number of registers in regmap.  */
  unsigned int num_pseudo_regs;	/* Number of pseudo registers.  */
  unsigned int num_aregs;	/* Size of register file.  */
  unsigned int num_contexts;

  int ar_base;			/* Register number for AR0.  */
  int a0_base;			/* Register number for A0 (pseudo).  */
  int wb_regnum;		/* Register number for WB.  */
  int ws_regnum;		/* Register number for WS.  */
  int pc_regnum;		/* Register number for PC.  */
  int ps_regnum;		/* Register number for PS.  */
  int lbeg_regnum;		/* Register numbers for count regs.  */
  int lend_regnum;
  int lcount_regnum;
  int sar_regnum;		/* Register number of SAR.  */
  int litbase_regnum;		/* Register number of LITBASE.  */

  int interrupt_regnum;		/* Register number for interrupt.  */
  int interrupt2_regnum;	/* Register number for interrupt2.  */
  int cpenable_regnum;		/* Register number for cpenable.  */
  int debugcause_regnum;	/* Register number for debugcause.  */
  int exccause_regnum;		/* Register number for exccause.  */
  int excvaddr_regnum;		/* Register number for excvaddr.  */

  int max_register_raw_size;
  int max_register_virtual_size;
  unsigned long *fp_layout;	/* Layout of custom/TIE regs in 'FP' area.  */
  unsigned int fp_layout_bytes;	/* Size of layout information (in bytes).  */
  unsigned long *gregmap;
};


#define WB_SHIFT	  2

/* We assign fixed numbers to the registers of the "current" window 
   (i.e., relative to WB).  The registers get remapped via the reg_map 
   data structure to their corresponding register in the AR register 
   file (see xtensa-tdep.c).  */
Commit	Line	Data
	1	/* Target-dependent code for the Xtensa port of GDB, the GNU debugger.
	2
	3	Copyright (C) 2003, 2005, 2006, 2007 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
	21	/* XTENSA_TDEP_VERSION can/should be changed along with XTENSA_CONFIG_VERSION
	22	whenever the "tdep" structure changes in an incompatible way. */
	23
	24	#define XTENSA_TDEP_VERSION 0x60
	25
	26	/* Xtensa register type. */
	27
	28	typedef enum
	29	{
	30	xtRegisterTypeArRegfile = 1, /* Register File ar0..arXX. */
	31	xtRegisterTypeSpecialReg, /* CPU states, such as PS, Booleans, (rsr). */
	32	xtRegisterTypeUserReg, /* User defined registers (rur). */
	33	xtRegisterTypeTieRegfile, /* User define register files. */
	34	xtRegisterTypeTieState, /* TIE States (mapped on user regs). */
	35	xtRegisterTypeMapped, /* Mapped on Special Registers. */
	36	xtRegisterTypeUnmapped, /* Special case of masked registers. */
	37	xtRegisterTypeWindow, /* Live window registers (a0..a15). */
	38	xtRegisterTypeVirtual, /* PC, FP. */
	39	xtRegisterTypeUnknown
	40	} xtensa_register_type_t;
	41
	42
	43	/* Xtensa register group. */
	44
	45	#define XTENSA_MAX_COPROCESSOR 0x08 /* Number of Xtensa coprocessors. */
	46
	47	typedef enum
	48	{
	49	xtRegisterGroupUnknown = 0,
	50	xtRegisterGroupRegFile = 0x0001, /* Register files without ARx. */
	51	xtRegisterGroupAddrReg = 0x0002, /* ARx. */
	52	xtRegisterGroupSpecialReg = 0x0004, /* SRxx. */
	53	xtRegisterGroupUserReg = 0x0008, /* URxx. */
	54	xtRegisterGroupState = 0x0010, /* States. */
	55
	56	xtRegisterGroupGeneral = 0x0100, /* General registers, Ax, SR. */
	57	xtRegisterGroupUser = 0x0200, /* User registers. */
	58	xtRegisterGroupFloat = 0x0400, /* Floating Point. */
	59	xtRegisterGroupVectra = 0x0800, /* Vectra. */
	60	xtRegisterGroupSystem = 0x1000, /* System. */
	61
	62	xtRegisterGroupCP0 = 0x01000000, /* CP0. */
	63	xtRegisterGroupCP1 = 0x02000000, /* CP1. */
	64	xtRegisterGroupCP2 = 0x04000000, /* CP2. */
	65	xtRegisterGroupCP3 = 0x08000000, /* CP3. */
	66	xtRegisterGroupCP4 = 0x10000000, /* CP4. */
	67	xtRegisterGroupCP5 = 0x20000000, /* CP5. */
	68	xtRegisterGroupCP6 = 0x40000000, /* CP6. */
	69	xtRegisterGroupCP7 = 0x80000000, /* CP7. */
	70
	71	} xtensa_register_group_t;
	72
	73
	74	/* Xtensa target flags. */
	75
	76	typedef enum
	77	{
	78	xtTargetFlagsNonVisibleRegs = 0x0001,
	79	xtTargetFlagsUseFetchStore = 0x0002,
	80	} xtensa_target_flags_t;
	81
	82
	83	/* Xtensa ELF core file register set representation ('.reg' section).
	84	Copied from target-side ELF header <xtensa/elf.h>. */
	85
	86	typedef unsigned long xtensa_elf_greg_t;
	87
	88	typedef struct
	89	{
	90	xtensa_elf_greg_t xchal_config_id0;
	91	xtensa_elf_greg_t xchal_config_id1;
	92	xtensa_elf_greg_t cpux;
	93	xtensa_elf_greg_t cpuy;
	94	xtensa_elf_greg_t pc;
	95	xtensa_elf_greg_t ps;
	96	xtensa_elf_greg_t exccause;
	97	xtensa_elf_greg_t excvaddr;
	98	xtensa_elf_greg_t windowbase;
	99	xtensa_elf_greg_t windowstart;
	100	xtensa_elf_greg_t lbeg;
	101	xtensa_elf_greg_t lend;
	102	xtensa_elf_greg_t lcount;
	103	xtensa_elf_greg_t sar;
	104	xtensa_elf_greg_t syscall;
	105	xtensa_elf_greg_t ar[0]; /* variable size (per config). */
	106	} xtensa_elf_gregset_t;
	107
	108	#define SIZEOF_GREGSET (sizeof (xtensa_elf_gregset_t) + gdbarch_tdep (current_gdbarch)->num_aregs * 4)
	109	#define XTENSA_ELF_NGREG (SIZEOF_GREGSET / sizeof(xtensa_elf_greg_t))
	110
	111
	112	/* Mask. */
	113
	114	typedef struct
	115	{
	116	int reg_num;
	117	int bit_start;
	118	int bit_size;
	119	} xtensa_reg_mask_t;
	120
	121	typedef struct
	122	{
	123	int count;
	124	xtensa_reg_mask_t *mask;
	125	} xtensa_mask_t;
	126
	127
	128	/* Xtensa register representation. */
	129
	130	typedef struct
	131	{
	132	char* name; /* Register name. */
	133	int offset; /* Offset. */
	134	xtensa_register_type_t type; /* Register type. */
	135	xtensa_register_group_t group;/* Register group. */
	136	struct type* ctype; /* C-type. */
	137	int bit_size; /* The actual bit size in the target. */
	138	int byte_size; /* Actual space allocated in registers[]. */
	139	int align; /* Alignment for this register. */
	140
	141	unsigned int target_number; /* Register target number. */
	142
	143	int flags; /* Flags. */
	144
	145	const xtensa_mask_t mask; / Register is a compilation of other regs. */
	146	const char fetch; / Instruction sequence to fetch register. */
	147	const char store; / Instruction sequence to store register. */
	148	} xtensa_register_t;
	149
	150
	151	#define XTENSA_REGISTER_FLAGS_PRIVILEDGED 0x0001
	152	#define XTENSA_REGISTER_FLAGS_READABLE 0x0002
	153	#define XTENSA_REGISTER_FLAGS_WRITABLE 0x0004
	154	#define XTENSA_REGISTER_FLAGS_VOLATILE 0x0008
	155
	156
	157	/* Call-ABI for stack frame. */
	158
	159	typedef enum
	160	{
	161	CallAbiDefault = 0, /* Any 'callX' instructions; default stack. */
	162	CallAbiCall0Only, /* Only 'call0' instructions; flat stack. */
	163	} call_abi_t;
	164
	165
	166	/* Xtensa-specific target dependencies. */
	167
	168	struct gdbarch_tdep
	169	{
	170	unsigned int target_flags;
	171
	172	/* Spill location for TIE register files under ocd. */
	173
	174	unsigned int spill_location;
	175	unsigned int spill_size;
	176
	177	char unused; / Placeholder for compatibility. */
	178	call_abi_t call_abi; /* Calling convention. */
	179
	180	/* CPU configuration. */
	181
	182	unsigned int debug_interrupt_level;
	183
	184	unsigned int icache_line_bytes;
	185	unsigned int dcache_line_bytes;
	186	unsigned int dcache_writeback;
	187
	188	unsigned int isa_use_windowed_registers;
	189	unsigned int isa_use_density_instructions;
	190	unsigned int isa_use_exceptions;
	191	unsigned int isa_use_ext_l32r;
	192	unsigned int isa_max_insn_size; /* Maximum instruction length. */
	193	unsigned int debug_num_ibreaks; /* Number of IBREAKs. */
	194	unsigned int debug_num_dbreaks;
	195
	196	/* Register map. */
	197
	198	xtensa_register_t* regmap;
	199
	200	unsigned int num_regs; /* Number of registers in regmap. */
	201	unsigned int num_pseudo_regs; /* Number of pseudo registers. */
	202	unsigned int num_aregs; /* Size of register file. */
	203	unsigned int num_contexts;
	204
	205	int ar_base; /* Register number for AR0. */
	206	int a0_base; /* Register number for A0 (pseudo). */
	207	int wb_regnum; /* Register number for WB. */
	208	int ws_regnum; /* Register number for WS. */
	209	int pc_regnum; /* Register number for PC. */
	210	int ps_regnum; /* Register number for PS. */
	211	int lbeg_regnum; /* Register numbers for count regs. */
	212	int lend_regnum;
	213	int lcount_regnum;
	214	int sar_regnum; /* Register number of SAR. */
	215	int litbase_regnum; /* Register number of LITBASE. */
	216
	217	int interrupt_regnum; /* Register number for interrupt. */
	218	int interrupt2_regnum; /* Register number for interrupt2. */
	219	int cpenable_regnum; /* Register number for cpenable. */
	220	int debugcause_regnum; /* Register number for debugcause. */
	221	int exccause_regnum; /* Register number for exccause. */
	222	int excvaddr_regnum; /* Register number for excvaddr. */
	223
	224	int max_register_raw_size;
	225	int max_register_virtual_size;
	226	unsigned long fp_layout; / Layout of custom/TIE regs in 'FP' area. */
	227	unsigned int fp_layout_bytes; /* Size of layout information (in bytes). */
	228	unsigned long *gregmap;
	229	};
	230
	231
	232	#define WB_SHIFT 2
	233
	234	/* We assign fixed numbers to the registers of the "current" window
	235	(i.e., relative to WB). The registers get remapped via the reg_map
	236	data structure to their corresponding register in the AR register
	237	file (see xtensa-tdep.c). */
	238