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