Unverified Commit baa57b33 authored by Marco Pagani's avatar Marco Pagani Committed by Xu Yilun
Browse files

fpga: region: fix kernel-doc 



- Fix the following warnings issued by the kernel-doc script:

drivers/fpga/fpga-region.c:46: warning: No description found for return value of 'fpga_region_get'
drivers/fpga/fpga-region.c:97: warning: No description found for return value of 'fpga_region_program_fpga'
drivers/fpga/fpga-region.c:295: warning: No description found for return value of 'fpga_region_init'

- Remove the "and registers a reconfig notifier" part from the description
  of fpga_region_init() since it does not register an of_overlay notifier
  anymore.

- Remove the outdated "if @np is not an FPGA Region" case from the return
  description of fpga_region_get() and replace it with the case when
  try_module_get() fails.

Signed-off-by: default avatarMarco Pagani <marpagan@redhat.com>
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Acked-by: default avatarXu Yilun <yilun.xu@intel.com>
Link: https://lore.kernel.org/r/20230706142755.124879-2-marpagan@redhat.com


Signed-off-by: default avatarXu Yilun <yilun.xu@intel.com>
parent 1b75f5e9

drivers/fpga/fpga-region.c

+8 −6
Original line number Diff line number Diff line
@@ -38,9 +38,10 @@ EXPORT_SYMBOL_GPL(fpga_region_class_find); 
 *

 * Caller should call fpga_region_put() when done with region.

 *

 * Return fpga_region struct if successful.

 * Return -EBUSY if someone already has a reference to the region.

 * Return -ENODEV if @np is not an FPGA Region.

 * Return:

 * * fpga_region struct if successful.

 * * -EBUSY if someone already has a reference to the region.

 * * -ENODEV if can't take parent driver module refcount.

 */

static struct fpga_region *fpga_region_get(struct fpga_region *region)

{
@@ -91,7 +92,7 @@ static void fpga_region_put(struct fpga_region *region) 
 * The caller will need to call fpga_bridges_put() before attempting to

 * reprogram the region.

 *

 * Return 0 for success or negative error code.

 * Return: 0 for success or negative error code.

 */

int fpga_region_program_fpga(struct fpga_region *region)

{
@@ -288,8 +289,9 @@ static void fpga_region_dev_release(struct device *dev) 
}



/**

 * fpga_region_init - init function for fpga_region class

 * Creates the fpga_region class and registers a reconfig notifier.

 * fpga_region_init - creates the fpga_region class.

 *

 * Return: 0 on success or ERR_PTR() on error.

 */

static int __init fpga_region_init(void)

{