aboutsummaryrefslogtreecommitdiff
path: root/src/target/xtensa/xtensa_regs.h
blob: 1d9d3657ac86c14bfd3b8dfd3314a458a28cb6e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/* SPDX-License-Identifier: GPL-2.0-or-later */

/***************************************************************************
 *   Generic Xtensa target API for OpenOCD                                 *
 *   Copyright (C) 2020-2022 Cadence Design Systems, Inc.                  *
 *   Copyright (C) 2016-2019 Espressif Systems Ltd.                        *
 *   Author: Angus Gratton gus@projectgus.com                              *
 ***************************************************************************/

#ifndef OPENOCD_TARGET_XTENSA_REGS_H
#define OPENOCD_TARGET_XTENSA_REGS_H

struct reg_arch_type;

enum xtensa_reg_id {
	XT_REG_IDX_PC = 0,
	XT_REG_IDX_AR0,
	XT_REG_IDX_ARFIRST = XT_REG_IDX_AR0,
	XT_REG_IDX_AR1,
	XT_REG_IDX_AR2,
	XT_REG_IDX_AR3,
	XT_REG_IDX_AR4,
	XT_REG_IDX_AR5,
	XT_REG_IDX_AR6,
	XT_REG_IDX_AR7,
	XT_REG_IDX_AR8,
	XT_REG_IDX_AR9,
	XT_REG_IDX_AR10,
	XT_REG_IDX_AR11,
	XT_REG_IDX_AR12,
	XT_REG_IDX_AR13,
	XT_REG_IDX_AR14,
	XT_REG_IDX_AR15,
	XT_REG_IDX_ARLAST = 64,	/* Max 64 ARs */
	XT_REG_IDX_WINDOWBASE,
	XT_REG_IDX_WINDOWSTART,
	XT_REG_IDX_PS,
	XT_REG_IDX_IBREAKENABLE,
	XT_REG_IDX_DDR,
	XT_REG_IDX_IBREAKA0,
	XT_REG_IDX_IBREAKA1,
	XT_REG_IDX_DBREAKA0,
	XT_REG_IDX_DBREAKA1,
	XT_REG_IDX_DBREAKC0,
	XT_REG_IDX_DBREAKC1,
	XT_REG_IDX_CPENABLE,
	XT_REG_IDX_EXCCAUSE,
	XT_REG_IDX_DEBUGCAUSE,
	XT_REG_IDX_ICOUNT,
	XT_REG_IDX_ICOUNTLEVEL,
	XT_REG_IDX_A0,
	XT_REG_IDX_A1,
	XT_REG_IDX_A2,
	XT_REG_IDX_A3,
	XT_REG_IDX_A4,
	XT_REG_IDX_A5,
	XT_REG_IDX_A6,
	XT_REG_IDX_A7,
	XT_REG_IDX_A8,
	XT_REG_IDX_A9,
	XT_REG_IDX_A10,
	XT_REG_IDX_A11,
	XT_REG_IDX_A12,
	XT_REG_IDX_A13,
	XT_REG_IDX_A14,
	XT_REG_IDX_A15,
	XT_NUM_REGS
};

typedef uint32_t xtensa_reg_val_t;

#define XT_NUM_A_REGS   16

enum xtensa_reg_type {
	XT_REG_GENERAL = 0,		/* General-purpose register; part of the windowed register set */
	XT_REG_USER = 1,		/* User register, needs RUR to read */
	XT_REG_SPECIAL = 2,		/* Special register, needs RSR to read */
	XT_REG_DEBUG = 3,		/* Register used for the debug interface. Don't mess with this. */
	XT_REG_RELGEN = 4,		/* Relative general address. Points to the absolute addresses plus the window
					 * index */
	XT_REG_FR = 5,			/* Floating-point register */
	XT_REG_TIE = 6,			/* TIE (custom) register */
	XT_REG_OTHER = 7,		/* Other (typically legacy) register */
	XT_REG_TYPE_NUM,

	/* enum names must be one of the above types + _VAL or _MASK */
	XT_REG_GENERAL_MASK             = 0xFFC0,
	XT_REG_GENERAL_VAL              = 0x0100,
	XT_REG_USER_MASK                = 0xFF00,
	XT_REG_USER_VAL                 = 0x0300,
	XT_REG_SPECIAL_MASK             = 0xFF00,
	XT_REG_SPECIAL_VAL              = 0x0200,
	XT_REG_DEBUG_MASK               = 0xFF00,
	XT_REG_DEBUG_VAL                = 0x0200,
	XT_REG_RELGEN_MASK              = 0xFFE0,
	XT_REG_RELGEN_VAL               = 0x0000,
	XT_REG_FR_MASK                  = 0xFFF0,
	XT_REG_FR_VAL                   = 0x0030,
	XT_REG_TIE_MASK                 = 0xF000,
	XT_REG_TIE_VAL                  = 0xF000,	/* unused */
	XT_REG_OTHER_MASK               = 0xFFFF,
	XT_REG_OTHER_VAL                = 0xF000,	/* unused */

	XT_REG_INDEX_MASK               = 0x00FF
};

enum xtensa_reg_flags {
	XT_REGF_NOREAD = 0x01,	/* Register is write-only */
	XT_REGF_COPROC0 = 0x02,	/* Can't be read if coproc0 isn't enabled */
	XT_REGF_MASK = 0x03
};

struct xtensa_reg_desc {
	const char *name;
	bool exist;
	unsigned int reg_num;			/* ISA register num (meaning depends on register type) */
	unsigned int dbreg_num;			/* Debugger-visible register num (reg type encoded) */
	enum xtensa_reg_type type;
	enum xtensa_reg_flags flags;
};

#define _XT_MK_DBREGN(reg_num, reg_type)					\
	((reg_type ## _VAL) | (reg_num))

#define _XT_MK_DBREGN_MASK(reg_num, reg_mask)				\
	((reg_mask) | (reg_num))

#define XT_MK_REG_DESC(n, r, t, f)							\
	{ .name = (n), .exist = false, .reg_num = (r),			\
	  .dbreg_num = _XT_MK_DBREGN(r, t), .type = (t),		\
	  .flags = (f) }

extern struct xtensa_reg_desc xtensa_regs[XT_NUM_REGS];

#endif	/* OPENOCD_TARGET_XTENSA_REGS_H */