intr.h revision 296138 
1/* 	$NetBSD: intr.h,v 1.7 2003/06/16 20:01:00 thorpej Exp $	*/
2
3/*-
4 * Copyright (c) 1997 Mark Brinicombe.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 *    must display the following acknowledgement:
17 *	This product includes software developed by Mark Brinicombe
18 *	for the NetBSD Project.
19 * 4. The name of the company nor the name of the author may be used to
20 *    endorse or promote products derived from this software without specific
21 *    prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
29 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * $FreeBSD: head/sys/sys/intr.h 296138 2016-02-27 12:03:07Z skra $
36 *
37 */
38
39#ifndef _SYS_INTR_H_
40#define _SYS_INTR_H_
41
42#include <sys/systm.h>
43
44#ifdef notyet
45#define	INTR_SOLO	INTR_MD1
46typedef int intr_irq_filter_t(void *arg, struct trapframe *tf);
47#else
48typedef int intr_irq_filter_t(void *arg);
49#endif
50
51#define INTR_ISRC_NAMELEN	(MAXCOMLEN + 1)
52
53typedef void intr_ipi_filter_t(void *arg);
54
55enum intr_isrc_type {
56	INTR_ISRCT_NAMESPACE,
57	INTR_ISRCT_FDT
58};
59
60#define INTR_ISRCF_REGISTERED	0x01	/* registered in a controller */
61#define INTR_ISRCF_PERCPU	0x02	/* per CPU interrupt */
62#define INTR_ISRCF_BOUND	0x04	/* bound to a CPU */
63
64/* Interrupt source definition. */
65struct intr_irqsrc {
66	device_t		isrc_dev;	/* where isrc is mapped */
67	intptr_t		isrc_xref;	/* device reference key */
68	uintptr_t		isrc_data;	/* device data for isrc */
69	u_int			isrc_irq;	/* unique identificator */
70	enum intr_isrc_type	isrc_type;	/* how is isrc decribed */
71	u_int			isrc_flags;
72	char			isrc_name[INTR_ISRC_NAMELEN];
73	uint16_t		isrc_nspc_type;
74	uint16_t		isrc_nspc_num;
75	enum intr_trigger	isrc_trig;
76	enum intr_polarity	isrc_pol;
77	cpuset_t		isrc_cpu;	/* on which CPUs is enabled */
78	u_int			isrc_index;
79	u_long *		isrc_count;
80	u_int			isrc_handlers;
81	struct intr_event *	isrc_event;
82	intr_irq_filter_t *	isrc_filter;
83	intr_ipi_filter_t *	isrc_ipifilter;
84	void *			isrc_arg;
85#ifdef FDT
86	u_int			isrc_ncells;
87	pcell_t			isrc_cells[];	/* leave it last */
88#endif
89};
90
91void intr_irq_set_name(struct intr_irqsrc *isrc, const char *fmt, ...)
92    __printflike(2, 3);
93
94void intr_irq_dispatch(struct intr_irqsrc *isrc, struct trapframe *tf);
95
96#define INTR_IRQ_NSPC_NONE	0
97#define INTR_IRQ_NSPC_PLAIN	1
98#define INTR_IRQ_NSPC_IRQ	2
99#define INTR_IRQ_NSPC_IPI	3
100
101u_int intr_namespace_map_irq(device_t dev, uint16_t type, uint16_t num);
102#ifdef FDT
103u_int intr_fdt_map_irq(phandle_t, pcell_t *, u_int);
104#endif
105
106extern device_t intr_irq_root_dev;
107
108int intr_pic_register(device_t dev, intptr_t xref);
109int intr_pic_unregister(device_t dev, intptr_t xref);
110int intr_pic_claim_root(device_t dev, intptr_t xref, intr_irq_filter_t *filter,
111    void *arg, u_int ipicount);
112
113int intr_irq_add_handler(device_t dev, driver_filter_t, driver_intr_t, void *,
114    u_int, int, void **);
115int intr_irq_remove_handler(device_t dev, u_int, void *);
116int intr_irq_config(u_int, enum intr_trigger, enum intr_polarity);
117int intr_irq_describe(u_int, void *, const char *);
118
119u_int intr_irq_next_cpu(u_int current_cpu, cpuset_t *cpumask);
120
121#ifdef SMP
122int intr_irq_bind(u_int, int);
123
124void intr_pic_init_secondary(void);
125
126/* Virtualization for interrupt source IPI counter increment. */
127static inline void
128intr_ipi_increment_count(u_long *counter, u_int cpu)
129{
130
131	KASSERT(cpu < MAXCPU, ("%s: too big cpu %u", __func__, cpu));
132	counter[cpu]++;
133}
134
135/* Virtualization for interrupt source IPI counters setup. */
136u_long * intr_ipi_setup_counters(const char *name);
137
138#endif
139#endif	/* _SYS_INTR_H */
140