Re: [PATCH 1/2] dt-bindings: iio: accel: Add binding documentation for ADXL313
From: Jonathan Cameron <jic23@kernel.org>
Date: 2021-08-01 18:01:49
Also in:
linux-iio, lkml
On Sat, 31 Jul 2021 17:36:31 -0300 Lucas Stankus [off-list ref] wrote:
Add device tree binding documentation for ADXL313 3-axis accelerometer. Signed-off-by: Lucas Stankus <lucas.p.stankus@gmail.com>
Hi Lucas, A few minor requests for additions inline, so we include everything that is likely to be used by the driver in the longer term.
quoted hunk ↗ jump to hunk
--- .../bindings/iio/accel/adi,adxl313.yaml | 75 +++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/accel/adi,adxl313.yamldiff --git a/Documentation/devicetree/bindings/iio/accel/adi,adxl313.yaml b/Documentation/devicetree/bindings/iio/accel/adi,adxl313.yaml new file mode 100644 index 000000000000..31f11d7eaaae --- /dev/null +++ b/Documentation/devicetree/bindings/iio/accel/adi,adxl313.yaml@@ -0,0 +1,75 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/accel/adi,adxl313.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Analog Devices ADXL313 3-Axis Digital Accelerometer + +maintainers: + - Lucas Stankus <lucas.p.stankus@gmail.com> + +description: | + Analog Devices ADXL313 3-Axis Digital Accelerometer that supports + both I2C & SPI interfaces. + https://www.analog.com/en/products/adxl313.html + +properties: + compatible: + enum: + - adi,adxl313 + + reg: + maxItems: 1 + + spi-3wire: true + + spi-cpha: true + + spi-cpol: true + + spi-max-frequency: true + + interrupts: + maxItems: 2
As board designers have an annoying habit of wiring up the second interrupt only, please also provide interrupt-names so we can know which one is connected if it's only one. From a quick glance at the datasheet, I see this also has two powersupplies. Please include vddio-supply vs-supply - annoyingly the s just stands for supply, but v-supply seems a bit to minimal.
+
+required:
+ - compatible
+ - reg
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ #include <dt-bindings/interrupt-controller/irq.h>
+ i2c0 {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ /* Example for a I2C device node */
+ accelerometer@53 {
+ compatible = "adi,adxl313";
+ reg = <0x53>;
+ interrupt-parent = <&gpio0>;
+ interrupts = <0 IRQ_TYPE_LEVEL_HIGH>;
+ };
+ };
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+ #include <dt-bindings/interrupt-controller/irq.h>
+ spi {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ /* Example for a SPI device node */
+ accelerometer@0 {
+ compatible = "adi,adxl313";
+ reg = <0>;
+ spi-max-frequency = <5000000>;
+ spi-cpol;
+ spi-cpha;
+ interrupt-parent = <&gpio0>;
+ interrupts = <0 IRQ_TYPE_LEVEL_HIGH>;
+ };
+ };