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: 12357047 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=-17.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,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 CE49CC07E97 for ; Sat, 3 Jul 2021 15:15:22 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 8881661938 for ; Sat, 3 Jul 2021 15:15:22 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 8881661938 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=linux.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:Cc :To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=UQjzlPaHBHpDQJtJCYHSW/Eg1z9nbaUJrD6IqWtQjcs=; b=Yk1KUQkvZxv30U gnhVkD4fWWsHPp76q4CxuytSX2Kp6GsVa0A5SemNceS/3K300TFvqVDFmfKRE30r2Mi4Qrc3lYVdK jgyVwhJLXt1P0upWZkMmj0xMx6ZuNQ8R14yU3Ko+MeC3aQsFgGBIm2k7POnADZLWeMB6sWf3suqGg f2s12mwvY2Nx5qVWfN6yXDqiio5RZsu3sFYOcxsDn5ah3R/hMklTNA92ha+QuupLfJc9Sm+OMHDj6 V572+XNgPGg9MgUX7W2Ms6IyctYvbD8TKPJLJ7kYdvpV394sxorKOIikgrSu8VwWaHB57wIii3l/T SvpJ0yQ8dKuIzQc9dDBw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhKU-0050aq-Kk; Sat, 03 Jul 2021 15:13:14 +0000 Received: from mail-lf1-f52.google.com ([209.85.167.52]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhKR-0050Zo-8p for linux-arm-kernel@lists.infradead.org; Sat, 03 Jul 2021 15:13:12 +0000 Received: by mail-lf1-f52.google.com with SMTP id r26so6387181lfp.2 for ; Sat, 03 Jul 2021 08:13:09 -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=HG7xdnwf39+NCSUS8ZtYMcGDuNTPPn3Ijm6ltnWswkeYaHjhjtvH8V2igFmTHaEJyH NQpFWMSxfe94dDGGpP0Tcsxf6q3z0MmNH0vQ0vMcXyaewy8BhSRuCF9ECvCHGHl9dNO6 epeFwymZfF1m3ePMSS3vf9Cs2HIl/lA/iV0dLjKtOicWcDbx6TqMFhpuU68kBY5UM2Kd waQZ1IUGzGoE78HDF1PcRuOfjYSCD8KLWG3ozCWR5aUvKzkIqEHYRPgqpn0WNnCWOhC8 gco6FsrgNGrhGR/XfeZYCJoqI5FXqNRiBI9OFR5CNRk+cZdt7BSk3ptYyt1eXA0f53Oh kH+g== X-Gm-Message-State: AOAM532hVqDGf3XsH/e6JBiBAZCGF+eaEL9xSEAY2SQBuGVnS4FT+MkQ 2iWTDuXbTK8FgRNkav5FygM= 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 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210703_081311_352990_90288BD9 X-CRM114-Status: GOOD ( 11.93 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.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: 12357049 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=-17.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,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 377B3C07E99 for ; Sat, 3 Jul 2021 15:15:23 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id F2F2F61402 for ; Sat, 3 Jul 2021 15:15:22 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org F2F2F61402 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=linux.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=6lAxtBQ2riw3cJAXFGNhVUIca+tST67WtTtNJ1+W0oM=; b=chrBxAzZaPs27n kgKRdYK1/nozcbik+BzTVQdieXsMiGdbRK30xIp8GhMaoKSAFGZRE8iCLoVLEzQSt/xG7BjeR7V+e kRn3d1GXfvzELXHYJ/R8OoYLB57YaM8cGWaFLhr0MxRNbBdZlo+bJK3/kwhCI71R6jIs8BqhFj7Yk T6HXhpD4bPcJPAh5D4BgS/UU8gwsn5F0NIx8ecJ/cDt+Joihsme9aTRywOTRWe7K425xgLU0wLPKp LNesFOPaVO8DElwjKE8s4bfjmx7CB3Qx1IlQFuGB3oPgLy5gdU2h0GXJsxBwjqIk4CSl1h3ugbjlT Y2728vflDlqVuljVNv+Q==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhKe-0050cB-DN; Sat, 03 Jul 2021 15:13:24 +0000 Received: from mail-lf1-f50.google.com ([209.85.167.50]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhKR-0050Zr-4Z for linux-arm-kernel@lists.infradead.org; Sat, 03 Jul 2021 15:13:13 +0000 Received: by mail-lf1-f50.google.com with SMTP id c28so439540lfp.11 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=G29/DOPRTKrVDrhr2XlgbZaZtSFAOPWysmLzKwqkT0DO50Fv31KLmnMMNmFcJCENXw Kfux22hX94vdRZF+jX+cqkdFSQL7PZsqW599qY3/eyDELt4BzJQSl21o2AptuZ0ifuaW 7k1bXTFZSjYnfM4NtSMw9eOiItOO56oaNbCSn66g1uubHjIuoxU/MLXpeRjTDA6i94jd 6flgMHs14hSE48WlmnJKTI97Of/GjUWQw4Ch6c//MftPEAHNzmh8v5/sGRQHAhZwABBT yOBhtDYqsqSjnym3KaXh+l/ETgDcCHOFkSCzGROwFSQuAJJHoPSryAyYMo9KvZVltyZ0 2NVQ== X-Gm-Message-State: AOAM5336earejEN3muHehRpsDgE+h+K2CQJgE18IZqdaPgf9YGePMjzi uHBWFHJmosNsp0F3y9zHAWQ= 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 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210703_081311_233566_FADACB73 X-CRM114-Status: GOOD ( 21.17 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.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: 12357051 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=-17.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,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 773FAC07E98 for ; Sat, 3 Jul 2021 15:15:23 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 3FAA561402 for ; Sat, 3 Jul 2021 15:15:23 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 3FAA561402 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=linux.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=Uv4bgWnSTEb0O6iGM07EPzFf5+3ByTK32xy2BuYVkF4=; b=rv+kBk/5e5mIpC 6piZ01cTbjl7InjEqqNSzzn/fCN5knL0mNA+YlymrSR4IYTzEljOwHQ6ZW01y85Zm3cR6svv16CSI ddITjGKdbTdVtnE8dxbvEkX127smoQQRzCLtS2qLxK2pw7vgK/4DsTr+yy4G62mfPJUoXvz3dB8A1 12RLE7x1Z+o7gUQfqwE5C4lBibwkYLITY8QIr1t9wywo7RfZfWtRvZO9Or1RgF2SrWuH5l8tBFU15 TOK6ZfRLR3G2VHPvyJ1qeLjH6JDwNM014Z6DQDu2lUjJ3fUKT/80NBR/0jxWwGN1G9gAl+ciNf0B3 uyM6JZHeHebfhE5GM2CA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhKp-0050cg-Pz; Sat, 03 Jul 2021 15:13:35 +0000 Received: from mail-lf1-f53.google.com ([209.85.167.53]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhKW-0050Zs-IX for linux-arm-kernel@lists.infradead.org; Sat, 03 Jul 2021 15:13:17 +0000 Received: by mail-lf1-f53.google.com with SMTP id q18so23841042lfc.7 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=qWj1QTqW3/9aoFjQ3PYHvukFJUTdnTPlTZW13mW7xtGSZBSAkjpOXGXocwVBNLgESC eMFbjgpyzLRUoyogs7bS+EbeFtJ3Ki5E5ydtshdj9ngBs0TweaX++7ETu8OIPVuW8orU 4GcwkpA8TN7FjrIC9ABO4Ei+AvNE3/F7zfKofA7SQt8B4J0BjEPpTaszenoVp5MpkR3L ONF4KP8HrRsUGMrFPRIjbsMCauNqh08PUH98lvHyhkLF0wFpFQkPXfFwWLywBCVTGhAU UEnBRElzgkHz+rYi4NfbkyWGtTqyy5cuayZb2+8zRu64tKWyzYz2NiEgxSncUsHSRH3H 8CLw== X-Gm-Message-State: AOAM532ZrURrzyg/evhE+2apRt2cr0LhvSDEnujoztjeSZpoYO30v4ly OxizyRMunB22k0HgnFE0tqo= 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 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210703_081316_659157_002AA373 X-CRM114-Status: GOOD ( 13.50 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.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: 12357053 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=-17.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,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 885CCC07E9B for ; Sat, 3 Jul 2021 15:15:24 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 53C1161402 for ; Sat, 3 Jul 2021 15:15:24 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 53C1161402 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=linux.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=o/vynqWQE57yCFepF6zQIrM+9atfmtD7fut6L+c9Ht8=; b=MBysZjdHAAEGN/ 0bKToLe94WJ6iJXwAntjfxg4VFiXE69NvR7bj46YJw3tEXvBVW9hFwiHjAZ+Q0uYdAb2WDty8VI3b KHnp2UFMYog7xSLBb5B6nMYMqW56Xb339GzvcbdFnac0KQDF94lb7oj4D7kCQ3iubTPmXJFAiXJJw 6S7Zg2gKCBo/xym/iZJL/14b0PWooIQGAMWNZT1SaBF3pRQ8SD0He0RcjHVvFQ773mQeGx6gdOwAQ LBOSZlG8r+Unb31cHowX7EzRyu7ufOwYBptdhioIzEdT32u0VsF2NwQdiD6st1yN3X3kgJRFMeO4q X0lmdRUCEAVnce9MdTqw==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhKz-0050dw-Od; Sat, 03 Jul 2021 15:13:45 +0000 Received: from mail-lf1-f45.google.com ([209.85.167.45]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhKW-0050aR-Nv for linux-arm-kernel@lists.infradead.org; Sat, 03 Jul 2021 15:13:18 +0000 Received: by mail-lf1-f45.google.com with SMTP id w19so23858706lfk.5 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=U7rzTOb04LbYLPb0x72Oq3slQy7w9mF5ZvWIsm7kXic=; b=E5tx7mFWvwDQFxzY/BkkWkeCF2cUQypjV4Hh+fINHhqWB5Xtc0afr5F/D49ru83DQ2 TdKrjdyKao1uoehrRxsLaJJvMB/tmF6Awq6+meiQEkRsXR4IxEZiZX+4vpdt/ot23ito +JkW4b16/h2bjXWn3JDiBIr/CFaEgqz/5VUExgwuiDMiyPqcT5O/hHpyhtn5JndjhoBe bc01RKrBu6qONdnuoGubUwK23IjHEFj/COcslYZtIOvGR4srWPAD6OYVrTO4IRpMmpAu 4rfbfqzlccODfxlRVmDkWQMA9lBANyadB1QOMEJiduyAEl/bsXJjdZGSlKgrFioobbwX PxVg== X-Gm-Message-State: AOAM531KqmnNC8AqLSuzBORwUPyXvm0M7c6qQlmonZ2YsOj1FZCs+NXq jtCxfu9STP0uGjt0crl0F5o= 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 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210703_081316_829953_CCAD899E X-CRM114-Status: GOOD ( 16.43 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.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: 12357055 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=-17.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,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 2876DC07E97 for ; Sat, 3 Jul 2021 15:15:30 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id ED25161402 for ; Sat, 3 Jul 2021 15:15:29 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org ED25161402 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=linux.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=2nSbt4UNeF6pvgxT3WPoDBZ0vumDi7rjHcVGjwmXurs=; b=ta4RvOL51S3x2Z FfQn7y/2A8rvF3Bqj7xcr7WnLjg4UCDsbOqTaFt/3hl2P87STPFpshZQhWjE9MP5NaPKnTF8iqE5X jnbWVEGp/7cMEwocCaeJ+fXmC3CmUqD9ZZJxP5I4srAoncrr7+BwKiJo+I0jio4hjRlgkJlVuF8QJ CNgun2IVWFHdBTJsm0ABQqNHzTzMZNahWYzj/cm/i5o4y/hx5ncHNf23CpR4NO76mABZ6aIxnnaaK ON12Oxf1K9Wj0lEf9/yWFZ3HK2jTUMgR9Z8qkphHGXM99aHQM6BwpMXr3zMNGs8VAwdiVEq7+LFW8 6CioQ0zJjB+xLdC8Ys1w==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhLA-0050fV-4B; Sat, 03 Jul 2021 15:13:56 +0000 Received: from mail-lj1-f181.google.com ([209.85.208.181]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1lzhKX-0050ap-8X for linux-arm-kernel@lists.infradead.org; Sat, 03 Jul 2021 15:13:19 +0000 Received: by mail-lj1-f181.google.com with SMTP id p24so17867434ljj.1 for ; Sat, 03 Jul 2021 08:13:14 -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=eEzhxTLIXaZ0rWEdW0zRwLYhMiLMBYmuicpqM0rHbhkhbFjCzz4utHL3iAiq4PcLPN 07mvqV6AVZ9x2lEipy9lG8D0u+OeH6xTHiSBOBzErKoE3ay+5YRjidBjkjer8JFS7hqi xq7T18D0aHL7byr/BecuKUcj8l7q2Riu6i+Jmygrk7+8eFl8+iLSlahSaeKXprLwrQ5Q sAQa3DhEfc9BXjoebe5zx5qbzG6ZnjA00YqcGTzPHoL91MmyCnJPqAGeHM+ic8sEABnA jjMiQkFJygivGmk4Ev2AzZZG/D9hSPEpT4kWDtzisadSJzpT3ajzlUSL2aFeluRDcej2 kWAA== X-Gm-Message-State: AOAM533YPeSZ+xfuU66/6lbi2v/JgWfSELJeoFs+JDqQFbrKyvuKw07/ iH62h6dgNandzisMAvagQi6pOFDvC04mxA== 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 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210703_081317_348656_6FA110F0 X-CRM114-Status: GOOD ( 18.43 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.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