Skip to contentSkip to conversation

dt-bindings: iio: adc: add AD7816/AD7817/AD7818 binding

PATCH Superseded Hungyu Lin 2 participants 3 messages May 8 – May 9

Subsystems (3)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Hungyu Lin

author
#0 lore raw

v2 cover dt-bindings: iio: adc: add AD7816/AD7817/AD7818 binding

v2:
- Fix commit message to match binding requirements

Hungyu Lin (1):
dt-bindings: iio: adc: add AD7816/AD7817/AD7818 binding

 .../bindings/iio/adc/adi,ad7816.yaml          | 94 +++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7816.yaml
Signature · 1 line
2.34.1
author
#1 lore raw

PATCH v2 1/1 dt-bindings: iio: adc: add AD7816/AD7817/AD7818 binding

Add Device Tree binding documentation for the Analog Devices AD7816, AD7817 and AD7818 SPI ADC devices.

The AD7816 provides temperature monitoring only, while the AD7817 and AD7818 provide analog input channels with an on-chip temperature sensor.

The devices use control GPIOs for RD/WR and CONVST. BUSY is required for AD7816 and AD7817 variants.

---
 .../bindings/iio/adc/adi,ad7816.yaml          | 94 +++++++++++++++++++
 1 file changed, 94 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7816.yaml
Documentation/devicetree/bindings/iio/adc/adi,ad7816.yaml new file +94 -0
new file mode 100644
index 000000000000..490e5338d7b2
@@ -0,0 +1,94 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/adi,ad7816.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices AD7816/AD7817/AD7818 ADC
+
+maintainers:
+  - Hungyu Lin <[email protected]>
+
+description: |
+  Binding for Analog Devices AD7816, AD7817 and AD7818 SPI ADCs
+  with on-chip temperature sensor.
+
+  The AD7816 provides temperature monitoring only.
+  The AD7817 provides up to 4 analog input channels.
+  The AD7818 provides a single analog input channel.
+
+properties:
+  compatible:
+    enum:
+      - adi,ad7816
+      - adi,ad7817
+      - adi,ad7818
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+    description:
+      Optional interrupt line used by the device.
+
+  rdwr-gpios:
+    maxItems: 1
+    description:
+      GPIO connected to the RD/WR pin used to control read/write cycles.
+
+  convert-gpios:
+    maxItems: 1
+    description:
+      GPIO connected to the CONVST pin used to trigger conversions.
+
+  busy-gpios:
+    maxItems: 1
+    description:
+      GPIO connected to the BUSY pin indicating conversion status.
+
+required:
+  - compatible
+  - reg
+  - rdwr-gpios
+  - convert-gpios
+
+allOf:
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - adi,ad7816
+              - adi,ad7817
+    then:
+      required:
+        - busy-gpios
+    else:
+      properties:
+        busy-gpios: false
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    gpio0: gpio {
+      gpio-controller;
+      #gpio-cells = <2>;
+    };
+
+    spi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      adc@0 {
+        compatible = "adi,ad7816";
+        reg = <0>;
+        spi-max-frequency = <5000000>;
+        rdwr-gpios = <&gpio0 1 0>;
+        convert-gpios = <&gpio0 2 0>;
+        busy-gpios = <&gpio0 3 0>;
+      };
+    };
Signature · 1 line
2.34.1
#2 lore raw
In reply to Hungyu Lin
Quoted 3 lines · Hungyu Lin

v2:
- Fix commit message to match binding requirements

Hi,

Thank you for the change.

Ideally, multiple logical changes should be split into series. For a single patch you can include changelog like this:

Signed-off-by ....

---
Changes in v2:
- Fix commit message to match binding requirements
---
.../bindings..

         | 94 +++++++++++++++++++

If reviewer specifically asked to update commit message, you can mention in the changelog as well. for examle:

- Fix commit message based on input from <Reviewer Name>

Replace <Reviewer Name> with the actual reviewer.

Quoted 7 lines

Hungyu Lin (1):
dt-bindings: iio: adc: add AD7816/AD7817/AD7818 binding

.../bindings/iio/adc/adi,ad7816.yaml | 94 +++++++++++++++++++

1 file changed, 94 insertions(+)

create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7816.yaml