PCI/MSI: Clarify usage of pci_msix_free_irq()
authorReinette Chatre <reinette.chatre@intel.com>
Tue, 14 Feb 2023 21:13:20 +0000 (13:13 -0800)
committerThomas Gleixner <tglx@linutronix.de>
Tue, 21 Feb 2023 07:25:14 +0000 (08:25 +0100)
commite6cc6f175566dd21a3f6e384c24593b1c751dd74
treedfa0d7d976c5e29d52953a19e3647e9c948bbc7a
parent0af2795f936f1ea1f9f1497447145dfcc7ed2823
PCI/MSI: Clarify usage of pci_msix_free_irq()

pci_msix_free_irq() is used to free an interrupt on a PCI/MSI-X interrupt
domain.

The API description specifies that the interrupt to be freed was allocated
via pci_msix_alloc_irq_at().  This description limits the usage of
pci_msix_free_irq() since pci_msix_free_irq() can also be used to free
MSI-X interrupts allocated with, for example, pci_alloc_irq_vectors().

Remove the text stating that the interrupt to be freed had to be allocated
with pci_msix_alloc_irq_at(). The needed struct msi_map need not be from
pci_msix_alloc_irq_at() but can be created from scratch using
pci_irq_vector() to obtain the Linux IRQ number. Highlight that
pci_msix_free_irq() cannot be used to disable MSI-X to guide users that,
for example, pci_free_irq_vectors() remains to be needed.

Signed-off-by: Reinette Chatre <reinette.chatre@intel.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Kevin Tian <kevin.tian@intel.com>
Link: https://lore.kernel.org/lkml/87r0xsd8j4.ffs@tglx
Link: https://lore.kernel.org/r/4c3e7a50d6e70f408812cd7ab199c6b4b326f9de.1676408572.git.reinette.chatre@intel.com
drivers/pci/msi/api.c