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

fpga: bridge: fix kernel-doc 



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

drivers/fpga/fpga-bridge.c:99: warning: No description found for return value of 'of_fpga_bridge_get'
drivers/fpga/fpga-bridge.c:163: warning: No description found for return value of 'fpga_bridges_enable'
drivers/fpga/fpga-bridge.c:187: warning: No description found for return value of 'fpga_bridges_disable'
drivers/fpga/fpga-bridge.c:238: warning: No description found for return value of 'of_fpga_bridge_get_to_list'
drivers/fpga/fpga-bridge.c:268: warning: No description found for return value of 'fpga_bridge_get_to_list'

- Extend the return description of of_fpga_bridge_get() to include 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-3-marpagan@redhat.com


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

drivers/fpga/fpga-bridge.c

+12 −11
Original line number Diff line number Diff line
@@ -87,12 +87,13 @@ static struct fpga_bridge *__fpga_bridge_get(struct device *dev, 
/**

 * of_fpga_bridge_get - get an exclusive reference to an fpga bridge

 *

 * @np: node pointer of an FPGA bridge

 * @info: fpga image specific information

 * @np: node pointer of an FPGA bridge.

 * @info: fpga image specific information.

 *

 * Return fpga_bridge struct if successful.

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

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

 * Return:

 * * fpga_bridge struct pointer if successful.

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

 * * -ENODEV if @np is not an FPGA Bridge or can't take parent driver refcount.

 */

struct fpga_bridge *of_fpga_bridge_get(struct device_node *np,

				       struct fpga_image_info *info)
@@ -157,7 +158,7 @@ EXPORT_SYMBOL_GPL(fpga_bridge_put); 
 *

 * Enable each bridge in the list. If list is empty, do nothing.

 *

 * Return 0 for success or empty bridge list; return error code otherwise.

 * Return: 0 for success or empty bridge list or an error code otherwise.

 */

int fpga_bridges_enable(struct list_head *bridge_list)

{
@@ -181,7 +182,7 @@ EXPORT_SYMBOL_GPL(fpga_bridges_enable); 
 *

 * Disable each bridge in the list. If list is empty, do nothing.

 *

 * Return 0 for success or empty bridge list; return error code otherwise.

 * Return: 0 for success or empty bridge list or an error code otherwise.

 */

int fpga_bridges_disable(struct list_head *bridge_list)

{
@@ -230,7 +231,7 @@ EXPORT_SYMBOL_GPL(fpga_bridges_put); 
 *

 * Get an exclusive reference to the bridge and it to the list.

 *

 * Return 0 for success, error code from of_fpga_bridge_get() otherwise.

 * Return: 0 for success, error code from of_fpga_bridge_get() otherwise.

 */

int of_fpga_bridge_get_to_list(struct device_node *np,

			       struct fpga_image_info *info,
@@ -260,7 +261,7 @@ EXPORT_SYMBOL_GPL(of_fpga_bridge_get_to_list); 
 *

 * Get an exclusive reference to the bridge and it to the list.

 *

 * Return 0 for success, error code from fpga_bridge_get() otherwise.

 * Return: 0 for success, error code from fpga_bridge_get() otherwise.

 */

int fpga_bridge_get_to_list(struct device *dev,

			    struct fpga_image_info *info,