[v3,1/3] dt-bindings: media: Add bindings for THine THP7312 ISP

From: Paul Elder <paul.elder@ideasonboard.com>

The THP7312 is an external ISP from THine. Add DT bindings for it.

Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
Co-developed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
Changes since v2:

- Drop description of reg property
- Improve thine,boot-mode property documentation
- Making thine,boot-mode property optional
- Don't use underscores in supplies names
---
 .../bindings/media/i2c/thine,thp7312.yaml     | 226 ++++++++++++++++++
 MAINTAINERS                                   |   7 +
 2 files changed, 233 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/media/i2c/thine,thp7312.yaml

Hi Krzysztof,

On Thu, Oct 12, 2023 at 09:57:38PM +0200, Krzysztof Kozlowski wrote:
> On 12/10/2023 21:37, Laurent Pinchart wrote:
> 
> Thanks for the changes

You're welcome. Sorry again for missing some of your review comments on
v1.

> > +
> > +  port:
> > +    $ref: /schemas/graph.yaml#/$defs/port-base
> > +    additionalProperties: false
> > +
> > +    properties:
> > +      endpoint:
> > +        $ref: /schemas/media/video-interfaces.yaml#
> > +        unevaluatedProperties: false
> > +
> > +        properties:
> > +          data-lanes:
> > +            description:
> > +              This property is for lane reordering between the THP7312 and the
> > +              SoC. The sensor supports either two-lane, or four-lane operation.
> > +              If this property is omitted four-lane operation is assumed. For
> > +              two-lane operation the property must be set to <1 2>.
> > +            minItems: 2
> > +            maxItems: 4
> > +            items:
> > +              maximum: 4
> > +
> > +  sensors:
> > +    type: object
> > +    description: List of connected sensors
> 
> I don't understand why do you list sensors here. From the binding
> description I understood these are external sensors, which usually sit
> on I2C bus.

Good question :-)

The sensors connected to the THP7312 input are controlled over I2C by
the THP7312 itself. The host operating system doesn't have access to
that I2C bus. The sensors are listed here because their power supplies
need to be controlled by the host operating system.

> > +
> > +    properties:
> > +      "#address-cells":
> > +        const: 1
> > +
> > +      "#size-cells":
> > +        const: 0
> > +
> > +    patternProperties:
> > +      "^sensor@[01]":
> > +        type: object
> > +        description:
> > +          Sensors connected to the first and second input, with one node per
> > +          sensor.
> > +
> > +        properties:
> > +          thine,model:
> > +            $ref: /schemas/types.yaml#/definitions/string
> > +            description:
> > +              Model of the connected sensors. Must be a valid compatible string.
> 
> Then why this isn't compatible?

We picked a vendor-specific property to avoid implying that the sensor
nodes will result in devices being created by the host operating system.
I don't mind using "compatible" instead, but as far as I understand, a
compatible string implies that corresponding device DT bindings should
exist, and that won't be the case here necessarily.

> > +
> > +          reg:
> > +            maxItems: 1
> > +            description: THP7312 input port number
> > +
> > +          data-lanes:
> > +            $ref: /schemas/media/video-interfaces.yaml#/properties/data-lanes
> > +            items:
> > +              maxItems: 4
> > +            description:
> > +              This property is for lane reordering between the THP7312 and the imaging
> > +              sensor that it is connected to.
> > +
> > +        patternProperties:
> > +          ".*-supply":
> > +            description: Power supplies for the sensor
> > +
> > +        required:
> > +          - reg
> > +          - data-lanes
> > +
> > +        additionalProperties: false
> > +
> > +    required:
> > +      - "#address-cells"
> > +      - "#size-cells"
> > +
> > +    additionalProperties: false
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - reset-gpios
> > +  - clocks
> > +  - vddcore-supply
> > +  - vhtermrx-supply
> > +  - vddtx-supply
> > +  - vddhost-supply
> > +  - vddcmos-supply
> > +  - vddgpio-0-supply
> > +  - vddgpio-1-supply
> > +  - sensors
> > +  - port
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/gpio/gpio.h>
> > +
> > +    i2c {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        camera@61 {
> > +            compatible = "thine,thp7312";
> > +            reg = <0x61>;
> > +
> > +            pinctrl-names = "default";
> > +            pinctrl-0 = <&cam1_pins_default>;
> > +
> > +            reset-gpios = <&pio 119 GPIO_ACTIVE_LOW>;
> > +            clocks = <&camera61_clk>;
> > +
> > +            vddcore-supply = <&vsys_v4p2>;
> > +            vhtermrx-supply = <&vsys_v4p2>;
> > +            vddtx-supply = <&vsys_v4p2>;
> > +            vddhost-supply = <&vsys_v4p2>;
> > +            vddcmos-supply = <&vsys_v4p2>;
> > +            vddgpio-0-supply = <&vsys_v4p2>;
> > +            vddgpio-1-supply = <&vsys_v4p2>;
> > +
> > +            orientation = <0>;
> > +            rotation = <0>;
> > +
> > +            sensors {
> > +                #address-cells = <1>;
> > +                #size-cells = <0>;
> > +
> > +                sensor@0 {
> > +                    thine,model = "sony,imx258";
> > +                    reg = <0>;
> > +
> > +                    data-lanes = <4 1 3 2>;
> > +
> > +                    dovdd-supply = <&vsys_v4p2>;
> > +                    avdd-supply = <&vsys_v4p2>;
> > +                    dvdd-supply = <&vsys_v4p2>;
> > +                };
> > +            };
> > +
> > +            port {
> > +                thp7312_2_endpoint: endpoint {
> > +                    remote-endpoint = <&mipi_thp7312_2>;
> > +                    data-lanes = <4 2 1 3>;
> > +                };
> > +            };
> > +    	  };
> > +    };

On 15/10/2023 14:39, Laurent Pinchart wrote:
>>> +        properties:
>>> +          data-lanes:
>>> +            description:
>>> +              This property is for lane reordering between the THP7312 and the
>>> +              SoC. The sensor supports either two-lane, or four-lane operation.
>>> +              If this property is omitted four-lane operation is assumed. For
>>> +              two-lane operation the property must be set to <1 2>.
>>> +            minItems: 2
>>> +            maxItems: 4
>>> +            items:
>>> +              maximum: 4
>>> +
>>> +  sensors:
>>> +    type: object
>>> +    description: List of connected sensors
>>
>> I don't understand why do you list sensors here. From the binding
>> description I understood these are external sensors, which usually sit
>> on I2C bus.
> 
> Good question :-)
> 
> The sensors connected to the THP7312 input are controlled over I2C by
> the THP7312 itself. The host operating system doesn't have access to
> that I2C bus. The sensors are listed here because their power supplies
> need to be controlled by the host operating system.

OK

> 
>>> +
>>> +    properties:
>>> +      "#address-cells":
>>> +        const: 1
>>> +
>>> +      "#size-cells":
>>> +        const: 0
>>> +
>>> +    patternProperties:
>>> +      "^sensor@[01]":
>>> +        type: object
>>> +        description:
>>> +          Sensors connected to the first and second input, with one node per
>>> +          sensor.
>>> +
>>> +        properties:
>>> +          thine,model:
>>> +            $ref: /schemas/types.yaml#/definitions/string
>>> +            description:
>>> +              Model of the connected sensors. Must be a valid compatible string.
>>
>> Then why this isn't compatible?
> 
> We picked a vendor-specific property to avoid implying that the sensor
> nodes will result in devices being created by the host operating system.
> I don't mind using "compatible" instead, but as far as I understand, a
> compatible string implies that corresponding device DT bindings should
> exist, and that won't be the case here necessarily.

OK, looks sensible to me.

Best regards,
Krzysztof