Skip to contentSkip to conversation

media: dt-bindings: hynix,hi846: Document orientation and rotation

PATCH In review Fabio Estevam 4 participants 8 messages Sep 28, 2023 – Sep 29, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 media: dt-bindings: hynix,hi846: Document orientation and rotation

From: Fabio Estevam <[email protected]>

Document the 'orientation' and 'rotation' properties, which are valid for the SK Hynix Hi-846 sensor.

Their definitions come from video-interface-devices.yaml, so add a reference to it.

---
Changes since v1:
- Also pass a ref to video-interface-devices.yaml. (Martin)

 .../devicetree/bindings/media/i2c/hynix,hi846.yaml         | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/devicetree/bindings/media/i2c/hynix,hi846.yaml +7 -0
index 1e2df8cf2937..8b7a46a15458 100644
@@ -14,6 +14,9 @@ description: |-
   interface and CCI (I2C compatible) control bus. The output format
   is raw Bayer.
 
+allOf:
+  - $ref: /schemas/media/video-interface-devices.yaml#
+
 properties:
   compatible:
     const: hynix,hi846
@@ -48,6 +51,10 @@ properties:
   vddd-supply:
     description: Definition of the regulator used for the VDDD power supply.
 
+  orientation: true
+
+  rotation: true
+
   port:
     $ref: /schemas/graph.yaml#/$defs/port-base
     unevaluatedProperties: false
Signature · 1 line
2.34.1
#1 lore raw

Hi Fabio, Krzysztof

Quoted 8 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>

Document the 'orientation' and 'rotation' properties, which are valid for the SK Hynix Hi-846 sensor.

Their definitions come from video-interface-devices.yaml, so add a reference to it.

Quoted 7 lines

---
Changes since v1:
- Also pass a ref to video-interface-devices.yaml. (Martin)

This patch is technically correct, so this message is not meant to delay its integration or anything like that, but I'll take the occasion to ask for guidance to the DT maintainers, as I think this approach doesn't scale.

I count the following sensor bindings that refer to video-interface-device.yaml

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5675.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml

These:

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml:additionalProperties: false

specify 'additionalProperties: false' at the top-level. This is correct imho, as it implies that any properties not specifically allowed by bindings is forbidden.

This unfortunately applies to 'rotation' and 'orientation' as well. This is not correct, as those two properties should apply to all sensors without the requiring the bindings to explicitly allow them.

Counterproof: It's very easy to break validation of, in example, ov5640

Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml +1 -0
@@ -109,6 +109,7 @@ examples:
               powerdown-gpios = <&gpio1 19 GPIO_ACTIVE_HIGH>;
               reset-gpios = <&gpio1 20 GPIO_ACTIVE_LOW>;
               rotation = <180>;
+              orientation = <0>;
 
               port {
                   /* MIPI CSI-2 bus endpoint */
$ make ARCH=arm64 dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml
  DTC_CHK Documentation/devicetree/bindings/media/i2c/ovti,ov5640.example.dtb
  'orientation' does not match any of the regexes: 'pinctrl-[0-9]+'
	from schema $id: http://devicetree.org/schemas/media/i2c/ovti,ov5640.yaml#

Is there a way to allow those two properties ('rotation' and 'orientation') to be accepted by all sensor drivers bindings ?

Thanks
j

Quoted 31 lines
 .../devicetree/bindings/media/i2c/hynix,hi846.yaml         | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/devicetree/bindings/media/i2c/hynix,hi846.yaml +7 -1
index 1e2df8cf2937..8b7a46a15458 100644
@@ -14,6 +14,9 @@ description: |-
   interface and CCI (I2C compatible) control bus. The output format
   is raw Bayer.
 
+allOf:
+  - $ref: /schemas/media/video-interface-devices.yaml#
+
 properties:
   compatible:
     const: hynix,hi846
@@ -48,6 +51,10 @@ properties:
   vddd-supply:
     description: Definition of the regulator used for the VDDD power supply.
 
+  orientation: true
+
+  rotation: true
+
   port:
     $ref: /schemas/graph.yaml#/$defs/port-base
     unevaluatedProperties: false
--

2.34.1

#2 lore raw

Hi Jacopo,

Quoted 14 lines · Jacopo Mondi

Counterproof: It's very easy to break validation of, in example, ov5640

Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml +1 -0
@@ -109,6 +109,7 @@ examples:
               powerdown-gpios = <&gpio1 19 GPIO_ACTIVE_HIGH>;
               reset-gpios = <&gpio1 20 GPIO_ACTIVE_LOW>;
               rotation = <180>;
+              orientation = <0>;
 
               port {
                   /* MIPI CSI-2 bus endpoint */
Quoted 7 lines
$ make ARCH=arm64 dt_binding_check
DT_SCHEMA_FILES=Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml
  DTC_CHK 
Documentation/devicetree/bindings/media/i2c/ovti,ov5640.example.dtb
  'orientation' does not match any of the regexes: 'pinctrl-[0-9]+'
	from schema $id: 
http://devicetree.org/schemas/media/i2c/ovti,ov5640.yaml#

Should we use unevaluatedProperties: false instead?

Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml +2 -1
@@ -85,7 +85,7 @@ required:
   - DOVDD-supply
   - port
 
-additionalProperties: false
+unevaluatedProperties: false
 
 examples:
   - |
@@ -109,6 +109,7 @@ examples:
               powerdown-gpios = <&gpio1 19 GPIO_ACTIVE_HIGH>;
               reset-gpios = <&gpio1 20 GPIO_ACTIVE_LOW>;
               rotation = <180>;
+              orientation = <0>;
 
               port {
                   /* MIPI CSI-2 bus endpoint */
maintainer
#3 lore raw
In reply to Jacopo Mondi
Quoted 65 lines · Jacopo Mondi

Hi Fabio, Krzysztof

Quoted 8 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>

Document the 'orientation' and 'rotation' properties, which are valid for the SK Hynix Hi-846 sensor.

Their definitions come from video-interface-devices.yaml, so add a reference to it.

Quoted 7 lines

---
Changes since v1:
- Also pass a ref to video-interface-devices.yaml. (Martin)

This patch is technically correct, so this message is not meant to delay its integration or anything like that, but I'll take the occasion to ask for guidance to the DT maintainers, as I think this approach doesn't scale.

I count the following sensor bindings that refer to video-interface-device.yaml

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5675.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml

These:

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml:additionalProperties: false

specify 'additionalProperties: false' at the top-level. This is correct imho, as it implies that any properties not specifically allowed by bindings is forbidden.

This unfortunately applies to 'rotation' and 'orientation' as well. This is not correct, as those two properties should apply to all sensors without the requiring the bindings to explicitly allow them.

Counterproof: It's very easy to break validation of, in example, ov5640

Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml +1 -0
@@ -109,6 +109,7 @@ examples:
               powerdown-gpios = <&gpio1 19 GPIO_ACTIVE_HIGH>;
               reset-gpios = <&gpio1 20 GPIO_ACTIVE_LOW>;
               rotation = <180>;
+              orientation = <0>;
 
               port {
                   /* MIPI CSI-2 bus endpoint */
Quoted 7 lines
$ make ARCH=arm64 dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml
  DTC_CHK Documentation/devicetree/bindings/media/i2c/ovti,ov5640.example.dtb
  'orientation' does not match any of the regexes: 'pinctrl-[0-9]+'
	from schema $id: http://devicetree.org/schemas/media/i2c/ovti,ov5640.yaml#

Is there a way to allow those two properties ('rotation' and 'orientation') to be accepted by all sensor drivers bindings ?

Use unevaluatedProperties instead of additionalProperties and add a $ref to video-interface-devices.yaml in the sensor schemas. However, that will allow all properties in video-interface-devices.yaml (which is just flash-leds and lens-focus which seem fine). If you don't want that, then you will have to split up video-interface-devices.yaml.

Rob

#4 lore raw

Hi Rob, Fabio

Quoted 71 lines · Rob Herring
Quoted 70 lines · Jacopo Mondi

Hi Fabio, Krzysztof

Quoted 8 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>

Document the 'orientation' and 'rotation' properties, which are valid for the SK Hynix Hi-846 sensor.

Their definitions come from video-interface-devices.yaml, so add a reference to it.

Quoted 7 lines

---
Changes since v1:
- Also pass a ref to video-interface-devices.yaml. (Martin)

This patch is technically correct, so this message is not meant to delay its integration or anything like that, but I'll take the occasion to ask for guidance to the DT maintainers, as I think this approach doesn't scale.

I count the following sensor bindings that refer to video-interface-device.yaml

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5675.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml

These:

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml:additionalProperties: false

specify 'additionalProperties: false' at the top-level. This is correct imho, as it implies that any properties not specifically allowed by bindings is forbidden.

This unfortunately applies to 'rotation' and 'orientation' as well. This is not correct, as those two properties should apply to all sensors without the requiring the bindings to explicitly allow them.

Counterproof: It's very easy to break validation of, in example, ov5640

Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml +1 -0
@@ -109,6 +109,7 @@ examples:
               powerdown-gpios = <&gpio1 19 GPIO_ACTIVE_HIGH>;
               reset-gpios = <&gpio1 20 GPIO_ACTIVE_LOW>;
               rotation = <180>;
+              orientation = <0>;
 
               port {
                   /* MIPI CSI-2 bus endpoint */
$ make ARCH=arm64 dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml
  DTC_CHK Documentation/devicetree/bindings/media/i2c/ovti,ov5640.example.dtb
  'orientation' does not match any of the regexes: 'pinctrl-[0-9]+'
	from schema $id: http://devicetree.org/schemas/media/i2c/ovti,ov5640.yaml#
Quoted 8 lines
Quoted 2 lines

Is there a way to allow those two properties ('rotation' and 'orientation') to be accepted by all sensor drivers bindings ?

Use unevaluatedProperties instead of additionalProperties and add a $ref to video-interface-devices.yaml in the sensor schemas. However, that will allow all properties in video-interface-devices.yaml (which is just flash-leds and lens-focus which seem fine). If you don't want that, then you will have to split up video-interface-devices.yaml.

ack! I think it's fine to allow all sensors to point to a lens or a flash device if they want to.

I'll send a patch for:

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml:additionalProperties: false

to s/additionalProperties/unevaluatedProperties/

On this binding file instead. I noticed it again specifies
unevaluatedProperties: false both in the and 'endpoint' nodes, which refers to /schemas/media/video-interfaces.yaml. This allows all properties from that schema to be specified.

Should I send a patch to or is Fabio interested in doing so as part of a new version of this patch ?

Documentation/devicetree/bindings/media/i2c/hynix,hi846.yaml +2 -1
@@ -55,7 +55,7 @@ properties:
     properties:
       endpoint:
         $ref: /schemas/media/video-interfaces.yaml#
-        unevaluatedProperties: false
+        additionalProperties: false
 
         properties:
           data-lanes:
@@ -70,6 +70,7 @@ properties:
                   - const: 2
 
           link-frequencies: true
+          remote-endpoint: true
 
 
 
Quoted 2 lines

Rob

#5 lore raw

Hi Jacopo,

Quoted 2 lines · Jacopo Mondi

Should I send a patch to or is Fabio interested in doing so as part of a new version of this patch ?

Feel free to send it, thanks.

#6 lore raw
In reply to Jacopo Mondi

Hi again Fabio

Quoted 96 lines · Jacopo Mondi

Hi Rob, Fabio

Quoted 71 lines · Rob Herring
Quoted 70 lines · Jacopo Mondi

Hi Fabio, Krzysztof

Quoted 8 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>

Document the 'orientation' and 'rotation' properties, which are valid for the SK Hynix Hi-846 sensor.

Their definitions come from video-interface-devices.yaml, so add a reference to it.

Quoted 7 lines

---
Changes since v1:
- Also pass a ref to video-interface-devices.yaml. (Martin)

This patch is technically correct, so this message is not meant to delay its integration or anything like that, but I'll take the occasion to ask for guidance to the DT maintainers, as I think this approach doesn't scale.

I count the following sensor bindings that refer to video-interface-device.yaml

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5675.yaml Documentation/devicetree/bindings/media/i2c/ovti,ov5693.yaml Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml

These:

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml:additionalProperties: false

specify 'additionalProperties: false' at the top-level. This is correct imho, as it implies that any properties not specifically allowed by bindings is forbidden.

This unfortunately applies to 'rotation' and 'orientation' as well. This is not correct, as those two properties should apply to all sensors without the requiring the bindings to explicitly allow them.

Counterproof: It's very easy to break validation of, in example, ov5640

Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml +1 -0
@@ -109,6 +109,7 @@ examples:
               powerdown-gpios = <&gpio1 19 GPIO_ACTIVE_HIGH>;
               reset-gpios = <&gpio1 20 GPIO_ACTIVE_LOW>;
               rotation = <180>;
+              orientation = <0>;
 
               port {
                   /* MIPI CSI-2 bus endpoint */
$ make ARCH=arm64 dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml
  DTC_CHK Documentation/devicetree/bindings/media/i2c/ovti,ov5640.example.dtb
  'orientation' does not match any of the regexes: 'pinctrl-[0-9]+'
	from schema $id: http://devicetree.org/schemas/media/i2c/ovti,ov5640.yaml#
Quoted 8 lines
Quoted 2 lines

Is there a way to allow those two properties ('rotation' and 'orientation') to be accepted by all sensor drivers bindings ?

Use unevaluatedProperties instead of additionalProperties and add a $ref to video-interface-devices.yaml in the sensor schemas. However, that will allow all properties in video-interface-devices.yaml (which is just flash-leds and lens-focus which seem fine). If you don't want that, then you will have to split up video-interface-devices.yaml.

ack! I think it's fine to allow all sensors to point to a lens or a flash device if they want to.

I'll send a patch for:

Documentation/devicetree/bindings/media/i2c/ovti,ov02a10.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov4689.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/ovti,ov5640.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx214.yaml:additionalProperties: false Documentation/devicetree/bindings/media/i2c/sony,imx415.yaml:additionalProperties: false

to s/additionalProperties/unevaluatedProperties/

Quoted 8 lines

On this binding file instead. I noticed it again specifies
unevaluatedProperties: false both in the and 'endpoint' nodes, which refers to /schemas/media/video-interfaces.yaml. This allows all properties from that schema to be specified.

Should I send a patch to or is Fabio interested in doing so as part of a new version of this patch ?

Actually, if I'm going to s/additionalProperties/unevaluatedProperties/ in this bindings as well, am I wrong this patch is not needed anymore ?

#7 lore raw

Hi Jacopo,

Quoted 2 lines · Jacopo Mondi

Actually, if I'm going to s/additionalProperties/unevaluatedProperties/ in this bindings as well, am I wrong this patch is not needed anymore ?

You can discard this patch.

Make sure that the schema warning below is gone:

imx8mq-librem5-r3.dtb: camera@20: 'orientation', 'rotation' do not match any of the regexes: 'pinctrl-[0-9]+'
from schema $id: http://devicetree.org/schemas/media/i2c/hynix,hi846.yaml#

The diff below works for me:

Documentation/devicetree/bindings/media/i2c/hynix,hi846.yaml +4 -1
@@ -14,6 +14,9 @@ description: |-
   interface and CCI (I2C compatible) control bus. The output format
   is raw Bayer.
 
+allOf:
+  - $ref: /schemas/media/video-interface-devices.yaml#
+
 properties:
   compatible:
     const: hynix,hi846
@@ -86,7 +89,7 @@ required:
   - vddd-supply
   - port
 
-additionalProperties: false
+unevaluatedProperties: false
 
 examples:
   - |