xref: /netbsd-src/sys/arch/alpha/include/intr.h (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /* $NetBSD: intr.h,v 1.62 2007/12/03 15:33:04 ad Exp $ */
2 
3 /*-
4  * Copyright (c) 2000, 2001, 2002 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the NetBSD
21  *	Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * Copyright (c) 1997 Christopher G. Demetriou.  All rights reserved.
41  * Copyright (c) 1996 Carnegie-Mellon University.
42  * All rights reserved.
43  *
44  * Author: Chris G. Demetriou
45  *
46  * Permission to use, copy, modify and distribute this software and
47  * its documentation is hereby granted, provided that both the copyright
48  * notice and this permission notice appear in all copies of the
49  * software, derivative works or modified versions, and any portions
50  * thereof, and that both notices appear in supporting documentation.
51  *
52  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
53  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
54  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
55  *
56  * Carnegie Mellon requests users of this software to return to
57  *
58  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
59  *  School of Computer Science
60  *  Carnegie Mellon University
61  *  Pittsburgh PA 15213-3890
62  *
63  * any improvements or extensions that they make and grant Carnegie the
64  * rights to redistribute these changes.
65  */
66 
67 #ifndef _ALPHA_INTR_H_
68 #define _ALPHA_INTR_H_
69 
70 #include <sys/device.h>
71 #include <sys/simplelock.h>
72 #include <sys/queue.h>
73 
74 #include <machine/atomic.h>
75 
76 /*
77  * The Alpha System Control Block.  This is 8k long, and you get
78  * 16 bytes per vector (i.e. the vector numbers are spaced 16
79  * apart).
80  *
81  * This is sort of a "shadow" SCB -- rather than the CPU jumping
82  * to (SCBaddr + (16 * vector)), like it does on the VAX, we get
83  * a vector number in a1.  We use the SCB to look up a routine/arg
84  * and jump to it.
85  *
86  * Since we use the SCB only for I/O interrupts, we make it shorter
87  * than normal, starting it at vector 0x800 (the start of the I/O
88  * interrupt vectors).
89  */
90 #define	SCB_IOVECBASE	0x0800
91 #define	SCB_VECSIZE	0x0010
92 #define	SCB_SIZE	0x2000
93 
94 #define	SCB_VECTOIDX(x)	((x) >> 4)
95 #define	SCB_IDXTOVEC(x)	((x) << 4)
96 
97 #define	SCB_NIOVECS	SCB_VECTOIDX(SCB_SIZE - SCB_IOVECBASE)
98 
99 struct scbvec {
100 	void	(*scb_func)(void *, u_long);
101 	void	*scb_arg;
102 };
103 
104 /*
105  * Alpha interrupts come in at one of 4 levels:
106  *
107  *	software interrupt level
108  *	i/o level 1
109  *	i/o level 2
110  *	clock level
111  *
112  * However, since we do not have any way to know which hardware
113  * level a particular i/o interrupt comes in on, we have to
114  * whittle it down to 3.
115  */
116 
117 #define	IPL_NONE	0	/* no interrupt level */
118 #define	IPL_SOFTCLOCK	1	/* generic software interrupts */
119 #define	IPL_SOFTBIO	1	/* generic software interrupts */
120 #define	IPL_SOFTNET	1	/* generic software interrupts */
121 #define	IPL_SOFTSERIAL	1	/* generic software interrupts */
122 #define	IPL_VM		2	/* interrupts that can alloc mem */
123 #define	IPL_SCHED	3	/* clock interrupts */
124 #define	IPL_HIGH	4	/* all interrupts */
125 
126 typedef int ipl_t;
127 typedef struct {
128 	uint8_t _psl;
129 } ipl_cookie_t;
130 
131 ipl_cookie_t makeiplcookie(ipl_t);
132 
133 #define	IST_UNUSABLE	-1	/* interrupt cannot be used */
134 #define	IST_NONE	0	/* none (dummy) */
135 #define	IST_PULSE	1	/* pulsed */
136 #define	IST_EDGE	2	/* edge-triggered */
137 #define	IST_LEVEL	3	/* level-triggered */
138 
139 #ifdef	_KERNEL
140 
141 /* Simulated software interrupt register. */
142 extern volatile unsigned long ssir;
143 
144 /* IPL-lowering/restoring macros */
145 void	spl0(void);
146 
147 static __inline void
148 splx(int s)
149 {
150 	if (s == ALPHA_PSL_IPL_0 && ssir != 0)
151 		spl0();
152 	else
153 		alpha_pal_swpipl(s);
154 }
155 /* IPL-raising functions/macros */
156 static __inline int
157 _splraise(int s)
158 {
159 	int cur = alpha_pal_rdps() & ALPHA_PSL_IPL_MASK;
160 	return (s > cur ? alpha_pal_swpipl(s) : cur);
161 }
162 
163 #define	splraiseipl(icookie)	_splraise((icookie)._psl)
164 
165 #include <sys/spl.h>
166 
167 /*
168  * Interprocessor interrupts.  In order how we want them processed.
169  */
170 #define	ALPHA_IPI_HALT			(1UL << 0)
171 #define	ALPHA_IPI_MICROSET		(1UL << 1)
172 #define	ALPHA_IPI_SHOOTDOWN		(1UL << 2)
173 #define	ALPHA_IPI_IMB			(1UL << 3)
174 #define	ALPHA_IPI_AST			(1UL << 4)
175 #define	ALPHA_IPI_SYNCH_FPU		(1UL << 5)
176 #define	ALPHA_IPI_DISCARD_FPU		(1UL << 6)
177 #define	ALPHA_IPI_PAUSE			(1UL << 7)
178 #define	ALPHA_IPI_PMAP_REACTIVATE	(1UL << 8)
179 
180 #define	ALPHA_NIPIS		9	/* must not exceed 64 */
181 
182 struct cpu_info;
183 struct trapframe;
184 
185 void	alpha_ipi_init(struct cpu_info *);
186 void	alpha_ipi_process(struct cpu_info *, struct trapframe *);
187 void	alpha_send_ipi(unsigned long, unsigned long);
188 void	alpha_broadcast_ipi(unsigned long);
189 void	alpha_multicast_ipi(unsigned long, unsigned long);
190 
191 /*
192  * Alpha shared-interrupt-line common code.
193  */
194 
195 struct alpha_shared_intrhand {
196 	TAILQ_ENTRY(alpha_shared_intrhand)
197 		ih_q;
198 	struct alpha_shared_intr *ih_intrhead;
199 	int	(*ih_fn)(void *);
200 	void	*ih_arg;
201 	int	ih_level;
202 	unsigned int ih_num;
203 };
204 
205 struct alpha_shared_intr {
206 	TAILQ_HEAD(,alpha_shared_intrhand)
207 		intr_q;
208 	struct evcnt intr_evcnt;
209 	char	*intr_string;
210 	void	*intr_private;
211 	int	intr_sharetype;
212 	int	intr_dfltsharetype;
213 	int	intr_nstrays;
214 	int	intr_maxstrays;
215 };
216 
217 #define	ALPHA_SHARED_INTR_DISABLE(asi, num)				\
218 	((asi)[num].intr_maxstrays != 0 &&				\
219 	 (asi)[num].intr_nstrays == (asi)[num].intr_maxstrays)
220 
221 void	softintr_dispatch(void);
222 
223 struct alpha_shared_intr *alpha_shared_intr_alloc(unsigned int, unsigned int);
224 int	alpha_shared_intr_dispatch(struct alpha_shared_intr *,
225 	    unsigned int);
226 void	*alpha_shared_intr_establish(struct alpha_shared_intr *,
227 	    unsigned int, int, int, int (*)(void *), void *, const char *);
228 void	alpha_shared_intr_disestablish(struct alpha_shared_intr *,
229 	    void *, const char *);
230 int	alpha_shared_intr_get_sharetype(struct alpha_shared_intr *,
231 	    unsigned int);
232 int	alpha_shared_intr_isactive(struct alpha_shared_intr *,
233 	    unsigned int);
234 int	alpha_shared_intr_firstactive(struct alpha_shared_intr *,
235 	    unsigned int);
236 void	alpha_shared_intr_set_dfltsharetype(struct alpha_shared_intr *,
237 	    unsigned int, int);
238 void	alpha_shared_intr_set_maxstrays(struct alpha_shared_intr *,
239 	    unsigned int, int);
240 void	alpha_shared_intr_reset_strays(struct alpha_shared_intr *,
241 	    unsigned int);
242 void	alpha_shared_intr_stray(struct alpha_shared_intr *, unsigned int,
243 	    const char *);
244 void	alpha_shared_intr_set_private(struct alpha_shared_intr *,
245 	    unsigned int, void *);
246 void	*alpha_shared_intr_get_private(struct alpha_shared_intr *,
247 	    unsigned int);
248 char	*alpha_shared_intr_string(struct alpha_shared_intr *,
249 	    unsigned int);
250 struct evcnt *alpha_shared_intr_evcnt(struct alpha_shared_intr *,
251 	    unsigned int);
252 
253 extern struct scbvec scb_iovectab[];
254 
255 void	scb_init(void);
256 void	scb_set(u_long, void (*)(void *, u_long), void *, int);
257 u_long	scb_alloc(void (*)(void *, u_long), void *);
258 void	scb_free(u_long);
259 
260 #define	SCB_ALLOC_FAILED	((u_long) -1)
261 
262 #endif /* _KERNEL */
263 #endif /* ! _ALPHA_INTR_H_ */
264