master
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2015-2016 Svatopluk Kraus
5 * Copyright (c) 2015-2016 Michal Meloun
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#ifndef _SYS_INTR_H_
31#define _SYS_INTR_H_
32#ifndef INTRNG
33#error Need INTRNG for this file
34#endif
35
36#include <sys/systm.h>
37
38#define INTR_IRQ_INVALID 0xFFFFFFFF
39
40enum intr_map_data_type {
41 INTR_MAP_DATA_ACPI = 0,
42 INTR_MAP_DATA_FDT,
43 INTR_MAP_DATA_GPIO,
44 INTR_MAP_DATA_MSI,
45
46 /* Placeholders for platform specific types */
47 INTR_MAP_DATA_PLAT_1 = 1000,
48 INTR_MAP_DATA_PLAT_2,
49 INTR_MAP_DATA_PLAT_3,
50 INTR_MAP_DATA_PLAT_4,
51 INTR_MAP_DATA_PLAT_5,
52};
53
54struct intr_map_data {
55 size_t len;
56 enum intr_map_data_type type;
57};
58
59struct intr_map_data_msi {
60 struct intr_map_data hdr;
61 struct intr_irqsrc *isrc;
62};
63
64#ifdef notyet
65#define INTR_SOLO INTR_MD1
66typedef int intr_irq_filter_t(void *arg, struct trapframe *tf);
67#else
68typedef int intr_irq_filter_t(void *arg);
69#endif
70typedef int intr_child_irq_filter_t(void *arg, uintptr_t irq);
71
72#define INTR_ISRC_NAMELEN (MAXCOMLEN + 1)
73
74#define INTR_ISRCF_IPI 0x01 /* IPI interrupt */
75#define INTR_ISRCF_PPI 0x02 /* PPI interrupt */
76#define INTR_ISRCF_BOUND 0x04 /* bound to a CPU */
77
78struct intr_pic;
79
80/* Interrupt source definition. */
81struct intr_irqsrc {
82 device_t isrc_dev; /* where isrc is mapped */
83 u_int isrc_irq; /* unique identificator */
84 u_int isrc_flags;
85 char isrc_name[INTR_ISRC_NAMELEN];
86 cpuset_t isrc_cpu; /* on which CPUs is enabled */
87 u_int isrc_index;
88 u_long * isrc_count;
89 u_int isrc_handlers;
90 struct intr_event * isrc_event;
91#ifdef INTR_SOLO
92 intr_irq_filter_t * isrc_filter;
93 void * isrc_arg;
94#endif
95 /* Used by MSI interrupts to store the iommu details */
96 void * isrc_iommu;
97};
98
99/* Intr interface for PIC. */
100int intr_isrc_deregister(struct intr_irqsrc *);
101int intr_isrc_register(struct intr_irqsrc *, device_t, u_int, const char *, ...)
102 __printflike(4, 5);
103
104#ifdef SMP
105bool intr_isrc_init_on_cpu(struct intr_irqsrc *isrc, u_int cpu);
106#endif
107
108int intr_isrc_dispatch(struct intr_irqsrc *, struct trapframe *);
109u_int intr_irq_next_cpu(u_int current_cpu, cpuset_t *cpumask);
110
111struct intr_pic *intr_pic_register(device_t, intptr_t);
112int intr_pic_deregister(device_t, intptr_t);
113int intr_pic_claim_root(device_t, intptr_t, intr_irq_filter_t *, void *);
114int intr_pic_add_handler(device_t, struct intr_pic *,
115 intr_child_irq_filter_t *, void *, uintptr_t, uintptr_t);
116bool intr_is_per_cpu(struct resource *);
117
118extern device_t intr_irq_root_dev;
119
120/* Intr interface for BUS. */
121
122int intr_activate_irq(device_t, struct resource *);
123int intr_deactivate_irq(device_t, struct resource *);
124
125int intr_setup_irq(device_t, struct resource *, driver_filter_t, driver_intr_t,
126 void *, int, void **);
127int intr_teardown_irq(device_t, struct resource *, void *);
128
129int intr_describe_irq(device_t, struct resource *, void *, const char *);
130int intr_child_irq_handler(struct intr_pic *, uintptr_t);
131
132/* Intr resources mapping. */
133struct intr_map_data *intr_alloc_map_data(enum intr_map_data_type, size_t, int);
134void intr_free_intr_map_data(struct intr_map_data *);
135u_int intr_map_irq(device_t, intptr_t, struct intr_map_data *);
136void intr_unmap_irq(u_int );
137u_int intr_map_clone_irq(u_int );
138
139/* MSI/MSI-X handling */
140int intr_msi_register(device_t, intptr_t);
141int intr_alloc_msi(device_t, device_t, intptr_t, int, int, int *);
142int intr_release_msi(device_t, device_t, intptr_t, int, int *);
143int intr_map_msi(device_t, device_t, intptr_t, int, uint64_t *, uint32_t *);
144int intr_alloc_msix(device_t, device_t, intptr_t, int *);
145int intr_release_msix(device_t, device_t, intptr_t, int);
146
147#ifdef SMP
148int intr_bind_irq(device_t, struct resource *, int);
149
150void intr_pic_init_secondary(void);
151#endif
152
153extern u_int intr_nirq; /* number of IRQs on intrng platforms */
154
155/* Intr interface for IPIs. */
156#ifdef SMP
157typedef void intr_ipi_handler_t(void *);
158
159int intr_ipi_pic_register(device_t dev, u_int priority);
160void intr_ipi_setup(u_int ipi, const char *name, intr_ipi_handler_t *hand,
161 void *arg);
162void intr_ipi_send(cpuset_t cpus, u_int ipi);
163void intr_ipi_dispatch(u_int ipi);
164#endif
165
166#endif /* _SYS_INTR_H */