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