xref: /netbsd-src/sys/arch/arm/pic/picvar.h (revision f17b710f3d406bee67aa39c65053114ab78297c5)
1 /*	$NetBSD: picvar.h,v 1.16 2015/07/07 21:43:46 matt 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 int	_splraise(int);
42 int	_spllower(int);
43 void	splx(int);
44 const char *
45 	intr_typename(int);
46 
47 struct pic_softc;
48 struct intrsource;
49 struct cpu_info;
50 
51 #define	IPI_AST			0	/* just get an interrupt */
52 #define	IPI_XCALL		1	/* xcall */
53 #define	IPI_NOP			2	/* just get an interrupt (armv6) */
54 #define	IPI_SHOOTDOWN		3	/* cause a tlb shootdown */
55 #define	IPI_DDB			4	/* enter DDB */
56 #define	IPI_GENERIC		5	/* generic IPI */
57 #ifdef __HAVE_PREEMPTION
58 #define	IPI_KPREEMPT		6	/* cause a preemption */
59 #define	NIPI			7
60 #else
61 #define	NIPI			6
62 #endif
63 
64 #if !defined(__HAVE_PIC_SET_PRIORITY)
65 #define __HAVE_PIC_PENDING_INTRS
66 #endif
67 
68 int	pic_handle_intr(void *);
69 #if defined(__HAVE_PIC_PENDING_INTRS)
70 void	pic_mark_pending(struct pic_softc *pic, int irq);
71 void	pic_mark_pending_source(struct pic_softc *pic, struct intrsource *is);
72 uint32_t pic_mark_pending_sources(struct pic_softc *pic, size_t irq_base,
73 	    uint32_t pending);
74 #endif /* __HAVE_PIC_PENDING_INTRS */
75 void	*pic_establish_intr(struct pic_softc *pic, int irq, int ipl, int type,
76 	    int (*func)(void *), void *arg);
77 int	pic_alloc_irq(struct pic_softc *pic);
78 void	pic_disestablish_source(struct intrsource *is);
79 void	pic_do_pending_ints(register_t psw, int newipl, void *frame);
80 void	pic_dispatch(struct intrsource *is, void *frame);
81 
82 void	*intr_establish(int irq, int ipl, int type, int (*func)(void *),
83 	    void *arg);
84 void	intr_disestablish(void *);
85 #ifdef MULTIPROCESSOR
86 void	intr_cpu_init(struct cpu_info *);
87 void	intr_ipi_send(const kcpuset_t *, u_long ipi);
88 #endif
89 
90 #ifdef _INTR_PRIVATE
91 
92 #include "opt_arm_intr_impl.h"
93 
94 #include <sys/evcnt.h>
95 #include <sys/percpu.h>
96 
97 #ifndef PIC_MAXPICS
98 #define PIC_MAXPICS	32
99 #endif
100 #ifndef PIC_MAXSOURCES
101 #define	PIC_MAXSOURCES	64
102 #endif
103 #ifndef PIC_MAXMAXSOURCES
104 #define	PIC_MAXMAXSOURCES	128
105 #endif
106 
107 struct intrsource {
108 	int (*is_func)(void *);
109 	void *is_arg;
110 	struct pic_softc *is_pic;		/* owning PIC */
111 	uint8_t is_type;			/* IST_xxx */
112 	uint8_t is_ipl;				/* IPL_xxx */
113 	uint8_t is_irq;				/* local to pic */
114 	uint8_t is_iplidx;
115 	bool is_mpsafe;
116 	char is_source[16];
117 };
118 
119 struct pic_percpu {
120 	struct evcnt *pcpu_evs;
121 	char *pcpu_name;
122 	uint32_t pcpu_magic;
123 };
124 
125 #define	PICPERCPU_MAGIC		0xfeedface
126 
127 struct pic_softc {
128 	const struct pic_ops *pic_ops;
129 	struct intrsource **pic_sources;
130 #ifdef __HAVE_PIC_PENDING_INTRS
131 	volatile uint32_t pic_pending_irqs[(PIC_MAXSOURCES + 31) / 32];
132 	volatile uint32_t pic_blocked_irqs[(PIC_MAXSOURCES + 31) / 32];
133 	volatile uint32_t pic_pending_ipls;
134 #endif
135 #ifdef MULTIPROCESSOR
136 	kcpuset_t *pic_cpus;
137 #endif
138 	size_t pic_maxsources;
139 	percpu_t *pic_percpu;
140 	uint8_t pic_id;
141 	int16_t pic_irqbase;
142 	char pic_name[14];
143 };
144 
145 struct pic_ops {
146 	void (*pic_unblock_irqs)(struct pic_softc *, size_t, uint32_t);
147 	void (*pic_block_irqs)(struct pic_softc *, size_t, uint32_t);
148 	int (*pic_find_pending_irqs)(struct pic_softc *);
149 
150 	void (*pic_establish_irq)(struct pic_softc *, struct intrsource *);
151 	void (*pic_source_name)(struct pic_softc *, int, char *, size_t);
152 
153 #ifdef __HAVE_PIC_SET_PRIORITY
154 	void (*pic_set_priority)(struct pic_softc *, int);
155 #endif
156 #ifdef MULTIPROCESSOR
157 	void (*pic_cpu_init)(struct pic_softc *, struct cpu_info *);
158 	void (*pic_ipi_send)(struct pic_softc *, const kcpuset_t *, u_long);
159 #endif
160 };
161 
162 #ifdef __HAVE_PIC_SET_PRIORITY
163 /*
164  * This is used to update a hardware pic with a value corresponding
165  * to the ipl being set.
166  */
167 struct cpu_info;
168 void	pic_set_priority(struct cpu_info *, int);
169 #else
170 /* Using an inline causes catch-22 problems with cpu.h */
171 #define	pic_set_priority(ci, newipl)	((void)((ci)->ci_cpl = (newipl)))
172 #endif
173 
174 void	pic_add(struct pic_softc *, int);
175 void	pic_do_pending_int(void);
176 #ifdef MULTIPROCESSOR
177 int	pic_ipi_ast(void *);
178 int	pic_ipi_nop(void *);
179 int	pic_ipi_xcall(void *);
180 int	pic_ipi_generic(void *);
181 int	pic_ipi_shootdown(void *);
182 int	pic_ipi_ddb(void *);
183 int	pic_ipi_kpreempt(void *);
184 #endif
185 #ifdef __HAVE_PIC_FAST_SOFTINTS
186 int	pic_handle_softint(void *);
187 #endif
188 
189 extern struct pic_softc * pic_list[PIC_MAXPICS];
190 #endif /* _INTR_PRIVATE */
191 
192 #endif /* _ARM_PIC_PICVAR_H_ */
193