2 * Copyright (c) 2008, 2009 QLogic Corporation. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 #include <linux/pci.h>
35 #include <linux/delay.h>
36 #include <linux/vmalloc.h>
37 #include <linux/aer.h>
42 * This file contains PCIe utility routines that are common to the
43 * various QLogic InfiniPath adapters
47 * Code to adjust PCIe capabilities.
48 * To minimize the change footprint, we call it
49 * from qib_pcie_params, which every chip-specific
50 * file calls, even though this violates some
51 * expectations of harmlessness.
53 static int qib_tune_pcie_caps(struct qib_devdata
*);
54 static int qib_tune_pcie_coalesce(struct qib_devdata
*);
57 * Do all the common PCIe setup and initialization.
58 * devdata is not yet allocated, and is not allocated until after this
59 * routine returns success. Therefore qib_dev_err() can't be used for error
62 int qib_pcie_init(struct pci_dev
*pdev
, const struct pci_device_id
*ent
)
66 ret
= pci_enable_device(pdev
);
69 * This can happen (in theory) iff:
70 * We did a chip reset, and then failed to reprogram the
71 * BAR, or the chip reset due to an internal error. We then
72 * unloaded the driver and reloaded it.
74 * Both reset cases set the BAR back to initial state. For
75 * the latter case, the AER sticky error bit at offset 0x718
76 * should be set, but the Linux kernel doesn't yet know
77 * about that, it appears. If the original BAR was retained
78 * in the kernel data structures, this may be OK.
80 qib_early_err(&pdev
->dev
, "pci enable failed: error %d\n",
85 ret
= pci_request_regions(pdev
, QIB_DRV_NAME
);
87 qib_devinfo(pdev
, "pci_request_regions fails: err %d\n", -ret
);
91 ret
= pci_set_dma_mask(pdev
, DMA_BIT_MASK(64));
94 * If the 64 bit setup fails, try 32 bit. Some systems
95 * do not setup 64 bit maps on systems with 2GB or less
98 ret
= pci_set_dma_mask(pdev
, DMA_BIT_MASK(32));
100 qib_devinfo(pdev
, "Unable to set DMA mask: %d\n", ret
);
103 ret
= pci_set_consistent_dma_mask(pdev
, DMA_BIT_MASK(32));
105 ret
= pci_set_consistent_dma_mask(pdev
, DMA_BIT_MASK(64));
107 qib_early_err(&pdev
->dev
,
108 "Unable to set DMA consistent mask: %d\n", ret
);
112 pci_set_master(pdev
);
113 ret
= pci_enable_pcie_error_reporting(pdev
);
115 qib_early_err(&pdev
->dev
,
116 "Unable to enable pcie error reporting: %d\n",
123 pci_disable_device(pdev
);
124 pci_release_regions(pdev
);
130 * Do remaining PCIe setup, once dd is allocated, and save away
131 * fields required to re-initialize after a chip reset, or for
132 * various other purposes
134 int qib_pcie_ddinit(struct qib_devdata
*dd
, struct pci_dev
*pdev
,
135 const struct pci_device_id
*ent
)
138 resource_size_t addr
;
141 pci_set_drvdata(pdev
, dd
);
143 addr
= pci_resource_start(pdev
, 0);
144 len
= pci_resource_len(pdev
, 0);
146 #if defined(__powerpc__)
147 /* There isn't a generic way to specify writethrough mappings */
148 dd
->kregbase
= __ioremap(addr
, len
, _PAGE_NO_CACHE
| _PAGE_WRITETHRU
);
150 dd
->kregbase
= ioremap_nocache(addr
, len
);
156 dd
->kregend
= (u64 __iomem
*)((void __iomem
*) dd
->kregbase
+ len
);
157 dd
->physaddr
= addr
; /* used for io_remap, etc. */
160 * Save BARs to rewrite after device reset. Save all 64 bits of
164 dd
->pcibar1
= addr
>> 32;
165 dd
->deviceid
= ent
->device
; /* save for later use */
166 dd
->vendorid
= ent
->vendor
;
172 * Do PCIe cleanup, after chip-specific cleanup, etc. Just prior
173 * to releasing the dd memory.
174 * void because none of the core pcie cleanup returns are void
176 void qib_pcie_ddcleanup(struct qib_devdata
*dd
)
178 u64 __iomem
*base
= (void __iomem
*) dd
->kregbase
;
183 iounmap(dd
->piobase
);
185 iounmap(dd
->userbase
);
187 iounmap(dd
->piovl15base
);
189 pci_disable_device(dd
->pcidev
);
190 pci_release_regions(dd
->pcidev
);
192 pci_set_drvdata(dd
->pcidev
, NULL
);
195 static void qib_msix_setup(struct qib_devdata
*dd
, int pos
, u32
*msixcnt
,
196 struct msix_entry
*msix_entry
)
202 pci_read_config_word(dd
->pcidev
, pos
+ PCI_MSIX_FLAGS
, &msix_flags
);
203 tabsize
= 1 + (msix_flags
& PCI_MSIX_FLAGS_QSIZE
);
204 if (tabsize
> *msixcnt
)
206 ret
= pci_enable_msix(dd
->pcidev
, msix_entry
, tabsize
);
209 ret
= pci_enable_msix(dd
->pcidev
, msix_entry
, tabsize
);
212 qib_dev_err(dd
, "pci_enable_msix %d vectors failed: %d, "
213 "falling back to INTx\n", tabsize
, ret
);
219 qib_enable_intx(dd
->pcidev
);
224 * We save the msi lo and hi values, so we can restore them after
225 * chip reset (the kernel PCI infrastructure doesn't yet handle that
228 static int qib_msi_setup(struct qib_devdata
*dd
, int pos
)
230 struct pci_dev
*pdev
= dd
->pcidev
;
234 ret
= pci_enable_msi(pdev
);
236 qib_dev_err(dd
, "pci_enable_msi failed: %d, "
237 "interrupts may not work\n", ret
);
238 /* continue even if it fails, we may still be OK... */
240 pci_read_config_dword(pdev
, pos
+ PCI_MSI_ADDRESS_LO
,
242 pci_read_config_dword(pdev
, pos
+ PCI_MSI_ADDRESS_HI
,
244 pci_read_config_word(pdev
, pos
+ PCI_MSI_FLAGS
, &control
);
245 /* now save the data (vector) info */
246 pci_read_config_word(pdev
, pos
+ ((control
& PCI_MSI_FLAGS_64BIT
)
252 int qib_pcie_params(struct qib_devdata
*dd
, u32 minw
, u32
*nent
,
253 struct msix_entry
*entry
)
256 int pos
= 0, pose
, ret
= 1;
258 pose
= pci_find_capability(dd
->pcidev
, PCI_CAP_ID_EXP
);
260 qib_dev_err(dd
, "Can't find PCI Express capability!\n");
261 /* set up something... */
263 dd
->lbus_speed
= 2500; /* Gen1, 2.5GHz */
267 pos
= pci_find_capability(dd
->pcidev
, PCI_CAP_ID_MSIX
);
268 if (nent
&& *nent
&& pos
) {
269 qib_msix_setup(dd
, pos
, nent
, entry
);
270 ret
= 0; /* did it, either MSIx or INTx */
272 pos
= pci_find_capability(dd
->pcidev
, PCI_CAP_ID_MSI
);
274 ret
= qib_msi_setup(dd
, pos
);
276 qib_dev_err(dd
, "No PCI MSI or MSIx capability!\n");
279 qib_enable_intx(dd
->pcidev
);
281 pci_read_config_word(dd
->pcidev
, pose
+ PCI_EXP_LNKSTA
, &linkstat
);
283 * speed is bits 0-3, linkwidth is bits 4-8
284 * no defines for them in headers
286 speed
= linkstat
& 0xf;
289 dd
->lbus_width
= linkstat
;
293 dd
->lbus_speed
= 2500; /* Gen1, 2.5GHz */
296 dd
->lbus_speed
= 5000; /* Gen1, 5GHz */
298 default: /* not defined, assume gen1 */
299 dd
->lbus_speed
= 2500;
304 * Check against expected pcie width and complain if "wrong"
305 * on first initialization, not afterwards (i.e., reset).
307 if (minw
&& linkstat
< minw
)
309 "PCIe width %u (x%u HCA), performance reduced\n",
312 qib_tune_pcie_caps(dd
);
314 qib_tune_pcie_coalesce(dd
);
317 /* fill in string, even on errors */
318 snprintf(dd
->lbus_info
, sizeof(dd
->lbus_info
),
319 "PCIe,%uMHz,x%u\n", dd
->lbus_speed
, dd
->lbus_width
);
324 * Setup pcie interrupt stuff again after a reset. I'd like to just call
325 * pci_enable_msi() again for msi, but when I do that,
326 * the MSI enable bit doesn't get set in the command word, and
327 * we switch to to a different interrupt vector, which is confusing,
328 * so I instead just do it all inline. Perhaps somehow can tie this
329 * into the PCIe hotplug support at some point
331 int qib_reinit_intr(struct qib_devdata
*dd
)
337 /* If we aren't using MSI, don't restore it */
341 pos
= pci_find_capability(dd
->pcidev
, PCI_CAP_ID_MSI
);
343 qib_dev_err(dd
, "Can't find MSI capability, "
344 "can't restore MSI settings\n");
346 /* nothing special for MSIx, just MSI */
349 pci_write_config_dword(dd
->pcidev
, pos
+ PCI_MSI_ADDRESS_LO
,
351 pci_write_config_dword(dd
->pcidev
, pos
+ PCI_MSI_ADDRESS_HI
,
353 pci_read_config_word(dd
->pcidev
, pos
+ PCI_MSI_FLAGS
, &control
);
354 if (!(control
& PCI_MSI_FLAGS_ENABLE
)) {
355 control
|= PCI_MSI_FLAGS_ENABLE
;
356 pci_write_config_word(dd
->pcidev
, pos
+ PCI_MSI_FLAGS
,
359 /* now rewrite the data (vector) info */
360 pci_write_config_word(dd
->pcidev
, pos
+
361 ((control
& PCI_MSI_FLAGS_64BIT
) ? 12 : 8),
365 if (!ret
&& (dd
->flags
& QIB_HAS_INTX
)) {
366 qib_enable_intx(dd
->pcidev
);
370 /* and now set the pci master bit again */
371 pci_set_master(dd
->pcidev
);
377 * Disable msi interrupt if enabled, and clear msi_lo.
378 * This is used primarily for the fallback to INTx, but
379 * is also used in reinit after reset, and during cleanup.
381 void qib_nomsi(struct qib_devdata
*dd
)
384 pci_disable_msi(dd
->pcidev
);
388 * Same as qib_nosmi, but for MSIx.
390 void qib_nomsix(struct qib_devdata
*dd
)
392 pci_disable_msix(dd
->pcidev
);
396 * Similar to pci_intx(pdev, 1), except that we make sure
399 void qib_enable_intx(struct pci_dev
*pdev
)
404 /* first, turn on INTx */
405 pci_read_config_word(pdev
, PCI_COMMAND
, &cw
);
406 new = cw
& ~PCI_COMMAND_INTX_DISABLE
;
408 pci_write_config_word(pdev
, PCI_COMMAND
, new);
410 pos
= pci_find_capability(pdev
, PCI_CAP_ID_MSI
);
412 /* then turn off MSI */
413 pci_read_config_word(pdev
, pos
+ PCI_MSI_FLAGS
, &cw
);
414 new = cw
& ~PCI_MSI_FLAGS_ENABLE
;
416 pci_write_config_word(pdev
, pos
+ PCI_MSI_FLAGS
, new);
418 pos
= pci_find_capability(pdev
, PCI_CAP_ID_MSIX
);
420 /* then turn off MSIx */
421 pci_read_config_word(pdev
, pos
+ PCI_MSIX_FLAGS
, &cw
);
422 new = cw
& ~PCI_MSIX_FLAGS_ENABLE
;
424 pci_write_config_word(pdev
, pos
+ PCI_MSIX_FLAGS
, new);
429 * These two routines are helper routines for the device reset code
430 * to move all the pcie code out of the chip-specific driver code.
432 void qib_pcie_getcmd(struct qib_devdata
*dd
, u16
*cmd
, u8
*iline
, u8
*cline
)
434 pci_read_config_word(dd
->pcidev
, PCI_COMMAND
, cmd
);
435 pci_read_config_byte(dd
->pcidev
, PCI_INTERRUPT_LINE
, iline
);
436 pci_read_config_byte(dd
->pcidev
, PCI_CACHE_LINE_SIZE
, cline
);
439 void qib_pcie_reenable(struct qib_devdata
*dd
, u16 cmd
, u8 iline
, u8 cline
)
442 r
= pci_write_config_dword(dd
->pcidev
, PCI_BASE_ADDRESS_0
,
445 qib_dev_err(dd
, "rewrite of BAR0 failed: %d\n", r
);
446 r
= pci_write_config_dword(dd
->pcidev
, PCI_BASE_ADDRESS_1
,
449 qib_dev_err(dd
, "rewrite of BAR1 failed: %d\n", r
);
450 /* now re-enable memory access, and restore cosmetic settings */
451 pci_write_config_word(dd
->pcidev
, PCI_COMMAND
, cmd
);
452 pci_write_config_byte(dd
->pcidev
, PCI_INTERRUPT_LINE
, iline
);
453 pci_write_config_byte(dd
->pcidev
, PCI_CACHE_LINE_SIZE
, cline
);
454 r
= pci_enable_device(dd
->pcidev
);
456 qib_dev_err(dd
, "pci_enable_device failed after "
460 /* code to adjust PCIe capabilities. */
462 static int fld2val(int wd
, int mask
)
469 lsbmask
= mask
^ (mask
& (mask
- 1));
474 static int val2fld(int wd
, int mask
)
480 lsbmask
= mask
^ (mask
& (mask
- 1));
485 static int qib_pcie_coalesce
;
486 module_param_named(pcie_coalesce
, qib_pcie_coalesce
, int, S_IRUGO
);
487 MODULE_PARM_DESC(pcie_coalesce
, "tune PCIe colescing on some Intel chipsets");
490 * Enable PCIe completion and data coalescing, on Intel 5x00 and 7300
491 * chipsets. This is known to be unsafe for some revisions of some
492 * of these chipsets, with some BIOS settings, and enabling it on those
493 * systems may result in the system crashing, and/or data corruption.
495 static int qib_tune_pcie_coalesce(struct qib_devdata
*dd
)
498 struct pci_dev
*parent
;
503 if (!qib_pcie_coalesce
)
506 /* Find out supported and configured values for parent (root) */
507 parent
= dd
->pcidev
->bus
->self
;
508 if (parent
->bus
->parent
) {
509 qib_devinfo(dd
->pcidev
, "Parent not root\n");
512 ppos
= pci_find_capability(parent
, PCI_CAP_ID_EXP
);
515 if (parent
->vendor
!= 0x8086)
519 * - bit 12: Max_rdcmp_Imt_EN: need to set to 1
520 * - bit 11: COALESCE_FORCE: need to set to 0
521 * - bit 10: COALESCE_EN: need to set to 1
522 * (but limitations on some on some chipsets)
524 * On the Intel 5000, 5100, and 7300 chipsets, there is
525 * also: - bit 25:24: COALESCE_MODE, need to set to 0
527 devid
= parent
->device
;
528 if (devid
>= 0x25e2 && devid
<= 0x25fa) {
532 pci_read_config_byte(parent
, PCI_REVISION_ID
, &rev
);
537 mask
= (3U << 24) | (7U << 10);
538 } else if (devid
>= 0x65e2 && devid
<= 0x65fa) {
541 mask
= (3U << 24) | (7U << 10);
542 } else if (devid
>= 0x4021 && devid
<= 0x402e) {
546 } else if (devid
>= 0x3604 && devid
<= 0x360a) {
549 mask
= (3U << 24) | (7U << 10);
551 /* not one of the chipsets that we know about */
554 pci_read_config_dword(parent
, 0x48, &val
);
557 r
= pci_write_config_dword(parent
, 0x48, val
);
562 * BIOS may not set PCIe bus-utilization parameters for best performance.
563 * Check and optionally adjust them to maximize our throughput.
565 static int qib_pcie_caps
;
566 module_param_named(pcie_caps
, qib_pcie_caps
, int, S_IRUGO
);
567 MODULE_PARM_DESC(pcie_caps
, "Max PCIe tuning: Payload (4lsb), ReadReq (D4..7)");
569 static int qib_tune_pcie_caps(struct qib_devdata
*dd
)
571 int ret
= 1; /* Assume the worst */
572 struct pci_dev
*parent
;
574 u16 pcaps
, pctl
, ecaps
, ectl
;
578 /* Find out supported and configured values for parent (root) */
579 parent
= dd
->pcidev
->bus
->self
;
580 if (parent
->bus
->parent
) {
581 qib_devinfo(dd
->pcidev
, "Parent not root\n");
584 ppos
= pci_find_capability(parent
, PCI_CAP_ID_EXP
);
586 pci_read_config_word(parent
, ppos
+ PCI_EXP_DEVCAP
, &pcaps
);
587 pci_read_config_word(parent
, ppos
+ PCI_EXP_DEVCTL
, &pctl
);
590 /* Find out supported and configured values for endpoint (us) */
591 epos
= pci_find_capability(dd
->pcidev
, PCI_CAP_ID_EXP
);
593 pci_read_config_word(dd
->pcidev
, epos
+ PCI_EXP_DEVCAP
, &ecaps
);
594 pci_read_config_word(dd
->pcidev
, epos
+ PCI_EXP_DEVCTL
, &ectl
);
598 /* Find max payload supported by root, endpoint */
599 rc_sup
= fld2val(pcaps
, PCI_EXP_DEVCAP_PAYLOAD
);
600 ep_sup
= fld2val(ecaps
, PCI_EXP_DEVCAP_PAYLOAD
);
604 rc_cur
= fld2val(pctl
, PCI_EXP_DEVCTL_PAYLOAD
);
605 ep_cur
= fld2val(ectl
, PCI_EXP_DEVCTL_PAYLOAD
);
607 /* If Supported greater than limit in module param, limit it */
608 if (rc_sup
> (qib_pcie_caps
& 7))
609 rc_sup
= qib_pcie_caps
& 7;
610 /* If less than (allowed, supported), bump root payload */
611 if (rc_sup
> rc_cur
) {
613 pctl
= (pctl
& ~PCI_EXP_DEVCTL_PAYLOAD
) |
614 val2fld(rc_cur
, PCI_EXP_DEVCTL_PAYLOAD
);
615 pci_write_config_word(parent
, ppos
+ PCI_EXP_DEVCTL
, pctl
);
617 /* If less than (allowed, supported), bump endpoint payload */
618 if (rc_sup
> ep_cur
) {
620 ectl
= (ectl
& ~PCI_EXP_DEVCTL_PAYLOAD
) |
621 val2fld(ep_cur
, PCI_EXP_DEVCTL_PAYLOAD
);
622 pci_write_config_word(dd
->pcidev
, epos
+ PCI_EXP_DEVCTL
, ectl
);
626 * Now the Read Request size.
627 * No field for max supported, but PCIe spec limits it to 4096,
628 * which is code '5' (log2(4096) - 7)
631 if (rc_sup
> ((qib_pcie_caps
>> 4) & 7))
632 rc_sup
= (qib_pcie_caps
>> 4) & 7;
633 rc_cur
= fld2val(pctl
, PCI_EXP_DEVCTL_READRQ
);
634 ep_cur
= fld2val(ectl
, PCI_EXP_DEVCTL_READRQ
);
636 if (rc_sup
> rc_cur
) {
638 pctl
= (pctl
& ~PCI_EXP_DEVCTL_READRQ
) |
639 val2fld(rc_cur
, PCI_EXP_DEVCTL_READRQ
);
640 pci_write_config_word(parent
, ppos
+ PCI_EXP_DEVCTL
, pctl
);
642 if (rc_sup
> ep_cur
) {
644 ectl
= (ectl
& ~PCI_EXP_DEVCTL_READRQ
) |
645 val2fld(ep_cur
, PCI_EXP_DEVCTL_READRQ
);
646 pci_write_config_word(dd
->pcidev
, epos
+ PCI_EXP_DEVCTL
, ectl
);
651 /* End of PCIe capability tuning */
654 * From here through qib_pci_err_handler definition is invoked via
655 * PCI error infrastructure, registered via pci
657 static pci_ers_result_t
658 qib_pci_error_detected(struct pci_dev
*pdev
, pci_channel_state_t state
)
660 struct qib_devdata
*dd
= pci_get_drvdata(pdev
);
661 pci_ers_result_t ret
= PCI_ERS_RESULT_RECOVERED
;
664 case pci_channel_io_normal
:
665 qib_devinfo(pdev
, "State Normal, ignoring\n");
668 case pci_channel_io_frozen
:
669 qib_devinfo(pdev
, "State Frozen, requesting reset\n");
670 pci_disable_device(pdev
);
671 ret
= PCI_ERS_RESULT_NEED_RESET
;
674 case pci_channel_io_perm_failure
:
675 qib_devinfo(pdev
, "State Permanent Failure, disabling\n");
677 /* no more register accesses! */
678 dd
->flags
&= ~QIB_PRESENT
;
679 qib_disable_after_error(dd
);
681 /* else early, or other problem */
682 ret
= PCI_ERS_RESULT_DISCONNECT
;
685 default: /* shouldn't happen */
686 qib_devinfo(pdev
, "QIB PCI errors detected (state %d)\n",
693 static pci_ers_result_t
694 qib_pci_mmio_enabled(struct pci_dev
*pdev
)
697 struct qib_devdata
*dd
= pci_get_drvdata(pdev
);
698 pci_ers_result_t ret
= PCI_ERS_RESULT_RECOVERED
;
700 if (dd
&& dd
->pport
) {
701 words
= dd
->f_portcntr(dd
->pport
, QIBPORTCNTR_WORDRCV
);
703 ret
= PCI_ERS_RESULT_NEED_RESET
;
705 qib_devinfo(pdev
, "QIB mmio_enabled function called, "
706 "read wordscntr %Lx, returning %d\n", words
, ret
);
710 static pci_ers_result_t
711 qib_pci_slot_reset(struct pci_dev
*pdev
)
713 qib_devinfo(pdev
, "QIB link_reset function called, ignored\n");
714 return PCI_ERS_RESULT_CAN_RECOVER
;
717 static pci_ers_result_t
718 qib_pci_link_reset(struct pci_dev
*pdev
)
720 qib_devinfo(pdev
, "QIB link_reset function called, ignored\n");
721 return PCI_ERS_RESULT_CAN_RECOVER
;
725 qib_pci_resume(struct pci_dev
*pdev
)
727 struct qib_devdata
*dd
= pci_get_drvdata(pdev
);
728 qib_devinfo(pdev
, "QIB resume function called\n");
729 pci_cleanup_aer_uncorrect_error_status(pdev
);
731 * Running jobs will fail, since it's asynchronous
732 * unlike sysfs-requested reset. Better than
735 qib_init(dd
, 1); /* same as re-init after reset */
738 struct pci_error_handlers qib_pci_err_handler
= {
739 .error_detected
= qib_pci_error_detected
,
740 .mmio_enabled
= qib_pci_mmio_enabled
,
741 .link_reset
= qib_pci_link_reset
,
742 .slot_reset
= qib_pci_slot_reset
,
743 .resume
= qib_pci_resume
,