Re: [PATCH 1/2] dt-bindings: staging: iio: imu: Document CEVA BNO08x

Rob Herring
2022-06-27T22:25:25Z

On Thu, Jun 16, 2022 at 12:00:05PM +0200, Jacopo Mondi wrote:
> From: Jacopo Mondi <jacopo@jmondi.org>
>
> Document CEVA BNO08x (080, 085 and 086) Sensor Hub.
>
> The BNO08X family (BNO080/85/86) is a System in Package (SiP) that
> integrates a triaxial accelerometer, triaxial gyroscope, magnetometer
> and a 32-bit ARM Cortex-M0+ microcontroller running CEVA's SH-2
> firmware.
>
> Datasheet:
> https://www.ceva-dsp.com/wp-content/uploads/2019/10/BNO080_085-Datasheet.pdf
>
> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
> ---
> .../bindings/staging/iio/imu/ceva,bno08x.yaml | 63 +++++++++++++++++++

You expect this binding to change? If so, then why define the ABI. If
not, then why is it in staging? IOW, I don't really want additions to
bindings/staging/.

If this isn't in a .dts file and the driver isn't stable yet, then just
don't document it until it is.

> 1 file changed, 63 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/staging/iio/imu/ceva,bno08x.yaml
>
> diff --git a/Documentation/devicetree/bindings/staging/iio/imu/ceva,bno08x.yaml b/Documentation/devicetree/bindings/staging/iio/imu/ceva,bno08x.yaml
> new file mode 100644
> index 000000000000..f7d6ea6d9147
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/staging/iio/imu/ceva,bno08x.yaml
> @@ -0,0 +1,63 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/staging/iio/imu/ceva,bno08x.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: CEVA BNO080/85/86
> +
> +maintainers:
> + - Jacopo Mondi <jacopo@jmondi.org>
> +
> +description: |
> + CEVA BNO08x is a System in Package (SiP) that integrates a triaxial
> + accelerometer, triaxial gyroscope, magnetometer and a 32-bit ARM Cortex-M0+
> + microcontroller running CEVA's SH-2 firmware.
> +
> + The BNO08x family is documented at
> + https://www.ceva-dsp.com/product/bno080-085/
> + https://www.ceva-dsp.com/wp-content/uploads/2019/10/BNO080_085-Datasheet.pdf
> +
> + The SH-2 firmware reference is available at
> + https://cdn.sparkfun.com/assets/4/d/9/3/8/SH-2-Reference-Manual-v1.2.pdf
> + https://cdn.sparkfun.com/assets/7/6/9/3/c/Sensor-Hub-Transport-Protocol-v1.7.pdf
> +
> +properties:
> + compatible:
> + const: ceva,bno08x

Don't use wildcards in compatibles.

> +
> + reg:
> + maxItems: 1
> +
> + reset-gpios:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> + description:
> + Phandle to the GPIO connected to the chip H_INTN (Host Interrupt) pin.
> + The interrupt type shall be IRQ_TYPE_EDGE_FALLING.
> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> +
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + bno080: imu@4b {
> + compatible = "ceva,bno08x";
> + interrupt-parent = <&gpio5>;
> + interrupts = <8 IRQ_TYPE_EDGE_FALLING>;
> + reg = <0x4b>;
> + };
> + };
> +
> --
> 2.35.1
>
>