lkml.org 
[lkml]   [2020]   [Jul]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v2 21/30] misc: mic: scif: scif_nodeqp: Fix a bunch of kerneldoc issues
    Date
    Includes; missing function argument documentation, misnamed argument
    tags, the promotion of obvious kerneldoc header candidates and an
    ordering issue (functions must follow the kerneldoc which describes
    them).

    Fixes the following W=1 kernel build issues:

    drivers/misc/mic/scif/scif_nodeqp.c:452: warning: Function parameter or member 'scifdev' not described in 'scif_node_connect'
    drivers/misc/mic/scif/scif_nodeqp.c:730: warning: Function parameter or member 'unused' not described in 'scif_exit'
    drivers/misc/mic/scif/scif_nodeqp.c:730: warning: Excess function parameter 'msg' description in 'scif_exit'
    drivers/misc/mic/scif/scif_nodeqp.c:748: warning: Function parameter or member 'unused' not described in 'scif_exit_ack'
    drivers/misc/mic/scif/scif_nodeqp.c:748: warning: Excess function parameter 'msg' description in 'scif_exit_ack'
    drivers/misc/mic/scif/scif_nodeqp.c:939: warning: Function parameter or member 'scifdev' not described in 'scif_node_add_nack'
    drivers/misc/mic/scif/scif_nodeqp.c:988: warning: Function parameter or member 'scifdev' not described in 'scif_get_node_info_resp'
    drivers/misc/mic/scif/scif_nodeqp.c:1070: warning: cannot understand function prototype: 'int scif_max_msg_id = SCIF_MAX_MSG; '
    drivers/misc/mic/scif/scif_nodeqp.c:1129: warning: Function parameter or member 'unused' not described in 'scif_loopb_wq_handler'
    drivers/misc/mic/scif/scif_nodeqp.c:1129: warning: Excess function parameter 'work' description in 'scif_loopb_wq_handler'

    Signed-off-by: Lee Jones <lee.jones@linaro.org>
    ---
    drivers/misc/mic/scif/scif_nodeqp.c | 18 +++++++++++-------
    1 file changed, 11 insertions(+), 7 deletions(-)

    diff --git a/drivers/misc/mic/scif/scif_nodeqp.c b/drivers/misc/mic/scif/scif_nodeqp.c
    index ea084626fe116..e0748be373f19 100644
    --- a/drivers/misc/mic/scif/scif_nodeqp.c
    +++ b/drivers/misc/mic/scif/scif_nodeqp.c
    @@ -443,6 +443,7 @@ static void scif_deinit_p2p_info(struct scif_dev *scifdev,

    /**
    * scif_node_connect: Respond to SCIF_NODE_CONNECT interrupt message
    + * @scifdev: SCIF device
    * @dst: Destination node
    *
    * Connect the src and dst node by setting up the p2p connection
    @@ -719,7 +720,7 @@ scif_init(struct scif_dev *scifdev, struct scifmsg *msg)
    /**
    * scif_exit() - Respond to SCIF_EXIT interrupt message
    * @scifdev: Remote SCIF device node
    - * @msg: Interrupt message
    + * @unused: Interrupt message (unused)
    *
    * This function stops the SCIF interface for the node which sent
    * the SCIF_EXIT message and starts waiting for that node to
    @@ -740,7 +741,7 @@ scif_exit(struct scif_dev *scifdev, struct scifmsg *unused)
    /**
    * scif_exitack() - Respond to SCIF_EXIT_ACK interrupt message
    * @scifdev: Remote SCIF device node
    - * @msg: Interrupt message
    + * @unused: Interrupt message (unused)
    *
    */
    static __always_inline void
    @@ -930,6 +931,7 @@ scif_node_add_ack(struct scif_dev *scifdev, struct scifmsg *msg)

    /**
    * scif_node_add_nack: Respond to SCIF_NODE_ADD_NACK interrupt message
    + * @scifdev: Remote SCIF device node
    * @msg: Interrupt message
    *
    * SCIF_NODE_ADD failed, so inform the waiting wq.
    @@ -946,8 +948,9 @@ scif_node_add_nack(struct scif_dev *scifdev, struct scifmsg *msg)
    }
    }

    -/*
    +/**
    * scif_node_remove: Handle SCIF_NODE_REMOVE message
    + * @scifdev: Remote SCIF device node
    * @msg: Interrupt message
    *
    * Handle node removal.
    @@ -962,8 +965,9 @@ scif_node_remove(struct scif_dev *scifdev, struct scifmsg *msg)
    scif_handle_remove_node(node);
    }

    -/*
    +/**
    * scif_node_remove_ack: Handle SCIF_NODE_REMOVE_ACK message
    + * @scifdev: Remote SCIF device node
    * @msg: Interrupt message
    *
    * The peer has acked a SCIF_NODE_REMOVE message.
    @@ -979,6 +983,7 @@ scif_node_remove_ack(struct scif_dev *scifdev, struct scifmsg *msg)

    /**
    * scif_get_node_info: Respond to SCIF_GET_NODE_INFO interrupt message
    + * @scifdev: Remote SCIF device node
    * @msg: Interrupt message
    *
    * Retrieve node info i.e maxid and total from the mgmt node.
    @@ -1058,6 +1063,7 @@ static void (*scif_intr_func[SCIF_MAX_MSG + 1])
    scif_recv_sig_resp, /* SCIF_SIG_NACK */
    };

    +static int scif_max_msg_id = SCIF_MAX_MSG;
    /**
    * scif_nodeqp_msg_handler() - Common handler for node messages
    * @scifdev: Remote device to respond to
    @@ -1067,8 +1073,6 @@ static void (*scif_intr_func[SCIF_MAX_MSG + 1])
    * This routine calls the appropriate routine to handle a Node Qp
    * message receipt
    */
    -static int scif_max_msg_id = SCIF_MAX_MSG;
    -
    static void
    scif_nodeqp_msg_handler(struct scif_dev *scifdev,
    struct scif_qp *qp, struct scifmsg *msg)
    @@ -1117,7 +1121,7 @@ void scif_nodeqp_intrhandler(struct scif_dev *scifdev, struct scif_qp *qp)

    /**
    * scif_loopb_wq_handler - Loopback Workqueue Handler.
    - * @work: loop back work
    + * @unused: loop back work (unused)
    *
    * This work queue routine is invoked by the loopback work queue handler.
    * It grabs the recv lock, dequeues any available messages from the head
    --
    2.25.1
    \
     
     \ /
      Last update: 2020-07-01 10:32    [W:6.994 / U:0.088 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site