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: 18777 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:6687:0:0:0:0:0 with SMTP id l7csp753574wru; Fri, 11 Nov 2022 05:58:48 -0800 (PST) X-Google-Smtp-Source: AA0mqf5jB+5GdEb18QMvU9A2JPvWjoUcti4QZ8Phpp7XfrF080Pq3KtcCiJUztL7zvB5k18ZBGqS X-Received: by 2002:a05:6402:22e9:b0:464:1297:8412 with SMTP id dn9-20020a05640222e900b0046412978412mr1537088edb.50.1668175128574; Fri, 11 Nov 2022 05:58:48 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1668175128; cv=none; d=google.com; s=arc-20160816; b=Hr7EqKAXRxF2lGVmArOzl65w3tnrsmq35s4Hbdf5nHDZ16eExZDq+yBWYwvd1FJPRQ bgvFz3O+nisUZr+72AcdQU/BI3XfzQj77B4hbueyaDHXXuk5I8W/ilouiqQ1PzOpnn+K NDI14aVwXNhqRc3XpAg55VPKBg+erRzQo6se8PQg3F8iAifWi/wPt+ZQR5wJOBpjakuI 8aUlLnqDBdNkamSa4ZtuxtHGnSv1DIP891Z/kDfD8FNzewlA92k1Czb5g0B9svN0UQvz N8Q2XVfGxczryCClRBagQs4+987E/rId1pYR0WqYGm1J9Jzf7ZWyIqOisPUXB8ScizcY dOdA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:date:content-transfer-encoding:mime-version :references:subject:cc:to:from:dkim-signature:dkim-signature :message-id; bh=UuC1MepTqQIaLcqFkObf7DFyoADcBMPY/PEQtFoZlnk=; b=aK/HoeZSbXUVY8R9/ptSMaTf7A8mIRcp0mu1j8SfmzRbCHZke0I6n7gyx4Bq2sQQka nd/8kx7QhcVR6mj2fjf9cb080863BwF8WUJ6BwNRunnnoS9uNnYOMgich92oNh2xObuk JOe0Aud2e/9tWktCGW8bWl77KqQz/CC03voOCb2LHCrOvENl0ndrf8o3dnmW8p8iH54s XjVCVbaCEjfbocYacL24MO6q0+Z4/OFg1SrAnzt4/rGcpMJh7BRGGAjccjWhQUr76L2u GbmzurCKuv0soDllANmkZVXTYGZqbokpIOL8H7efhXe93WiJ2aNgWUOHGXWMcGg8RcJd Qhxw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=GthpV0+b; dkim=neutral (no key) header.i=@linutronix.de; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id m24-20020a056402051800b00458b752f449si1906482edv.91.2022.11.11.05.58.25; Fri, 11 Nov 2022 05:58:48 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=GthpV0+b; dkim=neutral (no key) header.i=@linutronix.de; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234042AbiKKN53 (ORCPT + 99 others); Fri, 11 Nov 2022 08:57:29 -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) X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1749208403354013744?= X-GMAIL-MSGID: =?utf-8?q?1749208403354013744?= 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: