diff mbox series

[v2,1/4] dt-bindings: iio: imu: bmi160: convert txt format to yaml

Message ID 20200519075111.6356-2-jonathan.albrieux@gmail.com (mailing list archive)
State New, archived
Headers show
Series iio: imu: bmi160: added regulator and mount-matrix support | expand

Commit Message

Jonathan Albrieux May 19, 2020, 7:50 a.m. UTC
Converts documentation from txt format to yaml 

Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com>
---
 .../devicetree/bindings/iio/imu/bmi160.txt    | 37 --------
 .../devicetree/bindings/iio/imu/bmi160.yaml   | 84 +++++++++++++++++++
 2 files changed, 84 insertions(+), 37 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.txt
 create mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.yaml

Comments

Rob Herring May 19, 2020, 5:37 p.m. UTC | #1
On Tue, 19 May 2020 09:50:57 +0200, Jonathan Albrieux wrote:
> Converts documentation from txt format to yaml
> 
> Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com>
> ---
>  .../devicetree/bindings/iio/imu/bmi160.txt    | 37 --------
>  .../devicetree/bindings/iio/imu/bmi160.yaml   | 84 +++++++++++++++++++
>  2 files changed, 84 insertions(+), 37 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.txt
>  create mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> 


My bot found errors running 'make dt_binding_check' on your patch:

Error: Documentation/devicetree/bindings/iio/imu/bmi160.example.dts:37.1-2 syntax error
FATAL ERROR: Unable to parse input tree
scripts/Makefile.lib:312: recipe for target 'Documentation/devicetree/bindings/iio/imu/bmi160.example.dt.yaml' failed
make[1]: *** [Documentation/devicetree/bindings/iio/imu/bmi160.example.dt.yaml] Error 1
Makefile:1300: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2

See https://patchwork.ozlabs.org/patch/1293085

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure dt-schema is up to date:

pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Please check and re-submit.
Jonathan Cameron May 19, 2020, 5:49 p.m. UTC | #2
On Tue, 19 May 2020 09:50:57 +0200
Jonathan Albrieux <jonathan.albrieux@gmail.com> wrote:

> Converts documentation from txt format to yaml 
> 
> Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com>
> ---
>  .../devicetree/bindings/iio/imu/bmi160.txt    | 37 --------
>  .../devicetree/bindings/iio/imu/bmi160.yaml   | 84 +++++++++++++++++++
>  2 files changed, 84 insertions(+), 37 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.txt
>  create mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.txt b/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> deleted file mode 100644
> index 900c169de00f..000000000000
> --- a/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> +++ /dev/null
> @@ -1,37 +0,0 @@
> -Bosch BMI160 - Inertial Measurement Unit with Accelerometer, Gyroscope
> -and externally connectable Magnetometer
> -
> -https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> -
> -Required properties:
> - - compatible : should be "bosch,bmi160"
> - - reg : the I2C address or SPI chip select number of the sensor
> - - spi-max-frequency : set maximum clock frequency (only for SPI)
> -
> -Optional properties:
> - - interrupts : interrupt mapping for IRQ
> - - interrupt-names : set to "INT1" if INT1 pin should be used as interrupt
> -   input, set to "INT2" if INT2 pin should be used instead
> - - drive-open-drain : set if the specified interrupt pin should be configured as
> -   open drain. If not set, defaults to push-pull.
> -
> -Examples:
> -
> -bmi160@68 {
> -	compatible = "bosch,bmi160";
> -	reg = <0x68>;
> -
> -	interrupt-parent = <&gpio4>;
> -	interrupts = <12 IRQ_TYPE_EDGE_RISING>;
> -	interrupt-names = "INT1";
> -};
> -
> -bmi160@0 {
> -	compatible = "bosch,bmi160";
> -	reg = <0>;
> -	spi-max-frequency = <10000000>;
> -
> -	interrupt-parent = <&gpio2>;
> -	interrupts = <12 IRQ_TYPE_LEVEL_LOW>;
> -	interrupt-names = "INT2";
> -};
> diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.yaml b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> new file mode 100644
> index 000000000000..6b464ce5ed0b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> @@ -0,0 +1,84 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/imu/bmi160.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Bosch BMI160
> +
> +maintainers:
> +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>

Daniel is still active in the kernel, just not at Intel any more. +CC

> +
> +description: |
> +  Inertial Measurement Unit with Accelerometer, Gyroscope and externally
> +  connectable Magnetometer
> +  https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> +
> +properties:
> +  compatible:
> +    const: bosch,bmi160
> +
> +  reg:
> +    maxItems: 1
> +    description: the I2C address or SPI chip select number of the sensor

As standard for i2c and spi, usually no need to have a description line for
this element.

> +
> +  spi-max-frequency:
> +    maxItems: 1
> +    description: set maximum clock frequency (required only for SPI)

Standard spi binding.  Probably doesn't need to be included here.

> +
> +  interrupts:
> +    maxItems: 1
> +    description: interrupt mapping for IRQ
> +
> +  interrupt-names:
> +    minItems: 1
> +    maxItems: 1
> +    items:
> +      enum:
> +        - INT1
> +        - INT2
> +    description: |
> +      set to "INT1" if INT1 pin should be used as interrupt input, set
> +      to "INT2" if INT2 pin should be used instead
> +
> +  drive-open-drain:
> +    description: |
> +      set if the specified interrupt pin should be configured as
> +      open drain. If not set, defaults to push-pull.

> +
> +required:
> +  - compatible
> +  - reg
> +
> +examples:
> +  - |
> +    // Example for I2C
> +    i2c@78b7000 {
> +        reg = <0x78b6000 0x600>;
> +        #address-cells = <1>;
> +        #size-cells = <0>;

Take a look at some of the other binding examples.  We normally
just focus on the driver so don't supply details for the bus.

e.g. https://elixir.bootlin.com/linux/v5.7-rc6/source/Documentation/devicetree/bindings/iio/adc/maxim,max1363.yaml#L39

> +
> +        bmi160@68 {
> +                compatible = "bosch,bmi160";
> +                reg = <0x68>;
> +                interrupt-parent = <&gpio4>;
> +                interrupts = <12 1>;
> +                interrupt-names = "INT1";
> +        };
> +  - |
> +    // Example for SPI
> +    spi@78b7000 {
> +        reg = <0x78b7000 0x600>,
> +              <0x7884000 0x23000>;
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        bmi160@0 {
> +                compatible = "bosch,bmi160";
> +                reg = <0>;
> +                spi-max-frequency = <10000000>;
> +                interrupt-parent = <&gpio2>;
> +                interrupts = <12 1>;
> +                interrupt-names = "INT2";
> +        };
> +    };
Rob Herring May 19, 2020, 6:20 p.m. UTC | #3
On Tue, May 19, 2020 at 09:50:57AM +0200, Jonathan Albrieux wrote:
> Converts documentation from txt format to yaml 
> 
> Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com>
> ---
>  .../devicetree/bindings/iio/imu/bmi160.txt    | 37 --------
>  .../devicetree/bindings/iio/imu/bmi160.yaml   | 84 +++++++++++++++++++
>  2 files changed, 84 insertions(+), 37 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.txt
>  create mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.yaml

Use compatible string for filename: bosch,bmi160.yaml

> 
> diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.txt b/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> deleted file mode 100644
> index 900c169de00f..000000000000
> --- a/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> +++ /dev/null
> @@ -1,37 +0,0 @@
> -Bosch BMI160 - Inertial Measurement Unit with Accelerometer, Gyroscope
> -and externally connectable Magnetometer
> -
> -https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> -
> -Required properties:
> - - compatible : should be "bosch,bmi160"
> - - reg : the I2C address or SPI chip select number of the sensor
> - - spi-max-frequency : set maximum clock frequency (only for SPI)
> -
> -Optional properties:
> - - interrupts : interrupt mapping for IRQ
> - - interrupt-names : set to "INT1" if INT1 pin should be used as interrupt
> -   input, set to "INT2" if INT2 pin should be used instead
> - - drive-open-drain : set if the specified interrupt pin should be configured as
> -   open drain. If not set, defaults to push-pull.
> -
> -Examples:
> -
> -bmi160@68 {
> -	compatible = "bosch,bmi160";
> -	reg = <0x68>;
> -
> -	interrupt-parent = <&gpio4>;
> -	interrupts = <12 IRQ_TYPE_EDGE_RISING>;
> -	interrupt-names = "INT1";
> -};
> -
> -bmi160@0 {
> -	compatible = "bosch,bmi160";
> -	reg = <0>;
> -	spi-max-frequency = <10000000>;
> -
> -	interrupt-parent = <&gpio2>;
> -	interrupts = <12 IRQ_TYPE_LEVEL_LOW>;
> -	interrupt-names = "INT2";
> -};
> diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.yaml b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> new file mode 100644
> index 000000000000..6b464ce5ed0b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> @@ -0,0 +1,84 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/imu/bmi160.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Bosch BMI160
> +
> +maintainers:
> +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>

Would help to Cc him perhaps.

> +
> +description: |
> +  Inertial Measurement Unit with Accelerometer, Gyroscope and externally
> +  connectable Magnetometer
> +  https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> +
> +properties:
> +  compatible:
> +    const: bosch,bmi160
> +
> +  reg:
> +    maxItems: 1
> +    description: the I2C address or SPI chip select number of the sensor
> +
> +  spi-max-frequency:
> +    maxItems: 1
> +    description: set maximum clock frequency (required only for SPI)
> +
> +  interrupts:
> +    maxItems: 1
> +    description: interrupt mapping for IRQ

No need for description if not adding anything unique for this device.

> +
> +  interrupt-names:
> +    minItems: 1
> +    maxItems: 1
> +    items:
> +      enum:
> +        - INT1
> +        - INT2

Just the enum is enough.

> +    description: |
> +      set to "INT1" if INT1 pin should be used as interrupt input, set
> +      to "INT2" if INT2 pin should be used instead
> +
> +  drive-open-drain:
> +    description: |
> +      set if the specified interrupt pin should be configured as
> +      open drain. If not set, defaults to push-pull.
> +
> +required:
> +  - compatible
> +  - reg
> +
> +examples:
> +  - |
> +    // Example for I2C
> +    i2c@78b7000 {
> +        reg = <0x78b6000 0x600>;
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        bmi160@68 {
> +                compatible = "bosch,bmi160";
> +                reg = <0x68>;
> +                interrupt-parent = <&gpio4>;
> +                interrupts = <12 1>;
> +                interrupt-names = "INT1";
> +        };
> +  - |
> +    // Example for SPI
> +    spi@78b7000 {
> +        reg = <0x78b7000 0x600>,
> +              <0x7884000 0x23000>;
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        bmi160@0 {
> +                compatible = "bosch,bmi160";
> +                reg = <0>;
> +                spi-max-frequency = <10000000>;
> +                interrupt-parent = <&gpio2>;
> +                interrupts = <12 1>;
> +                interrupt-names = "INT2";
> +        };
> +    };
> -- 
> 2.17.1
>
Jonathan Albrieux May 20, 2020, 7:06 a.m. UTC | #4
On Tue, May 19, 2020 at 11:37:38AM -0600, Rob Herring wrote:
> On Tue, 19 May 2020 09:50:57 +0200, Jonathan Albrieux wrote:
> > Converts documentation from txt format to yaml
> > 
> > Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com>
> > ---
> >  .../devicetree/bindings/iio/imu/bmi160.txt    | 37 --------
> >  .../devicetree/bindings/iio/imu/bmi160.yaml   | 84 +++++++++++++++++++
> >  2 files changed, 84 insertions(+), 37 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.txt
> >  create mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > 
> 
> 
> My bot found errors running 'make dt_binding_check' on your patch:
> 
> Error: Documentation/devicetree/bindings/iio/imu/bmi160.example.dts:37.1-2 syntax error
> FATAL ERROR: Unable to parse input tree
> scripts/Makefile.lib:312: recipe for target 'Documentation/devicetree/bindings/iio/imu/bmi160.example.dt.yaml' failed
> make[1]: *** [Documentation/devicetree/bindings/iio/imu/bmi160.example.dt.yaml] Error 1
> Makefile:1300: recipe for target 'dt_binding_check' failed
> make: *** [dt_binding_check] Error 2
> 
> See https://patchwork.ozlabs.org/patch/1293085
> 
> If you already ran 'make dt_binding_check' and didn't see the above
> error(s), then make sure dt-schema is up to date:
> 
> pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade
> 
> Please check and re-submit.
> 

Uhm I don't get that error, will try to update to see if it gives me the same error,
Thank you,

Best regards,
Jonathan Albrieux
Jonathan Albrieux May 20, 2020, 7:24 a.m. UTC | #5
On Tue, May 19, 2020 at 06:49:33PM +0100, Jonathan Cameron wrote:
> On Tue, 19 May 2020 09:50:57 +0200
> Jonathan Albrieux <jonathan.albrieux@gmail.com> wrote:
> 
> > Converts documentation from txt format to yaml 
> > 
> > Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com>
> > ---
> >  .../devicetree/bindings/iio/imu/bmi160.txt    | 37 --------
> >  .../devicetree/bindings/iio/imu/bmi160.yaml   | 84 +++++++++++++++++++
> >  2 files changed, 84 insertions(+), 37 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.txt
> >  create mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.txt b/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > deleted file mode 100644
> > index 900c169de00f..000000000000
> > --- a/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > +++ /dev/null
> > @@ -1,37 +0,0 @@
> > -Bosch BMI160 - Inertial Measurement Unit with Accelerometer, Gyroscope
> > -and externally connectable Magnetometer
> > -
> > -https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> > -
> > -Required properties:
> > - - compatible : should be "bosch,bmi160"
> > - - reg : the I2C address or SPI chip select number of the sensor
> > - - spi-max-frequency : set maximum clock frequency (only for SPI)
> > -
> > -Optional properties:
> > - - interrupts : interrupt mapping for IRQ
> > - - interrupt-names : set to "INT1" if INT1 pin should be used as interrupt
> > -   input, set to "INT2" if INT2 pin should be used instead
> > - - drive-open-drain : set if the specified interrupt pin should be configured as
> > -   open drain. If not set, defaults to push-pull.
> > -
> > -Examples:
> > -
> > -bmi160@68 {
> > -	compatible = "bosch,bmi160";
> > -	reg = <0x68>;
> > -
> > -	interrupt-parent = <&gpio4>;
> > -	interrupts = <12 IRQ_TYPE_EDGE_RISING>;
> > -	interrupt-names = "INT1";
> > -};
> > -
> > -bmi160@0 {
> > -	compatible = "bosch,bmi160";
> > -	reg = <0>;
> > -	spi-max-frequency = <10000000>;
> > -
> > -	interrupt-parent = <&gpio2>;
> > -	interrupts = <12 IRQ_TYPE_LEVEL_LOW>;
> > -	interrupt-names = "INT2";
> > -};
> > diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.yaml b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > new file mode 100644
> > index 000000000000..6b464ce5ed0b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > @@ -0,0 +1,84 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/imu/bmi160.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Bosch BMI160
> > +
> > +maintainers:
> > +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>
> 
> Daniel is still active in the kernel, just not at Intel any more. +CC
> 

Oh ok thank you! Daniel are you still maintaining this driver?

> > +
> > +description: |
> > +  Inertial Measurement Unit with Accelerometer, Gyroscope and externally
> > +  connectable Magnetometer
> > +  https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> > +
> > +properties:
> > +  compatible:
> > +    const: bosch,bmi160
> > +
> > +  reg:
> > +    maxItems: 1
> > +    description: the I2C address or SPI chip select number of the sensor
> 
> As standard for i2c and spi, usually no need to have a description line for
> this element.
> 

Thank you, will remove the description then.

> > +
> > +  spi-max-frequency:
> > +    maxItems: 1
> > +    description: set maximum clock frequency (required only for SPI)
> 
> Standard spi binding.  Probably doesn't need to be included here.
> 

So should I completely remove it from properties?

> > +
> > +  interrupts:
> > +    maxItems: 1
> > +    description: interrupt mapping for IRQ
> > +
> > +  interrupt-names:
> > +    minItems: 1
> > +    maxItems: 1
> > +    items:
> > +      enum:
> > +        - INT1
> > +        - INT2
> > +    description: |
> > +      set to "INT1" if INT1 pin should be used as interrupt input, set
> > +      to "INT2" if INT2 pin should be used instead
> > +
> > +  drive-open-drain:
> > +    description: |
> > +      set if the specified interrupt pin should be configured as
> > +      open drain. If not set, defaults to push-pull.
> 
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +examples:
> > +  - |
> > +    // Example for I2C
> > +    i2c@78b7000 {
> > +        reg = <0x78b6000 0x600>;
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> 
> Take a look at some of the other binding examples.  We normally
> just focus on the driver so don't supply details for the bus.
> 
> e.g. https://elixir.bootlin.com/linux/v5.7-rc6/source/Documentation/devicetree/bindings/iio/adc/maxim,max1363.yaml#L39
> 

Will check :-)

> > +
> > +        bmi160@68 {
> > +                compatible = "bosch,bmi160";
> > +                reg = <0x68>;
> > +                interrupt-parent = <&gpio4>;
> > +                interrupts = <12 1>;
> > +                interrupt-names = "INT1";
> > +        };
> > +  - |
> > +    // Example for SPI
> > +    spi@78b7000 {
> > +        reg = <0x78b7000 0x600>,
> > +              <0x7884000 0x23000>;
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        bmi160@0 {
> > +                compatible = "bosch,bmi160";
> > +                reg = <0>;
> > +                spi-max-frequency = <10000000>;
> > +                interrupt-parent = <&gpio2>;
> > +                interrupts = <12 1>;
> > +                interrupt-names = "INT2";
> > +        };
> > +    };
> 
> 

Thank you,

Best regards,
Jonathan Albrieux
Jonathan Albrieux May 20, 2020, 7:29 a.m. UTC | #6
On Tue, May 19, 2020 at 12:20:28PM -0600, Rob Herring wrote:
> On Tue, May 19, 2020 at 09:50:57AM +0200, Jonathan Albrieux wrote:
> > Converts documentation from txt format to yaml 
> > 
> > Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com>
> > ---
> >  .../devicetree/bindings/iio/imu/bmi160.txt    | 37 --------
> >  .../devicetree/bindings/iio/imu/bmi160.yaml   | 84 +++++++++++++++++++
> >  2 files changed, 84 insertions(+), 37 deletions(-)
> >  delete mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.txt
> >  create mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> 
> Use compatible string for filename: bosch,bmi160.yaml
>

Ok thank you, will change filename.
 
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.txt b/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > deleted file mode 100644
> > index 900c169de00f..000000000000
> > --- a/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > +++ /dev/null
> > @@ -1,37 +0,0 @@
> > -Bosch BMI160 - Inertial Measurement Unit with Accelerometer, Gyroscope
> > -and externally connectable Magnetometer
> > -
> > -https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> > -
> > -Required properties:
> > - - compatible : should be "bosch,bmi160"
> > - - reg : the I2C address or SPI chip select number of the sensor
> > - - spi-max-frequency : set maximum clock frequency (only for SPI)
> > -
> > -Optional properties:
> > - - interrupts : interrupt mapping for IRQ
> > - - interrupt-names : set to "INT1" if INT1 pin should be used as interrupt
> > -   input, set to "INT2" if INT2 pin should be used instead
> > - - drive-open-drain : set if the specified interrupt pin should be configured as
> > -   open drain. If not set, defaults to push-pull.
> > -
> > -Examples:
> > -
> > -bmi160@68 {
> > -	compatible = "bosch,bmi160";
> > -	reg = <0x68>;
> > -
> > -	interrupt-parent = <&gpio4>;
> > -	interrupts = <12 IRQ_TYPE_EDGE_RISING>;
> > -	interrupt-names = "INT1";
> > -};
> > -
> > -bmi160@0 {
> > -	compatible = "bosch,bmi160";
> > -	reg = <0>;
> > -	spi-max-frequency = <10000000>;
> > -
> > -	interrupt-parent = <&gpio2>;
> > -	interrupts = <12 IRQ_TYPE_LEVEL_LOW>;
> > -	interrupt-names = "INT2";
> > -};
> > diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.yaml b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > new file mode 100644
> > index 000000000000..6b464ce5ed0b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > @@ -0,0 +1,84 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/imu/bmi160.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Bosch BMI160
> > +
> > +maintainers:
> > +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>
> 
> Would help to Cc him perhaps.
> 

Thank you, I will add him too on the next version.

> > +
> > +description: |
> > +  Inertial Measurement Unit with Accelerometer, Gyroscope and externally
> > +  connectable Magnetometer
> > +  https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> > +
> > +properties:
> > +  compatible:
> > +    const: bosch,bmi160
> > +
> > +  reg:
> > +    maxItems: 1
> > +    description: the I2C address or SPI chip select number of the sensor
> > +
> > +  spi-max-frequency:
> > +    maxItems: 1
> > +    description: set maximum clock frequency (required only for SPI)
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +    description: interrupt mapping for IRQ
> 
> No need for description if not adding anything unique for this device.
> 

Will remove it then.

> > +
> > +  interrupt-names:
> > +    minItems: 1
> > +    maxItems: 1
> > +    items:
> > +      enum:
> > +        - INT1
> > +        - INT2
> 
> Just the enum is enough.
> 

Ok, will clean this.

> > +    description: |
> > +      set to "INT1" if INT1 pin should be used as interrupt input, set
> > +      to "INT2" if INT2 pin should be used instead
> > +
> > +  drive-open-drain:
> > +    description: |
> > +      set if the specified interrupt pin should be configured as
> > +      open drain. If not set, defaults to push-pull.
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +examples:
> > +  - |
> > +    // Example for I2C
> > +    i2c@78b7000 {
> > +        reg = <0x78b6000 0x600>;
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        bmi160@68 {
> > +                compatible = "bosch,bmi160";
> > +                reg = <0x68>;
> > +                interrupt-parent = <&gpio4>;
> > +                interrupts = <12 1>;
> > +                interrupt-names = "INT1";
> > +        };
> > +  - |
> > +    // Example for SPI
> > +    spi@78b7000 {
> > +        reg = <0x78b7000 0x600>,
> > +              <0x7884000 0x23000>;
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        bmi160@0 {
> > +                compatible = "bosch,bmi160";
> > +                reg = <0>;
> > +                spi-max-frequency = <10000000>;
> > +                interrupt-parent = <&gpio2>;
> > +                interrupts = <12 1>;
> > +                interrupt-names = "INT2";
> > +        };
> > +    };
> > -- 
> > 2.17.1
> > 

Thank you for your help,

Best regards,
Jonathan Albrieux
Jonathan Cameron May 21, 2020, 6:27 p.m. UTC | #7
On Wed, 20 May 2020 09:24:23 +0200
Jonathan Albrieux <jonathan.albrieux@gmail.com> wrote:

> On Tue, May 19, 2020 at 06:49:33PM +0100, Jonathan Cameron wrote:
> > On Tue, 19 May 2020 09:50:57 +0200
> > Jonathan Albrieux <jonathan.albrieux@gmail.com> wrote:
> >   
> > > Converts documentation from txt format to yaml 
> > > 
> > > Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com>
> > > ---
> > >  .../devicetree/bindings/iio/imu/bmi160.txt    | 37 --------
> > >  .../devicetree/bindings/iio/imu/bmi160.yaml   | 84 +++++++++++++++++++
> > >  2 files changed, 84 insertions(+), 37 deletions(-)
> > >  delete mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > >  create mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > > 
> > > diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.txt b/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > > deleted file mode 100644
> > > index 900c169de00f..000000000000
> > > --- a/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > > +++ /dev/null
> > > @@ -1,37 +0,0 @@
> > > -Bosch BMI160 - Inertial Measurement Unit with Accelerometer, Gyroscope
> > > -and externally connectable Magnetometer
> > > -
> > > -https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> > > -
> > > -Required properties:
> > > - - compatible : should be "bosch,bmi160"
> > > - - reg : the I2C address or SPI chip select number of the sensor
> > > - - spi-max-frequency : set maximum clock frequency (only for SPI)
> > > -
> > > -Optional properties:
> > > - - interrupts : interrupt mapping for IRQ
> > > - - interrupt-names : set to "INT1" if INT1 pin should be used as interrupt
> > > -   input, set to "INT2" if INT2 pin should be used instead
> > > - - drive-open-drain : set if the specified interrupt pin should be configured as
> > > -   open drain. If not set, defaults to push-pull.
> > > -
> > > -Examples:
> > > -
> > > -bmi160@68 {
> > > -	compatible = "bosch,bmi160";
> > > -	reg = <0x68>;
> > > -
> > > -	interrupt-parent = <&gpio4>;
> > > -	interrupts = <12 IRQ_TYPE_EDGE_RISING>;
> > > -	interrupt-names = "INT1";
> > > -};
> > > -
> > > -bmi160@0 {
> > > -	compatible = "bosch,bmi160";
> > > -	reg = <0>;
> > > -	spi-max-frequency = <10000000>;
> > > -
> > > -	interrupt-parent = <&gpio2>;
> > > -	interrupts = <12 IRQ_TYPE_LEVEL_LOW>;
> > > -	interrupt-names = "INT2";
> > > -};
> > > diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.yaml b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > > new file mode 100644
> > > index 000000000000..6b464ce5ed0b
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > > @@ -0,0 +1,84 @@
> > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/iio/imu/bmi160.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Bosch BMI160
> > > +
> > > +maintainers:
> > > +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>  
> > 
> > Daniel is still active in the kernel, just not at Intel any more. +CC
> >   
> 
> Oh ok thank you! Daniel are you still maintaining this driver?
> 
> > > +
> > > +description: |
> > > +  Inertial Measurement Unit with Accelerometer, Gyroscope and externally
> > > +  connectable Magnetometer
> > > +  https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> > > +
> > > +properties:
> > > +  compatible:
> > > +    const: bosch,bmi160
> > > +
> > > +  reg:
> > > +    maxItems: 1
> > > +    description: the I2C address or SPI chip select number of the sensor  
> > 
> > As standard for i2c and spi, usually no need to have a description line for
> > this element.
> >   
> 
> Thank you, will remove the description then.
> 
> > > +
> > > +  spi-max-frequency:
> > > +    maxItems: 1
> > > +    description: set maximum clock frequency (required only for SPI)  
> > 
> > Standard spi binding.  Probably doesn't need to be included here.
> >   
> 
> So should I completely remove it from properties?

Yes


Thanks,

Jonathan
Jonathan Albrieux May 22, 2020, 8:22 a.m. UTC | #8
On Thu, May 21, 2020 at 07:27:36PM +0100, Jonathan Cameron wrote:
> On Wed, 20 May 2020 09:24:23 +0200
> Jonathan Albrieux <jonathan.albrieux@gmail.com> wrote:
> 
> > On Tue, May 19, 2020 at 06:49:33PM +0100, Jonathan Cameron wrote:
> > > On Tue, 19 May 2020 09:50:57 +0200
> > > Jonathan Albrieux <jonathan.albrieux@gmail.com> wrote:
> > >   
> > > > Converts documentation from txt format to yaml 
> > > > 
> > > > Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com>
> > > > ---
> > > >  .../devicetree/bindings/iio/imu/bmi160.txt    | 37 --------
> > > >  .../devicetree/bindings/iio/imu/bmi160.yaml   | 84 +++++++++++++++++++
> > > >  2 files changed, 84 insertions(+), 37 deletions(-)
> > > >  delete mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > > >  create mode 100644 Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > > > 
> > > > diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.txt b/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > > > deleted file mode 100644
> > > > index 900c169de00f..000000000000
> > > > --- a/Documentation/devicetree/bindings/iio/imu/bmi160.txt
> > > > +++ /dev/null
> > > > @@ -1,37 +0,0 @@
> > > > -Bosch BMI160 - Inertial Measurement Unit with Accelerometer, Gyroscope
> > > > -and externally connectable Magnetometer
> > > > -
> > > > -https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> > > > -
> > > > -Required properties:
> > > > - - compatible : should be "bosch,bmi160"
> > > > - - reg : the I2C address or SPI chip select number of the sensor
> > > > - - spi-max-frequency : set maximum clock frequency (only for SPI)
> > > > -
> > > > -Optional properties:
> > > > - - interrupts : interrupt mapping for IRQ
> > > > - - interrupt-names : set to "INT1" if INT1 pin should be used as interrupt
> > > > -   input, set to "INT2" if INT2 pin should be used instead
> > > > - - drive-open-drain : set if the specified interrupt pin should be configured as
> > > > -   open drain. If not set, defaults to push-pull.
> > > > -
> > > > -Examples:
> > > > -
> > > > -bmi160@68 {
> > > > -	compatible = "bosch,bmi160";
> > > > -	reg = <0x68>;
> > > > -
> > > > -	interrupt-parent = <&gpio4>;
> > > > -	interrupts = <12 IRQ_TYPE_EDGE_RISING>;
> > > > -	interrupt-names = "INT1";
> > > > -};
> > > > -
> > > > -bmi160@0 {
> > > > -	compatible = "bosch,bmi160";
> > > > -	reg = <0>;
> > > > -	spi-max-frequency = <10000000>;
> > > > -
> > > > -	interrupt-parent = <&gpio2>;
> > > > -	interrupts = <12 IRQ_TYPE_LEVEL_LOW>;
> > > > -	interrupt-names = "INT2";
> > > > -};
> > > > diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.yaml b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > > > new file mode 100644
> > > > index 000000000000..6b464ce5ed0b
> > > > --- /dev/null
> > > > +++ b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
> > > > @@ -0,0 +1,84 @@
> > > > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > > > +%YAML 1.2
> > > > +---
> > > > +$id: http://devicetree.org/schemas/iio/imu/bmi160.yaml#
> > > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > > +
> > > > +title: Bosch BMI160
> > > > +
> > > > +maintainers:
> > > > +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>  
> > > 
> > > Daniel is still active in the kernel, just not at Intel any more. +CC
> > >   
> > 
> > Oh ok thank you! Daniel are you still maintaining this driver?
> > 
> > > > +
> > > > +description: |
> > > > +  Inertial Measurement Unit with Accelerometer, Gyroscope and externally
> > > > +  connectable Magnetometer
> > > > +  https://www.bosch-sensortec.com/bst/products/all_products/bmi160
> > > > +
> > > > +properties:
> > > > +  compatible:
> > > > +    const: bosch,bmi160
> > > > +
> > > > +  reg:
> > > > +    maxItems: 1
> > > > +    description: the I2C address or SPI chip select number of the sensor  
> > > 
> > > As standard for i2c and spi, usually no need to have a description line for
> > > this element.
> > >   
> > 
> > Thank you, will remove the description then.
> > 
> > > > +
> > > > +  spi-max-frequency:
> > > > +    maxItems: 1
> > > > +    description: set maximum clock frequency (required only for SPI)  
> > > 
> > > Standard spi binding.  Probably doesn't need to be included here.
> > >   
> > 
> > So should I completely remove it from properties?
> 
> Yes
> 
> 
> Thanks,
> 
> Jonathan

Ok I will remove it completely in next patch,
Thank you,

Best regards,
Jonathan Albrieux
Daniel Baluta May 22, 2020, 10:47 a.m. UTC | #9
>>>>> +
>>>>> +maintainers:
>>>>> +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>
>>>> Daniel is still active in the kernel, just not at Intel any more. +CC
>>>>    
>>> Oh ok thank you! Daniel are you still maintaining this driver?

I can do reviews if requested but I'm not actively maintaining this 
driver. If anyone wants

to take this over, will be more than happy.


Other than that we can add my gmail address: Daniel Baluta 
<daniel.baluta@gmail.com>
Jonathan Albrieux May 22, 2020, 2:26 p.m. UTC | #10
On Fri, May 22, 2020 at 01:47:21PM +0300, Daniel Baluta wrote:
> 
> > > > > > +
> > > > > > +maintainers:
> > > > > > +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>
> > > > > Daniel is still active in the kernel, just not at Intel any more. +CC
> > > > Oh ok thank you! Daniel are you still maintaining this driver?
> 
> I can do reviews if requested but I'm not actively maintaining this driver.
> If anyone wants
> 
> to take this over, will be more than happy.
> 
> 
> Other than that we can add my gmail address: Daniel Baluta
> <daniel.baluta@gmail.com>
> 
> 
> 

Well if you'd like to review this patch I'd really appreciate :-)
Forgive me for not having understood your answer regarding the maintainer
field, can I add you to this binding as maintainer or are you saying to
not add you? Thank you and sorry for the repeated question,

Best regards,
Jonathan Albrieux
Daniel Baluta May 22, 2020, 2:59 p.m. UTC | #11
On 22.05.2020 17:26, Jonathan Albrieux wrote:
> On Fri, May 22, 2020 at 01:47:21PM +0300, Daniel Baluta wrote:
>>>>>>> +
>>>>>>> +maintainers:
>>>>>>> +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>
>>>>>> Daniel is still active in the kernel, just not at Intel any more. +CC
>>>>> Oh ok thank you! Daniel are you still maintaining this driver?
>> I can do reviews if requested but I'm not actively maintaining this driver.
>> If anyone wants
>>
>> to take this over, will be more than happy.
>>
>>
>> Other than that we can add my gmail address: Daniel Baluta
>> <daniel.baluta@gmail.com>
>>
>>
>>
> Well if you'd like to review this patch I'd really appreciate :-)
> Forgive me for not having understood your answer regarding the maintainer
> field, can I add you to this binding as maintainer or are you saying to
> not add you? Thank you and sorry for the repeated question,
>
>

OK, so I think would be better not to add me as a maintainer because

this would set some expecation from people, and I most likely won't

have time to met them.


Can you instead add the linux-iio mailing list as a maintainer, not sure

if this is a common practice though.
Jonathan Albrieux May 22, 2020, 3:44 p.m. UTC | #12
On Fri, May 22, 2020 at 05:59:11PM +0300, Daniel Baluta wrote:
> 
> On 22.05.2020 17:26, Jonathan Albrieux wrote:
> > On Fri, May 22, 2020 at 01:47:21PM +0300, Daniel Baluta wrote:
> > > > > > > > +
> > > > > > > > +maintainers:
> > > > > > > > +  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>
> > > > > > > Daniel is still active in the kernel, just not at Intel any more. +CC
> > > > > > Oh ok thank you! Daniel are you still maintaining this driver?
> > > I can do reviews if requested but I'm not actively maintaining this driver.
> > > If anyone wants
> > > 
> > > to take this over, will be more than happy.
> > > 
> > > 
> > > Other than that we can add my gmail address: Daniel Baluta
> > > <daniel.baluta@gmail.com>
> > > 
> > > 
> > > 
> > Well if you'd like to review this patch I'd really appreciate :-)
> > Forgive me for not having understood your answer regarding the maintainer
> > field, can I add you to this binding as maintainer or are you saying to
> > not add you? Thank you and sorry for the repeated question,
> > 
> > 
> 
> OK, so I think would be better not to add me as a maintainer because
> 
> this would set some expecation from people, and I most likely won't
> 
> have time to met them.
> 
> 
> Can you instead add the linux-iio mailing list as a maintainer, not sure
> 
> if this is a common practice though.
> 
> 

Ok thank you! I don't know, maybe someone else could point out
the right direction to take, it would be sad to drop yaml documentation
format just for this.

Best regards,
Jonathan Albrieux
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.txt b/Documentation/devicetree/bindings/iio/imu/bmi160.txt
deleted file mode 100644
index 900c169de00f..000000000000
--- a/Documentation/devicetree/bindings/iio/imu/bmi160.txt
+++ /dev/null
@@ -1,37 +0,0 @@ 
-Bosch BMI160 - Inertial Measurement Unit with Accelerometer, Gyroscope
-and externally connectable Magnetometer
-
-https://www.bosch-sensortec.com/bst/products/all_products/bmi160
-
-Required properties:
- - compatible : should be "bosch,bmi160"
- - reg : the I2C address or SPI chip select number of the sensor
- - spi-max-frequency : set maximum clock frequency (only for SPI)
-
-Optional properties:
- - interrupts : interrupt mapping for IRQ
- - interrupt-names : set to "INT1" if INT1 pin should be used as interrupt
-   input, set to "INT2" if INT2 pin should be used instead
- - drive-open-drain : set if the specified interrupt pin should be configured as
-   open drain. If not set, defaults to push-pull.
-
-Examples:
-
-bmi160@68 {
-	compatible = "bosch,bmi160";
-	reg = <0x68>;
-
-	interrupt-parent = <&gpio4>;
-	interrupts = <12 IRQ_TYPE_EDGE_RISING>;
-	interrupt-names = "INT1";
-};
-
-bmi160@0 {
-	compatible = "bosch,bmi160";
-	reg = <0>;
-	spi-max-frequency = <10000000>;
-
-	interrupt-parent = <&gpio2>;
-	interrupts = <12 IRQ_TYPE_LEVEL_LOW>;
-	interrupt-names = "INT2";
-};
diff --git a/Documentation/devicetree/bindings/iio/imu/bmi160.yaml b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
new file mode 100644
index 000000000000..6b464ce5ed0b
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/imu/bmi160.yaml
@@ -0,0 +1,84 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/imu/bmi160.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Bosch BMI160
+
+maintainers:
+  - can't find a mantainer, author is Daniel Baluta <daniel.baluta@intel.com>
+
+description: |
+  Inertial Measurement Unit with Accelerometer, Gyroscope and externally
+  connectable Magnetometer
+  https://www.bosch-sensortec.com/bst/products/all_products/bmi160
+
+properties:
+  compatible:
+    const: bosch,bmi160
+
+  reg:
+    maxItems: 1
+    description: the I2C address or SPI chip select number of the sensor
+
+  spi-max-frequency:
+    maxItems: 1
+    description: set maximum clock frequency (required only for SPI)
+
+  interrupts:
+    maxItems: 1
+    description: interrupt mapping for IRQ
+
+  interrupt-names:
+    minItems: 1
+    maxItems: 1
+    items:
+      enum:
+        - INT1
+        - INT2
+    description: |
+      set to "INT1" if INT1 pin should be used as interrupt input, set
+      to "INT2" if INT2 pin should be used instead
+
+  drive-open-drain:
+    description: |
+      set if the specified interrupt pin should be configured as
+      open drain. If not set, defaults to push-pull.
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    // Example for I2C
+    i2c@78b7000 {
+        reg = <0x78b6000 0x600>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        bmi160@68 {
+                compatible = "bosch,bmi160";
+                reg = <0x68>;
+                interrupt-parent = <&gpio4>;
+                interrupts = <12 1>;
+                interrupt-names = "INT1";
+        };
+  - |
+    // Example for SPI
+    spi@78b7000 {
+        reg = <0x78b7000 0x600>,
+              <0x7884000 0x23000>;
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        bmi160@0 {
+                compatible = "bosch,bmi160";
+                reg = <0>;
+                spi-max-frequency = <10000000>;
+                interrupt-parent = <&gpio2>;
+                interrupts = <12 1>;
+                interrupt-names = "INT2";
+        };
+    };