diff mbox series

[07/46] dt-bindings:iio:health:ti,afe4403: txt to yaml binding

Message ID 20201031184854.745828-8-jic23@kernel.org (mailing list archive)
State New
Headers show
Series dt-bindings:iio: yet more txt to yam conversions | expand

Commit Message

Jonathan Cameron Oct. 31, 2020, 6:48 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

A few questions came up whilst converting this one.
1) What is actually required?
  - Checking Linux driver, interrupt is not, and the tx-supply could
    be supplied by a stub regulator as long as it's always on.
    As such I have reduced the required list to just compatible and reg.
2) What is the regulator called?
  - It's tx-supply in the binding doc, but the driver request tx_sup
    I've left this alone for now.  Andrew could you confirm what is
    intended for this?

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Andrew F. Davis <afd@ti.com>
---
 .../bindings/iio/health/afe4403.txt           | 33 ------------
 .../bindings/iio/health/ti,afe4403.yaml       | 54 +++++++++++++++++++
 2 files changed, 54 insertions(+), 33 deletions(-)

Comments

Jonathan Cameron Nov. 22, 2020, 5:32 p.m. UTC | #1
On Sat, 31 Oct 2020 18:48:15 +0000
Jonathan Cameron <jic23@kernel.org> wrote:

> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> A few questions came up whilst converting this one.
> 1) What is actually required?
>   - Checking Linux driver, interrupt is not, and the tx-supply could
>     be supplied by a stub regulator as long as it's always on.
>     As such I have reduced the required list to just compatible and reg.
> 2) What is the regulator called?
>   - It's tx-supply in the binding doc, but the driver request tx_sup
>     I've left this alone for now.  Andrew could you confirm what is
>     intended for this?

Andrew's email seems to be bouncing so I've reached out to him via another
means.  Will wait to see if that works before applying this or the next
patch given the questions.

Thanks,

Jonathan

> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Andrew F. Davis <afd@ti.com>
> ---
>  .../bindings/iio/health/afe4403.txt           | 33 ------------
>  .../bindings/iio/health/ti,afe4403.yaml       | 54 +++++++++++++++++++
>  2 files changed, 54 insertions(+), 33 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/iio/health/afe4403.txt b/Documentation/devicetree/bindings/iio/health/afe4403.txt
> deleted file mode 100644
> index 8e412054d6d5..000000000000
> --- a/Documentation/devicetree/bindings/iio/health/afe4403.txt
> +++ /dev/null
> @@ -1,33 +0,0 @@
> -Texas Instruments AFE4403 Heart rate and Pulse Oximeter
> -
> -Required properties:
> - - compatible		: Should be "ti,afe4403".
> - - reg			: SPI chip select address of device.
> - - tx-supply		: Regulator supply to transmitting LEDs.
> - - interrupts		: The interrupt line the device ADC_RDY pin is
> -			  connected to. For details refer to,
> -			  ../../interrupt-controller/interrupts.txt.
> -
> -Optional properties:
> - - reset-gpios		: GPIO used to reset the device.
> -			  For details refer to, ../../gpio/gpio.txt.
> -
> -For other required and optional properties of SPI slave nodes
> -please refer to ../../spi/spi-bus.txt.
> -
> -Example:
> -
> -&spi0 {
> -	heart_mon@0 {
> -		compatible = "ti,afe4403";
> -		reg = <0>;
> -		spi-max-frequency = <10000000>;
> -
> -		tx-supply = <&vbat>;
> -
> -		interrupt-parent = <&gpio1>;
> -		interrupts = <28 IRQ_TYPE_EDGE_RISING>;
> -
> -		reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
> -	};
> -};
> diff --git a/Documentation/devicetree/bindings/iio/health/ti,afe4403.yaml b/Documentation/devicetree/bindings/iio/health/ti,afe4403.yaml
> new file mode 100644
> index 000000000000..5c86db65c033
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/health/ti,afe4403.yaml
> @@ -0,0 +1,54 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/health/ti,afe4403.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments AFE4403 Heart rate and Pulse Oximeter
> +
> +maintainers:
> +  - Andrew F. Davis <afd@ti.com>
> +
> +properties:
> +  compatible:
> +    const: ti,afe4403
> +
> +  reg:
> +    maxItems: 1
> +
> +  tx-supply:
> +    description: Supply to transmitting LEDs.
> +
> +  interrupts:
> +    maxItems: 1
> +    description: Connected to ADC_RDY pin.
> +
> +  reset-gpios: true
> +
> +  spi-max-frequency: true
> +
> +additionalProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    spi {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        heart_mon@0 {
> +            compatible = "ti,afe4403";
> +            reg = <0>;
> +            spi-max-frequency = <10000000>;
> +            tx-supply = <&vbat>;
> +            interrupt-parent = <&gpio1>;
> +            interrupts = <28 IRQ_TYPE_EDGE_RISING>;
> +            reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
> +        };
> +    };
> +...
Jonathan Cameron Nov. 28, 2020, 4:15 p.m. UTC | #2
On Sun, 22 Nov 2020 17:32:11 +0000
Jonathan Cameron <jic23@kernel.org> wrote:

> On Sat, 31 Oct 2020 18:48:15 +0000
> Jonathan Cameron <jic23@kernel.org> wrote:
> 
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > 
> > A few questions came up whilst converting this one.
> > 1) What is actually required?
> >   - Checking Linux driver, interrupt is not, and the tx-supply could
> >     be supplied by a stub regulator as long as it's always on.
> >     As such I have reduced the required list to just compatible and reg.
> > 2) What is the regulator called?
> >   - It's tx-supply in the binding doc, but the driver request tx_sup
> >     I've left this alone for now.  Andrew could you confirm what is
> >     intended for this?  
> 
> Andrew's email seems to be bouncing so I've reached out to him via another
> means.  Will wait to see if that works before applying this or the next
> patch given the questions.

In order to move forwards with this I've put myself as maintainer and
decided to send out a fix for the driver naming of that supply.

Thanks,

Jonathan

> 
> Thanks,
> 
> Jonathan
> 
> > 
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > Cc: Andrew F. Davis <afd@ti.com>
> > ---
> >  .../bindings/iio/health/afe4403.txt           | 33 ------------
> >  .../bindings/iio/health/ti,afe4403.yaml       | 54 +++++++++++++++++++
> >  2 files changed, 54 insertions(+), 33 deletions(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/health/afe4403.txt b/Documentation/devicetree/bindings/iio/health/afe4403.txt
> > deleted file mode 100644
> > index 8e412054d6d5..000000000000
> > --- a/Documentation/devicetree/bindings/iio/health/afe4403.txt
> > +++ /dev/null
> > @@ -1,33 +0,0 @@
> > -Texas Instruments AFE4403 Heart rate and Pulse Oximeter
> > -
> > -Required properties:
> > - - compatible		: Should be "ti,afe4403".
> > - - reg			: SPI chip select address of device.
> > - - tx-supply		: Regulator supply to transmitting LEDs.
> > - - interrupts		: The interrupt line the device ADC_RDY pin is
> > -			  connected to. For details refer to,
> > -			  ../../interrupt-controller/interrupts.txt.
> > -
> > -Optional properties:
> > - - reset-gpios		: GPIO used to reset the device.
> > -			  For details refer to, ../../gpio/gpio.txt.
> > -
> > -For other required and optional properties of SPI slave nodes
> > -please refer to ../../spi/spi-bus.txt.
> > -
> > -Example:
> > -
> > -&spi0 {
> > -	heart_mon@0 {
> > -		compatible = "ti,afe4403";
> > -		reg = <0>;
> > -		spi-max-frequency = <10000000>;
> > -
> > -		tx-supply = <&vbat>;
> > -
> > -		interrupt-parent = <&gpio1>;
> > -		interrupts = <28 IRQ_TYPE_EDGE_RISING>;
> > -
> > -		reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
> > -	};
> > -};
> > diff --git a/Documentation/devicetree/bindings/iio/health/ti,afe4403.yaml b/Documentation/devicetree/bindings/iio/health/ti,afe4403.yaml
> > new file mode 100644
> > index 000000000000..5c86db65c033
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/health/ti,afe4403.yaml
> > @@ -0,0 +1,54 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/health/ti,afe4403.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Texas Instruments AFE4403 Heart rate and Pulse Oximeter
> > +
> > +maintainers:
> > +  - Andrew F. Davis <afd@ti.com>
> > +
> > +properties:
> > +  compatible:
> > +    const: ti,afe4403
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  tx-supply:
> > +    description: Supply to transmitting LEDs.
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +    description: Connected to ADC_RDY pin.
> > +
> > +  reset-gpios: true
> > +
> > +  spi-max-frequency: true
> > +
> > +additionalProperties: false
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/gpio/gpio.h>
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> > +    spi {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        heart_mon@0 {
> > +            compatible = "ti,afe4403";
> > +            reg = <0>;
> > +            spi-max-frequency = <10000000>;
> > +            tx-supply = <&vbat>;
> > +            interrupt-parent = <&gpio1>;
> > +            interrupts = <28 IRQ_TYPE_EDGE_RISING>;
> > +            reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
> > +        };
> > +    };
> > +...  
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/health/afe4403.txt b/Documentation/devicetree/bindings/iio/health/afe4403.txt
deleted file mode 100644
index 8e412054d6d5..000000000000
--- a/Documentation/devicetree/bindings/iio/health/afe4403.txt
+++ /dev/null
@@ -1,33 +0,0 @@ 
-Texas Instruments AFE4403 Heart rate and Pulse Oximeter
-
-Required properties:
- - compatible		: Should be "ti,afe4403".
- - reg			: SPI chip select address of device.
- - tx-supply		: Regulator supply to transmitting LEDs.
- - interrupts		: The interrupt line the device ADC_RDY pin is
-			  connected to. For details refer to,
-			  ../../interrupt-controller/interrupts.txt.
-
-Optional properties:
- - reset-gpios		: GPIO used to reset the device.
-			  For details refer to, ../../gpio/gpio.txt.
-
-For other required and optional properties of SPI slave nodes
-please refer to ../../spi/spi-bus.txt.
-
-Example:
-
-&spi0 {
-	heart_mon@0 {
-		compatible = "ti,afe4403";
-		reg = <0>;
-		spi-max-frequency = <10000000>;
-
-		tx-supply = <&vbat>;
-
-		interrupt-parent = <&gpio1>;
-		interrupts = <28 IRQ_TYPE_EDGE_RISING>;
-
-		reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
-	};
-};
diff --git a/Documentation/devicetree/bindings/iio/health/ti,afe4403.yaml b/Documentation/devicetree/bindings/iio/health/ti,afe4403.yaml
new file mode 100644
index 000000000000..5c86db65c033
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/health/ti,afe4403.yaml
@@ -0,0 +1,54 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/health/ti,afe4403.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments AFE4403 Heart rate and Pulse Oximeter
+
+maintainers:
+  - Andrew F. Davis <afd@ti.com>
+
+properties:
+  compatible:
+    const: ti,afe4403
+
+  reg:
+    maxItems: 1
+
+  tx-supply:
+    description: Supply to transmitting LEDs.
+
+  interrupts:
+    maxItems: 1
+    description: Connected to ADC_RDY pin.
+
+  reset-gpios: true
+
+  spi-max-frequency: true
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        heart_mon@0 {
+            compatible = "ti,afe4403";
+            reg = <0>;
+            spi-max-frequency = <10000000>;
+            tx-supply = <&vbat>;
+            interrupt-parent = <&gpio1>;
+            interrupts = <28 IRQ_TYPE_EDGE_RISING>;
+            reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
+        };
+    };
+...