xref: /netbsd-src/sys/arch/hpcarm/include/intr.h (revision 461b4e59b558e9da22519f5a00c42952aab0effb)
1 /* 	$NetBSD: intr.h,v 1.22 2021/06/05 21:24:17 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 1997 Mark Brinicombe.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by Mark Brinicombe
18  *	for the NetBSD Project.
19  * 4. The name of the company nor the name of the author may be used to
20  *    endorse or promote products derived from this software without specific
21  *    prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
24  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26  * IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
29  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  */
35 
36 #ifndef _HPCARM_INTR_H_
37 #define _HPCARM_INTR_H_
38 
39 #ifdef _KERNEL
40 
41 #define IPL_NONE	0
42 #define IPL_SOFTCLOCK	1
43 #define IPL_SOFTBIO	2
44 #define IPL_SOFTNET	3
45 #define IPL_SOFTSERIAL	4
46 #define IPL_VM		5
47 #define IPL_SCHED	6
48 #define IPL_HIGH	7
49 
50 #define NIPL		8
51 
52 #define	IST_UNUSABLE	-1	/* interrupt cannot be used */
53 #define	IST_NONE	0	/* none (dummy) */
54 #define	IST_PULSE	1	/* pulsed */
55 #define	IST_EDGE	2	/* edge-triggered */
56 #define	IST_LEVEL	3	/* level-triggered */
57 
58 #define	IST_LEVEL_LOW	IST_LEVEL
59 #define	IST_LEVEL_HIGH	4
60 #define	IST_EDGE_FALLING IST_EDGE
61 #define	IST_EDGE_RISING	5
62 #define	IST_EDGE_BOTH	6
63 
64 #ifdef __OLD_INTERRUPT_CODE	/* XXX XXX XXX */
65 
66 #include <machine/irqhandler.h>
67 #include <arm/arm32/psl.h>
68 
69 #else	/* !__OLD_INTERRUPT_CODE */
70 
71 #ifndef _LOCORE
72 
73 #include <sys/queue.h>
74 
75 #if defined(_MODULE)
76 
77 int	_splraise(int);
78 int	_spllower(int);
79 void	splx(int);
80 
81 #else	/* _MODULE */
82 
83 #include "opt_arm_intr_impl.h"
84 
85 #if defined(ARM_INTR_IMPL)
86 
87 /*
88  * Each board needs to define the following functions:
89  *
90  * int	_splraise(int);
91  * int	_spllower(int);
92  * void	splx(int);
93  * void	_setsoftintr(int);
94  *
95  * These may be defined as functions, static inline functions, or macros,
96  * but there must be a _spllower() and splx() defined as functions callable
97  * from assembly language (for cpu_switch()).  However, since it's quite
98  * useful to be able to inline splx(), you could do something like the
99  * following:
100  *
101  * in <boardtype>_intr.h:
102  * 	static inline int
103  *	boardtype_splx(int spl)
104  *	{...}
105  *
106  *	#define splx(nspl)	boardtype_splx(nspl)
107  *	...
108  * and in boardtype's machdep code:
109  *
110  *	...
111  *	#undef splx
112  *	int
113  *	splx(int spl)
114  *	{
115  *		return boardtype_splx(spl);
116  *	}
117  */
118 
119 #include ARM_INTR_IMPL
120 
121 #else	/* ARM_INTR_IMPL */
122 
123 #error ARM_INTR_IMPL not defined.
124 
125 #endif	/* ARM_INTR_IMPL */
126 
127 #endif /* _MODULE */
128 
129 typedef uint8_t ipl_t;
130 typedef struct {
131 	ipl_t _ipl;
132 } ipl_cookie_t;
133 
134 static inline ipl_cookie_t
makeiplcookie(ipl_t ipl)135 makeiplcookie(ipl_t ipl)
136 {
137 
138 	return (ipl_cookie_t){._ipl = ipl};
139 }
140 
141 static inline int
splraiseipl(ipl_cookie_t icookie)142 splraiseipl(ipl_cookie_t icookie)
143 {
144 
145 	return _splraise(icookie._ipl);
146 }
147 
148 #define	spl0()		_spllower(IPL_NONE)
149 
150 #include <sys/spl.h>
151 
152 #endif	/* ! _LOCORE */
153 
154 #endif	/* __OLD_INTERRUPT_CODE */
155 
156 #endif	/* _KERNEL */
157 
158 #endif	/* _HPCARM_INTR_H */
159