Re: [PATCH v2 1/2] media: dt-bindings: alvium: add document YAML binding

From: Tommaso Merciai
Date: Mon May 29 2023 - 03:22:24 EST


Hi Conor,
Thanks for the review.

On Fri, May 26, 2023 at 08:00:05PM +0100, Conor Dooley wrote:
> Hey Tommaso,
>
> On Fri, May 26, 2023 at 07:39:43PM +0200, Tommaso Merciai wrote:
> > Add documentation of device tree in YAML schema for the ALVIUM
> > Camera from Allied Vision Inc.
> >
> > References:
> > - https://www.alliedvision.com/en/products/embedded-vision-solutions
> >
> > Signed-off-by: Tommaso Merciai <tomm.merciai@xxxxxxxxx>
> > ---
> > Changes since v1:
> > - Fixed build error as suggested by RHerring bot
> >
> > .../media/i2c/alliedvision,alvium.yaml | 115 ++++++++++++++++++
> > 1 file changed, 115 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/media/i2c/alliedvision,alvium.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/media/i2c/alliedvision,alvium.yaml b/Documentation/devicetree/bindings/media/i2c/alliedvision,alvium.yaml
> > new file mode 100644
> > index 000000000000..81e9e560c99d
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/media/i2c/alliedvision,alvium.yaml
> > @@ -0,0 +1,115 @@
> > +# SPDX-License-Identifier: GPL-2.0
>
> No dual license?

Yep, agree. Thanks.

>
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/media/i2c/alliedvision,alvium.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Alliedvision Alvium Camera
> > +
> > +maintainers:
> > + - Tommaso Merciai <tomm.merciai@xxxxxxxxx>
> > + - Martin Hecht <martin.hecht@xxxxxxxx>
> > +
> > +allOf:
> > + - $ref: /schemas/media/video-interface-devices.yaml#
> > +
> > +properties:
> > + compatible:
> > + const: alliedvision,alvium
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + clocks:
> > + description: XCLK Input Clock
>
> Description is a bit moot when you have the clock name and there's only
> one. No harm done I suppose.

Agree, we can drop description.

>
> > +
> > + clock-names:
> > + const: xclk
> > +
> > + powerdown-gpios:
> > + maxItems: 1
> > + description: >
>
> You don't have any newlines, so you don't need a >

Thanks, I found the same ">" into ov5640 .yaml

>
> > + Reference to the GPIO connected to the powerdown pin, if any.
> > +
> > + reset-gpios:
> > + maxItems: 1
> > + description: >
> > + Reference to the GPIO connected to the reset pin, if any.
> > +
> > + streamon-delay:
> > + maxItems: 1
> > + description: >
> > + Delay before camera start capturing frames in us.
> > +
> > + rotation:
> > + enum:
> > + - 0
> > + - 180
>
> Could style this as enum: [0, 180], but I don't mind which you do.

For now this property is unused.
I'll drop this.

>
> > + port:
> > + description: Digital Output Port
> > + $ref: /schemas/graph.yaml#/$defs/port-base
> > + additionalProperties: false
> > +
> > + properties:
> > + endpoint:
> > + $ref: /schemas/media/video-interfaces.yaml#
> > + unevaluatedProperties: false
> > +
> > + properties:
> > + clock-lanes:
> > + const: 0
> > + data-lanes:
> > + minItems: 1
> > + maxItems: 4
> > + link-frequencies: true
> > +
> > + required:
> > + - data-lanes
> > + - link-frequencies
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - clocks
> > + - clock-names
> > + - port
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/gpio/gpio.h>
> > + #include <dt-bindings/clock/imx8mp-clock.h>
> > +
> > + i2c {
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > +
> > + camera: alvium@3c {
>
> Label does not seem to be used & the generic node name should probably
> be "camera", no?

What about using: "alvium: camera@3c {" ?
Like in some .yaml of ov sensors?

>
> > + compatible = "alliedvision,alvium";
> > + pinctrl-names = "default";
> > + pinctrl-0 = <&pinctrl_csi0_pwn>, <&pinctrl_csi0_rst>, <&pinctrl_csi_mclk>;
> > + reg = <0x3c>;
> > + clocks = <&clk IMX8MP_CLK_IPP_DO_CLKO2>;
> > + clock-names = "xclk";
> > + assigned-clocks = <&clk IMX8MP_CLK_IPP_DO_CLKO2>;
> > + assigned-clock-parents = <&clk IMX8MP_CLK_24M>;
> > + assigned-clock-rates = <24000000>;
> > + streamon-delay = <20>;
> > + powerdown-gpios = <&gpio2 11 GPIO_ACTIVE_HIGH>;
> > + reset-gpios = <&gpio1 6 GPIO_ACTIVE_LOW>;
> > + status = "okay";
> > +
> > + port {
> > + alvium_out: endpoint {
>
> Ditto here, drop the unused label?

I think we need this.



Thanks!

Regards,
Tommaso

>
> Otherwise, looks grand to me.
>
> Cheers,
> Conor.
>
> > + remote-endpoint = <&mipi_csi_0_in>;
> > + data-lanes = <1 2 3 4>;
> > + link-frequencies = /bits/ 64 <681250000>;
> > + clock-lanes = <0>;
> > + };
> > + };
> > + };
> > + };
> > +
> > +...
> > --
> > 2.34.1
> >