xref: /openbmc/linux/arch/x86/include/asm/apic.h (revision 7632611f)
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 void apic_disable(void);
224 extern int lapic_get_maxlvt(void);
225 extern void clear_local_APIC(void);
226 extern void connect_bsp_APIC(void);
227 extern void disconnect_bsp_APIC(int virt_wire_setup);
228 extern void disable_local_APIC(void);
229 extern void lapic_shutdown(void);
230 extern int verify_local_APIC(void);
231 extern void cache_APIC_registers(void);
232 extern void sync_Arb_IDs(void);
233 extern void init_bsp_APIC(void);
234 extern void setup_local_APIC(void);
235 extern void end_local_APIC_setup(void);
236 extern void init_apic_mappings(void);
237 void register_lapic_address(unsigned long address);
238 extern void setup_boot_APIC_clock(void);
239 extern void setup_secondary_APIC_clock(void);
240 extern int APIC_init_uniprocessor(void);
241 extern void enable_NMI_through_LVT0(void);
242 extern int apic_force_enable(void);
243 
244 /*
245  * On 32bit this is mach-xxx local
246  */
247 #ifdef CONFIG_X86_64
248 extern int apic_is_clustered_box(void);
249 #else
250 static inline int apic_is_clustered_box(void)
251 {
252 	return 0;
253 }
254 #endif
255 
256 extern int setup_APIC_eilvt(u8 lvt_off, u8 vector, u8 msg_type, u8 mask);
257 
258 #else /* !CONFIG_X86_LOCAL_APIC */
259 static inline void lapic_shutdown(void) { }
260 #define local_apic_timer_c2_ok		1
261 static inline void init_apic_mappings(void) { }
262 static inline void disable_local_APIC(void) { }
263 static inline void apic_disable(void) { }
264 # define setup_boot_APIC_clock x86_init_noop
265 # define setup_secondary_APIC_clock x86_init_noop
266 #endif /* !CONFIG_X86_LOCAL_APIC */
267 
268 #ifdef CONFIG_X86_64
269 #define	SET_APIC_ID(x)		(apic->set_apic_id(x))
270 #else
271 
272 #endif
273 
274 /*
275  * Copyright 2004 James Cleverdon, IBM.
276  * Subject to the GNU Public License, v.2
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 	char *name;
286 
287 	int (*probe)(void);
288 	int (*acpi_madt_oem_check)(char *oem_id, char *oem_table_id);
289 	int (*apic_id_registered)(void);
290 
291 	u32 irq_delivery_mode;
292 	u32 irq_dest_mode;
293 
294 	const struct cpumask *(*target_cpus)(void);
295 
296 	int disable_esr;
297 
298 	int dest_logical;
299 	unsigned long (*check_apicid_used)(physid_mask_t *map, int apicid);
300 	unsigned long (*check_apicid_present)(int apicid);
301 
302 	void (*vector_allocation_domain)(int cpu, struct cpumask *retmask);
303 	void (*init_apic_ldr)(void);
304 
305 	void (*ioapic_phys_id_map)(physid_mask_t *phys_map, physid_mask_t *retmap);
306 
307 	void (*setup_apic_routing)(void);
308 	int (*multi_timer_check)(int apic, int irq);
309 	int (*apicid_to_node)(int logical_apicid);
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 
359 /*
360  * Pointer to the local APIC driver in use on this system (there's
361  * always just one such driver in use - the kernel decides via an
362  * early probing process which one it picks - and then sticks to it):
363  */
364 extern struct apic *apic;
365 
366 /*
367  * APIC functionality to boot other CPUs - only used on SMP:
368  */
369 #ifdef CONFIG_SMP
370 extern atomic_t init_deasserted;
371 extern int wakeup_secondary_cpu_via_nmi(int apicid, unsigned long start_eip);
372 #endif
373 
374 #ifdef CONFIG_X86_LOCAL_APIC
375 static inline u32 apic_read(u32 reg)
376 {
377 	return apic->read(reg);
378 }
379 
380 static inline void apic_write(u32 reg, u32 val)
381 {
382 	apic->write(reg, val);
383 }
384 
385 static inline u64 apic_icr_read(void)
386 {
387 	return apic->icr_read();
388 }
389 
390 static inline void apic_icr_write(u32 low, u32 high)
391 {
392 	apic->icr_write(low, high);
393 }
394 
395 static inline void apic_wait_icr_idle(void)
396 {
397 	apic->wait_icr_idle();
398 }
399 
400 static inline u32 safe_apic_wait_icr_idle(void)
401 {
402 	return apic->safe_wait_icr_idle();
403 }
404 
405 #else /* CONFIG_X86_LOCAL_APIC */
406 
407 static inline u32 apic_read(u32 reg) { return 0; }
408 static inline void apic_write(u32 reg, u32 val) { }
409 static inline u64 apic_icr_read(void) { return 0; }
410 static inline void apic_icr_write(u32 low, u32 high) { }
411 static inline void apic_wait_icr_idle(void) { }
412 static inline u32 safe_apic_wait_icr_idle(void) { return 0; }
413 
414 #endif /* CONFIG_X86_LOCAL_APIC */
415 
416 static inline void ack_APIC_irq(void)
417 {
418 	/*
419 	 * ack_APIC_irq() actually gets compiled as a single instruction
420 	 * ... yummie.
421 	 */
422 
423 	/* Docs say use 0 for future compatibility */
424 	apic_write(APIC_EOI, 0);
425 }
426 
427 static inline unsigned default_get_apic_id(unsigned long x)
428 {
429 	unsigned int ver = GET_APIC_VERSION(apic_read(APIC_LVR));
430 
431 	if (APIC_XAPIC(ver) || boot_cpu_has(X86_FEATURE_EXTD_APICID))
432 		return (x >> 24) & 0xFF;
433 	else
434 		return (x >> 24) & 0x0F;
435 }
436 
437 /*
438  * Warm reset vector default position:
439  */
440 #define DEFAULT_TRAMPOLINE_PHYS_LOW		0x467
441 #define DEFAULT_TRAMPOLINE_PHYS_HIGH		0x469
442 
443 #ifdef CONFIG_X86_64
444 extern struct apic apic_flat;
445 extern struct apic apic_physflat;
446 extern struct apic apic_x2apic_cluster;
447 extern struct apic apic_x2apic_phys;
448 extern int default_acpi_madt_oem_check(char *, char *);
449 
450 extern void apic_send_IPI_self(int vector);
451 
452 extern struct apic apic_x2apic_uv_x;
453 DECLARE_PER_CPU(int, x2apic_extra_bits);
454 
455 extern int default_cpu_present_to_apicid(int mps_cpu);
456 extern int default_check_phys_apicid_present(int phys_apicid);
457 #endif
458 
459 static inline void default_wait_for_init_deassert(atomic_t *deassert)
460 {
461 	while (!atomic_read(deassert))
462 		cpu_relax();
463 	return;
464 }
465 
466 extern void generic_bigsmp_probe(void);
467 
468 
469 #ifdef CONFIG_X86_LOCAL_APIC
470 
471 #include <asm/smp.h>
472 
473 #define APIC_DFR_VALUE	(APIC_DFR_FLAT)
474 
475 static inline const struct cpumask *default_target_cpus(void)
476 {
477 #ifdef CONFIG_SMP
478 	return cpu_online_mask;
479 #else
480 	return cpumask_of(0);
481 #endif
482 }
483 
484 DECLARE_EARLY_PER_CPU(u16, x86_bios_cpu_apicid);
485 
486 
487 static inline unsigned int read_apic_id(void)
488 {
489 	unsigned int reg;
490 
491 	reg = apic_read(APIC_ID);
492 
493 	return apic->get_apic_id(reg);
494 }
495 
496 extern void default_setup_apic_routing(void);
497 
498 extern struct apic apic_noop;
499 
500 #ifdef CONFIG_X86_32
501 
502 extern struct apic apic_default;
503 
504 /*
505  * Set up the logical destination ID.
506  *
507  * Intel recommends to set DFR, LDR and TPR before enabling
508  * an APIC.  See e.g. "AP-388 82489DX User's Manual" (Intel
509  * document number 292116).  So here it goes...
510  */
511 extern void default_init_apic_ldr(void);
512 
513 static inline int default_apic_id_registered(void)
514 {
515 	return physid_isset(read_apic_id(), phys_cpu_present_map);
516 }
517 
518 static inline int default_phys_pkg_id(int cpuid_apic, int index_msb)
519 {
520 	return cpuid_apic >> index_msb;
521 }
522 
523 extern int default_apicid_to_node(int logical_apicid);
524 
525 #endif
526 
527 static inline unsigned int
528 default_cpu_mask_to_apicid(const struct cpumask *cpumask)
529 {
530 	return cpumask_bits(cpumask)[0] & APIC_ALL_CPUS;
531 }
532 
533 static inline unsigned int
534 default_cpu_mask_to_apicid_and(const struct cpumask *cpumask,
535 			       const struct cpumask *andmask)
536 {
537 	unsigned long mask1 = cpumask_bits(cpumask)[0];
538 	unsigned long mask2 = cpumask_bits(andmask)[0];
539 	unsigned long mask3 = cpumask_bits(cpu_online_mask)[0];
540 
541 	return (unsigned int)(mask1 & mask2 & mask3);
542 }
543 
544 static inline unsigned long default_check_apicid_used(physid_mask_t *map, int apicid)
545 {
546 	return physid_isset(apicid, *map);
547 }
548 
549 static inline unsigned long default_check_apicid_present(int bit)
550 {
551 	return physid_isset(bit, phys_cpu_present_map);
552 }
553 
554 static inline void default_ioapic_phys_id_map(physid_mask_t *phys_map, physid_mask_t *retmap)
555 {
556 	*retmap = *phys_map;
557 }
558 
559 static inline int __default_cpu_present_to_apicid(int mps_cpu)
560 {
561 	if (mps_cpu < nr_cpu_ids && cpu_present(mps_cpu))
562 		return (int)per_cpu(x86_bios_cpu_apicid, mps_cpu);
563 	else
564 		return BAD_APICID;
565 }
566 
567 static inline int
568 __default_check_phys_apicid_present(int phys_apicid)
569 {
570 	return physid_isset(phys_apicid, phys_cpu_present_map);
571 }
572 
573 #ifdef CONFIG_X86_32
574 static inline int default_cpu_present_to_apicid(int mps_cpu)
575 {
576 	return __default_cpu_present_to_apicid(mps_cpu);
577 }
578 
579 static inline int
580 default_check_phys_apicid_present(int phys_apicid)
581 {
582 	return __default_check_phys_apicid_present(phys_apicid);
583 }
584 #else
585 extern int default_cpu_present_to_apicid(int mps_cpu);
586 extern int default_check_phys_apicid_present(int phys_apicid);
587 #endif
588 
589 #endif /* CONFIG_X86_LOCAL_APIC */
590 
591 #endif /* _ASM_X86_APIC_H */
592