diff mbox

[V2,1/2] Documentation: devicetree: mfd: twl4030-power: Use the standard 'ti,system-power-controller' to mark power control

Message ID 1410957252-764-2-git-send-email-nm@ti.com
State New
Headers show

Commit Message

Nishanth Menon Sept. 17, 2014, 12:34 p.m. UTC
ti,system-power-controller is more or less the standard way of
indicating that the PMIC is the system wide power controller and hence
may be used to switch off the system. Almost ALL TI PMIC drivers and
many Maxim PMIC drivers follow the same style.

So support 'ti,system-power-controller' in addition to the usual
'ti,use_poweroff' to indicate that the PMIC instance has control for
switching off the system.

Signed-off-by: Nishanth Menon <nm@ti.com>
---

V2: picked up documentation suggestion from Sebastien
V1: https://patchwork.kernel.org/patch/4836381/

 .../devicetree/bindings/mfd/twl4030-power.txt      |    9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

Comments

Lee Jones Sept. 17, 2014, 3:44 p.m. UTC | #1
On Wed, 17 Sep 2014, Nishanth Menon wrote:

> ti,system-power-controller is more or less the standard way of
> indicating that the PMIC is the system wide power controller and hence
> may be used to switch off the system. Almost ALL TI PMIC drivers and
> many Maxim PMIC drivers follow the same style.
> 
> So support 'ti,system-power-controller' in addition to the usual
> 'ti,use_poweroff' to indicate that the PMIC instance has control for
> switching off the system.
> 
> Signed-off-by: Nishanth Menon <nm@ti.com>
> ---
> 
> V2: picked up documentation suggestion from Sebastien

It would be good to get Sebastian's Ack.

> V1: https://patchwork.kernel.org/patch/4836381/
> 
>  .../devicetree/bindings/mfd/twl4030-power.txt      |    9 +++++++--
>  1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/mfd/twl4030-power.txt b/Documentation/devicetree/bindings/mfd/twl4030-power.txt
> index b9ee7b9..a7390c7 100644
> --- a/Documentation/devicetree/bindings/mfd/twl4030-power.txt
> +++ b/Documentation/devicetree/bindings/mfd/twl4030-power.txt
> @@ -23,8 +23,13 @@ down during off-idle. Note that this does not work on all boards
>  depending on how the external oscillator is wired.
>  
>  Optional properties:
> -- ti,use_poweroff: With this flag, the chip will initiates an ACTIVE-to-OFF or
> -		   SLEEP-to-OFF transition when the system poweroffs.
> +
> +- ti,system-power-controller: This indicates that TWL4030 is the
> +  power supply master of the system. With this flag, the chip will
> +  initiates an ACTIVE-to-OFF or SLEEP-to-OFF transition when the
> +  system poweroffs.
> +
> +- ti,use_poweroff: Deprecated name for ti,system-power-controller
>  
>  Example:
>  &i2c1 {
Sebastian Reichel Sept. 17, 2014, 4:55 p.m. UTC | #2
On Wed, Sep 17, 2014 at 08:44:00AM -0700, Lee Jones wrote:
> On Wed, 17 Sep 2014, Nishanth Menon wrote:
> > ti,system-power-controller is more or less the standard way of
> > indicating that the PMIC is the system wide power controller and hence
> > may be used to switch off the system. Almost ALL TI PMIC drivers and
> > many Maxim PMIC drivers follow the same style.
> > 
> > So support 'ti,system-power-controller' in addition to the usual
> > 'ti,use_poweroff' to indicate that the PMIC instance has control for
> > switching off the system.
> > 
> > Signed-off-by: Nishanth Menon <nm@ti.com>
> > ---
> > 
> > V2: picked up documentation suggestion from Sebastien
> 
> It would be good to get Sebastian's Ack.

Acked-By: Sebastian Reichel <sre@kernel.org>

[...]

> > +- ti,system-power-controller: This indicates that TWL4030 is the
> > +  power supply master of the system. With this flag, the chip will
> > +  initiates an ACTIVE-to-OFF or SLEEP-to-OFF transition when the
> > +  system poweroffs.

One minor thing: While the documentation is updated you may want to
fix the typo "will initiates" to "will initiate" (or just drop the
"will").

-- Sebastian
Lee Jones Sept. 17, 2014, 9:39 p.m. UTC | #3
On Wed, 17 Sep 2014, Sebastian Reichel wrote:

> On Wed, Sep 17, 2014 at 08:44:00AM -0700, Lee Jones wrote:
> > On Wed, 17 Sep 2014, Nishanth Menon wrote:
> > > ti,system-power-controller is more or less the standard way of
> > > indicating that the PMIC is the system wide power controller and hence
> > > may be used to switch off the system. Almost ALL TI PMIC drivers and
> > > many Maxim PMIC drivers follow the same style.
> > > 
> > > So support 'ti,system-power-controller' in addition to the usual
> > > 'ti,use_poweroff' to indicate that the PMIC instance has control for
> > > switching off the system.
> > > 
> > > Signed-off-by: Nishanth Menon <nm@ti.com>
> > > ---
> > > 
> > > V2: picked up documentation suggestion from Sebastien
> > 
> > It would be good to get Sebastian's Ack.
> 
> Acked-By: Sebastian Reichel <sre@kernel.org>
> 
> [...]
> 
> > > +- ti,system-power-controller: This indicates that TWL4030 is the
> > > +  power supply master of the system. With this flag, the chip will
> > > +  initiates an ACTIVE-to-OFF or SLEEP-to-OFF transition when the
> > > +  system poweroffs.
> 
> One minor thing: While the documentation is updated you may want to
> fix the typo "will initiates" to "will initiate" (or just drop the
> "will").

Applied with Sebastian's Ack and I fixed this up too.
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mfd/twl4030-power.txt b/Documentation/devicetree/bindings/mfd/twl4030-power.txt
index b9ee7b9..a7390c7 100644
--- a/Documentation/devicetree/bindings/mfd/twl4030-power.txt
+++ b/Documentation/devicetree/bindings/mfd/twl4030-power.txt
@@ -23,8 +23,13 @@  down during off-idle. Note that this does not work on all boards
 depending on how the external oscillator is wired.
 
 Optional properties:
-- ti,use_poweroff: With this flag, the chip will initiates an ACTIVE-to-OFF or
-		   SLEEP-to-OFF transition when the system poweroffs.
+
+- ti,system-power-controller: This indicates that TWL4030 is the
+  power supply master of the system. With this flag, the chip will
+  initiates an ACTIVE-to-OFF or SLEEP-to-OFF transition when the
+  system poweroffs.
+
+- ti,use_poweroff: Deprecated name for ti,system-power-controller
 
 Example:
 &i2c1 {