[v3,1/4] dt-bindings: media: add Maxim MAX96717F GMSL2 Serializer

  Add DT bindings for Maxim MAX96717F GMSL2 Serializer.

Signed-off-by: Julien Massot <julien.massot@collabora.com>
---
Change since v2:
 - remove reg description
 - add data lanes min/maxItems
 - Use generic node name 

---
 .../bindings/media/i2c/maxim,max96717f.yaml   | 147 ++++++++++++++++++
 1 file changed, 147 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/media/i2c/maxim,max96717f.yaml
  

On 11/01/2024 14:03, Julien Massot wrote:
> Add DT bindings for Maxim MAX96717F GMSL2 Serializer.
> 
> Signed-off-by: Julien Massot <julien.massot@collabora.com>
> ---
> Change since v2:
>  - remove reg description
>  - add data lanes min/maxItems
>  - Use generic node name 
> 


Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof
  

Hi Julien,

On Thu, Jan 11, 2024 at 02:03:46PM +0100, Julien Massot wrote:
> Add DT bindings for Maxim MAX96717F GMSL2 Serializer.
> 
> Signed-off-by: Julien Massot <julien.massot@collabora.com>
> ---
> Change since v2:
>  - remove reg description
>  - add data lanes min/maxItems
>  - Use generic node name 
> 
> ---
>  .../bindings/media/i2c/maxim,max96717f.yaml   | 147 ++++++++++++++++++
>  1 file changed, 147 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/media/i2c/maxim,max96717f.yaml
> 
> diff --git a/Documentation/devicetree/bindings/media/i2c/maxim,max96717f.yaml b/Documentation/devicetree/bindings/media/i2c/maxim,max96717f.yaml
> new file mode 100644
> index 000000000000..f31517b1dbc8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/i2c/maxim,max96717f.yaml
> @@ -0,0 +1,147 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (C) 2024 Collabora Ltd.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/media/i2c/maxim,max96717f.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MAX96717 CSI-2 to GMSL2 Serializer
> +
> +maintainers:
> +  - Julien Massot <julien.massot@collabora.com>
> +
> +description: |
> +  The MAX96717F serializer converts MIPI CSI-2 D-PHY or C-PHY formatted input

Presumably this will need to be configured on the device? You should thus
require the bus-type property in the endpoint.

> +  into GMSL2 serial outputs. The device allows the GMSL2 link to
> +  simultaneously transmit bidirectional control-channel data while forward
> +  video transmissions are in progress. The MAX96717F can connect to one
> +  remotely located deserializer using industry-standard coax or STP
> +  interconnects. The device cans operate in pixel or tunnel mode. In pixel mode
> +  the MAX96717F can select the MIPI datatype, while the tunnel mode forward all the MIPI
> +  data received by the serializer.
> +  The MAX96717F supports Reference Over Reverse (channel),
> +  to generate a clock output for the sensor from the GMSL reverse channel.
> +
> +  The GMSL2 serial link operates at a fixed rate of 3Gbps in the
> +  forward direction and 187.5Mbps in the reverse direction.
> +
> +properties:
> +  compatible:
> +    const: maxim,max96717f
> +
> +  '#gpio-cells':
> +    const: 2
> +    description:
> +      First cell is the GPIO pin number, second cell is the flags. The GPIO pin
> +      number must be in range of [0, 10].
> +
> +  gpio-controller: true
> +
> +  '#clock-cells':
> +    const: 0
> +
> +  reg:
> +    maxItems: 1
> +
> +  ports:
> +    $ref: /schemas/graph.yaml#/properties/ports
> +
> +    properties:
> +      port@0:
> +        $ref: /schemas/graph.yaml#/$defs/port-base
> +        unevaluatedProperties: false
> +        description: CSI-2 Input port
> +
> +        properties:
> +          endpoint:
> +            $ref: /schemas/media/video-interfaces.yaml#
> +            unevaluatedProperties: false
> +
> +            properties:
> +              data-lanes:
> +                minItems: 1
> +                maxItems: 4
> +
> +            required:
> +              - data-lanes
> +
> +      port@1:
> +        $ref: /schemas/graph.yaml#/properties/port
> +        unevaluatedProperties: false
> +        description: GMSL Output port
> +
> +    required:
> +      - port@1
> +
> +  i2c-gate:
> +    $ref: /schemas/i2c/i2c-controller.yaml
> +    unevaluatedProperties: false
> +    description: |

I think you can remove ' |'.

> +      The MAX96717F will forward the I2C requests from the
> +      incoming GMSL2 link. Therefore, it supports an i2c-gate
> +      subnode to configure a sensor.
> +
> +required:
> +  - compatible
> +  - reg
> +  - ports
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    #include <dt-bindings/media/video-interfaces.h>
> +
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +        serializer: serializer@40 {
> +            compatible = "maxim,max96717f";
> +            reg = <0x40>;
> +            gpio-controller;
> +            #gpio-cells = <2>;
> +            #clock-cells = <0>;
> +
> +            ports {
> +                #address-cells = <1>;
> +                #size-cells = <0>;
> +
> +                port@0 {
> +                    reg = <0>;
> +                    max96717f_csi_in: endpoint {
> +                        data-lanes = <1 2 3 4>;
> +                        remote-endpoint = <&sensor_out>;
> +                    };
> +                };
> +
> +                port@1 {
> +                    reg = <1>;
> +                    max96917f_gmsl_out: endpoint {
> +                        remote-endpoint = <&deser_gmsl_in>;
> +                    };
> +                };
> +            };
> +
> +            i2c-gate {
> +                #address-cells = <1>;
> +                #size-cells = <0>;
> +                sensor@10 {
> +                    compatible = "st,st-vgxy61";
> +                    reg = <0x10>;
> +                    reset-gpios = <&serializer 0 GPIO_ACTIVE_LOW>;
> +                    clocks = <&serializer>;
> +                    VCORE-supply = <&v1v2>;
> +                    VDDIO-supply = <&v1v8>;
> +                    VANA-supply = <&v2v8>;
> +                    port {
> +                        sensor_out: endpoint {
> +                            data-lanes = <1 2 3 4>;
> +                            remote-endpoint = <&max96717f_csi_in>;
> +                        };
> +                    };
> +                };
> +            };
> +        };
> +    };
> +...
  

Hi Sakari,

On 2/9/24 10:28, Sakari Ailus wrote:
> Hi Julien,
> 
> On Thu, Jan 11, 2024 at 02:03:46PM +0100, Julien Massot wrote:
>> Add DT bindings for Maxim MAX96717F GMSL2 Serializer.
>>
>> Signed-off-by: Julien Massot <julien.massot@collabora.com>
>> ---
>> Change since v2:
>>   - remove reg description
>>   - add data lanes min/maxItems
>>   - Use generic node name
>>
>> ---
>>   .../bindings/media/i2c/maxim,max96717f.yaml   | 147 ++++++++++++++++++
>>   1 file changed, 147 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/media/i2c/maxim,max96717f.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/media/i2c/maxim,max96717f.yaml b/Documentation/devicetree/bindings/media/i2c/maxim,max96717f.yaml
>> new file mode 100644
>> index 000000000000..f31517b1dbc8
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/media/i2c/maxim,max96717f.yaml
>> @@ -0,0 +1,147 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +# Copyright (C) 2024 Collabora Ltd.
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/media/i2c/maxim,max96717f.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: MAX96717 CSI-2 to GMSL2 Serializer
>> +
>> +maintainers:
>> +  - Julien Massot <julien.massot@collabora.com>
>> +
>> +description: |
>> +  The MAX96717F serializer converts MIPI CSI-2 D-PHY or C-PHY formatted input
> 
> Presumably this will need to be configured on the device? You should thus
> require the bus-type property in the endpoint.

Yes I will add the bus-type propery

> 
>> +  into GMSL2 serial outputs. The device allows the GMSL2 link to
>> +  simultaneously transmit bidirectional control-channel data while forward
>> +  video transmissions are in progress. The MAX96717F can connect to one
>> +  remotely located deserializer using industry-standard coax or STP
>> +  interconnects. The device cans operate in pixel or tunnel mode. In pixel mode
>> +  the MAX96717F can select the MIPI datatype, while the tunnel mode forward all the MIPI
>> +  data received by the serializer.
>> +  The MAX96717F supports Reference Over Reverse (channel),
>> +  to generate a clock output for the sensor from the GMSL reverse channel.
>> +
>> +  The GMSL2 serial link operates at a fixed rate of 3Gbps in the
>> +  forward direction and 187.5Mbps in the reverse direction.
>> +
>> +properties:
>> +  compatible:
>> +    const: maxim,max96717f
>> +
>> +  '#gpio-cells':
>> +    const: 2
>> +    description:
>> +      First cell is the GPIO pin number, second cell is the flags. The GPIO pin
>> +      number must be in range of [0, 10].
>> +
>> +  gpio-controller: true
>> +
>> +  '#clock-cells':
>> +    const: 0
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  ports:
>> +    $ref: /schemas/graph.yaml#/properties/ports
>> +
>> +    properties:
>> +      port@0:
>> +        $ref: /schemas/graph.yaml#/$defs/port-base
>> +        unevaluatedProperties: false
>> +        description: CSI-2 Input port
>> +
>> +        properties:
>> +          endpoint:
>> +            $ref: /schemas/media/video-interfaces.yaml#
>> +            unevaluatedProperties: false
>> +
>> +            properties:
>> +              data-lanes:
>> +                minItems: 1
>> +                maxItems: 4
>> +
>> +            required:
>> +              - data-lanes
>> +
>> +      port@1:
>> +        $ref: /schemas/graph.yaml#/properties/port
>> +        unevaluatedProperties: false
>> +        description: GMSL Output port
>> +
>> +    required:
>> +      - port@1
>> +
>> +  i2c-gate:
>> +    $ref: /schemas/i2c/i2c-controller.yaml
>> +    unevaluatedProperties: false
>> +    description: |
> 
> I think you can remove ' |'.
Ok

> 
>> +      The MAX96717F will forward the I2C requests from the
>> +      incoming GMSL2 link. Therefore, it supports an i2c-gate
>> +      subnode to configure a sensor.
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - ports
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/gpio/gpio.h>
>> +    #include <dt-bindings/media/video-interfaces.h>
>> +
>> +    i2c {
>> +        #address-cells = <1>;
>> +        #size-cells = <0>;
>> +        serializer: serializer@40 {
>> +            compatible = "maxim,max96717f";
>> +            reg = <0x40>;
>> +            gpio-controller;
>> +            #gpio-cells = <2>;
>> +            #clock-cells = <0>;
>> +
>> +            ports {
>> +                #address-cells = <1>;
>> +                #size-cells = <0>;
>> +
>> +                port@0 {
>> +                    reg = <0>;
>> +                    max96717f_csi_in: endpoint {
>> +                        data-lanes = <1 2 3 4>;
>> +                        remote-endpoint = <&sensor_out>;
>> +                    };
>> +                };
>> +
>> +                port@1 {
>> +                    reg = <1>;
>> +                    max96917f_gmsl_out: endpoint {
>> +                        remote-endpoint = <&deser_gmsl_in>;
>> +                    };
>> +                };
>> +            };
>> +
>> +            i2c-gate {
>> +                #address-cells = <1>;
>> +                #size-cells = <0>;
>> +                sensor@10 {
>> +                    compatible = "st,st-vgxy61";
>> +                    reg = <0x10>;
>> +                    reset-gpios = <&serializer 0 GPIO_ACTIVE_LOW>;
>> +                    clocks = <&serializer>;
>> +                    VCORE-supply = <&v1v2>;
>> +                    VDDIO-supply = <&v1v8>;
>> +                    VANA-supply = <&v2v8>;
>> +                    port {
>> +                        sensor_out: endpoint {
>> +                            data-lanes = <1 2 3 4>;
>> +                            remote-endpoint = <&max96717f_csi_in>;
>> +                        };
>> +                    };
>> +                };
>> +            };
>> +        };
>> +    };
>> +...
>