leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

scsi: mpt3sas: Fix mpt3sas_check_same_4gb_region() kdoc comment

Browse Source 
The start_addres argument of mpt3sas_check_same_4gb_region() was misnamed
in the function kdoc comment, resulting in the following warning when
compiling with W=1.

drivers/scsi/mpt3sas/mpt3sas_base.c:5728: warning: Function parameter or
member 'start_address' not described in 'mpt3sas_check_same_4gb_region'
drivers/scsi/mpt3sas/mpt3sas_base.c:5728: warning: Excess function
parameter 'reply_pool_start_address' description in
'mpt3sas_check_same_4gb_region'

Fix the argument name in the function kdoc comment to avoid it. While at
it, remove a useless blank line between the kdoc and function code.

Link: https://lore.kernel.org/r/20220404050041.594774-1-damien.lemoal@opensource.wdc.com
Acked-by: Sreekanth Reddy <sreekanth.reddy@broadcom.com>
Signed-off-by: Damien Le Moal <damien.lemoal@opensource.wdc.com>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
This commit is contained in:
Damien Le Moal
2022-04-04 14:00:41 +09:00
committed by Martin K. Petersen
parent 6a0d0ae3e8
commit 6eaa77144b
1 changed files with 1 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
drivers/scsi/mpt3sas/mpt3sas_base.c
View File

@@ -5716,13 +5716,12 @@ _base_release_memory_pools(struct MPT3SAS_ADAPTER *ioc)
/** /**
* mpt3sas_check_same_4gb_region - checks whether all reply queues in a set are * mpt3sas_check_same_4gb_region - checks whether all reply queues in a set are
* having same upper 32bits in their base memory address. * having same upper 32bits in their base memory address.
* @reply_pool_start_address: Base address of a reply queue set * @start_address: Base address of a reply queue set
* @pool_sz: Size of single Reply Descriptor Post Queues pool size * @pool_sz: Size of single Reply Descriptor Post Queues pool size
* *
* Return: 1 if reply queues in a set have a same upper 32bits in their base * Return: 1 if reply queues in a set have a same upper 32bits in their base
* memory address, else 0. * memory address, else 0.
*/ */
static int static int
mpt3sas_check_same_4gb_region(dma_addr_t start_address, u32 pool_sz) mpt3sas_check_same_4gb_region(dma_addr_t start_address, u32 pool_sz)
{ {