On Thu, 2019-09-12 at 18:39 -0300, Rodrigo Carvalho wrote:
> This patch add device tree binding documentation for ADIS16240.
>
> Signed-off-by: Rodrigo Ribeiro Carvalho <rodrigor...@gmail.com>
> ---
> 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
>
> diff --git a/Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml
> b/Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml
> new file mode 100644
> index 000000000000..4b1bd2419604
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/accel/adi,adis16240.yaml
> @@ -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 <alexandru.ardel...@analog.com>
> +
> +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
Description for standard properties is not required.
For spi-cpha/cpol just "true" seems sufficient.
So
spi-cpha: true
spi-cpol: true
> +
> + spi-cpol: |
> + description: |
> + See Documentation/devicetree/bindings/spi/spi-controller.yaml
> + 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.
> +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>;
> + };
> + };
