[v1] media: Add Sony IMX585 image sensor support

[PATCH v1 1/4] dt-bindings: media: Add Sony IMX585 CMOS image sensor

Posted by Will Whang 3 months, 1 week ago

Document the devicetree binding for the Sony IMX585.  The schema
covers the CSI-2 data-lanes, the optional 'mono-mode' flag,
and the internal-sync properties used by the driver.

Signed-off-by: Will Whang <will@willwhang.com>
---
 .../bindings/media/i2c/sony,imx585.yaml       | 120 ++++++++++++++++++
 MAINTAINERS                                   |   8 ++
 2 files changed, 128 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml

diff --git a/Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml b/Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml
new file mode 100644
index 000000000..d050d1642
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml
@@ -0,0 +1,120 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2024 Ideas on Board Oy
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/i2c/sony,imx585.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Sony IMX585 Sensor
+
+maintainers:
+  - Will Whang <will@willwhang.com>
+
+description:
+  IMX585 sensor is a Sony CMOS sensor with 4K and FHD outputs.
+
+properties:
+  compatible:
+    const: sony,imx585
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    const: xclk
+
+  clock-frequency:
+    enum: [ 74250000, 37125000, 72000000, 27000000, 24000000 ]
+
+  reg:
+    maxItems: 1
+    description: I2C Address for IMX585
+
+  VANA-supply:
+    description: Analog power supply (3.3V)
+
+  VDDL-supply:
+    description: Interface power supply (1.8V)
+
+  VDIG-supply:
+    description: Digital power supply (1.1V)
+
+  reset-gpios:
+    description: Sensor reset (XCLR) GPIO
+    maxItems: 1
+
+  port:
+    $ref: /schemas/graph.yaml#/$defs/port-base
+    additionalProperties: false
+
+    properties:
+      endpoint:
+        $ref: /schemas/media/video-interfaces.yaml#
+        unevaluatedProperties: false
+
+        properties:
+          data-lanes:
+            anyOf:
+              - items:
+                  - const: 1
+                  - const: 2
+                  - const: 3
+                  - const: 4
+
+          sync-mode:
+            description: |
+              Select the synchronisation mode of the sensor
+                0 – internal sync, leader (default)
+                1 – internal sync, follower
+                2 – external sync
+            $ref: /schemas/types.yaml#/definitions/uint8
+            enum: [ 0, 1, 2 ]
+
+          link-frequencies:
+            description: Select the MIPI-CSI2 link speed in Mhz
+            items:
+              enum: [ 297000000, 360000000, 445500000, 594000000,
+                      720000000, 891000000, 1039500000 ]
+
+        required:
+          - data-lanes
+          - link-frequencies
+
+    required:
+      - endpoint
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-frequency
+  - port
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        imx585@1a {
+            compatible = "sony,imx585";
+            reg = <0x1a>;
+            clocks = <&imx585_clk>;
+            clock-frequency = <24000000>;
+
+            VANA-supply = <&camera_vadd_3v3>;
+            VDDL-supply = <&camera_vdd1_1v8>;
+            VDIG-supply = <&camera_vdd2_1v1>;
+
+            port {
+                imx585: endpoint {
+                    remote-endpoint = <&cam>;
+                    data-lanes = <1 2 3 4>;
+                    link-frequencies = /bits/ 64 <720000000>;
+                };
+            };
+        };
+    };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index da34c7227..9cc404790 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -23150,6 +23150,14 @@ T:	git git://linuxtv.org/media.git
 F:	Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml
 F:	drivers/media/i2c/imx415.c
 
+SONY IMX585 SENSOR DRIVER
+M:	Will Whang <will@willwhang.com>
+L:	linux-media@vger.kernel.org
+S:	Maintained
+T:	git git://linuxtv.org/media.git
+F:	Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml
+F:	drivers/media/i2c/imx585.c
+
 SONY MEMORYSTICK SUBSYSTEM
 M:	Maxim Levitsky <maximlevitsky@gmail.com>
 M:	Alex Dubov <oakad@yahoo.com>
-- 
2.39.5

Re: [PATCH v1 1/4] dt-bindings: media: Add Sony IMX585 CMOS image sensor

Posted by Krzysztof Kozlowski 3 months ago

On 02/07/2025 08:38, Will Whang wrote:
> +
> +description:
> +  IMX585 sensor is a Sony CMOS sensor with 4K and FHD outputs.
> +
> +properties:
> +  compatible:
> +    const: sony,imx585
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    const: xclk
> +
> +  clock-frequency:
> +    enum: [ 74250000, 37125000, 72000000, 27000000, 24000000 ]

Drop the property.

> +
> +  reg:

reg always follows compatible.

> +    maxItems: 1
> +    description: I2C Address for IMX585

Drop description, redundant.

> +
> +  VANA-supply:

Lower case.

> +    description: Analog power supply (3.3V)
> +
> +  VDDL-supply:
> +    description: Interface power supply (1.8V)
> +
> +  VDIG-supply:
> +    description: Digital power supply (1.1V)
> +
> +  reset-gpios:
> +    description: Sensor reset (XCLR) GPIO
> +    maxItems: 1
> +
> +  port:
> +    $ref: /schemas/graph.yaml#/$defs/port-base
> +    additionalProperties: false
> +
> +    properties:
> +      endpoint:
> +        $ref: /schemas/media/video-interfaces.yaml#
> +        unevaluatedProperties: false
> +
> +        properties:
> +          data-lanes:
> +            anyOf:
> +              - items:
> +                  - const: 1
> +                  - const: 2
> +                  - const: 3
> +                  - const: 4
> +
> +          sync-mode:

Missing vendor prefix

> +            description: |
> +              Select the synchronisation mode of the sensor
> +                0 – internal sync, leader (default)
> +                1 – internal sync, follower
> +                2 – external sync
> +            $ref: /schemas/types.yaml#/definitions/uint8
> +            enum: [ 0, 1, 2 ]

This should be just string enum

Missing default

> +
> +          link-frequencies:
> +            description: Select the MIPI-CSI2 link speed in Mhz
> +            items:
> +              enum: [ 297000000, 360000000, 445500000, 594000000,
> +                      720000000, 891000000, 1039500000 ]
> +
> +        required:
> +          - data-lanes
> +          - link-frequencies
> +
> +    required:
> +      - endpoint
> +
> +required:
> +  - compatible
> +  - reg

And why here is different? BTW, here it is correct.


> +  - clocks
> +  - clock-frequency

Drop

> +  - port
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        imx585@1a {

Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation


> +            compatible = "sony,imx585";
> +            reg = <0x1a>;
> +            clocks = <&imx585_clk>;
> +            clock-frequency = <24000000>;
> +
> +            VANA-supply = <&camera_vadd_3v3>;
> +            VDDL-supply = <&camera_vdd1_1v8>;
> +            VDIG-supply = <&camera_vdd2_1v1>;
> +
> +            port {
> +                imx585: endpoint {
> +                    remote-endpoint = <&cam>;
> +                    data-lanes = <1 2 3 4>;
> +                    link-frequencies = /bits/ 64 <720000000>;
> +                };
> +            };
> +        };
> +    };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index da34c7227..9cc404790 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -23150,6 +23150,14 @@ T:	git git://linuxtv.org/media.git
>  F:	Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml
>  F:	drivers/media/i2c/imx415.c
>  
> +SONY IMX585 SENSOR DRIVER
> +M:	Will Whang <will@willwhang.com>
> +L:	linux-media@vger.kernel.org
> +S:	Maintained
> +T:	git git://linuxtv.org/media.git

Drop, you do not have access there, AFAIK.

> +F:	Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml
> +F:	drivers/media/i2c/imx585.c

There is no such file.

> +
>  SONY MEMORYSTICK SUBSYSTEM
>  M:	Maxim Levitsky <maximlevitsky@gmail.com>
>  M:	Alex Dubov <oakad@yahoo.com>


Best regards,
Krzysztof

Re: [PATCH v1 1/4] dt-bindings: media: Add Sony IMX585 CMOS image sensor

Posted by Laurent Pinchart 3 months, 1 week ago

Hi Will,

Thank you for the patch.

On Wed, Jul 02, 2025 at 07:38:33AM +0100, Will Whang wrote:
> Document the devicetree binding for the Sony IMX585.  The schema
> covers the CSI-2 data-lanes, the optional 'mono-mode' flag,
> and the internal-sync properties used by the driver.
> 
> Signed-off-by: Will Whang <will@willwhang.com>
> ---
>  .../bindings/media/i2c/sony,imx585.yaml       | 120 ++++++++++++++++++
>  MAINTAINERS                                   |   8 ++
>  2 files changed, 128 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml
> 
> diff --git a/Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml b/Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml
> new file mode 100644
> index 000000000..d050d1642
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml
> @@ -0,0 +1,120 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (C) 2024 Ideas on Board Oy

Unless there's something I'm not aware of, I don't think Ideas on Board
wrote this. You can use your own copyright.

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/media/i2c/sony,imx585.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Sony IMX585 Sensor
> +
> +maintainers:
> +  - Will Whang <will@willwhang.com>
> +
> +description:
> +  IMX585 sensor is a Sony CMOS sensor with 4K and FHD outputs.
> +

You should add

allOf:
  - $ref: /schemas/media/video-interface-devices.yaml#

here to support generic sensor properties. You will need to replace

additionalProperties: false

with

unevaluatedProperties: false

below.

> +properties:
> +  compatible:
> +    const: sony,imx585
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    const: xclk

When there's a single clock you can drop clock-names.

> +
> +  clock-frequency:
> +    enum: [ 74250000, 37125000, 72000000, 27000000, 24000000 ]

The clock-frequency property is frowned upon for sensors in DT. If the
aim is to set the frequency of the clock, it should be done through
assigned-clocks and assigned-clock-rates. If the aim is to convey the
clock frequency to the driver, it should be done by calling
clk_get_rate() in the driver.

> +
> +  reg:
> +    maxItems: 1
> +    description: I2C Address for IMX585

You can drop the description, it's always the same for I2C devices.

> +
> +  VANA-supply:
> +    description: Analog power supply (3.3V)
> +
> +  VDDL-supply:
> +    description: Interface power supply (1.8V)
> +
> +  VDIG-supply:
> +    description: Digital power supply (1.1V)
> +
> +  reset-gpios:
> +    description: Sensor reset (XCLR) GPIO
> +    maxItems: 1
> +
> +  port:
> +    $ref: /schemas/graph.yaml#/$defs/port-base
> +    additionalProperties: false
> +
> +    properties:
> +      endpoint:
> +        $ref: /schemas/media/video-interfaces.yaml#
> +        unevaluatedProperties: false
> +
> +        properties:
> +          data-lanes:
> +            anyOf:
> +              - items:
> +                  - const: 1
> +                  - const: 2
> +                  - const: 3
> +                  - const: 4

Does that mean that the sensor supports data lane remapping ? I don't
see it implemented by the driver. If it's not supported by the hardware,
you should use

        properties:
          data-lanes:
	    minItems: 1
            items:
              - const: 1
              - const: 2
              - const: 3
              - const: 4

To guarantee the order.

> +
> +          sync-mode:
> +            description: |
> +              Select the synchronisation mode of the sensor
> +                0 – internal sync, leader (default)
> +                1 – internal sync, follower
> +                2 – external sync
> +            $ref: /schemas/types.yaml#/definitions/uint8
> +            enum: [ 0, 1, 2 ]

This seems to be a sensor-level property, not an endpoint property. As
it's not standard, it should also have a vendor prefix, i.e.
sony,sync-mode. I'm wondering, though, if we shouldn't try to
standardize it in video-interface-devices.yaml.

> +
> +          link-frequencies:
> +            description: Select the MIPI-CSI2 link speed in Mhz

You can drop the description, it's already described in
video-interfaces.yaml.

> +            items:
> +              enum: [ 297000000, 360000000, 445500000, 594000000,
> +                      720000000, 891000000, 1039500000 ]

Are those frequencies the only ones the hardware can support, or do they
come from the driver only supporting a fixed set of sensor PLL
configurations ? In the latter case I would drop the enumeration.

> +
> +        required:
> +          - data-lanes
> +          - link-frequencies
> +
> +    required:
> +      - endpoint
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - clock-frequency
> +  - port
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        imx585@1a {
> +            compatible = "sony,imx585";
> +            reg = <0x1a>;
> +            clocks = <&imx585_clk>;
> +            clock-frequency = <24000000>;
> +
> +            VANA-supply = <&camera_vadd_3v3>;
> +            VDDL-supply = <&camera_vdd1_1v8>;
> +            VDIG-supply = <&camera_vdd2_1v1>;
> +
> +            port {
> +                imx585: endpoint {
> +                    remote-endpoint = <&cam>;
> +                    data-lanes = <1 2 3 4>;
> +                    link-frequencies = /bits/ 64 <720000000>;
> +                };
> +            };
> +        };
> +    };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index da34c7227..9cc404790 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -23150,6 +23150,14 @@ T:	git git://linuxtv.org/media.git
>  F:	Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml
>  F:	drivers/media/i2c/imx415.c
>  
> +SONY IMX585 SENSOR DRIVER
> +M:	Will Whang <will@willwhang.com>
> +L:	linux-media@vger.kernel.org
> +S:	Maintained
> +T:	git git://linuxtv.org/media.git
> +F:	Documentation/devicetree/bindings/media/i2c/sony,imx585.yaml
> +F:	drivers/media/i2c/imx585.c
> +
>  SONY MEMORYSTICK SUBSYSTEM
>  M:	Maxim Levitsky <maximlevitsky@gmail.com>
>  M:	Alex Dubov <oakad@yahoo.com>

-- 
Regards,

Laurent Pinchart

[PATCH v1 1/4] dt-bindings: media: Add Sony IMX585 CMOS image sensor
[PATCH v1 2/4] media: uapi: Add custom IMX585 control IDs
[PATCH v1 3/4] media: i2c: imx585: Add Sony IMX585 image-sensor driver
[PATCH v1 4/4] media: docs: Add userspace-API guide for the IMX585 driver