aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/fpga/fpga-region.c
diff options
context:
space:
mode:
authorAlan Tull <atull@kernel.org>2018-05-16 19:50:01 -0400
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2018-05-25 12:23:56 -0400
commit917a4304fe48c12d346f038c7d64da3f51bce53a (patch)
treeaa0e4c023a485d16911a3b7eee5ca8f2433bb2a7 /drivers/fpga/fpga-region.c
parent060ac5c8fa7bae6a7a63953ecb48f6a42257ae64 (diff)
fpga: region: kernel-doc fixes
Fix formatting and some cleanup for the kernel-doc documentation in fpga-region.c Signed-off-by: Alan Tull <atull@kernel.org> Acked-by: Moritz Fischer <mdf@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers/fpga/fpga-region.c')
-rw-r--r--drivers/fpga/fpga-region.c7
1 files changed, 5 insertions, 2 deletions
diff --git a/drivers/fpga/fpga-region.c b/drivers/fpga/fpga-region.c
index 0878f62dd1fc..112fa3a0f977 100644
--- a/drivers/fpga/fpga-region.c
+++ b/drivers/fpga/fpga-region.c
@@ -81,13 +81,16 @@ static void fpga_region_put(struct fpga_region *region)
81 81
82/** 82/**
83 * fpga_region_program_fpga - program FPGA 83 * fpga_region_program_fpga - program FPGA
84 *
84 * @region: FPGA region 85 * @region: FPGA region
86 *
85 * Program an FPGA using fpga image info (region->info). 87 * Program an FPGA using fpga image info (region->info).
86 * If the region has a get_bridges function, the exclusive reference for the 88 * If the region has a get_bridges function, the exclusive reference for the
87 * bridges will be held if programming succeeds. This is intended to prevent 89 * bridges will be held if programming succeeds. This is intended to prevent
88 * reprogramming the region until the caller considers it safe to do so. 90 * reprogramming the region until the caller considers it safe to do so.
89 * The caller will need to call fpga_bridges_put() before attempting to 91 * The caller will need to call fpga_bridges_put() before attempting to
90 * reprogram the region. 92 * reprogram the region.
93 *
91 * Return 0 for success or negative error code. 94 * Return 0 for success or negative error code.
92 */ 95 */
93int fpga_region_program_fpga(struct fpga_region *region) 96int fpga_region_program_fpga(struct fpga_region *region)
@@ -216,7 +219,7 @@ void fpga_region_free(struct fpga_region *region)
216} 219}
217EXPORT_SYMBOL_GPL(fpga_region_free); 220EXPORT_SYMBOL_GPL(fpga_region_free);
218 221
219/* 222/**
220 * fpga_region_register - register a FPGA region 223 * fpga_region_register - register a FPGA region
221 * @region: FPGA region created by fpga_region_create 224 * @region: FPGA region created by fpga_region_create
222 * Return: 0 or -errno 225 * Return: 0 or -errno
@@ -228,7 +231,7 @@ int fpga_region_register(struct fpga_region *region)
228} 231}
229EXPORT_SYMBOL_GPL(fpga_region_register); 232EXPORT_SYMBOL_GPL(fpga_region_register);
230 233
231/* 234/**
232 * fpga_region_unregister - unregister a FPGA region 235 * fpga_region_unregister - unregister a FPGA region
233 * @region: FPGA region 236 * @region: FPGA region
234 */ 237 */