diff options
author | Marco Pagani <marpagan@redhat.com> | 2023-07-06 16:27:54 +0200 |
---|---|---|
committer | Xu Yilun <yilun.xu@intel.com> | 2023-07-10 16:10:26 +0800 |
commit | baa57b333e011656dd39b809f994bdb62d772867 (patch) | |
tree | 06ee37443e5c309f27bbbbc08e51ce7f9b965cd7 /drivers | |
parent | 1b75f5e9f49308d1fa9abe1ec0ba7cb5bde173f6 (diff) | |
download | linux-baa57b333e011656dd39b809f994bdb62d772867.tar.gz linux-baa57b333e011656dd39b809f994bdb62d772867.tar.bz2 linux-baa57b333e011656dd39b809f994bdb62d772867.zip |
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: Marco Pagani <marpagan@redhat.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Xu Yilun <yilun.xu@intel.com>
Link: https://lore.kernel.org/r/20230706142755.124879-2-marpagan@redhat.com
Signed-off-by: Xu Yilun <yilun.xu@intel.com>
Diffstat (limited to 'drivers')
-rw-r--r-- | drivers/fpga/fpga-region.c | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/drivers/fpga/fpga-region.c b/drivers/fpga/fpga-region.c index ccf6fdab1360..c9d065a6961b 100644 --- a/drivers/fpga/fpga-region.c +++ b/drivers/fpga/fpga-region.c @@ -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) { |