From patchwork Fri Nov 11 13:55:04 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Thomas Gleixner X-Patchwork-Id: 13040371 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id C9AC8C43217 for ; Fri, 11 Nov 2022 13:57:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233804AbiKKN5J (ORCPT ); Fri, 11 Nov 2022 08:57:09 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58922 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233887AbiKKN4b (ORCPT ); Fri, 11 Nov 2022 08:56:31 -0500 Received: from galois.linutronix.de (Galois.linutronix.de [193.142.43.55]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8599B7F560; Fri, 11 Nov 2022 05:55:06 -0800 (PST) Message-ID: <20221111122015.397739421@linutronix.de> DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1668174905; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: references:references; bh=UuC1MepTqQIaLcqFkObf7DFyoADcBMPY/PEQtFoZlnk=; b=GthpV0+bUwZ0On/zDcLYLzsswb8L1Lyf03t32FEBRxX4PnOlz+khlP72rDfyiJ1x9wRgx0 QZBHxxrL4JkPQLW7wxnFxQQP1C3bGSUtkFuYA7n7ImHn09T6nJKXmSRNq6GMcgez9zHcBr /sXuwxE+KMFFbdY6PdL0GaHWRYeq2JTEl73uUqyXZcW+aV/4sFTHIWAWRwSUxCox9LTE9G hYCMBp2pxhJCSf4Vrdt9VkoToU9NxPEz3oqd083h7hlHGv5jYqQ13ynW5aQ/L+OWRe7yr0 HZqb6OTN06vPLw7H/xCHtuHUesG4QYeE53KYO3lB8wsG9XL+fgCEqmcpWHMg5g== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1668174905; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: references:references; bh=UuC1MepTqQIaLcqFkObf7DFyoADcBMPY/PEQtFoZlnk=; b=N5w5QY6eUkXGEGiXNQj1Q3SBpVNANVHkPj6Rf+UFoASB2T/i/8da2rW7Kz59cuUMxbBlwY 9I6yIp/HKRYP4CAQ== From: Thomas Gleixner To: LKML Cc: x86@kernel.org, Joerg Roedel , Will Deacon , linux-pci@vger.kernel.org, Bjorn Helgaas , Lorenzo Pieralisi , Marc Zyngier , Greg Kroah-Hartman , Jason Gunthorpe , Dave Jiang , Alex Williamson , Kevin Tian , Dan Williams , Logan Gunthorpe , Ashok Raj , Jon Mason , Allen Hubbe , "Ahmed S. Darwish" , Reinette Chatre , Michael Ellerman , Christophe Leroy , linuxppc-dev@lists.ozlabs.org Subject: [patch 31/39] Documentation: PCI: Add reference to PCI/MSI device driver APIs References: <20221111120501.026511281@linutronix.de> MIME-Version: 1.0 Date: Fri, 11 Nov 2022 14:55:04 +0100 (CET) Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org 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 Reviewed-by: Jason Gunthorpe --- 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: