lkml.org 
[lkml]   [2022]   [Mar]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 6/6] fpga: fpga-region: Add missing kernel-doc description
    Date
    Fixed the warnings: Function parameter or member 'xxx' not
    described.

    Signed-off-by: Nava kishore Manne <nava.manne@xilinx.com>
    ---
    drivers/fpga/of-fpga-region.c | 18 ++++++++++--------
    1 file changed, 10 insertions(+), 8 deletions(-)

    diff --git a/drivers/fpga/of-fpga-region.c b/drivers/fpga/of-fpga-region.c
    index 50b83057c048..61ce257c47f3 100644
    --- a/drivers/fpga/of-fpga-region.c
    +++ b/drivers/fpga/of-fpga-region.c
    @@ -28,7 +28,7 @@ MODULE_DEVICE_TABLE(of, fpga_region_of_match);
    *
    * Caller will need to put_device(&region->dev) when done.
    *
    - * Returns FPGA Region struct or NULL
    + * @return: FPGA Region struct or NULL
    */
    static struct fpga_region *of_fpga_region_find(struct device_node *np)
    {
    @@ -43,7 +43,7 @@ static struct fpga_region *of_fpga_region_find(struct device_node *np)
    *
    * Caller should call fpga_mgr_put() when done with manager.
    *
    - * Return: fpga manager struct or IS_ERR() condition containing error code.
    + * @return: fpga manager struct or IS_ERR() condition containing error code.
    */
    static struct fpga_manager *of_fpga_region_get_mgr(struct device_node *np)
    {
    @@ -80,7 +80,7 @@ static struct fpga_manager *of_fpga_region_get_mgr(struct device_node *np)
    * Caller should call fpga_bridges_put(&region->bridge_list) when
    * done with the bridges.
    *
    - * Return 0 for success (even if there are no bridges specified)
    + * @return: 0 for success (even if there are no bridges specified)
    * or -EBUSY if any of the bridges are in use.
    */
    static int of_fpga_region_get_bridges(struct fpga_region *region)
    @@ -139,13 +139,13 @@ static int of_fpga_region_get_bridges(struct fpga_region *region)
    }

    /**
    - * child_regions_with_firmware
    + * child_regions_with_firmware - Used to check the child region info.
    * @overlay: device node of the overlay
    *
    * If the overlay adds child FPGA regions, they are not allowed to have
    * firmware-name property.
    *
    - * Return 0 for OK or -EINVAL if child FPGA region adds firmware-name.
    + * @return: 0 for OK or -EINVAL if child FPGA region adds firmware-name.
    */
    static int child_regions_with_firmware(struct device_node *overlay)
    {
    @@ -184,7 +184,7 @@ static int child_regions_with_firmware(struct device_node *overlay)
    * Given an overlay applied to an FPGA region, parse the FPGA image specific
    * info in the overlay and do some checking.
    *
    - * Returns:
    + * @return:
    * NULL if overlay doesn't direct us to program the FPGA.
    * fpga_image_info struct if there is an image to program.
    * error code for invalid overlay.
    @@ -279,7 +279,7 @@ static struct fpga_image_info *of_fpga_region_parse_ov(
    * If the checks fail, overlay is rejected and does not get added to the
    * live tree.
    *
    - * Returns 0 for success or negative error code for failure.
    + * @return: 0 for success or negative error code for failure.
    */
    static int of_fpga_region_notify_pre_apply(struct fpga_region *region,
    struct of_overlay_notify_data *nd)
    @@ -339,7 +339,7 @@ static void of_fpga_region_notify_post_remove(struct fpga_region *region,
    * This notifier handles programming an FPGA when a "firmware-name" property is
    * added to an fpga-region.
    *
    - * Returns NOTIFY_OK or error if FPGA programming fails.
    + * @return: NOTIFY_OK or error if FPGA programming fails.
    */
    static int of_fpga_region_notify(struct notifier_block *nb,
    unsigned long action, void *arg)
    @@ -446,6 +446,8 @@ static struct platform_driver of_fpga_region_driver = {
    /**
    * of_fpga_region_init - init function for fpga_region class
    * Creates the fpga_region class and registers a reconfig notifier.
    + *
    + * @return: 0 on success, negative error code otherwise.
    */
    static int __init of_fpga_region_init(void)
    {
    --
    2.25.1
    \
     
     \ /
      Last update: 2022-03-08 10:47    [W:5.280 / U:0.008 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site