Re: [PATCH] Documentation: tpm: Adds the TPM device tree node documentation

[Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>]

On Tue, Aug 30, 2016 at 09:36:31AM +0300, Jarkko Sakkinen wrote:
> On Tue, Aug 30, 2016 at 12:44:37AM -0400, Nayna Jain wrote:
> > This is documenting device tree binding for
> > I2C based TPM, similar concept which being used
> > for virtual TPM on POWER7 and POWER8 systems running PowerVM.
> > 
> > Signed-off-by: Nayna Jain <nayna-23VcF4HTsmIX0ybBhKVfKdBPR1lH4CV8@public.gmane.org>
> > ---
> >  Documentation/devicetree/bindings/i2c/i2c-tpm.txt | 29 +++++++++++++++++++++++
> >  1 file changed, 29 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/i2c/i2c-tpm.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/i2c/i2c-tpm.txt b/Documentation/devicetree/bindings/i2c/i2c-tpm.txt
> > new file mode 100644
> > index 0000000..8fdee14
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/i2c/i2c-tpm.txt
> > @@ -0,0 +1,29 @@
> > +Device Tree Bindings for I2C based Trusted Platform Module(TPM)
> > +---------------------------------------------------------------
> > +
> > +This node describes a TPM device connected to Processor on i2c bus.
> > +
> > +Required properties:
> > +
> > +- compatible : 'manufacturer,model'
> > +- label : represents device type
> > +- linux,sml-base : base address of the Event Log. It is a physical address.
> > +		   sml stands for shared memory log.
> > +- linux,sml-size : size of the memory allocated for the Event Log.
> > +
> > +Optional properties:
> > +
> > +- status: indicates whether the device is enabled or disabled. "okay" for
> > +          enabled and "disabled" for disabled.
> > +
> > +Example
> > +-------
> > +
> > +tpm@57 {
> > +	reg = <0x57>;
> > +	label = "tpm";
> > +	compatible = "nuvoton,npct650", "nuvoton,npct601";
> > +	linux,sml-base = <0x7f 0xfd450000>;
> > +	linux,sml-size = <0x10000>;
> > +	status = "okay";
> > +};
> 
> I would rather name the fields event-log-base and event-log-size. They
> would be much more readable and obvious names.
> 
> Also, enabled should be "enabled", not "okay".

No, okay is correct. But as I mentioned, don't document it here.

Rob

------------------------------------------------------------------------------