[v6,7/8] dt-bindings: Introduce interconnect consumers bindings

Message ID 20180709155104.25528-8-georgi.djakov@linaro.org
State New
Headers show
Series
  • Introduce on-chip interconnect API
Related show

Commit Message

Georgi Djakov July 9, 2018, 3:51 p.m.
Add documentation for the interconnect consumer bindings, that will allow
to link a device node (consumer) to its interconnect controller hardware.

Tha aim is to enable drivers to request a framework API to configure an
interconnect path by providing their struct device pointer and a name.

Signed-off-by: Georgi Djakov <georgi.djakov@linaro.org>

---
 .../bindings/interconnect/interconnect.txt    | 27 +++++++++++++++++++
 1 file changed, 27 insertions(+)

Comments

Evan Green July 10, 2018, 10:34 p.m. | #1
On Mon, Jul 9, 2018 at 8:51 AM Georgi Djakov <georgi.djakov@linaro.org> wrote:
>

> Add documentation for the interconnect consumer bindings, that will allow

> to link a device node (consumer) to its interconnect controller hardware.

>

> Tha aim is to enable drivers to request a framework API to configure an

> interconnect path by providing their struct device pointer and a name.

>

> Signed-off-by: Georgi Djakov <georgi.djakov@linaro.org>

> ---

>  .../bindings/interconnect/interconnect.txt    | 27 +++++++++++++++++++

>  1 file changed, 27 insertions(+)

>

> diff --git a/Documentation/devicetree/bindings/interconnect/interconnect.txt b/Documentation/devicetree/bindings/interconnect/interconnect.txt

> index 6e2b2971b094..0ad65dccbe8b 100644

> --- a/Documentation/devicetree/bindings/interconnect/interconnect.txt

> +++ b/Documentation/devicetree/bindings/interconnect/interconnect.txt

> @@ -31,3 +31,30 @@ Example:

>                         clocks = <&rpmcc RPM_SMD_SNOC_CLK>,

>                                  <&rpmcc RPM_SMD_SNOC_A_CLK>;

>                 };

> +

> +

> += interconnect consumers =

> +

> +The interconnect consumers are device nodes which consume the interconnect

> +path(s) provided by the interconnect provider. There can be multiple


I wonder if this sentence could be more descriptive. Maybe something like:

The interconnect consumers are device nodes which dynamically express
their bandwidth requirements along interconnect paths they are
connected to.

...or choose a better one if this one's a mouthful.

> +interconnect providers on a SoC and the consumer may consume multiple paths

> +from different providers depending on use case and the components it has to

> +interact with.

> +

> +Required properties:

> +interconnects : Pairs of phandles and interconnect provider specifier to denote

> +               the edge source and destination ports of the interconnect path.

> +

> +Optional properties:

> +interconnect-names : List of interconnect path name strings sorted in the same

> +                    order as the interconnects property. Consumers drivers will use

> +                    interconnect-names to match interconnect paths with interconnect

> +                    specifiers.

> +

> +Example:

> +

> +       sdhci@7864000 {

> +               ...

> +               interconnects = <&pnoc MASTER_SDCC_1 &bimc SLAVE_EBI_CH0>;

> +               interconnect-names = "ddr";

> +       };

Patch

diff --git a/Documentation/devicetree/bindings/interconnect/interconnect.txt b/Documentation/devicetree/bindings/interconnect/interconnect.txt
index 6e2b2971b094..0ad65dccbe8b 100644
--- a/Documentation/devicetree/bindings/interconnect/interconnect.txt
+++ b/Documentation/devicetree/bindings/interconnect/interconnect.txt
@@ -31,3 +31,30 @@  Example:
 			clocks = <&rpmcc RPM_SMD_SNOC_CLK>,
 				 <&rpmcc RPM_SMD_SNOC_A_CLK>;
 		};
+
+
+= interconnect consumers =
+
+The interconnect consumers are device nodes which consume the interconnect
+path(s) provided by the interconnect provider. There can be multiple
+interconnect providers on a SoC and the consumer may consume multiple paths
+from different providers depending on use case and the components it has to
+interact with.
+
+Required properties:
+interconnects : Pairs of phandles and interconnect provider specifier to denote
+	        the edge source and destination ports of the interconnect path.
+
+Optional properties:
+interconnect-names : List of interconnect path name strings sorted in the same
+		     order as the interconnects property. Consumers drivers will use
+		     interconnect-names to match interconnect paths with interconnect
+		     specifiers.
+
+Example:
+
+	sdhci@7864000 {
+		...
+		interconnects = <&pnoc MASTER_SDCC_1 &bimc SLAVE_EBI_CH0>;
+		interconnect-names = "ddr";
+	};