xref: /netbsd-src/sys/arch/arm/pic/picvar.h (revision a8c74629f602faa0ccf8a463757d7baf858bbf3a)
1 /*	$NetBSD: picvar.h,v 1.26 2019/12/24 20:40:09 skrll Exp $	*/
2 /*-
3  * Copyright (c) 2008 The NetBSD Foundation, Inc.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to The NetBSD Foundation
7  * by Matt Thomas.
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  *
18  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 #ifndef _ARM_PIC_PICVAR_H_
31 #define _ARM_PIC_PICVAR_H_
32 
33 #ifdef _KERNEL_OPT
34 #include "opt_multiprocessor.h"
35 #endif
36 
37 #ifdef MULTIPROCESSOR
38 #include <sys/kcpuset.h>
39 #endif
40 
41 typedef uint32_t	intr_handle_t;		/* for ACPI */
42 
43 int	_splraise(int);
44 int	_spllower(int);
45 void	splx(int);
46 const char *
47 	intr_typename(int);
48 
49 struct pic_softc;
50 struct intrsource;
51 struct cpu_info;
52 
53 #define	IPI_AST			0	/* just get an interrupt */
54 #define	IPI_XCALL		1	/* xcall */
55 #define	IPI_NOP			2	/* just get an interrupt (armv6) */
56 #define	IPI_SHOOTDOWN		3	/* cause a tlb shootdown */
57 #define	IPI_DDB			4	/* enter DDB */
58 #define	IPI_GENERIC		5	/* generic IPI */
59 #ifdef __HAVE_PREEMPTION
60 #define	IPI_KPREEMPT		6	/* cause a preemption */
61 #define	NIPI			7
62 #else
63 #define	NIPI			6
64 #endif
65 
66 #if !defined(__HAVE_PIC_SET_PRIORITY)
67 #define __HAVE_PIC_PENDING_INTRS
68 #endif
69 
70 int	pic_handle_intr(void *);
71 #if defined(__HAVE_PIC_PENDING_INTRS)
72 void	pic_mark_pending(struct pic_softc *pic, int irq);
73 void	pic_mark_pending_source(struct pic_softc *pic, struct intrsource *is);
74 uint32_t pic_mark_pending_sources(struct pic_softc *pic, size_t irq_base,
75 	    uint32_t pending);
76 #endif /* __HAVE_PIC_PENDING_INTRS */
77 void	*pic_establish_intr(struct pic_softc *pic, int irq, int ipl, int type,
78 	    int (*func)(void *), void *arg, const char *);
79 int	pic_alloc_irq(struct pic_softc *pic);
80 void	pic_disestablish_source(struct intrsource *is);
81 #ifdef MULTIPROCESSOR
82 void	pic_distribute_source(struct intrsource *is, const kcpuset_t *,
83 	    kcpuset_t *);
84 #endif
85 void	pic_do_pending_ints(register_t psw, int newipl, void *frame);
86 void	pic_dispatch(struct intrsource *is, void *frame);
87 
88 void	*intr_establish(int irq, int ipl, int type, int (*func)(void *),
89 	    void *arg);
90 void	*intr_establish_xname(int irq, int ipl, int type, int (*func)(void *),
91 	    void *arg, const char *xname);
92 void	intr_disestablish(void *);
93 void	intr_mask(void *);
94 void	intr_unmask(void *);
95 const char *intr_string(intr_handle_t, char *, size_t);
96 #ifdef MULTIPROCESSOR
97 void	intr_cpu_init(struct cpu_info *);
98 void	intr_ipi_send(const kcpuset_t *, u_long ipi);
99 #endif
100 
101 #ifdef _INTR_PRIVATE
102 
103 #include "opt_arm_intr_impl.h"
104 
105 #include <sys/evcnt.h>
106 #include <sys/percpu.h>
107 
108 #ifndef PIC_MAXPICS
109 #define PIC_MAXPICS	32
110 #endif
111 #ifndef PIC_MAXSOURCES
112 #define	PIC_MAXSOURCES	64
113 #endif
114 #ifndef PIC_MAXMAXSOURCES
115 #define	PIC_MAXMAXSOURCES	128
116 #endif
117 
118 struct intrsource {
119 	int (*is_func)(void *);
120 	void *is_arg;
121 	struct pic_softc *is_pic;		/* owning PIC */
122 	uint8_t is_type;			/* IST_xxx */
123 	uint8_t is_ipl;				/* IPL_xxx */
124 	uint32_t is_irq;			/* local to pic */
125 	uint8_t is_iplidx;
126 	bool is_mpsafe;
127 	char is_source[16];
128 	char *is_xname;
129 	uint32_t is_mask_count;
130 };
131 
132 struct pic_percpu {
133 	struct evcnt *pcpu_evs;
134 	char *pcpu_name;
135 	uint32_t pcpu_magic;
136 };
137 
138 #define	PICPERCPU_MAGIC		0xfeedface
139 
140 struct pic_softc {
141 	const struct pic_ops *pic_ops;
142 	struct intrsource **pic_sources;
143 #ifdef __HAVE_PIC_PENDING_INTRS
144 	volatile uint32_t pic_pending_irqs[(PIC_MAXSOURCES + 31) / 32];
145 	volatile uint32_t pic_blocked_irqs[(PIC_MAXSOURCES + 31) / 32];
146 	volatile uint32_t pic_pending_ipls;
147 #endif
148 #ifdef MULTIPROCESSOR
149 	kcpuset_t *pic_cpus;
150 #endif
151 	size_t pic_maxsources;
152 	percpu_t *pic_percpu;
153 	uint8_t pic_id;
154 	int pic_irqbase;
155 	char pic_name[16];
156 };
157 
158 struct pic_ops {
159 	void (*pic_unblock_irqs)(struct pic_softc *, size_t, uint32_t);
160 	void (*pic_block_irqs)(struct pic_softc *, size_t, uint32_t);
161 	int (*pic_find_pending_irqs)(struct pic_softc *);
162 
163 	void (*pic_establish_irq)(struct pic_softc *, struct intrsource *);
164 	void (*pic_source_name)(struct pic_softc *, int, char *, size_t);
165 
166 #ifdef __HAVE_PIC_SET_PRIORITY
167 	void (*pic_set_priority)(struct pic_softc *, int);
168 #endif
169 #ifdef MULTIPROCESSOR
170 	void (*pic_cpu_init)(struct pic_softc *, struct cpu_info *);
171 	void (*pic_ipi_send)(struct pic_softc *, const kcpuset_t *, u_long);
172 	int (*pic_set_affinity)(struct pic_softc *, size_t, const kcpuset_t *);
173 	void (*pic_get_affinity)(struct pic_softc *, size_t, kcpuset_t *);
174 #endif
175 };
176 
177 #ifdef __HAVE_PIC_SET_PRIORITY
178 /*
179  * This is used to update a hardware pic with a value corresponding
180  * to the ipl being set.
181  */
182 struct cpu_info;
183 void	pic_set_priority(struct cpu_info *, int);
184 #else
185 /* Using an inline causes catch-22 problems with cpu.h */
186 #define	pic_set_priority(ci, newipl)	((void)((ci)->ci_cpl = (newipl)))
187 #endif
188 
189 #define	PIC_IRQBASE_ALLOC	(-2)
190 
191 int	pic_add(struct pic_softc *, int);
192 void	pic_do_pending_int(void);
193 #ifdef MULTIPROCESSOR
194 int	pic_ipi_ast(void *);
195 int	pic_ipi_nop(void *);
196 int	pic_ipi_xcall(void *);
197 int	pic_ipi_generic(void *);
198 int	pic_ipi_shootdown(void *);
199 int	pic_ipi_ddb(void *);
200 int	pic_ipi_kpreempt(void *);
201 #endif
202 #ifdef __HAVE_PIC_FAST_SOFTINTS
203 int	pic_handle_softint(void *);
204 #endif
205 
206 extern struct pic_softc * pic_list[PIC_MAXPICS];
207 #endif /* _INTR_PRIVATE */
208 
209 #endif /* _ARM_PIC_PICVAR_H_ */
210