Commit 5a6a65b1 authored by Jonathan Cameron's avatar Jonathan Cameron
Browse files

dt-bindings:iio:health:maxim,max30102: txt to yaml conversion 



Straight forward binding.  Title was a bit of a challenge to keep short
as this binding covers sensors for two entirely different purposes.

Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Acked-by: default avatarMatt Ranostay <matt.ranostay@konsulko.com>
Cc: Matt Ranostay <mranostay@gmail.com>
Link: https://lore.kernel.org/r/20201031184854.745828-11-jic23@kernel.org
parent f0c49ea4

Documentation/devicetree/bindings/iio/health/max30102.txt

deleted100644 → 0
+0 −33
Original line number Diff line number Diff line 
Maxim MAX30102 heart rate and pulse oximeter sensor

Maxim MAX30105 optical particle-sensing module



* https://datasheets.maximintegrated.com/en/ds/MAX30102.pdf

* https://datasheets.maximintegrated.com/en/ds/MAX30105.pdf



Required properties:

  - compatible: must be "maxim,max30102" or "maxim,max30105"

  - reg: the I2C address of the sensor

  - interrupts: the sole interrupt generated by the device



  Refer to interrupt-controller/interrupts.txt for generic

  interrupt client node bindings.



Optional properties:

  - maxim,red-led-current-microamp: configuration for red LED current

  - maxim,ir-led-current-microamp: configuration for IR LED current

  - maxim,green-led-current-microamp: configuration for green LED current

    (max30105 only)



    Note that each step is approximately 200 microamps, ranging from 0 uA to

    50800 uA.



Example:



max30102@57 {

	compatible = "maxim,max30102";

	reg = <0x57>;

	maxim,red-led-current-microamp = <7000>;

	maxim,ir-led-current-microamp = <7000>;

	interrupt-parent = <&gpio1>;

	interrupts = <16 2>;

};

Documentation/devicetree/bindings/iio/health/maxim,max30102.yaml

0 → 100644
+72 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/iio/health/maxim,max30102.yaml#

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



title: Maxim MAX30102 heart rate and pulse oximeter and MAX30105 particle-sensor



maintainers:

  - Matt Ranostay <matt.ranostay@konsulko.com>



properties:

  compatible:

    enum:

      - maxim,max30102

      - maxim,max30105



  reg:

    maxItems: 1



  interrupts:

    maxItems: 1

    description: Connected to ADC_RDY pin.



  maxim,red-led-current-microamp:

    description: RED LED current. Each step is approximately 200 microamps.

    minimum: 0

    maximum: 50800



  maxim,ir-led-current-microamp:

    description: IR LED current. Each step is approximately 200 microamps.

    minimum: 0

    maximum: 50800



  maxim,green-led-current-microamp:

    description: Green LED current. Each step is approximately 200 microamps.

    minimum: 0

    maximum: 50800



allOf:

  - if:

      properties:

        compatible:

          contains:

            const: maxim,max30100

    then:

      properties:

        maxim,green-led-current-microamp: false



additionalProperties: false



required:

  - compatible

  - reg

  - interrupts



examples:

  - |

    i2c {

        #address-cells = <1>;

        #size-cells = <0>;



        heart-rate@57 {

            compatible = "maxim,max30102";

            reg = <0x57>;

            maxim,red-led-current-microamp = <7000>;

            maxim,ir-led-current-microamp = <7000>;

            interrupt-parent = <&gpio1>;

            interrupts = <16 2>;

        };

    };

...