Re: [PATCH 5/5] dt-bindings: iio: Add adis16475 documentation

Jonathan Cameron
2020-03-03T21:11:01Z

On Tue, 25 Feb 2020 13:41:52 +0100
Nuno Sá <nuno.sa@analog.com> wrote:

> Document the ADIS16475 device devicetree bindings.
>
> Signed-off-by: Nuno Sá <nuno.sa@analog.com>

One thing inline on the burst mode stuff.

Thanks,

Jonathan

> ---
> .../bindings/iio/imu/adi,adis16475.yaml | 130 ++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 131 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml b/Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
> new file mode 100644
> index 000000000000..c0f2146e000c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
> @@ -0,0 +1,130 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/imu/adi,adis16475.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices ADIS16475 and similar IMUs
> +
> +maintainers:
> + - Nuno Sá <nuno.sa@analog.com>
> +
> +description: |
> + Analog Devices ADIS16475 and similar IMUs
> + https://www.analog.com/media/en/technical-documentation/data-sheets/ADIS16475.pdf
> +
> +properties:
> + compatible:
> + enum:
> + - adi,adis16475-1
> + - adi,adis16475-2
> + - adi,adis16475-3
> + - adi,adis16477-1
> + - adi,adis16477-2
> + - adi,adis16477-3
> + - adi,adis16470
> + - adi,adis16465-1
> + - adi,adis16465-2
> + - adi,adis16465-3
> + - adi,adis16467-1
> + - adi,adis16467-2
> + - adi,adis16467-3
> + - adi,adis16500
> + - adi,adis16505-1
> + - adi,adis16505-2
> + - adi,adis16505-3
> + - adi,adis16507-1
> + - adi,adis16507-2
> + - adi,adis16507-3
> +
> + reg:
> + maxItems: 1
> +
> + spi-cpha: true
> +
> + spi-cpol: true
> +
> + spi-max-frequency:
> + maximum: 2000000
> +
> + interrupts:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
> +
> + clock-names:
> + oneOf:
> + - const: sync
> + - const: direct-sync
> + - const: pulse-sync
> + - const: scaled-sync
> +
> + 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
> +
> + adi,scaled-output-hz:
> + description:
> + This property must be present if the clock mode is scaled-sync through
> + clock-names property. In this mode, the input clock can have a range
> + of 1Hz to 128HZ which must be scaled to originate an allowable sample
> + rate. This property specifies that rate.
> + minimum: 1900
> + maximum: 2100
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - spi-cpha
> + - spi-cpol
> +
> +if:
> + properties:
> + compatible:
> + contains:
> + enum:
> + - adi,adis16500
> + - adi,adis16505-1
> + - adi,adis16505-2
> + - adi,adis16505-3
> + - adi,adis16507-1
> + - adi,adis16507-2
> + - adi,adis16507-3
> +
> +then:
> + properties:
> + clock-names:
> + oneOf:
> + - const: sync
> + - const: direct-sync
> + - const: scaled-sync
> +
> + adi,burst32-enable:
> + description:
> + Enable burst32 mode. In this mode, a burst reading contains calibrated
> + gyroscope and accelerometer data in 32-bit format.

Why is this in DT? Is it not a runtime decision
(ideally automatically selected)

> + type: boolean
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> + spi {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + adis16475: adis16475-3@0 {
> + compatible = "adi,adis16475-3";
> + reg = <0>;
> + spi-cpha;
> + spi-cpol;
> + spi-max-frequency = <2000000>;
> + interrupts = <4 IRQ_TYPE_EDGE_RISING>;
> + interrupt-parent = <&gpio>;
> + };
> + };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index f11262f1f3bb..f8ccc92ab378 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1015,6 +1015,7 @@ W: http://ez.analog.com/community/linux-device-drivers
> S: Supported
> F: drivers/iio/imu/adis16475.c
> F: Documentation/ABI/testing/sysfs-bus-iio-imu-adis16475
> +F: Documentation/devicetree/bindings/iio/imu/adi,adis16475.yaml
>
> ANALOG DEVICES INC ADM1177 DRIVER
> M: Beniamin Bia <beniamin.bia@analog.com>