diff mbox series

[v2,1/2] dt-bindings: iio: imu: smi240: devicetree binding

Message ID 20240809111635.106588-2-Jianping.Shen@de.bosch.com (mailing list archive)
State Changes Requested
Headers show
Series iio: imu: smi240: cover-letter | expand

Commit Message

Shen Jianping (ME-SE/EAD2) Aug. 9, 2024, 11:16 a.m. UTC
From: "Shen Jianping (ME-SE/EAD2)" <Jianping.Shen@de.bosch.com>

dt-bindings: iio: imu: smi240: dt-binding improvements
Signed-off-by: Shen Jianping (ME-SE/EAD2) <Jianping.Shen@de.bosch.com>
---

Notes:
    v1 -> v2
    - Add more detail in description
    - Add maintainer
    - Add vdd and vddio power supply
    - Use generic node name
    - Order the properties according to DTS coding style

 .../bindings/iio/imu/bosch,smi240.yaml        | 51 +++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/imu/bosch,smi240.yaml

Comments

Conor Dooley Aug. 9, 2024, 2:19 p.m. UTC | #1
On Fri, Aug 09, 2024 at 01:16:34PM +0200, Jianping.Shen@de.bosch.com wrote:
> From: "Shen Jianping (ME-SE/EAD2)" <Jianping.Shen@de.bosch.com>
> 
> dt-bindings: iio: imu: smi240: dt-binding improvements

The commit message here doesn't make much sese, you're adding a new
file. Something like the description in the binding below would be a
better fit than what you have.

> Signed-off-by: Shen Jianping (ME-SE/EAD2) <Jianping.Shen@de.bosch.com>
                               ^^^^^^^^^^^^
If this is not part of your name, or a client of Bosch that you want to
attribute authorship to, remove it.

> ---
> 
> Notes:
>     v1 -> v2
>     - Add more detail in description
>     - Add maintainer
>     - Add vdd and vddio power supply
>     - Use generic node name
>     - Order the properties according to DTS coding style
> 
>  .../bindings/iio/imu/bosch,smi240.yaml        | 51 +++++++++++++++++++
>  1 file changed, 51 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/imu/bosch,smi240.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/imu/bosch,smi240.yaml b/Documentation/devicetree/bindings/iio/imu/bosch,smi240.yaml
> new file mode 100644
> index 00000000000..0529e67de26
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/imu/bosch,smi240.yaml
> @@ -0,0 +1,51 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/imu/bosch,smi240.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Bosch smi240 imu
> +
> +maintainers:
> +  - Jianping Shen <Jianping.Shen@de.bosch.com>
> +
> +description:
> +  The smi240 is a combined three axis angular rate and three 
> +  axis acceleration sensor module with a measurement range of 
> +  +/-300°/s and up to 16g.

> smi240 does not support interrupt.

You can, drop this, don't think it's worth mentioning in the
description.

> +  https://www.bosch-semiconductors.com/mems-sensors/highly-automated-driving/smi240/
> +
> +properties:
> +  compatible:
> +    const: bosch,smi240
> +
> +  reg:
> +    maxItems: 1
> +
> +  vdd-supply:
> +    description: provide VDD power to the sensor.
> +
> +  vddio-supply:
> +    description: provide VDD IO power to the sensor.

I think the descriptions for these are not really worth having and can
be replaced with "vddio-supply: true" etc.

> +
> +required:
> +  - compatible
> +  - reg

However, the supplies likely are required to function and should be
added to the required section.

> +
> +allOf:
> +  - $ref: /schemas/spi/spi-peripheral-props.yaml#
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    spi {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        imu@0 {
> +            compatible = "bosch,smi240";            

You have trailing whitespace after this line.

Cheers,
Conor.

> +            reg = <0>;
> +            spi-max-frequency = <10000000>;
> +        };
> +    };
> -- 
> 2.34.1
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/imu/bosch,smi240.yaml b/Documentation/devicetree/bindings/iio/imu/bosch,smi240.yaml
new file mode 100644
index 00000000000..0529e67de26
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/imu/bosch,smi240.yaml
@@ -0,0 +1,51 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/imu/bosch,smi240.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Bosch smi240 imu
+
+maintainers:
+  - Jianping Shen <Jianping.Shen@de.bosch.com>
+
+description:
+  The smi240 is a combined three axis angular rate and three 
+  axis acceleration sensor module with a measurement range of 
+  +/-300°/s and up to 16g. smi240 does not support interrupt.
+  https://www.bosch-semiconductors.com/mems-sensors/highly-automated-driving/smi240/
+
+properties:
+  compatible:
+    const: bosch,smi240
+
+  reg:
+    maxItems: 1
+
+  vdd-supply:
+    description: provide VDD power to the sensor.
+
+  vddio-supply:
+    description: provide VDD IO power to the sensor.
+
+required:
+  - compatible
+  - reg
+
+allOf:
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        imu@0 {
+            compatible = "bosch,smi240";            
+            reg = <0>;
+            spi-max-frequency = <10000000>;
+        };
+    };