arch/powerpc/platforms/pseries/msi.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright 2006 Jake Moilanen <moilanen@austin.ibm.com>, IBM Corp.
   4  * Copyright 2006-2007 Michael Ellerman, IBM Corp.
   5  */
   6
   7 #include <linux/crash_dump.h>
   8 #include <linux/device.h>
   9 #include <linux/irq.h>
  10 #include <linux/msi.h>
  11
  12 #include <asm/rtas.h>
  13 #include <asm/hw_irq.h>
  14 #include <asm/ppc-pci.h>
  15 #include <asm/machdep.h>
  16
  17 #include "pseries.h"
  18
  19 static int query_token, change_token;
  20
  21 #define RTAS_QUERY_FN           0
  22 #define RTAS_CHANGE_FN          1
  23 #define RTAS_RESET_FN           2
  24 #define RTAS_CHANGE_MSI_FN      3
  25 #define RTAS_CHANGE_MSIX_FN     4
  26 #define RTAS_CHANGE_32MSI_FN    5
  27
  28 /* RTAS Helpers */
  29
  30 static int rtas_change_msi(struct pci_dn *pdn, u32 func, u32 num_irqs)
  31 {
  32         u32 addr, seq_num, rtas_ret[3];
  33         unsigned long buid;
  34         int rc;
  35
  36         addr = rtas_config_addr(pdn->busno, pdn->devfn, 0);
  37         buid = pdn->phb->buid;
  38
  39         seq_num = 1;
  40         do {
  41                 if (func == RTAS_CHANGE_MSI_FN || func == RTAS_CHANGE_MSIX_FN ||
  42                     func == RTAS_CHANGE_32MSI_FN)
  43                         rc = rtas_call(change_token, 6, 4, rtas_ret, addr,
  44                                         BUID_HI(buid), BUID_LO(buid),
  45                                         func, num_irqs, seq_num);
  46                 else
  47                         rc = rtas_call(change_token, 6, 3, rtas_ret, addr,
  48                                         BUID_HI(buid), BUID_LO(buid),
  49                                         func, num_irqs, seq_num);
  50
  51                 seq_num = rtas_ret[1];
  52         } while (rtas_busy_delay(rc));
  53
  54         /*
  55          * If the RTAS call succeeded, return the number of irqs allocated.
  56          * If not, make sure we return a negative error code.
  57          */
  58         if (rc == 0)
  59                 rc = rtas_ret[0];
  60         else if (rc > 0)
  61                 rc = -rc;
  62
  63         pr_debug("rtas_msi: ibm,change_msi(func=%d,num=%d), got %d rc = %d\n",
  64                  func, num_irqs, rtas_ret[0], rc);
  65
  66         return rc;
  67 }
  68
  69 static void rtas_disable_msi(struct pci_dev *pdev)
  70 {
  71         struct pci_dn *pdn;
  72
  73         pdn = pci_get_pdn(pdev);
  74         if (!pdn)
  75                 return;
  76
  77         /*
  78          * disabling MSI with the explicit interface also disables MSI-X
  79          */
  80         if (rtas_change_msi(pdn, RTAS_CHANGE_MSI_FN, 0) != 0) {
  81                 /*
  82                  * may have failed because explicit interface is not
  83                  * present
  84                  */
  85                 if (rtas_change_msi(pdn, RTAS_CHANGE_FN, 0) != 0) {
  86                         pr_debug("rtas_msi: Setting MSIs to 0 failed!\n");
  87                 }
  88         }
  89 }
  90
  91 static int rtas_query_irq_number(struct pci_dn *pdn, int offset)
  92 {
  93         u32 addr, rtas_ret[2];
  94         unsigned long buid;
  95         int rc;
  96
  97         addr = rtas_config_addr(pdn->busno, pdn->devfn, 0);
  98         buid = pdn->phb->buid;
  99
 100         do {
 101                 rc = rtas_call(query_token, 4, 3, rtas_ret, addr,
 102                                BUID_HI(buid), BUID_LO(buid), offset);
 103         } while (rtas_busy_delay(rc));
 104
 105         if (rc) {
 106                 pr_debug("rtas_msi: error (%d) querying source number\n", rc);
 107                 return rc;
 108         }
 109
 110         return rtas_ret[0];
 111 }
 112
 113 static void rtas_teardown_msi_irqs(struct pci_dev *pdev)
 114 {
 115         struct msi_desc *entry;
 116
 117         for_each_pci_msi_entry(entry, pdev) {
 118                 if (!entry->irq)
 119                         continue;
 120
 121                 irq_set_msi_desc(entry->irq, NULL);
 122                 irq_dispose_mapping(entry->irq);
 123         }
 124
 125         rtas_disable_msi(pdev);
 126 }
 127
 128 static int check_req(struct pci_dev *pdev, int nvec, char *prop_name)
 129 {
 130         struct device_node *dn;
 131         const __be32 *p;
 132         u32 req_msi;
 133
 134         dn = pci_device_to_OF_node(pdev);
 135
 136         p = of_get_property(dn, prop_name, NULL);
 137         if (!p) {
 138                 pr_debug("rtas_msi: No %s on %pOF\n", prop_name, dn);
 139                 return -ENOENT;
 140         }
 141
 142         req_msi = be32_to_cpup(p);
 143         if (req_msi < nvec) {
 144                 pr_debug("rtas_msi: %s requests < %d MSIs\n", prop_name, nvec);
 145
 146                 if (req_msi == 0) /* Be paranoid */
 147                         return -ENOSPC;
 148
 149                 return req_msi;
 150         }
 151
 152         return 0;
 153 }
 154
 155 static int check_req_msi(struct pci_dev *pdev, int nvec)
 156 {
 157         return check_req(pdev, nvec, "ibm,req#msi");
 158 }
 159
 160 static int check_req_msix(struct pci_dev *pdev, int nvec)
 161 {
 162         return check_req(pdev, nvec, "ibm,req#msi-x");
 163 }
 164
 165 /* Quota calculation */
 166
 167 static struct device_node *__find_pe_total_msi(struct device_node *node, int *total)
 168 {
 169         struct device_node *dn;
 170         const __be32 *p;
 171
 172         dn = of_node_get(node);
 173         while (dn) {
 174                 p = of_get_property(dn, "ibm,pe-total-#msi", NULL);
 175                 if (p) {
 176                         pr_debug("rtas_msi: found prop on dn %pOF\n",
 177                                 dn);
 178                         *total = be32_to_cpup(p);
 179                         return dn;
 180                 }
 181
 182                 dn = of_get_next_parent(dn);
 183         }
 184
 185         return NULL;
 186 }
 187
 188 static struct device_node *find_pe_total_msi(struct pci_dev *dev, int *total)
 189 {
 190         return __find_pe_total_msi(pci_device_to_OF_node(dev), total);
 191 }
 192
 193 static struct device_node *find_pe_dn(struct pci_dev *dev, int *total)
 194 {
 195         struct device_node *dn;
 196         struct eeh_dev *edev;
 197
 198         /* Found our PE and assume 8 at that point. */
 199
 200         dn = pci_device_to_OF_node(dev);
 201         if (!dn)
 202                 return NULL;
 203
 204         /* Get the top level device in the PE */
 205         edev = pdn_to_eeh_dev(PCI_DN(dn));
 206         if (edev->pe)
 207                 edev = list_first_entry(&edev->pe->edevs, struct eeh_dev,
 208                                         entry);
 209         dn = pci_device_to_OF_node(edev->pdev);
 210         if (!dn)
 211                 return NULL;
 212
 213         /* We actually want the parent */
 214         dn = of_get_parent(dn);
 215         if (!dn)
 216                 return NULL;
 217
 218         /* Hardcode of 8 for old firmwares */
 219         *total = 8;
 220         pr_debug("rtas_msi: using PE dn %pOF\n", dn);
 221
 222         return dn;
 223 }
 224
 225 struct msi_counts {
 226         struct device_node *requestor;
 227         int num_devices;
 228         int request;
 229         int quota;
 230         int spare;
 231         int over_quota;
 232 };
 233
 234 static void *count_non_bridge_devices(struct device_node *dn, void *data)
 235 {
 236         struct msi_counts *counts = data;
 237         const __be32 *p;
 238         u32 class;
 239
 240         pr_debug("rtas_msi: counting %pOF\n", dn);
 241
 242         p = of_get_property(dn, "class-code", NULL);
 243         class = p ? be32_to_cpup(p) : 0;
 244
 245         if ((class >> 8) != PCI_CLASS_BRIDGE_PCI)
 246                 counts->num_devices++;
 247
 248         return NULL;
 249 }
 250
 251 static void *count_spare_msis(struct device_node *dn, void *data)
 252 {
 253         struct msi_counts *counts = data;
 254         const __be32 *p;
 255         int req;
 256
 257         if (dn == counts->requestor)
 258                 req = counts->request;
 259         else {
 260                 /* We don't know if a driver will try to use MSI or MSI-X,
 261                  * so we just have to punt and use the larger of the two. */
 262                 req = 0;
 263                 p = of_get_property(dn, "ibm,req#msi", NULL);
 264                 if (p)
 265                         req = be32_to_cpup(p);
 266
 267                 p = of_get_property(dn, "ibm,req#msi-x", NULL);
 268                 if (p)
 269                         req = max(req, (int)be32_to_cpup(p));
 270         }
 271
 272         if (req < counts->quota)
 273                 counts->spare += counts->quota - req;
 274         else if (req > counts->quota)
 275                 counts->over_quota++;
 276
 277         return NULL;
 278 }
 279
 280 static int msi_quota_for_device(struct pci_dev *dev, int request)
 281 {
 282         struct device_node *pe_dn;
 283         struct msi_counts counts;
 284         int total;
 285
 286         pr_debug("rtas_msi: calc quota for %s, request %d\n", pci_name(dev),
 287                   request);
 288
 289         pe_dn = find_pe_total_msi(dev, &total);
 290         if (!pe_dn)
 291                 pe_dn = find_pe_dn(dev, &total);
 292
 293         if (!pe_dn) {
 294                 pr_err("rtas_msi: couldn't find PE for %s\n", pci_name(dev));
 295                 goto out;
 296         }
 297
 298         pr_debug("rtas_msi: found PE %pOF\n", pe_dn);
 299
 300         memset(&counts, 0, sizeof(struct msi_counts));
 301
 302         /* Work out how many devices we have below this PE */
 303         pci_traverse_device_nodes(pe_dn, count_non_bridge_devices, &counts);
 304
 305         if (counts.num_devices == 0) {
 306                 pr_err("rtas_msi: found 0 devices under PE for %s\n",
 307                         pci_name(dev));
 308                 goto out;
 309         }
 310
 311         counts.quota = total / counts.num_devices;
 312         if (request <= counts.quota)
 313                 goto out;
 314
 315         /* else, we have some more calculating to do */
 316         counts.requestor = pci_device_to_OF_node(dev);
 317         counts.request = request;
 318         pci_traverse_device_nodes(pe_dn, count_spare_msis, &counts);
 319
 320         /* If the quota isn't an integer multiple of the total, we can
 321          * use the remainder as spare MSIs for anyone that wants them. */
 322         counts.spare += total % counts.num_devices;
 323
 324         /* Divide any spare by the number of over-quota requestors */
 325         if (counts.over_quota)
 326                 counts.quota += counts.spare / counts.over_quota;
 327
 328         /* And finally clamp the request to the possibly adjusted quota */
 329         request = min(counts.quota, request);
 330
 331         pr_debug("rtas_msi: request clamped to quota %d\n", request);
 332 out:
 333         of_node_put(pe_dn);
 334
 335         return request;
 336 }
 337
 338 static int check_msix_entries(struct pci_dev *pdev)
 339 {
 340         struct msi_desc *entry;
 341         int expected;
 342
 343         /* There's no way for us to express to firmware that we want
 344          * a discontiguous, or non-zero based, range of MSI-X entries.
 345          * So we must reject such requests. */
 346
 347         expected = 0;
 348         for_each_pci_msi_entry(entry, pdev) {
 349                 if (entry->msi_attrib.entry_nr != expected) {
 350                         pr_debug("rtas_msi: bad MSI-X entries.\n");
 351                         return -EINVAL;
 352                 }
 353                 expected++;
 354         }
 355
 356         return 0;
 357 }
 358
 359 static void rtas_hack_32bit_msi_gen2(struct pci_dev *pdev)
 360 {
 361         u32 addr_hi, addr_lo;
 362
 363         /*
 364          * We should only get in here for IODA1 configs. This is based on the
 365          * fact that we using RTAS for MSIs, we don't have the 32 bit MSI RTAS
 366          * support, and we are in a PCIe Gen2 slot.
 367          */
 368         dev_info(&pdev->dev,
 369                  "rtas_msi: No 32 bit MSI firmware support, forcing 32 bit MSI\n");
 370         pci_read_config_dword(pdev, pdev->msi_cap + PCI_MSI_ADDRESS_HI, &addr_hi);
 371         addr_lo = 0xffff0000 | ((addr_hi >> (48 - 32)) << 4);
 372         pci_write_config_dword(pdev, pdev->msi_cap + PCI_MSI_ADDRESS_LO, addr_lo);
 373         pci_write_config_dword(pdev, pdev->msi_cap + PCI_MSI_ADDRESS_HI, 0);
 374 }
 375
 376 static int rtas_setup_msi_irqs(struct pci_dev *pdev, int nvec_in, int type)
 377 {
 378         struct pci_dn *pdn;
 379         int hwirq, virq, i, quota, rc;
 380         struct msi_desc *entry;
 381         struct msi_msg msg;
 382         int nvec = nvec_in;
 383         int use_32bit_msi_hack = 0;
 384
 385         if (type == PCI_CAP_ID_MSIX)
 386                 rc = check_req_msix(pdev, nvec);
 387         else
 388                 rc = check_req_msi(pdev, nvec);
 389
 390         if (rc)
 391                 return rc;
 392
 393         quota = msi_quota_for_device(pdev, nvec);
 394
 395         if (quota && quota < nvec)
 396                 return quota;
 397
 398         if (type == PCI_CAP_ID_MSIX && check_msix_entries(pdev))
 399                 return -EINVAL;
 400
 401         /*
 402          * Firmware currently refuse any non power of two allocation
 403          * so we round up if the quota will allow it.
 404          */
 405         if (type == PCI_CAP_ID_MSIX) {
 406                 int m = roundup_pow_of_two(nvec);
 407                 quota = msi_quota_for_device(pdev, m);
 408
 409                 if (quota >= m)
 410                         nvec = m;
 411         }
 412
 413         pdn = pci_get_pdn(pdev);
 414
 415         /*
 416          * Try the new more explicit firmware interface, if that fails fall
 417          * back to the old interface. The old interface is known to never
 418          * return MSI-Xs.
 419          */
 420 again:
 421         if (type == PCI_CAP_ID_MSI) {
 422                 if (pdev->no_64bit_msi) {
 423                         rc = rtas_change_msi(pdn, RTAS_CHANGE_32MSI_FN, nvec);
 424                         if (rc < 0) {
 425                                 /*
 426                                  * We only want to run the 32 bit MSI hack below if
 427                                  * the max bus speed is Gen2 speed
 428                                  */
 429                                 if (pdev->bus->max_bus_speed != PCIE_SPEED_5_0GT)
 430                                         return rc;
 431
 432                                 use_32bit_msi_hack = 1;
 433                         }
 434                 } else
 435                         rc = -1;
 436
 437                 if (rc < 0)
 438                         rc = rtas_change_msi(pdn, RTAS_CHANGE_MSI_FN, nvec);
 439
 440                 if (rc < 0) {
 441                         pr_debug("rtas_msi: trying the old firmware call.\n");
 442                         rc = rtas_change_msi(pdn, RTAS_CHANGE_FN, nvec);
 443                 }
 444
 445                 if (use_32bit_msi_hack && rc > 0)
 446                         rtas_hack_32bit_msi_gen2(pdev);
 447         } else
 448                 rc = rtas_change_msi(pdn, RTAS_CHANGE_MSIX_FN, nvec);
 449
 450         if (rc != nvec) {
 451                 if (nvec != nvec_in) {
 452                         nvec = nvec_in;
 453                         goto again;
 454                 }
 455                 pr_debug("rtas_msi: rtas_change_msi() failed\n");
 456                 return rc;
 457         }
 458
 459         i = 0;
 460         for_each_pci_msi_entry(entry, pdev) {
 461                 hwirq = rtas_query_irq_number(pdn, i++);
 462                 if (hwirq < 0) {
 463                         pr_debug("rtas_msi: error (%d) getting hwirq\n", rc);
 464                         return hwirq;
 465                 }
 466
 467                 /*
 468                  * Depending on the number of online CPUs in the original
 469                  * kernel, it is likely for CPU #0 to be offline in a kdump
 470                  * kernel. The associated IRQs in the affinity mappings
 471                  * provided by irq_create_affinity_masks() are thus not
 472                  * started by irq_startup(), as per-design for managed IRQs.
 473                  * This can be a problem with multi-queue block devices driven
 474                  * by blk-mq : such a non-started IRQ is very likely paired
 475                  * with the single queue enforced by blk-mq during kdump (see
 476                  * blk_mq_alloc_tag_set()). This causes the device to remain
 477                  * silent and likely hangs the guest at some point.
 478                  *
 479                  * We don't really care for fine-grained affinity when doing
 480                  * kdump actually : simply ignore the pre-computed affinity
 481                  * masks in this case and let the default mask with all CPUs
 482                  * be used when creating the IRQ mappings.
 483                  */
 484                 if (is_kdump_kernel())
 485                         virq = irq_create_mapping(NULL, hwirq);
 486                 else
 487                         virq = irq_create_mapping_affinity(NULL, hwirq,
 488                                                            entry->affinity);
 489
 490                 if (!virq) {
 491                         pr_debug("rtas_msi: Failed mapping hwirq %d\n", hwirq);
 492                         return -ENOSPC;
 493                 }
 494
 495                 dev_dbg(&pdev->dev, "rtas_msi: allocated virq %d\n", virq);
 496                 irq_set_msi_desc(virq, entry);
 497
 498                 /* Read config space back so we can restore after reset */
 499                 __pci_read_msi_msg(entry, &msg);
 500                 entry->msg = msg;
 501         }
 502
 503         return 0;
 504 }
 505
 506 static void rtas_msi_pci_irq_fixup(struct pci_dev *pdev)
 507 {
 508         /* No LSI -> leave MSIs (if any) configured */
 509         if (!pdev->irq) {
 510                 dev_dbg(&pdev->dev, "rtas_msi: no LSI, nothing to do.\n");
 511                 return;
 512         }
 513
 514         /* No MSI -> MSIs can't have been assigned by fw, leave LSI */
 515         if (check_req_msi(pdev, 1) && check_req_msix(pdev, 1)) {
 516                 dev_dbg(&pdev->dev, "rtas_msi: no req#msi/x, nothing to do.\n");
 517                 return;
 518         }
 519
 520         dev_dbg(&pdev->dev, "rtas_msi: disabling existing MSI.\n");
 521         rtas_disable_msi(pdev);
 522 }
 523
 524 static int rtas_msi_init(void)
 525 {
 526         struct pci_controller *phb;
 527
 528         query_token  = rtas_token("ibm,query-interrupt-source-number");
 529         change_token = rtas_token("ibm,change-msi");
 530
 531         if ((query_token == RTAS_UNKNOWN_SERVICE) ||
 532                         (change_token == RTAS_UNKNOWN_SERVICE)) {
 533                 pr_debug("rtas_msi: no RTAS tokens, no MSI support.\n");
 534                 return -1;
 535         }
 536
 537         pr_debug("rtas_msi: Registering RTAS MSI callbacks.\n");
 538
 539         WARN_ON(pseries_pci_controller_ops.setup_msi_irqs);
 540         pseries_pci_controller_ops.setup_msi_irqs = rtas_setup_msi_irqs;
 541         pseries_pci_controller_ops.teardown_msi_irqs = rtas_teardown_msi_irqs;
 542
 543         list_for_each_entry(phb, &hose_list, list_node) {
 544                 WARN_ON(phb->controller_ops.setup_msi_irqs);
 545                 phb->controller_ops.setup_msi_irqs = rtas_setup_msi_irqs;
 546                 phb->controller_ops.teardown_msi_irqs = rtas_teardown_msi_irqs;
 547         }
 548
 549         WARN_ON(ppc_md.pci_irq_fixup);
 550         ppc_md.pci_irq_fixup = rtas_msi_pci_irq_fixup;
 551
 552         return 0;
 553 }
 554 machine_arch_initcall(pseries, rtas_msi_init);