[v7,4/6] dt-bindings: iio: Add adis16550 bindings

Commit Message

Robert Budai Feb. 11, 2025, 5:57 p.m. UTC

Document the ADIS16550 device devicetree bindings.

Co-developed-by: Antoniu Miclaus <[e-mail]>
Signed-off-by: Antoniu Miclaus <[e-mail]>
Signed-off-by: Ramona Gradinariu <[e-mail]>
Signed-off-by: Robert Budai <[e-mail]>
---

v7:
- dropped clock-frequency binding as suggested

 .../bindings/iio/imu/adi,adis16550.yaml       | 73 +++++++++++++++++++
 MAINTAINERS                                   | 10 +++
 2 files changed, 83 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16550.yaml

Comments

Krzysztof Kozlowski Feb. 12, 2025, 7 a.m. UTC | #1

On Tue, Feb 11, 2025 at 07:57:01PM +0200, Robert Budai wrote:
> +  spi-max-frequency:
> +    maximum: 15000000
> +
> +  vdd-supply: true
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  reset-gpios:
> +    description:
> +      Must be the device tree identifier of the RESET pin. If specified,

Few nits here because you did not implement previous feedback:

s/Must be the device tree identifier of//
It cannot be anything else, right? So:

Active low RESET pin.

Second sentence is implementation detail, what if my krzkOS does not do
it in probe? Is binding incorrect in such case? No, so drop.

> +      it will be asserted during driver probe. As the line is active low,
> +      it should be marked GPIO_ACTIVE_LOW.

Line should be marked depending on the board layout. If there is
inverter, it won't be GPIO_ACTIVE_LOW. Just say this is active low.

> +    maxItems: 1
> +
> +  clocks:
> +    description: If not provided, then the internal clock is used.
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - spi-cpha
> +  - spi-cpol
> +  - spi-max-frequency
> +  - vdd-supply
> +
> +allOf:
> +  - $ref: /schemas/spi/spi-peripheral-props.yaml#

And now we get back to previous feedback which was not implemented.
Please share the filename which follows such style/syntax without blank
lines, so I can fix it and people will not take it as an example.

> +additionalProperties: false

Here as well.

> +examples:

Best regards,
Krzysztof

Patch

diff --git a/Documentation/devicetree/bindings/iio/imu/adi,adis16550.yaml b/Documentation/devicetree/bindings/iio/imu/adi,adis16550.yaml
new file mode 100644
index 000000000..b55cd0f7e
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/imu/adi,adis16550.yaml
@@ -0,0 +1,73 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/imu/adi,adis16550.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices ADIS16550 and similar IMUs
+
+maintainers:
+  - Nuno Sa <[e-mail]>
+  - Ramona Gradinariu <[e-mail]>
+  - Antoniu Miclaus <[e-mail]>
+  - Robert Budai <[e-mail]>
+
+properties:
+  compatible:
+    enum:
+      - adi,adis16550
+
+  reg:
+    maxItems: 1
+
+  spi-cpha: true
+  spi-cpol: true
+
+  spi-max-frequency:
+    maximum: 15000000
+
+  vdd-supply: true
+
+  interrupts:
+    maxItems: 1
+
+  reset-gpios:
+    description:
+      Must be the device tree identifier of the RESET pin. If specified,
+      it will be asserted during driver probe. As the line is active low,
+      it should be marked GPIO_ACTIVE_LOW.
+    maxItems: 1
+
+  clocks:
+    description: If not provided, then the internal clock is used.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - spi-cpha
+  - spi-cpol
+  - spi-max-frequency
+  - vdd-supply
+
+allOf:
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+additionalProperties: false
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        imu@0 {
+            compatible = "adi,adis16550";
+            reg = <0>;
+            spi-max-frequency = <15000000>;
+            spi-cpol;
+            spi-cpha;
+            vdd-supply = <&vdd>;
+            interrupts = <4 IRQ_TYPE_EDGE_FALLING>;
+            interrupt-parent = <&gpio>;
+        };
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index 25c86f473..d3e6258fa 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1485,6 +1485,16 @@  W:	https://ez.analog.com/linux-software-drivers
 F:	Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
 F:	drivers/iio/imu/adis16475.c
 
+ANALOG DEVICES INC ADIS16550 DRIVER
+M:	Nuno Sa <[e-mail]>
+M:	Ramona Gradinariu <[e-mail]>
+M:	Antoniu Miclaus <[e-mail]>
+M:	Robert Budai <[e-mail]>
+L:	[e-mail]
+S:	Supported
+W:	https://ez.analog.com/linux-software-drivers
+F:	Documentation/devicetree/bindings/iio/imu/adi,adis16550.yaml
+
 ANALOG DEVICES INC ADM1177 DRIVER
 M:	Michael Hennerich <[e-mail]>
 L:	[e-mail]