Commit 52f171ab authored by Andreas Klinger's avatar Andreas Klinger Committed by Jonathan Cameron
Browse files

devantech-srf04.yaml: transform DT binding to YAML 



devantech-srf04.yaml: yaml devicetree binding for iio ultrasonic
proximity driver of devantech srf04

use devantech-srf04.txt, transform binding into yaml and remove the
outdated DT documentation

Signed-off-by: default avatarAndreas Klinger <ak@it-klinger.de>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
parent 5cd66239

Documentation/devicetree/bindings/iio/proximity/devantech-srf04.txt

deleted100644 → 0
+0 −28
Original line number Diff line number Diff line 
* Devantech SRF04 ultrasonic range finder

  Bit-banging driver using two GPIOs



Required properties:

 - compatible:	Should be "devantech,srf04"



 - trig-gpios:	Definition of the GPIO for the triggering (output)

		This GPIO is set for about 10 us by the driver to tell the

		device it should initiate the measurement cycle.



 - echo-gpios:	Definition of the GPIO for the echo (input)

		This GPIO is set by the device as soon as an ultrasonic

		burst is sent out and reset when the first echo is

		received.

		Thus this GPIO is set while the ultrasonic waves are doing

		one round trip.

		It needs to be an GPIO which is able to deliver an

		interrupt because the time between two interrupts is

		measured in the driver.

		See Documentation/devicetree/bindings/gpio/gpio.txt for

		information on how to specify a consumer gpio.



Example:

srf04@0 {

	compatible = "devantech,srf04";

	trig-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;

	echo-gpios = <&gpio2  6 GPIO_ACTIVE_HIGH>;

};

Documentation/devicetree/bindings/iio/proximity/devantech-srf04.yaml

0 → 100644
+59 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

%YAML 1.2

---

$id: http://devicetree.org/schemas/iio/proximity/devantech-srf04.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Devantech SRF04 ultrasonic range finder



maintainers:

  - Andreas Klinger <ak@it-klinger.de>



description: |

  Bit-banging driver using two GPIOs:

  - trigger-gpio is raised by the driver to start sending out an ultrasonic

    burst

  - echo-gpio is held high by the sensor after sending ultrasonic burst

    until it is received once again



  Specifications about the driver can be found at:

  http://www.robot-electronics.co.uk/htm/srf04tech.htm



properties:

  compatible:

    items:

      - const: devantech,srf04



  trig-gpios:

    description:

      Definition of the GPIO for the triggering (output) This GPIO is set

      for about 10 us by the driver to tell the device it should initiate

      the measurement cycle.

    maxItems: 1



  echo-gpios:

    description:

      Definition of the GPIO for the echo (input)

      This GPIO is set by the device as soon as an ultrasonic burst is sent

      out and reset when the first echo is received.

      Thus this GPIO is set while the ultrasonic waves are doing one round

      trip.

      It needs to be an GPIO which is able to deliver an interrupt because

      the time between two interrupts is measured in the driver.

      See Documentation/devicetree/bindings/gpio/gpio.txt for information

      on how to specify a consumer gpio.

    maxItems: 1



required:

  - compatible

  - trig-gpios

  - echo-gpios



examples:

  - |

    #include <dt-bindings/gpio/gpio.h>

    proximity {

        compatible = "devantech,srf04";

        trig-gpios = <&gpio1 15 GPIO_ACTIVE_HIGH>;

        echo-gpios = <&gpio2  6 GPIO_ACTIVE_HIGH>;

    };