diff mbox series

[5/6] mmc: zynq_sdhci: Fix kernel doc warnings

Message ID 20210709071716.17093-6-ashok.reddy.soma@xilinx.com
State Superseded
Delegated to: Michal Simek
Headers show
Series This patch set fixes minor issues related to tapdelays | expand

Commit Message

Ashok Reddy Soma July 9, 2021, 7:17 a.m. UTC
From: Michal Simek <michal.simek@xilinx.com>

Fix these kernel doc warnings:
drivers/mmc/zynq_sdhci.c:181: warning: contents before sections
drivers/mmc/zynq_sdhci.c:187: warning: Function parameter or member 'degrees' not described in 'sdhci_zynqmp_sdcardclk_set_phase'
drivers/mmc/zynq_sdhci.c:236: warning: contents before sections
drivers/mmc/zynq_sdhci.c:242: warning: Function parameter or member 'degrees' not described in 'sdhci_zynqmp_sampleclk_set_phase'
drivers/mmc/zynq_sdhci.c:291: warning: contents before sections
drivers/mmc/zynq_sdhci.c:297: warning: Function parameter or member 'degrees' not described in 'sdhci_versal_sdcardclk_set_phase'
drivers/mmc/zynq_sdhci.c:354: warning: contents before sections
drivers/mmc/zynq_sdhci.c:360: warning: Function parameter or member 'degrees' not described in 'sdhci_versal_sampleclk_set_phase'
drivers/mmc/zynq_sdhci.c:467: warning: contents before sections

Signed-off-by: Michal Simek <michal.simek@xilinx.com>
Signed-off-by: Ashok Reddy Soma <ashok.reddy.soma@xilinx.com>
---

 drivers/mmc/zynq_sdhci.c | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

Comments

Jaehoon Chung July 9, 2021, 9:42 a.m. UTC | #1
Hi Ashok,

On 7/9/21 4:17 PM, Ashok Reddy Soma wrote:
> From: Michal Simek <michal.simek@xilinx.com>
> 
> Fix these kernel doc warnings:
> drivers/mmc/zynq_sdhci.c:181: warning: contents before sections
> drivers/mmc/zynq_sdhci.c:187: warning: Function parameter or member 'degrees' not described in 'sdhci_zynqmp_sdcardclk_set_phase'
> drivers/mmc/zynq_sdhci.c:236: warning: contents before sections
> drivers/mmc/zynq_sdhci.c:242: warning: Function parameter or member 'degrees' not described in 'sdhci_zynqmp_sampleclk_set_phase'
> drivers/mmc/zynq_sdhci.c:291: warning: contents before sections
> drivers/mmc/zynq_sdhci.c:297: warning: Function parameter or member 'degrees' not described in 'sdhci_versal_sdcardclk_set_phase'
> drivers/mmc/zynq_sdhci.c:354: warning: contents before sections
> drivers/mmc/zynq_sdhci.c:360: warning: Function parameter or member 'degrees' not described in 'sdhci_versal_sampleclk_set_phase'
> drivers/mmc/zynq_sdhci.c:467: warning: contents before sections

I didn't understand this patch. You are changing from "@degrees:" to "@degree" on [PATCH 1/6].
But reverted them in this patch.

Best Regards,
Jaehoon Chung


> 
> Signed-off-by: Michal Simek <michal.simek@xilinx.com>
> Signed-off-by: Ashok Reddy Soma <ashok.reddy.soma@xilinx.com>
> ---
> 
>  drivers/mmc/zynq_sdhci.c | 28 ++++++++++++++--------------
>  1 file changed, 14 insertions(+), 14 deletions(-)
> 
> diff --git a/drivers/mmc/zynq_sdhci.c b/drivers/mmc/zynq_sdhci.c
> index 926569f5d0..1e6efb1cd4 100644
> --- a/drivers/mmc/zynq_sdhci.c
> +++ b/drivers/mmc/zynq_sdhci.c
> @@ -181,11 +181,11 @@ static int arasan_sdhci_execute_tuning(struct mmc *mmc, u8 opcode)
>  /**
>   * sdhci_zynqmp_sdcardclk_set_phase - Set the SD Output Clock Tap Delays
>   *
> - * Set the SD Output Clock Tap Delays for Output path
> - *
>   * @host:		Pointer to the sdhci_host structure.
> - * @degrees		The clock phase shift between 0 - 359.
> + * @degrees:		The clock phase shift between 0 - 359.
>   * Return: 0
> + *
> + * Set the SD Output Clock Tap Delays for Output path
>   */
>  static int sdhci_zynqmp_sdcardclk_set_phase(struct sdhci_host *host,
>  					    int degrees)
> @@ -237,11 +237,11 @@ static int sdhci_zynqmp_sdcardclk_set_phase(struct sdhci_host *host,
>  /**
>   * sdhci_zynqmp_sampleclk_set_phase - Set the SD Input Clock Tap Delays
>   *
> - * Set the SD Input Clock Tap Delays for Input path
> - *
>   * @host:		Pointer to the sdhci_host structure.
> - * @degrees		The clock phase shift between 0 - 359.
> + * @degrees:		The clock phase shift between 0 - 359.
>   * Return: 0
> + *
> + * Set the SD Input Clock Tap Delays for Input path
>   */
>  static int sdhci_zynqmp_sampleclk_set_phase(struct sdhci_host *host,
>  					    int degrees)
> @@ -293,11 +293,11 @@ static int sdhci_zynqmp_sampleclk_set_phase(struct sdhci_host *host,
>  /**
>   * sdhci_versal_sdcardclk_set_phase - Set the SD Output Clock Tap Delays
>   *
> - * Set the SD Output Clock Tap Delays for Output path
> - *
>   * @host:		Pointer to the sdhci_host structure.
> - * @degrees		The clock phase shift between 0 - 359.
> + * @degrees:		The clock phase shift between 0 - 359.
>   * Return: 0
> + *
> + * Set the SD Output Clock Tap Delays for Output path
>   */
>  static int sdhci_versal_sdcardclk_set_phase(struct sdhci_host *host,
>  					    int degrees)
> @@ -355,11 +355,11 @@ static int sdhci_versal_sdcardclk_set_phase(struct sdhci_host *host,
>  /**
>   * sdhci_versal_sampleclk_set_phase - Set the SD Input Clock Tap Delays
>   *
> - * Set the SD Input Clock Tap Delays for Input path
> - *
>   * @host:		Pointer to the sdhci_host structure.
> - * @degrees		The clock phase shift between 0 - 359.
> + * @degrees:		The clock phase shift between 0 - 359.
>   * Return: 0
> + *
> + * Set the SD Input Clock Tap Delays for Input path
>   */
>  static int sdhci_versal_sampleclk_set_phase(struct sdhci_host *host,
>  					    int degrees)
> @@ -467,9 +467,9 @@ static void arasan_dt_read_clk_phase(struct udevice *dev, unsigned char timing,
>  /**
>   * arasan_dt_parse_clk_phases - Read Tap Delay values from DT
>   *
> - * Called at initialization to parse the values of Tap Delays.
> - *
>   * @dev:                Pointer to our struct udevice.
> + *
> + * Called at initialization to parse the values of Tap Delays.
>   */
>  static void arasan_dt_parse_clk_phases(struct udevice *dev)
>  {
>
Ashok Reddy Soma July 9, 2021, 10:18 a.m. UTC | #2
Hi Jaehoon,

> -----Original Message-----
> From: Jaehoon Chung <jh80.chung@samsung.com>
> Sent: Friday, July 9, 2021 3:12 PM
> To: Ashok Reddy Soma <ashokred@xilinx.com>; u-boot@lists.denx.de
> Cc: peng.fan@nxp.com; git <git@xilinx.com>; monstr@monstr.eu;
> somaashokreddy@gmail.com; Michal Simek <michals@xilinx.com>
> Subject: Re: [PATCH 5/6] mmc: zynq_sdhci: Fix kernel doc warnings
> 
> Hi Ashok,
> 
> On 7/9/21 4:17 PM, Ashok Reddy Soma wrote:
> > From: Michal Simek <michal.simek@xilinx.com>
> >
> > Fix these kernel doc warnings:
> > drivers/mmc/zynq_sdhci.c:181: warning: contents before sections
> > drivers/mmc/zynq_sdhci.c:187: warning: Function parameter or member
> 'degrees' not described in 'sdhci_zynqmp_sdcardclk_set_phase'
> > drivers/mmc/zynq_sdhci.c:236: warning: contents before sections
> > drivers/mmc/zynq_sdhci.c:242: warning: Function parameter or member
> 'degrees' not described in 'sdhci_zynqmp_sampleclk_set_phase'
> > drivers/mmc/zynq_sdhci.c:291: warning: contents before sections
> > drivers/mmc/zynq_sdhci.c:297: warning: Function parameter or member
> 'degrees' not described in 'sdhci_versal_sdcardclk_set_phase'
> > drivers/mmc/zynq_sdhci.c:354: warning: contents before sections
> > drivers/mmc/zynq_sdhci.c:360: warning: Function parameter or member
> 'degrees' not described in 'sdhci_versal_sampleclk_set_phase'
> > drivers/mmc/zynq_sdhci.c:467: warning: contents before sections
> 
> I didn't understand this patch. You are changing from "@degrees:" to
> "@degree" on [PATCH 1/6].
> But reverted them in this patch.

I made a mistake in patch 1/6, Michal corrected it in this patch. 
I will correct/move this change to 1/6 and send V2.

Thanks,
Ashok

> 
> Best Regards,
> Jaehoon Chung
> 
> 
> >
> > Signed-off-by: Michal Simek <michal.simek@xilinx.com>
> > Signed-off-by: Ashok Reddy Soma <ashok.reddy.soma@xilinx.com>
> > ---
> >
> >  drivers/mmc/zynq_sdhci.c | 28 ++++++++++++++--------------
> >  1 file changed, 14 insertions(+), 14 deletions(-)
> >
> > diff --git a/drivers/mmc/zynq_sdhci.c b/drivers/mmc/zynq_sdhci.c index
> > 926569f5d0..1e6efb1cd4 100644
> > --- a/drivers/mmc/zynq_sdhci.c
> > +++ b/drivers/mmc/zynq_sdhci.c
> > @@ -181,11 +181,11 @@ static int arasan_sdhci_execute_tuning(struct
> > mmc *mmc, u8 opcode)
> >  /**
> >   * sdhci_zynqmp_sdcardclk_set_phase - Set the SD Output Clock Tap Delays
> >   *
> > - * Set the SD Output Clock Tap Delays for Output path
> > - *
> >   * @host:		Pointer to the sdhci_host structure.
> > - * @degrees		The clock phase shift between 0 - 359.
> > + * @degrees:		The clock phase shift between 0 - 359.
> >   * Return: 0
> > + *
> > + * Set the SD Output Clock Tap Delays for Output path
> >   */
> >  static int sdhci_zynqmp_sdcardclk_set_phase(struct sdhci_host *host,
> >  					    int degrees)
> > @@ -237,11 +237,11 @@ static int
> > sdhci_zynqmp_sdcardclk_set_phase(struct sdhci_host *host,
> >  /**
> >   * sdhci_zynqmp_sampleclk_set_phase - Set the SD Input Clock Tap Delays
> >   *
> > - * Set the SD Input Clock Tap Delays for Input path
> > - *
> >   * @host:		Pointer to the sdhci_host structure.
> > - * @degrees		The clock phase shift between 0 - 359.
> > + * @degrees:		The clock phase shift between 0 - 359.
> >   * Return: 0
> > + *
> > + * Set the SD Input Clock Tap Delays for Input path
> >   */
> >  static int sdhci_zynqmp_sampleclk_set_phase(struct sdhci_host *host,
> >  					    int degrees)
> > @@ -293,11 +293,11 @@ static int
> > sdhci_zynqmp_sampleclk_set_phase(struct sdhci_host *host,
> >  /**
> >   * sdhci_versal_sdcardclk_set_phase - Set the SD Output Clock Tap Delays
> >   *
> > - * Set the SD Output Clock Tap Delays for Output path
> > - *
> >   * @host:		Pointer to the sdhci_host structure.
> > - * @degrees		The clock phase shift between 0 - 359.
> > + * @degrees:		The clock phase shift between 0 - 359.
> >   * Return: 0
> > + *
> > + * Set the SD Output Clock Tap Delays for Output path
> >   */
> >  static int sdhci_versal_sdcardclk_set_phase(struct sdhci_host *host,
> >  					    int degrees)
> > @@ -355,11 +355,11 @@ static int
> > sdhci_versal_sdcardclk_set_phase(struct sdhci_host *host,
> >  /**
> >   * sdhci_versal_sampleclk_set_phase - Set the SD Input Clock Tap Delays
> >   *
> > - * Set the SD Input Clock Tap Delays for Input path
> > - *
> >   * @host:		Pointer to the sdhci_host structure.
> > - * @degrees		The clock phase shift between 0 - 359.
> > + * @degrees:		The clock phase shift between 0 - 359.
> >   * Return: 0
> > + *
> > + * Set the SD Input Clock Tap Delays for Input path
> >   */
> >  static int sdhci_versal_sampleclk_set_phase(struct sdhci_host *host,
> >  					    int degrees)
> > @@ -467,9 +467,9 @@ static void arasan_dt_read_clk_phase(struct
> > udevice *dev, unsigned char timing,
> >  /**
> >   * arasan_dt_parse_clk_phases - Read Tap Delay values from DT
> >   *
> > - * Called at initialization to parse the values of Tap Delays.
> > - *
> >   * @dev:                Pointer to our struct udevice.
> > + *
> > + * Called at initialization to parse the values of Tap Delays.
> >   */
> >  static void arasan_dt_parse_clk_phases(struct udevice *dev)  {
> >
diff mbox series

Patch

diff --git a/drivers/mmc/zynq_sdhci.c b/drivers/mmc/zynq_sdhci.c
index 926569f5d0..1e6efb1cd4 100644
--- a/drivers/mmc/zynq_sdhci.c
+++ b/drivers/mmc/zynq_sdhci.c
@@ -181,11 +181,11 @@  static int arasan_sdhci_execute_tuning(struct mmc *mmc, u8 opcode)
 /**
  * sdhci_zynqmp_sdcardclk_set_phase - Set the SD Output Clock Tap Delays
  *
- * Set the SD Output Clock Tap Delays for Output path
- *
  * @host:		Pointer to the sdhci_host structure.
- * @degrees		The clock phase shift between 0 - 359.
+ * @degrees:		The clock phase shift between 0 - 359.
  * Return: 0
+ *
+ * Set the SD Output Clock Tap Delays for Output path
  */
 static int sdhci_zynqmp_sdcardclk_set_phase(struct sdhci_host *host,
 					    int degrees)
@@ -237,11 +237,11 @@  static int sdhci_zynqmp_sdcardclk_set_phase(struct sdhci_host *host,
 /**
  * sdhci_zynqmp_sampleclk_set_phase - Set the SD Input Clock Tap Delays
  *
- * Set the SD Input Clock Tap Delays for Input path
- *
  * @host:		Pointer to the sdhci_host structure.
- * @degrees		The clock phase shift between 0 - 359.
+ * @degrees:		The clock phase shift between 0 - 359.
  * Return: 0
+ *
+ * Set the SD Input Clock Tap Delays for Input path
  */
 static int sdhci_zynqmp_sampleclk_set_phase(struct sdhci_host *host,
 					    int degrees)
@@ -293,11 +293,11 @@  static int sdhci_zynqmp_sampleclk_set_phase(struct sdhci_host *host,
 /**
  * sdhci_versal_sdcardclk_set_phase - Set the SD Output Clock Tap Delays
  *
- * Set the SD Output Clock Tap Delays for Output path
- *
  * @host:		Pointer to the sdhci_host structure.
- * @degrees		The clock phase shift between 0 - 359.
+ * @degrees:		The clock phase shift between 0 - 359.
  * Return: 0
+ *
+ * Set the SD Output Clock Tap Delays for Output path
  */
 static int sdhci_versal_sdcardclk_set_phase(struct sdhci_host *host,
 					    int degrees)
@@ -355,11 +355,11 @@  static int sdhci_versal_sdcardclk_set_phase(struct sdhci_host *host,
 /**
  * sdhci_versal_sampleclk_set_phase - Set the SD Input Clock Tap Delays
  *
- * Set the SD Input Clock Tap Delays for Input path
- *
  * @host:		Pointer to the sdhci_host structure.
- * @degrees		The clock phase shift between 0 - 359.
+ * @degrees:		The clock phase shift between 0 - 359.
  * Return: 0
+ *
+ * Set the SD Input Clock Tap Delays for Input path
  */
 static int sdhci_versal_sampleclk_set_phase(struct sdhci_host *host,
 					    int degrees)
@@ -467,9 +467,9 @@  static void arasan_dt_read_clk_phase(struct udevice *dev, unsigned char timing,
 /**
  * arasan_dt_parse_clk_phases - Read Tap Delay values from DT
  *
- * Called at initialization to parse the values of Tap Delays.
- *
  * @dev:                Pointer to our struct udevice.
+ *
+ * Called at initialization to parse the values of Tap Delays.
  */
 static void arasan_dt_parse_clk_phases(struct udevice *dev)
 {