linux-fpga.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Colberg, Peter" <peter.colberg@intel.com>
To: "yilun.xu@linux.intel.com" <yilun.xu@linux.intel.com>
Cc: "linux-fpga@vger.kernel.org" <linux-fpga@vger.kernel.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	"oe-kbuild-all@lists.linux.dev" <oe-kbuild-all@lists.linux.dev>,
	"matthew.gerlach@linux.intel.com"
	<matthew.gerlach@linux.intel.com>,
	"basheer.ahmed.muddebihal@linux.intel.com"
	<basheer.ahmed.muddebihal@linux.intel.com>
Subject: Re: [linux-next:master 2636/3192] drivers/fpga/dfl.c:154: warning: Function parameter or struct member 'fdata' not described in 'dfl_fpga_port_ops_get'
Date: Wed, 11 Dec 2024 23:35:47 +0000	[thread overview]
Message-ID: <0003df208122ac05e5e364edb729a9ceb9cf96b1.camel@intel.com> (raw)
In-Reply-To: <202412120500.aF6jnlmu-lkp@intel.com>

Hi Yilun,

On Thu, 2024-12-12 at 05:55 +0800, kernel test robot wrote:
> Hi Peter,
> 
> FYI, the error/warning was bisected to this commit, please ignore it if it's irrelevant.
> 
> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git master
> head:   91e71d606356e50f238d7a87aacdee4abc427f07
> commit: a25cd37037c85376db766444f060425d2f55c511 [2636/3192] fpga: dfl: refactor internal DFL APIs to take/return feature device data
> config: arc-randconfig-002-20241211 (https://download.01.org/0day-ci/archive/20241212/202412120500.aF6jnlmu-lkp@intel.com/config)
> compiler: arc-elf-gcc (GCC) 13.2.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20241212/202412120500.aF6jnlmu-lkp@intel.com/reproduce)
> 
> If you fix the issue in a separate patch/commit (i.e. not just a new version of
> the same patch/commit), kindly add following tags
> > Reported-by: kernel test robot <lkp@intel.com>
> > Closes: https://lore.kernel.org/oe-kbuild-all/202412120500.aF6jnlmu-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
> > > drivers/fpga/dfl.c:154: warning: Function parameter or struct member 'fdata' not described in 'dfl_fpga_port_ops_get'
>    drivers/fpga/dfl.c:154: warning: Excess function parameter 'pdev' description in 'dfl_fpga_port_ops_get'
> > > drivers/fpga/dfl.c:220: warning: Function parameter or struct member 'fdata' not described in 'dfl_fpga_check_port_id'
>    drivers/fpga/dfl.c:220: warning: Excess function parameter 'pdev' description in 'dfl_fpga_check_port_id'

These warnings may be resolved by amending commit a25cd37037c8 ("fpga:
dfl: refactor internal DFL APIs to take/return feature device data").

--- a/drivers/fpga/dfl.c
+++ b/drivers/fpga/dfl.c
@@ -145,7 +145,7 @@ static LIST_HEAD(dfl_port_ops_list);
 
 /**
  * dfl_fpga_port_ops_get - get matched port ops from the global list
- * @pdata: platform data to match with associated port ops.
+ * @fdata: feature dev data to match with associated port ops.
  * Return: matched port ops on success, NULL otherwise.
  *
  * Please note that must dfl_fpga_port_ops_put after use the port_ops.
@@ -211,7 +211,7 @@ EXPORT_SYMBOL_GPL(dfl_fpga_port_ops_del);
 
 /**
  * dfl_fpga_check_port_id - check the port id
- * @pdata: port platform data.
+ * @fdata: port feature dev data.
  * @pport_id: port id to compare.
  *
  * Return: 1 if port device matches with given port id, otherwise 0.

Thanks,
Peter

> 
> 
> vim +154 drivers/fpga/dfl.c
> 
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  145  
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  146  /**
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  147   * dfl_fpga_port_ops_get - get matched port ops from the global list
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  148   * @pdev: platform device to match with associated port ops.
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  149   * Return: matched port ops on success, NULL otherwise.
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  150   *
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  151   * Please note that must dfl_fpga_port_ops_put after use the port_ops.
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  152   */
> a25cd37037c8537 Peter Colberg 2024-11-19  153  struct dfl_fpga_port_ops *dfl_fpga_port_ops_get(struct dfl_feature_dev_data *fdata)
> 6e8fd6e493bfca8 Wu Hao        2018-06-30 @154  {
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  155  	struct dfl_fpga_port_ops *ops = NULL;
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  156  
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  157  	mutex_lock(&dfl_port_ops_mutex);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  158  	if (list_empty(&dfl_port_ops_list))
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  159  		goto done;
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  160  
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  161  	list_for_each_entry(ops, &dfl_port_ops_list, node) {
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  162  		/* match port_ops using the name of platform device */
> a25cd37037c8537 Peter Colberg 2024-11-19  163  		if (!strcmp(fdata->dev->name, ops->name)) {
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  164  			if (!try_module_get(ops->owner))
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  165  				ops = NULL;
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  166  			goto done;
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  167  		}
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  168  	}
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  169  
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  170  	ops = NULL;
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  171  done:
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  172  	mutex_unlock(&dfl_port_ops_mutex);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  173  	return ops;
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  174  }
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  175  EXPORT_SYMBOL_GPL(dfl_fpga_port_ops_get);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  176  
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  177  /**
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  178   * dfl_fpga_port_ops_put - put port ops
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  179   * @ops: port ops.
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  180   */
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  181  void dfl_fpga_port_ops_put(struct dfl_fpga_port_ops *ops)
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  182  {
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  183  	if (ops && ops->owner)
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  184  		module_put(ops->owner);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  185  }
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  186  EXPORT_SYMBOL_GPL(dfl_fpga_port_ops_put);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  187  
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  188  /**
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  189   * dfl_fpga_port_ops_add - add port_ops to global list
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  190   * @ops: port ops to add.
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  191   */
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  192  void dfl_fpga_port_ops_add(struct dfl_fpga_port_ops *ops)
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  193  {
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  194  	mutex_lock(&dfl_port_ops_mutex);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  195  	list_add_tail(&ops->node, &dfl_port_ops_list);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  196  	mutex_unlock(&dfl_port_ops_mutex);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  197  }
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  198  EXPORT_SYMBOL_GPL(dfl_fpga_port_ops_add);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  199  
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  200  /**
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  201   * dfl_fpga_port_ops_del - remove port_ops from global list
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  202   * @ops: port ops to del.
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  203   */
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  204  void dfl_fpga_port_ops_del(struct dfl_fpga_port_ops *ops)
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  205  {
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  206  	mutex_lock(&dfl_port_ops_mutex);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  207  	list_del(&ops->node);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  208  	mutex_unlock(&dfl_port_ops_mutex);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  209  }
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  210  EXPORT_SYMBOL_GPL(dfl_fpga_port_ops_del);
> 6e8fd6e493bfca8 Wu Hao        2018-06-30  211  
> d06b004b99c9608 Wu Hao        2018-06-30  212  /**
> d06b004b99c9608 Wu Hao        2018-06-30  213   * dfl_fpga_check_port_id - check the port id
> d06b004b99c9608 Wu Hao        2018-06-30  214   * @pdev: port platform device.
> d06b004b99c9608 Wu Hao        2018-06-30  215   * @pport_id: port id to compare.
> d06b004b99c9608 Wu Hao        2018-06-30  216   *
> d06b004b99c9608 Wu Hao        2018-06-30  217   * Return: 1 if port device matches with given port id, otherwise 0.
> d06b004b99c9608 Wu Hao        2018-06-30  218   */
> a25cd37037c8537 Peter Colberg 2024-11-19  219  int dfl_fpga_check_port_id(struct dfl_feature_dev_data *fdata, void *pport_id)
> d06b004b99c9608 Wu Hao        2018-06-30 @220  {
> 69bb18ddfc4331b Wu Hao        2019-08-04  221  	struct dfl_fpga_port_ops *port_ops;
> 69bb18ddfc4331b Wu Hao        2019-08-04  222  
> a25cd37037c8537 Peter Colberg 2024-11-19  223  	if (fdata->id != FEATURE_DEV_ID_UNUSED)
> a25cd37037c8537 Peter Colberg 2024-11-19  224  		return fdata->id == *(int *)pport_id;
> d06b004b99c9608 Wu Hao        2018-06-30  225  
> a25cd37037c8537 Peter Colberg 2024-11-19  226  	port_ops = dfl_fpga_port_ops_get(fdata);
> d06b004b99c9608 Wu Hao        2018-06-30  227  	if (!port_ops || !port_ops->get_id)
> d06b004b99c9608 Wu Hao        2018-06-30  228  		return 0;
> d06b004b99c9608 Wu Hao        2018-06-30  229  
> a25cd37037c8537 Peter Colberg 2024-11-19  230  	fdata->id = port_ops->get_id(fdata);
> d06b004b99c9608 Wu Hao        2018-06-30  231  	dfl_fpga_port_ops_put(port_ops);
> d06b004b99c9608 Wu Hao        2018-06-30  232  
> a25cd37037c8537 Peter Colberg 2024-11-19  233  	return fdata->id == *(int *)pport_id;
> d06b004b99c9608 Wu Hao        2018-06-30  234  }
> d06b004b99c9608 Wu Hao        2018-06-30  235  EXPORT_SYMBOL_GPL(dfl_fpga_check_port_id);
> d06b004b99c9608 Wu Hao        2018-06-30  236  
> 
> :::::: The code at line 154 was first introduced by commit
> :::::: 6e8fd6e493bfca83021cc6a8fd86d7f69bd14fc6 fpga: dfl: add dfl_fpga_port_ops support.
> 
> :::::: TO: Wu Hao <hao.wu@intel.com>
> :::::: CC: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> 


       reply	other threads:[~2024-12-11 23:35 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <202412120500.aF6jnlmu-lkp@intel.com>
2024-12-11 23:35 ` Colberg, Peter [this message]
2023-03-05  3:06   ` [linux-next:master 2636/3192] drivers/fpga/dfl.c:154: warning: Function parameter or struct member 'fdata' not described in 'dfl_fpga_port_ops_get' Xu Yilun

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=0003df208122ac05e5e364edb729a9ceb9cf96b1.camel@intel.com \
    --to=peter.colberg@intel.com \
    --cc=basheer.ahmed.muddebihal@linux.intel.com \
    --cc=linux-fpga@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=matthew.gerlach@linux.intel.com \
    --cc=oe-kbuild-all@lists.linux.dev \
    --cc=yilun.xu@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).