poweroff-source DT property renaming

PATCH In review Romain Perier 5 participants 11 messages Nov 25, 2014 – Dec 1, 2014

Subsystems (3)

Device tree bindings Voltage and current regulator framework Device tree

lore

Share & tools

lore

Romain Perier

author

2014-11-25 12:28 UTC #0 lore raw

v5 cover poweroff-source DT property renaming

The goal of this serie is to rename the property "poweroff-source" to "system-power-controller". After discussions, it makes more sense to rename back to the old established property name. This patches serie reverts commit a4b4e0461ec5 ("of: Add standard property for poweroff capability").

Changes since v4:
- Renamed the helper function to of_device_is_system_power_controller
- Removed changes in tps65910, as this commit will be removed from the mfd tree
- Updated doc

Changes since v3:
- Move backward compatibility from of_is_system_power_controller to tps65910, as it was only required for this driver.

Changes since v2:
- of_is_system_power_controller is inline in of.h and only supports backward compatibility with device drivers which used this helper (which is tps65910)
- Quashed all changes into a single patch (except documentation)
- Add a separated commit to fix typos and mispellings in documentation

Changes since v1:

- The first patch defines "of_is_system_power_controller" which is compatible with both "vendor,system-power-controller" and "system-power-controller" properties. Also, It keeps the old helper function of_system_has_poweroff_source for source compatibility until everything is renamed (in this way, bisections are not broken and change is made "atomically" between each commit)

Note: the property "poweroff-source" itself is not used in dts files yet. Before this patch tps65910 was broken due to missing backward compatibility with "vendor,system-power-controller". As the old helper uses the new one, it works again.

- act8865 and tps65910 are ported to the new helper function
- The last commit removes the olf helper which was only used for source compatibility

Romain Perier (2):
of: Rename "poweroff-source" property to "system-power-controller"
dt-bindings: Update documentation for "system-power-controller" and
fix misspellings

 .../devicetree/bindings/power/power-controller.txt     | 18 ++++++++++++++++++
 Documentation/devicetree/bindings/power/poweroff.txt   | 18 ------------------
 .../bindings/regulator/act8865-regulator.txt           |  4 ++--
 drivers/regulator/act8865-regulator.c                  |  2 +-
 include/linux/of.h                                     |  6 +++---
 5 files changed, 24 insertions(+), 24 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/power/power-controller.txt
 delete mode 100644 Documentation/devicetree/bindings/power/poweroff.txt

Signature · 1 line

1.9.1

Romain Perier

author

2014-11-25 12:28 UTC #1 lore raw

PATCH v5 1/2 of: Rename "poweroff-source" property to "system-power-controller"

It reverts commit a4b4e0461ec5 ("of: Add standard property for poweroff capability"). As discussed on the mailing list, it makes more sense to rename back to the old established property name, without the vendor prefix. Problem being that the word "source" usually tends to be used for inputs and that is out of control of the OS. The poweroff capability is an output which simply turns the system-power off. Also, this property might be used by drivers which power-off the system and power back on subsequent RTC alarms. This seems to suggest to remove "poweroff" from the property name and to choose "system-power-controller" as the more generic name. This patchs adds the required renaming changes and defines an helper function which checks if this property is set.

Signed-off-by Romain Perier <[email protected]>

---
 .../bindings/power/{poweroff.txt => power-controller.txt}           | 0
 Documentation/devicetree/bindings/regulator/act8865-regulator.txt   | 4 ++--
 drivers/regulator/act8865-regulator.c                               | 2 +-
 include/linux/of.h                                                  | 6 +++---
 4 files changed, 6 insertions(+), 6 deletions(-)
 rename Documentation/devicetree/bindings/power/{poweroff.txt => power-controller.txt} (100%)

Documentation/devicetree/bindings/power/power-controller.txt renamed from Documentation/devicetree/bindings/power/poweroff.txt +0 -0

similarity index 100%
rename from Documentation/devicetree/bindings/power/poweroff.txt
rename to Documentation/devicetree/bindings/power/power-controller.txt

Documentation/devicetree/bindings/regulator/act8865-regulator.txt +2 -2

index 01a5b07..dad6358 100644
@@ -6,8 +6,8 @@ Required properties:
 - reg: I2C slave address
 
 Optional properties:
-- poweroff-source: Telling whether or not this pmic is controlling
-  the system power. See Documentation/devicetree/bindings/power/poweroff.txt .
+- system-power-controller: Telling whether or not this pmic is controlling
+  the system power. See Documentation/devicetree/bindings/power/power-controller.txt .
 
 Any standard regulator properties can be used to configure the single regulator.

drivers/regulator/act8865-regulator.c +1 -1

index 76301ed..9eec453 100644
@@ -365,7 +365,7 @@ static int act8865_pmic_probe(struct i2c_client *client,
 		return ret;
 	}
 
-	if (of_system_has_poweroff_source(dev->of_node)) {
+	if (of_device_is_system_power_controller(dev->of_node)) {
 		if (!pm_power_off) {
 			act8865_i2c_client = client;
 			act8865->off_reg = off_reg;

include/linux/of.h +3 -3

index b81dbcf..0abdd70 100644
@@ -964,14 +964,14 @@ static inline int of_changeset_update_property(struct of_changeset *ocs,
 extern int of_resolve_phandles(struct device_node *tree);
 
 /**
- * of_system_has_poweroff_source - Tells if poweroff-source is found for device_node
+ * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
  * @np: Pointer to the given device_node
  *
  * return true if present false otherwise
  */
-static inline bool of_system_has_poweroff_source(const struct device_node *np)
+static inline bool of_device_is_system_power_controller(const struct device_node *np)
 {
-	return of_property_read_bool(np, "poweroff-source");
+	return of_property_read_bool(np, "system-power-controller");
 }
 
 #endif /* _LINUX_OF_H */

Signature · 1 line

1.9.1

Johan Hovold

Acked-by on v5 1/2

2014-11-25 14:07 UTC #2 lore raw

Re: [PATCH v5 1/2] of: Rename "poweroff-source" property to "system-power-controller"

Quoted 11 lines · Romain Perier

It reverts commit a4b4e0461ec5 ("of: Add standard property for poweroff capability"). As discussed on the mailing list, it makes more sense to rename back to the old established property name, without the vendor prefix. Problem being that the word "source" usually tends to be used for inputs and that is out of control of the OS. The poweroff capability is an output which simply turns the system-power off. Also, this property might be used by drivers which power-off the system and power back on subsequent RTC alarms. This seems to suggest to remove "poweroff" from the property name and to choose "system-power-controller" as the more generic name. This patchs adds the required renaming changes and defines an helper function which checks if this property is set.

Quoted 1 line

Signed-off-by Romain Perier <[email protected]>

Acked-by Johan Hovold <[email protected]>

Mark, this is for the regulator tree.

Thanks,
Johan

Grant Likely

Acked-by on v5 1/2

2014-11-25 14:40 UTC #3 lore raw

Re: [PATCH v5 1/2] of: Rename "poweroff-source" property to "system-power-controller"

In reply to Romain Perier

Quoted 11 lines · Romain Perier

It reverts commit a4b4e0461ec5 ("of: Add standard property for poweroff capability"). As discussed on the mailing list, it makes more sense to rename back to the old established property name, without the vendor prefix. Problem being that the word "source" usually tends to be used for inputs and that is out of control of the OS. The poweroff capability is an output which simply turns the system-power off. Also, this property might be used by drivers which power-off the system and power back on subsequent RTC alarms. This seems to suggest to remove "poweroff" from the property name and to choose "system-power-controller" as the more generic name. This patchs adds the required renaming changes and defines an helper function which checks if this property is set.

Quoted 1 line

Signed-off-by Romain Perier <[email protected]>

For both patches:

Acked-by Grant Likely <[email protected]>

Let me know if I need to take this series through my tree. Also, does it need to go into v3.18 and be backported to stable? Or just v3.19.

Quoted 65 lines

---
 .../bindings/power/{poweroff.txt => power-controller.txt}           | 0
 Documentation/devicetree/bindings/regulator/act8865-regulator.txt   | 4 ++--
 drivers/regulator/act8865-regulator.c                               | 2 +-
 include/linux/of.h                                                  | 6 +++---
 4 files changed, 6 insertions(+), 6 deletions(-)
 rename Documentation/devicetree/bindings/power/{poweroff.txt => power-controller.txt} (100%)

Documentation/devicetree/bindings/power/power-controller.txt renamed from Documentation/devicetree/bindings/power/poweroff.txt +0 -0

similarity index 100%
rename from Documentation/devicetree/bindings/power/poweroff.txt
rename to Documentation/devicetree/bindings/power/power-controller.txt

Documentation/devicetree/bindings/regulator/act8865-regulator.txt +2 -2

index 01a5b07..dad6358 100644
@@ -6,8 +6,8 @@ Required properties:
 - reg: I2C slave address
 
 Optional properties:
-- poweroff-source: Telling whether or not this pmic is controlling
-  the system power. See Documentation/devicetree/bindings/power/poweroff.txt .
+- system-power-controller: Telling whether or not this pmic is controlling
+  the system power. See Documentation/devicetree/bindings/power/power-controller.txt .
 
 Any standard regulator properties can be used to configure the single regulator.

drivers/regulator/act8865-regulator.c +1 -1

index 76301ed..9eec453 100644
@@ -365,7 +365,7 @@ static int act8865_pmic_probe(struct i2c_client *client,
 		return ret;
 	}
 
-	if (of_system_has_poweroff_source(dev->of_node)) {
+	if (of_device_is_system_power_controller(dev->of_node)) {
 		if (!pm_power_off) {
 			act8865_i2c_client = client;
 			act8865->off_reg = off_reg;

include/linux/of.h +3 -3

index b81dbcf..0abdd70 100644
@@ -964,14 +964,14 @@ static inline int of_changeset_update_property(struct of_changeset *ocs,
 extern int of_resolve_phandles(struct device_node *tree);
 
 /**
- * of_system_has_poweroff_source - Tells if poweroff-source is found for device_node
+ * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
  * @np: Pointer to the given device_node
  *
  * return true if present false otherwise
  */
-static inline bool of_system_has_poweroff_source(const struct device_node *np)
+static inline bool of_device_is_system_power_controller(const struct device_node *np)
 {
-	return of_property_read_bool(np, "poweroff-source");
+	return of_property_read_bool(np, "system-power-controller");
 }
 
 #endif /* _LINUX_OF_H */

Signature · 1 line

1.9.1

Heiko Stübner

2014-11-25 14:48 UTC #4 lore raw

Re: [PATCH v5 1/2] of: Rename "poweroff-source" property to "system-power-controller"

Am Dienstag, 25. November 2014, 14:40:07 schrieb Grant Likely:

Quoted 16 lines

On Tue, 25 Nov 2014 12:28:25 +0000
, Romain Perier <[email protected]>
Quoted 12 lines · wrote:
It reverts commit a4b4e0461ec5 ("of: Add standard property for poweroff capability"). As discussed on the mailing list, it makes more sense to rename back to the old established property name, without the vendor prefix. Problem being that the word "source" usually tends to be used for inputs and that is out of control of the OS. The poweroff capability is an output which simply turns the system-power off. Also, this property might be used by drivers which power-off the system and power back on subsequent RTC alarms. This seems to suggest to remove "poweroff" from the property name and to choose "system-power-controller" as the more generic name. This patchs adds the required renaming changes and defines an helper function which checks if this property is set.

Quoted 7 lines

Quoted 1 line
Signed-off-by Romain Perier <[email protected]>
For both patches:
Acked-by Grant Likely <[email protected]>
Let me know if I need to take this series through my tree. Also, does it need to go into v3.18 and be backported to stable? Or just v3.19.

The original change [that is fixed now] is only scheduled for 3.19 and in Mark Brown's tree [0]. So there shouldn't be anything to do for you now.

Heiko

[0] https://git.kernel.org/cgit/linux/kernel/git/broonie/regulator.git/log/?h=topic/power-off

Johan Hovold

2014-11-25 14:54 UTC #5 lore raw

Re: [PATCH v5 1/2] of: Rename "poweroff-source" property to "system-power-controller"

In reply to Grant Likely

Quoted 14 lines · Grant Likely

Quoted 11 lines · Romain Perier
It reverts commit a4b4e0461ec5 ("of: Add standard property for poweroff capability"). As discussed on the mailing list, it makes more sense to rename back to the old established property name, without the vendor prefix. Problem being that the word "source" usually tends to be used for inputs and that is out of control of the OS. The poweroff capability is an output which simply turns the system-power off. Also, this property might be used by drivers which power-off the system and power back on subsequent RTC alarms. This seems to suggest to remove "poweroff" from the property name and to choose "system-power-controller" as the more generic name. This patchs adds the required renaming changes and defines an helper function which checks if this property is set.

Quoted 7 lines

Quoted 1 line
Signed-off-by Romain Perier <[email protected]>
For both patches:
Acked-by Grant Likely <[email protected]>
Let me know if I need to take this series through my tree. Also, does it need to go into v3.18 and be backported to stable? Or just v3.19.

It's only needed in the regulator tree for 3.19, and does not need to be backported.

We could convert the drivers (and dts) that currently use "<vendor>,system-power-controller" to use the new helper (while maintaining backward compatibility) after 3.19-rc1 is out.

Johan

Romain Perier

author

2014-11-25 15:57 UTC #6 lore raw

Re: [PATCH v5 1/2] of: Rename "poweroff-source" property to "system-power-controller"

Thanks for your feedbacks. I think that Mark will probably wait until there are more reviews on this serie. (this is exactly what he asked for the previous one)

2014-11-25 15:54 GMT+01:00 Johan Hovold <[email protected]>:

Quoted 31 lines · Grant Likely

Quoted 14 lines
Quoted 11 lines · Romain Perier
It reverts commit a4b4e0461ec5 ("of: Add standard property for poweroff capability"). As discussed on the mailing list, it makes more sense to rename back to the old established property name, without the vendor prefix. Problem being that the word "source" usually tends to be used for inputs and that is out of control of the OS. The poweroff capability is an output which simply turns the system-power off. Also, this property might be used by drivers which power-off the system and power back on subsequent RTC alarms. This seems to suggest to remove "poweroff" from the property name and to choose "system-power-controller" as the more generic name. This patchs adds the required renaming changes and defines an helper function which checks if this property is set.
Quoted 7 lines
Quoted 1 line
Signed-off-by Romain Perier <[email protected]>
For both patches:
Acked-by Grant Likely <[email protected]>
Let me know if I need to take this series through my tree. Also, does it need to go into v3.18 and be backported to stable? Or just v3.19.
It's only needed in the regulator tree for 3.19, and does not need to be backported.
We could convert the drivers (and dts) that currently use "<vendor>,system-power-controller" to use the new helper (while maintaining backward compatibility) after 3.19-rc1 is out.
Johan

Mark Brown

maintainer

2014-11-25 17:12 UTC #7 lore raw

Re: [PATCH v5 1/2] of: Rename "poweroff-source" property to "system-power-controller"

Quoted 3 lines · Romain Perier

Thanks for your feedbacks. I think that Mark will probably wait until there are more reviews on this serie. (this is exactly what he asked for the previous one)

Yeah, given the amount of often late arriving disagreement I'd rather
let things cook for a while unless there are a lot of people being vocal
about this being what we want to go with.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 473 bytes
Desc: Digital signature
URL: <http://lists.infradead.org/pipermail/linux-arm-kernel/attachments/20141125/20f3a59a/attachment-0001.sig>

Romain Perier

author

2014-11-26 10:08 UTC #8 lore raw

Re: [PATCH v5 1/2] of: Rename "poweroff-source" property to "system-power-controller"

2014-11-25 18:12 GMT+01:00 Mark Brown <[email protected]>:

Quoted 3 lines

Yeah, given the amount of often late arriving disagreement I'd rather let things cook for a while unless there are a lot of people being vocal about this being what we want to go with.

In other words, I need more reviews and more positives feedbacks about this serie (as far as people who were against the previous ones). For example, Feedbacks from Felipe Balbi and Lucas Stach would be welcome.

Thanks,
Romain

Romain Perier

author

2014-11-25 12:28 UTC #9 lore raw

PATCH v5 2/2 dt-bindings: Update documentation for "system-power-controller" and fix misspellings

In reply to Romain Perier

Signed-off-by Romain Perier <[email protected]>

---
 .../devicetree/bindings/power/power-controller.txt   | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

Documentation/devicetree/bindings/power/power-controller.txt +10 ~~-10~~

index 845868b..4f7a3bc 100644
@@ -1,18 +1,18 @@
-* Generic Poweroff capability
+* Generic system power control capability
 
-Power-management integrated circuits or miscellaneous harware components are
-sometimes able to control the system power. The device driver associated to these
-components might needs to define poweroff capability, which tells to the kernel
-how to switch off the system. The corresponding driver must have the standard
-property "poweroff-source" in its device node. This property marks the device as
-able to shutdown the system. In order to test if this property is found
-programmatically, use the helper function "of_system_has_poweroff_source" from
-of.h .
+Power-management integrated circuits or miscellaneous hardware components are
+sometimes able to control the system power. The device driver associated with these
+components might need to define this capability, which tells the kernel that
+it can be used to switch off the system. The corresponding device must have the
+standard property "system-power-controller" in its device node. This property
+marks the device as able to control the system power. In order to test if this
+property is found programmatically, use the helper function
+"of_device_is_system_power_controller" from of.h .
 
 Example:
 
 act8846: act8846 at 5 {
 	 compatible = "active-semi,act8846";
 	 status = "okay";
-	 poweroff-source;
+	 system-power-controller;
 }

Signature · 1 line

1.9.1

Mark Brown

maintainer

2014-12-01 19:33 UTC #10 lore raw

In reply to Romain Perier

Quoted 7 lines · Romain Perier

The goal of this serie is to rename the property "poweroff-source" to "system-power-controller". After discussions, it makes more sense to rename back to the old established property name. This patches serie reverts commit a4b4e0461ec5 ("of: Add standard property for poweroff capability").
Changes since v4:
- Renamed the helper function to of_device_is_system_power_controller

Applied both, thanks.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 473 bytes
Desc: Digital signature
URL: <http://lists.infradead.org/pipermail/linux-arm-kernel/attachments/20141201/ebc6c27c/attachment.sig>