xref: /openbsd-src/sys/arch/octeon/include/intr.h (revision 4b70baf6e17fc8b27fc1f7fa7929335753fa94c3)
1 /*	$OpenBSD: intr.h,v 1.20 2019/03/21 16:51:21 visa Exp $ */
2 
3 /*
4  * Copyright (c) 2001-2004 Opsycon AB  (www.opsycon.se / www.opsycon.com)
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
16  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  */
28 
29 #ifndef _MACHINE_INTR_H_
30 #define _MACHINE_INTR_H_
31 
32 /*
33  * The interrupt level ipl is a logical level; per-platform interrupt
34  * code will turn it into the appropriate hardware interrupt masks
35  * values.
36  *
37  * Interrupt sources on the CPU are kept enabled regardless of the
38  * current ipl value; individual hardware sources interrupting while
39  * logically masked are masked on the fly, remembered as pending, and
40  * unmasked at the first splx() opportunity.
41  *
42  * An exception to this rule is the clock interrupt. Clock interrupts
43  * are always allowed to happen, but will (of course!) not be serviced
44  * if logically masked.  The reason for this is that clocks usually sit on
45  * INT5 and cannot be easily masked if external hardware masking is used.
46  */
47 
48 /* Interrupt priority `levels'; not mutually exclusive. */
49 #define	IPL_NONE	0	/* nothing */
50 #define	IPL_SOFTINT	1	/* soft interrupts */
51 #define	IPL_BIO		2	/* block I/O */
52 #define IPL_AUDIO	IPL_BIO
53 #define	IPL_NET		3	/* network */
54 #define	IPL_TTY		4	/* terminal */
55 #define	IPL_VM		5	/* memory allocation */
56 #define	IPL_CLOCK	6	/* clock */
57 #define	IPL_SCHED	IPL_CLOCK
58 #define	IPL_HIGH	7	/* everything */
59 #define	IPL_IPI         8       /* interprocessor interrupt */
60 #define	NIPLS		9	/* Number of levels */
61 
62 #define IPL_MPFLOOR	IPL_TTY
63 
64 /* Interrupt priority 'flags'. */
65 #define	IPL_MPSAFE	0x100
66 
67 /* Interrupt sharing types. */
68 #define	IST_NONE	0	/* none */
69 #define	IST_PULSE	1	/* pulsed */
70 #define	IST_EDGE	2	/* edge-triggered */
71 #define	IST_LEVEL	3	/* level-triggered */
72 
73 #define	SINTBIT(q)	(q)
74 #define	SINTMASK(q)	(1 << SINTBIT(q))
75 
76 /* Soft interrupt masks. */
77 
78 #define	IPL_SOFT	0
79 #define	IPL_SOFTCLOCK	1
80 #define	IPL_SOFTNET	2
81 #define	IPL_SOFTTTY	3
82 
83 #define	SI_SOFT		0	/* for IPL_SOFT */
84 #define	SI_SOFTCLOCK	1	/* for IPL_SOFTCLOCK */
85 #define	SI_SOFTNET	2	/* for IPL_SOFTNET */
86 #define	SI_SOFTTTY	3	/* for IPL_SOFTTTY */
87 
88 #define	SI_NQUEUES	4
89 
90 #ifndef _LOCORE
91 
92 #include <sys/mutex.h>
93 #include <sys/queue.h>
94 
95 struct soft_intrhand {
96 	TAILQ_ENTRY(soft_intrhand) sih_list;
97 	void	(*sih_func)(void *);
98 	void	*sih_arg;
99 	struct soft_intrq *sih_siq;
100 	int	sih_pending;
101 };
102 
103 struct soft_intrq {
104 	TAILQ_HEAD(, soft_intrhand) siq_list;
105 	int siq_si;
106 	struct mutex siq_mtx;
107 };
108 
109 void	 softintr_disestablish(void *);
110 void	 softintr_dispatch(int);
111 void	*softintr_establish(int, void (*)(void *), void *);
112 void	 softintr_init(void);
113 void	 softintr_schedule(void *);
114 
115 #define	splsoft()	splraise(IPL_SOFTINT)
116 #define splbio()	splraise(IPL_BIO)
117 #define splnet()	splraise(IPL_NET)
118 #define spltty()	splraise(IPL_TTY)
119 #define splaudio()	splraise(IPL_AUDIO)
120 #define splvm()		splraise(IPL_VM)
121 #define splclock()	splraise(IPL_CLOCK)
122 #define splsched()	splraise(IPL_SCHED)
123 #define splhigh()	splraise(IPL_HIGH)
124 
125 #define splsoftclock()	splsoft()
126 #define splsoftnet()	splsoft()
127 #define splstatclock()	splhigh()
128 
129 #define spl0()		spllower(0)
130 
131 void	splinit(void);
132 
133 #define	splassert(X)
134 #define	splsoftassert(X)
135 
136 void	register_splx_handler(void (*)(int));
137 int	splraise(int);
138 void	splx(int);
139 int	spllower(int);
140 
141 void	intr_barrier(void *);
142 
143 /*
144  * Low level interrupt dispatcher registration data.
145  */
146 
147 /* Schedule priorities for base interrupts (CPU) */
148 #define	INTPRI_IPI	0
149 #define	INTPRI_CLOCK	1
150 /* other values are system-specific */
151 
152 #define NLOWINT	16		/* Number of low level registrations possible */
153 
154 extern uint32_t idle_mask;
155 
156 struct trapframe;
157 void	set_intr(int, uint32_t, uint32_t(*)(uint32_t, struct trapframe *));
158 
159 uint32_t updateimask(uint32_t);
160 void	dosoftint(void);
161 
162 struct intr_controller {
163 	void	  *ic_cookie;
164 	void	 (*ic_init)(void);
165 	void	*(*ic_establish)(int, int, int (*)(void *), void *,
166 		    const char *);
167 	void	*(*ic_establish_fdt_idx)(void *, int, int, int,
168 		    int (*)(void *), void *, const char *);
169 	void	 (*ic_disestablish)(void *);
170 	void	 (*ic_intr_barrier)(void *);
171 
172 #ifdef MULTIPROCESSOR
173 	int	 (*ic_ipi_establish)(int (*)(void *), cpuid_t);
174 	void	 (*ic_ipi_set)(cpuid_t);
175 	void	 (*ic_ipi_clear)(cpuid_t);
176 #endif /* MULTIPROCESSOR */
177 
178 	int	   ic_node;
179 	int	   ic_phandle;
180 	LIST_ENTRY(intr_controller) ic_list;
181 };
182 
183 #ifdef MULTIPROCESSOR
184 #define ENABLEIPI() updateimask(~CR_INT_1) /* enable IPI interrupt level */
185 #endif
186 
187 void   *octeon_intr_establish(int, int, int (*)(void *),
188 	    void *, const char *);
189 void	octeon_intr_disestablish(void *);
190 void	octeon_intr_init(void);
191 void	octeon_intr_register(struct intr_controller *);
192 
193 void	*octeon_intr_establish_fdt(int, int, int (*)(void *),
194 	    void *, const char *);
195 void	*octeon_intr_establish_fdt_idx(int, int, int, int (*)(void *),
196 	    void *, const char *);
197 void	 octeon_intr_disestablish_fdt(void *);
198 
199 #endif /* _LOCORE */
200 
201 #endif /* _MACHINE_INTR_H_ */
202