github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-26 16:12:59 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

scsi: lpfc: ELIMINATE kernel-doc warnings in lpfc.h

Browse Source 
Avoid all kernel-doc warnings in lpfc.h:

 - Use the correct function parameter name

 - Add a '*' to a kernel-doc line

 - Repair the function Returns: comments

Fixes these warnings:

Warning: drivers/scsi/lpfc/lpfc.h:1674 No description found for return
 value of 'lpfc_next_online_cpu'
Warning: drivers/scsi/lpfc/lpfc.h:1686 No description found for return
 value of 'lpfc_next_present_cpu'
Warning: drivers/scsi/lpfc/lpfc.h:1700 function parameter 'eq' not
 described in 'lpfc_sli4_mod_hba_eq_delay'
Warning: drivers/scsi/lpfc/lpfc.h:1755 bad line: --------------------------
Warning: drivers/scsi/lpfc/lpfc.h:1759 No description found for return
 value of 'lpfc_is_vmid_enabled'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Justin Tee <justin.tee@broadcom.com>
Link: https://patch.msgid.link/20260224234954.3606638-1-rdunlap@infradead.org
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
This commit is contained in:
Randy Dunlap 2026-02-24 15:49:54 -08:00 committed by Martin K. Petersen
parent e521b77688
commit 5e0d4fdb98
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
drivers/scsi/lpfc/lpfc.h
View File

@ -1667,8 +1667,9 @@ lpfc_phba_elsring(struct lpfc_hba *phba)
* @mask: Pointer to phba's cpumask member.
* @start: starting cpu index
*
* Note: If no valid cpu found, then nr_cpu_ids is returned.
* Returns: next online CPU in @mask on success
*
* Note: If no valid cpu found, then nr_cpu_ids is returned.
**/
static __always_inline unsigned int
lpfc_next_online_cpu(const struct cpumask *mask, unsigned int start)
@ -1680,8 +1681,9 @@ lpfc_next_online_cpu(const struct cpumask *mask, unsigned int start)
* lpfc_next_present_cpu - Finds next present CPU after n
* @n: the cpu prior to search
*
* Note: If no next present cpu, then fallback to first present cpu.
* Returns: next present CPU after CPU @n
*
* Note: If no next present cpu, then fallback to first present cpu.
**/
static __always_inline unsigned int lpfc_next_present_cpu(int n)
{
@ -1691,7 +1693,7 @@ static __always_inline unsigned int lpfc_next_present_cpu(int n)
/**
* lpfc_sli4_mod_hba_eq_delay - update EQ delay
* @phba: Pointer to HBA context object.
* @q: The Event Queue to update.
* @eq: The Event Queue to update.
* @delay: The delay value (in us) to be written.
*
**/
@ -1753,8 +1755,9 @@ static const char *routine(enum enum_name table_key) \
* Pr Tag 1 0 N
* Pr Tag 1 1 Y
* Pr Tag 2 * Y
---------------------------------------------------
* ---------------------------------------------------
*
* Returns: whether VMID is enabled
**/
static inline int lpfc_is_vmid_enabled(struct lpfc_hba *phba)
{