arch/x86/include/asm/apic.h

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