lkml.org 
[lkml]   [2020]   [May]   [19]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [PATCH v2 1/4] dt-bindings: iio: imu: bmi160: convert txt format to yaml
    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
    >

    \
     
     \ /
      Last update: 2020-05-19 20:20    [W:3.697 / U:0.036 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site