2020-07-01 12:50:28

by Lee Jones

[permalink] [raw]
Subject: [PATCH 04/15] mmc: host: sdhci-s3c: Provide documentation for missing struct properties

Describe properties; ext_cd_irq, clk_rates and no_divider (x2).

Squashes the following W=1 kernel build warnings:

drivers/mmc/host/sdhci-s3c.c:126: warning: Function parameter or member 'ext_cd_irq' not described in 'sdhci_s3c'
drivers/mmc/host/sdhci-s3c.c:126: warning: Function parameter or member 'clk_rates' not described in 'sdhci_s3c'
drivers/mmc/host/sdhci-s3c.c:126: warning: Function parameter or member 'no_divider' not described in 'sdhci_s3c'
drivers/mmc/host/sdhci-s3c.c:139: warning: Function parameter or member 'no_divider' not described in 'sdhci_s3c_drv_data'

Cc: Adrian Hunter <[email protected]>
Cc: Ben Dooks <[email protected]>
Cc: Jaehoon Chung <[email protected]>
Signed-off-by: Lee Jones <[email protected]>
---
drivers/mmc/host/sdhci-s3c.c | 4 ++++
1 file changed, 4 insertions(+)

diff --git a/drivers/mmc/host/sdhci-s3c.c b/drivers/mmc/host/sdhci-s3c.c
index 64200c78e90dc..9194bb73e601b 100644
--- a/drivers/mmc/host/sdhci-s3c.c
+++ b/drivers/mmc/host/sdhci-s3c.c
@@ -107,8 +107,11 @@
* @ioarea: The resource created when we claimed the IO area.
* @pdata: The platform data for this controller.
* @cur_clk: The index of the current bus clock.
+ * @ext_cd_irq: External card detect interrupt.
* @clk_io: The clock for the internal bus interface.
+ * @clk_rates: Clock frequencies.
* @clk_bus: The clocks that are available for the SD/MMC bus clock.
+ * @no_divider: No or non-standard internal clock divider.
*/
struct sdhci_s3c {
struct sdhci_host *host;
@@ -128,6 +131,7 @@ struct sdhci_s3c {
/**
* struct sdhci_s3c_driver_data - S3C SDHCI platform specific driver data
* @sdhci_quirks: sdhci host specific quirks.
+ * @no_divider: no or non-standard internal clock divider.
*
* Specifies platform specific configuration of sdhci controller.
* Note: A structure for driver specific platform data is used for future
--
2.25.1


2020-07-05 23:56:37

by Jaehoon Chung

[permalink] [raw]
Subject: Re: [PATCH 04/15] mmc: host: sdhci-s3c: Provide documentation for missing struct properties

On 7/1/20 9:46 PM, Lee Jones wrote:
> Describe properties; ext_cd_irq, clk_rates and no_divider (x2).
>
> Squashes the following W=1 kernel build warnings:
>
> drivers/mmc/host/sdhci-s3c.c:126: warning: Function parameter or member 'ext_cd_irq' not described in 'sdhci_s3c'
> drivers/mmc/host/sdhci-s3c.c:126: warning: Function parameter or member 'clk_rates' not described in 'sdhci_s3c'
> drivers/mmc/host/sdhci-s3c.c:126: warning: Function parameter or member 'no_divider' not described in 'sdhci_s3c'
> drivers/mmc/host/sdhci-s3c.c:139: warning: Function parameter or member 'no_divider' not described in 'sdhci_s3c_drv_data'
>
> Cc: Adrian Hunter <[email protected]>
> Cc: Ben Dooks <[email protected]>
> Cc: Jaehoon Chung <[email protected]>
> Signed-off-by: Lee Jones <[email protected]>

Reviewed-by: Jaehoon Chung <[email protected]>

> ---
> drivers/mmc/host/sdhci-s3c.c | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/drivers/mmc/host/sdhci-s3c.c b/drivers/mmc/host/sdhci-s3c.c
> index 64200c78e90dc..9194bb73e601b 100644
> --- a/drivers/mmc/host/sdhci-s3c.c
> +++ b/drivers/mmc/host/sdhci-s3c.c
> @@ -107,8 +107,11 @@
> * @ioarea: The resource created when we claimed the IO area.
> * @pdata: The platform data for this controller.
> * @cur_clk: The index of the current bus clock.
> + * @ext_cd_irq: External card detect interrupt.
> * @clk_io: The clock for the internal bus interface.
> + * @clk_rates: Clock frequencies.
> * @clk_bus: The clocks that are available for the SD/MMC bus clock.
> + * @no_divider: No or non-standard internal clock divider.
> */
> struct sdhci_s3c {
> struct sdhci_host *host;
> @@ -128,6 +131,7 @@ struct sdhci_s3c {
> /**
> * struct sdhci_s3c_driver_data - S3C SDHCI platform specific driver data
> * @sdhci_quirks: sdhci host specific quirks.
> + * @no_divider: no or non-standard internal clock divider.
> *
> * Specifies platform specific configuration of sdhci controller.
> * Note: A structure for driver specific platform data is used for future
>