xref: /linux/arch/x86/include/asm/apic.h (revision b7019ac550eb3916f34d79db583e9b7ea2524afa)
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 unsigned int apic_verbosity;
53 extern int local_apic_timer_c2_ok;
54 
55 extern int disable_apic;
56 extern unsigned int lapic_timer_frequency;
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 lapic_shutdown(void);
140 extern void sync_Arb_IDs(void);
141 extern void init_bsp_APIC(void);
142 extern void apic_intr_mode_init(void);
143 extern void init_apic_mappings(void);
144 void register_lapic_address(unsigned long address);
145 extern void setup_boot_APIC_clock(void);
146 extern void setup_secondary_APIC_clock(void);
147 extern void lapic_update_tsc_freq(void);
148 
149 #ifdef CONFIG_X86_64
150 static inline int apic_force_enable(unsigned long addr)
151 {
152 	return -1;
153 }
154 #else
155 extern int apic_force_enable(unsigned long addr);
156 #endif
157 
158 extern void apic_bsp_setup(bool upmode);
159 extern void apic_ap_setup(void);
160 
161 /*
162  * On 32bit this is mach-xxx local
163  */
164 #ifdef CONFIG_X86_64
165 extern int apic_is_clustered_box(void);
166 #else
167 static inline int apic_is_clustered_box(void)
168 {
169 	return 0;
170 }
171 #endif
172 
173 extern int setup_APIC_eilvt(u8 lvt_off, u8 vector, u8 msg_type, u8 mask);
174 extern void lapic_assign_system_vectors(void);
175 extern void lapic_assign_legacy_vector(unsigned int isairq, bool replace);
176 extern void lapic_online(void);
177 extern void lapic_offline(void);
178 
179 #else /* !CONFIG_X86_LOCAL_APIC */
180 static inline void lapic_shutdown(void) { }
181 #define local_apic_timer_c2_ok		1
182 static inline void init_apic_mappings(void) { }
183 static inline void disable_local_APIC(void) { }
184 # define setup_boot_APIC_clock x86_init_noop
185 # define setup_secondary_APIC_clock x86_init_noop
186 static inline void lapic_update_tsc_freq(void) { }
187 static inline void init_bsp_APIC(void) { }
188 static inline void apic_intr_mode_init(void) { }
189 static inline void lapic_assign_system_vectors(void) { }
190 static inline void lapic_assign_legacy_vector(unsigned int i, bool r) { }
191 #endif /* !CONFIG_X86_LOCAL_APIC */
192 
193 #ifdef CONFIG_X86_X2APIC
194 /*
195  * Make previous memory operations globally visible before
196  * sending the IPI through x2apic wrmsr. We need a serializing instruction or
197  * mfence for this.
198  */
199 static inline void x2apic_wrmsr_fence(void)
200 {
201 	asm volatile("mfence" : : : "memory");
202 }
203 
204 static inline void native_apic_msr_write(u32 reg, u32 v)
205 {
206 	if (reg == APIC_DFR || reg == APIC_ID || reg == APIC_LDR ||
207 	    reg == APIC_LVR)
208 		return;
209 
210 	wrmsr(APIC_BASE_MSR + (reg >> 4), v, 0);
211 }
212 
213 static inline void native_apic_msr_eoi_write(u32 reg, u32 v)
214 {
215 	__wrmsr(APIC_BASE_MSR + (APIC_EOI >> 4), APIC_EOI_ACK, 0);
216 }
217 
218 static inline u32 native_apic_msr_read(u32 reg)
219 {
220 	u64 msr;
221 
222 	if (reg == APIC_DFR)
223 		return -1;
224 
225 	rdmsrl(APIC_BASE_MSR + (reg >> 4), msr);
226 	return (u32)msr;
227 }
228 
229 static inline void native_x2apic_wait_icr_idle(void)
230 {
231 	/* no need to wait for icr idle in x2apic */
232 	return;
233 }
234 
235 static inline u32 native_safe_x2apic_wait_icr_idle(void)
236 {
237 	/* no need to wait for icr idle in x2apic */
238 	return 0;
239 }
240 
241 static inline void native_x2apic_icr_write(u32 low, u32 id)
242 {
243 	wrmsrl(APIC_BASE_MSR + (APIC_ICR >> 4), ((__u64) id) << 32 | low);
244 }
245 
246 static inline u64 native_x2apic_icr_read(void)
247 {
248 	unsigned long val;
249 
250 	rdmsrl(APIC_BASE_MSR + (APIC_ICR >> 4), val);
251 	return val;
252 }
253 
254 extern int x2apic_mode;
255 extern int x2apic_phys;
256 extern void __init check_x2apic(void);
257 extern void x2apic_setup(void);
258 static inline int x2apic_enabled(void)
259 {
260 	return boot_cpu_has(X86_FEATURE_X2APIC) && apic_is_x2apic_enabled();
261 }
262 
263 #define x2apic_supported()	(boot_cpu_has(X86_FEATURE_X2APIC))
264 #else /* !CONFIG_X86_X2APIC */
265 static inline void check_x2apic(void) { }
266 static inline void x2apic_setup(void) { }
267 static inline int x2apic_enabled(void) { return 0; }
268 
269 #define x2apic_mode		(0)
270 #define	x2apic_supported()	(0)
271 #endif /* !CONFIG_X86_X2APIC */
272 
273 struct irq_data;
274 
275 /*
276  * Copyright 2004 James Cleverdon, IBM.
277  *
278  * Generic APIC sub-arch data struct.
279  *
280  * Hacked for x86-64 by James Cleverdon from i386 architecture code by
281  * Martin Bligh, Andi Kleen, James Bottomley, John Stultz, and
282  * James Cleverdon.
283  */
284 struct apic {
285 	/* Hotpath functions first */
286 	void	(*eoi_write)(u32 reg, u32 v);
287 	void	(*native_eoi_write)(u32 reg, u32 v);
288 	void	(*write)(u32 reg, u32 v);
289 	u32	(*read)(u32 reg);
290 
291 	/* IPI related functions */
292 	void	(*wait_icr_idle)(void);
293 	u32	(*safe_wait_icr_idle)(void);
294 
295 	void	(*send_IPI)(int cpu, int vector);
296 	void	(*send_IPI_mask)(const struct cpumask *mask, int vector);
297 	void	(*send_IPI_mask_allbutself)(const struct cpumask *msk, int vec);
298 	void	(*send_IPI_allbutself)(int vector);
299 	void	(*send_IPI_all)(int vector);
300 	void	(*send_IPI_self)(int vector);
301 
302 	/* dest_logical is used by the IPI functions */
303 	u32	dest_logical;
304 	u32	disable_esr;
305 	u32	irq_delivery_mode;
306 	u32	irq_dest_mode;
307 
308 	u32	(*calc_dest_apicid)(unsigned int cpu);
309 
310 	/* ICR related functions */
311 	u64	(*icr_read)(void);
312 	void	(*icr_write)(u32 low, u32 high);
313 
314 	/* Probe, setup and smpboot functions */
315 	int	(*probe)(void);
316 	int	(*acpi_madt_oem_check)(char *oem_id, char *oem_table_id);
317 	int	(*apic_id_valid)(u32 apicid);
318 	int	(*apic_id_registered)(void);
319 
320 	bool	(*check_apicid_used)(physid_mask_t *map, int apicid);
321 	void	(*init_apic_ldr)(void);
322 	void	(*ioapic_phys_id_map)(physid_mask_t *phys_map, physid_mask_t *retmap);
323 	void	(*setup_apic_routing)(void);
324 	int	(*cpu_present_to_apicid)(int mps_cpu);
325 	void	(*apicid_to_cpu_present)(int phys_apicid, physid_mask_t *retmap);
326 	int	(*check_phys_apicid_present)(int phys_apicid);
327 	int	(*phys_pkg_id)(int cpuid_apic, int index_msb);
328 
329 	u32	(*get_apic_id)(unsigned long x);
330 	u32	(*set_apic_id)(unsigned int id);
331 
332 	/* wakeup_secondary_cpu */
333 	int	(*wakeup_secondary_cpu)(int apicid, unsigned long start_eip);
334 
335 	void	(*inquire_remote_apic)(int apicid);
336 
337 #ifdef CONFIG_X86_32
338 	/*
339 	 * Called very early during boot from get_smp_config().  It should
340 	 * return the logical apicid.  x86_[bios]_cpu_to_apicid is
341 	 * initialized before this function is called.
342 	 *
343 	 * If logical apicid can't be determined that early, the function
344 	 * may return BAD_APICID.  Logical apicid will be configured after
345 	 * init_apic_ldr() while bringing up CPUs.  Note that NUMA affinity
346 	 * won't be applied properly during early boot in this case.
347 	 */
348 	int (*x86_32_early_logical_apicid)(int cpu);
349 #endif
350 	char	*name;
351 };
352 
353 /*
354  * Pointer to the local APIC driver in use on this system (there's
355  * always just one such driver in use - the kernel decides via an
356  * early probing process which one it picks - and then sticks to it):
357  */
358 extern struct apic *apic;
359 
360 /*
361  * APIC drivers are probed based on how they are listed in the .apicdrivers
362  * section. So the order is important and enforced by the ordering
363  * of different apic driver files in the Makefile.
364  *
365  * For the files having two apic drivers, we use apic_drivers()
366  * to enforce the order with in them.
367  */
368 #define apic_driver(sym)					\
369 	static const struct apic *__apicdrivers_##sym __used		\
370 	__aligned(sizeof(struct apic *))			\
371 	__section(.apicdrivers) = { &sym }
372 
373 #define apic_drivers(sym1, sym2)					\
374 	static struct apic *__apicdrivers_##sym1##sym2[2] __used	\
375 	__aligned(sizeof(struct apic *))				\
376 	__section(.apicdrivers) = { &sym1, &sym2 }
377 
378 extern struct apic *__apicdrivers[], *__apicdrivers_end[];
379 
380 /*
381  * APIC functionality to boot other CPUs - only used on SMP:
382  */
383 #ifdef CONFIG_SMP
384 extern int wakeup_secondary_cpu_via_nmi(int apicid, unsigned long start_eip);
385 extern int lapic_can_unplug_cpu(void);
386 #endif
387 
388 #ifdef CONFIG_X86_LOCAL_APIC
389 
390 static inline u32 apic_read(u32 reg)
391 {
392 	return apic->read(reg);
393 }
394 
395 static inline void apic_write(u32 reg, u32 val)
396 {
397 	apic->write(reg, val);
398 }
399 
400 static inline void apic_eoi(void)
401 {
402 	apic->eoi_write(APIC_EOI, APIC_EOI_ACK);
403 }
404 
405 static inline u64 apic_icr_read(void)
406 {
407 	return apic->icr_read();
408 }
409 
410 static inline void apic_icr_write(u32 low, u32 high)
411 {
412 	apic->icr_write(low, high);
413 }
414 
415 static inline void apic_wait_icr_idle(void)
416 {
417 	apic->wait_icr_idle();
418 }
419 
420 static inline u32 safe_apic_wait_icr_idle(void)
421 {
422 	return apic->safe_wait_icr_idle();
423 }
424 
425 extern void __init apic_set_eoi_write(void (*eoi_write)(u32 reg, u32 v));
426 
427 #else /* CONFIG_X86_LOCAL_APIC */
428 
429 static inline u32 apic_read(u32 reg) { return 0; }
430 static inline void apic_write(u32 reg, u32 val) { }
431 static inline void apic_eoi(void) { }
432 static inline u64 apic_icr_read(void) { return 0; }
433 static inline void apic_icr_write(u32 low, u32 high) { }
434 static inline void apic_wait_icr_idle(void) { }
435 static inline u32 safe_apic_wait_icr_idle(void) { return 0; }
436 static inline void apic_set_eoi_write(void (*eoi_write)(u32 reg, u32 v)) {}
437 
438 #endif /* CONFIG_X86_LOCAL_APIC */
439 
440 extern void apic_ack_irq(struct irq_data *data);
441 
442 static inline void ack_APIC_irq(void)
443 {
444 	/*
445 	 * ack_APIC_irq() actually gets compiled as a single instruction
446 	 * ... yummie.
447 	 */
448 	apic_eoi();
449 }
450 
451 static inline unsigned default_get_apic_id(unsigned long x)
452 {
453 	unsigned int ver = GET_APIC_VERSION(apic_read(APIC_LVR));
454 
455 	if (APIC_XAPIC(ver) || boot_cpu_has(X86_FEATURE_EXTD_APICID))
456 		return (x >> 24) & 0xFF;
457 	else
458 		return (x >> 24) & 0x0F;
459 }
460 
461 /*
462  * Warm reset vector position:
463  */
464 #define TRAMPOLINE_PHYS_LOW		0x467
465 #define TRAMPOLINE_PHYS_HIGH		0x469
466 
467 #ifdef CONFIG_X86_64
468 extern void apic_send_IPI_self(int vector);
469 
470 DECLARE_PER_CPU(int, x2apic_extra_bits);
471 #endif
472 
473 extern void generic_bigsmp_probe(void);
474 
475 #ifdef CONFIG_X86_LOCAL_APIC
476 
477 #include <asm/smp.h>
478 
479 #define APIC_DFR_VALUE	(APIC_DFR_FLAT)
480 
481 DECLARE_EARLY_PER_CPU_READ_MOSTLY(u16, x86_bios_cpu_apicid);
482 
483 extern struct apic apic_noop;
484 
485 static inline unsigned int read_apic_id(void)
486 {
487 	unsigned int reg = apic_read(APIC_ID);
488 
489 	return apic->get_apic_id(reg);
490 }
491 
492 extern int default_apic_id_valid(u32 apicid);
493 extern int default_acpi_madt_oem_check(char *, char *);
494 extern void default_setup_apic_routing(void);
495 
496 extern u32 apic_default_calc_apicid(unsigned int cpu);
497 extern u32 apic_flat_calc_apicid(unsigned int cpu);
498 
499 extern bool default_check_apicid_used(physid_mask_t *map, int apicid);
500 extern void default_ioapic_phys_id_map(physid_mask_t *phys_map, physid_mask_t *retmap);
501 extern int default_cpu_present_to_apicid(int mps_cpu);
502 extern int default_check_phys_apicid_present(int phys_apicid);
503 
504 #endif /* CONFIG_X86_LOCAL_APIC */
505 
506 #ifdef CONFIG_SMP
507 bool apic_id_is_primary_thread(unsigned int id);
508 #else
509 static inline bool apic_id_is_primary_thread(unsigned int id) { return false; }
510 #endif
511 
512 extern void irq_enter(void);
513 extern void irq_exit(void);
514 
515 static inline void entering_irq(void)
516 {
517 	irq_enter();
518 	kvm_set_cpu_l1tf_flush_l1d();
519 }
520 
521 static inline void entering_ack_irq(void)
522 {
523 	entering_irq();
524 	ack_APIC_irq();
525 }
526 
527 static inline void ipi_entering_ack_irq(void)
528 {
529 	irq_enter();
530 	ack_APIC_irq();
531 	kvm_set_cpu_l1tf_flush_l1d();
532 }
533 
534 static inline void exiting_irq(void)
535 {
536 	irq_exit();
537 }
538 
539 static inline void exiting_ack_irq(void)
540 {
541 	ack_APIC_irq();
542 	irq_exit();
543 }
544 
545 extern void ioapic_zap_locks(void);
546 
547 #endif /* _ASM_X86_APIC_H */
548