Skip to contentSkip to conversation

mfd: stpmic1: fixup main control register and bits naming

PATCH Superseded Sean Nyekjaer 5 participants 16 messages May 16, 2023 – Jun 1, 2023

Subsystems (2)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/3 mfd: stpmic1: fixup main control register and bits naming

Fixup main control register and bits naming so the match the naming from the datasheet.

https://www.st.com/resource/en/datasheet/stpmic1.pdf

---
Changes since v1:
- None

 drivers/mfd/stpmic1.c       |  4 ++--
 include/linux/mfd/stpmic1.h | 12 ++++++------
 2 files changed, 8 insertions(+), 8 deletions(-)
drivers/mfd/stpmic1.c +2 -2
index 8db1530d9bac..4c9b18d9dec8 100644
@@ -19,7 +19,7 @@
 
 static const struct regmap_range stpmic1_readable_ranges[] = {
 	regmap_reg_range(TURN_ON_SR, VERSION_SR),
-	regmap_reg_range(SWOFF_PWRCTRL_CR, LDO6_STDBY_CR),
+	regmap_reg_range(MAIN_CR, LDO6_STDBY_CR),
 	regmap_reg_range(BST_SW_CR, BST_SW_CR),
 	regmap_reg_range(INT_PENDING_R1, INT_PENDING_R4),
 	regmap_reg_range(INT_CLEAR_R1, INT_CLEAR_R4),
@@ -30,7 +30,7 @@ static const struct regmap_range stpmic1_readable_ranges[] = {
 };
 
 static const struct regmap_range stpmic1_writeable_ranges[] = {
-	regmap_reg_range(SWOFF_PWRCTRL_CR, LDO6_STDBY_CR),
+	regmap_reg_range(MAIN_CR, LDO6_STDBY_CR),
 	regmap_reg_range(BST_SW_CR, BST_SW_CR),
 	regmap_reg_range(INT_CLEAR_R1, INT_CLEAR_R4),
 	regmap_reg_range(INT_SET_MASK_R1, INT_SET_MASK_R4),
include/linux/mfd/stpmic1.h +6 -6
index fa3f99f7e9a1..dc00bac24f5a 100644
@@ -15,7 +15,7 @@
 #define RREQ_STATE_SR		0x5
 #define VERSION_SR		0x6
 
-#define SWOFF_PWRCTRL_CR	0x10
+#define MAIN_CR			0x10
 #define PADS_PULL_CR		0x11
 #define BUCKS_PD_CR		0x12
 #define LDO14_PD_CR		0x13
@@ -148,14 +148,14 @@
 #define LDO_BYPASS_MASK			BIT(7)
 
 /* Main PMIC Control Register
- * SWOFF_PWRCTRL_CR
+ * MAIN_CR
  * Address : 0x10
  */
-#define ICC_EVENT_ENABLED		BIT(4)
+#define OCP_OFF_DBG			BIT(4)
 #define PWRCTRL_POLARITY_HIGH		BIT(3)
-#define PWRCTRL_PIN_VALID		BIT(2)
-#define RESTART_REQUEST_ENABLED		BIT(1)
-#define SOFTWARE_SWITCH_OFF_ENABLED	BIT(0)
+#define PWRCTRL_ENABLE			BIT(2)
+#define RESTART_REQUEST_ENABLE		BIT(1)
+#define SOFTWARE_SWITCH_OFF		BIT(0)
 
 /* Main PMIC PADS Control Register
  * PADS_PULL_CR
Signature · 1 line
2.40.0
#1 lore raw

PATCH v2 2/3 mfd: stpmic1: add pmic poweroff via sys-off handler

Use devm_register_sys_off_handler() that allows to register multiple power-off handlers.

This can be enabled by adding "st,pmic-poweroff" to device-tree.

---
Changes since v1:
- Removed superfluous function

 drivers/mfd/stpmic1.c | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
drivers/mfd/stpmic1.c +23 -0
index 4c9b18d9dec8..5b82cd37d57a 100644
@@ -7,6 +7,7 @@
 #include <linux/mfd/core.h>
 #include <linux/mfd/stpmic1.h>
 #include <linux/module.h>
+#include <linux/reboot.h>
 #include <linux/of.h>
 #include <linux/of_irq.h>
 #include <linux/of_platform.h>
@@ -117,6 +118,16 @@ static const struct regmap_irq_chip stpmic1_regmap_irq_chip = {
 	.num_irqs = ARRAY_SIZE(stpmic1_irqs),
 };
 
+static int stpmic1_power_off(struct sys_off_data *data)
+{
+	struct stpmic1 *ddata = data->cb_data;
+
+	regmap_update_bits(ddata->regmap, MAIN_CR,
+			   SOFTWARE_SWITCH_OFF, SOFTWARE_SWITCH_OFF);
+
+	return NOTIFY_DONE;
+}
+
 static int stpmic1_probe(struct i2c_client *i2c)
 {
 	struct stpmic1 *ddata;
@@ -159,6 +170,18 @@ static int stpmic1_probe(struct i2c_client *i2c)
 		return ret;
 	}
 
+	if (of_property_read_bool(i2c->dev.of_node,  "st,pmic-poweroff")) {
+		ret = devm_register_sys_off_handler(ddata->dev,
+						    SYS_OFF_MODE_POWER_OFF,
+						    SYS_OFF_PRIO_DEFAULT,
+						    stpmic1_power_off,
+						    ddata);
+		if (ret) {
+			dev_err(ddata->dev, "failed to register sys-off handler: %d\n", ret);
+			return ret;
+		}
+	}
+
 	return devm_of_platform_populate(dev);
 }
 
Signature · 1 line
2.40.0
maintainer Reviewed-by on v2 2/3
#2 lore raw

Re: [PATCH v2 2/3] mfd: stpmic1: add pmic poweroff via sys-off handler

Quoted 5 lines · Sean Nyekjaer

Use devm_register_sys_off_handler() that allows to register multiple power-off handlers.

This can be enabled by adding "st,pmic-poweroff" to device-tree.

Quoted 7 lines

---
Changes since v1:
- Removed superfluous function

 drivers/mfd/stpmic1.c | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
Signature · 1 line
Lee Jones [李琼斯]
#3 lore raw

PATCH v2 3/3 dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

In reply to Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
 Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +8 -0
index 9573e4af949e..5183a7c660d2 100644
@@ -26,6 +26,14 @@ properties:
 
   interrupt-controller: true
 
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).
+
   onkey:
     type: object
 
Signature · 1 line
2.40.0
#4 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Hey Sean,

Quoted 12 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
 Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml properties: · line 35

Quoted 10 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
@@ -26,6 +26,14 @@ properties:
 
   interrupt-controller: true
 
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Also, the dt-binding patch should go before the patch adding the property to the driver.

Thanks,
Conor.

#5 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Hey Conor,

Quoted 29 lines · Conor Dooley

Hey Sean,

Quoted 12 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++

1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml properties: · line 35

Quoted 10 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
@@ -26,6 +26,14 @@ properties:
 
  interrupt-controller: true
 
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software

Quoted 8 lines

behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Better wording?
Indicates that the power management IC (PMIC) is used to power off the board. So as the last step in the power off sequence set the SWOFF bit in the main control register (MAIN_CR) register, to shutdown all power rails.

Quoted 4 lines

Also, the dt-binding patch should go before the patch adding the property to the driver.

I will switch them around.

Quoted 2 lines

Thanks,
Conor.

/Sean

#6 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Quoted 35 lines · Sean Nyekjær
Quoted 26 lines · Conor Dooley
Quoted 12 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++

1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml properties: · line 35

Quoted 10 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
@@ -26,6 +26,14 @@ properties:
 
  interrupt-controller: true
 
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software

Quoted 8 lines

behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Quoted 4 lines

Better wording?
Indicates that the power management IC (PMIC) is used to power off the board. So as the last step in the power off sequence set the SWOFF bit in the main control register (MAIN_CR) register, to shutdown all power rails.

The description for the property that Krzysztof mentioned is
samsung,s2mps11-acokb-ground:
description: |
Indicates that ACOKB pin of S2MPS11 PMIC is connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1 register to turn off the power. Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.

In other words, I am asking what (abnormal?) scenario there is that means you need the property, rather than what setting the property does. Or am I totally off, and this is the only way this PMIC works?

Cheers,
Conor.

#7 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Hi Conor,

Quoted 51 lines · Conor Dooley
Quoted 35 lines · Sean Nyekjær
Quoted 26 lines · Conor Dooley
Quoted 12 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++

1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml properties: · line 35

Quoted 10 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
@@ -26,6 +26,14 @@ properties:
 
 interrupt-controller: true
 
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software

Quoted 8 lines

behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Quoted 4 lines

Better wording?
Indicates that the power management IC (PMIC) is used to power off the board. So as the last step in the power off sequence set the SWOFF bit in the main control register (MAIN_CR) register, to shutdown all power rails.

The description for the property that Krzysztof mentioned is
samsung,s2mps11-acokb-ground:
description: |
Indicates that ACOKB pin of S2MPS11 PMIC is connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1 register to turn off the power. Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.

Quoted 3 lines

In other words, I am asking what (abnormal?) scenario there is that means you need the property, rather than what setting the property does. Or am I totally off, and this is the only way this PMIC works?

Indicates that the power management IC (PMIC) turn-off condition is met by setting the SWOFF bit in the main control register (MAIN_CR) register. Turn-off condition can still be reached by the PONKEY input.

?

I must admit I’m somewhat lost here :)

/Sean

#8 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Quoted 57 lines · Sean Nyekjær

Hi Conor,

Quoted 51 lines · Conor Dooley
Quoted 35 lines · Sean Nyekjær
Quoted 26 lines · Conor Dooley
Quoted 12 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++

1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml properties: · line 35

Quoted 10 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
@@ -26,6 +26,14 @@ properties:
 
 interrupt-controller: true
 
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software

Quoted 8 lines

behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Quoted 4 lines

Better wording?
Indicates that the power management IC (PMIC) is used to power off the board. So as the last step in the power off sequence set the SWOFF bit in the main control register (MAIN_CR) register, to shutdown all power rails.

The description for the property that Krzysztof mentioned is
samsung,s2mps11-acokb-ground:
description: |
Indicates that ACOKB pin of S2MPS11 PMIC is connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1 register to turn off the power. Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.

Quoted 3 lines

In other words, I am asking what (abnormal?) scenario there is that means you need the property, rather than what setting the property does. Or am I totally off, and this is the only way this PMIC works?

Quoted 7 lines

Indicates that the power management IC (PMIC) turn-off condition is met by setting the SWOFF bit in the main control register (MAIN_CR) register. Turn-off condition can still be reached by the PONKEY input.

?

I must admit I’m somewhat lost here :)

Sorry about that. I'm trying to understand what is different about your hardware that it needs the property rather than what adding the property does. If you look at the samsung one, it describes both the configuration of the hardware ("ACOKB pin of S2MPS11 PMIC is connected to the ground") and how that is different from normal ("Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.")

Looking at your datasheet, you don't have such a pin though - just the sw poweroff bit & the PONKEY stuff. My angle is just that I am trying to figure out why you need this property when it has not been needed before. Or why you would not always want to "shutdown all power rails when power-off sequence have finished". I'm sorry if these are silly questions.

#9 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Quoted 78 lines · Conor Dooley
Quoted 57 lines · Sean Nyekjær

Hi Conor,

Quoted 51 lines · Conor Dooley
Quoted 35 lines · Sean Nyekjær
Quoted 26 lines · Conor Dooley
Quoted 15 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++

1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644
@@ -26,6 +26,14 @@ properties:
 

interrupt-controller: true

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml properties: · line 35

Quoted 7 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software

Quoted 8 lines

behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Quoted 4 lines

Better wording?
Indicates that the power management IC (PMIC) is used to power off the board. So as the last step in the power off sequence set the SWOFF bit in the main control register (MAIN_CR) register, to shutdown all power rails.

The description for the property that Krzysztof mentioned is samsung,s2mps11-acokb-ground:
description: |
Indicates that ACOKB pin of S2MPS11 PMIC is connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1 register to turn off the power. Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.

Quoted 3 lines

In other words, I am asking what (abnormal?) scenario there is that means you need the property, rather than what setting the property does. Or am I totally off, and this is the only way this PMIC works?

Quoted 7 lines

Indicates that the power management IC (PMIC) turn-off condition is met by setting the SWOFF bit in the main control register (MAIN_CR) register. Turn-off condition can still be reached by the PONKEY input.

?

I must admit I’m somewhat lost here :)

Sorry about that. I'm trying to understand what is different about your hardware that it needs the property rather than what adding the property does. If you look at the samsung one, it describes both the configuration of the hardware ("ACOKB pin of S2MPS11 PMIC is connected to the ground") and how that is different from normal ("Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.")

Quoted 7 lines

Looking at your datasheet, you don't have such a pin though - just the sw poweroff bit & the PONKEY stuff. My angle is just that I am trying to figure out why you need this property when it has not been needed before. Or why you would not always want to "shutdown all power rails when power-off sequence have finished". I'm sorry if these are silly questions.

No silly questions, maybe they trick me to come up with the correct answer :D

Basically without this, you won’t be able to power off the system other than hitting the PONKEY.
So it’s a new feature that wasn’t supported before. Maybe this feature should not be optional?

If st,pmic-poweroff == true:
System will power off as the last step in the power off sequence. If st,pmic-powerof == false:
System will reboot in the last step in the power off sequence.

I thought of this, as an always on system failsafe.

/Sean

#10 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Hey Sean, Lee,

Quoted 61 lines · Sean Nyekjaer
Quoted 53 lines · Conor Dooley
Quoted 35 lines · Sean Nyekjær
Quoted 31 lines · Conor Dooley
Quoted 11 lines · Sean Nyekjær
Quoted 11 lines · Conor Dooley
Quoted 7 lines · Sean Nyekjaer
(quoted diff) +7 -0
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).
Quoted 9 lines
Quoted 9 lines

Just reading this description, this is sounding quite like a "software behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

The description for the property that Krzysztof mentioned is samsung,s2mps11-acokb-ground:
description: |
Indicates that ACOKB pin of S2MPS11 PMIC is connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1 register to turn off the power. Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.

Quoted 3 lines

In other words, I am asking what (abnormal?) scenario there is that means you need the property, rather than what setting the property does. Or am I totally off, and this is the only way this PMIC works?

Quoted 7 lines

Indicates that the power management IC (PMIC) turn-off condition is met by setting the SWOFF bit in the main control register (MAIN_CR) register. Turn-off condition can still be reached by the PONKEY input.

?

I must admit I’m somewhat lost here :)

Sorry about that. I'm trying to understand what is different about your hardware that it needs the property rather than what adding the property does. If you look at the samsung one, it describes both the configuration of the hardware ("ACOKB pin of S2MPS11 PMIC is connected to the ground") and how that is different from normal ("Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.")

Quoted 7 lines

Looking at your datasheet, you don't have such a pin though - just the sw poweroff bit & the PONKEY stuff. My angle is just that I am trying to figure out why you need this property when it has not been needed before. Or why you would not always want to "shutdown all power rails when power-off sequence have finished". I'm sorry if these are silly questions.

Quoted 6 lines

No silly questions, maybe they trick me to come up with the correct answer :D

Basically without this, you won’t be able to power off the system other than hitting the PONKEY.
So it’s a new feature that wasn’t supported before. Maybe this feature should not be optional?

Yeah, I suppose that is the rabbit-hole that the silly questions lead down. I don't know the answer to that though. Maybe Lee does?

Quoted 8 lines

If st,pmic-poweroff == true:
System will power off as the last step in the power off sequence. If st,pmic-powerof == false:
System will reboot in the last step in the power off sequence.

I thought of this, as an always on system failsafe.

/Sean

#11 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

In reply to Sean Nyekjaer
Quoted 86 lines · Sean Nyekjaer
Quoted 78 lines · Conor Dooley
Quoted 57 lines · Sean Nyekjær

Hi Conor,

Quoted 51 lines · Conor Dooley
Quoted 35 lines · Sean Nyekjær
Quoted 26 lines · Conor Dooley
Quoted 15 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++

1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644
@@ -26,6 +26,14 @@ properties:
 

interrupt-controller: true

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml

Quoted 7 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software

Quoted 8 lines

behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Quoted 4 lines

Better wording?
Indicates that the power management IC (PMIC) is used to power off the board. So as the last step in the power off sequence set the SWOFF bit in the main control register (MAIN_CR) register, to shutdown all power rails.

The description for the property that Krzysztof mentioned is samsung,s2mps11-acokb-ground:
description: |
Indicates that ACOKB pin of S2MPS11 PMIC is connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1 register to turn off the power. Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.

Quoted 3 lines

In other words, I am asking what (abnormal?) scenario there is that means you need the property, rather than what setting the property does. Or am I totally off, and this is the only way this PMIC works?

Quoted 7 lines

Indicates that the power management IC (PMIC) turn-off condition is met by setting the SWOFF bit in the main control register (MAIN_CR) register. Turn-off condition can still be reached by the PONKEY input.

?

I must admit I’m somewhat lost here :)

Sorry about that. I'm trying to understand what is different about your hardware that it needs the property rather than what adding the property does. If you look at the samsung one, it describes both the configuration of the hardware ("ACOKB pin of S2MPS11 PMIC is connected to the ground") and how that is different from normal ("Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.")

Quoted 7 lines

Looking at your datasheet, you don't have such a pin though - just the sw poweroff bit & the PONKEY stuff. My angle is just that I am trying to figure out why you need this property when it has not been needed before. Or why you would not always want to "shutdown all power rails when power-off sequence have finished". I'm sorry if these are silly questions.

Quoted 6 lines

No silly questions, maybe they trick me to come up with the correct answer :D

Basically without this, you won’t be able to power off the system other than hitting the PONKEY.
So it’s a new feature that wasn’t supported before. Maybe this feature should not be optional?

You are still describing what driver should do with registers. What you are missing is describing real cause for this. It's exactly the same case as was with s2mps11.

Best regards,
Krzysztof

#12 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Hi Krzysztof,

Quoted 91 lines · Krzysztof Kozlowski
Quoted 88 lines · Sean Nyekjaer
Quoted 78 lines · Conor Dooley
Quoted 57 lines · Sean Nyekjær

Hi Conor,

Quoted 51 lines · Conor Dooley
Quoted 35 lines · Sean Nyekjær
Quoted 26 lines · Conor Dooley
Quoted 15 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++

1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644
@@ -26,6 +26,14 @@ properties:
 

interrupt-controller: true

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml

Quoted 7 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software

Quoted 8 lines

behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Quoted 4 lines

Better wording?
Indicates that the power management IC (PMIC) is used to power off the board. So as the last step in the power off sequence set the SWOFF bit in the main control register (MAIN_CR) register, to shutdown all power rails.

The description for the property that Krzysztof mentioned is samsung,s2mps11-acokb-ground:
description: |
Indicates that ACOKB pin of S2MPS11 PMIC is connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1 register to turn off the power. Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.

Quoted 3 lines

In other words, I am asking what (abnormal?) scenario there is that means you need the property, rather than what setting the property does. Or am I totally off, and this is the only way this PMIC works?

Quoted 7 lines

Indicates that the power management IC (PMIC) turn-off condition is met by setting the SWOFF bit in the main control register (MAIN_CR) register. Turn-off condition can still be reached by the PONKEY input.

?

I must admit I’m somewhat lost here :)

Sorry about that. I'm trying to understand what is different about your hardware that it needs the property rather than what adding the property does. If you look at the samsung one, it describes both the configuration of the hardware ("ACOKB pin of S2MPS11 PMIC is connected to the ground") and how that is different from normal ("Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.")

Quoted 7 lines

Looking at your datasheet, you don't have such a pin though - just the sw poweroff bit & the PONKEY stuff. My angle is just that I am trying to figure out why you need this property when it has not been needed before. Or why you would not always want to "shutdown all power rails when power-off sequence have finished". I'm sorry if these are silly questions.

No silly questions, maybe they trick me to come up with the correct answer :D

Quoted 8 lines
Quoted 4 lines

Basically without this, you won’t be able to power off the system other than hitting the PONKEY.
So it’s a new feature that wasn’t supported before. Maybe this feature should not be optional?

You are still describing what driver should do with registers. What you are missing is describing real cause for this. It's exactly the same case as was with s2mps11.

I didn’t mention anything with registers in the patch:

if present, configure the PMIC to shutdown all power rails when power off sequence have finished.
Use this option if the SoC should be powered off by external power management IC (PMIC).

^^ That’s is exactly what is happening if the option is enabled.

Do you have a suggestion wording?
What do you think about removing this option and make it default behaviour?

/Sean

Quoted 4 lines

Best regards,
Krzysztof

#13 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Quoted 109 lines · Sean Nyekjaer

Hi Krzysztof,

Quoted 91 lines · Krzysztof Kozlowski
Quoted 88 lines · Sean Nyekjaer
Quoted 78 lines · Conor Dooley
Quoted 57 lines · Sean Nyekjær

Hi Conor,

Quoted 51 lines · Conor Dooley
Quoted 35 lines · Sean Nyekjær
Quoted 26 lines · Conor Dooley
Quoted 15 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++

1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644
@@ -26,6 +26,14 @@ properties:
 

interrupt-controller: true

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml

Quoted 7 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software

Quoted 8 lines

behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Quoted 4 lines

Better wording?
Indicates that the power management IC (PMIC) is used to power off the board. So as the last step in the power off sequence set the SWOFF bit in the main control register (MAIN_CR) register, to shutdown all power rails.

The description for the property that Krzysztof mentioned is samsung,s2mps11-acokb-ground:
description: |
Indicates that ACOKB pin of S2MPS11 PMIC is connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1 register to turn off the power. Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.

Quoted 3 lines

In other words, I am asking what (abnormal?) scenario there is that means you need the property, rather than what setting the property does. Or am I totally off, and this is the only way this PMIC works?

Quoted 7 lines

Indicates that the power management IC (PMIC) turn-off condition is met by setting the SWOFF bit in the main control register (MAIN_CR) register. Turn-off condition can still be reached by the PONKEY input.

?

I must admit I’m somewhat lost here :)

Sorry about that. I'm trying to understand what is different about your hardware that it needs the property rather than what adding the property does. If you look at the samsung one, it describes both the configuration of the hardware ("ACOKB pin of S2MPS11 PMIC is connected to the ground") and how that is different from normal ("Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.")

Quoted 7 lines

Looking at your datasheet, you don't have such a pin though - just the sw poweroff bit & the PONKEY stuff. My angle is just that I am trying to figure out why you need this property when it has not been needed before. Or why you would not always want to "shutdown all power rails when power-off sequence have finished". I'm sorry if these are silly questions.

No silly questions, maybe they trick me to come up with the correct answer :D

Quoted 8 lines
Quoted 4 lines

Basically without this, you won’t be able to power off the system other than hitting the PONKEY.
So it’s a new feature that wasn’t supported before. Maybe this feature should not be optional?

You are still describing what driver should do with registers. What you are missing is describing real cause for this. It's exactly the same case as was with s2mps11.

I didn’t mention anything with registers in the patch:

if present, configure the PMIC to shutdown all power rails when power off sequence have finished.
Use this option if the SoC should be powered off by external power management IC (PMIC).

Quoted 4 lines

^^ That’s is exactly what is happening if the option is enabled.

Do you have a suggestion wording?
What do you think about removing this option and make it default behaviour?

Again - you write what the driver should do ("configure the PMIC") when something in Linux happens ("power off sequence have finished"). Exactly the same case as s2mps11. Look how it was worded there. You need to find
the real cause, why such actions are required on which board.

Otherwise it does not warrant DT property and just perform it always.

Best regards,
Krzysztof

#14 lore raw

Re: [PATCH v2 3/3] dt-bindings: mfd: stpmic1: add fsl,pmic-poweroff property

Not trimming any of this in case Lee wants to chime in and needs the context...

Quoted 83 lines · Krzysztof Kozlowski
Quoted 82 lines · Sean Nyekjaer
Quoted 82 lines · Krzysztof Kozlowski
Quoted 80 lines · Sean Nyekjaer
Quoted 79 lines · Conor Dooley
Quoted 54 lines · Sean Nyekjær
Quoted 50 lines · Conor Dooley
Quoted 35 lines · Sean Nyekjær
Quoted 26 lines · Conor Dooley
Quoted 15 lines · Sean Nyekjaer

Document the new optional "fsl,pmic-poweroff" property.

---
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml | 8 ++++++++

1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +0 -0
index 9573e4af949e..5183a7c660d2 100644
@@ -26,6 +26,14 @@ properties:
 

interrupt-controller: true

Documentation/devicetree/bindings/mfd/st,stpmic1.yaml

Quoted 7 lines
Documentation/devicetree/bindings/mfd/st,stpmic1.yaml +7 -0
+  st,pmic-poweroff:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      if present, configure the PMIC to shutdown all power rails when
+      power off sequence have finished.
+      Use this option if the SoC should be powered off by external power management
+      IC (PMIC).

Just reading this description, this is sounding quite like a "software

Quoted 8 lines

behaviour" type of property, which are not permitted, rather than describing some element of the hardware. Clearly you are trying to solve an actual problem though, so try re-phrasing the description (and property name) to focus on what exact hardware configuration it is that you are trying to special-case.
Krzysztof suggested that the samsung,s2mps11-acokb-ground property in samsung,s2mps11.yaml is addressing a similar problem, so that could be good to look at.

Quoted 4 lines

Better wording?
Indicates that the power management IC (PMIC) is used to power off the board. So as the last step in the power off sequence set the SWOFF bit in the main control register (MAIN_CR) register, to shutdown all power rails.

The description for the property that Krzysztof mentioned is samsung,s2mps11-acokb-ground:
description: |
Indicates that ACOKB pin of S2MPS11 PMIC is connected to the ground so the PMIC must manually set PWRHOLD bit in CTRL1 register to turn off the power. Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.

Quoted 3 lines

In other words, I am asking what (abnormal?) scenario there is that means you need the property, rather than what setting the property does. Or am I totally off, and this is the only way this PMIC works?

Quoted 7 lines

Indicates that the power management IC (PMIC) turn-off condition is met by setting the SWOFF bit in the main control register (MAIN_CR) register. Turn-off condition can still be reached by the PONKEY input.

?

I must admit I’m somewhat lost here :)

Sorry about that. I'm trying to understand what is different about your hardware that it needs the property rather than what adding the property does. If you look at the samsung one, it describes both the configuration of the hardware ("ACOKB pin of S2MPS11 PMIC is connected to the ground") and how that is different from normal ("Usually the ACOKB is pulled up to VBATT so when PWRHOLD pin goes low, the rising ACOKB will trigger power off.")

Looking at your datasheet, you don't have such a pin though - just the sw poweroff bit & the PONKEY stuff. My angle is just that I am trying to figure out why you need this property when it has not been needed before. Or why you would not always want to "shutdown all power rails when power-off sequence have finished". I'm sorry if these are silly questions.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

No silly questions, maybe they trick me to come up with the correct answer :D

Basically without this, you won’t be able to power off the system other than hitting the PONKEY.
So it’s a new feature that wasn’t supported before. Maybe this feature should not be optional?

[1]

Quoted 17 lines
Quoted 12 lines
Quoted 4 lines

You are still describing what driver should do with registers. What you are missing is describing real cause for this. It's exactly the same case as was with s2mps11.

I didn’t mention anything with registers in the patch:

if present, configure the PMIC to shutdown all power rails when power off sequence have finished.
Use this option if the SoC should be powered off by external power management IC (PMIC).

Quoted 4 lines

^^ That’s is exactly what is happening if the option is enabled.

Do you have a suggestion wording?
What do you think about removing this option and make it default behaviour?

Quoted 6 lines

Again - you write what the driver should do ("configure the PMIC") when something in Linux happens ("power off sequence have finished"). Exactly the same case as s2mps11. Look how it was worded there. You need to find
the real cause, why such actions are required on which board.

Otherwise it does not warrant DT property and just perform it always.

Yeah, Sean asked that a few messages back up [1] & having looked at the datasheet I am kinda struggling to see why you would not just always want to do this. There does not seem to be an equivalent pin in this PMIC as your Samsung one, so this patch isn't working around some flaw in a board design, but rather seems to be looking to implement the actual functionality.
I vote for do it always, obviously unless Less disagrees, and if that causes problems we can revisit the dt property with more understanding of whatever use case breaks if this is done unilaterally.

Cheers,
Conor.

maintainer Reviewed-by on v2 1/3
#15 lore raw
In reply to Sean Nyekjaer
Quoted 5 lines · Sean Nyekjaer

Fixup main control register and bits naming so the match the naming from the datasheet.

https://www.st.com/resource/en/datasheet/stpmic1.pdf

Quoted 8 lines

---
Changes since v1:
- None

 drivers/mfd/stpmic1.c       |  4 ++--
 include/linux/mfd/stpmic1.h | 12 ++++++------
 2 files changed, 8 insertions(+), 8 deletions(-)
Signature · 1 line
Lee Jones [李琼斯]