xref: /openbmc/linux/arch/x86/include/asm/apic.h (revision 1ac322d0)
1 #ifndef _ASM_X86_APIC_H
2 #define _ASM_X86_APIC_H
3 
4 #include <linux/cpumask.h>
5 #include <linux/pm.h>
6 
7 #include <asm/alternative.h>
8 #include <asm/cpufeature.h>
9 #include <asm/processor.h>
10 #include <asm/apicdef.h>
11 #include <linux/atomic.h>
12 #include <asm/fixmap.h>
13 #include <asm/mpspec.h>
14 #include <asm/msr.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 /*
26  * Define the default level of output to be very little
27  * This can be turned up by using apic=verbose for more
28  * information and apic=debug for _lots_ of information.
29  * apic_verbosity is defined in apic.c
30  */
31 #define apic_printk(v, s, a...) do {       \
32 		if ((v) <= apic_verbosity) \
33 			printk(s, ##a);    \
34 	} while (0)
35 
36 
37 #if defined(CONFIG_X86_LOCAL_APIC) && defined(CONFIG_X86_32)
38 extern void generic_apic_probe(void);
39 #else
40 static inline void generic_apic_probe(void)
41 {
42 }
43 #endif
44 
45 #ifdef CONFIG_X86_LOCAL_APIC
46 
47 extern unsigned int apic_verbosity;
48 extern int local_apic_timer_c2_ok;
49 
50 extern int disable_apic;
51 extern unsigned int lapic_timer_frequency;
52 
53 #ifdef CONFIG_SMP
54 extern void __inquire_remote_apic(int apicid);
55 #else /* CONFIG_SMP */
56 static inline void __inquire_remote_apic(int apicid)
57 {
58 }
59 #endif /* CONFIG_SMP */
60 
61 static inline void default_inquire_remote_apic(int apicid)
62 {
63 	if (apic_verbosity >= APIC_DEBUG)
64 		__inquire_remote_apic(apicid);
65 }
66 
67 /*
68  * With 82489DX we can't rely on apic feature bit
69  * retrieved via cpuid but still have to deal with
70  * such an apic chip so we assume that SMP configuration
71  * is found from MP table (64bit case uses ACPI mostly
72  * which set smp presence flag as well so we are safe
73  * to use this helper too).
74  */
75 static inline bool apic_from_smp_config(void)
76 {
77 	return smp_found_config && !disable_apic;
78 }
79 
80 /*
81  * Basic functions accessing APICs.
82  */
83 #ifdef CONFIG_PARAVIRT
84 #include <asm/paravirt.h>
85 #endif
86 
87 #ifdef CONFIG_X86_64
88 extern int is_vsmp_box(void);
89 #else
90 static inline int is_vsmp_box(void)
91 {
92 	return 0;
93 }
94 #endif
95 extern void xapic_wait_icr_idle(void);
96 extern u32 safe_xapic_wait_icr_idle(void);
97 extern void xapic_icr_write(u32, u32);
98 extern int setup_profiling_timer(unsigned int);
99 
100 static inline void native_apic_mem_write(u32 reg, u32 v)
101 {
102 	volatile u32 *addr = (volatile u32 *)(APIC_BASE + reg);
103 
104 	alternative_io("movl %0, %1", "xchgl %0, %1", X86_FEATURE_11AP,
105 		       ASM_OUTPUT2("=r" (v), "=m" (*addr)),
106 		       ASM_OUTPUT2("0" (v), "m" (*addr)));
107 }
108 
109 static inline u32 native_apic_mem_read(u32 reg)
110 {
111 	return *((volatile u32 *)(APIC_BASE + reg));
112 }
113 
114 extern void native_apic_wait_icr_idle(void);
115 extern u32 native_safe_apic_wait_icr_idle(void);
116 extern void native_apic_icr_write(u32 low, u32 id);
117 extern u64 native_apic_icr_read(void);
118 
119 extern int x2apic_mode;
120 
121 #ifdef CONFIG_X86_X2APIC
122 /*
123  * Make previous memory operations globally visible before
124  * sending the IPI through x2apic wrmsr. We need a serializing instruction or
125  * mfence for this.
126  */
127 static inline void x2apic_wrmsr_fence(void)
128 {
129 	asm volatile("mfence" : : : "memory");
130 }
131 
132 static inline void native_apic_msr_write(u32 reg, u32 v)
133 {
134 	if (reg == APIC_DFR || reg == APIC_ID || reg == APIC_LDR ||
135 	    reg == APIC_LVR)
136 		return;
137 
138 	wrmsr(APIC_BASE_MSR + (reg >> 4), v, 0);
139 }
140 
141 static inline void native_apic_msr_eoi_write(u32 reg, u32 v)
142 {
143 	wrmsr(APIC_BASE_MSR + (APIC_EOI >> 4), APIC_EOI_ACK, 0);
144 }
145 
146 static inline u32 native_apic_msr_read(u32 reg)
147 {
148 	u64 msr;
149 
150 	if (reg == APIC_DFR)
151 		return -1;
152 
153 	rdmsrl(APIC_BASE_MSR + (reg >> 4), msr);
154 	return (u32)msr;
155 }
156 
157 static inline void native_x2apic_wait_icr_idle(void)
158 {
159 	/* no need to wait for icr idle in x2apic */
160 	return;
161 }
162 
163 static inline u32 native_safe_x2apic_wait_icr_idle(void)
164 {
165 	/* no need to wait for icr idle in x2apic */
166 	return 0;
167 }
168 
169 static inline void native_x2apic_icr_write(u32 low, u32 id)
170 {
171 	wrmsrl(APIC_BASE_MSR + (APIC_ICR >> 4), ((__u64) id) << 32 | low);
172 }
173 
174 static inline u64 native_x2apic_icr_read(void)
175 {
176 	unsigned long val;
177 
178 	rdmsrl(APIC_BASE_MSR + (APIC_ICR >> 4), val);
179 	return val;
180 }
181 
182 extern int x2apic_phys;
183 extern int x2apic_preenabled;
184 extern void check_x2apic(void);
185 extern void enable_x2apic(void);
186 extern void x2apic_icr_write(u32 low, u32 id);
187 static inline int x2apic_enabled(void)
188 {
189 	u64 msr;
190 
191 	if (!cpu_has_x2apic)
192 		return 0;
193 
194 	rdmsrl(MSR_IA32_APICBASE, msr);
195 	if (msr & X2APIC_ENABLE)
196 		return 1;
197 	return 0;
198 }
199 
200 #define x2apic_supported()	(cpu_has_x2apic)
201 static inline void x2apic_force_phys(void)
202 {
203 	x2apic_phys = 1;
204 }
205 #else
206 static inline void disable_x2apic(void)
207 {
208 }
209 static inline void check_x2apic(void)
210 {
211 }
212 static inline void enable_x2apic(void)
213 {
214 }
215 static inline int x2apic_enabled(void)
216 {
217 	return 0;
218 }
219 static inline void x2apic_force_phys(void)
220 {
221 }
222 
223 #define	nox2apic	0
224 #define	x2apic_preenabled 0
225 #define	x2apic_supported()	0
226 #endif
227 
228 extern void enable_IR_x2apic(void);
229 
230 extern int get_physical_broadcast(void);
231 
232 extern int lapic_get_maxlvt(void);
233 extern void clear_local_APIC(void);
234 extern void connect_bsp_APIC(void);
235 extern void disconnect_bsp_APIC(int virt_wire_setup);
236 extern void disable_local_APIC(void);
237 extern void lapic_shutdown(void);
238 extern int verify_local_APIC(void);
239 extern void sync_Arb_IDs(void);
240 extern void init_bsp_APIC(void);
241 extern void setup_local_APIC(void);
242 extern void end_local_APIC_setup(void);
243 extern void bsp_end_local_APIC_setup(void);
244 extern void init_apic_mappings(void);
245 void register_lapic_address(unsigned long address);
246 extern void setup_boot_APIC_clock(void);
247 extern void setup_secondary_APIC_clock(void);
248 extern int APIC_init_uniprocessor(void);
249 extern int apic_force_enable(unsigned long addr);
250 
251 /*
252  * On 32bit this is mach-xxx local
253  */
254 #ifdef CONFIG_X86_64
255 extern int apic_is_clustered_box(void);
256 #else
257 static inline int apic_is_clustered_box(void)
258 {
259 	return 0;
260 }
261 #endif
262 
263 extern int setup_APIC_eilvt(u8 lvt_off, u8 vector, u8 msg_type, u8 mask);
264 
265 #else /* !CONFIG_X86_LOCAL_APIC */
266 static inline void lapic_shutdown(void) { }
267 #define local_apic_timer_c2_ok		1
268 static inline void init_apic_mappings(void) { }
269 static inline void disable_local_APIC(void) { }
270 # define setup_boot_APIC_clock x86_init_noop
271 # define setup_secondary_APIC_clock x86_init_noop
272 #endif /* !CONFIG_X86_LOCAL_APIC */
273 
274 #ifdef CONFIG_X86_64
275 #define	SET_APIC_ID(x)		(apic->set_apic_id(x))
276 #else
277 
278 #endif
279 
280 /*
281  * Copyright 2004 James Cleverdon, IBM.
282  * Subject to the GNU Public License, v.2
283  *
284  * Generic APIC sub-arch data struct.
285  *
286  * Hacked for x86-64 by James Cleverdon from i386 architecture code by
287  * Martin Bligh, Andi Kleen, James Bottomley, John Stultz, and
288  * James Cleverdon.
289  */
290 struct apic {
291 	char *name;
292 
293 	int (*probe)(void);
294 	int (*acpi_madt_oem_check)(char *oem_id, char *oem_table_id);
295 	int (*apic_id_valid)(int apicid);
296 	int (*apic_id_registered)(void);
297 
298 	u32 irq_delivery_mode;
299 	u32 irq_dest_mode;
300 
301 	const struct cpumask *(*target_cpus)(void);
302 
303 	int disable_esr;
304 
305 	int dest_logical;
306 	unsigned long (*check_apicid_used)(physid_mask_t *map, int apicid);
307 	unsigned long (*check_apicid_present)(int apicid);
308 
309 	void (*vector_allocation_domain)(int cpu, struct cpumask *retmask,
310 					 const struct cpumask *mask);
311 	void (*init_apic_ldr)(void);
312 
313 	void (*ioapic_phys_id_map)(physid_mask_t *phys_map, physid_mask_t *retmap);
314 
315 	void (*setup_apic_routing)(void);
316 	int (*multi_timer_check)(int apic, int irq);
317 	int (*cpu_present_to_apicid)(int mps_cpu);
318 	void (*apicid_to_cpu_present)(int phys_apicid, physid_mask_t *retmap);
319 	void (*setup_portio_remap)(void);
320 	int (*check_phys_apicid_present)(int phys_apicid);
321 	void (*enable_apic_mode)(void);
322 	int (*phys_pkg_id)(int cpuid_apic, int index_msb);
323 
324 	/*
325 	 * When one of the next two hooks returns 1 the apic
326 	 * is switched to this. Essentially they are additional
327 	 * probe functions:
328 	 */
329 	int (*mps_oem_check)(struct mpc_table *mpc, char *oem, char *productid);
330 
331 	unsigned int (*get_apic_id)(unsigned long x);
332 	unsigned long (*set_apic_id)(unsigned int id);
333 	unsigned long apic_id_mask;
334 
335 	int (*cpu_mask_to_apicid_and)(const struct cpumask *cpumask,
336 				      const struct cpumask *andmask,
337 				      unsigned int *apicid);
338 
339 	/* ipi */
340 	void (*send_IPI_mask)(const struct cpumask *mask, int vector);
341 	void (*send_IPI_mask_allbutself)(const struct cpumask *mask,
342 					 int vector);
343 	void (*send_IPI_allbutself)(int vector);
344 	void (*send_IPI_all)(int vector);
345 	void (*send_IPI_self)(int vector);
346 
347 	/* wakeup_secondary_cpu */
348 	int (*wakeup_secondary_cpu)(int apicid, unsigned long start_eip);
349 
350 	int trampoline_phys_low;
351 	int trampoline_phys_high;
352 
353 	void (*wait_for_init_deassert)(atomic_t *deassert);
354 	void (*smp_callin_clear_local_apic)(void);
355 	void (*inquire_remote_apic)(int apicid);
356 
357 	/* apic ops */
358 	u32 (*read)(u32 reg);
359 	void (*write)(u32 reg, u32 v);
360 	/*
361 	 * ->eoi_write() has the same signature as ->write().
362 	 *
363 	 * Drivers can support both ->eoi_write() and ->write() by passing the same
364 	 * callback value. Kernel can override ->eoi_write() and fall back
365 	 * on write for EOI.
366 	 */
367 	void (*eoi_write)(u32 reg, u32 v);
368 	u64 (*icr_read)(void);
369 	void (*icr_write)(u32 low, u32 high);
370 	void (*wait_icr_idle)(void);
371 	u32 (*safe_wait_icr_idle)(void);
372 
373 #ifdef CONFIG_X86_32
374 	/*
375 	 * Called very early during boot from get_smp_config().  It should
376 	 * return the logical apicid.  x86_[bios]_cpu_to_apicid is
377 	 * initialized before this function is called.
378 	 *
379 	 * If logical apicid can't be determined that early, the function
380 	 * may return BAD_APICID.  Logical apicid will be configured after
381 	 * init_apic_ldr() while bringing up CPUs.  Note that NUMA affinity
382 	 * won't be applied properly during early boot in this case.
383 	 */
384 	int (*x86_32_early_logical_apicid)(int cpu);
385 
386 	/*
387 	 * Optional method called from setup_local_APIC() after logical
388 	 * apicid is guaranteed to be known to initialize apicid -> node
389 	 * mapping if NUMA initialization hasn't done so already.  Don't
390 	 * add new users.
391 	 */
392 	int (*x86_32_numa_cpu_node)(int cpu);
393 #endif
394 };
395 
396 /*
397  * Pointer to the local APIC driver in use on this system (there's
398  * always just one such driver in use - the kernel decides via an
399  * early probing process which one it picks - and then sticks to it):
400  */
401 extern struct apic *apic;
402 
403 /*
404  * APIC drivers are probed based on how they are listed in the .apicdrivers
405  * section. So the order is important and enforced by the ordering
406  * of different apic driver files in the Makefile.
407  *
408  * For the files having two apic drivers, we use apic_drivers()
409  * to enforce the order with in them.
410  */
411 #define apic_driver(sym)					\
412 	static struct apic *__apicdrivers_##sym __used		\
413 	__aligned(sizeof(struct apic *))			\
414 	__section(.apicdrivers) = { &sym }
415 
416 #define apic_drivers(sym1, sym2)					\
417 	static struct apic *__apicdrivers_##sym1##sym2[2] __used	\
418 	__aligned(sizeof(struct apic *))				\
419 	__section(.apicdrivers) = { &sym1, &sym2 }
420 
421 extern struct apic *__apicdrivers[], *__apicdrivers_end[];
422 
423 /*
424  * APIC functionality to boot other CPUs - only used on SMP:
425  */
426 #ifdef CONFIG_SMP
427 extern atomic_t init_deasserted;
428 extern int wakeup_secondary_cpu_via_nmi(int apicid, unsigned long start_eip);
429 #endif
430 
431 #ifdef CONFIG_X86_LOCAL_APIC
432 
433 static inline u32 apic_read(u32 reg)
434 {
435 	return apic->read(reg);
436 }
437 
438 static inline void apic_write(u32 reg, u32 val)
439 {
440 	apic->write(reg, val);
441 }
442 
443 static inline void apic_eoi(void)
444 {
445 	apic->eoi_write(APIC_EOI, APIC_EOI_ACK);
446 }
447 
448 static inline u64 apic_icr_read(void)
449 {
450 	return apic->icr_read();
451 }
452 
453 static inline void apic_icr_write(u32 low, u32 high)
454 {
455 	apic->icr_write(low, high);
456 }
457 
458 static inline void apic_wait_icr_idle(void)
459 {
460 	apic->wait_icr_idle();
461 }
462 
463 static inline u32 safe_apic_wait_icr_idle(void)
464 {
465 	return apic->safe_wait_icr_idle();
466 }
467 
468 #else /* CONFIG_X86_LOCAL_APIC */
469 
470 static inline u32 apic_read(u32 reg) { return 0; }
471 static inline void apic_write(u32 reg, u32 val) { }
472 static inline void apic_eoi(void) { }
473 static inline u64 apic_icr_read(void) { return 0; }
474 static inline void apic_icr_write(u32 low, u32 high) { }
475 static inline void apic_wait_icr_idle(void) { }
476 static inline u32 safe_apic_wait_icr_idle(void) { return 0; }
477 
478 #endif /* CONFIG_X86_LOCAL_APIC */
479 
480 static inline void ack_APIC_irq(void)
481 {
482 	/*
483 	 * ack_APIC_irq() actually gets compiled as a single instruction
484 	 * ... yummie.
485 	 */
486 	apic_eoi();
487 }
488 
489 static inline unsigned default_get_apic_id(unsigned long x)
490 {
491 	unsigned int ver = GET_APIC_VERSION(apic_read(APIC_LVR));
492 
493 	if (APIC_XAPIC(ver) || boot_cpu_has(X86_FEATURE_EXTD_APICID))
494 		return (x >> 24) & 0xFF;
495 	else
496 		return (x >> 24) & 0x0F;
497 }
498 
499 /*
500  * Warm reset vector default position:
501  */
502 #define DEFAULT_TRAMPOLINE_PHYS_LOW		0x467
503 #define DEFAULT_TRAMPOLINE_PHYS_HIGH		0x469
504 
505 #ifdef CONFIG_X86_64
506 extern int default_acpi_madt_oem_check(char *, char *);
507 
508 extern void apic_send_IPI_self(int vector);
509 
510 DECLARE_PER_CPU(int, x2apic_extra_bits);
511 
512 extern int default_cpu_present_to_apicid(int mps_cpu);
513 extern int default_check_phys_apicid_present(int phys_apicid);
514 #endif
515 
516 static inline void default_wait_for_init_deassert(atomic_t *deassert)
517 {
518 	while (!atomic_read(deassert))
519 		cpu_relax();
520 	return;
521 }
522 
523 extern void generic_bigsmp_probe(void);
524 
525 
526 #ifdef CONFIG_X86_LOCAL_APIC
527 
528 #include <asm/smp.h>
529 
530 #define APIC_DFR_VALUE	(APIC_DFR_FLAT)
531 
532 static inline const struct cpumask *default_target_cpus(void)
533 {
534 #ifdef CONFIG_SMP
535 	return cpu_online_mask;
536 #else
537 	return cpumask_of(0);
538 #endif
539 }
540 
541 static inline const struct cpumask *online_target_cpus(void)
542 {
543 	return cpu_online_mask;
544 }
545 
546 DECLARE_EARLY_PER_CPU(u16, x86_bios_cpu_apicid);
547 
548 
549 static inline unsigned int read_apic_id(void)
550 {
551 	unsigned int reg;
552 
553 	reg = apic_read(APIC_ID);
554 
555 	return apic->get_apic_id(reg);
556 }
557 
558 static inline int default_apic_id_valid(int apicid)
559 {
560 	return (apicid < 255);
561 }
562 
563 extern void default_setup_apic_routing(void);
564 
565 extern struct apic apic_noop;
566 
567 #ifdef CONFIG_X86_32
568 
569 static inline int noop_x86_32_early_logical_apicid(int cpu)
570 {
571 	return BAD_APICID;
572 }
573 
574 /*
575  * Set up the logical destination ID.
576  *
577  * Intel recommends to set DFR, LDR and TPR before enabling
578  * an APIC.  See e.g. "AP-388 82489DX User's Manual" (Intel
579  * document number 292116).  So here it goes...
580  */
581 extern void default_init_apic_ldr(void);
582 
583 static inline int default_apic_id_registered(void)
584 {
585 	return physid_isset(read_apic_id(), phys_cpu_present_map);
586 }
587 
588 static inline int default_phys_pkg_id(int cpuid_apic, int index_msb)
589 {
590 	return cpuid_apic >> index_msb;
591 }
592 
593 #endif
594 
595 static inline int
596 flat_cpu_mask_to_apicid_and(const struct cpumask *cpumask,
597 			    const struct cpumask *andmask,
598 			    unsigned int *apicid)
599 {
600 	unsigned long cpu_mask = cpumask_bits(cpumask)[0] &
601 				 cpumask_bits(andmask)[0] &
602 				 cpumask_bits(cpu_online_mask)[0] &
603 				 APIC_ALL_CPUS;
604 
605 	if (likely(cpu_mask)) {
606 		*apicid = (unsigned int)cpu_mask;
607 		return 0;
608 	} else {
609 		return -EINVAL;
610 	}
611 }
612 
613 extern int
614 default_cpu_mask_to_apicid_and(const struct cpumask *cpumask,
615 			       const struct cpumask *andmask,
616 			       unsigned int *apicid);
617 
618 static inline void
619 flat_vector_allocation_domain(int cpu, struct cpumask *retmask,
620 			      const struct cpumask *mask)
621 {
622 	/* Careful. Some cpus do not strictly honor the set of cpus
623 	 * specified in the interrupt destination when using lowest
624 	 * priority interrupt delivery mode.
625 	 *
626 	 * In particular there was a hyperthreading cpu observed to
627 	 * deliver interrupts to the wrong hyperthread when only one
628 	 * hyperthread was specified in the interrupt desitination.
629 	 */
630 	cpumask_clear(retmask);
631 	cpumask_bits(retmask)[0] = APIC_ALL_CPUS;
632 }
633 
634 static inline void
635 default_vector_allocation_domain(int cpu, struct cpumask *retmask,
636 				 const struct cpumask *mask)
637 {
638 	cpumask_copy(retmask, cpumask_of(cpu));
639 }
640 
641 static inline unsigned long default_check_apicid_used(physid_mask_t *map, int apicid)
642 {
643 	return physid_isset(apicid, *map);
644 }
645 
646 static inline unsigned long default_check_apicid_present(int bit)
647 {
648 	return physid_isset(bit, phys_cpu_present_map);
649 }
650 
651 static inline void default_ioapic_phys_id_map(physid_mask_t *phys_map, physid_mask_t *retmap)
652 {
653 	*retmap = *phys_map;
654 }
655 
656 static inline int __default_cpu_present_to_apicid(int mps_cpu)
657 {
658 	if (mps_cpu < nr_cpu_ids && cpu_present(mps_cpu))
659 		return (int)per_cpu(x86_bios_cpu_apicid, mps_cpu);
660 	else
661 		return BAD_APICID;
662 }
663 
664 static inline int
665 __default_check_phys_apicid_present(int phys_apicid)
666 {
667 	return physid_isset(phys_apicid, phys_cpu_present_map);
668 }
669 
670 #ifdef CONFIG_X86_32
671 static inline int default_cpu_present_to_apicid(int mps_cpu)
672 {
673 	return __default_cpu_present_to_apicid(mps_cpu);
674 }
675 
676 static inline int
677 default_check_phys_apicid_present(int phys_apicid)
678 {
679 	return __default_check_phys_apicid_present(phys_apicid);
680 }
681 #else
682 extern int default_cpu_present_to_apicid(int mps_cpu);
683 extern int default_check_phys_apicid_present(int phys_apicid);
684 #endif
685 
686 #endif /* CONFIG_X86_LOCAL_APIC */
687 
688 #endif /* _ASM_X86_APIC_H */
689