xref: /openbmc/linux/arch/x86/include/asm/apic.h (revision 680ef72a)
1 #ifndef _ASM_X86_APIC_H
2 #define _ASM_X86_APIC_H
3 
4 #include <linux/cpumask.h>
5 
6 #include <asm/alternative.h>
7 #include <asm/cpufeature.h>
8 #include <asm/apicdef.h>
9 #include <linux/atomic.h>
10 #include <asm/fixmap.h>
11 #include <asm/mpspec.h>
12 #include <asm/msr.h>
13 
14 #define ARCH_APICTIMER_STOPS_ON_C3	1
15 
16 /*
17  * Debugging macros
18  */
19 #define APIC_QUIET   0
20 #define APIC_VERBOSE 1
21 #define APIC_DEBUG   2
22 
23 /* Macros for apic_extnmi which controls external NMI masking */
24 #define APIC_EXTNMI_BSP		0 /* Default */
25 #define APIC_EXTNMI_ALL		1
26 #define APIC_EXTNMI_NONE	2
27 
28 /*
29  * Define the default level of output to be very little
30  * This can be turned up by using apic=verbose for more
31  * information and apic=debug for _lots_ of information.
32  * apic_verbosity is defined in apic.c
33  */
34 #define apic_printk(v, s, a...) do {       \
35 		if ((v) <= apic_verbosity) \
36 			printk(s, ##a);    \
37 	} while (0)
38 
39 
40 #if defined(CONFIG_X86_LOCAL_APIC) && defined(CONFIG_X86_32)
41 extern void generic_apic_probe(void);
42 #else
43 static inline void generic_apic_probe(void)
44 {
45 }
46 #endif
47 
48 #ifdef CONFIG_X86_LOCAL_APIC
49 
50 extern unsigned int apic_verbosity;
51 extern int local_apic_timer_c2_ok;
52 
53 extern int disable_apic;
54 extern unsigned int lapic_timer_frequency;
55 
56 extern enum apic_intr_mode_id apic_intr_mode;
57 enum apic_intr_mode_id {
58 	APIC_PIC,
59 	APIC_VIRTUAL_WIRE,
60 	APIC_VIRTUAL_WIRE_NO_CONFIG,
61 	APIC_SYMMETRIC_IO,
62 	APIC_SYMMETRIC_IO_NO_ROUTING
63 };
64 
65 #ifdef CONFIG_SMP
66 extern void __inquire_remote_apic(int apicid);
67 #else /* CONFIG_SMP */
68 static inline void __inquire_remote_apic(int apicid)
69 {
70 }
71 #endif /* CONFIG_SMP */
72 
73 static inline void default_inquire_remote_apic(int apicid)
74 {
75 	if (apic_verbosity >= APIC_DEBUG)
76 		__inquire_remote_apic(apicid);
77 }
78 
79 /*
80  * With 82489DX we can't rely on apic feature bit
81  * retrieved via cpuid but still have to deal with
82  * such an apic chip so we assume that SMP configuration
83  * is found from MP table (64bit case uses ACPI mostly
84  * which set smp presence flag as well so we are safe
85  * to use this helper too).
86  */
87 static inline bool apic_from_smp_config(void)
88 {
89 	return smp_found_config && !disable_apic;
90 }
91 
92 /*
93  * Basic functions accessing APICs.
94  */
95 #ifdef CONFIG_PARAVIRT
96 #include <asm/paravirt.h>
97 #endif
98 
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, %P1", "xchgl %0, %P1", X86_BUG_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 static inline bool apic_is_x2apic_enabled(void)
121 {
122 	u64 msr;
123 
124 	if (rdmsrl_safe(MSR_IA32_APICBASE, &msr))
125 		return false;
126 	return msr & X2APIC_ENABLE;
127 }
128 
129 extern void enable_IR_x2apic(void);
130 
131 extern int get_physical_broadcast(void);
132 
133 extern int lapic_get_maxlvt(void);
134 extern void clear_local_APIC(void);
135 extern void disconnect_bsp_APIC(int virt_wire_setup);
136 extern void disable_local_APIC(void);
137 extern void lapic_shutdown(void);
138 extern void sync_Arb_IDs(void);
139 extern void apic_intr_mode_init(void);
140 extern void setup_local_APIC(void);
141 extern void init_apic_mappings(void);
142 void register_lapic_address(unsigned long address);
143 extern void setup_boot_APIC_clock(void);
144 extern void setup_secondary_APIC_clock(void);
145 extern void lapic_update_tsc_freq(void);
146 
147 #ifdef CONFIG_X86_64
148 static inline int apic_force_enable(unsigned long addr)
149 {
150 	return -1;
151 }
152 #else
153 extern int apic_force_enable(unsigned long addr);
154 #endif
155 
156 extern void apic_bsp_setup(bool upmode);
157 extern void apic_ap_setup(void);
158 
159 /*
160  * On 32bit this is mach-xxx local
161  */
162 #ifdef CONFIG_X86_64
163 extern int apic_is_clustered_box(void);
164 #else
165 static inline int apic_is_clustered_box(void)
166 {
167 	return 0;
168 }
169 #endif
170 
171 extern int setup_APIC_eilvt(u8 lvt_off, u8 vector, u8 msg_type, u8 mask);
172 extern void lapic_assign_system_vectors(void);
173 extern void lapic_assign_legacy_vector(unsigned int isairq, bool replace);
174 extern void lapic_online(void);
175 extern void lapic_offline(void);
176 
177 #else /* !CONFIG_X86_LOCAL_APIC */
178 static inline void lapic_shutdown(void) { }
179 #define local_apic_timer_c2_ok		1
180 static inline void init_apic_mappings(void) { }
181 static inline void disable_local_APIC(void) { }
182 # define setup_boot_APIC_clock x86_init_noop
183 # define setup_secondary_APIC_clock x86_init_noop
184 static inline void lapic_update_tsc_freq(void) { }
185 static inline void apic_intr_mode_init(void) { }
186 static inline void lapic_assign_system_vectors(void) { }
187 static inline void lapic_assign_legacy_vector(unsigned int i, bool r) { }
188 #endif /* !CONFIG_X86_LOCAL_APIC */
189 
190 #ifdef CONFIG_X86_X2APIC
191 /*
192  * Make previous memory operations globally visible before
193  * sending the IPI through x2apic wrmsr. We need a serializing instruction or
194  * mfence for this.
195  */
196 static inline void x2apic_wrmsr_fence(void)
197 {
198 	asm volatile("mfence" : : : "memory");
199 }
200 
201 static inline void native_apic_msr_write(u32 reg, u32 v)
202 {
203 	if (reg == APIC_DFR || reg == APIC_ID || reg == APIC_LDR ||
204 	    reg == APIC_LVR)
205 		return;
206 
207 	wrmsr(APIC_BASE_MSR + (reg >> 4), v, 0);
208 }
209 
210 static inline void native_apic_msr_eoi_write(u32 reg, u32 v)
211 {
212 	__wrmsr(APIC_BASE_MSR + (APIC_EOI >> 4), APIC_EOI_ACK, 0);
213 }
214 
215 static inline u32 native_apic_msr_read(u32 reg)
216 {
217 	u64 msr;
218 
219 	if (reg == APIC_DFR)
220 		return -1;
221 
222 	rdmsrl(APIC_BASE_MSR + (reg >> 4), msr);
223 	return (u32)msr;
224 }
225 
226 static inline void native_x2apic_wait_icr_idle(void)
227 {
228 	/* no need to wait for icr idle in x2apic */
229 	return;
230 }
231 
232 static inline u32 native_safe_x2apic_wait_icr_idle(void)
233 {
234 	/* no need to wait for icr idle in x2apic */
235 	return 0;
236 }
237 
238 static inline void native_x2apic_icr_write(u32 low, u32 id)
239 {
240 	wrmsrl(APIC_BASE_MSR + (APIC_ICR >> 4), ((__u64) id) << 32 | low);
241 }
242 
243 static inline u64 native_x2apic_icr_read(void)
244 {
245 	unsigned long val;
246 
247 	rdmsrl(APIC_BASE_MSR + (APIC_ICR >> 4), val);
248 	return val;
249 }
250 
251 extern int x2apic_mode;
252 extern int x2apic_phys;
253 extern void __init check_x2apic(void);
254 extern void x2apic_setup(void);
255 static inline int x2apic_enabled(void)
256 {
257 	return boot_cpu_has(X86_FEATURE_X2APIC) && apic_is_x2apic_enabled();
258 }
259 
260 #define x2apic_supported()	(boot_cpu_has(X86_FEATURE_X2APIC))
261 #else /* !CONFIG_X86_X2APIC */
262 static inline void check_x2apic(void) { }
263 static inline void x2apic_setup(void) { }
264 static inline int x2apic_enabled(void) { return 0; }
265 
266 #define x2apic_mode		(0)
267 #define	x2apic_supported()	(0)
268 #endif /* !CONFIG_X86_X2APIC */
269 
270 struct irq_data;
271 
272 /*
273  * Copyright 2004 James Cleverdon, IBM.
274  * Subject to the GNU Public License, v.2
275  *
276  * Generic APIC sub-arch data struct.
277  *
278  * Hacked for x86-64 by James Cleverdon from i386 architecture code by
279  * Martin Bligh, Andi Kleen, James Bottomley, John Stultz, and
280  * James Cleverdon.
281  */
282 struct apic {
283 	/* Hotpath functions first */
284 	void	(*eoi_write)(u32 reg, u32 v);
285 	void	(*native_eoi_write)(u32 reg, u32 v);
286 	void	(*write)(u32 reg, u32 v);
287 	u32	(*read)(u32 reg);
288 
289 	/* IPI related functions */
290 	void	(*wait_icr_idle)(void);
291 	u32	(*safe_wait_icr_idle)(void);
292 
293 	void	(*send_IPI)(int cpu, int vector);
294 	void	(*send_IPI_mask)(const struct cpumask *mask, int vector);
295 	void	(*send_IPI_mask_allbutself)(const struct cpumask *msk, int vec);
296 	void	(*send_IPI_allbutself)(int vector);
297 	void	(*send_IPI_all)(int vector);
298 	void	(*send_IPI_self)(int vector);
299 
300 	/* dest_logical is used by the IPI functions */
301 	u32	dest_logical;
302 	u32	disable_esr;
303 	u32	irq_delivery_mode;
304 	u32	irq_dest_mode;
305 
306 	/* Functions and data related to vector allocation */
307 	void	(*vector_allocation_domain)(int cpu, struct cpumask *retmask,
308 					    const struct cpumask *mask);
309 	int	(*cpu_mask_to_apicid)(const struct cpumask *cpumask,
310 				      struct irq_data *irqdata,
311 				      unsigned int *apicid);
312 	u32	(*calc_dest_apicid)(unsigned int cpu);
313 
314 	/* ICR related functions */
315 	u64	(*icr_read)(void);
316 	void	(*icr_write)(u32 low, u32 high);
317 
318 	/* Probe, setup and smpboot functions */
319 	int	(*probe)(void);
320 	int	(*acpi_madt_oem_check)(char *oem_id, char *oem_table_id);
321 	int	(*apic_id_valid)(int apicid);
322 	int	(*apic_id_registered)(void);
323 
324 	bool	(*check_apicid_used)(physid_mask_t *map, int apicid);
325 	void	(*init_apic_ldr)(void);
326 	void	(*ioapic_phys_id_map)(physid_mask_t *phys_map, physid_mask_t *retmap);
327 	void	(*setup_apic_routing)(void);
328 	int	(*cpu_present_to_apicid)(int mps_cpu);
329 	void	(*apicid_to_cpu_present)(int phys_apicid, physid_mask_t *retmap);
330 	int	(*check_phys_apicid_present)(int phys_apicid);
331 	int	(*phys_pkg_id)(int cpuid_apic, int index_msb);
332 
333 	u32	(*get_apic_id)(unsigned long x);
334 	u32	(*set_apic_id)(unsigned int id);
335 
336 	/* wakeup_secondary_cpu */
337 	int	(*wakeup_secondary_cpu)(int apicid, unsigned long start_eip);
338 
339 	void	(*inquire_remote_apic)(int apicid);
340 
341 #ifdef CONFIG_X86_32
342 	/*
343 	 * Called very early during boot from get_smp_config().  It should
344 	 * return the logical apicid.  x86_[bios]_cpu_to_apicid is
345 	 * initialized before this function is called.
346 	 *
347 	 * If logical apicid can't be determined that early, the function
348 	 * may return BAD_APICID.  Logical apicid will be configured after
349 	 * init_apic_ldr() while bringing up CPUs.  Note that NUMA affinity
350 	 * won't be applied properly during early boot in this case.
351 	 */
352 	int (*x86_32_early_logical_apicid)(int cpu);
353 #endif
354 	char	*name;
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 drivers are probed based on how they are listed in the .apicdrivers
366  * section. So the order is important and enforced by the ordering
367  * of different apic driver files in the Makefile.
368  *
369  * For the files having two apic drivers, we use apic_drivers()
370  * to enforce the order with in them.
371  */
372 #define apic_driver(sym)					\
373 	static const struct apic *__apicdrivers_##sym __used		\
374 	__aligned(sizeof(struct apic *))			\
375 	__section(.apicdrivers) = { &sym }
376 
377 #define apic_drivers(sym1, sym2)					\
378 	static struct apic *__apicdrivers_##sym1##sym2[2] __used	\
379 	__aligned(sizeof(struct apic *))				\
380 	__section(.apicdrivers) = { &sym1, &sym2 }
381 
382 extern struct apic *__apicdrivers[], *__apicdrivers_end[];
383 
384 /*
385  * APIC functionality to boot other CPUs - only used on SMP:
386  */
387 #ifdef CONFIG_SMP
388 extern int wakeup_secondary_cpu_via_nmi(int apicid, unsigned long start_eip);
389 extern int lapic_can_unplug_cpu(void);
390 #endif
391 
392 #ifdef CONFIG_X86_LOCAL_APIC
393 
394 static inline u32 apic_read(u32 reg)
395 {
396 	return apic->read(reg);
397 }
398 
399 static inline void apic_write(u32 reg, u32 val)
400 {
401 	apic->write(reg, val);
402 }
403 
404 static inline void apic_eoi(void)
405 {
406 	apic->eoi_write(APIC_EOI, APIC_EOI_ACK);
407 }
408 
409 static inline u64 apic_icr_read(void)
410 {
411 	return apic->icr_read();
412 }
413 
414 static inline void apic_icr_write(u32 low, u32 high)
415 {
416 	apic->icr_write(low, high);
417 }
418 
419 static inline void apic_wait_icr_idle(void)
420 {
421 	apic->wait_icr_idle();
422 }
423 
424 static inline u32 safe_apic_wait_icr_idle(void)
425 {
426 	return apic->safe_wait_icr_idle();
427 }
428 
429 extern void __init apic_set_eoi_write(void (*eoi_write)(u32 reg, u32 v));
430 
431 #else /* CONFIG_X86_LOCAL_APIC */
432 
433 static inline u32 apic_read(u32 reg) { return 0; }
434 static inline void apic_write(u32 reg, u32 val) { }
435 static inline void apic_eoi(void) { }
436 static inline u64 apic_icr_read(void) { return 0; }
437 static inline void apic_icr_write(u32 low, u32 high) { }
438 static inline void apic_wait_icr_idle(void) { }
439 static inline u32 safe_apic_wait_icr_idle(void) { return 0; }
440 static inline void apic_set_eoi_write(void (*eoi_write)(u32 reg, u32 v)) {}
441 
442 #endif /* CONFIG_X86_LOCAL_APIC */
443 
444 static inline void ack_APIC_irq(void)
445 {
446 	/*
447 	 * ack_APIC_irq() actually gets compiled as a single instruction
448 	 * ... yummie.
449 	 */
450 	apic_eoi();
451 }
452 
453 static inline unsigned default_get_apic_id(unsigned long x)
454 {
455 	unsigned int ver = GET_APIC_VERSION(apic_read(APIC_LVR));
456 
457 	if (APIC_XAPIC(ver) || boot_cpu_has(X86_FEATURE_EXTD_APICID))
458 		return (x >> 24) & 0xFF;
459 	else
460 		return (x >> 24) & 0x0F;
461 }
462 
463 /*
464  * Warm reset vector position:
465  */
466 #define TRAMPOLINE_PHYS_LOW		0x467
467 #define TRAMPOLINE_PHYS_HIGH		0x469
468 
469 #ifdef CONFIG_X86_64
470 extern void apic_send_IPI_self(int vector);
471 
472 DECLARE_PER_CPU(int, x2apic_extra_bits);
473 #endif
474 
475 extern void generic_bigsmp_probe(void);
476 
477 #ifdef CONFIG_X86_LOCAL_APIC
478 
479 #include <asm/smp.h>
480 
481 #define APIC_DFR_VALUE	(APIC_DFR_FLAT)
482 
483 DECLARE_EARLY_PER_CPU_READ_MOSTLY(u16, x86_bios_cpu_apicid);
484 
485 extern struct apic apic_noop;
486 
487 static inline unsigned int read_apic_id(void)
488 {
489 	unsigned int reg = apic_read(APIC_ID);
490 
491 	return apic->get_apic_id(reg);
492 }
493 
494 extern int default_apic_id_valid(int apicid);
495 extern int default_acpi_madt_oem_check(char *, char *);
496 extern void default_setup_apic_routing(void);
497 
498 extern u32 apic_default_calc_apicid(unsigned int cpu);
499 extern u32 apic_flat_calc_apicid(unsigned int cpu);
500 
501 extern int flat_cpu_mask_to_apicid(const struct cpumask *cpumask,
502 				   struct irq_data *irqdata,
503 				   unsigned int *apicid);
504 extern int default_cpu_mask_to_apicid(const struct cpumask *cpumask,
505 				      struct irq_data *irqdata,
506 				      unsigned int *apicid);
507 extern bool default_check_apicid_used(physid_mask_t *map, int apicid);
508 extern void flat_vector_allocation_domain(int cpu, struct cpumask *retmask,
509 				   const struct cpumask *mask);
510 extern void default_vector_allocation_domain(int cpu, struct cpumask *retmask,
511 				      const struct cpumask *mask);
512 extern void default_ioapic_phys_id_map(physid_mask_t *phys_map, physid_mask_t *retmap);
513 extern int default_cpu_present_to_apicid(int mps_cpu);
514 extern int default_check_phys_apicid_present(int phys_apicid);
515 
516 #endif /* CONFIG_X86_LOCAL_APIC */
517 
518 extern void irq_enter(void);
519 extern void irq_exit(void);
520 
521 static inline void entering_irq(void)
522 {
523 	irq_enter();
524 }
525 
526 static inline void entering_ack_irq(void)
527 {
528 	entering_irq();
529 	ack_APIC_irq();
530 }
531 
532 static inline void ipi_entering_ack_irq(void)
533 {
534 	irq_enter();
535 	ack_APIC_irq();
536 }
537 
538 static inline void exiting_irq(void)
539 {
540 	irq_exit();
541 }
542 
543 static inline void exiting_ack_irq(void)
544 {
545 	ack_APIC_irq();
546 	irq_exit();
547 }
548 
549 extern void ioapic_zap_locks(void);
550 
551 #endif /* _ASM_X86_APIC_H */
552