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