lkml.org 
[lkml]   [2020]   [Jul]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 27/30] scsi: pm8001: pm8001_init: Demote obvious misuse of kerneldoc and update others
    Date
    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'

    Cc: Jack Wang <jinpu.wang@cloud.ionos.com>
    Cc: Kumar Santhanam <AnandKumar.Santhanam@pmcs.com>
    Cc: Sangeetha Gnanasekaran <Sangeetha.Gnanasekaran@pmcs.com>
    Cc: Nikith Ganigarakoppal <Nikith.Ganigarakoppal@pmcs.com>
    Signed-off-by: Lee Jones <lee.jones@linaro.org>
    ---
    drivers/scsi/pm8001/pm8001_init.c | 30 +++++++++++++++---------------
    1 file changed, 15 insertions(+), 15 deletions(-)

    diff --git a/drivers/scsi/pm8001/pm8001_init.c b/drivers/scsi/pm8001/pm8001_init.c
    index 9e99262a2b9dd..20fa96cbc9d3d 100644
    --- a/drivers/scsi/pm8001/pm8001_init.c
    +++ b/drivers/scsi/pm8001/pm8001_init.c
    @@ -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 = {
    @@ -109,7 +109,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 = {
    @@ -129,9 +129,9 @@ static struct sas_domain_function_template pm8001_transport_ops = {
    };

    /**
    - *pm8001_phy_init - initiate our adapter phys
    - *@pm8001_ha: our hba structure.
    - *@phy_id: phy id.
    + * pm8001_phy_init - initiate our adapter phys
    + * @pm8001_ha: our hba structure.
    + * @phy_id: phy id.
    */
    static void pm8001_phy_init(struct pm8001_hba_info *pm8001_ha, int phy_id)
    {
    @@ -155,9 +155,8 @@ static void pm8001_phy_init(struct pm8001_hba_info *pm8001_ha, int phy_id)
    }

    /**
    - *pm8001_free - free hba
    - *@pm8001_ha: our hba structure.
    - *
    + * pm8001_free - free hba
    + * @pm8001_ha: our hba structure.
    */
    static void pm8001_free(struct pm8001_hba_info *pm8001_ha)
    {
    @@ -205,6 +204,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.
    */
    @@ -230,6 +230,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,8 +258,8 @@ 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.
    - *
    + * @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)
    @@ -615,7 +616,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
    @@ -893,8 +894,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)
    {
    @@ -975,7 +975,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)
    {
    --
    2.25.1
    \
     
     \ /
      Last update: 2020-07-08 14:04    [W:4.185 / U:0.068 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site