Re: [PATCH v2 2/5] dt-bindings: iio: magnetometer: qst: Add QMC5883L device tree binding

[Jonathan Cameron <jic23@kernel.org>]

On Thu,  8 May 2025 13:08:46 +0100
Brajesh Patil <brajeshpatil11@gmail.com> wrote:

Needs description. Give us a clue what the device is in a
few lines.

> Signed-off-by: Brajesh Patil <brajeshpatil11@gmail.com>
> ---
>  .../iio/magnetometer/qst,qmc5883l.yaml        | 52 +++++++++++++++++++
>  1 file changed, 52 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/magnetometer/qst,qmc5883l.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/magnetometer/qst,qmc5883l.yaml b/Documentation/devicetree/bindings/iio/magnetometer/qst,qmc5883l.yaml
> new file mode 100644
> index 000000000000..a2e6982a177d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/magnetometer/qst,qmc5883l.yaml
> @@ -0,0 +1,52 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/magnetometer/qst,qmc5883l.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: QST QMC5883L 3-Axis Magnetometer
> +
> +maintainers:
> +  - Brajesh Patil <brajeshpatil11@gmail.com>
> +
> +description: |

No need for | as paragraph that follows doesn't need any specific formatting.

> +  The QMC5883L is a 3-axis magnetic sensor with I2C interface. It provides
> +  measurements of magnetic field strength along X, Y and Z axes, as well as
> +  temperature readings.

There are two supplies that should be listed here and in the required list
(note that doesn't mean we can't reply on the regulator framework supplying
 stub regulators if the power is always on - it just documents that the
 device requires power to work!)

There is also a drdy pin so I'd expect an optional interrupt.

Note that bindings should be as complete as possible, even if the driver
doesn't make use of a particular feature yet.

> +
> +properties:
> +  compatible:
> +    const: qst,qmc5883l
> +
> +  reg:
> +    maxItems: 1
> +    description: I2C slave address (0x0d)
> +
> +  mount-matrix:
> +    description: |
As above.

> +      A 3x3 rotation matrix describing how the magnetometer is mounted
> +      on the device. This is used to orient the sensor measurements
> +      to match the device's coordinate system.
> +
> +additionalProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        magnetometer@0d {
> +            compatible = "qst,qmc5883l";
> +            reg = <0x0d>;
> +            mount-matrix = "1", "0", "0",
> +                           "0", "1", "0",
> +                           "0", "0", "1";
> +        };
> +    };
> +...
> +
> --
> 2.39.5
>