lkml.org 
[lkml]   [2020]   [Jun]   [30]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 01/30] misc: genwqe: card_ddcb: Fix a variety of kerneldoc issues
    Date
    Including; demoting file header from kerneldoc to standard comment/
    header, adding a variety of missing function argument documentation,
    re-ordering of #defines i.e. not placed between kerneldoc headers
    and the functions they are documenting and re-documenting of changed/
    renamed arguments.

    Fixes the following W=1 kernel build warnings:

    drivers/misc/genwqe/card_ddcb.c:83: warning: Function parameter or member 'queue' not described in 'queue_empty'
    drivers/misc/genwqe/card_ddcb.c:262: warning: Excess function parameter 'cd' description in 'RET_DDCB_APPENDED'
    drivers/misc/genwqe/card_ddcb.c:262: warning: Excess function parameter 'queue' description in 'RET_DDCB_APPENDED'
    drivers/misc/genwqe/card_ddcb.c:262: warning: Excess function parameter 'ddcb_no' description in 'RET_DDCB_APPENDED'
    drivers/misc/genwqe/card_ddcb.c:329: warning: Function parameter or member 'req' not described in 'copy_ddcb_results'
    drivers/misc/genwqe/card_ddcb.c:329: warning: Function parameter or member 'ddcb_no' not described in 'copy_ddcb_results'
    drivers/misc/genwqe/card_ddcb.c:364: warning: Function parameter or member 'queue' not described in 'genwqe_check_ddcb_queue'
    drivers/misc/genwqe/card_ddcb.c:565: warning: Function parameter or member 'queue' not described in 'get_next_ddcb'
    drivers/misc/genwqe/card_ddcb.c:565: warning: Function parameter or member 'num' not described in 'get_next_ddcb'
    drivers/misc/genwqe/card_ddcb.c:909: warning: Function parameter or member 'cmd' not described in '__genwqe_execute_raw_ddcb'
    drivers/misc/genwqe/card_ddcb.c:909: warning: Excess function parameter 'req' description in '__genwqe_execute_raw_ddcb'
    drivers/misc/genwqe/card_ddcb.c:972: warning: Function parameter or member 'cd' not described in 'genwqe_next_ddcb_ready'
    drivers/misc/genwqe/card_ddcb.c:1002: warning: Function parameter or member 'cd' not described in 'genwqe_ddcbs_in_flight'
    drivers/misc/genwqe/card_ddcb.c:1181: warning: Function parameter or member 'data' not described in 'genwqe_card_thread'
    drivers/misc/genwqe/card_ddcb.c:1308: warning: Function parameter or member 'cd' not described in 'queue_wake_up_all'
    drivers/misc/genwqe/card_ddcb.c:1333: warning: Function parameter or member 'cd' not described in 'genwqe_finish_queue'

    Cc: Michael Jung <mijung@gmx.net>
    Cc: Michael Ruettger <michael@ibmra.de>
    Cc: Frank Haverkamp <haver@linux.ibm.com>
    Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
    Signed-off-by: Lee Jones <lee.jones@linaro.org>
    ---
    drivers/misc/genwqe/card_ddcb.c | 20 +++++++++++++++-----
    1 file changed, 15 insertions(+), 5 deletions(-)

    diff --git a/drivers/misc/genwqe/card_ddcb.c b/drivers/misc/genwqe/card_ddcb.c
    index 905106579935a..0db4000dedf20 100644
    --- a/drivers/misc/genwqe/card_ddcb.c
    +++ b/drivers/misc/genwqe/card_ddcb.c
    @@ -1,5 +1,5 @@
    // SPDX-License-Identifier: GPL-2.0-only
    -/**
    +/*
    * IBM Accelerator Family 'GenWQE'
    *
    * (C) Copyright IBM Corp. 2013
    @@ -244,10 +244,13 @@ static int ddcb_requ_finished(struct genwqe_dev *cd, struct ddcb_requ *req)
    (cd->card_state != GENWQE_CARD_USED);
    }

    +#define RET_DDCB_APPENDED 1
    +#define RET_DDCB_TAPPED 2
    /**
    * enqueue_ddcb() - Enqueue a DDCB
    * @cd: pointer to genwqe device descriptor
    * @queue: queue this operation should be done on
    + * @pddcb: pointer to ddcb structure
    * @ddcb_no: pointer to ddcb number being tapped
    *
    * Start execution of DDCB by tapping or append to queue via NEXT
    @@ -259,9 +262,6 @@ static int ddcb_requ_finished(struct genwqe_dev *cd, struct ddcb_requ *req)
    * Return: 1 if new DDCB is appended to previous
    * 2 if DDCB queue is tapped via register/simulation
    */
    -#define RET_DDCB_APPENDED 1
    -#define RET_DDCB_TAPPED 2
    -
    static int enqueue_ddcb(struct genwqe_dev *cd, struct ddcb_queue *queue,
    struct ddcb *pddcb, int ddcb_no)
    {
    @@ -316,6 +316,8 @@ static int enqueue_ddcb(struct genwqe_dev *cd, struct ddcb_queue *queue,

    /**
    * copy_ddcb_results() - Copy output state from real DDCB to request
    + * @req: pointer to requsted DDCB parameters
    + * @ddcb_no: pointer to ddcb number being tapped
    *
    * Copy DDCB ASV to request struct. There is no endian
    * conversion made, since data structure in ASV is still
    @@ -356,6 +358,7 @@ static void copy_ddcb_results(struct ddcb_requ *req, int ddcb_no)
    /**
    * genwqe_check_ddcb_queue() - Checks DDCB queue for completed work equests.
    * @cd: pointer to genwqe device descriptor
    + * @queue: queue to be checked
    *
    * Return: Number of DDCBs which were finished
    */
    @@ -553,6 +556,8 @@ int __genwqe_wait_ddcb(struct genwqe_dev *cd, struct ddcb_requ *req)
    /**
    * get_next_ddcb() - Get next available DDCB
    * @cd: pointer to genwqe device descriptor
    + * @queue: DDCB queue
    + * @num: internal DDCB number
    *
    * DDCB's content is completely cleared but presets for PRE and
    * SEQNUM. This function must only be called when ddcb_lock is held.
    @@ -900,7 +905,7 @@ int __genwqe_enqueue_ddcb(struct genwqe_dev *cd, struct ddcb_requ *req,
    /**
    * __genwqe_execute_raw_ddcb() - Setup and execute DDCB
    * @cd: pointer to genwqe device descriptor
    - * @req: user provided DDCB request
    + * @cmd: user provided DDCB command
    * @f_flags: file mode: blocking, non-blocking
    */
    int __genwqe_execute_raw_ddcb(struct genwqe_dev *cd,
    @@ -965,6 +970,7 @@ int __genwqe_execute_raw_ddcb(struct genwqe_dev *cd,

    /**
    * genwqe_next_ddcb_ready() - Figure out if the next DDCB is already finished
    + * @cd: pointer to genwqe device descriptor
    *
    * We use this as condition for our wait-queue code.
    */
    @@ -993,6 +999,7 @@ static int genwqe_next_ddcb_ready(struct genwqe_dev *cd)

    /**
    * genwqe_ddcbs_in_flight() - Check how many DDCBs are in flight
    + * @cd: pointer to genwqe device descriptor
    *
    * Keep track on the number of DDCBs which ware currently in the
    * queue. This is needed for statistics as well as conditon if we want
    @@ -1171,6 +1178,7 @@ static irqreturn_t genwqe_vf_isr(int irq, void *dev_id)

    /**
    * genwqe_card_thread() - Work thread for the DDCB queue
    + * @data: pointer to genwqe device descriptor
    *
    * The idea is to check if there are DDCBs in processing. If there are
    * some finished DDCBs, we process them and wakeup the
    @@ -1299,6 +1307,7 @@ int genwqe_setup_service_layer(struct genwqe_dev *cd)

    /**
    * queue_wake_up_all() - Handles fatal error case
    + * @cd: pointer to genwqe device descriptor
    *
    * The PCI device got unusable and we have to stop all pending
    * requests as fast as we can. The code after this must purge the
    @@ -1323,6 +1332,7 @@ static int queue_wake_up_all(struct genwqe_dev *cd)

    /**
    * genwqe_finish_queue() - Remove any genwqe devices and user-interfaces
    + * @cd: pointer to genwqe device descriptor
    *
    * Relies on the pre-condition that there are no users of the card
    * device anymore e.g. with open file-descriptors.
    --
    2.25.1
    \
     
     \ /
      Last update: 2020-06-30 15:54    [W:4.893 / U:0.168 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site