Commit e802fc43 authored by Lee Jones's avatar Lee Jones Committed by Martin K. Petersen
Browse files

scsi: pm8001: Demote obvious misuse of kerneldoc and update others 

More bitrot issues with function documentation not keeping up with API changes.

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

 drivers/scsi/pm8001/pm8001_init.c:64: warning: cannot understand function prototype: 'const struct pm8001_chip_info pm8001_chips[] = '
 drivers/scsi/pm8001/pm8001_init.c:86: warning: cannot understand function prototype: 'struct scsi_host_template pm8001_sht = '
 drivers/scsi/pm8001/pm8001_init.c:115: warning: cannot understand function prototype: 'struct sas_domain_function_template pm8001_transport_ops = '
 drivers/scsi/pm8001/pm8001_init.c:212: warning: Function parameter or member 'irq' not described in 'pm8001_interrupt_handler_msix'
 drivers/scsi/pm8001/pm8001_init.c:237: warning: Function parameter or member 'irq' not described in 'pm8001_interrupt_handler_intx'
 drivers/scsi/pm8001/pm8001_init.c:265: warning: Function parameter or member 'ent' not described in 'pm8001_alloc'
 drivers/scsi/pm8001/pm8001_init.c:624: warning: Function parameter or member 'pm8001_ha' not described in 'pm8001_init_sas_add'
 drivers/scsi/pm8001/pm8001_init.c:624: warning: Excess function parameter 'chip_info' description in 'pm8001_init_sas_add'
 drivers/scsi/pm8001/pm8001_init.c:900: warning: Function parameter or member 'pm8001_ha' not described in 'pm8001_setup_msix'
 drivers/scsi/pm8001/pm8001_init.c:900: warning: Excess function parameter 'chip_info' description in 'pm8001_setup_msix'
 drivers/scsi/pm8001/pm8001_init.c:900: warning: Excess function parameter 'irq_handler' description in 'pm8001_setup_msix'
 drivers/scsi/pm8001/pm8001_init.c:981: warning: Function parameter or member 'pm8001_ha' not described in 'pm8001_request_irq'
 drivers/scsi/pm8001/pm8001_init.c:981: warning: Excess function parameter 'chip_info' description in 'pm8001_request_irq'

Link: https://lore.kernel.org/r/20200713074645.126138-27-lee.jones@linaro.org


Cc: Kumar Santhanam <AnandKumar.Santhanam@pmcs.com>
Cc: Sangeetha Gnanasekaran <Sangeetha.Gnanasekaran@pmcs.com>
Cc: Nikith Ganigarakoppal <Nikith.Ganigarakoppal@pmcs.com>
Acked-by: default avatarJack Wang <jinpu.wang@cloud.ionos.com>
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent 2862a3a2

drivers/scsi/pm8001/pm8001_init.c

+15 −15
Original line number Diff line number Diff line
@@ -57,7 +57,7 @@ MODULE_PARM_DESC(link_rate, "Enable link rate.\n" 


static struct scsi_transport_template *pm8001_stt;



/**

/*

 * chip info structure to identify chip key functionality as

 * encryption available/not, no of ports, hw specific function ref

 */
@@ -80,7 +80,7 @@ LIST_HEAD(hba_list); 


struct workqueue_struct *pm8001_wq;



/**

/*

 * The main structure which LLDD must register for scsi core.

 */

static struct scsi_host_template pm8001_sht = {
@@ -108,7 +108,7 @@ static struct scsi_host_template pm8001_sht = { 
	.track_queue_depth	= 1,

};



/**

/*

 * Sas layer call this function to execute specific task.

 */

static struct sas_domain_function_template pm8001_transport_ops = {
@@ -156,7 +156,6 @@ static void pm8001_phy_init(struct pm8001_hba_info *pm8001_ha, int phy_id) 
/**

 * pm8001_free - free hba

 * @pm8001_ha:	our hba structure.

 *

 */

static void pm8001_free(struct pm8001_hba_info *pm8001_ha)

{
@@ -204,6 +203,7 @@ static void pm8001_tasklet(unsigned long opaque) 
 * pm8001_interrupt_handler_msix - main MSIX interrupt handler.

 * It obtains the vector number and calls the equivalent bottom

 * half or services directly.

 * @irq: interrupt number

 * @opaque: the passed outbound queue/vector. Host structure is

 * retrieved from the same.

 */
@@ -229,6 +229,7 @@ static irqreturn_t pm8001_interrupt_handler_msix(int irq, void *opaque) 


/**

 * pm8001_interrupt_handler_intx - main INTx interrupt handler.

 * @irq: interrupt number

 * @dev_id: sas_ha structure. The HBA is retrieved from sas_has structure.

 */
@@ -257,7 +258,7 @@ static u32 pm8001_request_irq(struct pm8001_hba_info *pm8001_ha); 
/**

 * pm8001_alloc - initiate our hba structure and 6 DMAs area.

 * @pm8001_ha: our hba structure.

 *

 * @ent: PCI device ID structure to match on

 */

static int pm8001_alloc(struct pm8001_hba_info *pm8001_ha,

			const struct pci_device_id *ent)
@@ -614,7 +615,7 @@ static void pm8001_post_sas_ha_init(struct Scsi_Host *shost, 


/**

 * pm8001_init_sas_add - initialize sas address

 * @chip_info: our ha struct.

 * @pm8001_ha: our ha struct.

 *

 * Currently we just set the fixed SAS address to our HBA,for manufacture,

 * it should read from the EEPROM
@@ -892,8 +893,7 @@ static int pm8001_configure_phy_settings(struct pm8001_hba_info *pm8001_ha) 
#ifdef PM8001_USE_MSIX

/**

 * pm8001_setup_msix - enable MSI-X interrupt

 * @chip_info: our ha struct.

 * @irq_handler: irq_handler

 * @pm8001_ha: our ha struct.

 */

static u32 pm8001_setup_msix(struct pm8001_hba_info *pm8001_ha)

{
@@ -974,7 +974,7 @@ static u32 pm8001_setup_irq(struct pm8001_hba_info *pm8001_ha) 


/**

 * pm8001_request_irq - register interrupt

 * @chip_info: our ha struct.

 * @pm8001_ha: our ha struct.

 */

static u32 pm8001_request_irq(struct pm8001_hba_info *pm8001_ha)

{