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. */