diff mbox series

[v3,1/2] bindings: pm8941-misc: Convert to YAML and add support for VBUS detection

Message ID b63ffcc19639f69aaba1072c059ca79e4081e6ef.1603403020.git.gurus@codeaurora.org
State Changes Requested
Headers show
Series Add support for VBUS detection | expand

Checks

Context Check Description
robh/dt-meta-schema fail build log
robh/checkpatch warning total: 0 errors, 2 warnings, 65 lines checked

Commit Message

Guru Das Srinagesh Oct. 22, 2020, 9:47 p.m. UTC
From: Anirudh Ghayal <aghayal@codeaurora.org>

Convert bindings to YAML. Also add compatible string that adds support
for reporting the VBUS status that can be detected via a dedicated PMIC
pin.

Signed-off-by: Anirudh Ghayal <aghayal@codeaurora.org>
Signed-off-by: Guru Das Srinagesh <gurus@codeaurora.org>
---
 .../bindings/extcon/qcom,pm8941-misc.txt           | 41 --------------
 .../bindings/extcon/qcom,pm8941-misc.yaml          | 65 ++++++++++++++++++++++
 2 files changed, 65 insertions(+), 41 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.txt
 create mode 100644 Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml

Comments

Rob Herring Oct. 23, 2020, 4:06 p.m. UTC | #1
On Thu, 22 Oct 2020 14:47:43 -0700, Guru Das Srinagesh wrote:
> From: Anirudh Ghayal <aghayal@codeaurora.org>
> 
> Convert bindings to YAML. Also add compatible string that adds support
> for reporting the VBUS status that can be detected via a dedicated PMIC
> pin.
> 
> Signed-off-by: Anirudh Ghayal <aghayal@codeaurora.org>
> Signed-off-by: Guru Das Srinagesh <gurus@codeaurora.org>
> ---
>  .../bindings/extcon/qcom,pm8941-misc.txt           | 41 --------------
>  .../bindings/extcon/qcom,pm8941-misc.yaml          | 65 ++++++++++++++++++++++
>  2 files changed, 65 insertions(+), 41 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.txt
>  create mode 100644 Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml
> 


My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.example.dt.yaml: misc@900: interrupts: [[0, 9, 0, 3]] is too short
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml


See https://patchwork.ozlabs.org/patch/1386438

The base for the patch is generally the last rc1. Any dependencies
should be noted.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Rob Herring Oct. 23, 2020, 4:14 p.m. UTC | #2
On Thu, Oct 22, 2020 at 02:47:43PM -0700, Guru Das Srinagesh wrote:
> From: Anirudh Ghayal <aghayal@codeaurora.org>
> 
> Convert bindings to YAML. Also add compatible string that adds support
> for reporting the VBUS status that can be detected via a dedicated PMIC
> pin.

Converting to yaml and add Vbus support should be 2 patches.

Really, the main pm8941 needs to be converted and then this one 
referenced by it.

> 
> Signed-off-by: Anirudh Ghayal <aghayal@codeaurora.org>
> Signed-off-by: Guru Das Srinagesh <gurus@codeaurora.org>
> ---
>  .../bindings/extcon/qcom,pm8941-misc.txt           | 41 --------------
>  .../bindings/extcon/qcom,pm8941-misc.yaml          | 65 ++++++++++++++++++++++
>  2 files changed, 65 insertions(+), 41 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.txt
>  create mode 100644 Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.txt b/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.txt
> deleted file mode 100644
> index 35383adb..0000000
> --- a/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.txt
> +++ /dev/null
> @@ -1,41 +0,0 @@
> -Qualcomm's PM8941 USB ID Extcon device
> -
> -Some Qualcomm PMICs have a "misc" module that can be used to detect when
> -the USB ID pin has been pulled low or high.
> -
> -PROPERTIES
> -
> -- compatible:
> -    Usage: required
> -    Value type: <string>
> -    Definition: Should contain "qcom,pm8941-misc";
> -
> -- reg:
> -    Usage: required
> -    Value type: <u32>
> -    Definition: Should contain the offset to the misc address space
> -
> -- interrupts:
> -    Usage: required
> -    Value type: <prop-encoded-array>
> -    Definition: Should contain the usb id interrupt
> -
> -- interrupt-names:
> -    Usage: required
> -    Value type: <stringlist>
> -    Definition: Should contain the string "usb_id" for the usb id interrupt
> -
> -Example:
> -
> -	pmic {
> -		usb_id: misc@900 {
> -			compatible = "qcom,pm8941-misc";
> -			reg = <0x900>;
> -			interrupts = <0x0 0x9 0 IRQ_TYPE_EDGE_BOTH>;
> -			interrupt-names = "usb_id";
> -		};
> -	}
> -
> -	usb-controller {
> -		extcon = <&usb_id>;
> -	};
> diff --git a/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml b/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml
> new file mode 100644
> index 0000000..f422546
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml
> @@ -0,0 +1,65 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/extcon/qcom,pm8941-misc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Qualcomm Technologies, Inc. PM8941 USB ID Extcon device
> +
> +maintainers:
> +  - Guru Das Srinagesh <gurus@codeaurora.org>
> +
> +description: |
> +  Some Qualcomm PMICs have a "misc" module that can be used to detect when
> +  the USB ID pin has been pulled low or high.
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:

Don't need oneOf for a single entry.

> +          - enum:
> +              - qcom,pm8941-misc
> +              - qcom,pmd-vbus-det
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 2

Need 'minItems: 1' if 1 or 2 interrupts is valid.

> +
> +  interrupt-names:
> +    anyOf:
> +      - items:

Don't need 'anyOf'

> +          - enum:
> +              - usb_id
> +              - usb_vbus

I think what you want here is:

minItems: 1
items:
  - const: usb_id
  - const: usb_vbus

Meaning 'usb_id' is always present and 'usb_vbus' is optional 2nd 
interrupt.

> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - interrupt-names
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    pmic {
> +            #address-cells = <1>;
> +            #size-cells = <0>;
> +            interrupt-controller;
> +            #interrupt-cells = <4>;
> +
> +            usb_id: misc@900 {
> +                    compatible = "qcom,pm8941-misc";
> +                    reg = <0x900>;
> +                    interrupts = <0x0 0x9 0 IRQ_TYPE_EDGE_BOTH>;
> +                    interrupt-names = "usb_id";
> +            };
> +    };
> +
> +    usb-controller {
> +           extcon = <&usb_id>;
> +    };
> -- 
> The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
> a Linux Foundation Collaborative Project
>
Guru Das Srinagesh Oct. 28, 2020, 7:08 a.m. UTC | #3
On Fri, Oct 23, 2020 at 11:14:09AM -0500, Rob Herring wrote:
> On Thu, Oct 22, 2020 at 02:47:43PM -0700, Guru Das Srinagesh wrote:
> > From: Anirudh Ghayal <aghayal@codeaurora.org>
> > 
> > Convert bindings to YAML. Also add compatible string that adds support
> > for reporting the VBUS status that can be detected via a dedicated PMIC
> > pin.
> 
> Converting to yaml and add Vbus support should be 2 patches.

Done.

> 
> Really, the main pm8941 needs to be converted and then this one 
> referenced by it.

Could you please explain a bit more on what this might look like?

> 

...

> > +
> > +description: |
> > +  Some Qualcomm PMICs have a "misc" module that can be used to detect when
> > +  the USB ID pin has been pulled low or high.
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - items:
> 
> Don't need oneOf for a single entry.

Done.

> 
> > +          - enum:
> > +              - qcom,pm8941-misc
> > +              - qcom,pmd-vbus-det
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 2
> 
> Need 'minItems: 1' if 1 or 2 interrupts is valid.

Done.

> 
> > +
> > +  interrupt-names:
> > +    anyOf:
> > +      - items:
> 
> Don't need 'anyOf'

Done.

> 
> > +          - enum:
> > +              - usb_id
> > +              - usb_vbus
> 
> I think what you want here is:
> 
> minItems: 1
> items:
>   - const: usb_id
>   - const: usb_vbus
> 
> Meaning 'usb_id' is always present and 'usb_vbus' is optional 2nd 
> interrupt.

Done.

> 
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - interrupt-names
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> > +
> > +    pmic {
> > +            #address-cells = <1>;
> > +            #size-cells = <0>;
> > +            interrupt-controller;
> > +            #interrupt-cells = <4>;
> > +
> > +            usb_id: misc@900 {
> > +                    compatible = "qcom,pm8941-misc";
> > +                    reg = <0x900>;
> > +                    interrupts = <0x0 0x9 0 IRQ_TYPE_EDGE_BOTH>;
> > +                    interrupt-names = "usb_id";
> > +            };
> > +    };
> > +
> > +    usb-controller {
> > +           extcon = <&usb_id>;
> > +    };
> > -- 
> > The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
> > a Linux Foundation Collaborative Project
> >
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.txt b/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.txt
deleted file mode 100644
index 35383adb..0000000
--- a/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.txt
+++ /dev/null
@@ -1,41 +0,0 @@ 
-Qualcomm's PM8941 USB ID Extcon device
-
-Some Qualcomm PMICs have a "misc" module that can be used to detect when
-the USB ID pin has been pulled low or high.
-
-PROPERTIES
-
-- compatible:
-    Usage: required
-    Value type: <string>
-    Definition: Should contain "qcom,pm8941-misc";
-
-- reg:
-    Usage: required
-    Value type: <u32>
-    Definition: Should contain the offset to the misc address space
-
-- interrupts:
-    Usage: required
-    Value type: <prop-encoded-array>
-    Definition: Should contain the usb id interrupt
-
-- interrupt-names:
-    Usage: required
-    Value type: <stringlist>
-    Definition: Should contain the string "usb_id" for the usb id interrupt
-
-Example:
-
-	pmic {
-		usb_id: misc@900 {
-			compatible = "qcom,pm8941-misc";
-			reg = <0x900>;
-			interrupts = <0x0 0x9 0 IRQ_TYPE_EDGE_BOTH>;
-			interrupt-names = "usb_id";
-		};
-	}
-
-	usb-controller {
-		extcon = <&usb_id>;
-	};
diff --git a/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml b/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml
new file mode 100644
index 0000000..f422546
--- /dev/null
+++ b/Documentation/devicetree/bindings/extcon/qcom,pm8941-misc.yaml
@@ -0,0 +1,65 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/extcon/qcom,pm8941-misc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm Technologies, Inc. PM8941 USB ID Extcon device
+
+maintainers:
+  - Guru Das Srinagesh <gurus@codeaurora.org>
+
+description: |
+  Some Qualcomm PMICs have a "misc" module that can be used to detect when
+  the USB ID pin has been pulled low or high.
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - enum:
+              - qcom,pm8941-misc
+              - qcom,pmd-vbus-det
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 2
+
+  interrupt-names:
+    anyOf:
+      - items:
+          - enum:
+              - usb_id
+              - usb_vbus
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - interrupt-names
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    pmic {
+            #address-cells = <1>;
+            #size-cells = <0>;
+            interrupt-controller;
+            #interrupt-cells = <4>;
+
+            usb_id: misc@900 {
+                    compatible = "qcom,pm8941-misc";
+                    reg = <0x900>;
+                    interrupts = <0x0 0x9 0 IRQ_TYPE_EDGE_BOTH>;
+                    interrupt-names = "usb_id";
+            };
+    };
+
+    usb-controller {
+           extcon = <&usb_id>;
+    };