Re: [PATCH v3 1/5] dt-bindings: media: Add Allwinner A10 CSI binding

[Rob Herring]

On Thu, Mar 14, 2019 at 4:17 PM Maxime Ripard <maxime.ripard@xxxxxxxxxxx> wrote:
>
> The Allwinner A10 CMOS Sensor Interface is a camera capture interface also
> used in later (A10s, A13, A20, R8 and GR8) SoCs.
>
> On some SoCs, like the A10, there's multiple instances of that controller,
> with one instance supporting more channels and having an ISP.
>
> Signed-off-by: Maxime Ripard <maxime.ripard@xxxxxxxxxxx>
> ---
>  Documentation/devicetree/bindings/media/allwinner,sun4i-a10-csi.yaml | 115 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 115 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/media/allwinner,sun4i-a10-csi.yaml
>
> diff --git a/Documentation/devicetree/bindings/media/allwinner,sun4i-a10-csi.yaml b/Documentation/devicetree/bindings/media/allwinner,sun4i-a10-csi.yaml
> new file mode 100644
> index 000000000000..30c5dc1406cf
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/allwinner,sun4i-a10-csi.yaml
> @@ -0,0 +1,115 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/arm/allwinner,sun4i-a10-csi.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Allwinner A10 CMOS Sensor Interface (CSI) Device Tree Bindings
> +
> +maintainers:
> +  - Chen-Yu Tsai <wens@xxxxxxxx>
> +  - Maxime Ripard <maxime.ripard@xxxxxxxxxxx>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +        - enum:

The 'standard' formatting is 2 more spaces of indentation here. IOW,
the '-' goes under the 'e' in items. yaml-format in the yaml-bindings
repo should reformat this correctly for you.

Both ways are valid, but the main advantage to that I see is it makes
it a bit more obvious when you have a list. It's easy to look at a
schema and miss the '-'.

> +          - allwinner,sun7i-a20-csi0
> +        - const: allwinner,sun4i-a10-csi0
> +
> +      - items:
> +        - const: allwinner,sun4i-a10-csi0
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    items:
> +      - description: The CSI interface clock
> +      - description: The CSI module clock
> +      - description: The CSI ISP clock
> +      - description: The CSI DRAM clock
> +
> +  clock-names:
> +    items:
> +      - const: bus
> +      - const: mod
> +      - const: isp
> +      - const: ram
> +
> +  resets:
> +    description: The reset line driver this IP
> +    maxItems: 1
> +
> +  pinctrl-0:
> +    minItems: 1
> +
> +  pinctrl-names:
> +    const: default
> +
> +  port:
> +    additionalProperties: false

Nodes should have a 'type: object'.

I'm adding a meta-schema to check this.

> +
> +    properties:
> +      endpoint:
> +        properties:
> +          bus-width:
> +            const: 8
> +            description:
> +              Number of data lines actively used.
> +

> +          data-active:
> +            description: Polarity of the data lines, 0 for active low,
> +              1 for active high.
> +            allOf:
> +              - $ref: /schemas/types.yaml#/definitions/uint32
> +              - enum: [0, 1]
> +
> +          hsync-active:
> +            description: Active state of the HSYNC signal, 0 for
> +              active low, 1 for active high.
> +            allOf:
> +              - $ref: /schemas/types.yaml#/definitions/uint32
> +              - enum: [0, 1]
> +
> +          pclk-sample:
> +            description: Sample data on the rising (1) or falling (0)
> +              edge of the pixel clock signal
> +            allOf:
> +              - $ref: /schemas/types.yaml#/definitions/uint32
> +              - enum: [0, 1]
> +
> +          remote-endpoint:
> +            $ref: '/schemas/types.yaml#/definitions/phandle'
> +            description: Phandle to an endpoint subnode of a remote
> +              device node.
> +
> +          vsync-active:
> +            description: Active state of the VSYNC signal, 0 for
> +              active low, 1 for active high.
> +            allOf:
> +              - $ref: /schemas/types.yaml#/definitions/uint32
> +              - enum: [0, 1]

These are all common properties, so we shouldn't be defining the type
here. And since you don't have any further constraints, just
'vsync-sample: true' would suffice.

> +
> +        required:
> +          - bus-width
> +          - data-active
> +          - hsync-active
> +          - pclk-sample
> +          - remote-endpoint
> +          - vsync-active
> +
> +    required:
> +      - endpoint
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +
> +additionalProperties: false
> --
> git-series 0.9.1