scsi: aacraid: Fix a bunch of function header issues
authorLee Jones <lee.jones@linaro.org>
Mon, 13 Jul 2020 07:59:44 +0000 (08:59 +0100)
committerMartin K. Petersen <martin.petersen@oracle.com>
Wed, 15 Jul 2020 21:25:13 +0000 (17:25 -0400)
Some parameters not documented.  Others misspelled.

Also, functions must follow directly after the header that documents them.

Fixes the following W=1 kernel build warning(s):

 drivers/scsi/aacraid/commsup.c:223: warning: Function parameter or member 'scmd' not described in 'aac_fib_alloc_tag'
 drivers/scsi/aacraid/commsup.c:421: warning: Function parameter or member 'qid' not described in 'aac_queue_get'
 drivers/scsi/aacraid/commsup.c:421: warning: Function parameter or member 'hw_fib' not described in 'aac_queue_get'
 drivers/scsi/aacraid/commsup.c:421: warning: Excess function parameter 'priority' description in 'aac_queue_get'
 drivers/scsi/aacraid/commsup.c:421: warning: Excess function parameter 'fib' description in 'aac_queue_get'
 drivers/scsi/aacraid/commsup.c:943: warning: Function parameter or member 'fibptr' not described in 'aac_fib_complete'
 drivers/scsi/aacraid/commsup.c:943: warning: Excess function parameter 'fib' description in 'aac_fib_complete'
 drivers/scsi/aacraid/commsup.c:1061: warning: Excess function parameter 'dev' description in 'AIF_SNIFF_TIMEOUT'
 drivers/scsi/aacraid/commsup.c:1061: warning: Excess function parameter 'fibptr' description in 'AIF_SNIFF_TIMEOUT'
 drivers/scsi/aacraid/commsup.c:2428: warning: Function parameter or member 'data' not described in 'aac_command_thread'
 drivers/scsi/aacraid/commsup.c:2428: warning: Excess function parameter 'dev' description in 'aac_command_thread'

Link: https://lore.kernel.org/r/20200713080001.128044-8-lee.jones@linaro.org
Cc: Adaptec OEM Raid Solutions <aacraid@microsemi.com>
Cc: Sumit Semwal <sumit.semwal@linaro.org>
Cc: "Christian König" <christian.koenig@amd.com>
Cc: "PMC-Sierra, Inc" <aacraid@pmc-sierra.com>
Cc: linux-media@vger.kernel.org
Cc: dri-devel@lists.freedesktop.org
Cc: linaro-mm-sig@lists.linaro.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
drivers/scsi/aacraid/commsup.c

index 8ee4e1abe568d1f2f738e2d52063a7086beec854..adbdc3b7c7a706e0151c698f84c73251157a05e8 100644 (file)
@@ -214,6 +214,7 @@ int aac_fib_setup(struct aac_dev * dev)
 /**
  *     aac_fib_alloc_tag-allocate a fib using tags
  *     @dev: Adapter to allocate the fib for
+ *     @scmd: SCSI command
  *
  *     Allocate a fib from the adapter fib pool using tags
  *     from the blk layer.
@@ -405,8 +406,8 @@ static int aac_get_entry (struct aac_dev * dev, u32 qid, struct aac_entry **entr
  *     aac_queue_get           -       get the next free QE
  *     @dev: Adapter
  *     @index: Returned index
- *     @priority: Priority of fib
- *     @fib: Fib to associate with the queue entry
+ *     @qid: Queue number
+ *     @hw_fib: Fib to associate with the queue entry
  *     @wait: Wait if queue full
  *     @fibptr: Driver fib object to go with fib
  *     @nonotify: Don't notify the adapter
@@ -934,7 +935,7 @@ int aac_fib_adapter_complete(struct fib *fibptr, unsigned short size)
 
 /**
  *     aac_fib_complete        -       fib completion handler
- *     @fib: FIB to complete
+ *     @fibptr: FIB to complete
  *
  *     Will do all necessary work to complete a FIB.
  */
@@ -1049,6 +1050,7 @@ static void aac_handle_aif_bu(struct aac_dev *dev, struct aac_aifcmd *aifcmd)
        }
 }
 
+#define AIF_SNIFF_TIMEOUT      (500*HZ)
 /**
  *     aac_handle_aif          -       Handle a message from the firmware
  *     @dev: Which adapter this fib is from
@@ -1057,8 +1059,6 @@ static void aac_handle_aif_bu(struct aac_dev *dev, struct aac_aifcmd *aifcmd)
  *     This routine handles a driver notify fib from the adapter and
  *     dispatches it to the appropriate routine for handling.
  */
-
-#define AIF_SNIFF_TIMEOUT      (500*HZ)
 static void aac_handle_aif(struct aac_dev * dev, struct fib * fibptr)
 {
        struct hw_fib * hw_fib = fibptr->hw_fib_va;
@@ -2416,7 +2416,7 @@ out:
 
 /**
  *     aac_command_thread      -       command processing thread
- *     @dev: Adapter to monitor
+ *     @data: Adapter to monitor
  *
  *     Waits on the commandready event in it's queue. When the event gets set
  *     it will pull FIBs off it's queue. It will continue to pull FIBs off