xref: /openbmc/linux/arch/x86/include/asm/apic.h (revision 25874a29)
1 #ifndef _ASM_X86_APIC_H
2 #define _ASM_X86_APIC_H
3 
4 #include <linux/cpumask.h>
5 #include <linux/delay.h>
6 #include <linux/pm.h>
7 
8 #include <asm/alternative.h>
9 #include <asm/cpufeature.h>
10 #include <asm/processor.h>
11 #include <asm/apicdef.h>
12 #include <asm/atomic.h>
13 #include <asm/fixmap.h>
14 #include <asm/mpspec.h>
15 #include <asm/system.h>
16 #include <asm/msr.h>
17 
18 #define ARCH_APICTIMER_STOPS_ON_C3	1
19 
20 /*
21  * Debugging macros
22  */
23 #define APIC_QUIET   0
24 #define APIC_VERBOSE 1
25 #define APIC_DEBUG   2
26 
27 /*
28  * Define the default level of output to be very little
29  * This can be turned up by using apic=verbose for more
30  * information and apic=debug for _lots_ of information.
31  * apic_verbosity is defined in apic.c
32  */
33 #define apic_printk(v, s, a...) do {       \
34 		if ((v) <= apic_verbosity) \
35 			printk(s, ##a);    \
36 	} while (0)
37 
38 
39 #if defined(CONFIG_X86_LOCAL_APIC) && defined(CONFIG_X86_32)
40 extern void generic_apic_probe(void);
41 #else
42 static inline void generic_apic_probe(void)
43 {
44 }
45 #endif
46 
47 #ifdef CONFIG_X86_LOCAL_APIC
48 
49 extern unsigned int apic_verbosity;
50 extern int local_apic_timer_c2_ok;
51 
52 extern int disable_apic;
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 void check_x2apic(void);
180 extern void enable_x2apic(void);
181 extern void x2apic_icr_write(u32 low, u32 id);
182 static inline int x2apic_enabled(void)
183 {
184 	u64 msr;
185 
186 	if (!cpu_has_x2apic)
187 		return 0;
188 
189 	rdmsrl(MSR_IA32_APICBASE, msr);
190 	if (msr & X2APIC_ENABLE)
191 		return 1;
192 	return 0;
193 }
194 
195 #define x2apic_supported()	(cpu_has_x2apic)
196 static inline void x2apic_force_phys(void)
197 {
198 	x2apic_phys = 1;
199 }
200 #else
201 static inline void check_x2apic(void)
202 {
203 }
204 static inline void enable_x2apic(void)
205 {
206 }
207 static inline int x2apic_enabled(void)
208 {
209 	return 0;
210 }
211 static inline void x2apic_force_phys(void)
212 {
213 }
214 
215 #define	x2apic_preenabled 0
216 #define	x2apic_supported()	0
217 #endif
218 
219 extern void enable_IR_x2apic(void);
220 
221 extern int get_physical_broadcast(void);
222 
223 extern int lapic_get_maxlvt(void);
224 extern void clear_local_APIC(void);
225 extern void connect_bsp_APIC(void);
226 extern void disconnect_bsp_APIC(int virt_wire_setup);
227 extern void disable_local_APIC(void);
228 extern void lapic_shutdown(void);
229 extern int verify_local_APIC(void);
230 extern void sync_Arb_IDs(void);
231 extern void init_bsp_APIC(void);
232 extern void setup_local_APIC(void);
233 extern void end_local_APIC_setup(void);
234 extern void bsp_end_local_APIC_setup(void);
235 extern void init_apic_mappings(void);
236 void register_lapic_address(unsigned long address);
237 extern void setup_boot_APIC_clock(void);
238 extern void setup_secondary_APIC_clock(void);
239 extern int APIC_init_uniprocessor(void);
240 extern int apic_force_enable(unsigned long addr);
241 
242 /*
243  * On 32bit this is mach-xxx local
244  */
245 #ifdef CONFIG_X86_64
246 extern int apic_is_clustered_box(void);
247 #else
248 static inline int apic_is_clustered_box(void)
249 {
250 	return 0;
251 }
252 #endif
253 
254 extern int setup_APIC_eilvt(u8 lvt_off, u8 vector, u8 msg_type, u8 mask);
255 
256 #else /* !CONFIG_X86_LOCAL_APIC */
257 static inline void lapic_shutdown(void) { }
258 #define local_apic_timer_c2_ok		1
259 static inline void init_apic_mappings(void) { }
260 static inline void disable_local_APIC(void) { }
261 # define setup_boot_APIC_clock x86_init_noop
262 # define setup_secondary_APIC_clock x86_init_noop
263 #endif /* !CONFIG_X86_LOCAL_APIC */
264 
265 #ifdef CONFIG_X86_64
266 #define	SET_APIC_ID(x)		(apic->set_apic_id(x))
267 #else
268 
269 #endif
270 
271 /*
272  * Copyright 2004 James Cleverdon, IBM.
273  * Subject to the GNU Public License, v.2
274  *
275  * Generic APIC sub-arch data struct.
276  *
277  * Hacked for x86-64 by James Cleverdon from i386 architecture code by
278  * Martin Bligh, Andi Kleen, James Bottomley, John Stultz, and
279  * James Cleverdon.
280  */
281 struct apic {
282 	char *name;
283 
284 	int (*probe)(void);
285 	int (*acpi_madt_oem_check)(char *oem_id, char *oem_table_id);
286 	int (*apic_id_registered)(void);
287 
288 	u32 irq_delivery_mode;
289 	u32 irq_dest_mode;
290 
291 	const struct cpumask *(*target_cpus)(void);
292 
293 	int disable_esr;
294 
295 	int dest_logical;
296 	unsigned long (*check_apicid_used)(physid_mask_t *map, int apicid);
297 	unsigned long (*check_apicid_present)(int apicid);
298 
299 	void (*vector_allocation_domain)(int cpu, struct cpumask *retmask);
300 	void (*init_apic_ldr)(void);
301 
302 	void (*ioapic_phys_id_map)(physid_mask_t *phys_map, physid_mask_t *retmap);
303 
304 	void (*setup_apic_routing)(void);
305 	int (*multi_timer_check)(int apic, int irq);
306 	int (*apicid_to_node)(int logical_apicid);
307 	int (*cpu_to_logical_apicid)(int cpu);
308 	int (*cpu_present_to_apicid)(int mps_cpu);
309 	void (*apicid_to_cpu_present)(int phys_apicid, physid_mask_t *retmap);
310 	void (*setup_portio_remap)(void);
311 	int (*check_phys_apicid_present)(int phys_apicid);
312 	void (*enable_apic_mode)(void);
313 	int (*phys_pkg_id)(int cpuid_apic, int index_msb);
314 
315 	/*
316 	 * When one of the next two hooks returns 1 the apic
317 	 * is switched to this. Essentially they are additional
318 	 * probe functions:
319 	 */
320 	int (*mps_oem_check)(struct mpc_table *mpc, char *oem, char *productid);
321 
322 	unsigned int (*get_apic_id)(unsigned long x);
323 	unsigned long (*set_apic_id)(unsigned int id);
324 	unsigned long apic_id_mask;
325 
326 	unsigned int (*cpu_mask_to_apicid)(const struct cpumask *cpumask);
327 	unsigned int (*cpu_mask_to_apicid_and)(const struct cpumask *cpumask,
328 					       const struct cpumask *andmask);
329 
330 	/* ipi */
331 	void (*send_IPI_mask)(const struct cpumask *mask, int vector);
332 	void (*send_IPI_mask_allbutself)(const struct cpumask *mask,
333 					 int vector);
334 	void (*send_IPI_allbutself)(int vector);
335 	void (*send_IPI_all)(int vector);
336 	void (*send_IPI_self)(int vector);
337 
338 	/* wakeup_secondary_cpu */
339 	int (*wakeup_secondary_cpu)(int apicid, unsigned long start_eip);
340 
341 	int trampoline_phys_low;
342 	int trampoline_phys_high;
343 
344 	void (*wait_for_init_deassert)(atomic_t *deassert);
345 	void (*smp_callin_clear_local_apic)(void);
346 	void (*inquire_remote_apic)(int apicid);
347 
348 	/* apic ops */
349 	u32 (*read)(u32 reg);
350 	void (*write)(u32 reg, u32 v);
351 	u64 (*icr_read)(void);
352 	void (*icr_write)(u32 low, u32 high);
353 	void (*wait_icr_idle)(void);
354 	u32 (*safe_wait_icr_idle)(void);
355 };
356 
357 /*
358  * Pointer to the local APIC driver in use on this system (there's
359  * always just one such driver in use - the kernel decides via an
360  * early probing process which one it picks - and then sticks to it):
361  */
362 extern struct apic *apic;
363 
364 /*
365  * APIC functionality to boot other CPUs - only used on SMP:
366  */
367 #ifdef CONFIG_SMP
368 extern atomic_t init_deasserted;
369 extern int wakeup_secondary_cpu_via_nmi(int apicid, unsigned long start_eip);
370 #endif
371 
372 #ifdef CONFIG_X86_LOCAL_APIC
373 static inline u32 apic_read(u32 reg)
374 {
375 	return apic->read(reg);
376 }
377 
378 static inline void apic_write(u32 reg, u32 val)
379 {
380 	apic->write(reg, val);
381 }
382 
383 static inline u64 apic_icr_read(void)
384 {
385 	return apic->icr_read();
386 }
387 
388 static inline void apic_icr_write(u32 low, u32 high)
389 {
390 	apic->icr_write(low, high);
391 }
392 
393 static inline void apic_wait_icr_idle(void)
394 {
395 	apic->wait_icr_idle();
396 }
397 
398 static inline u32 safe_apic_wait_icr_idle(void)
399 {
400 	return apic->safe_wait_icr_idle();
401 }
402 
403 #else /* CONFIG_X86_LOCAL_APIC */
404 
405 static inline u32 apic_read(u32 reg) { return 0; }
406 static inline void apic_write(u32 reg, u32 val) { }
407 static inline u64 apic_icr_read(void) { return 0; }
408 static inline void apic_icr_write(u32 low, u32 high) { }
409 static inline void apic_wait_icr_idle(void) { }
410 static inline u32 safe_apic_wait_icr_idle(void) { return 0; }
411 
412 #endif /* CONFIG_X86_LOCAL_APIC */
413 
414 static inline void ack_APIC_irq(void)
415 {
416 	/*
417 	 * ack_APIC_irq() actually gets compiled as a single instruction
418 	 * ... yummie.
419 	 */
420 
421 	/* Docs say use 0 for future compatibility */
422 	apic_write(APIC_EOI, 0);
423 }
424 
425 static inline unsigned default_get_apic_id(unsigned long x)
426 {
427 	unsigned int ver = GET_APIC_VERSION(apic_read(APIC_LVR));
428 
429 	if (APIC_XAPIC(ver) || boot_cpu_has(X86_FEATURE_EXTD_APICID))
430 		return (x >> 24) & 0xFF;
431 	else
432 		return (x >> 24) & 0x0F;
433 }
434 
435 /*
436  * Warm reset vector default position:
437  */
438 #define DEFAULT_TRAMPOLINE_PHYS_LOW		0x467
439 #define DEFAULT_TRAMPOLINE_PHYS_HIGH		0x469
440 
441 #ifdef CONFIG_X86_64
442 extern struct apic apic_flat;
443 extern struct apic apic_physflat;
444 extern struct apic apic_x2apic_cluster;
445 extern struct apic apic_x2apic_phys;
446 extern int default_acpi_madt_oem_check(char *, char *);
447 
448 extern void apic_send_IPI_self(int vector);
449 
450 extern struct apic apic_x2apic_uv_x;
451 DECLARE_PER_CPU(int, x2apic_extra_bits);
452 
453 extern int default_cpu_present_to_apicid(int mps_cpu);
454 extern int default_check_phys_apicid_present(int phys_apicid);
455 #endif
456 
457 static inline void default_wait_for_init_deassert(atomic_t *deassert)
458 {
459 	while (!atomic_read(deassert))
460 		cpu_relax();
461 	return;
462 }
463 
464 extern void generic_bigsmp_probe(void);
465 
466 
467 #ifdef CONFIG_X86_LOCAL_APIC
468 
469 #include <asm/smp.h>
470 
471 #define APIC_DFR_VALUE	(APIC_DFR_FLAT)
472 
473 static inline const struct cpumask *default_target_cpus(void)
474 {
475 #ifdef CONFIG_SMP
476 	return cpu_online_mask;
477 #else
478 	return cpumask_of(0);
479 #endif
480 }
481 
482 DECLARE_EARLY_PER_CPU(u16, x86_bios_cpu_apicid);
483 
484 
485 static inline unsigned int read_apic_id(void)
486 {
487 	unsigned int reg;
488 
489 	reg = apic_read(APIC_ID);
490 
491 	return apic->get_apic_id(reg);
492 }
493 
494 extern void default_setup_apic_routing(void);
495 
496 extern struct apic apic_noop;
497 
498 #ifdef CONFIG_X86_32
499 
500 extern struct apic apic_default;
501 
502 /*
503  * Set up the logical destination ID.
504  *
505  * Intel recommends to set DFR, LDR and TPR before enabling
506  * an APIC.  See e.g. "AP-388 82489DX User's Manual" (Intel
507  * document number 292116).  So here it goes...
508  */
509 extern void default_init_apic_ldr(void);
510 
511 static inline int default_apic_id_registered(void)
512 {
513 	return physid_isset(read_apic_id(), phys_cpu_present_map);
514 }
515 
516 static inline int default_phys_pkg_id(int cpuid_apic, int index_msb)
517 {
518 	return cpuid_apic >> index_msb;
519 }
520 
521 extern int default_apicid_to_node(int logical_apicid);
522 
523 #endif
524 
525 static inline unsigned int
526 default_cpu_mask_to_apicid(const struct cpumask *cpumask)
527 {
528 	return cpumask_bits(cpumask)[0] & APIC_ALL_CPUS;
529 }
530 
531 static inline unsigned int
532 default_cpu_mask_to_apicid_and(const struct cpumask *cpumask,
533 			       const struct cpumask *andmask)
534 {
535 	unsigned long mask1 = cpumask_bits(cpumask)[0];
536 	unsigned long mask2 = cpumask_bits(andmask)[0];
537 	unsigned long mask3 = cpumask_bits(cpu_online_mask)[0];
538 
539 	return (unsigned int)(mask1 & mask2 & mask3);
540 }
541 
542 static inline unsigned long default_check_apicid_used(physid_mask_t *map, int apicid)
543 {
544 	return physid_isset(apicid, *map);
545 }
546 
547 static inline unsigned long default_check_apicid_present(int bit)
548 {
549 	return physid_isset(bit, phys_cpu_present_map);
550 }
551 
552 static inline void default_ioapic_phys_id_map(physid_mask_t *phys_map, physid_mask_t *retmap)
553 {
554 	*retmap = *phys_map;
555 }
556 
557 /* Mapping from cpu number to logical apicid */
558 static inline int default_cpu_to_logical_apicid(int cpu)
559 {
560 	return 1 << cpu;
561 }
562 
563 static inline int __default_cpu_present_to_apicid(int mps_cpu)
564 {
565 	if (mps_cpu < nr_cpu_ids && cpu_present(mps_cpu))
566 		return (int)per_cpu(x86_bios_cpu_apicid, mps_cpu);
567 	else
568 		return BAD_APICID;
569 }
570 
571 static inline int
572 __default_check_phys_apicid_present(int phys_apicid)
573 {
574 	return physid_isset(phys_apicid, phys_cpu_present_map);
575 }
576 
577 #ifdef CONFIG_X86_32
578 static inline int default_cpu_present_to_apicid(int mps_cpu)
579 {
580 	return __default_cpu_present_to_apicid(mps_cpu);
581 }
582 
583 static inline int
584 default_check_phys_apicid_present(int phys_apicid)
585 {
586 	return __default_check_phys_apicid_present(phys_apicid);
587 }
588 #else
589 extern int default_cpu_present_to_apicid(int mps_cpu);
590 extern int default_check_phys_apicid_present(int phys_apicid);
591 #endif
592 
593 #endif /* CONFIG_X86_LOCAL_APIC */
594 
595 #ifdef CONFIG_X86_32
596 extern u8 cpu_2_logical_apicid[NR_CPUS];
597 #endif
598 
599 #endif /* _ASM_X86_APIC_H */
600