From patchwork Thu Mar 11 00:17:17 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: 12129799 X-Patchwork-Delegate: bhelgaas@google.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 7E035C43381 for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 62B0E64FCE for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229569AbhCKARl (ORCPT ); Wed, 10 Mar 2021 19:17:41 -0500 Received: from mail-lf1-f54.google.com ([209.85.167.54]:44040 "EHLO mail-lf1-f54.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229603AbhCKAR1 (ORCPT ); Wed, 10 Mar 2021 19:17:27 -0500 Received: by mail-lf1-f54.google.com with SMTP id p21so36651248lfu.11 for ; Wed, 10 Mar 2021 16:17:27 -0800 (PST) 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=Q3lO8pebCVFGO+fEfIU0tWuyR+GRHMbt+x018VBrXDU=; b=ptraTT5gj7YwszaGiu1knHlrH45ciWvbb65QvrJK4cDwtfflwPH9x9f6uhfLWWcwpn g0jShL3zzno/1aHzcCO++gIHggbmz7Cfnztpt+RN2J6wynd5o7Nl+Bq2mjQbdXS+zps4 zDH8SzfAM4i6wWWN1pFfkEHy4sRgUhf2LA93MugkYZ1VGstSR4Pc6lUkhEPGaCzkKbZP GIqXNeJh9MtnhjUJW/M+01rC4mkU7eNIOiMtaZGo7A4i28SndALbFuIieXyA8FwbjBhn 0NS/pUJujKCFZ6woJ/i+lrsIi/TOmlOit1YxRozEhNfr7ZFetLoLvcS/jbaGFc5QMaQw aGQg== X-Gm-Message-State: AOAM532rRbjCEEnT6twjKJnVJRT1Y0KZTGJ7olM5mN6776hPnE3KYmg5 27IyYYPLuw6diIXYHSF3UNU= X-Google-Smtp-Source: ABdhPJxCZqtp/ATFnX8k3HtxV8Vq/s6YyWBaLoJ7SQ+ucs0/muOBRBh0hp8yOAQpJ/2Hj7UUA73MrQ== X-Received: by 2002:ac2:5fe6:: with SMTP id s6mr601998lfg.445.1615421846245; Wed, 10 Mar 2021 16:17:26 -0800 (PST) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id y186sm269332lfc.304.2021.03.10.16.17.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 16:17:25 -0800 (PST) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Kishon Vijay Abraham I , Tom Joseph , Murali Karicheri , Rob Herring , Russell Currey , "Oliver O'Halloran" , Geert Uytterhoeven , Arnd Bergmann , Krzysztof Kozlowski , Kunihiko Hayashi , Sean V Kelley , Qiuxu Zhuo , Jay Fang , linux-pci@vger.kernel.org Subject: [PATCH 1/8] PCI: endpoint: Fix kernel-doc formatting and add missing documentation Date: Thu, 11 Mar 2021 00:17:17 +0000 Message-Id: <20210311001724.423356-1-kw@linux.com> X-Mailer: git-send-email 2.30.1 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Add missing documentation for the parameters "ntb_epc", "type", "dev", and "group" of the following functions: - epf_ntb_add_cfs() - epf_ntb_alloc_peer_mem() - epf_ntb_config_sspad_bar_clear(), - epf_ntb_config_sspad_bar_set() - epf_ntb_peer_spad_bar_clear() - epf_ntb_peer_spad_bar_set() - pci_epc_remove_epf() Remove surplus parameter from the epf_ntb_init_epc_bar() function. Additionally, fix a non-compliant kernel-doc at the top of the files pci-epf-ntb.c and pci-epf-test.c, and resolve number of build time warnings related to kernel-doc: drivers/pci/endpoint/functions/pci-epf-ntb.c:1363: warning: Function parameter or member 'dev' not described in 'epf_ntb_alloc_peer_mem' drivers/pci/endpoint/functions/pci-epf-ntb.c:2046: warning: Function parameter or member 'group' not described in 'epf_ntb_add_cfs' drivers/pci/endpoint/functions/pci-epf-ntb.c:1670: warning: Excess function parameter 'type' description in 'epf_ntb_init_epc_bar' drivers/pci/endpoint/functions/pci-epf-ntb.c:45: warning: cannot understand function prototype: 'struct workqueue_struct *kpcintb_workqueue; ' drivers/pci/endpoint/functions/pci-epf-ntb.c:727: warning: Excess function parameter 'ntb' description in 'epf_ntb_peer_spad_bar_clear' drivers/pci/endpoint/functions/pci-epf-ntb.c:727: warning: Function parameter or member 'ntb_epc' not described in 'epf_ntb_peer_spad_bar_clear' drivers/pci/endpoint/functions/pci-epf-ntb.c:771: warning: Function parameter or member 'type' not described in 'epf_ntb_peer_spad_bar_set' drivers/pci/endpoint/functions/pci-epf-ntb.c:839: warning: Excess function parameter 'ntb' description in 'epf_ntb_config_sspad_bar_clear' drivers/pci/endpoint/functions/pci-epf-ntb.c:839: warning: Function parameter or member 'ntb_epc' not described in 'epf_ntb_config_sspad_bar_clear' drivers/pci/endpoint/functions/pci-epf-ntb.c:882: warning: Excess function parameter 'ntb' description in 'epf_ntb_config_sspad_bar_set' drivers/pci/endpoint/functions/pci-epf-ntb.c:882: warning: Function parameter or member 'ntb_epc' not described in 'epf_ntb_config_sspad_bar_set' drivers/pci/endpoint/functions/pci-epf-test.c:22: warning: expecting prototype for Test driver to test endpoint functionality(). Prototype was for IRQ_TYPE_LEGACY() instead No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/endpoint/functions/pci-epf-ntb.c | 16 +++++++++++----- drivers/pci/endpoint/functions/pci-epf-test.c | 2 +- drivers/pci/endpoint/pci-epc-core.c | 2 ++ 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/drivers/pci/endpoint/functions/pci-epf-ntb.c b/drivers/pci/endpoint/functions/pci-epf-ntb.c index 338148cf56f5..bce274d02dcf 100644 --- a/drivers/pci/endpoint/functions/pci-epf-ntb.c +++ b/drivers/pci/endpoint/functions/pci-epf-ntb.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -/** +/* * Endpoint Function Driver to implement Non-Transparent Bridge functionality * * Copyright (C) 2020 Texas Instruments @@ -696,7 +696,8 @@ static void epf_ntb_cmd_handler(struct work_struct *work) /** * epf_ntb_peer_spad_bar_clear() - Clear Peer Scratchpad BAR - * @ntb: NTB device that facilitates communication between HOST1 and HOST2 + * @ntb_epc: EPC associated with one of the HOST which holds peer's outbound + * address. * *+-----------------+------->+------------------+ +-----------------+ *| BAR0 | | CONFIG REGION | | BAR0 | @@ -740,6 +741,7 @@ static void epf_ntb_peer_spad_bar_clear(struct epf_ntb_epc *ntb_epc) /** * epf_ntb_peer_spad_bar_set() - Set peer scratchpad BAR * @ntb: NTB device that facilitates communication between HOST1 and HOST2 + * @type: PRIMARY interface or SECONDARY interface * *+-----------------+------->+------------------+ +-----------------+ *| BAR0 | | CONFIG REGION | | BAR0 | @@ -808,7 +810,8 @@ static int epf_ntb_peer_spad_bar_set(struct epf_ntb *ntb, /** * epf_ntb_config_sspad_bar_clear() - Clear Config + Self scratchpad BAR - * @ntb: NTB device that facilitates communication between HOST1 and HOST2 + * @ntb_epc: EPC associated with one of the HOST which holds peer's outbound + * address. * * +-----------------+------->+------------------+ +-----------------+ * | BAR0 | | CONFIG REGION | | BAR0 | @@ -851,7 +854,8 @@ static void epf_ntb_config_sspad_bar_clear(struct epf_ntb_epc *ntb_epc) /** * epf_ntb_config_sspad_bar_set() - Set Config + Self scratchpad BAR - * @ntb: NTB device that facilitates communication between HOST1 and HOST2 + * @ntb_epc: EPC associated with one of the HOST which holds peer's outbound + * address. * * +-----------------+------->+------------------+ +-----------------+ * | BAR0 | | CONFIG REGION | | BAR0 | @@ -1312,6 +1316,7 @@ static int epf_ntb_configure_interrupt(struct epf_ntb *ntb, /** * epf_ntb_alloc_peer_mem() - Allocate memory in peer's outbound address space + * @dev: The PCI device. * @ntb_epc: EPC associated with one of the HOST whose BAR holds peer's outbound * address * @bar: BAR of @ntb_epc in for which memory has to be allocated (could be @@ -1660,7 +1665,6 @@ static int epf_ntb_init_epc_bar_interface(struct epf_ntb *ntb, * epf_ntb_init_epc_bar() - Identify BARs to be used for each of the NTB * constructs (scratchpad region, doorbell, memorywindow) * @ntb: NTB device that facilitates communication between HOST1 and HOST2 - * @type: PRIMARY interface or SECONDARY interface * * Wrapper to epf_ntb_init_epc_bar_interface() to identify the free BARs * to be used for each of BAR_CONFIG, BAR_PEER_SPAD, BAR_DB_MW1, BAR_MW2, @@ -2037,6 +2041,8 @@ static const struct config_item_type ntb_group_type = { /** * epf_ntb_add_cfs() - Add configfs directory specific to NTB * @epf: NTB endpoint function device + * @group: A pointer to the config_group structure referencing a group of + * config_items of a specific type that belong to a specific sub-system. * * Add configfs directory specific to NTB. This directory will hold * NTB specific properties like db_count, spad_count, num_mws etc., diff --git a/drivers/pci/endpoint/functions/pci-epf-test.c b/drivers/pci/endpoint/functions/pci-epf-test.c index c0ac4e9cbe72..63d5f5c6e3e0 100644 --- a/drivers/pci/endpoint/functions/pci-epf-test.c +++ b/drivers/pci/endpoint/functions/pci-epf-test.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -/** +/* * Test driver to test endpoint functionality * * Copyright (C) 2017 Texas Instruments diff --git a/drivers/pci/endpoint/pci-epc-core.c b/drivers/pci/endpoint/pci-epc-core.c index cc8f9eb2b177..adec9bee72cf 100644 --- a/drivers/pci/endpoint/pci-epc-core.c +++ b/drivers/pci/endpoint/pci-epc-core.c @@ -594,6 +594,8 @@ EXPORT_SYMBOL_GPL(pci_epc_add_epf); * pci_epc_remove_epf() - remove PCI endpoint function from endpoint controller * @epc: the EPC device from which the endpoint function should be removed * @epf: the endpoint function to be removed + * @type: identifies if the EPC is connected to the primary or secondary + * interface of EPF * * Invoke to remove PCI endpoint function from the endpoint controller. */ From patchwork Thu Mar 11 00:17:18 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: 12129797 X-Patchwork-Delegate: bhelgaas@google.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 77DCAC433E9 for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 516BC64FD4 for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229441AbhCKARl (ORCPT ); Wed, 10 Mar 2021 19:17:41 -0500 Received: from mail-lj1-f176.google.com ([209.85.208.176]:39211 "EHLO mail-lj1-f176.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229612AbhCKAR2 (ORCPT ); Wed, 10 Mar 2021 19:17:28 -0500 Received: by mail-lj1-f176.google.com with SMTP id e20so88408ljn.6 for ; Wed, 10 Mar 2021 16:17:28 -0800 (PST) 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=A5H4fGIgo3dUpMCIo2j40I5wIj0MRYFpDDCxoqUPc5w=; b=JdP9wBDtVoDVmbhkD2mNWQbughy+Z96KbJ2CK24A2pZjI9aluL6QQ61IaxVWA4WlEc tA/Kwn0TxjLIWWqk31Vi+NAtGLE/majG3M9ZZh1ETY6mGTNWWPqzVxhZLvf0qdPtmikY C4YFZp1M90679+nA1BIFW5gZC3YlOXaJPShUsyWEY42LdqmGHz6WWLVh/so+j+ar0Dp4 HaAilcy+oSCsoPr5jz65hKG1OXqwnEv2w41NkrRKkVvSa+nofQCG1qtDj8a2scMO4dST d5/tVXMYrXBnxwgTvsM5b9jK2fCQP8dRmb5QcBiGgY5WG4lUwBqhjNKviEm+bDPagCw9 0pJQ== X-Gm-Message-State: AOAM531RmUmCKs6LjzriVCu9SDE/nZwJtyrlbEubVFHgIeqJTC/V9KKJ LqdJM8UDN5Xa7ArJkNaUNxo= X-Google-Smtp-Source: ABdhPJzx8D8PuTst522MhCYIm0jb2r1VSliIaz1do8blvP5IxyLsQo7fTvG1hCDuJLJ+SZQ6w0gTNA== X-Received: by 2002:a2e:a0d0:: with SMTP id f16mr3360194ljm.215.1615421847382; Wed, 10 Mar 2021 16:17:27 -0800 (PST) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id y186sm269332lfc.304.2021.03.10.16.17.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 16:17:26 -0800 (PST) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Kishon Vijay Abraham I , Tom Joseph , Murali Karicheri , Rob Herring , Russell Currey , "Oliver O'Halloran" , Geert Uytterhoeven , Arnd Bergmann , Krzysztof Kozlowski , Kunihiko Hayashi , Sean V Kelley , Qiuxu Zhuo , Jay Fang , linux-pci@vger.kernel.org Subject: [PATCH 2/8] PCI/AER: Update functions names in the kernel-doc Date: Thu, 11 Mar 2021 00:17:18 +0000 Message-Id: <20210311001724.423356-2-kw@linux.com> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210311001724.423356-1-kw@linux.com> References: <20210311001724.423356-1-kw@linux.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Update function names in the kernel-doc to match function prototypes for functions enable_ecrc_checking(), disable_ecrc_checking() and pcie_aer_init(), and resolve build time warnings related to kernel-doc: drivers/pci/pcie/aer.c:138: warning: expecting prototype for enable_ercr_checking(). Prototype was for enable_ecrc_checking() instead drivers/pci/pcie/aer.c:1450: warning: expecting prototype for aer_service_init(). Prototype was for pcie_aer_init() instead drivers/pci/pcie/aer.c:162: warning: expecting prototype for disable_ercr_checking(). Prototype was for disable_ecrc_checking() instead No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/pcie/aer.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/drivers/pci/pcie/aer.c b/drivers/pci/pcie/aer.c index ba22388342d1..ec943cee5ecc 100644 --- a/drivers/pci/pcie/aer.c +++ b/drivers/pci/pcie/aer.c @@ -129,7 +129,7 @@ static const char * const ecrc_policy_str[] = { }; /** - * enable_ercr_checking - enable PCIe ECRC checking for a device + * enable_ecrc_checking - enable PCIe ECRC checking for a device * @dev: the PCI device * * Returns 0 on success, or negative on failure. @@ -153,7 +153,7 @@ static int enable_ecrc_checking(struct pci_dev *dev) } /** - * disable_ercr_checking - disables PCIe ECRC checking for a device + * disable_ecrc_checking - disables PCIe ECRC checking for a device * @dev: the PCI device * * Returns 0 on success, or negative on failure. @@ -1442,7 +1442,7 @@ static struct pcie_port_service_driver aerdriver = { }; /** - * aer_service_init - register AER root service driver + * pcie_aer_init - register AER root service driver * * Invoked when AER root service driver is loaded. */ From patchwork Thu Mar 11 00:17:19 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: 12129795 X-Patchwork-Delegate: bhelgaas@google.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 615C8C433E6 for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 29EC864FAD for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229468AbhCKARm (ORCPT ); Wed, 10 Mar 2021 19:17:42 -0500 Received: from mail-lj1-f173.google.com ([209.85.208.173]:41001 "EHLO mail-lj1-f173.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229632AbhCKAR3 (ORCPT ); Wed, 10 Mar 2021 19:17:29 -0500 Received: by mail-lj1-f173.google.com with SMTP id t9so78777ljt.8 for ; Wed, 10 Mar 2021 16:17:29 -0800 (PST) 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=t2becTOHhnpDLLCNKLhd3Mi2zYpwApKxhajyRI9f9S8=; b=gtWKjygKo++thwZVfLY7pQjx+sAnIq/kuLbUH+G6rscQqV6MfeW32+nWBs7A6qbQ6c vUDAMHaqpWMHJSYaniONDdl7swSQuXH7iXVpKJu+hPUGDIiDWEpbPIgfcUJYyIip+g0v zmJs2ELHb0phStYWInf20TPtVyPAUjl1BfWwgZcky2caqvf4aDuk3EcxcZVhtIM3duh4 4vns+iUA4SPj8HlGRiq2vW+sR2B5/1zn/N6LFx2wuD522gqJ2hQzvDkiifyJ/Q2wgXdY 6pqf8PKspworb4zNhKP6ZjO/R/RM0pPL1UgjICNfoHX9d07lujRnv8iMhccggGOgKjJf RpFA== X-Gm-Message-State: AOAM531rctbhvR4LdSEwq+3T4rqhsHfeT/VVsRyibOd+NX9e8WYK9pRp sjkZzNkp4bI9X9MirROV/5s= X-Google-Smtp-Source: ABdhPJybTgPwdtEY8gmUe1zneRabsnGbJ8sgmMsqJoqrHDxq9e9lOAXOO6q1ag3LE0xiKR3gDpcNGQ== X-Received: by 2002:a2e:8111:: with SMTP id d17mr3202656ljg.337.1615421848459; Wed, 10 Mar 2021 16:17:28 -0800 (PST) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id y186sm269332lfc.304.2021.03.10.16.17.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 16:17:28 -0800 (PST) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Kishon Vijay Abraham I , Tom Joseph , Murali Karicheri , Rob Herring , Russell Currey , "Oliver O'Halloran" , Geert Uytterhoeven , Arnd Bergmann , Krzysztof Kozlowski , Kunihiko Hayashi , Sean V Kelley , Qiuxu Zhuo , Jay Fang , linux-pci@vger.kernel.org Subject: [PATCH 3/8] PCI/PME: Update function name in the kernel-doc Date: Thu, 11 Mar 2021 00:17:19 +0000 Message-Id: <20210311001724.423356-3-kw@linux.com> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210311001724.423356-1-kw@linux.com> References: <20210311001724.423356-1-kw@linux.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Update function name in the kernel-doc to match function prototype for function pcie_pme_init(), and resolve build time warning related to kernel-doc: drivers/pci/pcie/pme.c:469: warning: expecting prototype for pcie_pme_service_init(). Prototype was for pcie_pme_init() instead No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/pcie/pme.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/pci/pcie/pme.c b/drivers/pci/pcie/pme.c index 3fc08488d65f..1d0dd77fed3a 100644 --- a/drivers/pci/pcie/pme.c +++ b/drivers/pci/pcie/pme.c @@ -463,7 +463,7 @@ static struct pcie_port_service_driver pcie_pme_driver = { }; /** - * pcie_pme_service_init - Register the PCIe PME service driver. + * pcie_pme_init - Register the PCIe PME service driver. */ int __init pcie_pme_init(void) { From patchwork Thu Mar 11 00:17:20 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: 12129791 X-Patchwork-Delegate: bhelgaas@google.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 412C6C433DB for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 0653264FD5 for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229577AbhCKARm (ORCPT ); Wed, 10 Mar 2021 19:17:42 -0500 Received: from mail-lf1-f50.google.com ([209.85.167.50]:37308 "EHLO mail-lf1-f50.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229648AbhCKARa (ORCPT ); Wed, 10 Mar 2021 19:17:30 -0500 Received: by mail-lf1-f50.google.com with SMTP id n16so36746377lfb.4 for ; Wed, 10 Mar 2021 16:17:30 -0800 (PST) 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=Bbc+ydK9EZPctjxOlQsxWSvwLOSFn01mGILhtLZh9mI=; b=VVkv1mif9wBGKXZzbgnBrEud5/sk1YMoR5woXMIIhgBVJjfwDgMDIEE+amW3zE1fXd kJQUNxb7X4Dj9kx0/su8IP1rwXW6dhwn7JnqpXxNsY1ApcwKFFu68AqX1yhP47NTMyB+ GHofOcZPD2uSE23+ILsVPJq8gDhFw+0pxcIXwfZAPXqpgUijuWuUf5+Oalp/00m1u/zM mfEcFYPT/xVQQswEZWN+Gi+9mfT02tKoK7BH2/7APQ7fXFIEl3lRsBOs0MbjkIhPaFIC 0WPzlbVTSDYVUMGGGKxq4VrOA76APBCeRPJ3UyfXjxFZAFbm9PS+S3V5btAbjfan73KE xDDg== X-Gm-Message-State: AOAM532aLi807lSTeu1HHVJOkqJshCF6bPXySPBYsquc8bJ+TuBTLDpY 8c5LZEpkCfg3lWNsz0piyrA= X-Google-Smtp-Source: ABdhPJzB1gI1w74Ik1n1aZ4AJjXkWt7Z6Annezky4amWi1L2AUpS3kYdPAAAZlEef7zPaZT3orPIKg== X-Received: by 2002:a19:ee13:: with SMTP id g19mr623166lfb.657.1615421849534; Wed, 10 Mar 2021 16:17:29 -0800 (PST) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id y186sm269332lfc.304.2021.03.10.16.17.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 16:17:29 -0800 (PST) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Kishon Vijay Abraham I , Tom Joseph , Murali Karicheri , Rob Herring , Russell Currey , "Oliver O'Halloran" , Geert Uytterhoeven , Arnd Bergmann , Krzysztof Kozlowski , Kunihiko Hayashi , Sean V Kelley , Qiuxu Zhuo , Jay Fang , linux-pci@vger.kernel.org Subject: [PATCH 4/8] PCI/ATS: Update function name in the kernel-doc Date: Thu, 11 Mar 2021 00:17:20 +0000 Message-Id: <20210311001724.423356-4-kw@linux.com> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210311001724.423356-1-kw@linux.com> References: <20210311001724.423356-1-kw@linux.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Update function name in the kernel-doc to match function prototype for function pci_max_pasids(), and resolve build time warning related to kernel-doc: drivers/pci/ats.c:490: warning: expecting prototype for pci_max_pasid(). Prototype was for pci_max_pasids() instead No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/ats.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/pci/ats.c b/drivers/pci/ats.c index 0d3719407b8b..6d7d64939f82 100644 --- a/drivers/pci/ats.c +++ b/drivers/pci/ats.c @@ -480,7 +480,7 @@ EXPORT_SYMBOL_GPL(pci_pasid_features); #define PASID_NUMBER_SHIFT 8 #define PASID_NUMBER_MASK (0x1f << PASID_NUMBER_SHIFT) /** - * pci_max_pasid - Get maximum number of PASIDs supported by device + * pci_max_pasids - Get maximum number of PASIDs supported by device * @pdev: PCI device structure * * Returns negative value when PASID capability is not present. From patchwork Thu Mar 11 00:17:21 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: 12129793 X-Patchwork-Delegate: bhelgaas@google.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 2E7ABC433E0 for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id DAEA964FCA for ; Thu, 11 Mar 2021 00:18:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229601AbhCKARm (ORCPT ); Wed, 10 Mar 2021 19:17:42 -0500 Received: from mail-lf1-f52.google.com ([209.85.167.52]:40102 "EHLO mail-lf1-f52.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229641AbhCKARb (ORCPT ); Wed, 10 Mar 2021 19:17:31 -0500 Received: by mail-lf1-f52.google.com with SMTP id x4so30010271lfu.7 for ; Wed, 10 Mar 2021 16:17:31 -0800 (PST) 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=L8bwBr9Pfd7b8SAPZWvFQUsDlwPAHuolYwAQT4bOibQ=; b=Dm7dwV65ioG4NCX8/YqCA0ZdxYoCOC9R0kg96L1z4iYf5ya3GahdLb96EUQMpJs9zd +GMErUh2Nk5vLbpKhGr4Sa//8zI0g8iGA6gZ0iyApFcyb1O9t2QfDIPDCbd2lYpk083C VQAi9dyaWQaQ4/lp44S490zo/RZiODNwiz9tZZH+/pd87NC5R3+IKKYBT2EpcqTcOiTG dEvRvY3f6jR7u+SD4ZUt4P5fjEi0hvR4OtKQfPZLCP4KBhBs6PVU3bjPL657/1a3tq7X Iw+wXwTcV4QlYmYJCYuoV5m2ehSILXW/KujSFEmkmlo+TYvTmYTIa1mDxOoIHAArGWKJ Pfvg== X-Gm-Message-State: AOAM533USzsRQ1v0zj5CgK38hYmIHAAV4RrU4C+N1vxjDrMqfT8WL0si CIJ1GZ4h7noXfN3vhoNR+kM= X-Google-Smtp-Source: ABdhPJxkEx/i2KtS/JHTkPTMYxauMy0doB82djFET6ilyJnmCv1PoC6pODTjuBwIccgvuDm9EAQsBw== X-Received: by 2002:a19:c3d5:: with SMTP id t204mr627041lff.216.1615421850708; Wed, 10 Mar 2021 16:17:30 -0800 (PST) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id y186sm269332lfc.304.2021.03.10.16.17.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 16:17:30 -0800 (PST) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Kishon Vijay Abraham I , Tom Joseph , Murali Karicheri , Rob Herring , Russell Currey , "Oliver O'Halloran" , Geert Uytterhoeven , Arnd Bergmann , Krzysztof Kozlowski , Kunihiko Hayashi , Sean V Kelley , Qiuxu Zhuo , Jay Fang , linux-pci@vger.kernel.org Subject: [PATCH 5/8] PCI: Update function name in the kernel-doc Date: Thu, 11 Mar 2021 00:17:21 +0000 Message-Id: <20210311001724.423356-5-kw@linux.com> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210311001724.423356-1-kw@linux.com> References: <20210311001724.423356-1-kw@linux.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Update function name in the kernel-doc to match function prototype for function acpi_pci_check_ejectable(), and resolve build time warning related to kernel-doc: drivers/pci/hotplug/acpi_pcihp.c:167: warning: expecting prototype for acpi_pcihp_check_ejectable(). Prototype was for acpi_pci_check_ejectable() instead No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/hotplug/acpi_pcihp.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/pci/hotplug/acpi_pcihp.c b/drivers/pci/hotplug/acpi_pcihp.c index 2750a64cecd3..4fedebf2f8c1 100644 --- a/drivers/pci/hotplug/acpi_pcihp.c +++ b/drivers/pci/hotplug/acpi_pcihp.c @@ -157,7 +157,7 @@ static int pcihp_is_ejectable(acpi_handle handle) } /** - * acpi_pcihp_check_ejectable - check if handle is ejectable ACPI PCI slot + * acpi_pci_check_ejectable - check if handle is ejectable ACPI PCI slot * @pbus: the PCI bus of the PCI slot corresponding to 'handle' * @handle: ACPI handle to check * From patchwork Thu Mar 11 00:17:22 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: 12129805 X-Patchwork-Delegate: bhelgaas@google.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 F279EC43331 for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B65DA64FD3 for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229603AbhCKARm (ORCPT ); Wed, 10 Mar 2021 19:17:42 -0500 Received: from mail-lj1-f179.google.com ([209.85.208.179]:37107 "EHLO mail-lj1-f179.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229655AbhCKARd (ORCPT ); Wed, 10 Mar 2021 19:17:33 -0500 Received: by mail-lj1-f179.google.com with SMTP id q14so98058ljp.4 for ; Wed, 10 Mar 2021 16:17:32 -0800 (PST) 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=vnLOt3JRC/SV3REFag8843NSfHwLc7oxyVUfV6PrzHM=; b=WeMiqQDfKR1yUr0ES5PlWpN+rOFCCh05ChzAgryPNPEAtR7gFH15BM0lhEWvGGp6si jgsRRsQf0DVF66ZEELhB9dOcSkOjo5JnHXrWgiSDMh5zuddNFobPVcBN3xBEUGEGyV4M s8R3ooTR4ksoRAW5h1vaGVarqaBaX1DYt+Xz8yvwC7l5vWdmdRuV2Z6XDhbihEma9cpS XgZLdCYhRn7t8t/vsmZ6jeGLxrdon0NGV3ivjyVSwmjL9pQOjKZRHaNpj/Va/TSHg2b/ 67D1DAHXtSEYvE2NVOum6YeKrFb/I+HxtlnZy5Ql+3uVBzrYIcrFcJ7qC1hfm8OP/EOV sRbA== X-Gm-Message-State: AOAM531ZPT7nLYtVnFg1qZuFsJkKOSaRhg+5ctPsfSEvqi1yykMVhx5H 00qtX2vXqE8wvg8J8ecV1so= X-Google-Smtp-Source: ABdhPJykC9/y545ja/Zr//caW9YiUhWkHvAYeZMoPTHa4mtNr9dZecRkoscyaLby/GrivZlNfYVAgQ== X-Received: by 2002:a05:651c:387:: with SMTP id e7mr3311183ljp.425.1615421851890; Wed, 10 Mar 2021 16:17:31 -0800 (PST) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id y186sm269332lfc.304.2021.03.10.16.17.30 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 16:17:31 -0800 (PST) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Kishon Vijay Abraham I , Tom Joseph , Murali Karicheri , Rob Herring , Russell Currey , "Oliver O'Halloran" , Geert Uytterhoeven , Arnd Bergmann , Krzysztof Kozlowski , Kunihiko Hayashi , Sean V Kelley , Qiuxu Zhuo , Jay Fang , linux-pci@vger.kernel.org Subject: [PATCH 6/8] PCI: j721e: Fix a non-compliant kernel-doc Date: Thu, 11 Mar 2021 00:17:22 +0000 Message-Id: <20210311001724.423356-6-kw@linux.com> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210311001724.423356-1-kw@linux.com> References: <20210311001724.423356-1-kw@linux.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Correct a non-compliant kernel-doc at the top of the pci-j721e.c file, and resolve build time warning related to kernel-doc: drivers/pci/controller/cadence/pci-j721e.c:25: warning: expecting prototype for pci(). Prototype was for ENABLE_REG_SYS_2() instead No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/controller/cadence/pci-j721e.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drivers/pci/controller/cadence/pci-j721e.c b/drivers/pci/controller/cadence/pci-j721e.c index 849f1e416ea5..f1eef67e9526 100644 --- a/drivers/pci/controller/cadence/pci-j721e.c +++ b/drivers/pci/controller/cadence/pci-j721e.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -/** +/* * pci-j721e - PCIe controller driver for TI's J721E SoCs * * Copyright (C) 2020 Texas Instruments Incorporated - http://www.ti.com From patchwork Thu Mar 11 00:17:23 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: 12129801 X-Patchwork-Delegate: bhelgaas@google.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 CA1EBC4332D for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9BF3064FCC for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229612AbhCKARm (ORCPT ); Wed, 10 Mar 2021 19:17:42 -0500 Received: from mail-lj1-f182.google.com ([209.85.208.182]:40248 "EHLO mail-lj1-f182.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229656AbhCKARe (ORCPT ); Wed, 10 Mar 2021 19:17:34 -0500 Received: by mail-lj1-f182.google.com with SMTP id e2so82901ljo.7 for ; Wed, 10 Mar 2021 16:17:34 -0800 (PST) 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=QLZENbJQtmVGcctaPup6m6pSUGnrpLqtTIGTnn/p2nM=; b=MCAT3Yflh/c2xZbqu/ZtNtm9QeEdIIV/QTR2M6fTQE52Qr75VceCQdF5+ZlB4iII7q jABymP6GBiLKE7oPWeLl8/arCrKbvYbnoquodUpme5o/7fAhRXNzVHKHub1aR1lEch3n 5JkRl882dXVz2UqdGtguaKug12xvsRg+8ubKbJ+ixMFOt3ojXKAX3rFAoYhvDI7gyfR3 zRmc3QZbeuhu5otwWLsTyFzep0wXzMR2cNfcoHsRTrlkizRmkHr279z6jQUDQwOyQkAL We7dWxz8dJRgCvpeg+uK+j6BXiKmNTKswVpewyRiibaswevvZqYy5M5zH6hrwyFMU5Ib 5dYg== X-Gm-Message-State: AOAM531isX4UURACACjozU4LT4z/BPQK6v1jUjILxDlzoHAfAN2Y9o+r B4jpzFhLlRbKpRx4kGv1SDA= X-Google-Smtp-Source: ABdhPJwhyjM+FAGn4pZP2S/Gi6bQwMNNT1qwUW9HP4jRBhdLjLD6a8/P3p3Fc5iwib7x8dyz/rcUdA== X-Received: by 2002:a2e:9012:: with SMTP id h18mr3338382ljg.139.1615421853436; Wed, 10 Mar 2021 16:17:33 -0800 (PST) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id y186sm269332lfc.304.2021.03.10.16.17.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 16:17:32 -0800 (PST) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Kishon Vijay Abraham I , Tom Joseph , Murali Karicheri , Rob Herring , Russell Currey , "Oliver O'Halloran" , Geert Uytterhoeven , Arnd Bergmann , Krzysztof Kozlowski , Kunihiko Hayashi , Sean V Kelley , Qiuxu Zhuo , Jay Fang , linux-pci@vger.kernel.org Subject: [PATCH 7/8] PCI: dwc: Remove surplus and document missing function parameters Date: Thu, 11 Mar 2021 00:17:23 +0000 Message-Id: <20210311001724.423356-7-kw@linux.com> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210311001724.423356-1-kw@linux.com> References: <20210311001724.423356-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 parameters "ks_pcie", "bus" and "pci" of the ks_pcie_set_dbi_mode(), ks_pcie_clear_dbi_mode(), ks_pcie_v3_65_add_bus() and ks_pcie_link_up() functions and resolve build time warnings related to kernel-doc: drivers/pci/controller/dwc/pci-keystone.c:356: warning: Function parameter or member 'ks_pcie' not described in 'ks_pcie_set_dbi_mode' drivers/pci/controller/dwc/pci-keystone.c:375: warning: Function parameter or member 'ks_pcie' not described in 'ks_pcie_clear_dbi_mode' drivers/pci/controller/dwc/pci-keystone.c:456: warning: Function parameter or member 'bus' not described in 'ks_pcie_v3_65_add_bus' drivers/pci/controller/dwc/pci-keystone.c:493: warning: Function parameter or member 'pci' not described in 'ks_pcie_link_up' drivers/pci/controller/dwc/pci-keystone.c:615: warning: Excess function parameter 'irq' description in 'ks_pcie_legacy_irq_handler' No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/controller/dwc/pci-keystone.c | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/drivers/pci/controller/dwc/pci-keystone.c b/drivers/pci/controller/dwc/pci-keystone.c index 53aa35cb3a49..6745e69b7020 100644 --- a/drivers/pci/controller/dwc/pci-keystone.c +++ b/drivers/pci/controller/dwc/pci-keystone.c @@ -346,8 +346,9 @@ static const struct irq_domain_ops ks_pcie_legacy_irq_domain_ops = { }; /** - * ks_pcie_set_dbi_mode() - Set DBI mode to access overlaid BAR mask - * registers + * ks_pcie_set_dbi_mode() - Set DBI mode to access overlaid BAR mask registers + * @ks_pcie: A pointer to the keystone_pcie structure which holds the KeyStone + * PCIe host controller driver information. * * Since modification of dbi_cs2 involves different clock domain, read the * status back to ensure the transition is complete. @@ -367,6 +368,8 @@ static void ks_pcie_set_dbi_mode(struct keystone_pcie *ks_pcie) /** * ks_pcie_clear_dbi_mode() - Disable DBI mode + * @ks_pcie: A pointer to the keystone_pcie structure which holds the KeyStone + * PCIe host controller driver information. * * Since modification of dbi_cs2 involves different clock domain, read the * status back to ensure the transition is complete. @@ -449,6 +452,7 @@ static struct pci_ops ks_child_pcie_ops = { /** * ks_pcie_v3_65_add_bus() - keystone add_bus post initialization + * @bus: A pointer to the PCI bus structure. * * This sets BAR0 to enable inbound access for MSI_IRQ register */ @@ -488,6 +492,8 @@ static struct pci_ops ks_pcie_ops = { /** * ks_pcie_link_up() - Check if link up + * @pci: A pointer to the dw_pcie structure which holds the DesignWare PCIe host + * controller driver information. */ static int ks_pcie_link_up(struct dw_pcie *pci) { @@ -605,7 +611,6 @@ static void ks_pcie_msi_irq_handler(struct irq_desc *desc) /** * ks_pcie_legacy_irq_handler() - Handle legacy interrupt - * @irq: IRQ line for legacy interrupts * @desc: Pointer to irq descriptor * * Traverse through pending legacy interrupts and invoke handler for each. Also From patchwork Thu Mar 11 00:17:24 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: 12129803 X-Patchwork-Delegate: bhelgaas@google.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 9880FC4332B for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 79B5E64FD3 for ; Thu, 11 Mar 2021 00:18:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229632AbhCKARn (ORCPT ); Wed, 10 Mar 2021 19:17:43 -0500 Received: from mail-lf1-f52.google.com ([209.85.167.52]:42519 "EHLO mail-lf1-f52.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229668AbhCKARf (ORCPT ); Wed, 10 Mar 2021 19:17:35 -0500 Received: by mail-lf1-f52.google.com with SMTP id v2so23688793lft.9 for ; Wed, 10 Mar 2021 16:17:35 -0800 (PST) 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=NOaZ9L90hSCMz6oZGX1bbSsAE8thLW/EO9o9W5+QirQ=; b=b4uDjrutkHmie/hTvLvL88rVFvKmpVyoX3n3VvaApzvHLjahvXds5WIUZ8RxESZVrt xM7siBrz1CY9Zs3gh3KPM96LMEuDR8S6hqYlF31fkSAMXjqDjf6CwZOPSg4iF6uo52RV MpnCV6oCSc96mY3anOVVYPX1/tz0WDNwYTYa1GEAk+9FPUyA1WGA4M8mv+bYAp8wOgML iN2q5bf50wVMJHoDilCQB5r4Xq/mN7TfbvuVVKpsnrkKy75bCB0TeGl0jLbXQ0D8GG1A 01pVU7MfR01Aj9ISRQ63E/69HdWFiBwKqoPJ/VTr4ZYqgIPd1mt5NLOZhwztnsOHKT5r H1rg== X-Gm-Message-State: AOAM531scZ/YT1CrWrUFT3+bWl1cvmH1QotiDEYW/6e58hByuaJJpuf+ FtwE+zyJOzONVgBe+mFwunQ= X-Google-Smtp-Source: ABdhPJyIHIUKWITbj+6M9WCWXYHfQKp2laz5VSCEBSOg4vL/S+jWouIS61nsZuzW7UzCYhbjI0Wk1Q== X-Received: by 2002:a19:f510:: with SMTP id j16mr635398lfb.301.1615421854491; Wed, 10 Mar 2021 16:17:34 -0800 (PST) Received: from workstation.lan ([95.155.85.46]) by smtp.gmail.com with ESMTPSA id y186sm269332lfc.304.2021.03.10.16.17.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 10 Mar 2021 16:17:34 -0800 (PST) From: =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= To: Bjorn Helgaas Cc: Lorenzo Pieralisi , Kishon Vijay Abraham I , Tom Joseph , Murali Karicheri , Rob Herring , Russell Currey , "Oliver O'Halloran" , Geert Uytterhoeven , Arnd Bergmann , Krzysztof Kozlowski , Kunihiko Hayashi , Sean V Kelley , Qiuxu Zhuo , Jay Fang , linux-pci@vger.kernel.org Subject: [PATCH 8/8] PCI: of: Fix kernel-doc formatting and add missing documentation Date: Thu, 11 Mar 2021 00:17:24 +0000 Message-Id: <20210311001724.423356-8-kw@linux.com> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210311001724.423356-1-kw@linux.com> References: <20210311001724.423356-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 "node" parameter of the of_get_pci_domain_nr() and of_pci_get_max_link_speed() functions, and resolve build time warnings related to kernel-doc: drivers/pci/of.c:202: warning: expecting prototype for This function will try to obtain the host bridge domain number by(). Prototype was for of_get_pci_domain_nr() instead drivers/pci/of.c:597: warning: expecting prototype for This function will try to find the limitation of link speed by finding(). Prototype was for of_pci_get_max_link_speed() instead No change to functionality intended. Signed-off-by: Krzysztof Wilczyński --- drivers/pci/of.c | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/drivers/pci/of.c b/drivers/pci/of.c index 5ea472ae22ac..da5b414d585a 100644 --- a/drivers/pci/of.c +++ b/drivers/pci/of.c @@ -190,10 +190,18 @@ int of_pci_parse_bus_range(struct device_node *node, struct resource *res) EXPORT_SYMBOL_GPL(of_pci_parse_bus_range); /** - * This function will try to obtain the host bridge domain number by - * finding a property called "linux,pci-domain" of the given device node. + * of_get_pci_domain_nr - Find the host bridge domain number + * of the given device node. + * @node: Device tree node with the domain information. * - * @node: device tree node with the domain information + * This function will try to obtain the host bridge domain number by finding + * a property called "linux,pci-domain" of the given device node. + * + * Return: + * * > 0 - On success, an associated domain number. + * * -EINVAL - The property "linux,pci-domain" does not exist. + * * -ENODATA - The linux,pci-domain" property does not have value. + * * -EOVERFLOW - Invalid "linux,pci-domain" property value. * * Returns the associated domain number from DT in the range [0-0xffff], or * a negative value if the required property is not found. @@ -585,10 +593,16 @@ int devm_of_pci_bridge_init(struct device *dev, struct pci_host_bridge *bridge) #endif /* CONFIG_PCI */ /** + * of_pci_get_max_link_speed - Find the maximum link speed of the given device node. + * @node: Device tree node with the maximum link speed information. + * * This function will try to find the limitation of link speed by finding * a property called "max-link-speed" of the given device node. * - * @node: device tree node with the max link speed information + * Return: + * * > 0 - On success, a maximum link speed. + * * -EINVAL - Invalid "max-link-speed" property value, or failure to access + * the property of the device tree node. * * Returns the associated max link speed from DT, or a negative value if the * required property is not found or is invalid.