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-2015 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 #define XCHAL_CP_NUM			1	/* number of coprocessors */
36 #define XCHAL_CP_MAX			8	/* max CP ID + 1 (0 if none) */
37 #define XCHAL_CP_MASK			0x80	/* bitmask of all CPs by ID */
38 #define XCHAL_CP_PORT_MASK		0x80	/* bitmask of only port CPs */
39 
40 /*  Basic parameters of each coprocessor:  */
41 #define XCHAL_CP7_NAME			"XTIOP"
42 #define XCHAL_CP7_IDENT			XTIOP
43 #define XCHAL_CP7_SA_SIZE		0	/* size of state save area */
44 #define XCHAL_CP7_SA_ALIGN		1	/* min alignment of save area */
45 #define XCHAL_CP_ID_XTIOP           	7	/* coprocessor ID (0..7) */
46 
47 /*  Filler info for unassigned coprocessors, to simplify arrays etc:  */
48 #define XCHAL_CP0_SA_SIZE		0
49 #define XCHAL_CP0_SA_ALIGN		1
50 #define XCHAL_CP1_SA_SIZE		0
51 #define XCHAL_CP1_SA_ALIGN		1
52 #define XCHAL_CP2_SA_SIZE		0
53 #define XCHAL_CP2_SA_ALIGN		1
54 #define XCHAL_CP3_SA_SIZE		0
55 #define XCHAL_CP3_SA_ALIGN		1
56 #define XCHAL_CP4_SA_SIZE		0
57 #define XCHAL_CP4_SA_ALIGN		1
58 #define XCHAL_CP5_SA_SIZE		0
59 #define XCHAL_CP5_SA_ALIGN		1
60 #define XCHAL_CP6_SA_SIZE		0
61 #define XCHAL_CP6_SA_ALIGN		1
62 
63 /*  Save area for non-coprocessor optional and custom (TIE) state:  */
64 #define XCHAL_NCP_SA_SIZE		36
65 #define XCHAL_NCP_SA_ALIGN		4
66 
67 /*  Total save area for optional and custom state (NCP + CPn):  */
68 #define XCHAL_TOTAL_SA_SIZE		48	/* with 16-byte align padding */
69 #define XCHAL_TOTAL_SA_ALIGN		4	/* actual minimum alignment */
70 
71 /*
72  * Detailed contents of save areas.
73  * NOTE:  caller must define the XCHAL_SA_REG macro (not defined here)
74  * before expanding the XCHAL_xxx_SA_LIST() macros.
75  *
76  * XCHAL_SA_REG(s,ccused,abikind,kind,opt,name,galign,align,asize,
77  *		dbnum,base,regnum,bitsz,gapsz,reset,x...)
78  *
79  *	s = passed from XCHAL_*_LIST(s), eg. to select how to expand
80  *	ccused = set if used by compiler without special options or code
81  *	abikind = 0 (caller-saved), 1 (callee-saved), or 2 (thread-global)
82  *	kind = 0 (special reg), 1 (TIE user reg), or 2 (TIE regfile reg)
83  *	opt = 0 (custom TIE extension or coprocessor), or 1 (optional reg)
84  *	name = lowercase reg name (no quotes)
85  *	galign = group byte alignment (power of 2) (galign >= align)
86  *	align = register byte alignment (power of 2)
87  *	asize = allocated size in bytes (asize*8 == bitsz + gapsz + padsz)
88  *	  (not including any pad bytes required to galign this or next reg)
89  *	dbnum = unique target number f/debug (see <xtensa-libdb-macros.h>)
90  *	base = reg shortname w/o index (or sr=special, ur=TIE user reg)
91  *	regnum = reg index in regfile, or special/TIE-user reg number
92  *	bitsz = number of significant bits (regfile width, or ur/sr mask bits)
93  *	gapsz = intervening bits, if bitsz bits not stored contiguously
94  *	(padsz = pad bits at end [TIE regfile] or at msbits [ur,sr] of asize)
95  *	reset = register reset value (or 0 if undefined at reset)
96  *	x = reserved for future use (0 until then)
97  *
98  *  To filter out certain registers, e.g. to expand only the non-global
99  *  registers used by the compiler, you can do something like this:
100  *
101  *  #define XCHAL_SA_REG(s,ccused,p...)	SELCC##ccused(p)
102  *  #define SELCC0(p...)
103  *  #define SELCC1(abikind,p...)	SELAK##abikind(p)
104  *  #define SELAK0(p...)		REG(p)
105  *  #define SELAK1(p...)		REG(p)
106  *  #define SELAK2(p...)
107  *  #define REG(kind,tie,name,galn,aln,asz,csz,dbnum,base,rnum,bsz,rst,x...) \
108  *		...what you want to expand...
109  */
110 
111 #define XCHAL_NCP_SA_NUM	9
112 #define XCHAL_NCP_SA_LIST(s)	\
113  XCHAL_SA_REG(s,1,2,1,1,      threadptr, 4, 4, 4,0x03E7,  ur,231, 32,0,0,0) \
114  XCHAL_SA_REG(s,1,0,0,1,          acclo, 4, 4, 4,0x0210,  sr,16 , 32,0,0,0) \
115  XCHAL_SA_REG(s,1,0,0,1,          acchi, 4, 4, 4,0x0211,  sr,17 ,  8,0,0,0) \
116  XCHAL_SA_REG(s,0,0,0,1,             br, 4, 4, 4,0x0204,  sr,4  , 16,0,0,0) \
117  XCHAL_SA_REG(s,0,0,0,1,      scompare1, 4, 4, 4,0x020C,  sr,12 , 32,0,0,0) \
118  XCHAL_SA_REG(s,0,0,0,1,             m0, 4, 4, 4,0x0220,  sr,32 , 32,0,0,0) \
119  XCHAL_SA_REG(s,0,0,0,1,             m1, 4, 4, 4,0x0221,  sr,33 , 32,0,0,0) \
120  XCHAL_SA_REG(s,0,0,0,1,             m2, 4, 4, 4,0x0222,  sr,34 , 32,0,0,0) \
121  XCHAL_SA_REG(s,0,0,0,1,             m3, 4, 4, 4,0x0223,  sr,35 , 32,0,0,0)
122 
123 #define XCHAL_CP0_SA_NUM	0
124 #define XCHAL_CP0_SA_LIST(s)	/* empty */
125 
126 #define XCHAL_CP1_SA_NUM	0
127 #define XCHAL_CP1_SA_LIST(s)	/* empty */
128 
129 #define XCHAL_CP2_SA_NUM	0
130 #define XCHAL_CP2_SA_LIST(s)	/* empty */
131 
132 #define XCHAL_CP3_SA_NUM	0
133 #define XCHAL_CP3_SA_LIST(s)	/* empty */
134 
135 #define XCHAL_CP4_SA_NUM	0
136 #define XCHAL_CP4_SA_LIST(s)	/* empty */
137 
138 #define XCHAL_CP5_SA_NUM	0
139 #define XCHAL_CP5_SA_LIST(s)	/* empty */
140 
141 #define XCHAL_CP6_SA_NUM	0
142 #define XCHAL_CP6_SA_LIST(s)	/* empty */
143 
144 #define XCHAL_CP7_SA_NUM	0
145 #define XCHAL_CP7_SA_LIST(s)	/* empty */
146 
147 /* Byte length of instruction from its first nibble (op0 field), per FLIX.  */
148 #define XCHAL_OP0_FORMAT_LENGTHS	3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3
149 /* Byte length of instruction from its first byte, per FLIX.  */
150 #define XCHAL_BYTE0_FORMAT_LENGTHS	\
151 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3,\
152 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3,\
153 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3,\
154 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3,\
155 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3,\
156 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3,\
157 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3,\
158 	3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3, 3,3,3,3,3,3,3,3,2,2,2,2,2,2,3,3
159 
160 #endif /*_XTENSA_CORE_TIE_H*/
161 
162