Skip to contentSkip to conversation

clk: divider: Tolerate 0 divider for one based dividers

RFC PATCH In review Soren Brinkmann 2 participants 6 messages Mar 11, 2013 – Apr 1, 2013 Common clk

lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 clk: divider: Tolerate 0 divider for one based dividers

Handle a zero divider value as one/bypass for dividers which have the CLK_DIVIDER_ONE_BASED flag set.

---
In Zynq we have a lot of dividers which are one based, but at the same time zero is a valid value which is handled as one/bypass. Also, the reset value of some of these registers is zero, resulting in warnings when the clock framework encounters this.

So, my question here is: Are our dividers odd? Does it make sense to allow zero for all one based dividers, as shown in this patch? Or does this behavior qualify for another flag for the divider clocks (e.g. CLK_DIVIDER_ZERO_OKAY)?

Thanks,
S?ren

 drivers/clk/clk-divider.c    | 5 +++--
 include/linux/clk-provider.h | 4 ++--
 2 files changed, 5 insertions(+), 4 deletions(-)
drivers/clk/clk-divider.c +3 -2
index 68b4021..6c2a431 100644
@@ -109,8 +109,9 @@ static unsigned long clk_divider_recalc_rate(struct clk_hw *hw,
 
 	div = _get_div(divider, val);
 	if (!div) {
-		WARN(1, "%s: Invalid divisor for clock %s\n", __func__,
-						__clk_get_name(hw->clk));
+		WARN(!(divider->flags & CLK_DIVIDER_ONE_BASED),
+				"%s: Invalid divisor for clock %s\n", __func__,
+				__clk_get_name(hw->clk));
 		return parent_rate;
 	}
 
include/linux/clk-provider.h +2 -2
index 7f197d7..5b19b13 100644
@@ -238,8 +238,8 @@ struct clk_div_table {
  * Flags:
  * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the
  * 	register plus one.  If CLK_DIVIDER_ONE_BASED is set then the divider is
- * 	the raw value read from the register, with the value of zero considered
- * 	invalid
+ *	the raw value read from the register. A zero divider is considered to be
+ *	the same as the a value of one.
  * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from
  * 	the hardware register
  */
Signature · 1 line
1.8.1.5
#1 lore raw

Quoting Soren Brinkmann (2013-03-11 14:13:37)

Quoted 10 lines

Handle a zero divider value as one/bypass for dividers which have the CLK_DIVIDER_ONE_BASED flag set.

---
In Zynq we have a lot of dividers which are one based, but at the same time zero is a valid value which is handled as one/bypass. Also, the reset value of some of these registers is zero, resulting in warnings when the clock framework encounters this.

Quoted 4 lines

So, my question here is: Are our dividers odd? Does it make sense to allow zero for all one based dividers, as shown in this patch? Or does this behavior qualify for another flag for the divider clocks (e.g. CLK_DIVIDER_ZERO_OKAY)?

Everyone's dividers are odd ;)

For the case where a bitfield value of zero or one translates into divide-by-one, then I think a flag can be introduced.

But handling bypass and reset is likely to not be as generic or common across implementation, so you might need your own custom clk_hw_foo for that.

The basic clk_divider type is meant to do exactly what the name says:
divide an incoming clock rate. If your clock does more than that then you might need to cook up your own clock type.

Quoted 12 lines

Thanks,
S?ren

 drivers/clk/clk-divider.c    | 5 +++--
 include/linux/clk-provider.h | 4 ++--
 2 files changed, 5 insertions(+), 4 deletions(-)
drivers/clk/clk-divider.c +0 -0
index 68b4021..6c2a431 100644

drivers/clk/clk-divider.c static unsigned long clk_divider_recalc_rate(struct clk_hw *hw, · line 114

Quoted 8 lines
drivers/clk/clk-divider.c +3 -2
@@ -109,8 +109,9 @@ static unsigned long clk_divider_recalc_rate(struct clk_hw *hw,
 
        div = _get_div(divider, val);
        if (!div) {
-               WARN(1, "%s: Invalid divisor for clock %s\n", __func__,
-                                               __clk_get_name(hw->clk));
+               WARN(!(divider->flags & CLK_DIVIDER_ONE_BASED),
+                               "%s: Invalid divisor for clock %s\n", __func__,
+                               __clk_get_name(hw->clk));

div in this code is not the value programmed into the divider, but the numerical divider applied to the parent clock rate. Thus dividing by zero never makes sense here.

Regards,
Mike

Quoted 20 lines
drivers/clk/clk-divider.c +0 -0
                return parent_rate;
        }
 
include/linux/clk-provider.h +2 -2
index 7f197d7..5b19b13 100644
@@ -238,8 +238,8 @@ struct clk_div_table {
  * Flags:
  * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the
  *     register plus one.  If CLK_DIVIDER_ONE_BASED is set then the divider is
- *     the raw value read from the register, with the value of zero considered
- *     invalid
+ *     the raw value read from the register. A zero divider is considered to be
+ *     the same as the a value of one.
  * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from
  *     the hardware register
  */
Signature · 1 line
1.8.1.5
#2 lore raw

Hi Mike,

Quoted 16 lines · Mike Turquette

Quoting Soren Brinkmann (2013-03-11 14:13:37)

Quoted 10 lines

Handle a zero divider value as one/bypass for dividers which have the CLK_DIVIDER_ONE_BASED flag set.

---
In Zynq we have a lot of dividers which are one based, but at the same time zero is a valid value which is handled as one/bypass. Also, the reset value of some of these registers is zero, resulting in warnings when the clock framework encounters this.

Quoted 4 lines

So, my question here is: Are our dividers odd? Does it make sense to allow zero for all one based dividers, as shown in this patch? Or does this behavior qualify for another flag for the divider clocks (e.g. CLK_DIVIDER_ZERO_OKAY)?

Quoted 8 lines

Everyone's dividers are odd ;)

For the case where a bitfield value of zero or one translates into divide-by-one, then I think a flag can be introduced.

But handling bypass and reset is likely to not be as generic or common across implementation, so you might need your own custom clk_hw_foo for that.

What I mean is that 0 corresponds to not modify the input frequency. Whether hardware realizes this through bypass or divide by 1 is an irrelevant implementation detail. I don't want to handle reset. Just avoid the warning about a zero divider in case the CLK_DIVIDER_ONE_BASED flag is set.

Quoted 18 lines

The basic clk_divider type is meant to do exactly what the name says:
divide an incoming clock rate. If your clock does more than that then you might need to cook up your own clock type.

Quoted 13 lines

Thanks,
S?ren

 drivers/clk/clk-divider.c    | 5 +++--
 include/linux/clk-provider.h | 4 ++--
 2 files changed, 5 insertions(+), 4 deletions(-)
drivers/clk/clk-divider.c +0 -0
index 68b4021..6c2a431 100644
@@ -109,8 +109,9 @@ static unsigned long clk_divider_recalc_rate(struct clk_hw *hw,
 
Quoted 11 lines

drivers/clk/clk-divider.c static unsigned long clk_divider_recalc_rate(struct clk_hw *hw, · line 114

Quoted 7 lines
drivers/clk/clk-divider.c +3 -2
        div = _get_div(divider, val);
        if (!div) {
-               WARN(1, "%s: Invalid divisor for clock %s\n", __func__,
-                                               __clk_get_name(hw->clk));
+               WARN(!(divider->flags & CLK_DIVIDER_ONE_BASED),
+                               "%s: Invalid divisor for clock %s\n", __func__,
+                               __clk_get_name(hw->clk));

div in this code is not the value programmed into the divider, but the numerical divider applied to the parent clock rate. Thus dividing by zero never makes sense here.

Right, and for dividers which have the ONE_BASED flags set, this value is just the register value read from HW. Our HW, allows the register to be 0 and the resulting output frequency is its input frequency - just as if it was set to 1.
Since some of our dividers have a reset value of 0, I see this warning during boot up. My intention here is to get rid of the warning for clocks which deem 0 a valid divider value.
I thought, reusing the ONE_BASED flag might be okay, since all such dividers have this redundant 0 state and might handle it similar. Otherwise a new flag might be required.

S?ren

#3 lore raw

RFC PATCH 1/1 clk: divider: Tolerate 0 divider for one based dividers

Quoting S?ren Brinkmann (2013-03-22 11:00:15)

Quoted 7 lines

Since some of our dividers have a reset value of 0, I see this warning during boot up. My intention here is to get rid of the warning for clocks which deem 0 a valid divider value.
I thought, reusing the ONE_BASED flag might be okay, since all such dividers have this redundant 0 state and might handle it similar. Otherwise a new flag might be required.

Hi Soren,

A flag will be necessary. I just checked some documentation for the divider outputs for OMAP's PLLs and (which use the common clk_divider type) and programming zero into those dividers is not allowed. At reset the divider registers are set to 1.

So it is unsafe to simply reuse the ONE_BASED flag.

Let's keep the current behavior as the default and introduce a new flag to handle the special case of a zero divider. Would you like to take a crack at it? It might also be nice to update the WARN message with a hint to take a look at your new flag in case future platforms hit the same issue as you.

Regards,
Mike

Quoted 1 line

S?ren

#4 lore raw

Hi Mike,

Quoted 16 lines · Mike Turquette

Quoting S?ren Brinkmann (2013-03-22 11:00:15)

Quoted 7 lines

Since some of our dividers have a reset value of 0, I see this warning during boot up. My intention here is to get rid of the warning for clocks which deem 0 a valid divider value.
I thought, reusing the ONE_BASED flag might be okay, since all such dividers have this redundant 0 state and might handle it similar. Otherwise a new flag might be required.

Hi Soren,

A flag will be necessary. I just checked some documentation for the divider outputs for OMAP's PLLs and (which use the common clk_divider type) and programming zero into those dividers is not allowed. At reset the divider registers are set to 1.

Quoted 7 lines

So it is unsafe to simply reuse the ONE_BASED flag.

Let's keep the current behavior as the default and introduce a new flag to handle the special case of a zero divider. Would you like to take a crack at it? It might also be nice to update the WARN message with a hint to take a look at your new flag in case future platforms hit the same issue as you.

Okay, sounds good. I should be able to get something ready within this week.
Does anybody have suggestions for naming the new flag? CLK_DIVIDER_ZERO_OKAY was my original suggestionn I think.

S?ren

#5 lore raw

RFC PATCH 1/1 clk: divider: Tolerate 0 divider for one based dividers

Quoting S?ren Brinkmann (2013-04-01 11:31:32)

Quoted 26 lines

Hi Mike,

Quoted 16 lines · Mike Turquette

Quoting S?ren Brinkmann (2013-03-22 11:00:15)

Quoted 7 lines

Since some of our dividers have a reset value of 0, I see this warning during boot up. My intention here is to get rid of the warning for clocks which deem 0 a valid divider value.
I thought, reusing the ONE_BASED flag might be okay, since all such dividers have this redundant 0 state and might handle it similar. Otherwise a new flag might be required.

Hi Soren,

A flag will be necessary. I just checked some documentation for the divider outputs for OMAP's PLLs and (which use the common clk_divider type) and programming zero into those dividers is not allowed. At reset the divider registers are set to 1.

Quoted 7 lines

So it is unsafe to simply reuse the ONE_BASED flag.

Let's keep the current behavior as the default and introduce a new flag to handle the special case of a zero divider. Would you like to take a crack at it? It might also be nice to update the WARN message with a hint to take a look at your new flag in case future platforms hit the same issue as you.

Quoted 5 lines

Okay, sounds good. I should be able to get something ready within this week.
Does anybody have suggestions for naming the new flag? CLK_DIVIDER_ZERO_OKAY was my original suggestionn I think.

CLK_DIVIDER_ALLOW_ZERO sounds betterer to me.

Regards,
Mike

Quoted 1 line

S?ren