1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2003 John Baldwin <jhb@FreeBSD.org>
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#ifndef __X86_INTR_MACHDEP_H__
29#define	__X86_INTR_MACHDEP_H__
30
31#ifdef _KERNEL
32
33/*
34 * Values used in determining the allocation of IRQ values among
35 * different types of I/O interrupts.  These values are used as
36 * indices into a interrupt source array to map I/O interrupts to a
37 * device interrupt source whether it be a pin on an interrupt
38 * controller or an MSI interrupt.  The 16 ISA IRQs are assigned fixed
39 * IDT vectors, but all other device interrupts allocate IDT vectors
40 * on demand.  Currently we have 191 IDT vectors available for device
41 * interrupts on each CPU.  On many systems with I/O APICs, a lot of
42 * the IRQs are not used, so the total number of IRQ values reserved
43 * can exceed the number of available IDT slots.
44 *
45 * The first 16 IRQs (0 - 15) are reserved for ISA IRQs.  Interrupt
46 * pins on I/O APICs for non-ISA interrupts use IRQ values starting at
47 * IRQ 17.  This layout matches the GSI numbering used by ACPI so that
48 * IRQ values returned by ACPI methods such as _CRS can be used
49 * directly by the ACPI bus driver.
50 *
51 * MSI interrupts allocate a block of interrupts starting at the end
52 * of the I/O APIC range.  When running under the Xen Hypervisor, an
53 * additional range of IRQ values are available for binding to event
54 * channel events.
55 */
56extern u_int first_msi_irq;
57extern u_int num_io_irqs;
58extern u_int num_msi_irqs;
59
60/*
61 * Default base address for MSI messages on x86 platforms.
62 */
63#define	MSI_INTEL_ADDR_BASE		0xfee00000
64
65#ifndef LOCORE
66
67typedef void inthand_t(void);
68
69#define	IDTVEC(name)	__CONCAT(X,name)
70
71struct intsrc;
72
73/*
74 * Methods that a PIC provides to mask/unmask a given interrupt source,
75 * "turn on" the interrupt on the CPU side by setting up an IDT entry, and
76 * return the vector associated with this source.
77 */
78struct pic {
79	void (*pic_register_sources)(struct pic *);
80	void (*pic_enable_source)(struct intsrc *);
81	void (*pic_disable_source)(struct intsrc *, int);
82	void (*pic_eoi_source)(struct intsrc *);
83	void (*pic_enable_intr)(struct intsrc *);
84	void (*pic_disable_intr)(struct intsrc *);
85	int (*pic_vector)(struct intsrc *);
86	int (*pic_source_pending)(struct intsrc *);
87	void (*pic_suspend)(struct pic *);
88	void (*pic_resume)(struct pic *, bool suspend_cancelled);
89	int (*pic_config_intr)(struct intsrc *, enum intr_trigger,
90	    enum intr_polarity);
91	int (*pic_assign_cpu)(struct intsrc *, u_int apic_id);
92	void (*pic_reprogram_pin)(struct intsrc *);
93	TAILQ_ENTRY(pic) pics;
94};
95
96/* Flags for pic_disable_source() */
97enum {
98	PIC_EOI,
99	PIC_NO_EOI,
100};
101
102/*
103 * An interrupt source.  The upper-layer code uses the PIC methods to
104 * control a given source.  The lower-layer PIC drivers can store additional
105 * private data in a given interrupt source such as an interrupt pin number
106 * or an I/O APIC pointer.
107 */
108struct intsrc {
109	struct pic *is_pic;
110	struct intr_event *is_event;
111	u_long *is_count;
112	u_long *is_straycount;
113	u_int is_index;
114	u_int is_handlers;
115	u_int is_domain;
116	u_int is_cpu;
117};
118
119struct trapframe;
120
121#ifdef SMP
122extern cpuset_t intr_cpus;
123#endif
124extern struct mtx icu_lock;
125extern int elcr_found;
126#ifdef SMP
127extern int msix_disable_migration;
128#endif
129
130#ifndef DEV_ATPIC
131void	atpic_reset(void);
132#endif
133/* XXX: The elcr_* prototypes probably belong somewhere else. */
134int	elcr_probe(void);
135enum intr_trigger elcr_read_trigger(u_int irq);
136void	elcr_resume(void);
137void	elcr_write_trigger(u_int irq, enum intr_trigger trigger);
138#ifdef SMP
139void	intr_add_cpu(u_int cpu);
140#endif
141int	intr_add_handler(struct intsrc *isrc, const char *name,
142     driver_filter_t filter, driver_intr_t handler, void *arg,
143     enum intr_type flags, void **cookiep, int domain);
144int	intr_config_intr(struct intsrc *isrc, enum intr_trigger trig,
145    enum intr_polarity pol);
146int	intr_describe(struct intsrc *isrc, void *ih, const char *descr);
147void	intr_execute_handlers(struct intsrc *isrc, struct trapframe *frame);
148u_int	intr_next_cpu(int domain);
149struct intsrc *intr_lookup_source(int vector);
150int	intr_register_pic(struct pic *pic);
151int	intr_register_source(struct intsrc *isrc);
152int	intr_remove_handler(void *cookie);
153void	intr_resume(bool suspend_cancelled);
154void	intr_suspend(void);
155void	intr_reprogram(void);
156void	intrcnt_add(const char *name, u_long **countp);
157void	nexus_add_irq(u_long irq);
158int	msi_alloc(device_t dev, int count, int maxcount, int *irqs);
159void	msi_init(void);
160int	msi_map(int irq, uint64_t *addr, uint32_t *data);
161int	msi_release(int *irqs, int count);
162int	msix_alloc(device_t dev, int *irq);
163int	msix_release(int irq);
164#ifdef XENHVM
165void	xen_intr_alloc_irqs(void);
166#endif
167
168#endif	/* !LOCORE */
169#endif	/* _KERNEL */
170#endif	/* !__X86_INTR_MACHDEP_H__ */
171