From patchwork Sat Jul 3 15:13:02 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= X-Patchwork-Id: 12357057 X-Patchwork-Delegate: lorenzo.pieralisi@arm.com Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BCDB2C07E97 for ; Sat, 3 Jul 2021 15:13:11 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8A93061938 for ; Sat, 3 Jul 2021 15:13:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229598AbhGCPPo (ORCPT ); Sat, 3 Jul 2021 11:15:44 -0400 Received: from mail-lf1-f51.google.com ([209.85.167.51]:46778 "EHLO mail-lf1-f51.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229562AbhGCPPn (ORCPT ); Sat, 3 Jul 2021 11:15:43 -0400 Received: by mail-lf1-f51.google.com with SMTP id p21so2125636lfj.13 for ; Sat, 03 Jul 2021 08:13:08 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=v4gKaNS+MWVdKg2mBjXfowlkmrYKBzhvJhNdC8LPcZA=; b=PWCXLRAhVee6oWTyZhWthmuHqm7eQ5CgqfgD8lkx6ckfDDV5XC9IVM71AziutkpodQ 1CycHMCkI/u3svCzHs9lFDRSlg8WyI1/fKuzUv3/wUDmDXHdkAR8GPLHDcMHJj7GM92T BPwNMkJuWsqnXJTKSsDy7xi02Qc8M1GqcApP65vENA2cDFjyoVUaBVdAw0teqncKgQsW ia7acHHNThNHDthL8g+Yva/azEAMfsLS+o5PSUjK+Vm8wNcdGGs/uBIUC+1a/NBgR2bq KkRj5FpbuVLOB0DBDL+c0E2oV4JBCePKR3Xpdi2nokrOJu8pTAVA068ixzm9kgn8Mp0L ws3w== X-Gm-Message-State: AOAM532sqaYleT+geCHNi0urjCxCJDbGFPWWGveiywQB4QwIbOLqAxOv OJJEL30kkAKFfORSWHym6Vo= X-Google-Smtp-Source: ABdhPJyIi/j/IQ6MGQKx9+zf59VKtoT16Laht43s1RlBY2AE3P/kLmewgO3VRAt6aBjVkE7enMEsdg== X-Received: by 2002:a19:dc1c:: with SMTP id t28mr3570189lfg.615.1625325188252; Sat, 03 Jul 2021 08:13:08 -0700 (PDT) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id p18sm715980ljj.56.2021.07.03.08.13.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 03 Jul 2021 08:13:07 -0700 (PDT) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Lukas Wunner , Rob Herring , Scott Branden , Scott Murray , Tom Joseph , bcm-kernel-feedback-list@broadcom.com, linux-arm-kernel@lists.infradead.org, linux-pci@vger.kernel.org Subject: [PATCH 1/5] PCI: Fix kernel-doc formatting Date: Sat, 3 Jul 2021 15:13:02 +0000 Message-Id: <20210703151306.1922450-1-kw@linux.com> X-Mailer: git-send-email 2.32.0 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Fix kernel-doc formatting of function pci_dev_set_io_state(), and resolve build time warnings related to kernel-doc: drivers/pci/pci.h:337: warning: Function parameter or member 'dev' not described in 'pci_dev_set_io_state' drivers/pci/pci.h:337: warning: Function parameter or member 'new' not described in 'pci_dev_set_io_state' No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/pci.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/pci/pci.h b/drivers/pci/pci.h index 37c913bbc6e1..c1ac65cc4572 100644 --- a/drivers/pci/pci.h +++ b/drivers/pci/pci.h @@ -324,8 +324,8 @@ struct pci_sriov { /** * pci_dev_set_io_state - Set the new error state if possible. * - * @dev - pci device to set new error_state - * @new - the state we want dev to be in + * @dev: pci device to set new error_state + * @new: the state we want dev to be in * * Must be called with device_lock held. * From patchwork Sat Jul 3 15:13:03 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= X-Patchwork-Id: 12357059 X-Patchwork-Delegate: lorenzo.pieralisi@arm.com Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8831BC07E99 for ; Sat, 3 Jul 2021 15:13:12 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 63A296192D for ; Sat, 3 Jul 2021 15:13:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229753AbhGCPPp (ORCPT ); Sat, 3 Jul 2021 11:15:45 -0400 Received: from mail-lf1-f47.google.com ([209.85.167.47]:37464 "EHLO mail-lf1-f47.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229562AbhGCPPp (ORCPT ); Sat, 3 Jul 2021 11:15:45 -0400 Received: by mail-lf1-f47.google.com with SMTP id q16so23896871lfr.4 for ; Sat, 03 Jul 2021 08:13:10 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=nCceiwSHotY6w4BBLh4dMsz6eJ1AQ5LepYY/lC2O4FM=; b=kUsrdVT827aHCtrD3MDvpMHsBxnmZ/wHFz8lEbfsg4HRcCvcioDDiWFS5FCW2cRRoq 85inlUoxrUuGJs9SHUPz+eE8pi4fgLdj8FR6bHNmA7rEIVb55gtVez/HNlbXbo3G55jb L6a9muSpe/BIfmCA0NAy/HwYwyhnOZTXB7Rd9B+fEmj2RFn0mJjCzWzwV8LGvNml/QbB 7+iOIv2b6rt8vt6swvPbdJ7m1kOjQDtQA8udeSMtQTWsODQIFwoNksOO/vO+mXa8OrTh +MFEHHxcsZbKFiWqOV+XrnnXoN7oOOL2Zk6Xv9UW5UrlxmdjgwJs17Co5ciCeTmMzDkV nO4A== X-Gm-Message-State: AOAM530wJeBfn0WPY8JA8IsDsmklP3ZB4PDePMAwUs5ukuBnJ4FLWnj0 UhN/m2voGI1K0umv0xcFclY= X-Google-Smtp-Source: ABdhPJzHK9ktHD/bQ+3Iia917/0ikz0iROMcW/8hBE7sgMIo1QGtwIH/XheGnnYhz2cfotc+aHfDQw== X-Received: by 2002:a05:6512:2251:: with SMTP id i17mr3254363lfu.194.1625325189448; Sat, 03 Jul 2021 08:13:09 -0700 (PDT) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id p18sm715980ljj.56.2021.07.03.08.13.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 03 Jul 2021 08:13:08 -0700 (PDT) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Lukas Wunner , Rob Herring , Scott Branden , Scott Murray , Tom Joseph , bcm-kernel-feedback-list@broadcom.com, linux-arm-kernel@lists.infradead.org, linux-pci@vger.kernel.org Subject: [PATCH 2/5] PCI: iproc: Fix kernel-doc formatting Date: Sat, 3 Jul 2021 15:13:03 +0000 Message-Id: <20210703151306.1922450-2-kw@linux.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210703151306.1922450-1-kw@linux.com> References: <20210703151306.1922450-1-kw@linux.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Fix kernel-doc formatting used to describe structs, enum types and functions in the pcie-iproc.c, pcie-iproc-msi.c and pcie-iproc.h files. Also, add documentation for the "mem" member of the struct iproc_pcie, and the enum values "IPROC_PCIE_IB_MAP_MEM", "IPROC_PCIE_IB_MAP_IO" and "IPROC_PCIE_IB_MAP_INVALID" of the enum iproc_pcie_ib_map_type. Thus, resolve the following build time warning related to kernel-doc: drivers/pci/controller/pcie-iproc.c:92: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:139: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:153: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:441: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:623: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:901: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_MEM' not described in enum 'iproc_pcie_ib_map_type' drivers/pci/controller/pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_IO' not described in enum 'iproc_pcie_ib_map_type' drivers/pci/controller/pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_INVALID' not described in enum 'iproc_pcie_ib_map_type' drivers/pci/controller/pcie-iproc-msi.c:52: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc-msi.c:68: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.h:11: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.h:28: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.h:39: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.h:51: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.h:112: warning: Function parameter or member 'mem' not described in 'iproc_pcie' No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/controller/pcie-iproc-msi.c | 4 ++-- drivers/pci/controller/pcie-iproc.c | 24 +++++++++++------------- drivers/pci/controller/pcie-iproc.h | 18 +++++++++++++----- 3 files changed, 26 insertions(+), 20 deletions(-) diff --git a/drivers/pci/controller/pcie-iproc-msi.c b/drivers/pci/controller/pcie-iproc-msi.c index eede4e8f3f75..21d28dc0b901 100644 --- a/drivers/pci/controller/pcie-iproc-msi.c +++ b/drivers/pci/controller/pcie-iproc-msi.c @@ -49,7 +49,7 @@ enum iproc_msi_reg { struct iproc_msi; /** - * iProc MSI group + * struct iproc_msi_grp - iProc MSI group * * One MSI group is allocated per GIC interrupt, serviced by one iProc MSI * event queue. @@ -65,7 +65,7 @@ struct iproc_msi_grp { }; /** - * iProc event queue based MSI + * struct iproc_msi - iProc event queue based MSI * * Only meant to be used on platforms without MSI support integrated into the * GIC. diff --git a/drivers/pci/controller/pcie-iproc.c b/drivers/pci/controller/pcie-iproc.c index 02e52f698eeb..5b2a02a309cf 100644 --- a/drivers/pci/controller/pcie-iproc.c +++ b/drivers/pci/controller/pcie-iproc.c @@ -89,8 +89,8 @@ #define IPROC_PCIE_REG_INVALID 0xffff /** - * iProc PCIe outbound mapping controller specific parameters - * + * struct iproc_pcie_ob_map - iProc PCIe outbound mapping controller specific + * parameters * @window_sizes: list of supported outbound mapping window sizes in MB * @nr_sizes: number of supported outbound mapping window sizes */ @@ -136,22 +136,20 @@ static const struct iproc_pcie_ob_map paxb_v2_ob_map[] = { }; /** - * iProc PCIe inbound mapping type + * enum iproc_pcie_ib_map_type - iProc PCIe inbound mapping type + * @IPROC_PCIE_IB_MAP_MEM: DDR memory + * @IPROC_PCIE_IB_MAP_IO: device I/O memory + * @IPROC_PCIE_IB_MAP_INVALID: invalid or unused */ enum iproc_pcie_ib_map_type { - /* for DDR memory */ IPROC_PCIE_IB_MAP_MEM = 0, - - /* for device I/O memory */ IPROC_PCIE_IB_MAP_IO, - - /* invalid or unused */ IPROC_PCIE_IB_MAP_INVALID }; /** - * iProc PCIe inbound mapping controller specific parameters - * + * struct iproc_pcie_ib_map - iProc PCIe inbound mapping controller specific + * parameters * @type: inbound mapping region type * @size_unit: inbound mapping region size unit, could be SZ_1K, SZ_1M, or * SZ_1G @@ -437,7 +435,7 @@ static inline void iproc_pcie_write_reg(struct iproc_pcie *pcie, writel(val, pcie->base + offset); } -/** +/* * APB error forwarding can be disabled during access of configuration * registers of the endpoint device, to prevent unsupported requests * (typically seen during enumeration with multi-function devices) from @@ -619,7 +617,7 @@ static int iproc_pcie_config_read(struct pci_bus *bus, unsigned int devfn, return PCIBIOS_SUCCESSFUL; } -/** +/* * Note access to the configuration registers are protected at the higher layer * by 'pci_lock' in drivers/pci/access.c */ @@ -897,7 +895,7 @@ static inline int iproc_pcie_ob_write(struct iproc_pcie *pcie, int window_idx, return 0; } -/** +/* * Some iProc SoCs require the SW to configure the outbound address mapping * * Outbound address translation: diff --git a/drivers/pci/controller/pcie-iproc.h b/drivers/pci/controller/pcie-iproc.h index c2676e442f55..170247f7e49e 100644 --- a/drivers/pci/controller/pcie-iproc.h +++ b/drivers/pci/controller/pcie-iproc.h @@ -7,7 +7,15 @@ #define _PCIE_IPROC_H /** - * iProc PCIe interface type + * enum iproc_pcie_type - iProc PCIe interface type + * @IPROC_PCIE_PAXB_BCMA: new generation of iProc BCMA-based host controllers + * @IPROC_PCIE_PAXB: iProc PAXB-based host controllers for SoCs such as NS, NSP, + * Cygnus, NS2 and Pegasus + * @IPROC_PCIE_PAXB_V2: next generation of iProc PAXB-based host controllers + * using the Stingray SoCs + * @IPROC_PCIE_PAXC: iProx PAXC-based host controllers + * @IPROC_PCIE_PAXC_V2: Second generation of the iProc PAXC-based host + * controllers * * PAXB is the wrapper used in root complex that can be connected to an * external endpoint device. @@ -24,7 +32,7 @@ enum iproc_pcie_type { }; /** - * iProc PCIe outbound mapping + * struct iproc_pcie_ob - iProc PCIe outbound mapping * @axi_offset: offset from the AXI address to the internal address used by * the iProc PCIe core * @nr_windows: total number of supported outbound mapping windows @@ -35,7 +43,7 @@ struct iproc_pcie_ob { }; /** - * iProc PCIe inbound mapping + * struct iproc_pcie_ib - iProc PCIe inbound mapping * @nr_regions: total number of supported inbound mapping regions */ struct iproc_pcie_ib { @@ -47,13 +55,13 @@ struct iproc_pcie_ib_map; struct iproc_msi; /** - * iProc PCIe device - * + * struct iproc_pcie - iProc PCIe device * @dev: pointer to device data structure * @type: iProc PCIe interface type * @reg_offsets: register offsets * @base: PCIe host controller I/O register base * @base_addr: PCIe host controller register base physical address + * @mem: host bridge memory window resource * @phy: optional PHY device that controls the Serdes * @map_irq: function callback to map interrupts * @ep_is_internal: indicates an internal emulated endpoint device is connected From patchwork Sat Jul 3 15:13:04 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= X-Patchwork-Id: 12357061 X-Patchwork-Delegate: lorenzo.pieralisi@arm.com Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BBF8EC07E98 for ; Sat, 3 Jul 2021 15:13:12 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 93D076192D for ; Sat, 3 Jul 2021 15:13:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229562AbhGCPPp (ORCPT ); Sat, 3 Jul 2021 11:15:45 -0400 Received: from mail-lf1-f44.google.com ([209.85.167.44]:36782 "EHLO mail-lf1-f44.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229700AbhGCPPp (ORCPT ); Sat, 3 Jul 2021 11:15:45 -0400 Received: by mail-lf1-f44.google.com with SMTP id d16so23856445lfn.3 for ; Sat, 03 Jul 2021 08:13:11 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=cNlKcnCbf+U9MYL6Tec0SeQijh0GE4vaKksfFp6LR00=; b=jYXphEwwu1ZOeopxSjv8j9/qP1LN6boV5pdQ7YugyjtmblS96qhNp7rQPmLaAcJEed XjoETt/Sv5xNsApmUpQWqm01vOQ+/tluVvP9UBTljRyQa3pdIpLosVhj+rCHWXT5K5Nv bo26PdNODOsJUDvfJDRHnDcLp9bR19e0NhPecMo1ehaDRzBbLDNkdsJi4mFTitHHyqEB PfXeGNZcuTsU0ud1ky6QxG71l92uW6YHt0KPGkZaF3lsAS0RXotvhPKw3kmy03Kju2Q8 vhefQ33ISAOHeqDOLYPpi0gLsU0Codsk++3HBquoY7tHBNS7LqsvKUm0+YRqzoDO0e/C GiRA== X-Gm-Message-State: AOAM533edG21Dz4dayq60u2rwF+wpBDkGDnvgLWzCwzok2JPegF+kjIQ ZQvWoIkcB3xTlfCxKS/v/9k= X-Google-Smtp-Source: ABdhPJyNUz9oqR3m7d9EcsTihaXJum064mwNQTq7KBIFgp9VmGalJfqatTUu7MOeiAI+aLjRMxU2xg== X-Received: by 2002:ac2:4ecd:: with SMTP id p13mr3562303lfr.351.1625325190608; Sat, 03 Jul 2021 08:13:10 -0700 (PDT) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id p18sm715980ljj.56.2021.07.03.08.13.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 03 Jul 2021 08:13:10 -0700 (PDT) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Lukas Wunner , Rob Herring , Scott Branden , Scott Murray , Tom Joseph , bcm-kernel-feedback-list@broadcom.com, linux-arm-kernel@lists.infradead.org, linux-pci@vger.kernel.org Subject: [PATCH 3/5] PCI: cadence: Add missing kernel-doc for struct cdns_pcie members Date: Sat, 3 Jul 2021 15:13:04 +0000 Message-Id: <20210703151306.1922450-3-kw@linux.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210703151306.1922450-1-kw@linux.com> References: <20210703151306.1922450-1-kw@linux.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Add missing documentation for the members "dev", "phy_count", "phy" and "link" of the struct cdns_pcie, and also remove surplus member "bus". Thus resolve build time warnings related to kernel-doc: drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'dev' not described in 'cdns_pcie' drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'phy_count' not described in 'cdns_pcie' drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'phy' not described in 'cdns_pcie' drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'link' not described in 'cdns_pcie' No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/controller/cadence/pcie-cadence.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/drivers/pci/controller/cadence/pcie-cadence.h b/drivers/pci/controller/cadence/pcie-cadence.h index 254d2570f8c9..e118c650bbf9 100644 --- a/drivers/pci/controller/cadence/pcie-cadence.h +++ b/drivers/pci/controller/cadence/pcie-cadence.h @@ -263,8 +263,11 @@ struct cdns_pcie_ops { * struct cdns_pcie - private data for Cadence PCIe controller drivers * @reg_base: IO mapped register base * @mem_res: start/end offsets in the physical system memory to map PCI accesses + * @dev: the PCI device * @is_rc: tell whether the PCIe controller mode is Root Complex or Endpoint. - * @bus: In Root Complex mode, the bus number + * @phy_count: number of supported PHY devices + * @phy: list of pointers to specific PHY control blocks + * @link: list of pointers to corresponding device link representations * @ops: Platform specific ops to control various inputs from Cadence PCIe * wrapper */ From patchwork Sat Jul 3 15:13:05 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= X-Patchwork-Id: 12357063 X-Patchwork-Delegate: lorenzo.pieralisi@arm.com Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 54518C07E97 for ; Sat, 3 Jul 2021 15:13:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 32A9B61936 for ; Sat, 3 Jul 2021 15:13:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229792AbhGCPPr (ORCPT ); Sat, 3 Jul 2021 11:15:47 -0400 Received: from mail-lf1-f49.google.com ([209.85.167.49]:34761 "EHLO mail-lf1-f49.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229700AbhGCPPq (ORCPT ); Sat, 3 Jul 2021 11:15:46 -0400 Received: by mail-lf1-f49.google.com with SMTP id f30so23901742lfj.1 for ; Sat, 03 Jul 2021 08:13:12 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=U7rzTOb04LbYLPb0x72Oq3slQy7w9mF5ZvWIsm7kXic=; b=Ma4KViC9WgE0JmPV0gGHKcn4Uksh8CzJaSrrMe0UVIKvlvhtOCqrTCpq1lWxZo2VXr YulJR6v7UCezpbKf7+Or/HkU438K1jtGuimkX22WB7JGTbDNwRHNR6ipKBwvsmgEUS2I oL00Tvcyh+48wNMfEZEIGx7OeLDBuPGFtRbshFycF90WHXG7avzw8vbQRpm+DChHOccZ bkvJQbBySQTwXCQ8rmuahCEjKjxbHsKK/lKMZ8B+uDW2r8fRqm3IX21cyIdB3Afz8009 3ASxrFGka/15Ms41w0GpEguAUuwsTndniz7EfWrdODmE/hm0JGz0Qp6VY9Yd1EnFSzyq i2kQ== X-Gm-Message-State: AOAM531WKNNvApLzVB1Nj32NOiXlVaVGpWrfJBhPSwAS02x1Xy/o3Kd7 siiAz7Yso23CfuBEuSIlgK8= X-Google-Smtp-Source: ABdhPJzdvWD5Pic4JP8Q0qc1wxxJN3vK1g1cZUZ9XK2encPzy+iMlCGvKhk8fDEzbwF9fvSEQwa8eQ== X-Received: by 2002:a05:6512:238c:: with SMTP id c12mr3946443lfv.317.1625325191845; Sat, 03 Jul 2021 08:13:11 -0700 (PDT) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id p18sm715980ljj.56.2021.07.03.08.13.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 03 Jul 2021 08:13:11 -0700 (PDT) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Lukas Wunner , Rob Herring , Scott Branden , Scott Murray , Tom Joseph , bcm-kernel-feedback-list@broadcom.com, linux-arm-kernel@lists.infradead.org, linux-pci@vger.kernel.org Subject: [PATCH 4/5] PCI: hotplug: Fix kernel-doc formatting and add missing documentation Date: Sat, 3 Jul 2021 15:13:05 +0000 Message-Id: <20210703151306.1922450-4-kw@linux.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210703151306.1922450-1-kw@linux.com> References: <20210703151306.1922450-1-kw@linux.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Fix kernel-doc formatting and add missing documentation for the parameters "bus" of the get_slot_mapping() function. Add documentation for missing "t" and remove surplus "slot" parameter of the cpqhp_pushbutton_thread() function. Also add missing documentation for "inband_presence_disabled" member of the struct controller, and the "slot_list" and "pci_slot" members of the struct hotplug_slot. Thus, resolve build time warnings related to kernel-doc: drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'bus' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'bus_num' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'dev_num' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'slot' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_ctrl.c:1887: warning: Function parameter or member 't' not described in 'cpqhp_pushbutton_thread' drivers/pci/hotplug/cpqphp_ctrl.c:1887: warning: Excess function parameter 'slot' description in 'cpqhp_pushbutton_thread' drivers/pci/hotplug/pciehp.h:110: warning: Function parameter or member 'inband_presence_disabled' not described in 'controller' include/linux/pci_hotplug.h:64: warning: Function parameter or member 'slot_list' not described in 'hotplug_slot' include/linux/pci_hotplug.h:64: warning: Function parameter or member 'pci_slot' not described in 'hotplug_slot' No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/hotplug/cpqphp_core.c | 7 ++++--- drivers/pci/hotplug/cpqphp_ctrl.c | 2 +- drivers/pci/hotplug/pciehp.h | 3 +++ include/linux/pci_hotplug.h | 2 ++ 4 files changed, 10 insertions(+), 4 deletions(-) diff --git a/drivers/pci/hotplug/cpqphp_core.c b/drivers/pci/hotplug/cpqphp_core.c index b8aacb41a83c..f99a7927e5a8 100644 --- a/drivers/pci/hotplug/cpqphp_core.c +++ b/drivers/pci/hotplug/cpqphp_core.c @@ -296,9 +296,10 @@ static int ctrl_slot_cleanup(struct controller *ctrl) * * Won't work for more than one PCI-PCI bridge in a slot. * - * @bus_num - bus number of PCI device - * @dev_num - device number of PCI device - * @slot - Pointer to u8 where slot number will be returned + * @bus: pointer to the PCI bus structure + * @bus_num: bus number of PCI device + * @dev_num: device number of PCI device + * @slot: Pointer to u8 where slot number will be returned * * Output: SUCCESS or FAILURE */ diff --git a/drivers/pci/hotplug/cpqphp_ctrl.c b/drivers/pci/hotplug/cpqphp_ctrl.c index 68de958a9be8..b881cc2b01c8 100644 --- a/drivers/pci/hotplug/cpqphp_ctrl.c +++ b/drivers/pci/hotplug/cpqphp_ctrl.c @@ -1877,7 +1877,7 @@ static void interrupt_event_handler(struct controller *ctrl) /** * cpqhp_pushbutton_thread - handle pushbutton events - * @slot: target slot (struct) + * @t: pointer to struct timer_list which holds all timer related callbacks * * Scheduled procedure to handle blocking stuff for the pushbuttons. * Handles all pending events and exits. diff --git a/drivers/pci/hotplug/pciehp.h b/drivers/pci/hotplug/pciehp.h index 4fd200d8b0a9..ab57c11aa58a 100644 --- a/drivers/pci/hotplug/pciehp.h +++ b/drivers/pci/hotplug/pciehp.h @@ -47,6 +47,9 @@ extern int pciehp_poll_time; * struct controller - PCIe hotplug controller * @pcie: pointer to the controller's PCIe port service device * @slot_cap: cached copy of the Slot Capabilities register + * @inband_presence_disabled: whether In-Band Presence Detect Disable is + * supported by the controller and disabled per spec recommendation + * (PCIe r5.0, appendix I implementation note) * @slot_ctrl: cached copy of the Slot Control register * @ctrl_lock: serializes writes to the Slot Control register * @cmd_started: jiffies when the Slot Control register was last written; diff --git a/include/linux/pci_hotplug.h b/include/linux/pci_hotplug.h index b482e42d7153..2dac431d94ac 100644 --- a/include/linux/pci_hotplug.h +++ b/include/linux/pci_hotplug.h @@ -50,6 +50,8 @@ struct hotplug_slot_ops { /** * struct hotplug_slot - used to register a physical slot with the hotplug pci core * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot + * @slot_list: internal list used to track hotplug PCI slots + * @pci_slot: represents a physical slot * @owner: The module owner of this structure * @mod_name: The module name (KBUILD_MODNAME) of this structure */ From patchwork Sat Jul 3 15:13:06 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= X-Patchwork-Id: 12357065 X-Patchwork-Delegate: lorenzo.pieralisi@arm.com Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3522FC07E99 for ; Sat, 3 Jul 2021 15:13:16 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 17E9B61936 for ; Sat, 3 Jul 2021 15:13:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229907AbhGCPPt (ORCPT ); Sat, 3 Jul 2021 11:15:49 -0400 Received: from mail-lj1-f178.google.com ([209.85.208.178]:46047 "EHLO mail-lj1-f178.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229787AbhGCPPs (ORCPT ); Sat, 3 Jul 2021 11:15:48 -0400 Received: by mail-lj1-f178.google.com with SMTP id u20so17760961ljo.12 for ; Sat, 03 Jul 2021 08:13:13 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=6lHQTkFszDwppiFYXxWFA+kKr860Oxn5YwDCzS+9heU=; b=eProUmst4sg72kHTcsktd6Onl8vkkRQgCsfw+6a44a6wgMMHodikoHmLzsGsvBKDJs f/79k8IZ1eaTAoRi1YcoEOaD1Kin4ULidx3bUULxb/5bEC+qjFaO0VPI6gz3pLMSh4Cv 9U9IiXg5TQ3I+j7omKcA6qEa7QsLVecx1ejfRrijH2XAfaKeuL2HtNauBtieUdDgDPsQ 24+t83WFLTQJUr9OqDzrUYDr0+htYvbGzgNZhErNzN07zjF9K3ttRWJ2vSDkLPXxbpYC UhBFnHjdXZfk0tH3A4N9N/bt98yQ3gTobHit+joYEuztEHEsMBBLa48pTAc1QKc8gZn5 0GvA== X-Gm-Message-State: AOAM530pWRlmY/oS3E8CfEyBeeEYLAjUvaVwx5/havuX8iyOPImgZEiT oPyE7h7CLHKZyl8pFRZHdEo= X-Google-Smtp-Source: ABdhPJzHbwkWTp5lomxzPU1dmoE8sF99vTpppKGzpbH6LWc4gwV/maUXyu+gYWgpDjdXXkhJgfKz8g== X-Received: by 2002:a05:651c:168a:: with SMTP id bd10mr3809573ljb.341.1625325192914; Sat, 03 Jul 2021 08:13:12 -0700 (PDT) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id p18sm715980ljj.56.2021.07.03.08.13.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 03 Jul 2021 08:13:12 -0700 (PDT) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Lukas Wunner , Rob Herring , Scott Branden , Scott Murray , Tom Joseph , bcm-kernel-feedback-list@broadcom.com, linux-arm-kernel@lists.infradead.org, linux-pci@vger.kernel.org Subject: [PATCH 5/5] PCI: endpoint: Fix kernel-doc formatting and add missing documentation Date: Sat, 3 Jul 2021 15:13:06 +0000 Message-Id: <20210703151306.1922450-5-kw@linux.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20210703151306.1922450-1-kw@linux.com> References: <20210703151306.1922450-1-kw@linux.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Fix a non-compliant kernel-doc at the top of the files include/linux/pci-ep-cfs.h and include/linux/pci-epc.h. Also add the following missing documentation: - "barno" and "flags" members of the struct pci_epf_bar - "msix_interrupts" member of the struct pci_epf - "get_features" member of the struct pci_epc_ops - "core_init_notifier" member of the struct pci_epc_features Thus, resolve build time warnings related to kernel-doc: include/linux/pci-epf.h:4: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst include/linux/pci-epf.h:113: warning: Function parameter or member 'barno' not described in 'pci_epf_bar' include/linux/pci-epf.h:113: warning: Function parameter or member 'flags' not described in 'pci_epf_bar' include/linux/pci-epf.h:157: warning: Function parameter or member 'msix_interrupts' not described in 'pci_epf' include/linux/pci-ep-cfs.h:4: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst include/linux/pci-epc.h:4: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst include/linux/pci-epc.h:91: warning: Function parameter or member 'get_features' not described in 'pci_epc_ops' include/linux/pci-epc.h:170: warning: Function parameter or member 'core_init_notifier' not described in 'pci_epc_features' No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- include/linux/pci-ep-cfs.h | 2 +- include/linux/pci-epc.h | 5 ++++- include/linux/pci-epf.h | 5 ++++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/include/linux/pci-ep-cfs.h b/include/linux/pci-ep-cfs.h index 662881335c7e..3e2140d7e31d 100644 --- a/include/linux/pci-ep-cfs.h +++ b/include/linux/pci-ep-cfs.h @@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0+ */ -/** +/* * PCI Endpoint ConfigFS header file * * Copyright (C) 2017 Texas Instruments diff --git a/include/linux/pci-epc.h b/include/linux/pci-epc.h index b82c9b100e97..48e75d8f0543 100644 --- a/include/linux/pci-epc.h +++ b/include/linux/pci-epc.h @@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0 */ -/** +/* * PCI Endpoint *Controller* (EPC) header file * * Copyright (C) 2017 Texas Instruments @@ -58,6 +58,7 @@ pci_epc_interface_string(enum pci_epc_interface_type type) * @map_msi_irq: ops to map physical address to MSI address and return MSI data * @start: ops to start the PCI link * @stop: ops to stop the PCI link + * @get_features: ops to get the features supported by the EPC * @owner: the module owner containing the ops */ struct pci_epc_ops { @@ -150,6 +151,8 @@ struct pci_epc { /** * struct pci_epc_features - features supported by a EPC device per function * @linkup_notifier: indicate if the EPC device can notify EPF driver on link up + * @core_init_notifier: indicate cores that can notify about their availability + * for initialization * @msi_capable: indicate if the endpoint function has MSI capability * @msix_capable: indicate if the endpoint function has MSI-X capability * @reserved_bar: bitmap to indicate reserved BAR unavailable to function driver diff --git a/include/linux/pci-epf.h b/include/linux/pci-epf.h index 6833e2160ef1..6d1cc35209b6 100644 --- a/include/linux/pci-epf.h +++ b/include/linux/pci-epf.h @@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0 */ -/** +/* * PCI Endpoint *Function* (EPF) header file * * Copyright (C) 2017 Texas Instruments @@ -102,6 +102,8 @@ struct pci_epf_driver { * @phys_addr: physical address that should be mapped to the BAR * @addr: virtual address corresponding to the @phys_addr * @size: the size of the address space present in BAR + * @barno: the BAR number + * @flags: flags that are set for the BAR */ struct pci_epf_bar { dma_addr_t phys_addr; @@ -118,6 +120,7 @@ struct pci_epf_bar { * @header: represents standard configuration header * @bar: represents the BAR of EPF device * @msi_interrupts: number of MSI interrupts required by this function + * @msix_interrupts: number of MSI-X interrupts required by this function * @func_no: unique function number within this endpoint device * @epc: the EPC device to which this EPF device is bound * @driver: the EPF driver to which this EPF device is bound