xref: /illumos-gate/usr/src/uts/i86pc/sys/apic_common.h (revision 0250c53ad267726f2438e3c6556199a0bbf588a2)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright (c) 2017 by Delphix. All rights reserved.
24  */
25 /*
26  * Copyright 2019, Joyent, Inc.
27  */
28 
29 #ifndef _SYS_APIC_COMMON_H
30 #define	_SYS_APIC_COMMON_H
31 
32 #include <sys/psm_types.h>
33 #include <sys/avintr.h>
34 #include <sys/privregs.h>
35 #include <sys/pci.h>
36 #include <sys/cyclic.h>
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 /*
43  * Functions & Variables common to pcplusmp & apix
44  */
45 
46 #include <sys/psm_common.h>
47 
48 /* Methods for multiple IOAPIC */
49 enum apic_ioapic_method_type {
50 	APIC_MUL_IOAPIC_NONE,		/* use to disable pcplusmp fallback */
51 	APIC_MUL_IOAPIC_MASK,		/* Set RT Entry Mask bit before EOI */
52 	APIC_MUL_IOAPIC_DEOI,		/* Directed EOI */
53 	APIC_MUL_IOAPIC_IOXAPIC,	/* IOxAPIC */
54 	APIC_MUL_IOAPIC_IIR,		/* IOMMU interrup remapping */
55 	APIC_MUL_IOAPIC_PCPLUSMP	/* Fall back to old pcplusmp */
56 };
57 
58 #define	APIX_IS_DIRECTED_EOI(type)	\
59 	((type) == APIC_MUL_IOAPIC_DEOI || (type) == APIC_MUL_IOAPIC_IIR)
60 #define	APIX_IS_MASK_RDT(type)	\
61 	((type) == APIC_MUL_IOAPIC_NONE || (type) == APIC_MUL_IOAPIC_MASK)
62 
63 extern int	apix_enable;
64 extern int	apix_loaded(void);
65 extern enum apic_ioapic_method_type apix_mul_ioapic_method;
66 
67 extern int	apic_oneshot;
68 /* to allow disabling one-shot capability */
69 extern int	apic_oneshot_enable;
70 
71 /* Now the ones for Dynamic Interrupt distribution */
72 extern int	apic_enable_dynamic_migration;
73 
74 extern struct psm_ops *psmops;
75 
76 /*
77  * These variables are frequently accessed in apic_intr_enter(),
78  * apic_intr_exit and apic_setspl, so group them together
79  */
80 extern volatile uint32_t *apicadr;	/* virtual addr of local APIC	*/
81 extern uchar_t	apic_io_vectbase[MAX_IO_APIC];
82 extern uchar_t	apic_io_vectend[MAX_IO_APIC];
83 extern uchar_t	apic_io_ver[MAX_IO_APIC];
84 extern int	apic_io_max;
85 extern int	apic_nvidia_io_max;
86 extern int apic_setspl_delay;		/* apic_setspl - delay enable	*/
87 extern int apic_clkvect;
88 
89 /* vector at which error interrupts come in */
90 extern int apic_errvect;
91 extern int apic_enable_error_intr;
92 extern int apic_error_display_delay;
93 
94 /* vector at which performance counter overflow interrupts come in */
95 extern int apic_cpcovf_vect;
96 extern int apic_enable_cpcovf_intr;
97 
98 /* vector at which CMCI interrupts come in */
99 extern int apic_cmci_vect;
100 extern int cmi_enable_cmci;
101 extern void cmi_cmci_trap(void);
102 
103 extern kmutex_t cmci_cpu_setup_lock;	/* protects cmci_cpu_setup_registered */
104 extern int cmci_cpu_setup_registered;
105 
106 extern int	apic_forceload;
107 
108 extern int	apic_coarse_hrtime;	/* 0 - use accurate slow gethrtime() */
109 					/* 1 - use gettime() for performance */
110 extern int	apic_flat_model;		/* 0 - clustered. 1 - flat */
111 
112 extern int	apic_panic_on_nmi;
113 extern int	apic_panic_on_apic_error;
114 
115 extern int	apic_verbose;
116 
117 extern int	apic_pir_vect;
118 
119 #ifdef DEBUG
120 extern int	apic_debug;
121 extern int	apic_restrict_vector;
122 
123 extern int	apic_debug_msgbuf[APIC_DEBUG_MSGBUFSIZE];
124 extern int	apic_debug_msgbufindex;
125 
126 #endif /* DEBUG */
127 
128 extern uint_t	apic_nsec_per_intr;
129 extern uint_t	apic_nticks;
130 extern uint_t	apic_skipped_redistribute;
131 
132 extern uint_t	last_count_read;
133 extern lock_t	apic_mode_switch_lock;
134 extern lock_t	apic_gethrtime_lock;
135 extern volatile int	apic_hrtime_stamp;
136 extern volatile hrtime_t apic_nsec_since_boot;
137 extern uint_t	apic_hertz_count;
138 
139 extern uint64_t apic_ticks_per_SFnsecs;	/* # of ticks in SF nsecs */
140 
141 extern int	apic_hrtime_error;
142 extern int	apic_remote_hrterr;
143 extern int	apic_num_nmis;
144 extern int	apic_apic_error;
145 extern int	apic_num_apic_errors;
146 extern int	apic_num_cksum_errors;
147 
148 extern int	apic_error;
149 
150 /* use to make sure only one cpu handles the nmi */
151 extern lock_t	apic_nmi_lock;
152 /* use to make sure only one cpu handles the error interrupt */
153 extern lock_t	apic_error_lock;
154 
155 /* Patchable global variables. */
156 extern uint32_t	apic_divide_reg_init;	/* 0 - divide by 2 */
157 
158 extern apic_intrmap_ops_t *apic_vt_ops;
159 
160 #ifdef	DEBUG
161 extern int	apic_break_on_cpu;
162 extern int	apic_stretch_interrupts;
163 extern int	apic_stretch_ISR;	/* IPL of 3 matches nothing now */
164 #endif
165 
166 extern cyclic_id_t apic_cyclic_id;
167 
168 extern uint_t apic_nmi_intr(caddr_t arg, caddr_t);
169 extern int	apic_clkinit();
170 extern hrtime_t apic_gettime();
171 extern hrtime_t apic_gethrtime();
172 extern int	apic_cpu_start(processorid_t cpuid, caddr_t ctx);
173 extern int	apic_cpu_stop(processorid_t cpuid, caddr_t ctx);
174 extern int	apic_cpu_add(psm_cpu_request_t *reqp);
175 extern int	apic_cpu_remove(psm_cpu_request_t *reqp);
176 extern int	apic_cpu_ops(psm_cpu_request_t *reqp);
177 extern void	apic_switch_ipi_callback(boolean_t enter);
178 extern void	apic_send_ipi(int cpun, int ipl);
179 extern void	apic_set_idlecpu(processorid_t cpun);
180 extern void	apic_unset_idlecpu(processorid_t cpun);
181 extern void	apic_shutdown(int cmd, int fcn);
182 extern void	apic_preshutdown(int cmd, int fcn);
183 extern processorid_t	apic_get_next_processorid(processorid_t cpun);
184 extern uint64_t	apic_calibrate();
185 extern int	apic_get_pir_ipivect(void);
186 extern void	apic_send_pir_ipi(processorid_t);
187 
188 extern int apic_error_intr();
189 extern void apic_cpcovf_mask_clear(void);
190 extern void apic_cmci_setup(processorid_t, boolean_t);
191 extern void apic_intrmap_init(int apic_mode);
192 extern processorid_t apic_find_cpu(int flag);
193 extern processorid_t apic_get_next_bind_cpu(void);
194 
195 extern int	apic_support_msi;
196 extern int	apic_multi_msi_enable;
197 extern int	apic_msix_enable;
198 
199 extern uint32_t apic_get_localapicid(uint32_t cpuid);
200 extern uchar_t apic_get_ioapicid(uchar_t ioapicindex);
201 
202 typedef enum nmi_action {
203 	NMI_ACTION_UNSET,
204 	NMI_ACTION_PANIC,
205 	NMI_ACTION_IGNORE,
206 	NMI_ACTION_KMDB
207 } nmi_action_t;
208 
209 extern nmi_action_t nmi_action;
210 
211 #ifdef	__cplusplus
212 }
213 #endif
214 
215 #endif	/* _SYS_APIC_COMMON_H */
216