xref: /netbsd/sys/arch/x86/include/i82093var.h (revision 04775534)
1 /* $NetBSD: i82093var.h,v 1.16 2017/05/23 03:23:58 nonaka Exp $ */
2 
3 /*-
4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by RedBack Networks Inc.
9  *
10  * Author: Bill Sommerfeld
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef _X86_I82093VAR_H_
35 #define _X86_I82093VAR_H_
36 
37 #include <sys/device.h>
38 #include <machine/apicvar.h>
39 
40 struct ioapic_pin {
41 	struct ioapic_pin	*ip_next;	/* next pin on this vector */
42 	struct mp_intr_map 	*ip_map;
43 	int			ip_vector;	/* IDT vector */
44 	int			ip_type;
45 	struct cpu_info		*ip_cpu;	/* target CPU */
46 };
47 
48 struct ioapic_softc {
49 	device_t		sc_dev;
50 	struct pic		sc_pic;
51 	struct ioapic_softc	*sc_next;
52 	int			sc_apic_vers;
53 	int			sc_apic_vecbase; /* global int base if ACPI */
54 	int			sc_apic_sz;	/* apic size */
55 	int			sc_flags;
56 	paddr_t			sc_pa;		/* PA of ioapic */
57 	volatile uint32_t	*sc_reg;	/* KVA of ioapic addr */
58 	volatile uint32_t	*sc_data;	/* KVA of ioapic data */
59 	struct ioapic_pin	*sc_pins;	/* sc_apic_sz entries */
60 };
61 
62 /*
63  * MP: intr_handle_t is bitfielded.
64  * ih&0xff -> legacy irq number.
65  * ih&0x10000000 -> if 0, old-style isa irq; if 1, routed via ioapic.
66  * (ih&0xff0000)>>16 -> ioapic id.
67  * (ih&0x00ff00)>>8 -> ioapic pin.
68  *
69  * MSI/MSI-X:
70  * (ih&0x000ff80000000000)>>43 -> MSI/MSI-X device id.
71  * (ih&0x000007ff00000000)>>32 -> MSI/MSI-X vector id in a device.
72  */
73 #define MPSAFE_MASK		0x80000000ULL
74 #define APIC_INT_VIA_APIC	0x10000000ULL
75 #define APIC_INT_VIA_MSI	0x20000000ULL
76 #define APIC_INT_APIC_MASK	0x00ff0000ULL
77 #define APIC_INT_APIC_SHIFT	16
78 #define APIC_INT_PIN_MASK	0x0000ff00ULL
79 #define APIC_INT_PIN_SHIFT	8
80 
81 #define APIC_IRQ_APIC(x) (int)(((x) & APIC_INT_APIC_MASK) >> APIC_INT_APIC_SHIFT)
82 #define APIC_IRQ_PIN(x) (int)(((x) & APIC_INT_PIN_MASK) >> APIC_INT_PIN_SHIFT)
83 #define APIC_IRQ_ISLEGACY(x) (bool)(!((x) & APIC_INT_VIA_APIC))
84 #define APIC_IRQ_LEGACY_IRQ(x) (int)((x) & 0xff)
85 
86 #define INT_VIA_MSI(x) (bool)(((x) & APIC_INT_VIA_MSI) != 0)
87 
88 #define MSI_INT_MSIX		0x1000000000000000ULL
89 #define MSI_INT_DEV_MASK	0x000ff80000000000ULL
90 #define MSI_INT_VEC_MASK	0x000007ff00000000ULL
91 
92 #define MSI_INT_IS_MSIX(x) (bool)((((x) & MSI_INT_MSIX) != 0))
93 #define MSI_INT_MAKE_MSI(x) ((x) &= ~MSI_INT_MSIX)
94 #define MSI_INT_MAKE_MSIX(x) ((x) |= MSI_INT_MSIX)
95 #define MSI_INT_DEV(x) __SHIFTOUT((x), MSI_INT_DEV_MASK)
96 #define MSI_INT_VEC(x) __SHIFTOUT((x), MSI_INT_VEC_MASK)
97 
98 void ioapic_print_redir(struct ioapic_softc *, const char *, int);
99 void ioapic_format_redir(char *, const char *, int, uint32_t, uint32_t);
100 struct ioapic_softc *ioapic_find(int);
101 struct ioapic_softc *ioapic_find_bybase(int);
102 
103 void ioapic_enable(void);
104 void ioapic_reenable(void);
105 
106 extern int nioapics;
107 extern struct ioapic_softc *ioapics;
108 
109 #endif /* !_X86_I82093VAR_H_ */
110