Skip to content

PCI/MSI: Introduce pci_auto_enable_msi*() family helpers

Alexander Gordeev linux-pci lkml 3 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v4 Latest9 patches 13 repliesIn review
  2. v311 patches 12 repliesSuperseded
  3. v2 RFC29 patches 34 repliesSuperseded

Changes in v4 from the cover letter

- pcim_enable_msi* functions renamed to pci_auto_enable_msi* ones
- PowerPC patches dropped
- pci_get_msi_cap() renamed to pci_get_msix_vec_count() and
pci_msix_table_size() renamed to pci_get_msix_vec_count()

Patches in v4 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/9PCI/MSI/s390: Fix single MSI only checkarch/s390/pci/pci.c+2 -00 replies
2/9PCI/MSI/s390: Remove superfluous check of MSI typearch/s390/pci/pci.c+0 -20 replies
3/9PCI/MSI: Fix return value when populate_msi_sysfs() faileddrivers/pci/msi.c+5 -60 replies
4/9PCI/MSI: Return -ENOSYS for unimplemented interfaces, not -1include/linux/pci.h+3 -30 replies
5/9PCI/MSI: Make pci_enable_msi/msix() 'nvec' argument type as intDocumentation/PCI/MSI-HOWTO.txt drivers/pci/msi.c include/linux/pci.h+7 -70 replies
6/9PCI/MSI: Factor out pci_get_msi_vec_count() interfaceDocumentation/PCI/MSI-HOWTO.txt drivers/pci/msi.c include/linux/pci.h+54 -81 reply
7/9PCI/MSI: Get rid of pci_enable_msi_block_auto() interfaceDocumentation/PCI/MSI-HOWTO.txt drivers/ata/ahci.c drivers/pci/msi.c +1 more+41 -860 replies
8/9PCI/MSI: Introduce pci_get_msix_vec_count() interfaceDocumentation/PCI/MSI-HOWTO.txt drivers/pci/msi.c drivers/pci/pcie/portdrv_core.c +1 more+33 -110 replies
9/9PCI/MSI: Introduce pci_auto_enable_msi*() family helpersDocumentation/PCI/MSI-HOWTO.txt drivers/pci/msi.c include/linux/pci.h+260 -511 replies

Reviews trailers per patch

All 9 patches have a Reviewed-by or Acked-by.

PatchTejun HeoMartin Schwidefsky
1/9A-b
2/9A-b
3/9R-b
4/9R-b
5/9R-b
6/9R-b
7/9A-b
8/9R-b
9/9R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v4 thread

Cover letter [PATCH v4 0/9] PCI/MSI: Introduce pci_auto_enable_msi*() family helpers

This series is against "next" branch in Bjorn's repo:
git://git.kernel.org/pub/scm/linux/kernel/git/helgaas/pci.git

Changes from v3 to v4:
- pcim_enable_msi* functions renamed to pci_auto_enable_msi* ones
- PowerPC patches dropped
- pci_get_msi_cap() renamed to pci_get_msix_vec_count() and
pci_msix_table_size() renamed to pci_get_msix_vec_count()

Changes from v2 to v3:
- new public interfaces commented in drivers/pci/msi.c;
- patch "Make quota traversing and requesting race-safe" explained;
- pci_enable_msi/msix() 'nvec' arg type changed from 'unsigned int' to 'int';
- pcim_enable_msi*() arg 'nvec' renamed to 'maxvec' when upper limit passed;
- pcim_enable_msi*(..., maxvec, minvec) arg order swapped to minvec, maxvec;
- "PCI: Fail MSI/MSI-X initialization if device is not in PCI_D0" commit 869a161 and "PCI/MSI: Factor out pci_get_msi_cap() interface" patch conflicts resolved;

Currently many device drivers need contiguously call functions pci_enable_msix() for MSI-X or pci_enable_msi_block() for MSI in a loop until success or failure. This update generalizes this usage pattern and introduces pci_auto_enable_msi*() family helpers.

As result, device drivers do not have to deal with tri-state return values from pci_enable_msix() and pci_enable_msi_block() functions directly and expected to have more clearer and straight code.

So i.e. the request loop described in the documentation...

	int foo_driver_enable_msix(struct foo_adapter *adapter,
				   int nvec)
	{
		while (nvec >= FOO_DRIVER_MINIMUM_NVEC) {
			rc = pci_enable_msix(adapter->pdev,
					     adapter->msix_entries,
					     nvec);
			if (rc > 0)
				nvec = rc;
			else
				return rc;
		}

		return -ENOSPC;
	}

...would turn into a single helper call....

	rc = pci_auto_enable_msix_range(adapter->pdev,
					adapter->msix_entries,
					FOO_DRIVER_MINIMUM_NVEC,
					nvec);

Device drivers with more specific requirements (i.e. a number of MSI-Xs which is a multiple of a certain number within a specified range) would still need to implement the loop using the two old functions.

The tree could be found in "pci-next-msi-v4" branch in repo:
https://github.com/a-gordeev/linux.git

Alexander Gordeev (9):
PCI/MSI/s390: Fix single MSI only check
PCI/MSI/s390: Remove superfluous check of MSI type PCI/MSI: Fix return value when populate_msi_sysfs() failed PCI/MSI: Return -ENOSYS for unimplemented interfaces, not -1 PCI/MSI: Make pci_enable_msi/msix() 'nvec' argument type as int PCI/MSI: Factor out pci_get_msi_vec_count() interface PCI/MSI: Get rid of pci_enable_msi_block_auto() interface PCI/MSI: Introduce pci_get_msix_vec_count() interface PCI/MSI: Introduce pci_auto_enable_msi*() family helpers

 Documentation/PCI/MSI-HOWTO.txt |  175 +++++++++++++++++++++++++++++++++------
 arch/s390/pci/pci.c             |    4 +-
 drivers/ata/ahci.c              |   56 ++++++++-----
 drivers/pci/msi.c               |  163 +++++++++++++++++++++++++++---------
 drivers/pci/pcie/portdrv_core.c |    7 +-
 include/linux/pci.h             |   78 +++++++++++++++---
 6 files changed, 380 insertions(+), 103 deletions(-)
Signature · 1 line
1.7.7.6