xref: /netbsd-src/sys/arch/sparc/include/psl.h (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: psl.h,v 1.33 2003/06/16 20:01:05 thorpej Exp $ */
2 
3 /*
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This software was developed by the Computer Systems Engineering group
8  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
9  * contributed to Berkeley.
10  *
11  * All advertising materials mentioning features or use of this software
12  * must display the following acknowledgement:
13  *	This product includes software developed by the University of
14  *	California, Lawrence Berkeley Laboratory.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. All advertising materials mentioning features or use of this software
25  *    must display the following acknowledgement:
26  *	This product includes software developed by the University of
27  *	California, Berkeley and its contributors.
28  * 4. Neither the name of the University nor the names of its contributors
29  *    may be used to endorse or promote products derived from this software
30  *    without specific prior written permission.
31  *
32  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
34  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
36  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
40  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
41  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42  * SUCH DAMAGE.
43  *
44  *	@(#)psl.h	8.1 (Berkeley) 6/11/93
45  */
46 
47 #ifndef PSR_IMPL
48 
49 /*
50  * SPARC Process Status Register (in psl.h for hysterical raisins).  This
51  * doesn't exist on the V9.
52  *
53  * The picture in the Sun manuals looks like this:
54  *	                                     1 1
55  *	 31   28 27   24 23   20 19       14 3 2 11    8 7 6 5 4       0
56  *	+-------+-------+-------+-----------+-+-+-------+-+-+-+---------+
57  *	|  impl |  ver  |  icc  |  reserved |E|E|  pil  |S|P|E|   CWP   |
58  *	|       |       |n z v c|           |C|F|       | |S|T|         |
59  *	+-------+-------+-------+-----------+-+-+-------+-+-+-+---------+
60  */
61 
62 #define PSR_IMPL	0xf0000000	/* implementation */
63 #define PSR_VER		0x0f000000	/* version */
64 #define PSR_ICC		0x00f00000	/* integer condition codes */
65 #define PSR_N		0x00800000	/* negative */
66 #define PSR_Z		0x00400000	/* zero */
67 #define PSR_O		0x00200000	/* overflow */
68 #define PSR_C		0x00100000	/* carry */
69 #define PSR_EC		0x00002000	/* coprocessor enable */
70 #define PSR_EF		0x00001000	/* FP enable */
71 #define PSR_PIL		0x00000f00	/* interrupt level */
72 #define PSR_S		0x00000080	/* supervisor (kernel) mode */
73 #define PSR_PS		0x00000040	/* previous supervisor mode (traps) */
74 #define PSR_ET		0x00000020	/* trap enable */
75 #define PSR_CWP		0x0000001f	/* current window pointer */
76 
77 #define PSR_BITS "\20\16EC\15EF\10S\7PS\6ET"
78 
79 /* Interesting spl()s */
80 #define PIL_FDSOFT	IPL_SOFTFDC	/* compat */
81 #define PIL_AUSOFT	IPL_SOFTAUDIO	/* compat */
82 #define PIL_TTY		6		/* compat */
83 #define PIL_CLOCK	10
84 #define PIL_FD		11
85 #define PIL_SER		13
86 #define	PIL_AUD		13
87 #define PIL_HIGH	15
88 #define PIL_LOCK	PIL_HIGH
89 
90 /*
91  * SPARC V9 CCR register
92  */
93 
94 #define ICC_C	0x01L
95 #define ICC_V	0x02L
96 #define ICC_Z	0x04L
97 #define ICC_N	0x08L
98 #define XCC_SHIFT	4
99 #define XCC_C	(ICC_C<<XCC_SHIFT)
100 #define XCC_V	(ICC_V<<XCC_SHIFT)
101 #define XCC_Z	(ICC_Z<<XCC_SHIFT)
102 #define XCC_N	(ICC_N<<XCC_SHIFT)
103 
104 
105 /*
106  * SPARC V9 PSTATE register (what replaces the PSR in V9)
107  *
108  * Here's the layout:
109  *
110  *    11   10    9     8   7  6   5     4     3     2     1   0
111  *  +------------------------------------------------------------+
112  *  | IG | MG | CLE | TLE | MM | RED | PEF | AM | PRIV | IE | AG |
113  *  +------------------------------------------------------------+
114  */
115 
116 #define PSTATE_IG	0x800	/* enable spitfire interrupt globals */
117 #define PSTATE_MG	0x400	/* enable spitfire MMU globals */
118 #define PSTATE_CLE	0x200	/* current little endian */
119 #define PSTATE_TLE	0x100	/* traps little endian */
120 #define PSTATE_MM	0x0c0	/* memory model */
121 #define PSTATE_MM_TSO	0x000	/* total store order */
122 #define PSTATE_MM_PSO	0x040	/* partial store order */
123 #define PSTATE_MM_RMO	0x080	/* Relaxed memory order */
124 #define PSTATE_RED	0x020	/* RED state */
125 #define PSTATE_PEF	0x010	/* enable floating point */
126 #define PSTATE_AM	0x008	/* 32-bit address masking */
127 #define PSTATE_PRIV	0x004	/* privileged mode */
128 #define PSTATE_IE	0x002	/* interrupt enable */
129 #define PSTATE_AG	0x001	/* enable alternate globals */
130 
131 #define PSTATE_BITS "\20\14IG\13MG\12CLE\11TLE\10\7MM\6RED\5PEF\4AM\3PRIV\2IE\1AG"
132 
133 
134 /*
135  * 32-bit code requires TSO or at best PSO since that's what's supported on
136  * SPARC V8 and earlier machines.
137  *
138  * 64-bit code sets the memory model in the ELF header.
139  *
140  * We're running kernel code in TSO for the moment so we don't need to worry
141  * about possible memory barrier bugs.
142  */
143 
144 #ifdef __arch64__
145 #define PSTATE_PROM	(PSTATE_MM_TSO|PSTATE_PRIV)
146 #define PSTATE_NUCLEUS	(PSTATE_MM_TSO|PSTATE_PRIV|PSTATE_AG)
147 #define PSTATE_KERN	(PSTATE_MM_TSO|PSTATE_PRIV)
148 #define PSTATE_INTR	(PSTATE_KERN|PSTATE_IE)
149 #define PSTATE_USER32	(PSTATE_MM_TSO|PSTATE_AM|PSTATE_IE)
150 #define PSTATE_USER	(PSTATE_MM_RMO|PSTATE_IE)
151 #else
152 #define PSTATE_PROM	(PSTATE_MM_TSO|PSTATE_PRIV)
153 #define PSTATE_NUCLEUS	(PSTATE_MM_TSO|PSTATE_AM|PSTATE_PRIV|PSTATE_AG)
154 #define PSTATE_KERN	(PSTATE_MM_TSO|PSTATE_AM|PSTATE_PRIV)
155 #define PSTATE_INTR	(PSTATE_KERN|PSTATE_IE)
156 #define PSTATE_USER32	(PSTATE_MM_TSO|PSTATE_AM|PSTATE_IE)
157 #define PSTATE_USER	(PSTATE_MM_TSO|PSTATE_AM|PSTATE_IE)
158 #endif
159 
160 /*
161  * SPARC V9 TSTATE register
162  *
163  *   39 32 31 24 23 18  17   8	7 5 4   0
164  *  +-----+-----+-----+--------+---+-----+
165  *  | CCR | ASI |  -  | PSTATE | - | CWP |
166  *  +-----+-----+-----+--------+---+-----+
167  * */
168 
169 #define TSTATE_CWP		0x01f
170 #define TSTATE_PSTATE		0x6ff00
171 #define TSTATE_PSTATE_SHIFT	8
172 #define TSTATE_ASI		0xff000000LL
173 #define TSTATE_ASI_SHIFT	24
174 #define TSTATE_CCR		0xff00000000LL
175 #define TSTATE_CCR_SHIFT	32
176 
177 #define PSRCC_TO_TSTATE(x)	(((int64_t)(x)&PSR_ICC)<<(TSTATE_CCR_SHIFT-19))
178 #define TSTATECCR_TO_PSR(x)	(((x)&TSTATE_CCR)>>(TSTATE_CCR_SHIFT-19))
179 
180 /*
181  * These are here to simplify life.
182  */
183 #define TSTATE_IG	(PSTATE_IG<<TSTATE_PSTATE_SHIFT)
184 #define TSTATE_MG	(PSTATE_MG<<TSTATE_PSTATE_SHIFT)
185 #define TSTATE_CLE	(PSTATE_CLE<<TSTATE_PSTATE_SHIFT)
186 #define TSTATE_TLE	(PSTATE_TLE<<TSTATE_PSTATE_SHIFT)
187 #define TSTATE_MM	(PSTATE_MM<<TSTATE_PSTATE_SHIFT)
188 #define TSTATE_MM_TSO	(PSTATE_MM_TSO<<TSTATE_PSTATE_SHIFT)
189 #define TSTATE_MM_PSO	(PSTATE_MM_PSO<<TSTATE_PSTATE_SHIFT)
190 #define TSTATE_MM_RMO	(PSTATE_MM_RMO<<TSTATE_PSTATE_SHIFT)
191 #define TSTATE_RED	(PSTATE_RED<<TSTATE_PSTATE_SHIFT)
192 #define TSTATE_PEF	(PSTATE_PEF<<TSTATE_PSTATE_SHIFT)
193 #define TSTATE_AM	(PSTATE_AM<<TSTATE_PSTATE_SHIFT)
194 #define TSTATE_PRIV	(PSTATE_PRIV<<TSTATE_PSTATE_SHIFT)
195 #define TSTATE_IE	(PSTATE_IE<<TSTATE_PSTATE_SHIFT)
196 #define TSTATE_AG	(PSTATE_AG<<TSTATE_PSTATE_SHIFT)
197 
198 #define TSTATE_BITS "\20\14IG\13MG\12CLE\11TLE\10\7MM\6RED\5PEF\4AM\3PRIV\2IE\1AG"
199 
200 #define TSTATE_KERN	((TSTATE_KERN)<<TSTATE_PSTATE_SHIFT)
201 #define TSTATE_USER	((TSTATE_USER)<<TSTATE_PSTATE_SHIFT)
202 /*
203  * SPARC V9 VER version register.
204  *
205  *  63   48 47  32 31  24 23 16 15    8 7 5 4      0
206  * +-------+------+------+-----+-------+---+--------+
207  * | manuf | impl | mask |  -  | maxtl | - | maxwin |
208  * +-------+------+------+-----+-------+---+--------+
209  *
210  */
211 
212 #define VER_MANUF	0xffff000000000000LL
213 #define VER_MANUF_SHIFT	48
214 #define VER_IMPL	0x0000ffff00000000LL
215 #define VER_IMPL_SHIFT	32
216 #define VER_MASK	0x00000000ff000000LL
217 #define VER_MASK_SHIFT	24
218 #define VER_MAXTL	0x000000000000ff00LL
219 #define VER_MAXTL_SHIFT	8
220 #define VER_MAXWIN	0x000000000000001fLL
221 
222 /*
223  * Here are a few things to help us transition between user and kernel mode:
224  */
225 
226 /* Memory models */
227 #define KERN_MM		PSTATE_MM_TSO
228 #define USER_MM		PSTATE_MM_RMO
229 
230 /*
231  * Register window handlers.  These point to generic routines that check the
232  * stack pointer and then vector to the real handler.  We could optimize this
233  * if we could guarantee only 32-bit or 64-bit stacks.
234  */
235 #define WSTATE_KERN	026
236 #define WSTATE_USER	022
237 
238 #define CWP		0x01f
239 
240 /* 64-byte alignment -- this seems the best place to put this. */
241 #define BLOCK_SIZE	64
242 #define BLOCK_ALIGN	0x3f
243 
244 #if defined(_KERNEL) && !defined(_LOCORE)
245 
246 static __inline int getpsr __P((void));
247 static __inline void setpsr __P((int));
248 static __inline void spl0 __P((void));
249 static __inline int splhigh __P((void));
250 static __inline void splx __P((int));
251 static __inline int getmid __P((void));
252 
253 /*
254  * GCC pseudo-functions for manipulating PSR (primarily PIL field).
255  */
256 static __inline int getpsr()
257 {
258 	int psr;
259 
260 	__asm __volatile("rd %%psr,%0" : "=r" (psr));
261 	return (psr);
262 }
263 
264 static __inline int getmid()
265 {
266 	int mid;
267 
268 	__asm __volatile("rd %%tbr,%0" : "=r" (mid));
269 	return ((mid >> 20) & 0x3);
270 }
271 
272 static __inline void setpsr(newpsr)
273 	int newpsr;
274 {
275 	__asm __volatile("wr %0,0,%%psr" : : "r" (newpsr));
276 	__asm __volatile("nop; nop; nop");
277 }
278 
279 static __inline void spl0()
280 {
281 	int psr, oldipl;
282 
283 	/*
284 	 * wrpsr xors two values: we choose old psr and old ipl here,
285 	 * which gives us the same value as the old psr but with all
286 	 * the old PIL bits turned off.
287 	 */
288 	__asm __volatile("rd %%psr,%0" : "=r" (psr));
289 	oldipl = psr & PSR_PIL;
290 	__asm __volatile("wr %0,%1,%%psr" : : "r" (psr), "r" (oldipl));
291 
292 	/*
293 	 * Three instructions must execute before we can depend
294 	 * on the bits to be changed.
295 	 */
296 	__asm __volatile("nop; nop; nop");
297 }
298 
299 /*
300  * PIL 1 through 14 can use this macro.
301  * (spl0 and splhigh are special since they put all 0s or all 1s
302  * into the ipl field.)
303  */
304 #define	_SPLSET(name, newipl) \
305 static __inline void name __P((void)); \
306 static __inline void name() \
307 { \
308 	int psr, oldipl; \
309 	__asm __volatile("rd %%psr,%0" : "=r" (psr)); \
310 	oldipl = psr & PSR_PIL; \
311 	psr &= ~oldipl; \
312 	__asm __volatile("wr %0,%1,%%psr" : : \
313 	    "r" (psr), "n" ((newipl) << 8)); \
314 	__asm __volatile("nop; nop; nop"); \
315 }
316 
317 /* Raise IPL and return previous value */
318 #define	_SPLRAISE(name, newipl) \
319 static __inline int name __P((void)); \
320 static __inline int name() \
321 { \
322 	int psr, oldipl; \
323 	__asm __volatile("rd %%psr,%0" : "=r" (psr)); \
324 	oldipl = psr & PSR_PIL; \
325 	if ((newipl << 8) <= oldipl) \
326 		return (oldipl); \
327 	psr &= ~oldipl; \
328 	__asm __volatile("wr %0,%1,%%psr" : : \
329 	    "r" (psr), "n" ((newipl) << 8)); \
330 	__asm __volatile("nop; nop; nop"); \
331 	return (oldipl); \
332 }
333 
334 _SPLSET(spllowersoftclock, 1)
335 
336 _SPLRAISE(splsoftint, 1)
337 #define	splsoftclock	splsoftint
338 #define	splsoftnet	splsoftint
339 
340 
341 /* audio software interrupts */
342 _SPLRAISE(splausoft, IPL_SOFTAUDIO)
343 
344 /* floppy software interrupts */
345 _SPLRAISE(splfdsoft, IPL_SOFTFDC)
346 
347 /* Block devices */
348 _SPLRAISE(splbio, IPL_BIO)
349 
350 /* tty input runs at software level 6 */
351 _SPLRAISE(spltty, IPL_TTY)
352 
353 /* network hardware interrupts are at level 7 */
354 _SPLRAISE(splnet, IPL_NET)
355 
356 /*
357  * Memory allocation (must be as high as highest network, tty, or disk device)
358  */
359 _SPLRAISE(splvm, IPL_VM)
360 
361 /* clock interrupts at level 10 */
362 _SPLRAISE(splclock, IPL_CLOCK)
363 
364 _SPLRAISE(splsched, IPL_SCHED)
365 _SPLSET(spllowerschedclock, IPL_SCHED)
366 
367 /* fd hardware, ts102, and tadpole microcontoller interrupts are at level 11 */
368 _SPLRAISE(splfd, 11)
369 _SPLRAISE(splts102, 11)
370 
371 /*
372  * zs hardware interrupts are at level 12
373  * su (com) hardware interrupts are at level 13
374  * IPL_SERIAL must protect them all.
375  */
376 _SPLRAISE(splzs, 12)
377 
378 _SPLRAISE(splserial, IPL_SERIAL)
379 
380 /* audio hardware interrupts are at level 13 */
381 _SPLRAISE(splaudio, IPL_AUDIO)
382 
383 /* second sparc timer interrupts at level 14 */
384 _SPLRAISE(splstatclock, IPL_STATCLOCK)
385 
386 static __inline int splhigh()
387 {
388 	int psr, oldipl;
389 
390 	__asm __volatile("rd %%psr,%0" : "=r" (psr));
391 	__asm __volatile("wr %0,0,%%psr" : : "r" (psr | PSR_PIL));
392 	__asm __volatile("and %1,%2,%0; nop; nop" : "=r" (oldipl) : \
393 	    "r" (psr), "n" (PSR_PIL));
394 	return (oldipl);
395 }
396 
397 #define	spllock()	splhigh()
398 
399 /* splx does not have a return value */
400 static __inline void splx(newipl)
401 	int newipl;
402 {
403 	int psr;
404 
405 	__asm __volatile("rd %%psr,%0" : "=r" (psr));
406 	__asm __volatile("wr %0,%1,%%psr" : : \
407 	    "r" (psr & ~PSR_PIL), "rn" (newipl));
408 	__asm __volatile("nop; nop; nop");
409 }
410 #endif /* KERNEL && !_LOCORE */
411 
412 #endif /* PSR_IMPL */
413