1 /*
2  * tie.h -- compile-time HAL definitions dependent on CORE & TIE configuration
3  *
4  *  NOTE:  This header file is not meant to be included directly.
5  */
6 
7 /* This header file describes this specific Xtensa processor's TIE extensions
8    that extend basic Xtensa core functionality.  It is customized to this
9    Xtensa processor configuration.
10 
11    Copyright (c) 1999-2019 Cadence Design Systems Inc.
12 
13    Permission is hereby granted, free of charge, to any person obtaining
14    a copy of this software and associated documentation files (the
15    "Software"), to deal in the Software without restriction, including
16    without limitation the rights to use, copy, modify, merge, publish,
17    distribute, sublicense, and/or sell copies of the Software, and to
18    permit persons to whom the Software is furnished to do so, subject to
19    the following conditions:
20 
21    The above copyright notice and this permission notice shall be included
22    in all copies or substantial portions of the Software.
23 
24    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
28    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
29    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
30    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  */
31 
32 #ifndef XTENSA_CORE_TIE_H
33 #define XTENSA_CORE_TIE_H
34 
35 /* parasoft-begin-suppress ALL "This file not MISRA checked." */
36 
37 #if 0
38 #define XCHAL_CP_NUM			2	/* number of coprocessors */
39 #define XCHAL_CP_MAX			2	/* max CP ID + 1 (0 if none) */
40 #define XCHAL_CP_MASK			0x03	/* bitmask of all CPs by ID */
41 #define XCHAL_CP_PORT_MASK		0x00	/* bitmask of only port CPs */
42 
43 /*  Basic parameters of each coprocessor:  */
44 #define XCHAL_CP0_NAME			"FPU"
45 #define XCHAL_CP0_IDENT			FPU
46 #define XCHAL_CP0_SA_SIZE		72	/* size of state save area */
47 #define XCHAL_CP0_SA_ALIGN		4	/* min alignment of save area */
48 #define XCHAL_CP_ID_FPU             	0	/* coprocessor ID (0..7) */
49 #define XCHAL_CP1_NAME			"AudioEngineLX"
50 #define XCHAL_CP1_IDENT			AudioEngineLX
51 #define XCHAL_CP1_SA_SIZE		184	/* size of state save area */
52 #define XCHAL_CP1_SA_ALIGN		8	/* min alignment of save area */
53 #define XCHAL_CP_ID_AUDIOENGINELX   	1	/* coprocessor ID (0..7) */
54 
55 /*  Filler info for unassigned coprocessors, to simplify arrays etc:  */
56 #define XCHAL_CP2_SA_SIZE		0
57 #define XCHAL_CP2_SA_ALIGN		1
58 #define XCHAL_CP3_SA_SIZE		0
59 #define XCHAL_CP3_SA_ALIGN		1
60 #define XCHAL_CP4_SA_SIZE		0
61 #define XCHAL_CP4_SA_ALIGN		1
62 #define XCHAL_CP5_SA_SIZE		0
63 #define XCHAL_CP5_SA_ALIGN		1
64 #define XCHAL_CP6_SA_SIZE		0
65 #define XCHAL_CP6_SA_ALIGN		1
66 #define XCHAL_CP7_SA_SIZE		0
67 #define XCHAL_CP7_SA_ALIGN		1
68 
69 #else
70 
71 #define XCHAL_CP_NUM                    0	/* number of coprocessors */
72 #define XCHAL_CP_MAX                    0	/* max CP ID + 1 (0 if none) */
73 #define XCHAL_CP_MASK                   0x00    /* bitmask of all CPs by ID */
74 #define XCHAL_CP_PORT_MASK              0x00    /* bitmask of only port CPs */
75 
76 #endif
77 
78 /*  Save area for non-coprocessor optional and custom (TIE) state:  */
79 #define XCHAL_NCP_SA_SIZE		12
80 #define XCHAL_NCP_SA_ALIGN		4
81 
82 /*  Total save area for optional and custom state (NCP + CPn):  */
83 #define XCHAL_TOTAL_SA_SIZE		272	/* with 16-byte align padding */
84 #define XCHAL_TOTAL_SA_ALIGN		8	/* actual minimum alignment */
85 
86 /*
87  * Detailed contents of save areas.
88  * NOTE:  caller must define the XCHAL_SA_REG macro (not defined here)
89  * before expanding the XCHAL_xxx_SA_LIST() macros.
90  *
91  * XCHAL_SA_REG(s,ccused,abikind,kind,opt,name,galign,align,asize,
92  *		dbnum,base,regnum,bitsz,gapsz,reset,x...)
93  *
94  *	s = passed from XCHAL_*_LIST(s), eg. to select how to expand
95  *	ccused = set if used by compiler without special options or code
96  *	abikind = 0 (caller-saved), 1 (callee-saved), or 2 (thread-global)
97  *	kind = 0 (special reg), 1 (TIE user reg), or 2 (TIE regfile reg)
98  *	opt = 0 (custom TIE extension or coprocessor), or 1 (optional reg)
99  *	name = lowercase reg name (no quotes)
100  *	galign = group byte alignment (power of 2) (galign >= align)
101  *	align = register byte alignment (power of 2)
102  *	asize = allocated size in bytes (asize*8 == bitsz + gapsz + padsz)
103  *	  (not including any pad bytes required to galign this or next reg)
104  *	dbnum = unique target number f/debug (see <xtensa-libdb-macros.h>)
105  *	base = reg shortname w/o index (or sr=special, ur=TIE user reg)
106  *	regnum = reg index in regfile, or special/TIE-user reg number
107  *	bitsz = number of significant bits (regfile width, or ur/sr mask bits)
108  *	gapsz = intervening bits, if bitsz bits not stored contiguously
109  *	(padsz = pad bits at end [TIE regfile] or at msbits [ur,sr] of asize)
110  *	reset = register reset value (or 0 if undefined at reset)
111  *	x = reserved for future use (0 until then)
112  *
113  *  To filter out certain registers, e.g. to expand only the non-global
114  *  registers used by the compiler, you can do something like this:
115  *
116  *  #define XCHAL_SA_REG(s,ccused,p...)	SELCC##ccused(p)
117  *  #define SELCC0(p...)
118  *  #define SELCC1(abikind,p...)	SELAK##abikind(p)
119  *  #define SELAK0(p...)		REG(p)
120  *  #define SELAK1(p...)		REG(p)
121  *  #define SELAK2(p...)
122  *  #define REG(kind,tie,name,galn,aln,asz,csz,dbnum,base,rnum,bsz,rst,x...) \
123  *		...what you want to expand...
124  */
125 
126 #define XCHAL_NCP_SA_NUM	3
127 #define XCHAL_NCP_SA_LIST(s)	\
128  XCHAL_SA_REG(s,1,2,1,1,      threadptr, 4, 4, 4,0x03E7,  ur,231, 32,0,0,0) \
129  XCHAL_SA_REG(s,0,0,0,1,             br, 4, 4, 4,0x0204,  sr,4  , 16,0,0,0) \
130  XCHAL_SA_REG(s,0,0,0,1,      scompare1, 4, 4, 4,0x020C,  sr,12 , 32,0,0,0)
131 
132 #define XCHAL_CP0_SA_NUM	18
133 #define XCHAL_CP0_SA_LIST(s)	\
134  XCHAL_SA_REG(s,0,0,1,0,            fcr, 4, 4, 4,0x03E8,  ur,232, 32,0,0,0) \
135  XCHAL_SA_REG(s,0,0,1,0,            fsr, 4, 4, 4,0x03E9,  ur,233, 32,0,0,0) \
136  XCHAL_SA_REG(s,0,0,2,0,             f0, 4, 4, 4,0x0030,   f,0  , 32,0,0,0) \
137  XCHAL_SA_REG(s,0,0,2,0,             f1, 4, 4, 4,0x0031,   f,1  , 32,0,0,0) \
138  XCHAL_SA_REG(s,0,0,2,0,             f2, 4, 4, 4,0x0032,   f,2  , 32,0,0,0) \
139  XCHAL_SA_REG(s,0,0,2,0,             f3, 4, 4, 4,0x0033,   f,3  , 32,0,0,0) \
140  XCHAL_SA_REG(s,0,0,2,0,             f4, 4, 4, 4,0x0034,   f,4  , 32,0,0,0) \
141  XCHAL_SA_REG(s,0,0,2,0,             f5, 4, 4, 4,0x0035,   f,5  , 32,0,0,0) \
142  XCHAL_SA_REG(s,0,0,2,0,             f6, 4, 4, 4,0x0036,   f,6  , 32,0,0,0) \
143  XCHAL_SA_REG(s,0,0,2,0,             f7, 4, 4, 4,0x0037,   f,7  , 32,0,0,0) \
144  XCHAL_SA_REG(s,0,0,2,0,             f8, 4, 4, 4,0x0038,   f,8  , 32,0,0,0) \
145  XCHAL_SA_REG(s,0,0,2,0,             f9, 4, 4, 4,0x0039,   f,9  , 32,0,0,0) \
146  XCHAL_SA_REG(s,0,0,2,0,            f10, 4, 4, 4,0x003A,   f,10 , 32,0,0,0) \
147  XCHAL_SA_REG(s,0,0,2,0,            f11, 4, 4, 4,0x003B,   f,11 , 32,0,0,0) \
148  XCHAL_SA_REG(s,0,0,2,0,            f12, 4, 4, 4,0x003C,   f,12 , 32,0,0,0) \
149  XCHAL_SA_REG(s,0,0,2,0,            f13, 4, 4, 4,0x003D,   f,13 , 32,0,0,0) \
150  XCHAL_SA_REG(s,0,0,2,0,            f14, 4, 4, 4,0x003E,   f,14 , 32,0,0,0) \
151  XCHAL_SA_REG(s,0,0,2,0,            f15, 4, 4, 4,0x003F,   f,15 , 32,0,0,0)
152 
153 #define XCHAL_CP1_SA_NUM	26
154 #define XCHAL_CP1_SA_LIST(s)	\
155  XCHAL_SA_REG(s,0,0,1,0,     ae_ovf_sar, 8, 4, 4,0x03F0,  ur,240,  8,0,0,0) \
156  XCHAL_SA_REG(s,0,0,1,0,     ae_bithead, 4, 4, 4,0x03F1,  ur,241, 32,0,0,0) \
157  XCHAL_SA_REG(s,0,0,1,0,ae_ts_fts_bu_bp, 4, 4, 4,0x03F2,  ur,242, 16,0,0,0) \
158  XCHAL_SA_REG(s,0,0,1,0,    ae_cw_sd_no, 4, 4, 4,0x03F3,  ur,243, 29,0,0,0) \
159  XCHAL_SA_REG(s,0,0,1,0,     ae_cbegin0, 4, 4, 4,0x03F6,  ur,246, 32,0,0,0) \
160  XCHAL_SA_REG(s,0,0,1,0,       ae_cend0, 4, 4, 4,0x03F7,  ur,247, 32,0,0,0) \
161  XCHAL_SA_REG(s,0,0,2,0,           aed0, 8, 8, 8,0x1000, aed,0  , 64,0,0,0) \
162  XCHAL_SA_REG(s,0,0,2,0,           aed1, 8, 8, 8,0x1001, aed,1  , 64,0,0,0) \
163  XCHAL_SA_REG(s,0,0,2,0,           aed2, 8, 8, 8,0x1002, aed,2  , 64,0,0,0) \
164  XCHAL_SA_REG(s,0,0,2,0,           aed3, 8, 8, 8,0x1003, aed,3  , 64,0,0,0) \
165  XCHAL_SA_REG(s,0,0,2,0,           aed4, 8, 8, 8,0x1004, aed,4  , 64,0,0,0) \
166  XCHAL_SA_REG(s,0,0,2,0,           aed5, 8, 8, 8,0x1005, aed,5  , 64,0,0,0) \
167  XCHAL_SA_REG(s,0,0,2,0,           aed6, 8, 8, 8,0x1006, aed,6  , 64,0,0,0) \
168  XCHAL_SA_REG(s,0,0,2,0,           aed7, 8, 8, 8,0x1007, aed,7  , 64,0,0,0) \
169  XCHAL_SA_REG(s,0,0,2,0,           aed8, 8, 8, 8,0x1008, aed,8  , 64,0,0,0) \
170  XCHAL_SA_REG(s,0,0,2,0,           aed9, 8, 8, 8,0x1009, aed,9  , 64,0,0,0) \
171  XCHAL_SA_REG(s,0,0,2,0,          aed10, 8, 8, 8,0x100A, aed,10 , 64,0,0,0) \
172  XCHAL_SA_REG(s,0,0,2,0,          aed11, 8, 8, 8,0x100B, aed,11 , 64,0,0,0) \
173  XCHAL_SA_REG(s,0,0,2,0,          aed12, 8, 8, 8,0x100C, aed,12 , 64,0,0,0) \
174  XCHAL_SA_REG(s,0,0,2,0,          aed13, 8, 8, 8,0x100D, aed,13 , 64,0,0,0) \
175  XCHAL_SA_REG(s,0,0,2,0,          aed14, 8, 8, 8,0x100E, aed,14 , 64,0,0,0) \
176  XCHAL_SA_REG(s,0,0,2,0,          aed15, 8, 8, 8,0x100F, aed,15 , 64,0,0,0) \
177  XCHAL_SA_REG(s,0,0,2,0,             u0, 8, 8, 8,0x1010,   u,0  , 64,0,0,0) \
178  XCHAL_SA_REG(s,0,0,2,0,             u1, 8, 8, 8,0x1011,   u,1  , 64,0,0,0) \
179  XCHAL_SA_REG(s,0,0,2,0,             u2, 8, 8, 8,0x1012,   u,2  , 64,0,0,0) \
180  XCHAL_SA_REG(s,0,0,2,0,             u3, 8, 8, 8,0x1013,   u,3  , 64,0,0,0)
181 
182 #define XCHAL_CP2_SA_NUM	0
183 #define XCHAL_CP2_SA_LIST(s)	/* empty */
184 
185 #define XCHAL_CP3_SA_NUM	0
186 #define XCHAL_CP3_SA_LIST(s)	/* empty */
187 
188 #define XCHAL_CP4_SA_NUM	0
189 #define XCHAL_CP4_SA_LIST(s)	/* empty */
190 
191 #define XCHAL_CP5_SA_NUM	0
192 #define XCHAL_CP5_SA_LIST(s)	/* empty */
193 
194 #define XCHAL_CP6_SA_NUM	0
195 #define XCHAL_CP6_SA_LIST(s)	/* empty */
196 
197 #define XCHAL_CP7_SA_NUM	0
198 #define XCHAL_CP7_SA_LIST(s)	/* empty */
199 
200 /* Byte length of instruction from its first nibble (op0 field), per FLIX.  */
201 #define XCHAL_OP0_FORMAT_LENGTHS	3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8
202 /* Byte length of instruction from its first byte, per FLIX.  */
203 #define XCHAL_BYTE0_FORMAT_LENGTHS	\
204 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8,\
205 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8,\
206 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8,\
207 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8,\
208 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8,\
209 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8,\
210 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8,\
211 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,8,8
212 
213 /* parasoft-end-suppress ALL "This file not MISRA checked." */
214 
215 #endif /* XTENSA_CORE_TIE_H */
216 
217