xref: /openbsd-src/sys/arch/arm/include/softintr.h (revision dacd911afd79bb107e64e769fd9f403208f9a3bc)
1 /*	$OpenBSD: softintr.h,v 1.6 2020/08/14 16:51:09 kettenis Exp $	*/
2 /*	$NetBSD: softintr.h,v 1.1 2002/01/29 22:54:14 thorpej Exp $	*/
3 
4 /*
5  * Copyright (c) 2001 Wasabi Systems, Inc.
6  * All rights reserved.
7  *
8  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
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 for the NetBSD Project by
21  *	Wasabi Systems, Inc.
22  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
23  *    or promote products derived from this software without specific prior
24  *    written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
27  * 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 WASABI SYSTEMS, INC
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 #ifndef	_ARM_SOFTINTR_H_
40 #define	_ARM_SOFTINTR_H_
41 
42 #ifdef _KERNEL
43 
44 #include <sys/mutex.h>
45 
46 /*
47  * Generic software interrupt support.
48  *
49  * To use this code, include <arm/softintr.h> from your platform's
50  * <machine/intr.h>.
51  */
52 
53 #define	SI_SOFT			0	/* for IPL_SOFT */
54 #define	SI_SOFTCLOCK		1	/* for IPL_SOFTCLOCK */
55 #define	SI_SOFTNET		2	/* for IPL_SOFTNET */
56 #define	SI_SOFTTTY		3	/* for IPL_SOFTTTY */
57 
58 #define	SI_NQUEUES		4
59 
60 struct soft_intrhand {
61 	TAILQ_ENTRY(soft_intrhand) sih_list;
62 	void (*sih_func)(void *);
63 	void *sih_arg;
64 	struct soft_intrq *sih_siq;
65 	int sih_pending;
66 };
67 
68 struct soft_intrq {
69 	TAILQ_HEAD(, soft_intrhand)
70 			siq_list;
71 	int		siq_si;
72 	struct mutex	siq_mtx;
73 };
74 
75 void	*softintr_establish(int, void (*)(void *), void *);
76 void	softintr_disestablish(void *);
77 void	softintr_init(void);
78 void	softintr_dispatch(int);
79 
80 #define	softintr_schedule(arg)						\
81 do {									\
82 	struct soft_intrhand *__sih = (arg);				\
83 	struct soft_intrq *__siq = __sih->sih_siq;			\
84 									\
85 	mtx_enter(&__siq->siq_mtx);					\
86 	if (__sih->sih_pending == 0) {					\
87 		TAILQ_INSERT_TAIL(&__siq->siq_list, __sih, sih_list);	\
88 		__sih->sih_pending = 1;					\
89 		_setsoftintr(__siq->siq_si);				\
90 	}								\
91 	mtx_leave(&__siq->siq_mtx);					\
92 } while (/*CONSTCOND*/0)
93 
94 #endif /* _KERNEL */
95 
96 #endif	/* _ARM_SOFTINTR_H_ */
97