xref: /openbmc/linux/arch/x86/include/asm/apic.h (revision 48ca54e3)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef _ASM_X86_APIC_H
3 #define _ASM_X86_APIC_H
4 
5 #include <linux/cpumask.h>
6 
7 #include <asm/alternative.h>
8 #include <asm/cpufeature.h>
9 #include <asm/apicdef.h>
10 #include <linux/atomic.h>
11 #include <asm/fixmap.h>
12 #include <asm/mpspec.h>
13 #include <asm/msr.h>
14 #include <asm/hardirq.h>
15 
16 #define ARCH_APICTIMER_STOPS_ON_C3	1
17 
18 /*
19  * Debugging macros
20  */
21 #define APIC_QUIET   0
22 #define APIC_VERBOSE 1
23 #define APIC_DEBUG   2
24 
25 /* Macros for apic_extnmi which controls external NMI masking */
26 #define APIC_EXTNMI_BSP		0 /* Default */
27 #define APIC_EXTNMI_ALL		1
28 #define APIC_EXTNMI_NONE	2
29 
30 /*
31  * Define the default level of output to be very little
32  * This can be turned up by using apic=verbose for more
33  * information and apic=debug for _lots_ of information.
34  * apic_verbosity is defined in apic.c
35  */
36 #define apic_printk(v, s, a...) do {       \
37 		if ((v) <= apic_verbosity) \
38 			printk(s, ##a);    \
39 	} while (0)
40 
41 
42 #if defined(CONFIG_X86_LOCAL_APIC) && defined(CONFIG_X86_32)
43 extern void generic_apic_probe(void);
44 #else
45 static inline void generic_apic_probe(void)
46 {
47 }
48 #endif
49 
50 #ifdef CONFIG_X86_LOCAL_APIC
51 
52 extern int apic_verbosity;
53 extern int local_apic_timer_c2_ok;
54 
55 extern int disable_apic;
56 extern unsigned int lapic_timer_period;
57 
58 extern enum apic_intr_mode_id apic_intr_mode;
59 enum apic_intr_mode_id {
60 	APIC_PIC,
61 	APIC_VIRTUAL_WIRE,
62 	APIC_VIRTUAL_WIRE_NO_CONFIG,
63 	APIC_SYMMETRIC_IO,
64 	APIC_SYMMETRIC_IO_NO_ROUTING
65 };
66 
67 #ifdef CONFIG_SMP
68 extern void __inquire_remote_apic(int apicid);
69 #else /* CONFIG_SMP */
70 static inline void __inquire_remote_apic(int apicid)
71 {
72 }
73 #endif /* CONFIG_SMP */
74 
75 static inline void default_inquire_remote_apic(int apicid)
76 {
77 	if (apic_verbosity >= APIC_DEBUG)
78 		__inquire_remote_apic(apicid);
79 }
80 
81 /*
82  * With 82489DX we can't rely on apic feature bit
83  * retrieved via cpuid but still have to deal with
84  * such an apic chip so we assume that SMP configuration
85  * is found from MP table (64bit case uses ACPI mostly
86  * which set smp presence flag as well so we are safe
87  * to use this helper too).
88  */
89 static inline bool apic_from_smp_config(void)
90 {
91 	return smp_found_config && !disable_apic;
92 }
93 
94 /*
95  * Basic functions accessing APICs.
96  */
97 #ifdef CONFIG_PARAVIRT
98 #include <asm/paravirt.h>
99 #endif
100 
101 extern int setup_profiling_timer(unsigned int);
102 
103 static inline void native_apic_mem_write(u32 reg, u32 v)
104 {
105 	volatile u32 *addr = (volatile u32 *)(APIC_BASE + reg);
106 
107 	alternative_io("movl %0, %P1", "xchgl %0, %P1", X86_BUG_11AP,
108 		       ASM_OUTPUT2("=r" (v), "=m" (*addr)),
109 		       ASM_OUTPUT2("0" (v), "m" (*addr)));
110 }
111 
112 static inline u32 native_apic_mem_read(u32 reg)
113 {
114 	return *((volatile u32 *)(APIC_BASE + reg));
115 }
116 
117 extern void native_apic_wait_icr_idle(void);
118 extern u32 native_safe_apic_wait_icr_idle(void);
119 extern void native_apic_icr_write(u32 low, u32 id);
120 extern u64 native_apic_icr_read(void);
121 
122 static inline bool apic_is_x2apic_enabled(void)
123 {
124 	u64 msr;
125 
126 	if (rdmsrl_safe(MSR_IA32_APICBASE, &msr))
127 		return false;
128 	return msr & X2APIC_ENABLE;
129 }
130 
131 extern void enable_IR_x2apic(void);
132 
133 extern int get_physical_broadcast(void);
134 
135 extern int lapic_get_maxlvt(void);
136 extern void clear_local_APIC(void);
137 extern void disconnect_bsp_APIC(int virt_wire_setup);
138 extern void disable_local_APIC(void);
139 extern void apic_soft_disable(void);
140 extern void lapic_shutdown(void);
141 extern void sync_Arb_IDs(void);
142 extern void init_bsp_APIC(void);
143 extern void apic_intr_mode_select(void);
144 extern void apic_intr_mode_init(void);
145 extern void init_apic_mappings(void);
146 void register_lapic_address(unsigned long address);
147 extern void setup_boot_APIC_clock(void);
148 extern void setup_secondary_APIC_clock(void);
149 extern void lapic_update_tsc_freq(void);
150 
151 #ifdef CONFIG_X86_64
152 static inline int apic_force_enable(unsigned long addr)
153 {
154 	return -1;
155 }
156 #else
157 extern int apic_force_enable(unsigned long addr);
158 #endif
159 
160 extern void apic_ap_setup(void);
161 
162 /*
163  * On 32bit this is mach-xxx local
164  */
165 #ifdef CONFIG_X86_64
166 extern int apic_is_clustered_box(void);
167 #else
168 static inline int apic_is_clustered_box(void)
169 {
170 	return 0;
171 }
172 #endif
173 
174 extern int setup_APIC_eilvt(u8 lvt_off, u8 vector, u8 msg_type, u8 mask);
175 extern void lapic_assign_system_vectors(void);
176 extern void lapic_assign_legacy_vector(unsigned int isairq, bool replace);
177 extern void lapic_update_legacy_vectors(void);
178 extern void lapic_online(void);
179 extern void lapic_offline(void);
180 extern bool apic_needs_pit(void);
181 
182 extern void apic_send_IPI_allbutself(unsigned int vector);
183 
184 #else /* !CONFIG_X86_LOCAL_APIC */
185 static inline void lapic_shutdown(void) { }
186 #define local_apic_timer_c2_ok		1
187 static inline void init_apic_mappings(void) { }
188 static inline void disable_local_APIC(void) { }
189 # define setup_boot_APIC_clock x86_init_noop
190 # define setup_secondary_APIC_clock x86_init_noop
191 static inline void lapic_update_tsc_freq(void) { }
192 static inline void init_bsp_APIC(void) { }
193 static inline void apic_intr_mode_select(void) { }
194 static inline void apic_intr_mode_init(void) { }
195 static inline void lapic_assign_system_vectors(void) { }
196 static inline void lapic_assign_legacy_vector(unsigned int i, bool r) { }
197 static inline bool apic_needs_pit(void) { return true; }
198 #endif /* !CONFIG_X86_LOCAL_APIC */
199 
200 #ifdef CONFIG_X86_X2APIC
201 static inline void native_apic_msr_write(u32 reg, u32 v)
202 {
203 	if (reg == APIC_DFR || reg == APIC_ID || reg == APIC_LDR ||
204 	    reg == APIC_LVR)
205 		return;
206 
207 	wrmsr(APIC_BASE_MSR + (reg >> 4), v, 0);
208 }
209 
210 static inline void native_apic_msr_eoi_write(u32 reg, u32 v)
211 {
212 	__wrmsr(APIC_BASE_MSR + (APIC_EOI >> 4), APIC_EOI_ACK, 0);
213 }
214 
215 static inline u32 native_apic_msr_read(u32 reg)
216 {
217 	u64 msr;
218 
219 	if (reg == APIC_DFR)
220 		return -1;
221 
222 	rdmsrl(APIC_BASE_MSR + (reg >> 4), msr);
223 	return (u32)msr;
224 }
225 
226 static inline void native_x2apic_wait_icr_idle(void)
227 {
228 	/* no need to wait for icr idle in x2apic */
229 	return;
230 }
231 
232 static inline u32 native_safe_x2apic_wait_icr_idle(void)
233 {
234 	/* no need to wait for icr idle in x2apic */
235 	return 0;
236 }
237 
238 static inline void native_x2apic_icr_write(u32 low, u32 id)
239 {
240 	wrmsrl(APIC_BASE_MSR + (APIC_ICR >> 4), ((__u64) id) << 32 | low);
241 }
242 
243 static inline u64 native_x2apic_icr_read(void)
244 {
245 	unsigned long val;
246 
247 	rdmsrl(APIC_BASE_MSR + (APIC_ICR >> 4), val);
248 	return val;
249 }
250 
251 extern int x2apic_mode;
252 extern int x2apic_phys;
253 extern void __init x2apic_set_max_apicid(u32 apicid);
254 extern void __init check_x2apic(void);
255 extern void x2apic_setup(void);
256 static inline int x2apic_enabled(void)
257 {
258 	return boot_cpu_has(X86_FEATURE_X2APIC) && apic_is_x2apic_enabled();
259 }
260 
261 #define x2apic_supported()	(boot_cpu_has(X86_FEATURE_X2APIC))
262 #else /* !CONFIG_X86_X2APIC */
263 static inline void check_x2apic(void) { }
264 static inline void x2apic_setup(void) { }
265 static inline int x2apic_enabled(void) { return 0; }
266 
267 #define x2apic_mode		(0)
268 #define	x2apic_supported()	(0)
269 #endif /* !CONFIG_X86_X2APIC */
270 
271 struct irq_data;
272 
273 /*
274  * Copyright 2004 James Cleverdon, IBM.
275  *
276  * Generic APIC sub-arch data struct.
277  *
278  * Hacked for x86-64 by James Cleverdon from i386 architecture code by
279  * Martin Bligh, Andi Kleen, James Bottomley, John Stultz, and
280  * James Cleverdon.
281  */
282 struct apic {
283 	/* Hotpath functions first */
284 	void	(*eoi_write)(u32 reg, u32 v);
285 	void	(*native_eoi_write)(u32 reg, u32 v);
286 	void	(*write)(u32 reg, u32 v);
287 	u32	(*read)(u32 reg);
288 
289 	/* IPI related functions */
290 	void	(*wait_icr_idle)(void);
291 	u32	(*safe_wait_icr_idle)(void);
292 
293 	void	(*send_IPI)(int cpu, int vector);
294 	void	(*send_IPI_mask)(const struct cpumask *mask, int vector);
295 	void	(*send_IPI_mask_allbutself)(const struct cpumask *msk, int vec);
296 	void	(*send_IPI_allbutself)(int vector);
297 	void	(*send_IPI_all)(int vector);
298 	void	(*send_IPI_self)(int vector);
299 
300 	u32	disable_esr;
301 
302 	enum apic_delivery_modes delivery_mode;
303 	bool	dest_mode_logical;
304 
305 	u32	(*calc_dest_apicid)(unsigned int cpu);
306 
307 	/* ICR related functions */
308 	u64	(*icr_read)(void);
309 	void	(*icr_write)(u32 low, u32 high);
310 
311 	/* Probe, setup and smpboot functions */
312 	int	(*probe)(void);
313 	int	(*acpi_madt_oem_check)(char *oem_id, char *oem_table_id);
314 	int	(*apic_id_valid)(u32 apicid);
315 	int	(*apic_id_registered)(void);
316 
317 	bool	(*check_apicid_used)(physid_mask_t *map, int apicid);
318 	void	(*init_apic_ldr)(void);
319 	void	(*ioapic_phys_id_map)(physid_mask_t *phys_map, physid_mask_t *retmap);
320 	void	(*setup_apic_routing)(void);
321 	int	(*cpu_present_to_apicid)(int mps_cpu);
322 	void	(*apicid_to_cpu_present)(int phys_apicid, physid_mask_t *retmap);
323 	int	(*check_phys_apicid_present)(int phys_apicid);
324 	int	(*phys_pkg_id)(int cpuid_apic, int index_msb);
325 
326 	u32	(*get_apic_id)(unsigned long x);
327 	u32	(*set_apic_id)(unsigned int id);
328 
329 	/* wakeup_secondary_cpu */
330 	int	(*wakeup_secondary_cpu)(int apicid, unsigned long start_eip);
331 	/* wakeup secondary CPU using 64-bit wakeup point */
332 	int	(*wakeup_secondary_cpu_64)(int apicid, unsigned long start_eip);
333 
334 	void	(*inquire_remote_apic)(int apicid);
335 
336 #ifdef CONFIG_X86_32
337 	/*
338 	 * Called very early during boot from get_smp_config().  It should
339 	 * return the logical apicid.  x86_[bios]_cpu_to_apicid is
340 	 * initialized before this function is called.
341 	 *
342 	 * If logical apicid can't be determined that early, the function
343 	 * may return BAD_APICID.  Logical apicid will be configured after
344 	 * init_apic_ldr() while bringing up CPUs.  Note that NUMA affinity
345 	 * won't be applied properly during early boot in this case.
346 	 */
347 	int (*x86_32_early_logical_apicid)(int cpu);
348 #endif
349 	char	*name;
350 };
351 
352 /*
353  * Pointer to the local APIC driver in use on this system (there's
354  * always just one such driver in use - the kernel decides via an
355  * early probing process which one it picks - and then sticks to it):
356  */
357 extern struct apic *apic;
358 
359 /*
360  * APIC drivers are probed based on how they are listed in the .apicdrivers
361  * section. So the order is important and enforced by the ordering
362  * of different apic driver files in the Makefile.
363  *
364  * For the files having two apic drivers, we use apic_drivers()
365  * to enforce the order with in them.
366  */
367 #define apic_driver(sym)					\
368 	static const struct apic *__apicdrivers_##sym __used		\
369 	__aligned(sizeof(struct apic *))			\
370 	__section(".apicdrivers") = { &sym }
371 
372 #define apic_drivers(sym1, sym2)					\
373 	static struct apic *__apicdrivers_##sym1##sym2[2] __used	\
374 	__aligned(sizeof(struct apic *))				\
375 	__section(".apicdrivers") = { &sym1, &sym2 }
376 
377 extern struct apic *__apicdrivers[], *__apicdrivers_end[];
378 
379 /*
380  * APIC functionality to boot other CPUs - only used on SMP:
381  */
382 #ifdef CONFIG_SMP
383 extern int wakeup_secondary_cpu_via_nmi(int apicid, unsigned long start_eip);
384 extern int lapic_can_unplug_cpu(void);
385 #endif
386 
387 #ifdef CONFIG_X86_LOCAL_APIC
388 
389 static inline u32 apic_read(u32 reg)
390 {
391 	return apic->read(reg);
392 }
393 
394 static inline void apic_write(u32 reg, u32 val)
395 {
396 	apic->write(reg, val);
397 }
398 
399 static inline void apic_eoi(void)
400 {
401 	apic->eoi_write(APIC_EOI, APIC_EOI_ACK);
402 }
403 
404 static inline u64 apic_icr_read(void)
405 {
406 	return apic->icr_read();
407 }
408 
409 static inline void apic_icr_write(u32 low, u32 high)
410 {
411 	apic->icr_write(low, high);
412 }
413 
414 static inline void apic_wait_icr_idle(void)
415 {
416 	apic->wait_icr_idle();
417 }
418 
419 static inline u32 safe_apic_wait_icr_idle(void)
420 {
421 	return apic->safe_wait_icr_idle();
422 }
423 
424 extern void __init apic_set_eoi_write(void (*eoi_write)(u32 reg, u32 v));
425 
426 #else /* CONFIG_X86_LOCAL_APIC */
427 
428 static inline u32 apic_read(u32 reg) { return 0; }
429 static inline void apic_write(u32 reg, u32 val) { }
430 static inline void apic_eoi(void) { }
431 static inline u64 apic_icr_read(void) { return 0; }
432 static inline void apic_icr_write(u32 low, u32 high) { }
433 static inline void apic_wait_icr_idle(void) { }
434 static inline u32 safe_apic_wait_icr_idle(void) { return 0; }
435 static inline void apic_set_eoi_write(void (*eoi_write)(u32 reg, u32 v)) {}
436 
437 #endif /* CONFIG_X86_LOCAL_APIC */
438 
439 extern void apic_ack_irq(struct irq_data *data);
440 
441 static inline void ack_APIC_irq(void)
442 {
443 	/*
444 	 * ack_APIC_irq() actually gets compiled as a single instruction
445 	 * ... yummie.
446 	 */
447 	apic_eoi();
448 }
449 
450 
451 static inline bool lapic_vector_set_in_irr(unsigned int vector)
452 {
453 	u32 irr = apic_read(APIC_IRR + (vector / 32 * 0x10));
454 
455 	return !!(irr & (1U << (vector % 32)));
456 }
457 
458 static inline unsigned default_get_apic_id(unsigned long x)
459 {
460 	unsigned int ver = GET_APIC_VERSION(apic_read(APIC_LVR));
461 
462 	if (APIC_XAPIC(ver) || boot_cpu_has(X86_FEATURE_EXTD_APICID))
463 		return (x >> 24) & 0xFF;
464 	else
465 		return (x >> 24) & 0x0F;
466 }
467 
468 /*
469  * Warm reset vector position:
470  */
471 #define TRAMPOLINE_PHYS_LOW		0x467
472 #define TRAMPOLINE_PHYS_HIGH		0x469
473 
474 extern void generic_bigsmp_probe(void);
475 
476 #ifdef CONFIG_X86_LOCAL_APIC
477 
478 #include <asm/smp.h>
479 
480 #define APIC_DFR_VALUE	(APIC_DFR_FLAT)
481 
482 DECLARE_EARLY_PER_CPU_READ_MOSTLY(u16, x86_bios_cpu_apicid);
483 
484 extern struct apic apic_noop;
485 
486 static inline unsigned int read_apic_id(void)
487 {
488 	unsigned int reg = apic_read(APIC_ID);
489 
490 	return apic->get_apic_id(reg);
491 }
492 
493 #ifdef CONFIG_X86_64
494 typedef int (*wakeup_cpu_handler)(int apicid, unsigned long start_eip);
495 extern void acpi_wake_cpu_handler_update(wakeup_cpu_handler handler);
496 #endif
497 
498 extern int default_apic_id_valid(u32 apicid);
499 extern int default_acpi_madt_oem_check(char *, char *);
500 extern void default_setup_apic_routing(void);
501 
502 extern u32 apic_default_calc_apicid(unsigned int cpu);
503 extern u32 apic_flat_calc_apicid(unsigned int cpu);
504 
505 extern bool default_check_apicid_used(physid_mask_t *map, int apicid);
506 extern void default_ioapic_phys_id_map(physid_mask_t *phys_map, physid_mask_t *retmap);
507 extern int default_cpu_present_to_apicid(int mps_cpu);
508 extern int default_check_phys_apicid_present(int phys_apicid);
509 
510 #endif /* CONFIG_X86_LOCAL_APIC */
511 
512 #ifdef CONFIG_SMP
513 bool apic_id_is_primary_thread(unsigned int id);
514 void apic_smt_update(void);
515 #else
516 static inline bool apic_id_is_primary_thread(unsigned int id) { return false; }
517 static inline void apic_smt_update(void) { }
518 #endif
519 
520 struct msi_msg;
521 struct irq_cfg;
522 
523 extern void __irq_msi_compose_msg(struct irq_cfg *cfg, struct msi_msg *msg,
524 				  bool dmar);
525 
526 extern void ioapic_zap_locks(void);
527 
528 #endif /* _ASM_X86_APIC_H */
529