2021-02-01 14:41:34

by Lee Jones

[permalink] [raw]
Subject: [PATCH v2 00/20] [Set 1] Rid W=1 warnings from ATA

This set is part of a larger effort attempting to clean-up W=1
kernel builds, which are currently overwhelmingly riddled with
niggly little warnings.

This is set 1 out of 2 sets required.

v2:
- Removed "Ignore -Woverride-init" patches
- Back-filled them with others

Lee Jones (20):
ata: libata-transport: Fix some potential doc-rot issues
ata: libata-sata: Fix function names in header comments
ata: libata-pmp: Fix misspelling of 'val'
ata: pata_ali: Repair some misnamed kernel-doc issues
ata: pata_artop: Fix a function name and parameter description
ata: pata_amd: Remove superfluous, add missing and fix broken params
ata: pata_hpt366: Provide missing description for 'hpt366_filter()'s
'mask' param
ata: pata_hpt37x: Fix some function misnaming and missing param issues
ata: ahci_xgene: Fix incorrect naming of
'xgene_ahci_handle_broken_edge_irq()'s 'host' param
ata: sata_mv: Fix worthy headers and demote others
ata: pata_ali: Supply description for 'ali_20_filter()'s 'mask' param
ata: pata_amd: Fix incorrectly named function in the header
ata: pata_artop: Repair possible copy/paste issue in
'artop_6210_qc_defer()'s header
ata: pata_atiixp: Fix a function name and supply description for 'pio'
ata: pata_cs5520: Add a couple of missing param descriptions
ata: pata_hpt3x2n: Fix possible doc-rotted function name
ata: pata_marvell: Fix incorrectly documented function parameter
ata: pata_jmicron: Fix incorrectly documented function parameter
ata: pata_optidma: Fix a function misnaming, a formatting issue and a
missing description
ata: pata_pdc2027x: Fix some incorrect function names and parameter
docs

drivers/ata/ahci_xgene.c | 2 +-
drivers/ata/libata-pmp.c | 2 +-
drivers/ata/libata-sata.c | 4 ++--
drivers/ata/libata-transport.c | 6 +++---
drivers/ata/pata_ali.c | 6 +++---
drivers/ata/pata_amd.c | 6 +++---
drivers/ata/pata_artop.c | 4 ++--
drivers/ata/pata_atiixp.c | 3 ++-
drivers/ata/pata_cs5520.c | 2 ++
drivers/ata/pata_hpt366.c | 1 +
drivers/ata/pata_hpt37x.c | 6 ++++--
drivers/ata/pata_hpt3x2n.c | 2 +-
drivers/ata/pata_jmicron.c | 2 +-
drivers/ata/pata_marvell.c | 2 +-
drivers/ata/pata_optidma.c | 5 +++--
drivers/ata/pata_pdc2027x.c | 10 +++++-----
drivers/ata/sata_mv.c | 12 ++++++------
17 files changed, 41 insertions(+), 34 deletions(-)

Cc: Alan Cox <[email protected]>
Cc: Albert Lee <[email protected]>
Cc: Alessandro Zummo <[email protected]>
Cc: ALWAYS copy <[email protected]>
Cc: and cc <[email protected]>
Cc: Andre Hedrick <[email protected]>
Cc: ATI Inc <[email protected]>
Cc: CJ <[email protected]>
Cc: Clear Zhang <[email protected]>
Cc: Frank Tiernan <[email protected]>
Cc: Jens Axboe <[email protected]>
Cc: [email protected]
Cc: Loc Ho <[email protected]>
Cc: Mark Lord <[email protected]>
Cc: Suman Tripathi <[email protected]>
Cc: Tejun Heo <[email protected]>
Cc: Tejun Heo <[email protected]>
Cc: Thibaut VARENE <[email protected]>
Cc: Tuan Phan <[email protected]>
--
2.25.1


2021-02-01 14:42:22

by Lee Jones

[permalink] [raw]
Subject: [PATCH 01/20] ata: libata-transport: Fix some potential doc-rot issues

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

drivers/ata/libata-transport.c:258: warning: Function parameter or member 'ap' not described in 'ata_tport_delete'
drivers/ata/libata-transport.c:258: warning: Excess function parameter 'port' description in 'ata_tport_delete'
drivers/ata/libata-transport.c:384: warning: Function parameter or member 'link' not described in 'ata_tlink_delete'
drivers/ata/libata-transport.c:384: warning: Excess function parameter 'port' description in 'ata_tlink_delete'
drivers/ata/libata-transport.c:640: warning: Function parameter or member 'ata_dev' not described in 'ata_tdev_delete'
drivers/ata/libata-transport.c:640: warning: Excess function parameter 'port' description in 'ata_tdev_delete'

Cc: Jens Axboe <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/libata-transport.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/ata/libata-transport.c b/drivers/ata/libata-transport.c
index 6a40e3c6cf492..34bb4608bdc67 100644
--- a/drivers/ata/libata-transport.c
+++ b/drivers/ata/libata-transport.c
@@ -250,7 +250,7 @@ static int ata_tport_match(struct attribute_container *cont,

/**
* ata_tport_delete -- remove ATA PORT
- * @port: ATA PORT to remove
+ * @ap: ATA PORT to remove
*
* Removes the specified ATA PORT. Remove the associated link as well.
*/
@@ -376,7 +376,7 @@ static int ata_tlink_match(struct attribute_container *cont,

/**
* ata_tlink_delete -- remove ATA LINK
- * @port: ATA LINK to remove
+ * @link: ATA LINK to remove
*
* Removes the specified ATA LINK. remove associated ATA device(s) as well.
*/
@@ -632,7 +632,7 @@ static void ata_tdev_free(struct ata_device *dev)

/**
* ata_tdev_delete -- remove ATA device
- * @port: ATA PORT to remove
+ * @ata_dev: ATA device to remove
*
* Removes the specified ATA device.
*/
--
2.25.1

2021-02-01 14:42:47

by Lee Jones

[permalink] [raw]
Subject: [PATCH 03/20] ata: libata-pmp: Fix misspelling of 'val'

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

drivers/ata/libata-pmp.c:76: warning: Function parameter or member 'val' not described in 'sata_pmp_write'
drivers/ata/libata-pmp.c:76: warning: Excess function parameter 'r_val' description in 'sata_pmp_write'

Cc: Jens Axboe <[email protected]>
Cc: Tejun Heo <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/libata-pmp.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/libata-pmp.c b/drivers/ata/libata-pmp.c
index 79f2aeeb482ab..ba7be3f386171 100644
--- a/drivers/ata/libata-pmp.c
+++ b/drivers/ata/libata-pmp.c
@@ -62,7 +62,7 @@ static unsigned int sata_pmp_read(struct ata_link *link, int reg, u32 *r_val)
* sata_pmp_write - write PMP register
* @link: link to write PMP register for
* @reg: register to write
- * @r_val: value to write
+ * @val: value to write
*
* Write PMP register.
*
--
2.25.1

2021-02-01 14:43:17

by Lee Jones

[permalink] [raw]
Subject: [PATCH 06/20] ata: pata_amd: Remove superfluous, add missing and fix broken params

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

drivers/ata/pata_amd.c:179: warning: Excess function parameter 'adev' description in 'amd_fifo_setup'
drivers/ata/pata_amd.c:331: warning: Function parameter or member 'link' not described in 'nv_pre_reset'
drivers/ata/pata_amd.c:331: warning: Function parameter or member 'deadline' not described in 'nv_pre_reset'
drivers/ata/pata_amd.c:331: warning: expecting prototype for nv_probe_init(). Prototype was for nv_pre_reset() instead

Cc: Jens Axboe <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_amd.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/ata/pata_amd.c b/drivers/ata/pata_amd.c
index 987967f976cb2..75b830eb3c542 100644
--- a/drivers/ata/pata_amd.c
+++ b/drivers/ata/pata_amd.c
@@ -167,7 +167,6 @@ static int amd_cable_detect(struct ata_port *ap)
/**
* amd_fifo_setup - set the PIO FIFO for ATA/ATAPI
* @ap: ATA interface
- * @adev: ATA device
*
* Set the PCI fifo for this device according to the devices present
* on the bus at this point in time. We need to turn the post write buffer
@@ -321,7 +320,8 @@ static unsigned long nv_mode_filter(struct ata_device *dev,

/**
* nv_probe_init - cable detection
- * @lin: ATA link
+ * @link: ATA link
+ * @deadline: deadline jiffies for the operation
*
* Perform cable detection. The BIOS stores this in PCI config
* space for us.
--
2.25.1

2021-02-01 14:44:14

by Lee Jones

[permalink] [raw]
Subject: [PATCH 02/20] ata: libata-sata: Fix function names in header comments

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

drivers/ata/libata-sata.c:1085: warning: expecting prototype for port_alloc(). Prototype was for ata_sas_port_alloc() instead
drivers/ata/libata-sata.c:1140: warning: expecting prototype for ata_port_stop(). Prototype was for ata_sas_port_stop() instead

Cc: Jens Axboe <[email protected]>
Cc: Tejun Heo <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/libata-sata.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/ata/libata-sata.c b/drivers/ata/libata-sata.c
index c16423e445255..8adeab76dd382 100644
--- a/drivers/ata/libata-sata.c
+++ b/drivers/ata/libata-sata.c
@@ -1067,7 +1067,7 @@ int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
EXPORT_SYMBOL_GPL(ata_scsi_change_queue_depth);

/**
- * port_alloc - Allocate port for a SAS attached SATA device
+ * ata_sas_port_alloc - Allocate port for a SAS attached SATA device
* @host: ATA host container for all SAS ports
* @port_info: Information from low-level host driver
* @shost: SCSI host that the scsi device is attached to
@@ -1127,7 +1127,7 @@ int ata_sas_port_start(struct ata_port *ap)
EXPORT_SYMBOL_GPL(ata_sas_port_start);

/**
- * ata_port_stop - Undo ata_sas_port_start()
+ * ata_sas_port_stop - Undo ata_sas_port_start()
* @ap: Port to shut down
*
* May be used as the port_stop() entry in ata_port_operations.
--
2.25.1

2021-02-01 14:44:22

by Lee Jones

[permalink] [raw]
Subject: [PATCH 05/20] ata: pata_artop: Fix a function name and parameter description

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

drivers/ata/pata_artop.c:278: warning: expecting prototype for artop_6210_qc_defer(). Prototype was for artop6210_qc_defer() instead
drivers/ata/pata_artop.c:359: warning: Function parameter or member 'id' not described in 'artop_init_one'
drivers/ata/pata_artop.c:359: warning: Excess function parameter 'ent' description in 'artop_init_one'

Cc: Jens Axboe <[email protected]>
Cc: Andre Hedrick <[email protected]>
Cc: Thibaut VARENE <[email protected]>
Cc: Alessandro Zummo <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_artop.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/pata_artop.c b/drivers/ata/pata_artop.c
index 6bd2228bb6ffa..02e4fd5e3b934 100644
--- a/drivers/ata/pata_artop.c
+++ b/drivers/ata/pata_artop.c
@@ -344,7 +344,7 @@ static void atp8xx_fixup(struct pci_dev *pdev)
/**
* artop_init_one - Register ARTOP ATA PCI device with kernel services
* @pdev: PCI device to register
- * @ent: Entry in artop_pci_tbl matching with @pdev
+ * @id: PCI device ID
*
* Called from kernel PCI layer.
*
--
2.25.1

2021-02-01 14:45:00

by Lee Jones

[permalink] [raw]
Subject: [PATCH 13/20] ata: pata_artop: Repair possible copy/paste issue in 'artop_6210_qc_defer()'s header

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

drivers/ata/pata_artop.c:278: warning: expecting prototype for artop_6210_qc_defer(). Prototype was for artop6210_qc_defer() instead

Cc: Jens Axboe <[email protected]>
Cc: Andre Hedrick <[email protected]>
Cc: Thibaut VARENE <[email protected]>
Cc: Alessandro Zummo <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_artop.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/pata_artop.c b/drivers/ata/pata_artop.c
index 02e4fd5e3b934..ad3c5808aaad6 100644
--- a/drivers/ata/pata_artop.c
+++ b/drivers/ata/pata_artop.c
@@ -268,7 +268,7 @@ static void artop6260_set_dmamode (struct ata_port *ap, struct ata_device *adev)
}

/**
- * artop_6210_qc_defer - implement serialization
+ * artop6210_qc_defer - implement serialization
* @qc: command
*
* Issue commands per host on this chip.
--
2.25.1

2021-02-01 14:45:36

by Lee Jones

[permalink] [raw]
Subject: [PATCH 12/20] ata: pata_amd: Fix incorrectly named function in the header

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

drivers/ata/pata_amd.c:331: warning: expecting prototype for nv_probe_init(). Prototype was for nv_pre_reset() instead

Cc: Jens Axboe <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_amd.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/pata_amd.c b/drivers/ata/pata_amd.c
index 75b830eb3c542..c8acba162d02f 100644
--- a/drivers/ata/pata_amd.c
+++ b/drivers/ata/pata_amd.c
@@ -319,7 +319,7 @@ static unsigned long nv_mode_filter(struct ata_device *dev,
}

/**
- * nv_probe_init - cable detection
+ * nv_pre_reset - cable detection
* @link: ATA link
* @deadline: deadline jiffies for the operation
*
--
2.25.1

2021-02-01 14:45:49

by Lee Jones

[permalink] [raw]
Subject: [PATCH 14/20] ata: pata_atiixp: Fix a function name and supply description for 'pio'

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

drivers/ata/pata_atiixp.c:103: warning: Function parameter or member 'pio' not described in 'atiixp_set_pio_timing'
drivers/ata/pata_atiixp.c:241: warning: expecting prototype for atiixp_dma_stop(). Prototype was for atiixp_bmdma_stop() instead

Cc: Jens Axboe <[email protected]>
Cc: ATI Inc <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_atiixp.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/ata/pata_atiixp.c b/drivers/ata/pata_atiixp.c
index c68aa3f585f22..d671d33ef2874 100644
--- a/drivers/ata/pata_atiixp.c
+++ b/drivers/ata/pata_atiixp.c
@@ -93,6 +93,7 @@ static int atiixp_prereset(struct ata_link *link, unsigned long deadline)
* atiixp_set_pio_timing - set initial PIO mode data
* @ap: ATA interface
* @adev: ATA device
+ * @pio: Requested PIO
*
* Called by both the pio and dma setup functions to set the controller
* timings for PIO transfers. We must load both the mode number and
@@ -227,7 +228,7 @@ static void atiixp_bmdma_start(struct ata_queued_cmd *qc)
}

/**
- * atiixp_dma_stop - DMA stop callback
+ * atiixp_bmdma_stop - DMA stop callback
* @qc: Command in progress
*
* DMA has completed. Clear the UDMA flag as the next operations will
--
2.25.1

2021-02-01 14:46:07

by Lee Jones

[permalink] [raw]
Subject: [PATCH 18/20] ata: pata_jmicron: Fix incorrectly documented function parameter

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

drivers/ata/pata_jmicron.c:135: warning: Function parameter or member 'id' not described in 'jmicron_init_one'
drivers/ata/pata_jmicron.c:135: warning: Excess function parameter 'ent' description in 'jmicron_init_one'

Cc: Jens Axboe <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_jmicron.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/pata_jmicron.c b/drivers/ata/pata_jmicron.c
index c3dedd3e71fb7..d1b3ce8958ddc 100644
--- a/drivers/ata/pata_jmicron.c
+++ b/drivers/ata/pata_jmicron.c
@@ -120,7 +120,7 @@ static struct ata_port_operations jmicron_ops = {
/**
* jmicron_init_one - Register Jmicron ATA PCI device with kernel services
* @pdev: PCI device to register
- * @ent: Entry in jmicron_pci_tbl matching with @pdev
+ * @id: PCI device ID
*
* Called from kernel PCI layer.
*
--
2.25.1

2021-02-01 14:46:39

by Lee Jones

[permalink] [raw]
Subject: [PATCH 08/20] ata: pata_hpt37x: Fix some function misnaming and missing param issues

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

drivers/ata/pata_hpt37x.c:283: warning: Function parameter or member 'mask' not described in 'hpt370_filter'
drivers/ata/pata_hpt37x.c:301: warning: Function parameter or member 'mask' not described in 'hpt370a_filter'
drivers/ata/pata_hpt37x.c:473: warning: expecting prototype for hpt370_bmdma_end(). Prototype was for hpt370_bmdma_stop() instead
drivers/ata/pata_hpt37x.c:567: warning: expecting prototype for hpt37x_bmdma_end(). Prototype was for hpt37x_bmdma_stop() instead

Cc: Jens Axboe <[email protected]>
Cc: Andre Hedrick <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_hpt37x.c | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/drivers/ata/pata_hpt37x.c b/drivers/ata/pata_hpt37x.c
index fad6c6a873130..f242157bc81bb 100644
--- a/drivers/ata/pata_hpt37x.c
+++ b/drivers/ata/pata_hpt37x.c
@@ -275,6 +275,7 @@ static const char * const bad_ata100_5[] = {
/**
* hpt370_filter - mode selection filter
* @adev: ATA device
+ * @mask: mode mask
*
* Block UDMA on devices that cause trouble with this controller.
*/
@@ -293,6 +294,7 @@ static unsigned long hpt370_filter(struct ata_device *adev, unsigned long mask)
/**
* hpt370a_filter - mode selection filter
* @adev: ATA device
+ * @mask: mode mask
*
* Block UDMA on devices that cause trouble with this controller.
*/
@@ -463,7 +465,7 @@ static void hpt370_set_dmamode(struct ata_port *ap, struct ata_device *adev)
}

/**
- * hpt370_bmdma_end - DMA engine stop
+ * hpt370_bmdma_stop - DMA engine stop
* @qc: ATA command
*
* Work around the HPT370 DMA engine.
@@ -557,7 +559,7 @@ static void hpt372_set_dmamode(struct ata_port *ap, struct ata_device *adev)
}

/**
- * hpt37x_bmdma_end - DMA engine stop
+ * hpt37x_bmdma_stop - DMA engine stop
* @qc: ATA command
*
* Clean up after the HPT372 and later DMA engine
--
2.25.1

2021-02-01 14:46:54

by Lee Jones

[permalink] [raw]
Subject: [PATCH 20/20] ata: pata_pdc2027x: Fix some incorrect function names and parameter docs

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

drivers/ata/pata_pdc2027x.c:209: warning: expecting prototype for pdc2027x_pata_cable_detect(). Prototype was for pdc2027x_cable_detect() instead
drivers/ata/pata_pdc2027x.c:262: warning: expecting prototype for pdc2720x_mode_filter(). Prototype was for pdc2027x_mode_filter() instead
drivers/ata/pata_pdc2027x.c:513: warning: Function parameter or member 'board_idx' not described in 'pdc_adjust_pll'
drivers/ata/pata_pdc2027x.c:513: warning: expecting prototype for adjust_pll(). Prototype was for pdc_adjust_pll() instead
drivers/ata/pata_pdc2027x.c:599: warning: expecting prototype for detect_pll_input_clock(). Prototype was for pdc_detect_pll_input_clock() instead

Cc: Jens Axboe <[email protected]>
Cc: Albert Lee <[email protected]>
Cc: Andre Hedrick <[email protected]>
Cc: Frank Tiernan <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_pdc2027x.c | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/ata/pata_pdc2027x.c b/drivers/ata/pata_pdc2027x.c
index de834fbb6dfe6..effc1a09444de 100644
--- a/drivers/ata/pata_pdc2027x.c
+++ b/drivers/ata/pata_pdc2027x.c
@@ -196,7 +196,7 @@ static inline void __iomem *dev_mmio(struct ata_port *ap, struct ata_device *ade
}

/**
- * pdc2027x_pata_cable_detect - Probe host controller cable detect info
+ * pdc2027x_cable_detect - Probe host controller cable detect info
* @ap: Port for which cable detect info is desired
*
* Read 80c cable indicator from Promise extended register.
@@ -251,7 +251,7 @@ static int pdc2027x_prereset(struct ata_link *link, unsigned long deadline)
}

/**
- * pdc2720x_mode_filter - mode selection filter
+ * pdc2027x_mode_filter - mode selection filter
* @adev: ATA device
* @mask: list of modes proposed
*
@@ -503,11 +503,11 @@ static long pdc_read_counter(struct ata_host *host)
}

/**
- * adjust_pll - Adjust the PLL input clock in Hz.
+ * pdc_adjust_pll - Adjust the PLL input clock in Hz.
*
- * @pdc_controller: controller specific information
* @host: target ATA host
* @pll_clock: The input of PLL in HZ
+ * @board_idx: board identifier
*/
static void pdc_adjust_pll(struct ata_host *host, long pll_clock, unsigned int board_idx)
{
@@ -590,7 +590,7 @@ static void pdc_adjust_pll(struct ata_host *host, long pll_clock, unsigned int b
}

/**
- * detect_pll_input_clock - Detect the PLL input clock in Hz.
+ * pdc_detect_pll_input_clock - Detect the PLL input clock in Hz.
* @host: target ATA host
* Ex. 16949000 on 33MHz PCI bus for pdc20275.
* Half of the PCI clock.
--
2.25.1

2021-02-01 14:48:00

by Lee Jones

[permalink] [raw]
Subject: [PATCH 16/20] ata: pata_hpt3x2n: Fix possible doc-rotted function name

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

drivers/ata/pata_hpt3x2n.c:247: warning: expecting prototype for hpt3x2n_bmdma_end(). Prototype was for hpt3x2n_bmdma_stop() instead

Cc: Jens Axboe <[email protected]>
Cc: Andre Hedrick <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_hpt3x2n.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/pata_hpt3x2n.c b/drivers/ata/pata_hpt3x2n.c
index 9cb2d50db8768..48eef338e0507 100644
--- a/drivers/ata/pata_hpt3x2n.c
+++ b/drivers/ata/pata_hpt3x2n.c
@@ -237,7 +237,7 @@ static void hpt3x2n_set_dmamode(struct ata_port *ap, struct ata_device *adev)
}

/**
- * hpt3x2n_bmdma_end - DMA engine stop
+ * hpt3x2n_bmdma_stop - DMA engine stop
* @qc: ATA command
*
* Clean up after the HPT3x2n and later DMA engine
--
2.25.1

2021-02-01 14:49:20

by Lee Jones

[permalink] [raw]
Subject: [PATCH 19/20] ata: pata_optidma: Fix a function misnaming, a formatting issue and a missing description

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

drivers/ata/pata_optidma.c:298: warning: expecting prototype for optidma_make_bits(). Prototype was for optidma_make_bits43() instead
drivers/ata/pata_optidma.c:319: warning: Function parameter or member 'r_failed' not described in 'optidma_set_mode'
drivers/ata/pata_optidma.c:361: warning: Function parameter or member 'pdev' not described in 'optiplus_with_udma'

Cc: Jens Axboe <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_optidma.c | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/ata/pata_optidma.c b/drivers/ata/pata_optidma.c
index fbcf0af34924d..f6278d9de3486 100644
--- a/drivers/ata/pata_optidma.c
+++ b/drivers/ata/pata_optidma.c
@@ -287,7 +287,7 @@ static void optiplus_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
}

/**
- * optidma_make_bits - PCI setup helper
+ * optidma_make_bits43 - PCI setup helper
* @adev: ATA device
*
* Turn the ATA device setup into PCI configuration bits
@@ -309,6 +309,7 @@ static u8 optidma_make_bits43(struct ata_device *adev)
/**
* optidma_set_mode - mode setup
* @link: link to set up
+ * @r_failed: out parameter for failed device
*
* Use the standard setup to tune the chipset and then finalise the
* configuration by writing the nibble of extra bits of data into
@@ -354,7 +355,7 @@ static struct ata_port_operations optiplus_port_ops = {

/**
* optiplus_with_udma - Look for UDMA capable setup
- * @pdev; ATA controller
+ * @pdev: ATA controller
*/

static int optiplus_with_udma(struct pci_dev *pdev)
--
2.25.1

2021-02-01 14:50:38

by Lee Jones

[permalink] [raw]
Subject: [PATCH 17/20] ata: pata_marvell: Fix incorrectly documented function parameter

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

drivers/ata/pata_marvell.c:125: warning: Function parameter or member 'id' not described in 'marvell_init_one'
drivers/ata/pata_marvell.c:125: warning: Excess function parameter 'ent' description in 'marvell_init_one'

Cc: Jens Axboe <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_marvell.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/pata_marvell.c b/drivers/ata/pata_marvell.c
index b066809ba9a11..361597d14c569 100644
--- a/drivers/ata/pata_marvell.c
+++ b/drivers/ata/pata_marvell.c
@@ -110,7 +110,7 @@ static struct ata_port_operations marvell_ops = {
/**
* marvell_init_one - Register Marvell ATA PCI device with kernel services
* @pdev: PCI device to register
- * @ent: Entry in marvell_pci_tbl matching with @pdev
+ * @id: PCI device ID
*
* Called from kernel PCI layer.
*
--
2.25.1

2021-02-01 14:53:41

by Lee Jones

[permalink] [raw]
Subject: [PATCH 09/20] ata: ahci_xgene: Fix incorrect naming of 'xgene_ahci_handle_broken_edge_irq()'s 'host' param

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

drivers/ata/ahci_xgene.c:564: warning: Function parameter or member 'host' not described in 'xgene_ahci_handle_broken_edge_irq'
drivers/ata/ahci_xgene.c:564: warning: Excess function parameter 'ata_host' description in 'xgene_ahci_handle_broken_edge_irq'

Cc: Jens Axboe <[email protected]>
Cc: Loc Ho <[email protected]>
Cc: Tuan Phan <[email protected]>
Cc: Suman Tripathi <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/ahci_xgene.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/ahci_xgene.c b/drivers/ata/ahci_xgene.c
index 16246c843365e..dffc432b9d54a 100644
--- a/drivers/ata/ahci_xgene.c
+++ b/drivers/ata/ahci_xgene.c
@@ -537,7 +537,7 @@ static int xgene_ahci_softreset(struct ata_link *link, unsigned int *class,

/**
* xgene_ahci_handle_broken_edge_irq - Handle the broken irq.
- * @ata_host: Host that recieved the irq
+ * @host: Host that recieved the irq
* @irq_masked: HOST_IRQ_STAT value
*
* For hardware with broken edge trigger latch
--
2.25.1

2021-02-01 15:33:55

by Lee Jones

[permalink] [raw]
Subject: [PATCH 15/20] ata: pata_cs5520: Add a couple of missing param descriptions

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

drivers/ata/pata_cs5520.c:61: warning: Function parameter or member 'pio' not described in 'cs5520_set_timings'
drivers/ata/pata_cs5520.c:257: warning: Function parameter or member 'mesg' not described in 'cs5520_pci_device_suspend'

Cc: Jens Axboe <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_cs5520.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/drivers/ata/pata_cs5520.c b/drivers/ata/pata_cs5520.c
index 9052148b306d9..d09d432d3c442 100644
--- a/drivers/ata/pata_cs5520.c
+++ b/drivers/ata/pata_cs5520.c
@@ -52,6 +52,7 @@ static const struct pio_clocks cs5520_pio_clocks[]={
* cs5520_set_timings - program PIO timings
* @ap: ATA port
* @adev: ATA device
+ * @pio: PIO ID
*
* Program the PIO mode timings for the controller according to the pio
* clocking table.
@@ -246,6 +247,7 @@ static int cs5520_reinit_one(struct pci_dev *pdev)
/**
* cs5520_pci_device_suspend - device suspend
* @pdev: PCI device
+ * @mesg: PM event message
*
* We have to cut and waste bits from the standard method because
* the 5520 is a bit odd and not just a pure ATA device. As a result
--
2.25.1

2021-02-01 15:35:40

by Lee Jones

[permalink] [raw]
Subject: [PATCH 10/20] ata: sata_mv: Fix worthy headers and demote others

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

drivers/ata/sata_mv.c:1162: warning: Function parameter or member 'ap' not described in 'mv_start_edma'
drivers/ata/sata_mv.c:1162: warning: Function parameter or member 'port_mmio' not described in 'mv_start_edma'
drivers/ata/sata_mv.c:1162: warning: Function parameter or member 'protocol' not described in 'mv_start_edma'
drivers/ata/sata_mv.c:1162: warning: Excess function parameter 'base' description in 'mv_start_edma'
drivers/ata/sata_mv.c:1535: warning: Function parameter or member 'enable_bmdma' not described in 'mv_bmdma_enable_iie'
drivers/ata/sata_mv.c:1535: warning: expecting prototype for mv_bmdma_enable(). Prototype was for mv_bmdma_enable_iie() instead
drivers/ata/sata_mv.c:1930: warning: Function parameter or member 'ap' not described in 'mv_bmdma_stop_ap'
drivers/ata/sata_mv.c:1930: warning: expecting prototype for mv_bmdma_stop(). Prototype was for mv_bmdma_stop_ap() instead
drivers/ata/sata_mv.c:2228: warning: Function parameter or member 'ap' not described in 'mv_send_fis'
drivers/ata/sata_mv.c:3263: warning: Function parameter or member 'hpriv' not described in 'mv6_reset_hc'
drivers/ata/sata_mv.c:3263: warning: Function parameter or member 'n_hc' not described in 'mv6_reset_hc'
drivers/ata/sata_mv.c:3541: warning: Function parameter or member 'hpriv' not described in 'soc_is_65n'
drivers/ata/sata_mv.c:3541: warning: expecting prototype for soc_is_65(). Prototype was for soc_is_65n() instead

Cc: Jens Axboe <[email protected]>
Cc: Mark Lord <[email protected]>
Cc: ALWAYS copy <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/sata_mv.c | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/drivers/ata/sata_mv.c b/drivers/ata/sata_mv.c
index 664ef658a955f..eafca46d8feb4 100644
--- a/drivers/ata/sata_mv.c
+++ b/drivers/ata/sata_mv.c
@@ -1146,9 +1146,8 @@ static void mv_set_irq_coalescing(struct ata_host *host,
spin_unlock_irqrestore(&host->lock, flags);
}

-/**
+/*
* mv_start_edma - Enable eDMA engine
- * @base: port base address
* @pp: port private data
*
* Verify the local cache of the eDMA state is accurate with a
@@ -1519,7 +1518,7 @@ static void mv_60x1_errata_sata25(struct ata_port *ap, int want_ncq)
writel(new, hpriv->base + GPIO_PORT_CTL);
}

-/**
+/*
* mv_bmdma_enable - set a magic bit on GEN_IIE to allow bmdma
* @ap: Port being initialized
*
@@ -1919,7 +1918,7 @@ static void mv_bmdma_start(struct ata_queued_cmd *qc)

/**
* mv_bmdma_stop - Stop BMDMA transfer
- * @qc: queued command to stop DMA on.
+ * @ap: port to stop
*
* Clears the ATA_DMA_START flag in the bmdma control register
*
@@ -2221,6 +2220,7 @@ static u8 mv_sff_check_status(struct ata_port *ap)

/**
* mv_send_fis - Send a FIS, using the "Vendor-Unique FIS" register
+ * @ap: ATA port to send a FIS
* @fis: fis to be sent
* @nwords: number of 32-bit words in the fis
*/
@@ -3249,7 +3249,7 @@ static void mv6_reset_flash(struct mv_host_priv *hpriv, void __iomem *mmio)
writel(tmp, mmio + GPIO_PORT_CTL);
}

-/**
+/*
* mv6_reset_hc - Perform the 6xxx global soft reset
* @mmio: base address of the HBA
*
@@ -3530,7 +3530,7 @@ static void mv_soc_65n_phy_errata(struct mv_host_priv *hpriv,
writel(reg, port_mmio + PHY_MODE9_GEN1);
}

-/**
+/*
* soc_is_65 - check if the soc is 65 nano device
*
* Detect the type of the SoC, this is done by reading the PHYCFG_OFS
--
2.25.1

2021-02-01 15:35:47

by Lee Jones

[permalink] [raw]
Subject: [PATCH 07/20] ata: pata_hpt366: Provide missing description for 'hpt366_filter()'s 'mask' param

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

drivers/ata/pata_hpt366.c:200: warning: Function parameter or member 'mask' not described in 'hpt366_filter'

Cc: Jens Axboe <[email protected]>
Cc: Andre Hedrick <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_hpt366.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/ata/pata_hpt366.c b/drivers/ata/pata_hpt366.c
index 2574d6fbb1ad3..06b7c4a9ec954 100644
--- a/drivers/ata/pata_hpt366.c
+++ b/drivers/ata/pata_hpt366.c
@@ -192,6 +192,7 @@ static int hpt_dma_blacklisted(const struct ata_device *dev, char *modestr,
/**
* hpt366_filter - mode selection filter
* @adev: ATA device
+ * @mask: Current mask to manipulate and pass back
*
* Block UDMA on devices that cause trouble with this controller.
*/
--
2.25.1

2021-02-01 15:36:04

by Lee Jones

[permalink] [raw]
Subject: [PATCH 04/20] ata: pata_ali: Repair some misnamed kernel-doc issues

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

drivers/ata/pata_ali.c:119: warning: Function parameter or member 'mask' not described in 'ali_20_filter'
drivers/ata/pata_ali.c:119: warning: Excess function parameter 'ap' description in 'ali_20_filter'
drivers/ata/pata_ali.c:322: warning: Function parameter or member 'qc' not described in 'ali_check_atapi_dma'
drivers/ata/pata_ali.c:322: warning: Excess function parameter 'adev' description in 'ali_check_atapi_dma'

Cc: Jens Axboe <[email protected]>
Cc: CJ <[email protected]>
Cc: Andre Hedrick <[email protected]>
Cc: Alan Cox <[email protected]>
Cc: Clear Zhang <[email protected]>
Cc: [email protected]
Cc: and cc <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_ali.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/ata/pata_ali.c b/drivers/ata/pata_ali.c
index 0b122f903b8a8..e18aa02f89530 100644
--- a/drivers/ata/pata_ali.c
+++ b/drivers/ata/pata_ali.c
@@ -108,7 +108,7 @@ static int ali_c2_cable_detect(struct ata_port *ap)

/**
* ali_20_filter - filter for earlier ALI DMA
- * @ap: ALi ATA port
+ * @adev: ATA device
* @adev: attached device
*
* Ensure that we do not do DMA on CD devices. We may be able to
@@ -313,7 +313,7 @@ static void ali_lock_sectors(struct ata_device *adev)

/**
* ali_check_atapi_dma - DMA check for most ALi controllers
- * @adev: Device
+ * @qc: Command to complete
*
* Called to decide whether commands should be sent by DMA or PIO
*/
--
2.25.1

2021-02-01 15:37:37

by Lee Jones

[permalink] [raw]
Subject: [PATCH 11/20] ata: pata_ali: Supply description for 'ali_20_filter()'s 'mask' param

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

drivers/ata/pata_ali.c:119: warning: Function parameter or member 'mask' not described in 'ali_20_filter'

Cc: Jens Axboe <[email protected]>
Cc: CJ <[email protected]>
Cc: Andre Hedrick <[email protected]>
Cc: Alan Cox <[email protected]>
Cc: Clear Zhang <[email protected]>
Cc: [email protected]
Cc: and cc <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/ata/pata_ali.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/ata/pata_ali.c b/drivers/ata/pata_ali.c
index e18aa02f89530..557ecf4661022 100644
--- a/drivers/ata/pata_ali.c
+++ b/drivers/ata/pata_ali.c
@@ -109,7 +109,7 @@ static int ali_c2_cable_detect(struct ata_port *ap)
/**
* ali_20_filter - filter for earlier ALI DMA
* @adev: ATA device
- * @adev: attached device
+ * @mask: received mask to manipulate and pass back
*
* Ensure that we do not do DMA on CD devices. We may be able to
* fix that later on. Also ensure we do not do UDMA on WDC drives
--
2.25.1

2021-03-04 11:08:07

by Lee Jones

[permalink] [raw]
Subject: Re: [PATCH v2 00/20] [Set 1] Rid W=1 warnings from ATA

On Mon, 01 Feb 2021, Lee Jones wrote:

> This set is part of a larger effort attempting to clean-up W=1
> kernel builds, which are currently overwhelmingly riddled with
> niggly little warnings.
>
> This is set 1 out of 2 sets required.

Would you like me to [RESEND] this set?

> v2:
> - Removed "Ignore -Woverride-init" patches
> - Back-filled them with others
>
> Lee Jones (20):
> ata: libata-transport: Fix some potential doc-rot issues
> ata: libata-sata: Fix function names in header comments
> ata: libata-pmp: Fix misspelling of 'val'
> ata: pata_ali: Repair some misnamed kernel-doc issues
> ata: pata_artop: Fix a function name and parameter description
> ata: pata_amd: Remove superfluous, add missing and fix broken params
> ata: pata_hpt366: Provide missing description for 'hpt366_filter()'s
> 'mask' param
> ata: pata_hpt37x: Fix some function misnaming and missing param issues
> ata: ahci_xgene: Fix incorrect naming of
> 'xgene_ahci_handle_broken_edge_irq()'s 'host' param
> ata: sata_mv: Fix worthy headers and demote others
> ata: pata_ali: Supply description for 'ali_20_filter()'s 'mask' param
> ata: pata_amd: Fix incorrectly named function in the header
> ata: pata_artop: Repair possible copy/paste issue in
> 'artop_6210_qc_defer()'s header
> ata: pata_atiixp: Fix a function name and supply description for 'pio'
> ata: pata_cs5520: Add a couple of missing param descriptions
> ata: pata_hpt3x2n: Fix possible doc-rotted function name
> ata: pata_marvell: Fix incorrectly documented function parameter
> ata: pata_jmicron: Fix incorrectly documented function parameter
> ata: pata_optidma: Fix a function misnaming, a formatting issue and a
> missing description
> ata: pata_pdc2027x: Fix some incorrect function names and parameter
> docs
>
> drivers/ata/ahci_xgene.c | 2 +-
> drivers/ata/libata-pmp.c | 2 +-
> drivers/ata/libata-sata.c | 4 ++--
> drivers/ata/libata-transport.c | 6 +++---
> drivers/ata/pata_ali.c | 6 +++---
> drivers/ata/pata_amd.c | 6 +++---
> drivers/ata/pata_artop.c | 4 ++--
> drivers/ata/pata_atiixp.c | 3 ++-
> drivers/ata/pata_cs5520.c | 2 ++
> drivers/ata/pata_hpt366.c | 1 +
> drivers/ata/pata_hpt37x.c | 6 ++++--
> drivers/ata/pata_hpt3x2n.c | 2 +-
> drivers/ata/pata_jmicron.c | 2 +-
> drivers/ata/pata_marvell.c | 2 +-
> drivers/ata/pata_optidma.c | 5 +++--
> drivers/ata/pata_pdc2027x.c | 10 +++++-----
> drivers/ata/sata_mv.c | 12 ++++++------
> 17 files changed, 41 insertions(+), 34 deletions(-)
>
> Cc: Alan Cox <[email protected]>
> Cc: Albert Lee <[email protected]>
> Cc: Alessandro Zummo <[email protected]>
> Cc: ALWAYS copy <[email protected]>
> Cc: and cc <[email protected]>
> Cc: Andre Hedrick <[email protected]>
> Cc: ATI Inc <[email protected]>
> Cc: CJ <[email protected]>
> Cc: Clear Zhang <[email protected]>
> Cc: Frank Tiernan <[email protected]>
> Cc: Jens Axboe <[email protected]>
> Cc: [email protected]
> Cc: Loc Ho <[email protected]>
> Cc: Mark Lord <[email protected]>
> Cc: Suman Tripathi <[email protected]>
> Cc: Tejun Heo <[email protected]>
> Cc: Tejun Heo <[email protected]>
> Cc: Thibaut VARENE <[email protected]>
> Cc: Tuan Phan <[email protected]>

--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

2021-03-04 14:17:12

by Jens Axboe

[permalink] [raw]
Subject: Re: [PATCH v2 00/20] [Set 1] Rid W=1 warnings from ATA

On 2/1/21 7:39 AM, Lee Jones wrote:
> This set is part of a larger effort attempting to clean-up W=1
> kernel builds, which are currently overwhelmingly riddled with
> niggly little warnings.
>
> This is set 1 out of 2 sets required.

Queued up for 5.13, thanks.

--
Jens Axboe