diff mbox

[v5,11/15] tpm/tpm_i2c_stm_st33/dts/st33zp24_i2c: Add DTS Documentation

Message ID 1417393247-4479-12-git-send-email-christophe-h.ricard@st.com (mailing list archive)
State New, archived
Headers show

Commit Message

Christophe Ricard Dec. 1, 2014, 12:20 a.m. UTC
st33zp24 tpm can be seen as a trivial i2c device as other i2c tpm.
However several other properties needs to be documented such as lpcpd.

Reviewed-by: Jason Gunthorpe <jgunthorpe@obsidianresearch.com>
Signed-off-by: Christophe Ricard <christophe-h.ricard@st.com>
---
 .../devicetree/bindings/security/tpm/st33zp24.txt  | 36 ++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/security/tpm/st33zp24.txt

Comments

Mark Rutland Dec. 1, 2014, 10:46 a.m. UTC | #1
On Mon, Dec 01, 2014 at 12:20:43AM +0000, Christophe Ricard wrote:
> st33zp24 tpm can be seen as a trivial i2c device as other i2c tpm.
> However several other properties needs to be documented such as lpcpd.
> 
> Reviewed-by: Jason Gunthorpe <jgunthorpe@obsidianresearch.com>
> Signed-off-by: Christophe Ricard <christophe-h.ricard@st.com>
> ---
>  .../devicetree/bindings/security/tpm/st33zp24.txt  | 36 ++++++++++++++++++++++
>  1 file changed, 36 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/security/tpm/st33zp24.txt
> 
> diff --git a/Documentation/devicetree/bindings/security/tpm/st33zp24.txt b/Documentation/devicetree/bindings/security/tpm/st33zp24..txt
> new file mode 100644
> index 0000000..eb48222
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/security/tpm/st33zp24.txt
> @@ -0,0 +1,36 @@
> +* STMicroelectronics SAS. ST33ZP24 TPM SoC
> +
> +Required properties:
> +- compatible: Should be "st,st33zp24_i2c".

s/_/-/ in property names and compatible strings, please.

> +- clock-frequency: I²C work frequency.
> +- reg: address on the bus
> +
> +Optional ST33ZP24 Properties:
> +- interrupt-parent: phandle for the interrupt gpio controller
> +- interrupts: GPIO interrupt to which the chip is connected
> +- lpcpd-gpios: Output GPIO pin used for ST33ZP24 power management D1/D2 state.
> +If set vps must present when the platform is going into sleep/hibernate mode.

What is 'vps'?

Mark.

> +
> +Optional SoC Specific Properties:
> +- pinctrl-names: Contains only one value - "default".
> +- pintctrl-0: Specifies the pin control groups used for this controller.
> +
> +Example (for ARM-based BeagleBoard xM with ST33ZP24 on I2C2):
> +
> +&i2c2 {
> +
> +        status = "okay";
> +
> +        st33zp24: st33zp24@13 {
> +
> +                compatible = "st,st33zp24_i2c";
> +
> +                reg = <0x013>;
> +                clock-frequency = <400000>;
> +
> +                interrupt-parent = <&gpio5>;
> +                interrupts = <7 IRQ_TYPE_LEVEL_HIGH>;
> +
> +                lpcpd-gpios = <&gpio5 15 GPIO_ACTIVE_HIGH>;
> +        };
> +};
> -- 
> 2.1.0
> 
> --
> To unsubscribe from this list: send the line "unsubscribe devicetree" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> 

------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=157005751&iu=/4140/ostg.clktrk
Christophe Ricard Dec. 1, 2014, 4:13 p.m. UTC | #2
Hi Mark,

Does st,st33zp24-i2c as a compatible string would fit better here ?
VPS stands for Voltage power supply.

I think i should rephrase it:
"If set, power must be present when the platform is going into
sleep/hibernate mode."

Would it be ok ?

Best Regards
Christophe

2014-12-01 11:46 GMT+01:00 Mark Rutland <mark.rutland@arm.com>:

> On Mon, Dec 01, 2014 at 12:20:43AM +0000, Christophe Ricard wrote:
> > st33zp24 tpm can be seen as a trivial i2c device as other i2c tpm.
> > However several other properties needs to be documented such as lpcpd.
> >
> > Reviewed-by: Jason Gunthorpe <jgunthorpe@obsidianresearch.com>
> > Signed-off-by: Christophe Ricard <christophe-h.ricard@st.com>
> > ---
> >  .../devicetree/bindings/security/tpm/st33zp24.txt  | 36
> ++++++++++++++++++++++
> >  1 file changed, 36 insertions(+)
> >  create mode 100644
> Documentation/devicetree/bindings/security/tpm/st33zp24.txt
> >
> > diff --git a/Documentation/devicetree/bindings/security/tpm/st33zp24.txt
> b/Documentation/devicetree/bindings/security/tpm/st33zp24.txt
> > new file mode 100644
> > index 0000000..eb48222
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/security/tpm/st33zp24.txt
> > @@ -0,0 +1,36 @@
> > +* STMicroelectronics SAS. ST33ZP24 TPM SoC
> > +
> > +Required properties:
> > +- compatible: Should be "st,st33zp24_i2c".
>
> s/_/-/ in property names and compatible strings, please.
>
> > +- clock-frequency: I²C work frequency.
> > +- reg: address on the bus
> > +
> > +Optional ST33ZP24 Properties:
> > +- interrupt-parent: phandle for the interrupt gpio controller
> > +- interrupts: GPIO interrupt to which the chip is connected
> > +- lpcpd-gpios: Output GPIO pin used for ST33ZP24 power management D1/D2
> state.
> > +If set vps must present when the platform is going into sleep/hibernate
> mode.
>
> What is 'vps'?
>
> Mark.
>
> > +
> > +Optional SoC Specific Properties:
> > +- pinctrl-names: Contains only one value - "default".
> > +- pintctrl-0: Specifies the pin control groups used for this controller.
> > +
> > +Example (for ARM-based BeagleBoard xM with ST33ZP24 on I2C2):
> > +
> > +&i2c2 {
> > +
> > +        status = "okay";
> > +
> > +        st33zp24: st33zp24@13 {
> > +
> > +                compatible = "st,st33zp24_i2c";
> > +
> > +                reg = <0x013>;
> > +                clock-frequency = <400000>;
> > +
> > +                interrupt-parent = <&gpio5>;
> > +                interrupts = <7 IRQ_TYPE_LEVEL_HIGH>;
> > +
> > +                lpcpd-gpios = <&gpio5 15 GPIO_ACTIVE_HIGH>;
> > +        };
> > +};
> > --
> > 2.1.0
> >
> > --
> > To unsubscribe from this list: send the line "unsubscribe devicetree" in
> > the body of a message to majordomo@vger.kernel.org
> > More majordomo info at  http://vger.kernel.org/majordomo-info.html
> >
>
------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=157005751&iu=/4140/ostg.clktrk
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/security/tpm/st33zp24.txt b/Documentation/devicetree/bindings/security/tpm/st33zp24.txt
new file mode 100644
index 0000000..eb48222
--- /dev/null
+++ b/Documentation/devicetree/bindings/security/tpm/st33zp24.txt
@@ -0,0 +1,36 @@ 
+* STMicroelectronics SAS. ST33ZP24 TPM SoC
+
+Required properties:
+- compatible: Should be "st,st33zp24_i2c".
+- clock-frequency: I²C work frequency.
+- reg: address on the bus
+
+Optional ST33ZP24 Properties:
+- interrupt-parent: phandle for the interrupt gpio controller
+- interrupts: GPIO interrupt to which the chip is connected
+- lpcpd-gpios: Output GPIO pin used for ST33ZP24 power management D1/D2 state.
+If set vps must present when the platform is going into sleep/hibernate mode.
+
+Optional SoC Specific Properties:
+- pinctrl-names: Contains only one value - "default".
+- pintctrl-0: Specifies the pin control groups used for this controller.
+
+Example (for ARM-based BeagleBoard xM with ST33ZP24 on I2C2):
+
+&i2c2 {
+
+        status = "okay";
+
+        st33zp24: st33zp24@13 {
+
+                compatible = "st,st33zp24_i2c";
+
+                reg = <0x013>;
+                clock-frequency = <400000>;
+
+                interrupt-parent = <&gpio5>;
+                interrupts = <7 IRQ_TYPE_LEVEL_HIGH>;
+
+                lpcpd-gpios = <&gpio5 15 GPIO_ACTIVE_HIGH>;
+        };
+};