| Message ID | 20230113063720.10668-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | fpga: dfl: kernel-doc corrections | expand |
On 2023-01-12 at 22:37:20 -0800, Randy Dunlap wrote: > Fix W=1 kernel-doc warnings in drivers/fpga/: > > drivers/fpga/dfl.c:54: warning: cannot understand function prototype: 'struct dfl_dev_info ' > drivers/fpga/dfl.c:74: warning: cannot understand function prototype: 'struct dfl_chardev_info ' > drivers/fpga/dfl-fme-pr.c:175: warning: Function parameter or member 'feature' not described in 'dfl_fme_create_mgr' > drivers/fpga/dfl-fme-pr.c:280: warning: expecting prototype for dfl_fme_destroy_bridge(). Prototype was for dfl_fme_destroy_bridges() instead > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Xu Yilun <yilun.xu@intel.com> Applied to for-next > Cc: Wu Hao <hao.wu@intel.com> > Cc: Tom Rix <trix@redhat.com> > Cc: Moritz Fischer <mdf@kernel.org> > Cc: Xu Yilun <yilun.xu@intel.com> > Cc: linux-fpga@vger.kernel.org > --- > drivers/fpga/dfl-fme-pr.c | 4 ++-- > drivers/fpga/dfl.c | 5 +++-- > 2 files changed, 5 insertions(+), 4 deletions(-) > > diff -- a/drivers/fpga/dfl.c b/drivers/fpga/dfl.c > --- a/drivers/fpga/dfl.c > +++ b/drivers/fpga/dfl.c > @@ -45,7 +45,7 @@ static const char *dfl_pdata_key_strings > }; > > /** > - * dfl_dev_info - dfl feature device information. > + * struct dfl_dev_info - dfl feature device information. > * @name: name string of the feature platform device. > * @dfh_id: id value in Device Feature Header (DFH) register by DFL spec. > * @id: idr id of the feature dev. > @@ -67,7 +67,7 @@ static struct dfl_dev_info dfl_devs[] = > }; > > /** > - * dfl_chardev_info - chardev information of dfl feature device > + * struct dfl_chardev_info - chardev information of dfl feature device > * @name: nmae string of the char device. > * @devt: devt of the char device. > */ > @@ -708,6 +708,7 @@ struct build_feature_devs_info { > * struct dfl_feature_info - sub feature info collected during feature dev build > * > * @fid: id of this sub feature. > + * @revision: revision value of this sub feature. > * @mmio_res: mmio resource of this sub feature. > * @ioaddr: mapped base address of mmio resource. > * @node: node in sub_features linked list. > diff -- a/drivers/fpga/dfl-fme-pr.c b/drivers/fpga/dfl-fme-pr.c > --- a/drivers/fpga/dfl-fme-pr.c > +++ b/drivers/fpga/dfl-fme-pr.c > @@ -164,7 +164,7 @@ free_exit: > > /** > * dfl_fme_create_mgr - create fpga mgr platform device as child device > - * > + * @feature: sub feature info > * @pdata: fme platform_device's pdata > * > * Return: mgr platform device if successful, and error code otherwise. > @@ -273,7 +273,7 @@ static void dfl_fme_destroy_bridge(struc > } > > /** > - * dfl_fme_destroy_bridge - destroy all fpga bridge platform device > + * dfl_fme_destroy_bridges - destroy all fpga bridge platform device > * @pdata: fme platform device's pdata > */ > static void dfl_fme_destroy_bridges(struct dfl_feature_platform_data *pdata)
diff -- a/drivers/fpga/dfl.c b/drivers/fpga/dfl.c --- a/drivers/fpga/dfl.c +++ b/drivers/fpga/dfl.c @@ -45,7 +45,7 @@ static const char *dfl_pdata_key_strings }; /** - * dfl_dev_info - dfl feature device information. + * struct dfl_dev_info - dfl feature device information. * @name: name string of the feature platform device. * @dfh_id: id value in Device Feature Header (DFH) register by DFL spec. * @id: idr id of the feature dev. @@ -67,7 +67,7 @@ static struct dfl_dev_info dfl_devs[] = }; /** - * dfl_chardev_info - chardev information of dfl feature device + * struct dfl_chardev_info - chardev information of dfl feature device * @name: nmae string of the char device. * @devt: devt of the char device. */ @@ -708,6 +708,7 @@ struct build_feature_devs_info { * struct dfl_feature_info - sub feature info collected during feature dev build * * @fid: id of this sub feature. + * @revision: revision value of this sub feature. * @mmio_res: mmio resource of this sub feature. * @ioaddr: mapped base address of mmio resource. * @node: node in sub_features linked list. diff -- a/drivers/fpga/dfl-fme-pr.c b/drivers/fpga/dfl-fme-pr.c --- a/drivers/fpga/dfl-fme-pr.c +++ b/drivers/fpga/dfl-fme-pr.c @@ -164,7 +164,7 @@ free_exit: /** * dfl_fme_create_mgr - create fpga mgr platform device as child device - * + * @feature: sub feature info * @pdata: fme platform_device's pdata * * Return: mgr platform device if successful, and error code otherwise. @@ -273,7 +273,7 @@ static void dfl_fme_destroy_bridge(struc } /** - * dfl_fme_destroy_bridge - destroy all fpga bridge platform device + * dfl_fme_destroy_bridges - destroy all fpga bridge platform device * @pdata: fme platform device's pdata */ static void dfl_fme_destroy_bridges(struct dfl_feature_platform_data *pdata)
Fix W=1 kernel-doc warnings in drivers/fpga/: drivers/fpga/dfl.c:54: warning: cannot understand function prototype: 'struct dfl_dev_info ' drivers/fpga/dfl.c:74: warning: cannot understand function prototype: 'struct dfl_chardev_info ' drivers/fpga/dfl-fme-pr.c:175: warning: Function parameter or member 'feature' not described in 'dfl_fme_create_mgr' drivers/fpga/dfl-fme-pr.c:280: warning: expecting prototype for dfl_fme_destroy_bridge(). Prototype was for dfl_fme_destroy_bridges() instead Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Wu Hao <hao.wu@intel.com> Cc: Tom Rix <trix@redhat.com> Cc: Moritz Fischer <mdf@kernel.org> Cc: Xu Yilun <yilun.xu@intel.com> Cc: linux-fpga@vger.kernel.org --- drivers/fpga/dfl-fme-pr.c | 4 ++-- drivers/fpga/dfl.c | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-)