mbox series

[v4,0/5] SDHCI clock handling fixes and cleanups

Message ID cover.1627204633.git.mirq-linux@rere.qmqm.pl
Headers show
Series SDHCI clock handling fixes and cleanups | expand

Message

Michał Mirosław July 25, 2021, 9:20 a.m. UTC
This patch set combines a few of code improvements for SDHCI clock
handling. First three are small fixes to the code, next two make
the clock calculation code simpler.

Michał Mirosław (5):
  mmc: sdhci: fix base clock usage in preset value
  mmc: sdhci: always obey programmable clock config in preset value
  mmc: sdhci: fix SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN
  mmc: sdhci: move SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN frequency limit
  mmc: sdhci: simplify v2/v3+ clock calculation

 drivers/mmc/host/sdhci-of-arasan.c  |  11 +--
 drivers/mmc/host/sdhci-of-dwcmshc.c |   8 +-
 drivers/mmc/host/sdhci.c            | 123 +++++++++++++---------------
 drivers/mmc/host/sdhci.h            |   4 +-
 4 files changed, 67 insertions(+), 79 deletions(-)

Comments

Adrian Hunter Aug. 4, 2021, 10:50 a.m. UTC | #1
On 25/07/21 12:20 pm, Michał Mirosław wrote:
> Fixed commit added an unnecessary read of CLOCK_CONTROL. The value read

> is overwritten for programmable clock preset, but is carried over for

> divided clock preset. This can confuse sdhci_enable_clk() if the register

> has enable bits set for some reason at time time of clock calculation.


"time time" -> "time"

> Remove the read.

> 

> Quoting Al Cooper:

> 

> sdhci_brcmstb_set_clock() assumed that sdhci_calc_clk() would always

> return the divider value without the enable set, so this fixes a case

> for DDR52 where the enable was not being cleared when the divider

> value was changed.

> 

> Cc: stable@vger.kernel.org

> Fixes: 52983382c74f ("mmc: sdhci: enhance preset value function")

> Signed-off-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>

> Acked-by: Al Cooper <alcooperx@gmail.com>


Apart from above:

Acked-by: Adrian Hunter <adrian.hunter@intel.com>


> 

> ---

> v4: no changes

> v3: updated commit message

> v2: removed truncated sentence from commitmsg

> 

> Signed-off-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>

> ---

>  drivers/mmc/host/sdhci.c | 1 -

>  1 file changed, 1 deletion(-)

> 

> diff --git a/drivers/mmc/host/sdhci.c b/drivers/mmc/host/sdhci.c

> index aba6e10b8605..c7438dd13e3e 100644

> --- a/drivers/mmc/host/sdhci.c

> +++ b/drivers/mmc/host/sdhci.c

> @@ -1857,7 +1857,6 @@ u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,

>  		if (host->preset_enabled) {

>  			u16 pre_val;

>  

> -			clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL);

>  			pre_val = sdhci_get_preset_value(host);

>  			div = FIELD_GET(SDHCI_PRESET_SDCLK_FREQ_MASK, pre_val);

>  			if (host->clk_mul &&

>
Adrian Hunter Aug. 4, 2021, 11:06 a.m. UTC | #2
On 25/07/21 12:20 pm, Michał Mirosław wrote:
> Fix returned clock rate for SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN case.

> This fixes real_div value that was calculated as 1 (meaning no division)

> instead of 2 with the quirk enabled.

> 

> Cc: stable@kernel.vger.org

> Fixes: d1955c3a9a1d ("mmc: sdhci: add quirk SDHCI_QUIRK_CLOCK_DIV_ZERO_BROKEN")

> Signed-off-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>


Notwithstanding comment below:

Acked-by: Adrian Hunter <adrian.hunter@intel.com>



> ---

> v4: no changes

> v3: updated commit message

> v2: no changes

> ---

>  drivers/mmc/host/sdhci.c | 10 +++++-----

>  1 file changed, 5 insertions(+), 5 deletions(-)

> 

> diff --git a/drivers/mmc/host/sdhci.c b/drivers/mmc/host/sdhci.c

> index 3ab60e7f936b..0993f7d0ce8e 100644

> --- a/drivers/mmc/host/sdhci.c

> +++ b/drivers/mmc/host/sdhci.c

> @@ -1903,9 +1903,12 @@ u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,

>  

>  		if (!host->clk_mul || switch_base_clk) {

>  			/* Version 3.00 divisors must be a multiple of 2. */

> -			if (host->max_clk <= clock)

> +			if (host->max_clk <= clock) {

>  				div = 1;

> -			else {

> +				if ((host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN)

> +					&& host->max_clk <= 25000000)


It is preferred to line break after '&&' and line up e.g.

				if ((host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN) &&
				    host->max_clk <= 25000000)


> +					div = 2;

> +			} else {

>  				for (div = 2; div < SDHCI_MAX_DIV_SPEC_300;

>  				     div += 2) {

>  					if ((host->max_clk / div) <= clock)

> @@ -1914,9 +1917,6 @@ u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,

>  			}

>  			real_div = div;

>  			div >>= 1;

> -			if ((host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN)

> -				&& !div && host->max_clk <= 25000000)

> -				div = 1;

>  		}

>  	} else {

>  		/* Version 2.00 divisors must be a power of 2. */

>
Adrian Hunter Aug. 4, 2021, 12:40 p.m. UTC | #3
On 25/07/21 12:20 pm, Michał Mirosław wrote:
> For base clock setting, SDHCI V2 differs from V3+ only in allowed divisor

> values.  Remove the duplicate version of code and reduce indentation

> levels.  We can see now, that 'real_div' can't be zero, so the check is

> removed.  While at it, replace divisor search loops with divide-and-clamp

> to make the code even more readable.


It doesn't seem simpler to me, just different.

Simpler would mean broken into separate logical functions, getting rid of
the gotos, and above all having the changes broken into separate patches
for easy review.

> 

> Signed-off-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>

> ---

> v4: no changes

> v3: squashed div-conversion and deduplication patches to avoid code churn

> v2: no changes

> ---

>  drivers/mmc/host/sdhci.c | 124 ++++++++++++++++++---------------------

>  drivers/mmc/host/sdhci.h |   4 +-

>  2 files changed, 58 insertions(+), 70 deletions(-)

> 

> diff --git a/drivers/mmc/host/sdhci.c b/drivers/mmc/host/sdhci.c

> index cfa314e659bc..90bda4150083 100644

> --- a/drivers/mmc/host/sdhci.c

> +++ b/drivers/mmc/host/sdhci.c

> @@ -1848,88 +1848,76 @@ static u16 sdhci_get_preset_value(struct sdhci_host *host)

>  u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,

>  		   unsigned int *actual_clock)

>  {

> -	int div = 0; /* Initialized for compiler warning */

> -	int real_div = div, clk_mul = 1;

> +	unsigned int div, real_div, clk_mul = 1;

>  	u16 clk = 0;

> -	bool switch_base_clk = false;

>  

> -	if (host->version >= SDHCI_SPEC_300) {

> -		if (host->preset_enabled) {

> -			u16 pre_val;

> +	if (clock == 0)

> +		return clk;

> +

> +	if (host->preset_enabled) {

> +		/* Only version 3.00+ can have preset_enabled */

> +		u16 pre_val;

> +

> +		pre_val = sdhci_get_preset_value(host);

> +		div = FIELD_GET(SDHCI_PRESET_SDCLK_FREQ_MASK, pre_val);

> +		if (!(pre_val & SDHCI_PRESET_CLKGEN_SEL))

> +			goto base_div_set;

> +

> +		clk = SDHCI_PROG_CLOCK_MODE;

> +		real_div = div + 1;

> +		clk_mul = host->clk_mul;

> +		if (!clk_mul) {

> +			/* The clock frequency is unknown. Assume undivided base. */

> +			clk_mul = 1;

> +		}

> +

> +		goto clock_set;

> +	}

> +

> +	/*

> +	 * Check if the Host Controller supports Programmable Clock

> +	 * Mode.

> +	 */

> +	if (host->version >= SDHCI_SPEC_300 && host->clk_mul) {

> +		div = DIV_ROUND_UP(host->max_clk * host->clk_mul, clock);

> +		if (div <= SDHCI_MAX_DIV_SPEC_300 / 2 + 1) {

> +			/*

> +			 * Set Programmable Clock Mode in the Clock

> +			 * Control register.

> +			 */

> +			clk = SDHCI_PROG_CLOCK_MODE;

> +			clk_mul = host->clk_mul;

> +			real_div = div--;

>  

> -			pre_val = sdhci_get_preset_value(host);

> -			div = FIELD_GET(SDHCI_PRESET_SDCLK_FREQ_MASK, pre_val);

> -			if (pre_val & SDHCI_PRESET_CLKGEN_SEL) {

> -				clk = SDHCI_PROG_CLOCK_MODE;

> -				real_div = div + 1;

> -				clk_mul = host->clk_mul;

> -				if (!clk_mul) {

> -					/* The clock frequency is unknown. Assume undivided base. */

> -					clk_mul = 1;

> -				}

> -			} else {

> -				real_div = max_t(int, 1, div << 1);

> -			}

>  			goto clock_set;

>  		}

>  

>  		/*

> -		 * Check if the Host Controller supports Programmable Clock

> -		 * Mode.

> +		 * Divisor is too big for requested clock rate.

> +		 * Fall back to the base clock.

>  		 */

> -		if (host->clk_mul) {

> -			for (div = 1; div <= 1024; div++) {

> -				if ((host->max_clk * host->clk_mul / div)

> -					<= clock)

> -					break;

> -			}

> -			if ((host->max_clk * host->clk_mul / div) <= clock) {

> -				/*

> -				 * Set Programmable Clock Mode in the Clock

> -				 * Control register.

> -				 */

> -				clk = SDHCI_PROG_CLOCK_MODE;

> -				real_div = div;

> -				clk_mul = host->clk_mul;

> -				div--;

> -			} else {

> -				/*

> -				 * Divisor can be too small to reach clock

> -				 * speed requirement. Then use the base clock.

> -				 */

> -				switch_base_clk = true;

> -			}

> -		}

> +	}

>  

> -		if (!host->clk_mul || switch_base_clk) {

> -			/* Version 3.00 divisors must be a multiple of 2. */

> -			if (host->max_clk <= clock) {

> -				div = 1;

> -				if (host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN)

> -					div = 2;

> -			} else {

> -				for (div = 2; div < SDHCI_MAX_DIV_SPEC_300;

> -				     div += 2) {

> -					if ((host->max_clk / div) <= clock)

> -						break;

> -				}

> -			}

> -			real_div = div;

> -			div >>= 1;

> -		}

> +	div = DIV_ROUND_UP(host->max_clk, clock);

> +

> +	if (div == 1 && (host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN))

> +		div = 2;

> +

> +	if (host->version >= SDHCI_SPEC_300) {

> +		/* Version 3.00 divisors must be a multiple of 2. */

> +		div = min(div, SDHCI_MAX_DIV_SPEC_300);

> +		div = DIV_ROUND_UP(div, 2);

>  	} else {

>  		/* Version 2.00 divisors must be a power of 2. */

> -		for (div = 1; div < SDHCI_MAX_DIV_SPEC_200; div *= 2) {

> -			if ((host->max_clk / div) <= clock)

> -				break;

> -		}

> -		real_div = div;

> -		div >>= 1;

> +		div = min(div, SDHCI_MAX_DIV_SPEC_200);

> +		div = roundup_pow_of_two(div) / 2;

>  	}

>  

> +base_div_set:

> +	real_div = div * 2 + !div;

> +

>  clock_set:

> -	if (real_div)

> -		*actual_clock = (host->max_clk * clk_mul) / real_div;

> +	*actual_clock = (host->max_clk * clk_mul) / real_div;

>  	clk |= (div & SDHCI_DIV_MASK) << SDHCI_DIVIDER_SHIFT;

>  	clk |= ((div & SDHCI_DIV_HI_MASK) >> SDHCI_DIV_MASK_LEN)

>  		<< SDHCI_DIVIDER_HI_SHIFT;

> diff --git a/drivers/mmc/host/sdhci.h b/drivers/mmc/host/sdhci.h

> index 074dc182b184..a3fa70d91410 100644

> --- a/drivers/mmc/host/sdhci.h

> +++ b/drivers/mmc/host/sdhci.h

> @@ -284,8 +284,8 @@

>   * End of controller registers.

>   */

>  

> -#define SDHCI_MAX_DIV_SPEC_200	256

> -#define SDHCI_MAX_DIV_SPEC_300	2046

> +#define SDHCI_MAX_DIV_SPEC_200	256u

> +#define SDHCI_MAX_DIV_SPEC_300	2046u

>  

>  /*

>   * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.

>
Michał Mirosław Aug. 7, 2021, 2:08 p.m. UTC | #4
On Wed, Aug 04, 2021 at 02:06:55PM +0300, Adrian Hunter wrote:
> On 25/07/21 12:20 pm, Michał Mirosław wrote:

> > Fix returned clock rate for SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN case.

> > This fixes real_div value that was calculated as 1 (meaning no division)

> > instead of 2 with the quirk enabled.

> > 

> > Cc: stable@kernel.vger.org

> > Fixes: d1955c3a9a1d ("mmc: sdhci: add quirk SDHCI_QUIRK_CLOCK_DIV_ZERO_BROKEN")

> > Signed-off-by: Michał Mirosław <mirq-linux@rere.qmqm.pl>

> 

> Notwithstanding comment below:

> 

> Acked-by: Adrian Hunter <adrian.hunter@intel.com>

[...]
> > --- a/drivers/mmc/host/sdhci.c

> > +++ b/drivers/mmc/host/sdhci.c

> > @@ -1903,9 +1903,12 @@ u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,

> >  

> >  		if (!host->clk_mul || switch_base_clk) {

> >  			/* Version 3.00 divisors must be a multiple of 2. */

> > -			if (host->max_clk <= clock)

> > +			if (host->max_clk <= clock) {

> >  				div = 1;

> > -			else {

> > +				if ((host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN)

> > +					&& host->max_clk <= 25000000)

> 

> It is preferred to line break after '&&' and line up e.g.

> 

> 				if ((host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN) &&

> 				    host->max_clk <= 25000000)


This was just old code moved, but fixed for next version.

> 

> 

> > +					div = 2;

> > +			} else {

> >  				for (div = 2; div < SDHCI_MAX_DIV_SPEC_300;

> >  				     div += 2) {

> >  					if ((host->max_clk / div) <= clock)

> > @@ -1914,9 +1917,6 @@ u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,

> >  			}

> >  			real_div = div;

> >  			div >>= 1;

> > -			if ((host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN)

> > -				&& !div && host->max_clk <= 25000000)

> > -				div = 1;

> >  		}

> >  	} else {

> >  		/* Version 2.00 divisors must be a power of 2. */

> > 

>
Michał Mirosław Aug. 7, 2021, 3:39 p.m. UTC | #5
On Wed, Aug 04, 2021 at 03:40:38PM +0300, Adrian Hunter wrote:
> On 25/07/21 12:20 pm, Michał Mirosław wrote:
> > For base clock setting, SDHCI V2 differs from V3+ only in allowed divisor
> > values.  Remove the duplicate version of code and reduce indentation
> > levels.  We can see now, that 'real_div' can't be zero, so the check is
> > removed.  While at it, replace divisor search loops with divide-and-clamp
> > to make the code even more readable.
> 
> It doesn't seem simpler to me, just different.
> 
> Simpler would mean broken into separate logical functions, getting rid of
> the gotos, and above all having the changes broken into separate patches
> for easy review.

I've extracted part of the function. It does look better I think, but it
can be improved. Please take a look.

--->8<---

    mmc: sdhci: rework clock calculation
    
    Rework the code by extracting register value and real clock rate
    calculations to a separate function.  This also removes duplicated
    calculations of real_div and divisor search loops.

diff --git a/drivers/mmc/host/sdhci.c b/drivers/mmc/host/sdhci.c
index cfa314e659bc..9822903841f1 100644
--- a/drivers/mmc/host/sdhci.c
+++ b/drivers/mmc/host/sdhci.c
@@ -1845,97 +1845,79 @@ static u16 sdhci_get_preset_value(struct sdhci_host *host)
 	return preset;
 }
 
-u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,
+static u16 sdhci_calc_clk_mode(struct sdhci_host *host, int div, bool prog_mode,
 		   unsigned int *actual_clock)
 {
-	int div = 0; /* Initialized for compiler warning */
-	int real_div = div, clk_mul = 1;
+	unsigned int clk_mul, real_div;
 	u16 clk = 0;
-	bool switch_base_clk = false;
-
-	if (host->version >= SDHCI_SPEC_300) {
-		if (host->preset_enabled) {
-			u16 pre_val;
-
-			pre_val = sdhci_get_preset_value(host);
-			div = FIELD_GET(SDHCI_PRESET_SDCLK_FREQ_MASK, pre_val);
-			if (pre_val & SDHCI_PRESET_CLKGEN_SEL) {
-				clk = SDHCI_PROG_CLOCK_MODE;
-				real_div = div + 1;
-				clk_mul = host->clk_mul;
-				if (!clk_mul) {
-					/* The clock frequency is unknown. Assume undivided base. */
-					clk_mul = 1;
-				}
-			} else {
-				real_div = max_t(int, 1, div << 1);
-			}
-			goto clock_set;
-		}
-
-		/*
-		 * Check if the Host Controller supports Programmable Clock
-		 * Mode.
-		 */
-		if (host->clk_mul) {
-			for (div = 1; div <= 1024; div++) {
-				if ((host->max_clk * host->clk_mul / div)
-					<= clock)
-					break;
-			}
-			if ((host->max_clk * host->clk_mul / div) <= clock) {
-				/*
-				 * Set Programmable Clock Mode in the Clock
-				 * Control register.
-				 */
-				clk = SDHCI_PROG_CLOCK_MODE;
-				real_div = div;
-				clk_mul = host->clk_mul;
-				div--;
-			} else {
-				/*
-				 * Divisor can be too small to reach clock
-				 * speed requirement. Then use the base clock.
-				 */
-				switch_base_clk = true;
-			}
-		}
 
-		if (!host->clk_mul || switch_base_clk) {
-			/* Version 3.00 divisors must be a multiple of 2. */
-			if (host->max_clk <= clock) {
-				div = 1;
-				if (host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN)
-					div = 2;
-			} else {
-				for (div = 2; div < SDHCI_MAX_DIV_SPEC_300;
-				     div += 2) {
-					if ((host->max_clk / div) <= clock)
-						break;
-				}
-			}
-			real_div = div;
-			div >>= 1;
-		}
+	if (prog_mode) {
+		clk = SDHCI_PROG_CLOCK_MODE;
+		clk_mul = host->max_clk ?: 1;
+		real_div = div + 1;
 	} else {
-		/* Version 2.00 divisors must be a power of 2. */
-		for (div = 1; div < SDHCI_MAX_DIV_SPEC_200; div *= 2) {
-			if ((host->max_clk / div) <= clock)
-				break;
-		}
-		real_div = div;
-		div >>= 1;
+		clk_mul = 1;
+		real_div = div * 2 + !div;
 	}
 
-clock_set:
-	if (real_div)
-		*actual_clock = (host->max_clk * clk_mul) / real_div;
+	*actual_clock = (host->max_clk * clk_mul) / real_div;
+
 	clk |= (div & SDHCI_DIV_MASK) << SDHCI_DIVIDER_SHIFT;
 	clk |= ((div & SDHCI_DIV_HI_MASK) >> SDHCI_DIV_MASK_LEN)
 		<< SDHCI_DIVIDER_HI_SHIFT;
 
 	return clk;
 }
+
+u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock,
+		   unsigned int *actual_clock)
+{
+	unsigned int div;
+
+	if (clock == 0)
+		return 0;
+
+	if (host->preset_enabled) {
+		/* Note: Only version 3.00+ can have preset_enabled. */
+
+		u16 pre_val = sdhci_get_preset_value(host);
+		bool prog_mode = !!(pre_val & SDHCI_PRESET_CLKGEN_SEL);
+		div = FIELD_GET(SDHCI_PRESET_SDCLK_FREQ_MASK, pre_val);
+
+		return sdhci_calc_clk_mode(host, div, prog_mode, actual_clock);
+	}
+
+	if (host->version >= SDHCI_SPEC_300 && host->clk_mul) {
+		/* Programmable Clock Mode is supported. */
+
+		div = DIV_ROUND_UP(host->max_clk * host->clk_mul, clock) - 1;
+		if (div <= SDHCI_MAX_DIV_SPEC_300 / 2)
+			return sdhci_calc_clk_mode(host, div, true, actual_clock);
+
+		/*
+		 * Divisor is too big for requested clock rate.
+		 * Fall back to the base clock.
+		 */
+	}
+
+	div = DIV_ROUND_UP(host->max_clk, clock);
+
+	if (div == 1 && (host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN))
+		div = 2;
+
+	if (host->version >= SDHCI_SPEC_300) {
+		/* Version 3.00 divisor must be 1 or a multiple of 2. */
+		if (div != 1)
+			div += div & 1;
+		div = min(div, SDHCI_MAX_DIV_SPEC_300);
+	} else {
+		/* Version 2.00 divisor must be a power of 2. */
+		div = roundup_pow_of_two(div);
+		div = min(div, SDHCI_MAX_DIV_SPEC_200);
+	}
+
+	return sdhci_calc_clk_mode(host, div / 2, false, actual_clock);
+}
 EXPORT_SYMBOL_GPL(sdhci_calc_clk);
 
 void sdhci_enable_clk(struct sdhci_host *host, u16 clk)
diff --git a/drivers/mmc/host/sdhci.h b/drivers/mmc/host/sdhci.h
index 074dc182b184..a3fa70d91410 100644
--- a/drivers/mmc/host/sdhci.h
+++ b/drivers/mmc/host/sdhci.h
@@ -284,8 +284,8 @@
  * End of controller registers.
  */
 
-#define SDHCI_MAX_DIV_SPEC_200	256
-#define SDHCI_MAX_DIV_SPEC_300	2046
+#define SDHCI_MAX_DIV_SPEC_200	256u
+#define SDHCI_MAX_DIV_SPEC_300	2046u
 
 /*
  * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.