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