Skip to contentSkip to conversation

clk: aspeed/ast2600: Add critical clock setting logic

PATCH New Jae Hyun Yoo 4 participants 9 messages Jan 15, 2020 – Jan 30, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

cover clk: aspeed/ast2600: Add critical clock setting logic

This commit adds critical clock setting logic that applies CLK_IS_CRITICAL flag if it detects 'clock-critical' property in device tree. With this patch, each platform can enable critical clocks through device tree setting like below:

&syscon {
	clock-critical = <ASPEED_CLK_GATE_BCLK>,
			 <ASPEED_CLK_GATE_MCLK>,
			 <ASPEED_CLK_GATE_REFCLK>;
};

Please review.

Thanks,

Jae

Jae Hyun Yoo (2):
clk: aspeed: add critical clock setting logic
clk: ast2600: add critical clock setting logic

 drivers/clk/clk-aspeed.c  | 5 ++++-
 drivers/clk/clk-ast2600.c | 5 ++++-
 2 files changed, 8 insertions(+), 2 deletions(-)
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/2 clk: aspeed: add critical clock setting logic

This commit adds critical clock setting logic that applies CLK_IS_CRITICAL flag if it detects 'clock-critical' property in device tree.

---
 drivers/clk/clk-aspeed.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/clk/clk-aspeed.c +4 -1
index 411ff5fb2c07..d22eeb574ede 100644
@@ -541,8 +541,11 @@ static int aspeed_clk_probe(struct platform_device *pdev)
 
 	for (i = 0; i < ARRAY_SIZE(aspeed_gates); i++) {
 		const struct aspeed_gate_data *gd = &aspeed_gates[i];
+		unsigned long flags = gd->flags;
 		u32 gate_flags;
 
+		of_clk_detect_critical(pdev->dev.of_node, i, &flags);
+
 		/* Special case: the USB port 1 clock (bit 14) is always
 		 * working the opposite way from the other ones.
 		 */
@@ -550,7 +553,7 @@ static int aspeed_clk_probe(struct platform_device *pdev)
 		hw = aspeed_clk_hw_register_gate(dev,
 				gd->name,
 				gd->parent_name,
-				gd->flags,
+				flags,
 				map,
 				gd->clock_idx,
 				gd->reset_idx,
Signature · 1 line
2.17.1
maintainer
#2 lore raw

PATCH 1/2 clk: aspeed: add critical clock setting logic

Quoted 15 lines · Jae Hyun Yoo

This commit adds critical clock setting logic that applies CLK_IS_CRITICAL flag if it detects 'clock-critical' property in device tree.

---
 drivers/clk/clk-aspeed.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/clk/clk-aspeed.c +0 -0
index 411ff5fb2c07..d22eeb574ede 100644

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 547

Quoted 7 lines
drivers/clk/clk-aspeed.c +2 -0
@@ -541,8 +541,11 @@ static int aspeed_clk_probe(struct platform_device *pdev)
 
        for (i = 0; i < ARRAY_SIZE(aspeed_gates); i++) {
                const struct aspeed_gate_data *gd = &aspeed_gates[i];
+               unsigned long flags = gd->flags;
                u32 gate_flags;
 
+               of_clk_detect_critical(pdev->dev.of_node, i, &flags);

This makes sense to me.

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 556

Quoted 10 lines
drivers/clk/clk-aspeed.c +2 -1
+
                /* Special case: the USB port 1 clock (bit 14) is always
                 * working the opposite way from the other ones.
                 */
@@ -550,7 +553,7 @@ static int aspeed_clk_probe(struct platform_device *pdev)
                hw = aspeed_clk_hw_register_gate(dev,
                                gd->name,
                                gd->parent_name,
-                               gd->flags,
+                               flags,

For completeness should we make this

flags | gd->flags

Quoted 6 lines
drivers/clk/clk-aspeed.c +0 -1
                                map,
                                gd->clock_idx,
                                gd->reset_idx,
--

2.17.1

#3 lore raw

PATCH 1/2 clk: aspeed: add critical clock setting logic

Quoted 39 lines · Joel Stanley
Quoted 15 lines · Jae Hyun Yoo

This commit adds critical clock setting logic that applies CLK_IS_CRITICAL flag if it detects 'clock-critical' property in device tree.

---
  drivers/clk/clk-aspeed.c | 5 ++++-
  1 file changed, 4 insertions(+), 1 deletion(-)
drivers/clk/clk-aspeed.c +0 -0
index 411ff5fb2c07..d22eeb574ede 100644

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 547

Quoted 7 lines
drivers/clk/clk-aspeed.c +2 -0
@@ -541,8 +541,11 @@ static int aspeed_clk_probe(struct platform_device *pdev)
 
         for (i = 0; i < ARRAY_SIZE(aspeed_gates); i++) {
                 const struct aspeed_gate_data *gd = &aspeed_gates[i];
+               unsigned long flags = gd->flags;
                 u32 gate_flags;
 
+               of_clk_detect_critical(pdev->dev.of_node, i, &flags);

This makes sense to me.

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 556

Quoted 10 lines
drivers/clk/clk-aspeed.c +2 -1
+
                 /* Special case: the USB port 1 clock (bit 14) is always
                  * working the opposite way from the other ones.
                  */
@@ -550,7 +553,7 @@ static int aspeed_clk_probe(struct platform_device *pdev)
                 hw = aspeed_clk_hw_register_gate(dev,
                                 gd->name,
                                 gd->parent_name,
-                               gd->flags,
+                               flags,

For completeness should we make this

Quoted 1 line

flags | gd->flags

Not needed. of_clk_detect_critical uses OR operation inside.

Quoted 6 lines
Quoted 6 lines
drivers/clk/clk-aspeed.c +0 -1
                                 map,
                                 gd->clock_idx,
                                 gd->reset_idx,
--

2.17.1

#4 lore raw

PATCH 1/2 clk: aspeed: add critical clock setting logic

In reply to Jae Hyun Yoo

Dear Jae,

Quoted 3 lines · Jae Hyun Yoo

This commit adds critical clock setting logic that applies CLK_IS_CRITICAL flag if it detects 'clock-critical' property in device tree.

Tested how?

Quoted 10 lines
---
 drivers/clk/clk-aspeed.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/clk/clk-aspeed.c +0 -0
index 411ff5fb2c07..d22eeb574ede 100644

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 548

Quoted 8 lines
drivers/clk/clk-aspeed.c +3 -0
@@ -541,8 +541,11 @@ static int aspeed_clk_probe(struct platform_device *pdev)
 
 	for (i = 0; i < ARRAY_SIZE(aspeed_gates); i++) {
 		const struct aspeed_gate_data *gd = &aspeed_gates[i];
+		unsigned long flags = gd->flags;
 		u32 gate_flags;
 
+		of_clk_detect_critical(pdev->dev.of_node, i, &flags);
+

The function description in drivers/clk/clk.c has the warning below.

Quoted 6 lines
drivers/clk/clk-aspeed.c +0 -0
 * Do not use this function. It exists only for legacy Device Tree
 * bindings, such as the one-clock-per-node style that are outdated.
 * Those bindings typically put all clock data into .dts and the Linux

* driver has no clock data, thus making it impossible to set this flag
* correctly from the driver. Only those drivers may call
* of_clk_detect_critical from their setup functions.

Will this still work?

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 559

Quoted 12 lines
drivers/clk/clk-aspeed.c +1 -1
 		/* Special case: the USB port 1 clock (bit 14) is always
 		 * working the opposite way from the other ones.
 		 */
@@ -550,7 +553,7 @@ static int aspeed_clk_probe(struct platform_device *pdev)
 		hw = aspeed_clk_hw_register_gate(dev,
 				gd->name,
 				gd->parent_name,
-				gd->flags,
+				flags,
 				map,
 				gd->clock_idx,
 				gd->reset_idx,

Kind regards,

Paul

-------------- next part --------------
A non-text attachment was scrubbed...
Name: smime.p7s
Type: application/pkcs7-signature
Size: 5174 bytes
Desc: S/MIME Cryptographic Signature
URL: <http://lists.ozlabs.org/pipermail/linux-aspeed/attachments/20200116/a87f0f3e/attachment.bin>

#5 lore raw

PATCH 1/2 clk: aspeed: add critical clock setting logic

Dear Paul,

Quoted 9 lines · Paul Menzel

Dear Jae,

Quoted 3 lines · Jae Hyun Yoo

This commit adds critical clock setting logic that applies CLK_IS_CRITICAL flag if it detects 'clock-critical' property in device tree.

Tested how?

I added in the cover letter how I tested it. For an example, BCLK can have the flag if I add below setting into one of 'aspeed-bmc-*.dts' files.

&syscon {
	clock-critical = <ASPEED_CLK_GATE_BCLK>;
};
Quoted 21 lines
Quoted 10 lines
---
  drivers/clk/clk-aspeed.c | 5 ++++-
  1 file changed, 4 insertions(+), 1 deletion(-)
drivers/clk/clk-aspeed.c +0 -0
index 411ff5fb2c07..d22eeb574ede 100644

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 548

Quoted 8 lines
drivers/clk/clk-aspeed.c +3 -0
@@ -541,8 +541,11 @@ static int aspeed_clk_probe(struct platform_device *pdev)
 
  	for (i = 0; i < ARRAY_SIZE(aspeed_gates); i++) {
  		const struct aspeed_gate_data *gd = &aspeed_gates[i];
+		unsigned long flags = gd->flags;
  		u32 gate_flags;
 
+		of_clk_detect_critical(pdev->dev.of_node, i, &flags);
+

The function description in drivers/clk/clk.c has the warning below.

Quoted 8 lines
Quoted 6 lines
drivers/clk/clk-aspeed.c +0 -0
  * Do not use this function. It exists only for legacy Device Tree
  * bindings, such as the one-clock-per-node style that are outdated.
  * Those bindings typically put all clock data into .dts and the Linux

* driver has no clock data, thus making it impossible to set this flag
* correctly from the driver. Only those drivers may call
* of_clk_detect_critical from their setup functions.

Will this still work?

At least, it still works now and still useful for this case. Actually, I made this change as an alternative way of
https://www.spinics.net/lists/linux-clk/msg44836.html
because not all Aspeed BMC systems enable BCLK as a critical clock, so it's for providing more flexible way of critical clock setting for various hardware configurations.

If the function is deprecated and is going to be removed soon, would it be acceptable if I add the 'critical-clock' parsing code into this driver module instead of using the function?

Best Regards,

Jae

Quoted 18 lines

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 559

Quoted 12 lines

/* Special case: the USB port 1 clock (bit 14) is always
* working the opposite way from the other ones. */

drivers/clk/clk-aspeed.c +1 -1
@@ -550,7 +553,7 @@ static int aspeed_clk_probe(struct platform_device *pdev)
  		hw = aspeed_clk_hw_register_gate(dev,
  				gd->name,
  				gd->parent_name,
-				gd->flags,
+				flags,
  				map,
  				gd->clock_idx,
  				gd->reset_idx,

Kind regards,

Paul

maintainer
#6 lore raw

PATCH 1/2 clk: aspeed: add critical clock setting logic

In reply to Jae Hyun Yoo

Quoting Jae Hyun Yoo (2020-01-15 13:26:38)

Quoted 3 lines

This commit adds critical clock setting logic that applies CLK_IS_CRITICAL flag if it detects 'clock-critical' property in device tree.

Yes that is what the patch does. The commit text is supposed to explain _why_ the patch is important. Please read "The canonical patch format" from Documentation/process/submitting-patches.rst to understand what is expected.

Quoted 11 lines
---
 drivers/clk/clk-aspeed.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/clk/clk-aspeed.c +0 -0
index 411ff5fb2c07..d22eeb574ede 100644

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 548

Quoted 8 lines
drivers/clk/clk-aspeed.c +3 -0
@@ -541,8 +541,11 @@ static int aspeed_clk_probe(struct platform_device *pdev)
 
        for (i = 0; i < ARRAY_SIZE(aspeed_gates); i++) {
                const struct aspeed_gate_data *gd = &aspeed_gates[i];
+               unsigned long flags = gd->flags;
                u32 gate_flags;
 
+               of_clk_detect_critical(pdev->dev.of_node, i, &flags);
+

Do you need clks to be critical, but only sometimes? What clks need to be critical? Why aren't there drivers for those clks that turn them on as necessary?

There was a lengthy discussion years ago on the list about this function and how it's not supposed to be used in newer code. Maybe we need to revisit that discussion and conclude that sometimes we actually do need clks to be turned on and kept on because we'll never have a driver for them in the kernel. Similar to how pinctrl has pin hogs.

#7 lore raw

PATCH 1/2 clk: aspeed: add critical clock setting logic

Hi Stephen,

Quoted 9 lines · Stephen Boyd

Quoting Jae Hyun Yoo (2020-01-15 13:26:38)

Quoted 3 lines

This commit adds critical clock setting logic that applies CLK_IS_CRITICAL flag if it detects 'clock-critical' property in device tree.

Yes that is what the patch does. The commit text is supposed to explain _why_ the patch is important. Please read "The canonical patch format" from Documentation/process/submitting-patches.rst to understand what is expected.

I see. I'll add more detailed summary.

Quoted 24 lines
Quoted 11 lines
---
  drivers/clk/clk-aspeed.c | 5 ++++-
  1 file changed, 4 insertions(+), 1 deletion(-)
drivers/clk/clk-aspeed.c +0 -0
index 411ff5fb2c07..d22eeb574ede 100644

drivers/clk/clk-aspeed.c static int aspeed_clk_probe(struct platform_device *pdev) · line 548

Quoted 8 lines
drivers/clk/clk-aspeed.c +3 -0
@@ -541,8 +541,11 @@ static int aspeed_clk_probe(struct platform_device *pdev)
 
         for (i = 0; i < ARRAY_SIZE(aspeed_gates); i++) {
                 const struct aspeed_gate_data *gd = &aspeed_gates[i];
+               unsigned long flags = gd->flags;
                 u32 gate_flags;
 
+               of_clk_detect_critical(pdev->dev.of_node, i, &flags);
+

Do you need clks to be critical, but only sometimes? What clks need to be critical? Why aren't there drivers for those clks that turn them on as necessary?

Quoted 5 lines

There was a lengthy discussion years ago on the list about this function and how it's not supposed to be used in newer code. Maybe we need to revisit that discussion and conclude that sometimes we actually do need clks to be turned on and kept on because we'll never have a driver for them in the kernel. Similar to how pinctrl has pin hogs.

Yes, I need to make BCLK as a critical only for specific platforms. BCLK is for controllers that are connected through PCI or PCIe bus to the host machine such as VGA controller, 2D graphics engine and P2A bridge in this SoC.

I'm currently trying to enable VGA controller which is actually independent from Aspeed BMC SoC. It means that the VGA can be reset only when either host PCI bus reset or host power-on reset is asserted. Basically, VGA hardware module is controlled by the host machine not by the Aspeed BMC SoC.

I submitted this patch as an alternative solution of
https://www.spinics.net/lists/linux-clk/msg44836.html because there could be use cases that intentionally disable the VGA controller depend on hardware design. So it'd be helpful for reducing power consumption and for allocating more generic memory space instead of allocating dedicated VGA shared memory if we can flexibly config the BCLK.

I think, we don't need to add VGA driver just for enabling the clock because the VGA controller is actually controlled by host machine as I explained above so I made this patch set instead.

I agree with you that we need to revisit the discussion.

Thanks,

Jae

#8 lore raw

PATCH 2/2 clk: ast2600: add critical clock setting logic

In reply to Jae Hyun Yoo

This commit adds critical clock setting logic that applies CLK_IS_CRITICAL flag if it detects 'clock-critical' property in device tree.

---
 drivers/clk/clk-ast2600.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/clk/clk-ast2600.c +4 -1
index 392d01705b97..49d89ffdd4be 100644
@@ -599,8 +599,11 @@ static int aspeed_g6_clk_probe(struct platform_device *pdev)
 
 	for (i = 0; i < ARRAY_SIZE(aspeed_g6_gates); i++) {
 		const struct aspeed_gate_data *gd = &aspeed_g6_gates[i];
+		unsigned long flags = gd->flags;
 		u32 gate_flags;
 
+		of_clk_detect_critical(pdev->dev.of_node, i, &flags);
+
 		/*
 		 * Special case: the USB port 1 clock (bit 14) is always
 		 * working the opposite way from the other ones.
@@ -609,7 +612,7 @@ static int aspeed_g6_clk_probe(struct platform_device *pdev)
 		hw = aspeed_g6_clk_hw_register_gate(dev,
 				gd->name,
 				gd->parent_name,
-				gd->flags,
+				flags,
 				map,
 				gd->clock_idx,
 				gd->reset_idx,
Signature · 1 line
2.17.1