This patch adds documentation of device tree in YAML schema for the
OV5693 CMOS image sensor from Omnivision
Signed-off-by: Tommaso Merciai <[email protected]>
---
.../bindings/media/i2c/ovti,ov5693.yaml | 123 ++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 124 insertions(+)
create mode 100644 Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
diff --git a/Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml b/Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
new file mode 100644
index 000000000000..1ee70af40000
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
@@ -0,0 +1,123 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (c) 2022 Amarulasolutions
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/i2c/ovti,ov5693.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Omnivision OV5693 CMOS Sensor
+
+maintainers:
+ - Tommaso Merciai <[email protected]>
+
+allOf:
+ - $ref: /schemas/media/video-interface-devices.yaml#
+
+description: |
+ The Omnivision OV5693 is a high performance, 1/4-inch, 5 megapixel, CMOS
+ image sensor that delivers 2592x1944 at 30fps. It provides full-frame,
+ sub-sampled, and windowed 10-bit MIPI images in various formats via the
+ Serial Camera Control Bus (SCCB) interface.
+
+ Supports images sizes: 5 Mpixel, EIS1080p, 1080p, 720p, VGA, QVGA
+
+ OV5693 is programmable through I2C and two-wire Serial Camera Control Bus (SCCB).
+ The sensor output is available via CSI-2 serial data output (up to 2-lane).
+
+properties:
+ compatible:
+ const: ovti,ov5693
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ description:
+ System input clock (aka XVCLK). From 6 to 27 MHz.
+ maxItems: 1
+
+ dovdd-supply:
+ description:
+ Digital I/O voltage supply, 1.8V.
+
+ avdd-supply:
+ description:
+ Analog voltage supply, 2.8V.
+
+ dvdd-supply:
+ description:
+ Digital core voltage supply, 1.2V.
+
+ reset-gpios:
+ description:
+ The phandle and specifier for the GPIO that controls sensor reset.
+ This corresponds to the hardware pin XSHUTDN which is physically
+ active low.
+ 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:
+ minItems: 1
+ maxItems: 2
+
+ # Supports max data transfer of 900 Mbps per lane
+ link-frequencies: true
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - dovdd-supply
+ - avdd-supply
+ - dvdd-supply
+ - port
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/clock/px30-cru.h>
+ #include <dt-bindings/gpio/gpio.h>
+ #include <dt-bindings/pinctrl/rockchip.h>
+
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ ov5693: camera@36 {
+ compatible = "ovti,ov5693";
+ reg = <0x36>;
+
+ reset-gpios = <&gpio2 RK_PB1 GPIO_ACTIVE_LOW>;
+ pinctrl-names = "default";
+ pinctrl-0 = <&cif_clkout_m0>;
+
+ clocks = <&cru SCLK_CIF_OUT>;
+ assigned-clocks = <&cru SCLK_CIF_OUT>;
+ assigned-clock-rates = <19200000>;
+
+ avdd-supply = <&vcc_1v8>;
+ dvdd-supply = <&vcc_1v2>;
+ dovdd-supply = <&vcc_2v8>;
+
+ rotation = <90>;
+ orientation = <0>;
+
+ port {
+ ucam_out: endpoint {
+ remote-endpoint = <&mipi_in_ucam>;
+ data-lanes = <1 2>;
+ link-frequencies = /bits/ 64 <450000000>;
+ };
+ };
+ };
+ };
\ No newline at end of file
diff --git a/MAINTAINERS b/MAINTAINERS
index 1fc9ead83d2a..844307cb20c4 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -14719,6 +14719,7 @@ M: Daniel Scally <[email protected]>
L: [email protected]
S: Maintained
T: git git://linuxtv.org/media_tree.git
+F: Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
F: drivers/media/i2c/ov5693.c
OMNIVISION OV5695 SENSOR DRIVER
--
2.25.1
On 25/06/2022 01:03, Tommaso Merciai wrote:
> This patch adds documentation of device tree in YAML schema for the
> OV5693 CMOS image sensor from Omnivision
>
> Signed-off-by: Tommaso Merciai <[email protected]>
> ---
> .../bindings/media/i2c/ovti,ov5693.yaml | 123 ++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 124 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
>
> diff --git a/Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml b/Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
> new file mode 100644
> index 000000000000..1ee70af40000
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
> @@ -0,0 +1,123 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (c) 2022 Amarulasolutions
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/media/i2c/ovti,ov5693.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Omnivision OV5693 CMOS Sensor
> +
> +maintainers:
> + - Tommaso Merciai <[email protected]>
> +
> +allOf:
> + - $ref: /schemas/media/video-interface-devices.yaml#
This goes after description.
> +
> +description: |
> + The Omnivision OV5693 is a high performance, 1/4-inch, 5 megapixel, CMOS
> + image sensor that delivers 2592x1944 at 30fps. It provides full-frame,
> + sub-sampled, and windowed 10-bit MIPI images in various formats via the
> + Serial Camera Control Bus (SCCB) interface.
> +
> + Supports images sizes: 5 Mpixel, EIS1080p, 1080p, 720p, VGA, QVGA
> +
> + OV5693 is programmable through I2C and two-wire Serial Camera Control Bus (SCCB).
> + The sensor output is available via CSI-2 serial data output (up to 2-lane).
> +
> +properties:
> + compatible:
> + const: ovti,ov5693
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + description:
> + System input clock (aka XVCLK). From 6 to 27 MHz.
> + maxItems: 1
> +
> + dovdd-supply:
> + description:
> + Digital I/O voltage supply, 1.8V.
> +
> + avdd-supply:
> + description:
> + Analog voltage supply, 2.8V.
> +
> + dvdd-supply:
> + description:
> + Digital core voltage supply, 1.2V.
> +
> + reset-gpios:
> + description:
> + The phandle and specifier for the GPIO that controls sensor reset.
> + This corresponds to the hardware pin XSHUTDN which is physically
> + active low.
> + 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:
> + minItems: 1
> + maxItems: 2
> +
> + # Supports max data transfer of 900 Mbps per lane
> + link-frequencies: true
This is not needed. Provided by video-interfaces.yaml.
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - dovdd-supply
> + - avdd-supply
> + - dvdd-supply
> + - port
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/clock/px30-cru.h>
> + #include <dt-bindings/gpio/gpio.h>
> + #include <dt-bindings/pinctrl/rockchip.h>
> +
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + ov5693: camera@36 {
> + compatible = "ovti,ov5693";
> + reg = <0x36>;
> +
> + reset-gpios = <&gpio2 RK_PB1 GPIO_ACTIVE_LOW>;
> + pinctrl-names = "default";
> + pinctrl-0 = <&cif_clkout_m0>;
> +
> + clocks = <&cru SCLK_CIF_OUT>;
> + assigned-clocks = <&cru SCLK_CIF_OUT>;
> + assigned-clock-rates = <19200000>;
> +
> + avdd-supply = <&vcc_1v8>;
> + dvdd-supply = <&vcc_1v2>;
> + dovdd-supply = <&vcc_2v8>;
> +
> + rotation = <90>;
> + orientation = <0>;
> +
> + port {
> + ucam_out: endpoint {
> + remote-endpoint = <&mipi_in_ucam>;
> + data-lanes = <1 2>;
> + link-frequencies = /bits/ 64 <450000000>;
> + };
> + };
> + };
> + };
> \ No newline at end of file
^^^ This has to be fixed.
> diff --git a/MAINTAINERS b/MAINTAINERS
Best regards,
Krzysztof
Hi Krzysztof,
Thanks for your review, I will fix this in v2.
Regards,
Tommaso
On Sat, Jun 25, 2022 at 10:35:50PM +0200, Krzysztof Kozlowski wrote:
> On 25/06/2022 01:03, Tommaso Merciai wrote:
> > This patch adds documentation of device tree in YAML schema for the
> > OV5693 CMOS image sensor from Omnivision
> >
> > Signed-off-by: Tommaso Merciai <[email protected]>
> > ---
> > .../bindings/media/i2c/ovti,ov5693.yaml | 123 ++++++++++++++++++
> > MAINTAINERS | 1 +
> > 2 files changed, 124 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml b/Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
> > new file mode 100644
> > index 000000000000..1ee70af40000
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
> > @@ -0,0 +1,123 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +# Copyright (c) 2022 Amarulasolutions
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/media/i2c/ovti,ov5693.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Omnivision OV5693 CMOS Sensor
> > +
> > +maintainers:
> > + - Tommaso Merciai <[email protected]>
> > +
> > +allOf:
> > + - $ref: /schemas/media/video-interface-devices.yaml#
>
> This goes after description.
>
> > +
> > +description: |
> > + The Omnivision OV5693 is a high performance, 1/4-inch, 5 megapixel, CMOS
> > + image sensor that delivers 2592x1944 at 30fps. It provides full-frame,
> > + sub-sampled, and windowed 10-bit MIPI images in various formats via the
> > + Serial Camera Control Bus (SCCB) interface.
> > +
> > + Supports images sizes: 5 Mpixel, EIS1080p, 1080p, 720p, VGA, QVGA
> > +
> > + OV5693 is programmable through I2C and two-wire Serial Camera Control Bus (SCCB).
> > + The sensor output is available via CSI-2 serial data output (up to 2-lane).
> > +
> > +properties:
> > + compatible:
> > + const: ovti,ov5693
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + clocks:
> > + description:
> > + System input clock (aka XVCLK). From 6 to 27 MHz.
> > + maxItems: 1
> > +
> > + dovdd-supply:
> > + description:
> > + Digital I/O voltage supply, 1.8V.
> > +
> > + avdd-supply:
> > + description:
> > + Analog voltage supply, 2.8V.
> > +
> > + dvdd-supply:
> > + description:
> > + Digital core voltage supply, 1.2V.
> > +
> > + reset-gpios:
> > + description:
> > + The phandle and specifier for the GPIO that controls sensor reset.
> > + This corresponds to the hardware pin XSHUTDN which is physically
> > + active low.
> > + 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:
> > + minItems: 1
> > + maxItems: 2
> > +
> > + # Supports max data transfer of 900 Mbps per lane
> > + link-frequencies: true
>
> This is not needed. Provided by video-interfaces.yaml.
>
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - clocks
> > + - dovdd-supply
> > + - avdd-supply
> > + - dvdd-supply
> > + - port
> > +
> > +unevaluatedProperties: false
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/clock/px30-cru.h>
> > + #include <dt-bindings/gpio/gpio.h>
> > + #include <dt-bindings/pinctrl/rockchip.h>
> > +
> > + i2c {
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > +
> > + ov5693: camera@36 {
> > + compatible = "ovti,ov5693";
> > + reg = <0x36>;
> > +
> > + reset-gpios = <&gpio2 RK_PB1 GPIO_ACTIVE_LOW>;
> > + pinctrl-names = "default";
> > + pinctrl-0 = <&cif_clkout_m0>;
> > +
> > + clocks = <&cru SCLK_CIF_OUT>;
> > + assigned-clocks = <&cru SCLK_CIF_OUT>;
> > + assigned-clock-rates = <19200000>;
> > +
> > + avdd-supply = <&vcc_1v8>;
> > + dvdd-supply = <&vcc_1v2>;
> > + dovdd-supply = <&vcc_2v8>;
> > +
> > + rotation = <90>;
> > + orientation = <0>;
> > +
> > + port {
> > + ucam_out: endpoint {
> > + remote-endpoint = <&mipi_in_ucam>;
> > + data-lanes = <1 2>;
> > + link-frequencies = /bits/ 64 <450000000>;
> > + };
> > + };
> > + };
> > + };
> > \ No newline at end of file
>
> ^^^ This has to be fixed.
>
> > diff --git a/MAINTAINERS b/MAINTAINERS
> Best regards,
> Krzysztof
--
Tommaso Merciai
Embedded Linux Engineer
[email protected]
__________________________________
Amarula Solutions SRL
Via Le Canevare 30, 31100 Treviso, Veneto, IT
T. +39 042 243 5310
[email protected]
http://www.amarulasolutions.com
On Sat, 25 Jun 2022 01:03:07 +0200, Tommaso Merciai wrote:
> This patch adds documentation of device tree in YAML schema for the
> OV5693 CMOS image sensor from Omnivision
>
> Signed-off-by: Tommaso Merciai <[email protected]>
> ---
> .../bindings/media/i2c/ovti,ov5693.yaml | 123 ++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 124 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml
>
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
./Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml:123:7: [error] no new line character at the end of file (new-line-at-end-of-file)
dtschema/dtc warnings/errors:
doc reference errors (make refcheckdocs):
See https://patchwork.ozlabs.org/patch/
This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit.