Re: [PATCH 1/5] dt-bindings: media: i2c: Add bindings for OX05B1S sensor driver

From: Laurent Pinchart
Date: Tue Oct 29 2024 - 07:58:07 EST


On Tue, Oct 29, 2024 at 11:44:33AM +0000, Bryan O'Donoghue wrote:
> On 28/10/2024 19:06, Mirela Rabulea wrote:
> > Add bindings for OX05B1S sensor driver
> >
> > Signed-off-by: Mirela Rabulea <mirela.rabulea@xxxxxxx>
> > ---
> > .../bindings/media/i2c/ovti,ox05b1s.yaml | 109 ++++++++++++++++++
> > 1 file changed, 109 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/media/i2c/ovti,ox05b1s.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/media/i2c/ovti,ox05b1s.yaml b/Documentation/devicetree/bindings/media/i2c/ovti,ox05b1s.yaml
> > new file mode 100644
> > index 000000000000..d47e1950f24d
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/media/i2c/ovti,ox05b1s.yaml
> > @@ -0,0 +1,109 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +# Copyright (C) 2024, NXP
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/media/i2c/ovti,ox05b1s.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Omnivision OX05B1S Image Sensor
> > +
> > +maintainers:
> > + - Mirela Rabulea <mirela.rabulea@xxxxxxx>
> > +
> > +description: |-
> > + The Omnivision OX05B1S is a 1/2.5-Inch CMOS image sensor with an active array size

Reflow to 80 columns.

> > + of 2592 x 1944. It is programmable through I2C interface.
> > + The sensor output is available via CSI-2 serial data output.
> > +
>
> You should add
>
> +allOf:
> + - $ref: /schemas/media/video-interface-devices.yaml#
>
> > +properties:
> > + compatible:
> > + items:
> > + - enum:
> > + - ovti,ox05b1s
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + clocks:
> > + maxItems: 1
> > +
> > + clock-names:
> > + description: Input clock (24 MHz)
> > + items:
> > + - const: csi_mclk

If there's a single clock you can drop the name.

How about regulators ?

> > +
> > + assigned-clocks:
> > + maxItems: 1
> > +
> > + assigned-clock-parents:
> > + maxItems: 1
> > +
> > + assigned-clock-rates:
> > + maxItems: 1
> > +
>
> assigned-clock* should be dropped.
>
> https://lore.kernel.org/all/20241025-b4-linux-next-202041004-i2c-media-yaml-fixes-v2-1-1b4535174a5a@xxxxxxxxxx/

Agreed.

> > +
> > + orientation: true
> > + rotation: true
>
> I think you can drop both of these too.

Aren't they needed given that the binding ends with

additionalProperties: false

?

> > +
> > + port:
> > + $ref: /schemas/graph.yaml#/$defs/port-base
> > + additionalProperties: false
> > + description: MIPI CSI-2 transmitter port
> > +
> > + properties:
> > + endpoint:
> > + $ref: /schemas/media/video-interfaces.yaml#
> > + unevaluatedProperties: false
> > +
> > + properties:
> > + data-lanes:
> > + anyOf:
> > + - items:
> > + - const: 1
> > + - const: 2
> > + - items:
> > + - const: 1
> > + - const: 2
> > + - const: 3
> > + - const: 4
> > + required:
> > + - data-lanes
> > +
> > + required:
> > + - endpoint
> > +
> > +required:
> > + - compatible
> > + - reg

The device requires a clock, shouldn't the clocks property be required ?

> > + - port
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/gpio/gpio.h>
> > +
> > + i2c {
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > +
> > + ox05b1s: ox05b1s@36 {
> > + compatible = "ovti,ox05b1s";
> > + reg = <0x36>;
> > + reset-gpios = <&i2c3_gpio_expander_20 2 GPIO_ACTIVE_LOW>;

This isn't specified in the bindings. Does the example validate ?

> > + orientation = <2>;
> > + rotation = <0>;
> > + status = "okay";
>
> You should include assigned-clock* here in the example.

Is that mandatory ? I'd rather omit it, I think it only adds noise.

> > +
> > + port {
> > + ox05b1s_mipi_0_ep: endpoint {
> > + remote-endpoint = <&mipi_csi0_ep>;
> > + data-lanes = <1 2 3 4>;
> > + };
> > + };
> > + };
> > + };
> > +...

--
Regards,

Laurent Pinchart