Skip to contentSkip to conversation

dt-bindings: iio: accel: add binding documentation for ADIS16240

PATCH Superseded Rodrigo Carvalho 3 participants 3 messages Sep 12, 2019 – Sep 22, 2019

Subsystems (3)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 dt-bindings: iio: accel: add binding documentation for ADIS16240

This patch add device tree binding documentation for ADIS16240.

---
V2:
- Remove true constant for spi-cpha and spi-cpol
- Add description field for spi-cpha and spi-cpol
- Add maxItems field for spi-cpha and spi-cpol

 .../bindings/iio/accel/adi,adis16240.yaml     | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +61 -0
new file mode 100644
index 000000000000..4b1bd2419604
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/accel/adi,adis16240.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ADIS16240 Programmable Impact Sensor and Recorder driver
+
+maintainers:
+  - Alexandru Ardelean <[email protected]>
+
+description: |
+  ADIS16240 Programmable Impact Sensor and Recorder driver that supports
+  SPI interface.
+    https://www.analog.com/en/products/adis16240.html
+
+properties:
+  compatible:
+    enum:
+      - adi,adis16240
+
+  reg:
+    maxItems: 1
+
+  spi-cpha:
+    description: |
+      See Documentation/devicetree/bindings/spi/spi-controller.yaml
+    maxItems: 1
+
+  spi-cpol: |
+    description: |
+      See Documentation/devicetree/bindings/spi/spi-controller.yaml
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    spi0 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        /* Example for a SPI device node */
+        accelerometer@0 {
+            compatible = "adi,adis16240";
+            reg = <0>;
+            spi-max-frequency = <2500000>;
+            spi-cpol;
+            spi-cpha;
+            interrupt-parent = <&gpio0>;
+            interrupts = <0 IRQ_TYPE_LEVEL_HIGH>;
+        };
+    };
Signature · 1 line
2.23.0.rc1
#1 lore raw
Quoted 38 lines · Rodrigo Carvalho

This patch add device tree binding documentation for ADIS16240.

---
V2:
- Remove true constant for spi-cpha and spi-cpol
- Add description field for spi-cpha and spi-cpol
- Add maxItems field for spi-cpha and spi-cpol

 .../bindings/iio/accel/adi,adis16240.yaml     | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +18 -0
new file mode 100644
index 000000000000..4b1bd2419604
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/accel/adi,adis16240.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ADIS16240 Programmable Impact Sensor and Recorder driver
+
+maintainers:
+  - Alexandru Ardelean <[email protected]>
+
+description: |
+  ADIS16240 Programmable Impact Sensor and Recorder driver that supports
+  SPI interface.
+    https://www.analog.com/en/products/adis16240.html
+
+properties:
+  compatible:

Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml line 28

Quoted 10 lines
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +10 -0
+    enum:
+      - adi,adis16240
+
+  reg:
+    maxItems: 1
+
+  spi-cpha:
+    description: |
+      See Documentation/devicetree/bindings/spi/spi-controller.yaml
+    maxItems: 1

Description for standard properties is not required.

For spi-cpha/cpol just "true" seems sufficient.

So

spi-cpha: true

spi-cpol: true

Quoted 4 lines
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +4 -0
+
+  spi-cpol: |
+    description: |
+      See Documentation/devicetree/bindings/spi/spi-controller.yaml

Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml line 42

Quoted 10 lines
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +10 -0
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+

If spi-cpha & spi-cpol are true, they should typically be also required. Though, I think Rob would answer things better here.

Quoted 19 lines
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +19 -0
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    spi0 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        /* Example for a SPI device node */
+        accelerometer@0 {
+            compatible = "adi,adis16240";
+            reg = <0>;
+            spi-max-frequency = <2500000>;
+            spi-cpol;
+            spi-cpha;
+            interrupt-parent = <&gpio0>;
+            interrupts = <0 IRQ_TYPE_LEVEL_HIGH>;
+        };
+    };
#2 lore raw

Hi,

Could anyone with some experience in devicetree give us a hint on what to do here?

I have built a binding doc using the same spi-cpha property.
https://github.com/analogdevicesinc/linux/commit/bb2945e489dfdf2faa0255dd2cf09ae4ee77d826

Quoted 52 lines · Alexandru
Quoted 38 lines · Rodrigo Carvalho

This patch add device tree binding documentation for ADIS16240.

---
V2:
- Remove true constant for spi-cpha and spi-cpol
- Add description field for spi-cpha and spi-cpol
- Add maxItems field for spi-cpha and spi-cpol

 .../bindings/iio/accel/adi,adis16240.yaml     | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +18 -0
new file mode 100644
index 000000000000..4b1bd2419604
@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/accel/adi,adis16240.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ADIS16240 Programmable Impact Sensor and Recorder driver
+
+maintainers:
+  - Alexandru Ardelean <[email protected]>
+
+description: |
+  ADIS16240 Programmable Impact Sensor and Recorder driver that supports
+  SPI interface.
+    https://www.analog.com/en/products/adis16240.html
+
+properties:
+  compatible:

Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml line 28

Quoted 10 lines
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +10 -0
+    enum:
+      - adi,adis16240
+
+  reg:
+    maxItems: 1
+
+  spi-cpha:
+    description: |
+      See Documentation/devicetree/bindings/spi/spi-controller.yaml
+    maxItems: 1

Description for standard properties is not required.

Quoted 8 lines

For spi-cpha/cpol just "true" seems sufficient.

So

spi-cpha: true

spi-cpol: true

I'm not Rob, but I think it is not necessary to explicitly say the property is true. In this case, it should be enough if it is present. If needed to know whether some property is "true" or not, one can use the of_property_read_bool function. For the AD7292 driver on it was enough to just add the property names. The spi-chpa did not need any further care. Without the spi-cpha property, the AD7292 vendor ID came as 0x0C (one bit shifted to the right).

Rodrigo is participating at FLUSP students group. It would be good if we could test whether these properties are really needed. However, I don't think we have the ADIS16240 part. Would anyone test it?

Quoted 9 lines
Quoted 9 lines
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +9 -0
+
+  spi-cpol: |
+    description: |
+      See Documentation/devicetree/bindings/spi/spi-controller.yaml
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
Quoted 9 lines

Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml line 42

Quoted 5 lines
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +5 -0
+required:
+  - compatible
+  - reg
+  - interrupts
+

If spi-cpha & spi-cpol are true, they should typically be also required. Though, I think Rob would answer things better here.

Some feedback about the need (or not) to link to the spi-controller doc would also be appreciated.

Quoted 11 lines
Quoted 11 lines
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +11 -0
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    spi0 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        /* Example for a SPI device node */
+        accelerometer@0 {
+            compatible = "adi,adis16240";
Quoted 8 lines

Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml line 61

Quoted 8 lines
Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml new file +8 -0
+            reg = <0>;
+            spi-max-frequency = <2500000>;
+            spi-cpol;
+            spi-cpha;
+            interrupt-parent = <&gpio0>;
+            interrupts = <0 IRQ_TYPE_LEVEL_HIGH>;
+        };
+    };

Thanks,

Marcelo