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

scsi: pm8001: Fix some function documentation issues 

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

 drivers/scsi/pm8001/pm80xx_hwi.c:918: warning: Function parameter or member 'number' not described in 'update_inbnd_queue_table'
 drivers/scsi/pm8001/pm80xx_hwi.c:954: warning: Function parameter or member 'number' not described in 'update_outbnd_queue_table'
 drivers/scsi/pm8001/pm80xx_hwi.c:1717: warning: Function parameter or member 'vec' not described in 'pm80xx_chip_interrupt_enable'
 drivers/scsi/pm8001/pm80xx_hwi.c:1735: warning: Function parameter or member 'vec' not described in 'pm80xx_chip_interrupt_disable'
 drivers/scsi/pm8001/pm80xx_hwi.c:4830: warning: Excess function parameter 'num' description in 'pm80xx_chip_phy_start_req'
 drivers/scsi/pm8001/pm80xx_hwi.c:4872: warning: Excess function parameter 'num' description in 'pm80xx_chip_phy_stop_req'
 drivers/scsi/pm8001/pm80xx_hwi.c:4892: warning: Function parameter or member 'pm8001_ha' not described in 'pm80xx_chip_reg_dev_req'
 drivers/scsi/pm8001/pm80xx_hwi.c:4892: warning: Function parameter or member 'pm8001_dev' not described in 'pm80xx_chip_reg_dev_req'
 drivers/scsi/pm8001/pm80xx_hwi.c:4892: warning: Function parameter or member 'flag' not described in 'pm80xx_chip_reg_dev_req'
 drivers/scsi/pm8001/pm80xx_hwi.c:4966: warning: Function parameter or member 'phyId' not described in 'pm80xx_chip_phy_ctl_req'
 drivers/scsi/pm8001/pm80xx_hwi.c:4966: warning: Function parameter or member 'phy_op' not described in 'pm80xx_chip_phy_ctl_req'
 drivers/scsi/pm8001/pm80xx_hwi.c:4966: warning: Excess function parameter 'num' description in 'pm80xx_chip_phy_ctl_req'
 drivers/scsi/pm8001/pm80xx_hwi.c:4966: warning: Excess function parameter 'phy_id' description in 'pm80xx_chip_phy_ctl_req'
 drivers/scsi/pm8001/pm80xx_hwi.c:5006: warning: Function parameter or member 'vec' not described in 'pm80xx_chip_isr'
 drivers/scsi/pm8001/pm80xx_hwi.c:5006: warning: Excess function parameter 'irq' description in 'pm80xx_chip_isr'
 drivers/scsi/pm8001/pm80xx_hwi.c:5006: warning: Excess function parameter 'stat' description in 'pm80xx_chip_isr'

Link: https://lore.kernel.org/r/20200721164148.2617584-18-lee.jones@linaro.org


Cc: Jack 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 083645ba

drivers/scsi/pm8001/pm80xx_hwi.c

+8 −8
Original line number Diff line number Diff line
@@ -912,6 +912,7 @@ static void update_main_config_table(struct pm8001_hba_info *pm8001_ha) 
/**

 * update_inbnd_queue_table - update the inbound queue table to the HBA.

 * @pm8001_ha: our hba card information

 * @number: entry in the queue

 */

static void update_inbnd_queue_table(struct pm8001_hba_info *pm8001_ha,

					 int number)
@@ -948,6 +949,7 @@ static void update_inbnd_queue_table(struct pm8001_hba_info *pm8001_ha, 
/**

 * update_outbnd_queue_table - update the outbound queue table to the HBA.

 * @pm8001_ha: our hba card information

 * @number: entry in the queue

 */

static void update_outbnd_queue_table(struct pm8001_hba_info *pm8001_ha,

						 int number)
@@ -1711,6 +1713,7 @@ pm80xx_chip_intx_interrupt_disable(struct pm8001_hba_info *pm8001_ha) 
/**

 * pm8001_chip_interrupt_enable - enable PM8001 chip interrupt

 * @pm8001_ha: our hba card information

 * @vec: interrupt number to enable

 */

static void

pm80xx_chip_interrupt_enable(struct pm8001_hba_info *pm8001_ha, u8 vec)
@@ -1729,6 +1732,7 @@ pm80xx_chip_interrupt_enable(struct pm8001_hba_info *pm8001_ha, u8 vec) 
/**

 * pm8001_chip_interrupt_disable- disable PM8001 chip interrupt

 * @pm8001_ha: our hba card information

 * @vec: interrupt number to disable

 */

static void

pm80xx_chip_interrupt_disable(struct pm8001_hba_info *pm8001_ha, u8 vec)
@@ -4822,7 +4826,6 @@ static int pm80xx_chip_sata_req(struct pm8001_hba_info *pm8001_ha, 
/**

 * pm80xx_chip_phy_start_req - start phy via PHY_START COMMAND

 * @pm8001_ha: our hba card information.

 * @num: the inbound queue number

 * @phy_id: the phy id which we wanted to start up.

 */

static int
@@ -4864,7 +4867,6 @@ pm80xx_chip_phy_start_req(struct pm8001_hba_info *pm8001_ha, u8 phy_id) 
/**

 * pm8001_chip_phy_stop_req - start phy via PHY_STOP COMMAND

 * @pm8001_ha: our hba card information.

 * @num: the inbound queue number

 * @phy_id: the phy id which we wanted to start up.

 */

static int pm80xx_chip_phy_stop_req(struct pm8001_hba_info *pm8001_ha,
@@ -4884,7 +4886,7 @@ static int pm80xx_chip_phy_stop_req(struct pm8001_hba_info *pm8001_ha, 
	return ret;

}



/**

/*

 * see comments on pm8001_mpi_reg_resp.

 */

static int pm80xx_chip_reg_dev_req(struct pm8001_hba_info *pm8001_ha,
@@ -4957,9 +4959,8 @@ static int pm80xx_chip_reg_dev_req(struct pm8001_hba_info *pm8001_ha, 
/**

 * pm80xx_chip_phy_ctl_req - support the local phy operation

 * @pm8001_ha: our hba card information.

 * @num: the inbound queue number

 * @phy_id: the phy id which we wanted to operate

 * @phy_op:

 * @phyId: the phy id which we wanted to operate

 * @phy_op: phy operation to request

 */

static int pm80xx_chip_phy_ctl_req(struct pm8001_hba_info *pm8001_ha,

	u32 phyId, u32 phy_op)
@@ -4998,8 +4999,7 @@ static u32 pm80xx_chip_is_our_interrupt(struct pm8001_hba_info *pm8001_ha) 
/**

 * pm8001_chip_isr - PM8001 isr handler.

 * @pm8001_ha: our hba card information.

 * @irq: irq number.

 * @stat: stat.

 * @vec: irq number.

 */

static irqreturn_t

pm80xx_chip_isr(struct pm8001_hba_info *pm8001_ha, u8 vec)