1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright 2006 Jake Moilanen <moilanen@austin.ibm.com>, IBM Corp.
4 * Copyright 2006-2007 Michael Ellerman, IBM Corp.
7 #include <linux/crash_dump.h>
8 #include <linux/device.h>
10 #include <linux/msi.h>
13 #include <asm/hw_irq.h>
14 #include <asm/ppc-pci.h>
15 #include <asm/machdep.h>
20 static int query_token, change_token;
22 #define RTAS_QUERY_FN 0
23 #define RTAS_CHANGE_FN 1
24 #define RTAS_RESET_FN 2
25 #define RTAS_CHANGE_MSI_FN 3
26 #define RTAS_CHANGE_MSIX_FN 4
27 #define RTAS_CHANGE_32MSI_FN 5
31 static int rtas_change_msi(struct pci_dn *pdn, u32 func, u32 num_irqs)
33 u32 addr, seq_num, rtas_ret[3];
37 addr = rtas_config_addr(pdn->busno, pdn->devfn, 0);
38 buid = pdn->phb->buid;
42 if (func == RTAS_CHANGE_MSI_FN || func == RTAS_CHANGE_MSIX_FN ||
43 func == RTAS_CHANGE_32MSI_FN)
44 rc = rtas_call(change_token, 6, 4, rtas_ret, addr,
45 BUID_HI(buid), BUID_LO(buid),
46 func, num_irqs, seq_num);
48 rc = rtas_call(change_token, 6, 3, rtas_ret, addr,
49 BUID_HI(buid), BUID_LO(buid),
50 func, num_irqs, seq_num);
52 seq_num = rtas_ret[1];
53 } while (rtas_busy_delay(rc));
56 * If the RTAS call succeeded, return the number of irqs allocated.
57 * If not, make sure we return a negative error code.
64 pr_debug("rtas_msi: ibm,change_msi(func=%d,num=%d), got %d rc = %d\n",
65 func, num_irqs, rtas_ret[0], rc);
70 static void rtas_disable_msi(struct pci_dev *pdev)
74 pdn = pci_get_pdn(pdev);
79 * disabling MSI with the explicit interface also disables MSI-X
81 if (rtas_change_msi(pdn, RTAS_CHANGE_MSI_FN, 0) != 0) {
83 * may have failed because explicit interface is not
86 if (rtas_change_msi(pdn, RTAS_CHANGE_FN, 0) != 0) {
87 pr_debug("rtas_msi: Setting MSIs to 0 failed!\n");
92 static int rtas_query_irq_number(struct pci_dn *pdn, int offset)
94 u32 addr, rtas_ret[2];
98 addr = rtas_config_addr(pdn->busno, pdn->devfn, 0);
99 buid = pdn->phb->buid;
102 rc = rtas_call(query_token, 4, 3, rtas_ret, addr,
103 BUID_HI(buid), BUID_LO(buid), offset);
104 } while (rtas_busy_delay(rc));
107 pr_debug("rtas_msi: error (%d) querying source number\n", rc);
114 static int check_req(struct pci_dev *pdev, int nvec, char *prop_name)
116 struct device_node *dn;
120 dn = pci_device_to_OF_node(pdev);
122 p = of_get_property(dn, prop_name, NULL);
124 pr_debug("rtas_msi: No %s on %pOF\n", prop_name, dn);
128 req_msi = be32_to_cpup(p);
129 if (req_msi < nvec) {
130 pr_debug("rtas_msi: %s requests < %d MSIs\n", prop_name, nvec);
132 if (req_msi == 0) /* Be paranoid */
141 static int check_req_msi(struct pci_dev *pdev, int nvec)
143 return check_req(pdev, nvec, "ibm,req#msi");
146 static int check_req_msix(struct pci_dev *pdev, int nvec)
148 return check_req(pdev, nvec, "ibm,req#msi-x");
151 /* Quota calculation */
153 static struct device_node *__find_pe_total_msi(struct device_node *node, int *total)
155 struct device_node *dn;
158 dn = of_node_get(node);
160 p = of_get_property(dn, "ibm,pe-total-#msi", NULL);
162 pr_debug("rtas_msi: found prop on dn %pOF\n",
164 *total = be32_to_cpup(p);
168 dn = of_get_next_parent(dn);
174 static struct device_node *find_pe_total_msi(struct pci_dev *dev, int *total)
176 return __find_pe_total_msi(pci_device_to_OF_node(dev), total);
179 static struct device_node *find_pe_dn(struct pci_dev *dev, int *total)
181 struct device_node *dn;
182 struct eeh_dev *edev;
184 /* Found our PE and assume 8 at that point. */
186 dn = pci_device_to_OF_node(dev);
190 /* Get the top level device in the PE */
191 edev = pdn_to_eeh_dev(PCI_DN(dn));
193 edev = list_first_entry(&edev->pe->edevs, struct eeh_dev,
195 dn = pci_device_to_OF_node(edev->pdev);
199 /* We actually want the parent */
200 dn = of_get_parent(dn);
204 /* Hardcode of 8 for old firmwares */
206 pr_debug("rtas_msi: using PE dn %pOF\n", dn);
212 struct device_node *requestor;
220 static void *count_non_bridge_devices(struct device_node *dn, void *data)
222 struct msi_counts *counts = data;
226 pr_debug("rtas_msi: counting %pOF\n", dn);
228 p = of_get_property(dn, "class-code", NULL);
229 class = p ? be32_to_cpup(p) : 0;
231 if ((class >> 8) != PCI_CLASS_BRIDGE_PCI)
232 counts->num_devices++;
237 static void *count_spare_msis(struct device_node *dn, void *data)
239 struct msi_counts *counts = data;
243 if (dn == counts->requestor)
244 req = counts->request;
246 /* We don't know if a driver will try to use MSI or MSI-X,
247 * so we just have to punt and use the larger of the two. */
249 p = of_get_property(dn, "ibm,req#msi", NULL);
251 req = be32_to_cpup(p);
253 p = of_get_property(dn, "ibm,req#msi-x", NULL);
255 req = max(req, (int)be32_to_cpup(p));
258 if (req < counts->quota)
259 counts->spare += counts->quota - req;
260 else if (req > counts->quota)
261 counts->over_quota++;
266 static int msi_quota_for_device(struct pci_dev *dev, int request)
268 struct device_node *pe_dn;
269 struct msi_counts counts;
272 pr_debug("rtas_msi: calc quota for %s, request %d\n", pci_name(dev),
275 pe_dn = find_pe_total_msi(dev, &total);
277 pe_dn = find_pe_dn(dev, &total);
280 pr_err("rtas_msi: couldn't find PE for %s\n", pci_name(dev));
284 pr_debug("rtas_msi: found PE %pOF\n", pe_dn);
286 memset(&counts, 0, sizeof(struct msi_counts));
288 /* Work out how many devices we have below this PE */
289 pci_traverse_device_nodes(pe_dn, count_non_bridge_devices, &counts);
291 if (counts.num_devices == 0) {
292 pr_err("rtas_msi: found 0 devices under PE for %s\n",
297 counts.quota = total / counts.num_devices;
298 if (request <= counts.quota)
301 /* else, we have some more calculating to do */
302 counts.requestor = pci_device_to_OF_node(dev);
303 counts.request = request;
304 pci_traverse_device_nodes(pe_dn, count_spare_msis, &counts);
306 /* If the quota isn't an integer multiple of the total, we can
307 * use the remainder as spare MSIs for anyone that wants them. */
308 counts.spare += total % counts.num_devices;
310 /* Divide any spare by the number of over-quota requestors */
311 if (counts.over_quota)
312 counts.quota += counts.spare / counts.over_quota;
314 /* And finally clamp the request to the possibly adjusted quota */
315 request = min(counts.quota, request);
317 pr_debug("rtas_msi: request clamped to quota %d\n", request);
324 static int check_msix_entries(struct pci_dev *pdev)
326 struct msi_desc *entry;
329 /* There's no way for us to express to firmware that we want
330 * a discontiguous, or non-zero based, range of MSI-X entries.
331 * So we must reject such requests. */
334 for_each_pci_msi_entry(entry, pdev) {
335 if (entry->msi_attrib.entry_nr != expected) {
336 pr_debug("rtas_msi: bad MSI-X entries.\n");
345 static void rtas_hack_32bit_msi_gen2(struct pci_dev *pdev)
347 u32 addr_hi, addr_lo;
350 * We should only get in here for IODA1 configs. This is based on the
351 * fact that we using RTAS for MSIs, we don't have the 32 bit MSI RTAS
352 * support, and we are in a PCIe Gen2 slot.
355 "rtas_msi: No 32 bit MSI firmware support, forcing 32 bit MSI\n");
356 pci_read_config_dword(pdev, pdev->msi_cap + PCI_MSI_ADDRESS_HI, &addr_hi);
357 addr_lo = 0xffff0000 | ((addr_hi >> (48 - 32)) << 4);
358 pci_write_config_dword(pdev, pdev->msi_cap + PCI_MSI_ADDRESS_LO, addr_lo);
359 pci_write_config_dword(pdev, pdev->msi_cap + PCI_MSI_ADDRESS_HI, 0);
362 static int rtas_prepare_msi_irqs(struct pci_dev *pdev, int nvec_in, int type,
363 msi_alloc_info_t *arg)
368 int use_32bit_msi_hack = 0;
370 if (type == PCI_CAP_ID_MSIX)
371 rc = check_req_msix(pdev, nvec);
373 rc = check_req_msi(pdev, nvec);
378 quota = msi_quota_for_device(pdev, nvec);
380 if (quota && quota < nvec)
383 if (type == PCI_CAP_ID_MSIX && check_msix_entries(pdev))
387 * Firmware currently refuse any non power of two allocation
388 * so we round up if the quota will allow it.
390 if (type == PCI_CAP_ID_MSIX) {
391 int m = roundup_pow_of_two(nvec);
392 quota = msi_quota_for_device(pdev, m);
398 pdn = pci_get_pdn(pdev);
401 * Try the new more explicit firmware interface, if that fails fall
402 * back to the old interface. The old interface is known to never
406 if (type == PCI_CAP_ID_MSI) {
407 if (pdev->no_64bit_msi) {
408 rc = rtas_change_msi(pdn, RTAS_CHANGE_32MSI_FN, nvec);
411 * We only want to run the 32 bit MSI hack below if
412 * the max bus speed is Gen2 speed
414 if (pdev->bus->max_bus_speed != PCIE_SPEED_5_0GT)
417 use_32bit_msi_hack = 1;
423 rc = rtas_change_msi(pdn, RTAS_CHANGE_MSI_FN, nvec);
426 pr_debug("rtas_msi: trying the old firmware call.\n");
427 rc = rtas_change_msi(pdn, RTAS_CHANGE_FN, nvec);
430 if (use_32bit_msi_hack && rc > 0)
431 rtas_hack_32bit_msi_gen2(pdev);
433 rc = rtas_change_msi(pdn, RTAS_CHANGE_MSIX_FN, nvec);
436 if (nvec != nvec_in) {
440 pr_debug("rtas_msi: rtas_change_msi() failed\n");
447 static int pseries_msi_ops_prepare(struct irq_domain *domain, struct device *dev,
448 int nvec, msi_alloc_info_t *arg)
450 struct pci_dev *pdev = to_pci_dev(dev);
451 struct msi_desc *desc = first_pci_msi_entry(pdev);
452 int type = desc->msi_attrib.is_msix ? PCI_CAP_ID_MSIX : PCI_CAP_ID_MSI;
454 return rtas_prepare_msi_irqs(pdev, nvec, type, arg);
458 * ->msi_free() is called before irq_domain_free_irqs_top() when the
459 * handler data is still available. Use that to clear the XIVE
462 static void pseries_msi_ops_msi_free(struct irq_domain *domain,
463 struct msi_domain_info *info,
467 xive_irq_free_data(irq);
471 * RTAS can not disable one MSI at a time. It's all or nothing. Do it
472 * at the end after all IRQs have been freed.
474 static void pseries_msi_domain_free_irqs(struct irq_domain *domain,
477 if (WARN_ON_ONCE(!dev_is_pci(dev)))
480 __msi_domain_free_irqs(domain, dev);
482 rtas_disable_msi(to_pci_dev(dev));
485 static struct msi_domain_ops pseries_pci_msi_domain_ops = {
486 .msi_prepare = pseries_msi_ops_prepare,
487 .msi_free = pseries_msi_ops_msi_free,
488 .domain_free_irqs = pseries_msi_domain_free_irqs,
491 static void pseries_msi_shutdown(struct irq_data *d)
494 if (d->chip->irq_shutdown)
495 d->chip->irq_shutdown(d);
498 static void pseries_msi_mask(struct irq_data *d)
501 irq_chip_mask_parent(d);
504 static void pseries_msi_unmask(struct irq_data *d)
506 pci_msi_unmask_irq(d);
507 irq_chip_unmask_parent(d);
510 static struct irq_chip pseries_pci_msi_irq_chip = {
511 .name = "pSeries-PCI-MSI",
512 .irq_shutdown = pseries_msi_shutdown,
513 .irq_mask = pseries_msi_mask,
514 .irq_unmask = pseries_msi_unmask,
515 .irq_eoi = irq_chip_eoi_parent,
518 static struct msi_domain_info pseries_msi_domain_info = {
519 .flags = (MSI_FLAG_USE_DEF_DOM_OPS | MSI_FLAG_USE_DEF_CHIP_OPS |
520 MSI_FLAG_MULTI_PCI_MSI | MSI_FLAG_PCI_MSIX),
521 .ops = &pseries_pci_msi_domain_ops,
522 .chip = &pseries_pci_msi_irq_chip,
525 static void pseries_msi_compose_msg(struct irq_data *data, struct msi_msg *msg)
527 __pci_read_msi_msg(irq_data_get_msi_desc(data), msg);
530 static struct irq_chip pseries_msi_irq_chip = {
531 .name = "pSeries-MSI",
532 .irq_shutdown = pseries_msi_shutdown,
533 .irq_mask = irq_chip_mask_parent,
534 .irq_unmask = irq_chip_unmask_parent,
535 .irq_eoi = irq_chip_eoi_parent,
536 .irq_set_affinity = irq_chip_set_affinity_parent,
537 .irq_compose_msi_msg = pseries_msi_compose_msg,
540 static int pseries_irq_parent_domain_alloc(struct irq_domain *domain, unsigned int virq,
541 irq_hw_number_t hwirq)
543 struct irq_fwspec parent_fwspec;
546 parent_fwspec.fwnode = domain->parent->fwnode;
547 parent_fwspec.param_count = 2;
548 parent_fwspec.param[0] = hwirq;
549 parent_fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
551 ret = irq_domain_alloc_irqs_parent(domain, virq, 1, &parent_fwspec);
558 static int pseries_irq_domain_alloc(struct irq_domain *domain, unsigned int virq,
559 unsigned int nr_irqs, void *arg)
561 struct pci_controller *phb = domain->host_data;
562 msi_alloc_info_t *info = arg;
563 struct msi_desc *desc = info->desc;
564 struct pci_dev *pdev = msi_desc_to_pci_dev(desc);
568 hwirq = rtas_query_irq_number(pci_get_pdn(pdev), desc->msi_attrib.entry_nr);
570 dev_err(&pdev->dev, "Failed to query HW IRQ: %d\n", hwirq);
574 dev_dbg(&pdev->dev, "%s bridge %pOF %d/%x #%d\n", __func__,
575 phb->dn, virq, hwirq, nr_irqs);
577 for (i = 0; i < nr_irqs; i++) {
578 ret = pseries_irq_parent_domain_alloc(domain, virq + i, hwirq + i);
582 irq_domain_set_hwirq_and_chip(domain, virq + i, hwirq + i,
583 &pseries_msi_irq_chip, domain->host_data);
589 /* TODO: handle RTAS cleanup in ->msi_finish() ? */
590 irq_domain_free_irqs_parent(domain, virq, i - 1);
594 static void pseries_irq_domain_free(struct irq_domain *domain, unsigned int virq,
595 unsigned int nr_irqs)
597 struct irq_data *d = irq_domain_get_irq_data(domain, virq);
598 struct pci_controller *phb = irq_data_get_irq_chip_data(d);
600 pr_debug("%s bridge %pOF %d #%d\n", __func__, phb->dn, virq, nr_irqs);
602 /* XIVE domain data is cleared through ->msi_free() */
605 static const struct irq_domain_ops pseries_irq_domain_ops = {
606 .alloc = pseries_irq_domain_alloc,
607 .free = pseries_irq_domain_free,
610 static int __pseries_msi_allocate_domains(struct pci_controller *phb,
613 struct irq_domain *parent = irq_get_default_host();
615 phb->fwnode = irq_domain_alloc_named_id_fwnode("pSeries-MSI",
620 phb->dev_domain = irq_domain_create_hierarchy(parent, 0, count,
622 &pseries_irq_domain_ops, phb);
623 if (!phb->dev_domain) {
624 pr_err("PCI: failed to create IRQ domain bridge %pOF (domain %d)\n",
625 phb->dn, phb->global_number);
626 irq_domain_free_fwnode(phb->fwnode);
630 phb->msi_domain = pci_msi_create_irq_domain(of_node_to_fwnode(phb->dn),
631 &pseries_msi_domain_info,
633 if (!phb->msi_domain) {
634 pr_err("PCI: failed to create MSI IRQ domain bridge %pOF (domain %d)\n",
635 phb->dn, phb->global_number);
636 irq_domain_free_fwnode(phb->fwnode);
637 irq_domain_remove(phb->dev_domain);
644 int pseries_msi_allocate_domains(struct pci_controller *phb)
648 if (!__find_pe_total_msi(phb->dn, &count)) {
649 pr_err("PCI: failed to find MSIs for bridge %pOF (domain %d)\n",
650 phb->dn, phb->global_number);
654 return __pseries_msi_allocate_domains(phb, count);
657 void pseries_msi_free_domains(struct pci_controller *phb)
660 irq_domain_remove(phb->msi_domain);
662 irq_domain_remove(phb->dev_domain);
664 irq_domain_free_fwnode(phb->fwnode);
667 static void rtas_msi_pci_irq_fixup(struct pci_dev *pdev)
669 /* No LSI -> leave MSIs (if any) configured */
671 dev_dbg(&pdev->dev, "rtas_msi: no LSI, nothing to do.\n");
675 /* No MSI -> MSIs can't have been assigned by fw, leave LSI */
676 if (check_req_msi(pdev, 1) && check_req_msix(pdev, 1)) {
677 dev_dbg(&pdev->dev, "rtas_msi: no req#msi/x, nothing to do.\n");
681 dev_dbg(&pdev->dev, "rtas_msi: disabling existing MSI.\n");
682 rtas_disable_msi(pdev);
685 static int rtas_msi_init(void)
687 query_token = rtas_token("ibm,query-interrupt-source-number");
688 change_token = rtas_token("ibm,change-msi");
690 if ((query_token == RTAS_UNKNOWN_SERVICE) ||
691 (change_token == RTAS_UNKNOWN_SERVICE)) {
692 pr_debug("rtas_msi: no RTAS tokens, no MSI support.\n");
696 pr_debug("rtas_msi: Registering RTAS MSI callbacks.\n");
698 WARN_ON(ppc_md.pci_irq_fixup);
699 ppc_md.pci_irq_fixup = rtas_msi_pci_irq_fixup;
703 machine_arch_initcall(pseries, rtas_msi_init);