summaryrefslogtreecommitdiff
path: root/Documentation/PCI
diff options
context:
space:
mode:
authorAhmed S. Darwish <darwi@linutronix.de>2022-11-11 14:55:04 +0100
committerThomas Gleixner <tglx@linutronix.de>2022-11-17 15:15:21 +0100
commit88614075a952b1af50f5fb10c958e311f6b4f68a (patch)
tree4d18c27a5ba13f6d5aa353fa019368073c856342 /Documentation/PCI
parent57127da98bc87688324cc2d29927b340d7754701 (diff)
downloadlwn-88614075a952b1af50f5fb10c958e311f6b4f68a.tar.gz
lwn-88614075a952b1af50f5fb10c958e311f6b4f68a.zip
Documentation: PCI: Add reference to PCI/MSI device driver APIs
All exported device-driver MSI APIs are now grouped in one place at drivers/pci/msi/api.c with comprehensive kernel-docs added. Reference these kernel-docs in the official PCI/MSI howto. Signed-off-by: Ahmed S. Darwish <darwi@linutronix.de> Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Reviewed-by: Jason Gunthorpe <jgg@nvidia.com> Acked-by: Bjorn Helgaas <bhelgaas@google.com> Link: https://lore.kernel.org/r/20221111122015.397739421@linutronix.de
Diffstat (limited to 'Documentation/PCI')
-rw-r--r--Documentation/PCI/msi-howto.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/PCI/msi-howto.rst b/Documentation/PCI/msi-howto.rst
index aa2046af69f7..8ae461e97c54 100644
--- a/Documentation/PCI/msi-howto.rst
+++ b/Documentation/PCI/msi-howto.rst
@@ -285,3 +285,13 @@ to bridges between the PCI root and the device, MSIs are disabled.
It is also worth checking the device driver to see whether it supports MSIs.
For example, it may contain calls to pci_alloc_irq_vectors() with the
PCI_IRQ_MSI or PCI_IRQ_MSIX flags.
+
+
+List of device drivers MSI(-X) APIs
+===================================
+
+The PCI/MSI subystem has a dedicated C file for its exported device driver
+APIs — `drivers/pci/msi/api.c`. The following functions are exported:
+
+.. kernel-doc:: drivers/pci/msi/api.c
+ :export: