| Message ID | 20191007170219.xfipsry5nk4raiem@arbad |
|---|---|
| State | Not Applicable, archived |
| Headers | show |
| Series | [v3] dt-bindings: iio: maxbotix,mb1232.yaml: transform to yaml | expand |
| Context | Check | Description |
|---|---|---|
| robh/checkpatch | warning | "total: 0 errors, 2 warnings, 60 lines checked" |
| robh/dt-meta-schema | success |
On Mon, 7 Oct 2019 19:02:20 +0200, Andreas Klinger wrote: > transform existing documentation of maxbotix,mb1232 ultrasonic ranger > from text documentation format into yaml. > > Changes in v3: > - add a i2c node around device node to set up #address-cells and > #size-cells for omitting error during make dt_binding_check > > Changes in v2: > - removed description of reg property > - added a line: > additionalProperties: false > > Signed-off-by: Andreas Klinger <ak@it-klinger.de> > --- > .../bindings/iio/proximity/maxbotix,mb1232.txt | 29 ----------- > .../bindings/iio/proximity/maxbotix,mb1232.yaml | 60 ++++++++++++++++++++++ > 2 files changed, 60 insertions(+), 29 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt > create mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml > Reviewed-by: Rob Herring <robh@kernel.org>
On Thu, 10 Oct 2019 15:53:28 -0500 Rob Herring <robh@kernel.org> wrote: > On Mon, 7 Oct 2019 19:02:20 +0200, Andreas Klinger wrote: > > transform existing documentation of maxbotix,mb1232 ultrasonic ranger > > from text documentation format into yaml. > > > > Changes in v3: > > - add a i2c node around device node to set up #address-cells and > > #size-cells for omitting error during make dt_binding_check > > > > Changes in v2: > > - removed description of reg property > > - added a line: > > additionalProperties: false > > > > Signed-off-by: Andreas Klinger <ak@it-klinger.de> > > --- > > .../bindings/iio/proximity/maxbotix,mb1232.txt | 29 ----------- > > .../bindings/iio/proximity/maxbotix,mb1232.yaml | 60 ++++++++++++++++++++++ > > 2 files changed, 60 insertions(+), 29 deletions(-) > > delete mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt > > create mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml > > > > Reviewed-by: Rob Herring <robh@kernel.org> Applied to the togreg branch of iio.git and pushed out as testing for the autobuilders to play with it. Thanks, Jonathan
diff --git a/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt deleted file mode 100644 index dd1058fbe9c3..000000000000 --- a/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt +++ /dev/null @@ -1,29 +0,0 @@ -* MaxBotix I2CXL-MaxSonar ultrasonic distance sensor of type mb1202, - mb1212, mb1222, mb1232, mb1242, mb7040 or mb7137 using the i2c interface - for ranging - -Required properties: - - compatible: "maxbotix,mb1202", - "maxbotix,mb1212", - "maxbotix,mb1222", - "maxbotix,mb1232", - "maxbotix,mb1242", - "maxbotix,mb7040" or - "maxbotix,mb7137" - - - reg: i2c address of the device, see also i2c/i2c.txt - -Optional properties: - - interrupts: Interrupt used to announce the preceding reading - request has finished and that data is available. - If no interrupt is specified the device driver - falls back to wait a fixed amount of time until - data can be retrieved. - -Example: -proximity@70 { - compatible = "maxbotix,mb1232"; - reg = <0x70>; - interrupt-parent = <&gpio2>; - interrupts = <2 IRQ_TYPE_EDGE_FALLING>; -}; diff --git a/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml new file mode 100644 index 000000000000..3eac248f291d --- /dev/null +++ b/Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml @@ -0,0 +1,60 @@ +# SPDX-License-Identifier: GPL-2.0 +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/proximity/maxbotix,mb1232.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: MaxBotix I2CXL-MaxSonar ultrasonic distance sensor + +maintainers: + - Andreas Klinger <ak@it-klinger.de> + +description: | + MaxBotix I2CXL-MaxSonar ultrasonic distance sensor of type mb1202, + mb1212, mb1222, mb1232, mb1242, mb7040 or mb7137 using the i2c interface + for ranging + + Specifications about the devices can be found at: + https://www.maxbotix.com/documents/I2CXL-MaxSonar-EZ_Datasheet.pdf + +properties: + compatible: + enum: + - maxbotix,mb1202 + - maxbotix,mb1212 + - maxbotix,mb1222 + - maxbotix,mb1232 + - maxbotix,mb1242 + - maxbotix,mb7040 + - maxbotix,mb7137 + + reg: + maxItems: 1 + + interrupts: + description: + Interrupt used to announce the preceding reading request has finished + and that data is available. If no interrupt is specified the device + driver falls back to wait a fixed amount of time until data can be + retrieved. + maxItems: 1 + +required: + - compatible + - reg + +additionalProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + i2c { + #address-cells = <1>; + #size-cells = <0>; + proximity@70 { + compatible = "maxbotix,mb1232"; + reg = <0x70>; + interrupt-parent = <&gpio2>; + interrupts = <2 IRQ_TYPE_EDGE_FALLING>; + }; + };
transform existing documentation of maxbotix,mb1232 ultrasonic ranger from text documentation format into yaml. Changes in v3: - add a i2c node around device node to set up #address-cells and #size-cells for omitting error during make dt_binding_check Changes in v2: - removed description of reg property - added a line: additionalProperties: false Signed-off-by: Andreas Klinger <ak@it-klinger.de> --- .../bindings/iio/proximity/maxbotix,mb1232.txt | 29 ----------- .../bindings/iio/proximity/maxbotix,mb1232.yaml | 60 ++++++++++++++++++++++ 2 files changed, 60 insertions(+), 29 deletions(-) delete mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.txt create mode 100644 Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml