Re: [patch 31/39] Documentation: PCI: Add reference to PCI/MSI device driver APIs
On Fri, Nov 11, 2022 at 02:55:04PM +0100, Thomas Gleixner wrote: > From: Ahmed S. Darwish > > 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 > Signed-off-by: Thomas Gleixner > > --- > Documentation/PCI/msi-howto.rst | 10 ++ > 1 file changed, 10 insertions(+) I was wondering what the payoff was for moving everything to api.c, this seems pretty good. Though, in some regards it might be cleaner to teach ":export:" about how to process symbol namespaces and put all the architecture facing exports in some PCI_MSI_ARCH/IRQCHIP namespace which could achieve the same effect for kdoc as moving all the code around and have the bonus of discouraging people from mis-using the APIs inside inappropriate drivers. But, I like the idea, and the outcome is great so Reviewed-by: Jason Gunthorpe Jason
Re: [patch 31/39] Documentation: PCI: Add reference to PCI/MSI device driver APIs
On Fri, Nov 11, 2022 at 02:55:04PM +0100, Thomas Gleixner wrote: > From: Ahmed S. Darwish > > 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 > Signed-off-by: Thomas Gleixner Acked-by: Bjorn Helgaas > --- > Documentation/PCI/msi-howto.rst | 10 ++ > 1 file changed, 10 insertions(+) > --- > --- a/Documentation/PCI/msi-howto.rst > +++ b/Documentation/PCI/msi-howto.rst > @@ -285,3 +285,13 @@ to bridges between the PCI root and the > 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: >
[patch 31/39] Documentation: PCI: Add reference to PCI/MSI device driver APIs
From: Ahmed S. Darwish 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 Signed-off-by: Thomas Gleixner --- Documentation/PCI/msi-howto.rst | 10 ++ 1 file changed, 10 insertions(+) --- --- a/Documentation/PCI/msi-howto.rst +++ b/Documentation/PCI/msi-howto.rst @@ -285,3 +285,13 @@ to bridges between the PCI root and the 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:
