Re: [PATCH linux-next v5 07/13] dt-bindings: mfd: Add a document for PECI client mfd

[Jae Hyun Yoo]

Thanks for the review. Please check my answers inline.

On 6/12/2018 11:16 PM, Lee Jones wrote:
> All s/mfd/MFD/

Got it. Will fix it.

> > This commit adds a dt-bindings document for PECI client multi-function
> > device.
>
> Multi-Function Device

Will fix it.

> > Signed-off-by: Jae Hyun Yoo <jae.hyun.yoo@xxxxxxxxxxxxxxx>
> > Cc: Andrew Jeffery <andrew@xxxxxxxx>
> > Cc: James Feist <james.feist@xxxxxxxxxxxxxxx>
> > Cc: Jason M Biils <jason.m.bills@xxxxxxxxxxxxxxx>
> > Cc: Joel Stanley <joel@xxxxxxxxx>
> > Cc: Vernon Mauery <vernon.mauery@xxxxxxxxxxxxxxx>
> > ---
> >   .../devicetree/bindings/mfd/peci-client.txt   | 23 +++++++++++++++++++
> >   1 file changed, 23 insertions(+)
> >   create mode 100644 Documentation/devicetree/bindings/mfd/peci-client.txt
> >
> > diff --git a/Documentation/devicetree/bindings/mfd/peci-client.txt b/Documentation/devicetree/bindings/mfd/peci-client.txt
> > new file mode 100644
> > index 000000000000..4eb8f6bb6ca4
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/mfd/peci-client.txt
> > @@ -0,0 +1,23 @@
> > +* Intel PECI client bindings
>
> Now it the time to expand on what a "PECI client" is.

Okay, I'll add more description about the "PECI client".

> > +Required properties:
> > +- compatible : Should be "intel,peci-client", "simple-mfd".
> > +- reg        : Should contain address of a client CPU. Address range of CPU
> > +	       clients is starting from 0x30 based on PECI specification.
>
> s/is starting/start/

Will change it to "Address range of CPU clients starts from ...".

> > +Example:
> > +	peci-bus@0 {
>
> 0?

Because the actual reg value of the peci bus is reg = <0x0 0x60> but
anyway it's an example.

> > +		#address-cells = <1>;
> > +		#size-cells = <0>;
>
> No 'reg' property?

This is the actual peci bus node which is a parent of this MFD node:
	peci0: peci-bus@0 {
		compatible = "aspeed,ast2500-peci";
		reg = <0x0 0x60>;
		#address-cells = <1>;
		#size-cells = <0>;
		interrupts = <15>;
		clocks = <&syscon ASPEED_CLK_GATE_REFCLK>;
		resets = <&syscon ASPEED_RESET_PECI>;
		clock-frequency = <24000000>;
		msg-timing = <1>;
		addr-timing = <1>;
		rd-sampling-point = <8>;
		cmd-timeout-ms = <1000>;
	};

> > +		< more properties >
>
> Remove this.

I dropped all other properties into < more properties > because I want
to show the #address-cells and #size-cells to state its sub-nodes
should have a single unique reg value. Should I remove this line or the
whole parent node?

> > +		peci-client@30 {
> > +			compatible = "intel,peci-client", "simple-mfd";
> > +			reg = <0x30>;
> > +		};
> > +
> > +		peci-client@31 {
> > +			compatible = "intel,peci-client", "simple-mfd";
> > +			reg = <0x31>;
> > +		};
> > +	};