Skip to contentSkip to conversation

dt-bindings: media: Convert video-mux to DT schema

PATCH In review Rob Herring 3 participants 8 messages Mar 11, 2021 – Mar 15, 2021

Subsystems (2)
lore
Share & tools
lore

Rob Herring

author maintainer
#0 lore raw

PATCH 1/1 dt-bindings: media: Convert video-mux to DT schema

Now that we have the graph schema, convert the video-mux binding to DT schema.

Cc Sakari Ailus <[email protected]>
Cc Laurent Pinchart <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
---
 .../devicetree/bindings/media/video-mux.txt   | 60 ------------
 .../devicetree/bindings/media/video-mux.yaml  | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/video-mux.txt
 create mode 100644 Documentation/devicetree/bindings/media/video-mux.yaml
Documentation/devicetree/bindings/media/video-mux.txt deleted +0 -60
deleted file mode 100644
index 63b9dc913e45..000000000000
@@ -1,60 +0,0 @@
-Video Multiplexer
-=================
-
-Video multiplexers allow to select between multiple input ports. Video received
-on the active input port is passed through to the output port. Muxes described
-by this binding are controlled by a multiplexer controller that is described by
-the bindings in Documentation/devicetree/bindings/mux/mux-controller.txt
-
-Required properties:
-- compatible : should be "video-mux"
-- mux-controls : mux controller node to use for operating the mux
-- #address-cells: should be <1>
-- #size-cells: should be <0>
-- port@*: at least three port nodes containing endpoints connecting to the
-  source and sink devices according to of_graph bindings. The last port is
-  the output port, all others are inputs.
-
-Optionally, #address-cells, #size-cells, and port nodes can be grouped under a
-ports node as described in Documentation/devicetree/bindings/graph.txt.
-
-Example:
-
-	mux: mux-controller {
-		compatible = "gpio-mux";
-		#mux-control-cells = <0>;
-
-		mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
-	};
-
-	video-mux {
-		compatible = "video-mux";
-		mux-controls = <&mux>;
-		#address-cells = <1>;
-		#size-cells = <0>;
-
-		port@0 {
-			reg = <0>;
-
-			mux_in0: endpoint {
-				remote-endpoint = <&video_source0_out>;
-			};
-		};
-
-		port@1 {
-			reg = <1>;
-
-			mux_in1: endpoint {
-				remote-endpoint = <&video_source1_out>;
-			};
-		};
-
-		port@2 {
-			reg = <2>;
-
-			mux_out: endpoint {
-				remote-endpoint = <&capture_interface_in>;
-			};
-		};
-	};
-};
Documentation/devicetree/bindings/media/video-mux.yaml new file +93 -0

93 lines not on this page · raw message

Signature · 1 line
2.27.0
Reviewed-by on v1 1/1
#1 lore raw

Hi Rob,

Thank you for the patch.

Quoted 113 lines · Rob Herring

Now that we have the graph schema, convert the video-mux binding to DT schema.

Cc Sakari Ailus <[email protected]>
Cc Laurent Pinchart <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
---
 .../devicetree/bindings/media/video-mux.txt   | 60 ------------
 .../devicetree/bindings/media/video-mux.yaml  | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/video-mux.txt
 create mode 100644 Documentation/devicetree/bindings/media/video-mux.yaml
Documentation/devicetree/bindings/media/video-mux.txt deleted +0 -60
deleted file mode 100644
index 63b9dc913e45..000000000000
@@ -1,60 +0,0 @@
-Video Multiplexer
-=================
-
-Video multiplexers allow to select between multiple input ports. Video received
-on the active input port is passed through to the output port. Muxes described
-by this binding are controlled by a multiplexer controller that is described by
-the bindings in Documentation/devicetree/bindings/mux/mux-controller.txt
-
-Required properties:
-- compatible : should be "video-mux"
-- mux-controls : mux controller node to use for operating the mux
-- #address-cells: should be <1>
-- #size-cells: should be <0>
-- port@*: at least three port nodes containing endpoints connecting to the
-  source and sink devices according to of_graph bindings. The last port is
-  the output port, all others are inputs.
-
-Optionally, #address-cells, #size-cells, and port nodes can be grouped under a
-ports node as described in Documentation/devicetree/bindings/graph.txt.
-
-Example:
-
-	mux: mux-controller {
-		compatible = "gpio-mux";
-		#mux-control-cells = <0>;
-
-		mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
-	};
-
-	video-mux {
-		compatible = "video-mux";
-		mux-controls = <&mux>;
-		#address-cells = <1>;
-		#size-cells = <0>;
-
-		port@0 {
-			reg = <0>;
-
-			mux_in0: endpoint {
-				remote-endpoint = <&video_source0_out>;
-			};
-		};
-
-		port@1 {
-			reg = <1>;
-
-			mux_in1: endpoint {
-				remote-endpoint = <&video_source1_out>;
-			};
-		};
-
-		port@2 {
-			reg = <2>;
-
-			mux_out: endpoint {
-				remote-endpoint = <&capture_interface_in>;
-			};
-		};
-	};
-};
Documentation/devicetree/bindings/media/video-mux.yaml new file +26 -0
new file mode 100644
index 000000000000..780fbbd46a38
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/video-mux.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Video Multiplexer
+
+maintainers:
+  - Sakari Ailus <[email protected]>
+  - Laurent Pinchart <[email protected]>
+
+description:
+  Video multiplexers allow to select between multiple input ports. Video
+  received on the active input port is passed through to the output port. Muxes
+  described by this binding are controlled by a multiplexer controller.
+
+properties:
+  compatible:
+    const: video-mux
+
+  mux-controls:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1

Documentation/devicetree/bindings/media/video-mux.yaml line 36

Quoted 10 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +10 -0
+
+  '#size-cells':
+    const: 0
+
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    patternProperties:
+      '^port@':
+        $ref: /schemas/graph.yaml#/properties/port

Should we require at least port@0, port@1 and port@2 ?

Documentation/devicetree/bindings/media/video-mux.yaml line 48

Quoted 12 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +12 -0
+
+patternProperties:
+  '^port@':
+    $ref: /schemas/graph.yaml#/properties/port
+    description:
+      At least three port nodes containing endpoints connecting to the source
+      and sink devices according to of_graph bindings. The last port is the
+      output port, all others are inputs.
+
+required:
+  - compatible
+  - mux-controls

Should a constraint be added to ensure that either a ports node or port@0, port@1 and port@2 nodes exists ?

Quoted 45 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +45 -0
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    mux: mux-controller {
+        compatible = "gpio-mux";
+        #mux-control-cells = <0>;
+
+        mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
+    };
+
+    video-mux {
+        compatible = "video-mux";
+        mux-controls = <&mux>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        port@0 {
+            reg = <0>;
+
+            mux_in0: endpoint {
+                remote-endpoint = <&video_source0_out>;
+            };
+        };
+
+        port@1 {
+            reg = <1>;
+
+            mux_in1: endpoint {
+                remote-endpoint = <&video_source1_out>;
+            };
+        };
+
+        port@2 {
+            reg = <2>;
+
+            mux_out: endpoint {
+                remote-endpoint = <&capture_interface_in>;
+            };
+        };
+    };
+...
Signature · 3 lines
Regards,

Laurent Pinchart
Reviewed-by
#2 lore raw

Hi Laurent,

Quoted 131 lines · Laurent Pinchart

Hi Rob,

Thank you for the patch.

Quoted 113 lines · Rob Herring

Now that we have the graph schema, convert the video-mux binding to DT schema.

Cc Sakari Ailus <[email protected]>
Cc Laurent Pinchart <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
---
 .../devicetree/bindings/media/video-mux.txt   | 60 ------------
 .../devicetree/bindings/media/video-mux.yaml  | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/video-mux.txt
 create mode 100644 Documentation/devicetree/bindings/media/video-mux.yaml
Documentation/devicetree/bindings/media/video-mux.txt deleted +0 -60
deleted file mode 100644
index 63b9dc913e45..000000000000
@@ -1,60 +0,0 @@
-Video Multiplexer
-=================
-
-Video multiplexers allow to select between multiple input ports. Video received
-on the active input port is passed through to the output port. Muxes described
-by this binding are controlled by a multiplexer controller that is described by
-the bindings in Documentation/devicetree/bindings/mux/mux-controller.txt
-
-Required properties:
-- compatible : should be "video-mux"
-- mux-controls : mux controller node to use for operating the mux
-- #address-cells: should be <1>
-- #size-cells: should be <0>
-- port@*: at least three port nodes containing endpoints connecting to the
-  source and sink devices according to of_graph bindings. The last port is
-  the output port, all others are inputs.
-
-Optionally, #address-cells, #size-cells, and port nodes can be grouped under a
-ports node as described in Documentation/devicetree/bindings/graph.txt.
-
-Example:
-
-	mux: mux-controller {
-		compatible = "gpio-mux";
-		#mux-control-cells = <0>;
-
-		mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
-	};
-
-	video-mux {
-		compatible = "video-mux";
-		mux-controls = <&mux>;
-		#address-cells = <1>;
-		#size-cells = <0>;
-
-		port@0 {
-			reg = <0>;
-
-			mux_in0: endpoint {
-				remote-endpoint = <&video_source0_out>;
-			};
-		};
-
-		port@1 {
-			reg = <1>;
-
-			mux_in1: endpoint {
-				remote-endpoint = <&video_source1_out>;
-			};
-		};
-
-		port@2 {
-			reg = <2>;
-
-			mux_out: endpoint {
-				remote-endpoint = <&capture_interface_in>;
-			};
-		};
-	};
-};
Documentation/devicetree/bindings/media/video-mux.yaml new file +26 -0
new file mode 100644
index 000000000000..780fbbd46a38
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/video-mux.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Video Multiplexer
+
+maintainers:
+  - Sakari Ailus <[email protected]>
+  - Laurent Pinchart <[email protected]>
+
+description:
+  Video multiplexers allow to select between multiple input ports. Video
+  received on the active input port is passed through to the output port. Muxes
+  described by this binding are controlled by a multiplexer controller.
+
+properties:
+  compatible:
+    const: video-mux
+
+  mux-controls:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1

Documentation/devicetree/bindings/media/video-mux.yaml line 36

Quoted 10 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +10 -0
+
+  '#size-cells':
+    const: 0
+
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    patternProperties:
+      '^port@':
+        $ref: /schemas/graph.yaml#/properties/port

Should we require at least port@0, port@1 and port@2 ?

Quoted 15 lines

Documentation/devicetree/bindings/media/video-mux.yaml line 48

Quoted 12 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +12 -0
+
+patternProperties:
+  '^port@':
+    $ref: /schemas/graph.yaml#/properties/port
+    description:
+      At least three port nodes containing endpoints connecting to the source
+      and sink devices according to of_graph bindings. The last port is the
+      output port, all others are inputs.
+
+required:
+  - compatible
+  - mux-controls

Should a constraint be added to ensure that either a ports node or port@0, port@1 and port@2 nodes exists ?

It's not meaningful to have this device without such nodes. But a mux with more ports could be connected in a way that leaves one or both of ports 1 and 2 unconnected. It's still not a likely configuration but a possible one.

Either way,

Quoted 48 lines
Quoted 45 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +45 -0
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    mux: mux-controller {
+        compatible = "gpio-mux";
+        #mux-control-cells = <0>;
+
+        mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
+    };
+
+    video-mux {
+        compatible = "video-mux";
+        mux-controls = <&mux>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        port@0 {
+            reg = <0>;
+
+            mux_in0: endpoint {
+                remote-endpoint = <&video_source0_out>;
+            };
+        };
+
+        port@1 {
+            reg = <1>;
+
+            mux_in1: endpoint {
+                remote-endpoint = <&video_source1_out>;
+            };
+        };
+
+        port@2 {
+            reg = <2>;
+
+            mux_out: endpoint {
+                remote-endpoint = <&capture_interface_in>;
+            };
+        };
+    };
+...
Signature · 3 lines
Kind regards,

Sakari Ailus
#3 lore raw

Hi Sakari,

Quoted 144 lines · Sakari Ailus
Quoted 127 lines · Laurent Pinchart
Quoted 113 lines · Rob Herring

Now that we have the graph schema, convert the video-mux binding to DT schema.

Cc Sakari Ailus <[email protected]>
Cc Laurent Pinchart <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
---
 .../devicetree/bindings/media/video-mux.txt   | 60 ------------
 .../devicetree/bindings/media/video-mux.yaml  | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/video-mux.txt
 create mode 100644 Documentation/devicetree/bindings/media/video-mux.yaml
Documentation/devicetree/bindings/media/video-mux.txt deleted +0 -60
deleted file mode 100644
index 63b9dc913e45..000000000000
@@ -1,60 +0,0 @@
-Video Multiplexer
-=================
-
-Video multiplexers allow to select between multiple input ports. Video received
-on the active input port is passed through to the output port. Muxes described
-by this binding are controlled by a multiplexer controller that is described by
-the bindings in Documentation/devicetree/bindings/mux/mux-controller.txt
-
-Required properties:
-- compatible : should be "video-mux"
-- mux-controls : mux controller node to use for operating the mux
-- #address-cells: should be <1>
-- #size-cells: should be <0>
-- port@*: at least three port nodes containing endpoints connecting to the
-  source and sink devices according to of_graph bindings. The last port is
-  the output port, all others are inputs.
-
-Optionally, #address-cells, #size-cells, and port nodes can be grouped under a
-ports node as described in Documentation/devicetree/bindings/graph.txt.
-
-Example:
-
-	mux: mux-controller {
-		compatible = "gpio-mux";
-		#mux-control-cells = <0>;
-
-		mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
-	};
-
-	video-mux {
-		compatible = "video-mux";
-		mux-controls = <&mux>;
-		#address-cells = <1>;
-		#size-cells = <0>;
-
-		port@0 {
-			reg = <0>;
-
-			mux_in0: endpoint {
-				remote-endpoint = <&video_source0_out>;
-			};
-		};
-
-		port@1 {
-			reg = <1>;
-
-			mux_in1: endpoint {
-				remote-endpoint = <&video_source1_out>;
-			};
-		};
-
-		port@2 {
-			reg = <2>;
-
-			mux_out: endpoint {
-				remote-endpoint = <&capture_interface_in>;
-			};
-		};
-	};
-};
Documentation/devicetree/bindings/media/video-mux.yaml new file +26 -0
new file mode 100644
index 000000000000..780fbbd46a38
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/video-mux.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Video Multiplexer
+
+maintainers:
+  - Sakari Ailus <[email protected]>
+  - Laurent Pinchart <[email protected]>
+
+description:
+  Video multiplexers allow to select between multiple input ports. Video
+  received on the active input port is passed through to the output port. Muxes
+  described by this binding are controlled by a multiplexer controller.
+
+properties:
+  compatible:
+    const: video-mux
+
+  mux-controls:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1

Documentation/devicetree/bindings/media/video-mux.yaml line 36

Quoted 10 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +10 -0
+
+  '#size-cells':
+    const: 0
+
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    patternProperties:
+      '^port@':
+        $ref: /schemas/graph.yaml#/properties/port

Should we require at least port@0, port@1 and port@2 ?

Quoted 15 lines

Documentation/devicetree/bindings/media/video-mux.yaml line 48

Quoted 12 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +12 -0
+
+patternProperties:
+  '^port@':
+    $ref: /schemas/graph.yaml#/properties/port
+    description:
+      At least three port nodes containing endpoints connecting to the source
+      and sink devices according to of_graph bindings. The last port is the
+      output port, all others are inputs.
+
+required:
+  - compatible
+  - mux-controls

Should a constraint be added to ensure that either a ports node or port@0, port@1 and port@2 nodes exists ?

Quoted 4 lines

It's not meaningful to have this device without such nodes. But a mux with more ports could be connected in a way that leaves one or both of ports 1 and 2 unconnected. It's still not a likely configuration but a possible one.

Those ports wouldn't be connected, but they could still exist in DT.

Quoted 51 lines

Either way,

Quoted 47 lines
Quoted 45 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +45 -0
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    mux: mux-controller {
+        compatible = "gpio-mux";
+        #mux-control-cells = <0>;
+
+        mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
+    };
+
+    video-mux {
+        compatible = "video-mux";
+        mux-controls = <&mux>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        port@0 {
+            reg = <0>;
+
+            mux_in0: endpoint {
+                remote-endpoint = <&video_source0_out>;
+            };
+        };
+
+        port@1 {
+            reg = <1>;
+
+            mux_in1: endpoint {
+                remote-endpoint = <&video_source1_out>;
+            };
+        };
+
+        port@2 {
+            reg = <2>;
+
+            mux_out: endpoint {
+                remote-endpoint = <&capture_interface_in>;
+            };
+        };
+    };
+...
Signature · 3 lines
Regards,

Laurent Pinchart
author maintainer
#4 lore raw
Quoted 148 lines · Laurent Pinchart

Hi Sakari,

Quoted 144 lines · Sakari Ailus
Quoted 142 lines · Laurent Pinchart
Quoted 113 lines · Rob Herring

Now that we have the graph schema, convert the video-mux binding to DT schema.

Cc Sakari Ailus <[email protected]>
Cc Laurent Pinchart <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
---
 .../devicetree/bindings/media/video-mux.txt   | 60 ------------
 .../devicetree/bindings/media/video-mux.yaml  | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/video-mux.txt
 create mode 100644 Documentation/devicetree/bindings/media/video-mux.yaml
Documentation/devicetree/bindings/media/video-mux.txt deleted +0 -60
deleted file mode 100644
index 63b9dc913e45..000000000000
@@ -1,60 +0,0 @@
-Video Multiplexer
-=================
-
-Video multiplexers allow to select between multiple input ports. Video received
-on the active input port is passed through to the output port. Muxes described
-by this binding are controlled by a multiplexer controller that is described by
-the bindings in Documentation/devicetree/bindings/mux/mux-controller.txt
-
-Required properties:
-- compatible : should be "video-mux"
-- mux-controls : mux controller node to use for operating the mux
-- #address-cells: should be <1>
-- #size-cells: should be <0>
-- port@*: at least three port nodes containing endpoints connecting to the
-  source and sink devices according to of_graph bindings. The last port is
-  the output port, all others are inputs.
-
-Optionally, #address-cells, #size-cells, and port nodes can be grouped under a
-ports node as described in Documentation/devicetree/bindings/graph.txt.
-
-Example:
-
- mux: mux-controller {
-         compatible = "gpio-mux";
-         #mux-control-cells = <0>;
-
-         mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
- };
-
- video-mux {
-         compatible = "video-mux";
-         mux-controls = <&mux>;
-         #address-cells = <1>;
-         #size-cells = <0>;
-
-         port@0 {
-                 reg = <0>;
-
-                 mux_in0: endpoint {
-                         remote-endpoint = <&video_source0_out>;
-                 };
-         };
-
-         port@1 {
-                 reg = <1>;
-
-                 mux_in1: endpoint {
-                         remote-endpoint = <&video_source1_out>;
-                 };
-         };
-
-         port@2 {
-                 reg = <2>;
-
-                 mux_out: endpoint {
-                         remote-endpoint = <&capture_interface_in>;
-                 };
-         };
- };
-};
Documentation/devicetree/bindings/media/video-mux.yaml new file +26 -0
new file mode 100644
index 000000000000..780fbbd46a38
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/video-mux.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Video Multiplexer
+
+maintainers:
+  - Sakari Ailus <[email protected]>
+  - Laurent Pinchart <[email protected]>
+
+description:
+  Video multiplexers allow to select between multiple input ports. Video
+  received on the active input port is passed through to the output port. Muxes
+  described by this binding are controlled by a multiplexer controller.
+
+properties:
+  compatible:
+    const: video-mux
+
+  mux-controls:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1

Documentation/devicetree/bindings/media/video-mux.yaml line 36

Quoted 10 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +10 -0
+
+  '#size-cells':
+    const: 0
+
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    patternProperties:
+      '^port@':
+        $ref: /schemas/graph.yaml#/properties/port

Should we require at least port@0, port@1 and port@2 ?

Documentation/devicetree/bindings/media/video-mux.yaml line 48

Quoted 12 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +12 -0
+
+patternProperties:
+  '^port@':
+    $ref: /schemas/graph.yaml#/properties/port
+    description:
+      At least three port nodes containing endpoints connecting to the source
+      and sink devices according to of_graph bindings. The last port is the
+      output port, all others are inputs.
+
+required:
+  - compatible
+  - mux-controls

Should a constraint be added to ensure that either a ports node or port@0, port@1 and port@2 nodes exists ?

Quoted 6 lines
Quoted 4 lines

It's not meaningful to have this device without such nodes. But a mux with more ports could be connected in a way that leaves one or both of ports 1 and 2 unconnected. It's still not a likely configuration but a possible one.

Those ports wouldn't be connected, but they could still exist in DT.

Could or must? I think we could have both cases. If there's never a connection on a board no point in having the node there. If there's a possible connection (via a connector and overlay), then we may want the node.

Rob

#5 lore raw

Hi Rob,

Quoted 151 lines · Rob Herring
Quoted 150 lines · Laurent Pinchart
Quoted 148 lines · Sakari Ailus
Quoted 127 lines · Laurent Pinchart
Quoted 113 lines · Rob Herring

Now that we have the graph schema, convert the video-mux binding to DT schema.

Cc Sakari Ailus <[email protected]>
Cc Laurent Pinchart <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
---
 .../devicetree/bindings/media/video-mux.txt   | 60 ------------
 .../devicetree/bindings/media/video-mux.yaml  | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/video-mux.txt
 create mode 100644 Documentation/devicetree/bindings/media/video-mux.yaml
Documentation/devicetree/bindings/media/video-mux.txt deleted +0 -60
deleted file mode 100644
index 63b9dc913e45..000000000000
@@ -1,60 +0,0 @@
-Video Multiplexer
-=================
-
-Video multiplexers allow to select between multiple input ports. Video received
-on the active input port is passed through to the output port. Muxes described
-by this binding are controlled by a multiplexer controller that is described by
-the bindings in Documentation/devicetree/bindings/mux/mux-controller.txt
-
-Required properties:
-- compatible : should be "video-mux"
-- mux-controls : mux controller node to use for operating the mux
-- #address-cells: should be <1>
-- #size-cells: should be <0>
-- port@*: at least three port nodes containing endpoints connecting to the
-  source and sink devices according to of_graph bindings. The last port is
-  the output port, all others are inputs.
-
-Optionally, #address-cells, #size-cells, and port nodes can be grouped under a
-ports node as described in Documentation/devicetree/bindings/graph.txt.
-
-Example:
-
- mux: mux-controller {
-         compatible = "gpio-mux";
-         #mux-control-cells = <0>;
-
-         mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
- };
-
- video-mux {
-         compatible = "video-mux";
-         mux-controls = <&mux>;
-         #address-cells = <1>;
-         #size-cells = <0>;
-
-         port@0 {
-                 reg = <0>;
-
-                 mux_in0: endpoint {
-                         remote-endpoint = <&video_source0_out>;
-                 };
-         };
-
-         port@1 {
-                 reg = <1>;
-
-                 mux_in1: endpoint {
-                         remote-endpoint = <&video_source1_out>;
-                 };
-         };
-
-         port@2 {
-                 reg = <2>;
-
-                 mux_out: endpoint {
-                         remote-endpoint = <&capture_interface_in>;
-                 };
-         };
- };
-};
Documentation/devicetree/bindings/media/video-mux.yaml new file +26 -0
new file mode 100644
index 000000000000..780fbbd46a38
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/video-mux.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Video Multiplexer
+
+maintainers:
+  - Sakari Ailus <[email protected]>
+  - Laurent Pinchart <[email protected]>
+
+description:
+  Video multiplexers allow to select between multiple input ports. Video
+  received on the active input port is passed through to the output port. Muxes
+  described by this binding are controlled by a multiplexer controller.
+
+properties:
+  compatible:
+    const: video-mux
+
+  mux-controls:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1

Documentation/devicetree/bindings/media/video-mux.yaml line 36

Quoted 10 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +10 -0
+
+  '#size-cells':
+    const: 0
+
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    patternProperties:
+      '^port@':
+        $ref: /schemas/graph.yaml#/properties/port

Should we require at least port@0, port@1 and port@2 ?

Quoted 15 lines

Documentation/devicetree/bindings/media/video-mux.yaml line 48

Quoted 12 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +12 -0
+
+patternProperties:
+  '^port@':
+    $ref: /schemas/graph.yaml#/properties/port
+    description:
+      At least three port nodes containing endpoints connecting to the source
+      and sink devices according to of_graph bindings. The last port is the
+      output port, all others are inputs.
+
+required:
+  - compatible
+  - mux-controls

Should a constraint be added to ensure that either a ports node or port@0, port@1 and port@2 nodes exists ?

It's not meaningful to have this device without such nodes. But a mux with more ports could be connected in a way that leaves one or both of ports 1 and 2 unconnected. It's still not a likely configuration but a possible one.

Quoted 6 lines
Quoted 1 line

Those ports wouldn't be connected, but they could still exist in DT.

Could or must? I think we could have both cases. If there's never a connection on a board no point in having the node there. If there's a possible connection (via a connector and overlay), then we may want the node.

I tend to treat ports as mandatory and endpoints as optional, as the former describe a intrinsic property of the device and the latter a connection in a specific system.

Looking at the video-mux driver, it first finds the number of the last port, and then creates N V4L2 subdev pads, regardless of whether a port exists for it. There's thus an implicit assumption that ports will be numbered 0 to N-1 and will all exist. If a port doesn't exist in DT, the driver should still operate correctly as far as I can tell, but it will in any case create N pads.

Now, that's a driver implementation, but given that the bindings are for a generic mux device, the driver matters here. I'd be fine making ports optional and modifying the driver, or making them mandatory in DT, but I think it's important to at least synchronize the bindings and the driver.

Signature · 3 lines
Regards,

Laurent Pinchart
author maintainer
#6 lore raw
Quoted 173 lines · Laurent Pinchart

Hi Rob,

Quoted 151 lines · Rob Herring
Quoted 150 lines · Laurent Pinchart
Quoted 148 lines · Sakari Ailus
Quoted 127 lines · Laurent Pinchart
Quoted 113 lines · Rob Herring

Now that we have the graph schema, convert the video-mux binding to DT schema.

Cc Sakari Ailus <[email protected]>
Cc Laurent Pinchart <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
---
 .../devicetree/bindings/media/video-mux.txt   | 60 ------------
 .../devicetree/bindings/media/video-mux.yaml  | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/video-mux.txt
 create mode 100644 Documentation/devicetree/bindings/media/video-mux.yaml
Documentation/devicetree/bindings/media/video-mux.txt deleted +0 -60
deleted file mode 100644
index 63b9dc913e45..000000000000
@@ -1,60 +0,0 @@
-Video Multiplexer
-=================
-
-Video multiplexers allow to select between multiple input ports. Video received
-on the active input port is passed through to the output port. Muxes described
-by this binding are controlled by a multiplexer controller that is described by
-the bindings in Documentation/devicetree/bindings/mux/mux-controller.txt
-
-Required properties:
-- compatible : should be "video-mux"
-- mux-controls : mux controller node to use for operating the mux
-- #address-cells: should be <1>
-- #size-cells: should be <0>
-- port@*: at least three port nodes containing endpoints connecting to the
-  source and sink devices according to of_graph bindings. The last port is
-  the output port, all others are inputs.
-
-Optionally, #address-cells, #size-cells, and port nodes can be grouped under a
-ports node as described in Documentation/devicetree/bindings/graph.txt.
-
-Example:
-
- mux: mux-controller {
-         compatible = "gpio-mux";
-         #mux-control-cells = <0>;
-
-         mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
- };
-
- video-mux {
-         compatible = "video-mux";
-         mux-controls = <&mux>;
-         #address-cells = <1>;
-         #size-cells = <0>;
-
-         port@0 {
-                 reg = <0>;
-
-                 mux_in0: endpoint {
-                         remote-endpoint = <&video_source0_out>;
-                 };
-         };
-
-         port@1 {
-                 reg = <1>;
-
-                 mux_in1: endpoint {
-                         remote-endpoint = <&video_source1_out>;
-                 };
-         };
-
-         port@2 {
-                 reg = <2>;
-
-                 mux_out: endpoint {
-                         remote-endpoint = <&capture_interface_in>;
-                 };
-         };
- };
-};
Documentation/devicetree/bindings/media/video-mux.yaml new file +26 -0
new file mode 100644
index 000000000000..780fbbd46a38
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/video-mux.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Video Multiplexer
+
+maintainers:
+  - Sakari Ailus <[email protected]>
+  - Laurent Pinchart <[email protected]>
+
+description:
+  Video multiplexers allow to select between multiple input ports. Video
+  received on the active input port is passed through to the output port. Muxes
+  described by this binding are controlled by a multiplexer controller.
+
+properties:
+  compatible:
+    const: video-mux
+
+  mux-controls:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1

Documentation/devicetree/bindings/media/video-mux.yaml line 36

Quoted 10 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +10 -0
+
+  '#size-cells':
+    const: 0
+
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    patternProperties:
+      '^port@':
+        $ref: /schemas/graph.yaml#/properties/port

Should we require at least port@0, port@1 and port@2 ?

Quoted 15 lines

Documentation/devicetree/bindings/media/video-mux.yaml line 48

Quoted 12 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +12 -0
+
+patternProperties:
+  '^port@':
+    $ref: /schemas/graph.yaml#/properties/port
+    description:
+      At least three port nodes containing endpoints connecting to the source
+      and sink devices according to of_graph bindings. The last port is the
+      output port, all others are inputs.
+
+required:
+  - compatible
+  - mux-controls

Should a constraint be added to ensure that either a ports node or port@0, port@1 and port@2 nodes exists ?

It's not meaningful to have this device without such nodes. But a mux with more ports could be connected in a way that leaves one or both of ports 1 and 2 unconnected. It's still not a likely configuration but a possible one.

Quoted 6 lines
Quoted 1 line

Those ports wouldn't be connected, but they could still exist in DT.

Could or must? I think we could have both cases. If there's never a connection on a board no point in having the node there. If there's a possible connection (via a connector and overlay), then we may want the node.

I tend to treat ports as mandatory and endpoints as optional, as the former describe a intrinsic property of the device and the latter a connection in a specific system.

Looking at the video-mux driver, it first finds the number of the last port, and then creates N V4L2 subdev pads, regardless of whether a port exists for it. There's thus an implicit assumption that ports will be numbered 0 to N-1 and will all exist. If a port doesn't exist in DT, the driver should still operate correctly as far as I can tell, but it will in any case create N pads.

Quoted 5 lines

Now, that's a driver implementation, but given that the bindings are for a generic mux device, the driver matters here. I'd be fine making ports optional and modifying the driver, or making them mandatory in DT, but I think it's important to at least synchronize the bindings and the driver.

I guess we can always loosen the constraints if the need arises, so I've made the port nodes required and applied:

(quoted diff) +0 -0

b/Documentation/devicetree/bindings/media/video-mux.yaml index 780fbbd46a38..2f28a7dad93f 100644

Documentation/devicetree/bindings/media/video-mux.yaml +13 -0
@@ -35,6 +35,11 @@ properties:
       '^port@':
         $ref: /schemas/graph.yaml#/properties/port
 
+    required:
+      - port@0
+      - port@1
+      - port@2
+
 patternProperties:
   '^port@':
     $ref: /schemas/graph.yaml#/properties/port
@@ -47,6 +52,14 @@ required:
   - compatible
   - mux-controls
 
+oneOf:
+  - required:
+      - ports
+  - required:
+      - port@0
+      - port@1
+      - port@2
+
 additionalProperties: false
 
 examples:
author maintainer
#7 lore raw
In reply to Laurent Pinchart
Quoted 123 lines · Laurent Pinchart

Hi Rob,

Thank you for the patch.

Quoted 117 lines · Rob Herring

Now that we have the graph schema, convert the video-mux binding to DT schema.

Cc Sakari Ailus <[email protected]>
Cc Laurent Pinchart <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
---
 .../devicetree/bindings/media/video-mux.txt   | 60 ------------
 .../devicetree/bindings/media/video-mux.yaml  | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 60 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/video-mux.txt
 create mode 100644 Documentation/devicetree/bindings/media/video-mux.yaml
Documentation/devicetree/bindings/media/video-mux.txt deleted +0 -60
deleted file mode 100644
index 63b9dc913e45..000000000000
@@ -1,60 +0,0 @@
-Video Multiplexer
-=================
-
-Video multiplexers allow to select between multiple input ports. Video received
-on the active input port is passed through to the output port. Muxes described
-by this binding are controlled by a multiplexer controller that is described by
-the bindings in Documentation/devicetree/bindings/mux/mux-controller.txt
-
-Required properties:
-- compatible : should be "video-mux"
-- mux-controls : mux controller node to use for operating the mux
-- #address-cells: should be <1>
-- #size-cells: should be <0>
-- port@*: at least three port nodes containing endpoints connecting to the
-  source and sink devices according to of_graph bindings. The last port is
-  the output port, all others are inputs.
-
-Optionally, #address-cells, #size-cells, and port nodes can be grouped under a
-ports node as described in Documentation/devicetree/bindings/graph.txt.
-
-Example:
-
-     mux: mux-controller {
-             compatible = "gpio-mux";
-             #mux-control-cells = <0>;
-
-             mux-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;
-     };
-
-     video-mux {
-             compatible = "video-mux";
-             mux-controls = <&mux>;
-             #address-cells = <1>;
-             #size-cells = <0>;
-
-             port@0 {
-                     reg = <0>;
-
-                     mux_in0: endpoint {
-                             remote-endpoint = <&video_source0_out>;
-                     };
-             };
-
-             port@1 {
-                     reg = <1>;
-
-                     mux_in1: endpoint {
-                             remote-endpoint = <&video_source1_out>;
-                     };
-             };
-
-             port@2 {
-                     reg = <2>;
-
-                     mux_out: endpoint {
-                             remote-endpoint = <&capture_interface_in>;
-                     };
-             };
-     };
-};
Documentation/devicetree/bindings/media/video-mux.yaml new file +30 -0
new file mode 100644
index 000000000000..780fbbd46a38
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/video-mux.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Video Multiplexer
+
+maintainers:
+  - Sakari Ailus <[email protected]>
+  - Laurent Pinchart <[email protected]>
+
+description:
+  Video multiplexers allow to select between multiple input ports. Video
+  received on the active input port is passed through to the output port. Muxes
+  described by this binding are controlled by a multiplexer controller.
+
+properties:
+  compatible:
+    const: video-mux
+
+  mux-controls:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 0
+
Quoted 8 lines

Documentation/devicetree/bindings/media/video-mux.yaml line 36

Quoted 6 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +6 -0
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    patternProperties:
+      '^port@':
+        $ref: /schemas/graph.yaml#/properties/port

Should we require at least port@0, port@1 and port@2 ?

Is the numbering defined to be 0-N or it's defined by the mux values? Even if the former case, a port could be missing if the input is not hooked up.

Quoted 6 lines
Quoted 6 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +6 -0
+patternProperties:
+  '^port@':
+    $ref: /schemas/graph.yaml#/properties/port
+    description:
+      At least three port nodes containing endpoints connecting to the source
+      and sink devices according to of_graph bindings. The last port is the
Quoted 8 lines

Documentation/devicetree/bindings/media/video-mux.yaml line 48

Quoted 5 lines
Documentation/devicetree/bindings/media/video-mux.yaml new file +5 -0
+      output port, all others are inputs.
+
+required:
+  - compatible
+  - mux-controls

Should a constraint be added to ensure that either a ports node or port@0, port@1 and port@2 nodes exists ?

I kind of figured missing mux entries in a mux node was obvious enough. Though given the above, I don't think we can.

Also, we don't have any users with 'ports', so I debated doing away with that. Supporting either way is kind of pointless.

Quoted 2 lines

Thanks,
Rob