Re: [PATCH 1/3] dt-bindings: media: ov772x: Convert to json-schema

[Laurent Pinchart <laurent.pinchart@ideasonboard.com>]

Hi Rob,

On Tue, Aug 25, 2020 at 02:55:31PM -0600, Rob Herring wrote:
> On Mon, Aug 24, 2020 at 03:14:57PM +0300, Laurent Pinchart wrote:
> > On Mon, Aug 24, 2020 at 02:15:13PM +0200, Jacopo Mondi wrote:
> > > On Mon, Aug 24, 2020 at 02:34:40PM +0300, Laurent Pinchart wrote:
> > > > On Mon, Aug 24, 2020 at 10:32:11AM +0200, Jacopo Mondi wrote:
> > > > > On Wed, Aug 19, 2020 at 04:52:04PM +0300, Laurent Pinchart wrote:
> > > > > > On Tue, Aug 18, 2020 at 02:20:10PM +0200, Jacopo Mondi wrote:
> > > > > > > Convert the ov772x binding document to json-schema and update
> > > > > > > the MAINTAINERS file accordingly.
> > > > > > >
> > > > > > > Signed-off-by: Jacopo Mondi <jacopo+renesas@jmondi.org>
> > > > > > > ---
> > > > > > >  .../devicetree/bindings/media/i2c/ov772x.txt  | 40 ---------
> > > > > > >  .../devicetree/bindings/media/i2c/ov772x.yaml | 84 +++++++++++++++++++
> > > > > >
> > > > > > Could yuo rename this to ovti,ov772x.yaml ?
> > > > > >
> > > > > > >  MAINTAINERS                                   |  2 +-
> > > > > > >  3 files changed, 85 insertions(+), 41 deletions(-)
> > > > > > >  delete mode 100644 Documentation/devicetree/bindings/media/i2c/ov772x.txt
> > > > > > >  create mode 100644 Documentation/devicetree/bindings/media/i2c/ov772x.yaml
> > > > > > >
> > > > > > > diff --git a/Documentation/devicetree/bindings/media/i2c/ov772x.txt b/Documentation/devicetree/bindings/media/i2c/ov772x.txt
> > > > > > > deleted file mode 100644
> > > > > > > index 0b3ede5b8e6a..000000000000
> > > > > > > --- a/Documentation/devicetree/bindings/media/i2c/ov772x.txt
> > > > > > > +++ /dev/null
> > > > > > > @@ -1,40 +0,0 @@
> > > > > > > -* Omnivision OV7720/OV7725 CMOS sensor
> > > > > > > -
> > > > > > > -The Omnivision OV7720/OV7725 sensor supports multiple resolutions output,
> > > > > > > -such as VGA, QVGA, and any size scaling down from CIF to 40x30. It also can
> > > > > > > -support the YUV422, RGB565/555/444, GRB422 or raw RGB output formats.
> > > > > > > -
> > > > > > > -Required Properties:
> > > > > > > -- compatible: shall be one of
> > > > > > > -	"ovti,ov7720"
> > > > > > > -	"ovti,ov7725"
> > > > > > > -- clocks: reference to the xclk input clock.
> > > > > > > -
> > > > > > > -Optional Properties:
> > > > > > > -- reset-gpios: reference to the GPIO connected to the RSTB pin which is
> > > > > > > -  active low, if any.
> > > > > > > -- powerdown-gpios: reference to the GPIO connected to the PWDN pin which is
> > > > > > > -  active high, if any.
> > > > > > > -
> > > > > > > -The device node shall contain one 'port' child node with one child 'endpoint'
> > > > > > > -subnode for its digital output video port, in accordance with the video
> > > > > > > -interface bindings defined in Documentation/devicetree/bindings/media/
> > > > > > > -video-interfaces.txt.
> > > > > > > -
> > > > > > > -Example:
> > > > > > > -
> > > > > > > -&i2c0 {
> > > > > > > -	ov772x: camera@21 {
> > > > > > > -		compatible = "ovti,ov7725";
> > > > > > > -		reg = <0x21>;
> > > > > > > -		reset-gpios = <&axi_gpio_0 0 GPIO_ACTIVE_LOW>;
> > > > > > > -		powerdown-gpios = <&axi_gpio_0 1 GPIO_ACTIVE_LOW>;
> > > > > > > -		clocks = <&xclk>;
> > > > > > > -
> > > > > > > -		port {
> > > > > > > -			ov772x_0: endpoint {
> > > > > > > -				remote-endpoint = <&vcap1_in0>;
> > > > > > > -			};
> > > > > > > -		};
> > > > > > > -	};
> > > > > > > -};
> > > > > > > diff --git a/Documentation/devicetree/bindings/media/i2c/ov772x.yaml b/Documentation/devicetree/bindings/media/i2c/ov772x.yaml
> > > > > > > new file mode 100644
> > > > > > > index 000000000000..2b84fefeb4aa
> > > > > > > --- /dev/null
> > > > > > > +++ b/Documentation/devicetree/bindings/media/i2c/ov772x.yaml
> > > > > > > @@ -0,0 +1,84 @@
> > > > > > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > > > > > +%YAML 1.2
> > > > > > > +---
> > > > > > > +$id: http://devicetree.org/schemas/media/i2c/ov772x.yaml#
> > > > > > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > > > > > +
> > > > > > > +title:  Omnivision OV7720/OV7725 CMOS sensor
> > > > > > > +
> > > > > > > +maintainers:
> > > > > > > +  - Jacopo Mondi <jacopo@jmondi.org>
> > > > > > > +
> > > > > > > +description: -|
> > > > > > > +  The Omnivision OV7720/OV7725 sensor supports multiple resolutions output,
> > > > > > > +  such as VGA, QVGA, and any size scaling down from CIF to 40x30. It also can
> > > > > > > +  support the YUV422, RGB565/555/444, GRB422 or raw RGB output formats.
> > > > > > > +
> > > > > > > +properties:
> > > > > > > +  compatible:
> > > > > > > +    enum:
> > > > > > > +      - ovti,ov7720
> > > > > > > +      - ovti,ov7725
> > > > > > > +
> > > > > > > +  reg:
> > > > > > > +    maxItems: 1
> > > > > > > +
> > > > > > > +  clocks:
> > > > > > > +    maxItems: 1
> > > > > > > +
> > > > > > > +  reset-gpios:
> > > > > > > +    description: -|
> > > > > > > +      Reference to the GPIO connected to the RSTB pin which is active low.
> > > > > > > +    maxItems: 1
> > > > > > > +
> > > > > > > +  powerdown-gpios:
> > > > > > > +    description: -|
> > > > > > > +      Reference to the GPIO connected to the PWDN pin which is active high.
> > > > > > > +    maxItems: 1
> > > > > > > +
> > > > > > > +  port:
> > > > > > > +    type: object
> > > > > > > +    description: |
> > > > > > > +      The device node must contain one 'port' child node for its digital output
> > > > > > > +      video port, in accordance with the video interface bindings defined in
> > > > > > > +      Documentation/devicetree/bindings/media/video-interfaces.txt.
> > > > > >
> > > > > > You can simply write
> > > > > >
> > > > > >       Digital input video port. See ../video-interfaces.txt.
> > > > > >
> > > > > > > +
> > > > > > > +    properties:
> > > > > > > +      endpoint:
> > > > > > > +        type: object
> > > > > > > +        properties:
> > > > > > > +          remote-endpoint:
> > > > > > > +            description: A phandle to the bus receiver's endpoint node.
> > > > > >
> > > > > >            required:
> > > > > > 	     - remote-endpoint
> > > > > >
> > > > > >            additionalProperties: false
> > > > >
> > > > > I receveied a reply to you on previous json-schema conversion attempt
> > > > > where you suggested to not set remote-endpoint as required, as we
> > > > > allow empty ones to be later filled in in, maybe with an overlay.
> > > > >
> > > > > Which Laurent should I listen to ? I tend to agree with the one that
> > > > > said to drop remote-endpoint from the required properties list.
> > > >
> > > > Maybe I recall incorrectly, didn't I say that endpoint shouldn't be
> > > > mandatory ? Ports should be mandatory as they describe the hardware,
> > > > endpoints describe a connection, and within a connection, I'm not sure
> > > > to see a use-case for not setting remote-endpoint. Maybe I need to look
> > > > better ? :-)
> > > >
> > > 
> > > I might be confused as well, but to me port and endpoint should be
> > > there as they represent the available endpoints of the devices connections.
> > > Connections to external devices that can be established (or overwritten)
> > > by applying an overlay, and such are not mandatory.
> > > 
> > > As I see it:
> > > - port/endpoints: establish the available device connection endpoitns
> > >   and shall be mandatory (also to give a known place where to 'plug'
> > >   the connections)
> > > 
> > > - remote-endpoints: data connections to external devices, which might
> > >   depend on the board assembly or installed 'capes' and expansions. As
> > >   such, they can be modeled as an overlay fragment to be applied on the
> > >   (known layout of the) device.
> > 
> > Only the port represents a connection point. The endpoint node is part
> > of the representation of the link, it doesn't map to a particular
> > hardware resource on the port side.
> 
> I think all of 'endpoint' should be dropped if you only have 
> 'remote-endpoint' (and no other properties) and you don't have multiple 
> endpoints (typically only if the h/w has some sort of built-in mux or 
> connection selector). 

Makes sense to me, I'll keep this in mind during review.

> Once we have a generic graph schema, it can enforce that 'port' has 
> 'endpoint' and 'endpoint' has 'remote-endpoint'.

I think 'endpoint' should be optional though, as a port can exist but
not be connected. 'remote-endpoint' should be mandatory.

> Doing this hasn't been 
> too high on my list simply because dtc already does all or most of that.

-- 
Regards,

Laurent Pinchart