arch/x86/kernel/apic/msi.c

   1 /*
   2  * Support of MSI, HPET and DMAR interrupts.
   3  *
   4  * Copyright (C) 1997, 1998, 1999, 2000, 2009 Ingo Molnar, Hajnalka Szabo
   5  *      Moved from arch/x86/kernel/apic/io_apic.c.
   6  * Jiang Liu <jiang.liu@linux.intel.com>
   7  *      Convert to hierarchical irqdomain
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  */
  13 #include <linux/mm.h>
  14 #include <linux/interrupt.h>
  15 #include <linux/irq.h>
  16 #include <linux/pci.h>
  17 #include <linux/dmar.h>
  18 #include <linux/hpet.h>
  19 #include <linux/msi.h>
  20 #include <asm/irqdomain.h>
  21 #include <asm/msidef.h>
  22 #include <asm/hpet.h>
  23 #include <asm/hw_irq.h>
  24 #include <asm/apic.h>
  25 #include <asm/irq_remapping.h>
  26
  27 static struct irq_domain *msi_default_domain;
  28
  29 static void __irq_msi_compose_msg(struct irq_cfg *cfg, struct msi_msg *msg)
  30 {
  31         msg->address_hi = MSI_ADDR_BASE_HI;
  32
  33         if (x2apic_enabled())
  34                 msg->address_hi |= MSI_ADDR_EXT_DEST_ID(cfg->dest_apicid);
  35
  36         msg->address_lo =
  37                 MSI_ADDR_BASE_LO |
  38                 ((apic->irq_dest_mode == 0) ?
  39                         MSI_ADDR_DEST_MODE_PHYSICAL :
  40                         MSI_ADDR_DEST_MODE_LOGICAL) |
  41                 MSI_ADDR_REDIRECTION_CPU |
  42                 MSI_ADDR_DEST_ID(cfg->dest_apicid);
  43
  44         msg->data =
  45                 MSI_DATA_TRIGGER_EDGE |
  46                 MSI_DATA_LEVEL_ASSERT |
  47                 MSI_DATA_DELIVERY_FIXED |
  48                 MSI_DATA_VECTOR(cfg->vector);
  49 }
  50
  51 static void irq_msi_compose_msg(struct irq_data *data, struct msi_msg *msg)
  52 {
  53         __irq_msi_compose_msg(irqd_cfg(data), msg);
  54 }
  55
  56 static void irq_msi_update_msg(struct irq_data *irqd, struct irq_cfg *cfg)
  57 {
  58         struct msi_msg msg[2] = { [1] = { }, };
  59
  60         __irq_msi_compose_msg(cfg, msg);
  61         irq_data_get_irq_chip(irqd)->irq_write_msi_msg(irqd, msg);
  62 }
  63
  64 static int
  65 msi_set_affinity(struct irq_data *irqd, const struct cpumask *mask, bool force)
  66 {
  67         struct irq_cfg old_cfg, *cfg = irqd_cfg(irqd);
  68         struct irq_data *parent = irqd->parent_data;
  69         unsigned int cpu;
  70         int ret;
  71
  72         /* Save the current configuration */
  73         cpu = cpumask_first(irq_data_get_effective_affinity_mask(irqd));
  74         old_cfg = *cfg;
  75
  76         /* Allocate a new target vector */
  77         ret = parent->chip->irq_set_affinity(parent, mask, force);
  78         if (ret < 0 || ret == IRQ_SET_MASK_OK_DONE)
  79                 return ret;
  80
  81         /*
  82          * For non-maskable and non-remapped MSI interrupts the migration
  83          * to a different destination CPU and a different vector has to be
  84          * done careful to handle the possible stray interrupt which can be
  85          * caused by the non-atomic update of the address/data pair.
  86          *
  87          * Direct update is possible when:
  88          * - The MSI is maskable (remapped MSI does not use this code path)).
  89          *   The quirk bit is not set in this case.
  90          * - The new vector is the same as the old vector
  91          * - The old vector is MANAGED_IRQ_SHUTDOWN_VECTOR (interrupt starts up)
  92          * - The interrupt is not yet started up
  93          * - The new destination CPU is the same as the old destination CPU
  94          */
  95         if (!irqd_msi_nomask_quirk(irqd) ||
  96             cfg->vector == old_cfg.vector ||
  97             old_cfg.vector == MANAGED_IRQ_SHUTDOWN_VECTOR ||
  98             !irqd_is_started(irqd) ||
  99             cfg->dest_apicid == old_cfg.dest_apicid) {
 100                 irq_msi_update_msg(irqd, cfg);
 101                 return ret;
 102         }
 103
 104         /*
 105          * Paranoia: Validate that the interrupt target is the local
 106          * CPU.
 107          */
 108         if (WARN_ON_ONCE(cpu != smp_processor_id())) {
 109                 irq_msi_update_msg(irqd, cfg);
 110                 return ret;
 111         }
 112
 113         /*
 114          * Redirect the interrupt to the new vector on the current CPU
 115          * first. This might cause a spurious interrupt on this vector if
 116          * the device raises an interrupt right between this update and the
 117          * update to the final destination CPU.
 118          *
 119          * If the vector is in use then the installed device handler will
 120          * denote it as spurious which is no harm as this is a rare event
 121          * and interrupt handlers have to cope with spurious interrupts
 122          * anyway. If the vector is unused, then it is marked so it won't
 123          * trigger the 'No irq handler for vector' warning in do_IRQ().
 124          *
 125          * This requires to hold vector lock to prevent concurrent updates to
 126          * the affected vector.
 127          */
 128         lock_vector_lock();
 129
 130         /*
 131          * Mark the new target vector on the local CPU if it is currently
 132          * unused. Reuse the VECTOR_RETRIGGERED state which is also used in
 133          * the CPU hotplug path for a similar purpose. This cannot be
 134          * undone here as the current CPU has interrupts disabled and
 135          * cannot handle the interrupt before the whole set_affinity()
 136          * section is done. In the CPU unplug case, the current CPU is
 137          * about to vanish and will not handle any interrupts anymore. The
 138          * vector is cleaned up when the CPU comes online again.
 139          */
 140         if (IS_ERR_OR_NULL(this_cpu_read(vector_irq[cfg->vector])))
 141                 this_cpu_write(vector_irq[cfg->vector], VECTOR_RETRIGGERED);
 142
 143         /* Redirect it to the new vector on the local CPU temporarily */
 144         old_cfg.vector = cfg->vector;
 145         irq_msi_update_msg(irqd, &old_cfg);
 146
 147         /* Now transition it to the target CPU */
 148         irq_msi_update_msg(irqd, cfg);
 149
 150         /*
 151          * All interrupts after this point are now targeted at the new
 152          * vector/CPU.
 153          *
 154          * Drop vector lock before testing whether the temporary assignment
 155          * to the local CPU was hit by an interrupt raised in the device,
 156          * because the retrigger function acquires vector lock again.
 157          */
 158         unlock_vector_lock();
 159
 160         /*
 161          * Check whether the transition raced with a device interrupt and
 162          * is pending in the local APICs IRR. It is safe to do this outside
 163          * of vector lock as the irq_desc::lock of this interrupt is still
 164          * held and interrupts are disabled: The check is not accessing the
 165          * underlying vector store. It's just checking the local APIC's
 166          * IRR.
 167          */
 168         if (lapic_vector_set_in_irr(cfg->vector))
 169                 irq_data_get_irq_chip(irqd)->irq_retrigger(irqd);
 170
 171         return ret;
 172 }
 173
 174 /*
 175  * IRQ Chip for MSI PCI/PCI-X/PCI-Express Devices,
 176  * which implement the MSI or MSI-X Capability Structure.
 177  */
 178 static struct irq_chip pci_msi_controller = {
 179         .name                   = "PCI-MSI",
 180         .irq_unmask             = pci_msi_unmask_irq,
 181         .irq_mask               = pci_msi_mask_irq,
 182         .irq_ack                = irq_chip_ack_parent,
 183         .irq_retrigger          = irq_chip_retrigger_hierarchy,
 184         .irq_compose_msi_msg    = irq_msi_compose_msg,
 185         .irq_set_affinity       = msi_set_affinity,
 186         .flags                  = IRQCHIP_SKIP_SET_WAKE |
 187                                   IRQCHIP_AFFINITY_PRE_STARTUP,
 188 };
 189
 190 int native_setup_msi_irqs(struct pci_dev *dev, int nvec, int type)
 191 {
 192         struct irq_domain *domain;
 193         struct irq_alloc_info info;
 194
 195         init_irq_alloc_info(&info, NULL);
 196         info.type = X86_IRQ_ALLOC_TYPE_MSI;
 197         info.msi_dev = dev;
 198
 199         domain = irq_remapping_get_irq_domain(&info);
 200         if (domain == NULL)
 201                 domain = msi_default_domain;
 202         if (domain == NULL)
 203                 return -ENOSYS;
 204
 205         return msi_domain_alloc_irqs(domain, &dev->dev, nvec);
 206 }
 207
 208 void native_teardown_msi_irq(unsigned int irq)
 209 {
 210         irq_domain_free_irqs(irq, 1);
 211 }
 212
 213 static irq_hw_number_t pci_msi_get_hwirq(struct msi_domain_info *info,
 214                                          msi_alloc_info_t *arg)
 215 {
 216         return arg->msi_hwirq;
 217 }
 218
 219 int pci_msi_prepare(struct irq_domain *domain, struct device *dev, int nvec,
 220                     msi_alloc_info_t *arg)
 221 {
 222         struct pci_dev *pdev = to_pci_dev(dev);
 223         struct msi_desc *desc = first_pci_msi_entry(pdev);
 224
 225         init_irq_alloc_info(arg, NULL);
 226         arg->msi_dev = pdev;
 227         if (desc->msi_attrib.is_msix) {
 228                 arg->type = X86_IRQ_ALLOC_TYPE_MSIX;
 229         } else {
 230                 arg->type = X86_IRQ_ALLOC_TYPE_MSI;
 231                 arg->flags |= X86_IRQ_ALLOC_CONTIGUOUS_VECTORS;
 232         }
 233
 234         return 0;
 235 }
 236 EXPORT_SYMBOL_GPL(pci_msi_prepare);
 237
 238 void pci_msi_set_desc(msi_alloc_info_t *arg, struct msi_desc *desc)
 239 {
 240         arg->msi_hwirq = pci_msi_domain_calc_hwirq(arg->msi_dev, desc);
 241 }
 242 EXPORT_SYMBOL_GPL(pci_msi_set_desc);
 243
 244 static struct msi_domain_ops pci_msi_domain_ops = {
 245         .get_hwirq      = pci_msi_get_hwirq,
 246         .msi_prepare    = pci_msi_prepare,
 247         .set_desc       = pci_msi_set_desc,
 248 };
 249
 250 static struct msi_domain_info pci_msi_domain_info = {
 251         .flags          = MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
 252                           MSI_FLAG_PCI_MSIX,
 253         .ops            = &pci_msi_domain_ops,
 254         .chip           = &pci_msi_controller,
 255         .handler        = handle_edge_irq,
 256         .handler_name   = "edge",
 257 };
 258
 259 void __init arch_init_msi_domain(struct irq_domain *parent)
 260 {
 261         struct fwnode_handle *fn;
 262
 263         if (disable_apic)
 264                 return;
 265
 266         fn = irq_domain_alloc_named_fwnode("PCI-MSI");
 267         if (fn) {
 268                 msi_default_domain =
 269                         pci_msi_create_irq_domain(fn, &pci_msi_domain_info,
 270                                                   parent);
 271         }
 272         if (!msi_default_domain) {
 273                 irq_domain_free_fwnode(fn);
 274                 pr_warn("failed to initialize irqdomain for MSI/MSI-x.\n");
 275         } else {
 276                 msi_default_domain->flags |= IRQ_DOMAIN_MSI_NOMASK_QUIRK;
 277         }
 278 }
 279
 280 #ifdef CONFIG_IRQ_REMAP
 281 static struct irq_chip pci_msi_ir_controller = {
 282         .name                   = "IR-PCI-MSI",
 283         .irq_unmask             = pci_msi_unmask_irq,
 284         .irq_mask               = pci_msi_mask_irq,
 285         .irq_ack                = irq_chip_ack_parent,
 286         .irq_retrigger          = irq_chip_retrigger_hierarchy,
 287         .irq_set_vcpu_affinity  = irq_chip_set_vcpu_affinity_parent,
 288         .flags                  = IRQCHIP_SKIP_SET_WAKE |
 289                                   IRQCHIP_AFFINITY_PRE_STARTUP,
 290 };
 291
 292 static struct msi_domain_info pci_msi_ir_domain_info = {
 293         .flags          = MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
 294                           MSI_FLAG_MULTI_PCI_MSI | MSI_FLAG_PCI_MSIX,
 295         .ops            = &pci_msi_domain_ops,
 296         .chip           = &pci_msi_ir_controller,
 297         .handler        = handle_edge_irq,
 298         .handler_name   = "edge",
 299 };
 300
 301 struct irq_domain *arch_create_remap_msi_irq_domain(struct irq_domain *parent,
 302                                                     const char *name, int id)
 303 {
 304         struct fwnode_handle *fn;
 305         struct irq_domain *d;
 306
 307         fn = irq_domain_alloc_named_id_fwnode(name, id);
 308         if (!fn)
 309                 return NULL;
 310         d = pci_msi_create_irq_domain(fn, &pci_msi_ir_domain_info, parent);
 311         if (!d)
 312                 irq_domain_free_fwnode(fn);
 313         return d;
 314 }
 315 #endif
 316
 317 #ifdef CONFIG_DMAR_TABLE
 318 static void dmar_msi_write_msg(struct irq_data *data, struct msi_msg *msg)
 319 {
 320         dmar_msi_write(data->irq, msg);
 321 }
 322
 323 static struct irq_chip dmar_msi_controller = {
 324         .name                   = "DMAR-MSI",
 325         .irq_unmask             = dmar_msi_unmask,
 326         .irq_mask               = dmar_msi_mask,
 327         .irq_ack                = irq_chip_ack_parent,
 328         .irq_set_affinity       = msi_domain_set_affinity,
 329         .irq_retrigger          = irq_chip_retrigger_hierarchy,
 330         .irq_compose_msi_msg    = irq_msi_compose_msg,
 331         .irq_write_msi_msg      = dmar_msi_write_msg,
 332         .flags                  = IRQCHIP_SKIP_SET_WAKE |
 333                                   IRQCHIP_AFFINITY_PRE_STARTUP,
 334 };
 335
 336 static irq_hw_number_t dmar_msi_get_hwirq(struct msi_domain_info *info,
 337                                           msi_alloc_info_t *arg)
 338 {
 339         return arg->dmar_id;
 340 }
 341
 342 static int dmar_msi_init(struct irq_domain *domain,
 343                          struct msi_domain_info *info, unsigned int virq,
 344                          irq_hw_number_t hwirq, msi_alloc_info_t *arg)
 345 {
 346         irq_domain_set_info(domain, virq, arg->dmar_id, info->chip, NULL,
 347                             handle_edge_irq, arg->dmar_data, "edge");
 348
 349         return 0;
 350 }
 351
 352 static struct msi_domain_ops dmar_msi_domain_ops = {
 353         .get_hwirq      = dmar_msi_get_hwirq,
 354         .msi_init       = dmar_msi_init,
 355 };
 356
 357 static struct msi_domain_info dmar_msi_domain_info = {
 358         .ops            = &dmar_msi_domain_ops,
 359         .chip           = &dmar_msi_controller,
 360 };
 361
 362 static struct irq_domain *dmar_get_irq_domain(void)
 363 {
 364         static struct irq_domain *dmar_domain;
 365         static DEFINE_MUTEX(dmar_lock);
 366         struct fwnode_handle *fn;
 367
 368         mutex_lock(&dmar_lock);
 369         if (dmar_domain)
 370                 goto out;
 371
 372         fn = irq_domain_alloc_named_fwnode("DMAR-MSI");
 373         if (fn) {
 374                 dmar_domain = msi_create_irq_domain(fn, &dmar_msi_domain_info,
 375                                                     x86_vector_domain);
 376                 if (!dmar_domain)
 377                         irq_domain_free_fwnode(fn);
 378         }
 379 out:
 380         mutex_unlock(&dmar_lock);
 381         return dmar_domain;
 382 }
 383
 384 int dmar_alloc_hwirq(int id, int node, void *arg)
 385 {
 386         struct irq_domain *domain = dmar_get_irq_domain();
 387         struct irq_alloc_info info;
 388
 389         if (!domain)
 390                 return -1;
 391
 392         init_irq_alloc_info(&info, NULL);
 393         info.type = X86_IRQ_ALLOC_TYPE_DMAR;
 394         info.dmar_id = id;
 395         info.dmar_data = arg;
 396
 397         return irq_domain_alloc_irqs(domain, 1, node, &info);
 398 }
 399
 400 void dmar_free_hwirq(int irq)
 401 {
 402         irq_domain_free_irqs(irq, 1);
 403 }
 404 #endif
 405
 406 /*
 407  * MSI message composition
 408  */
 409 #ifdef CONFIG_HPET_TIMER
 410 static inline int hpet_dev_id(struct irq_domain *domain)
 411 {
 412         struct msi_domain_info *info = msi_get_domain_info(domain);
 413
 414         return (int)(long)info->data;
 415 }
 416
 417 static void hpet_msi_write_msg(struct irq_data *data, struct msi_msg *msg)
 418 {
 419         hpet_msi_write(irq_data_get_irq_handler_data(data), msg);
 420 }
 421
 422 static struct irq_chip hpet_msi_controller __ro_after_init = {
 423         .name = "HPET-MSI",
 424         .irq_unmask = hpet_msi_unmask,
 425         .irq_mask = hpet_msi_mask,
 426         .irq_ack = irq_chip_ack_parent,
 427         .irq_set_affinity = msi_domain_set_affinity,
 428         .irq_retrigger = irq_chip_retrigger_hierarchy,
 429         .irq_compose_msi_msg = irq_msi_compose_msg,
 430         .irq_write_msi_msg = hpet_msi_write_msg,
 431         .flags = IRQCHIP_SKIP_SET_WAKE | IRQCHIP_AFFINITY_PRE_STARTUP,
 432 };
 433
 434 static irq_hw_number_t hpet_msi_get_hwirq(struct msi_domain_info *info,
 435                                           msi_alloc_info_t *arg)
 436 {
 437         return arg->hpet_index;
 438 }
 439
 440 static int hpet_msi_init(struct irq_domain *domain,
 441                          struct msi_domain_info *info, unsigned int virq,
 442                          irq_hw_number_t hwirq, msi_alloc_info_t *arg)
 443 {
 444         irq_set_status_flags(virq, IRQ_MOVE_PCNTXT);
 445         irq_domain_set_info(domain, virq, arg->hpet_index, info->chip, NULL,
 446                             handle_edge_irq, arg->hpet_data, "edge");
 447
 448         return 0;
 449 }
 450
 451 static void hpet_msi_free(struct irq_domain *domain,
 452                           struct msi_domain_info *info, unsigned int virq)
 453 {
 454         irq_clear_status_flags(virq, IRQ_MOVE_PCNTXT);
 455 }
 456
 457 static struct msi_domain_ops hpet_msi_domain_ops = {
 458         .get_hwirq      = hpet_msi_get_hwirq,
 459         .msi_init       = hpet_msi_init,
 460         .msi_free       = hpet_msi_free,
 461 };
 462
 463 static struct msi_domain_info hpet_msi_domain_info = {
 464         .ops            = &hpet_msi_domain_ops,
 465         .chip           = &hpet_msi_controller,
 466 };
 467
 468 struct irq_domain *hpet_create_irq_domain(int hpet_id)
 469 {
 470         struct msi_domain_info *domain_info;
 471         struct irq_domain *parent, *d;
 472         struct irq_alloc_info info;
 473         struct fwnode_handle *fn;
 474
 475         if (x86_vector_domain == NULL)
 476                 return NULL;
 477
 478         domain_info = kzalloc(sizeof(*domain_info), GFP_KERNEL);
 479         if (!domain_info)
 480                 return NULL;
 481
 482         *domain_info = hpet_msi_domain_info;
 483         domain_info->data = (void *)(long)hpet_id;
 484
 485         init_irq_alloc_info(&info, NULL);
 486         info.type = X86_IRQ_ALLOC_TYPE_HPET;
 487         info.hpet_id = hpet_id;
 488         parent = irq_remapping_get_ir_irq_domain(&info);
 489         if (parent == NULL)
 490                 parent = x86_vector_domain;
 491         else
 492                 hpet_msi_controller.name = "IR-HPET-MSI";
 493
 494         fn = irq_domain_alloc_named_id_fwnode(hpet_msi_controller.name,
 495                                               hpet_id);
 496         if (!fn) {
 497                 kfree(domain_info);
 498                 return NULL;
 499         }
 500
 501         d = msi_create_irq_domain(fn, domain_info, parent);
 502         if (!d) {
 503                 irq_domain_free_fwnode(fn);
 504                 kfree(domain_info);
 505         }
 506         return d;
 507 }
 508
 509 int hpet_assign_irq(struct irq_domain *domain, struct hpet_dev *dev,
 510                     int dev_num)
 511 {
 512         struct irq_alloc_info info;
 513
 514         init_irq_alloc_info(&info, NULL);
 515         info.type = X86_IRQ_ALLOC_TYPE_HPET;
 516         info.hpet_data = dev;
 517         info.hpet_id = hpet_dev_id(domain);
 518         info.hpet_index = dev_num;
 519
 520         return irq_domain_alloc_irqs(domain, 1, NUMA_NO_NODE, &info);
 521 }
 522 #endif