[PATCH linux-next v6 01/13] dt-bindings: Add a document of PECI subsystem

[Rob Herring]

On Thu, Jun 21, 2018 at 12:39:47PM -0700, Jae Hyun Yoo wrote:
> This commit adds a document of generic PECI bus, adapter and client
> driver.
> 
> Signed-off-by: Jae Hyun Yoo <jae.hyun.yoo at linux.intel.com>
> Reviewed-by: Haiyue Wang <haiyue.wang at linux.intel.com>
> Reviewed-by: James Feist <james.feist at linux.intel.com>
> Reviewed-by: Vernon Mauery <vernon.mauery at linux.intel.com>
> Cc: Andrew Jeffery <andrew at aj.id.au>
> Cc: Joel Stanley <joel at jms.id.au>
> ---
>  .../devicetree/bindings/peci/peci.txt         | 60 +++++++++++++++++++
>  1 file changed, 60 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/peci/peci.txt
> 
> diff --git a/Documentation/devicetree/bindings/peci/peci.txt b/Documentation/devicetree/bindings/peci/peci.txt
> new file mode 100644
> index 000000000000..5583aa80b78a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/peci/peci.txt
> @@ -0,0 +1,60 @@
> +Generic device tree configuration for PECI buses
> +================================================
> +
> +Required properties:
> +- compatible     : Should be "simple-bus".
> +- #address-cells : Should be present if the device has sub-nodes.
> +- #size-cells    : Should be present if the device has sub-nodes.
> +- ranges         : Should contain PECI controller registers ranges.
> +
> +Example:
> +	peci: peci at 10000000 {
> +		compatible = "simple-bus";
> +		#address-cells = <1>;
> +		#size-cells = <1>;
> +		ranges = <0x0 0x10000000 0x1000>;
> +	};

I don't think you need this section. It's just the parent of the 
controller, right?

> +
> +Generic device tree configuration for PECI adapters
> +===================================================
> +
> +Required properties:
> +- #address-cells : Should be <1>. Read more about client addresses below.
> +- #size-cells    : Should be <0>. Read more about client addresses below.
> +
> +The cells properties above define that an address of CPU clients of a PECI bus
> +are described by a single value.
> +
> +Example:
> +	peci0: peci-bus at 0 {
> +		compatible = "vendor,soc-peci";
> +		reg = <0x0 0x1000>;
> +		#address-cells = <1>;
> +		#size-cells = <0>;
> +	};
> +
> +Generic device tree configuration for PECI clients
> +==================================================
> +
> +Required properties:
> +- compatible : Should contain name of PECI client.
> +- reg        : Should contain address of a client CPU. Address range of CPU
> +	       clients starts from 0x30 based on PECI specification.
> +
> +Example:
> +	peci-bus at 0 {
> +		compatible = "vendor,soc-peci";
> +		reg = <0x0 0x1000>;
> +		#address-cells = <1>;
> +		#size-cells = <0>;
> +
> +		peci-client at 30 {
> +			compatible = "vendor,peci-client";
> +			reg = <0x30>;
> +		};
> +
> +		peci-client at 31 {
> +			compatible = "vendor,peci-client";
> +			reg = <0x31>;
> +		};
> +	};
> -- 
> 2.17.1
>