diff mbox series

[1/1] dt-bindings: extcon: convert extcon-usb-gpio.txt to yaml format

Message ID 20240812201754.3830198-1-Frank.Li@nxp.com (mailing list archive)
State In Next, archived
Headers show
Series [1/1] dt-bindings: extcon: convert extcon-usb-gpio.txt to yaml format | expand

Commit Message

Frank Li Aug. 12, 2024, 8:17 p.m. UTC
Convert binding doc extcon-usb-gpio.txt to yaml format to fix below
warning:
arch/arm64/boot/dts/freescale/imx8mp-msc-sm2s-ep1.dtb: /extcon-usb0:
    failed to match any schema with compatible: ['linux,extcon-usb-gpio']

Additional change:
- rename id-gpio to id-gpios
- rename vbus-gpio to vbus-gpios

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 .../bindings/extcon/extcon-usb-gpio.txt       | 21 ----------
 .../extcon/linux,extcon-usb-gpio.yaml         | 38 +++++++++++++++++++
 2 files changed, 38 insertions(+), 21 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/extcon/extcon-usb-gpio.txt
 create mode 100644 Documentation/devicetree/bindings/extcon/linux,extcon-usb-gpio.yaml

Comments

Rob Herring (Arm) Aug. 18, 2024, 2:57 p.m. UTC | #1
On Mon, 12 Aug 2024 16:17:53 -0400, Frank Li wrote:
> Convert binding doc extcon-usb-gpio.txt to yaml format to fix below
> warning:
> arch/arm64/boot/dts/freescale/imx8mp-msc-sm2s-ep1.dtb: /extcon-usb0:
>     failed to match any schema with compatible: ['linux,extcon-usb-gpio']
> 
> Additional change:
> - rename id-gpio to id-gpios
> - rename vbus-gpio to vbus-gpios
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
>  .../bindings/extcon/extcon-usb-gpio.txt       | 21 ----------
>  .../extcon/linux,extcon-usb-gpio.yaml         | 38 +++++++++++++++++++
>  2 files changed, 38 insertions(+), 21 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/extcon/extcon-usb-gpio.txt
>  create mode 100644 Documentation/devicetree/bindings/extcon/linux,extcon-usb-gpio.yaml
> 

Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
Chanwoo Choi Aug. 22, 2024, 2:45 p.m. UTC | #2
24. 8. 13. 05:17에 Frank Li 이(가) 쓴 글:
> Convert binding doc extcon-usb-gpio.txt to yaml format to fix below
> warning:
> arch/arm64/boot/dts/freescale/imx8mp-msc-sm2s-ep1.dtb: /extcon-usb0:
>     failed to match any schema with compatible: ['linux,extcon-usb-gpio']
> 
> Additional change:
> - rename id-gpio to id-gpios
> - rename vbus-gpio to vbus-gpios
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
>  .../bindings/extcon/extcon-usb-gpio.txt       | 21 ----------
>  .../extcon/linux,extcon-usb-gpio.yaml         | 38 +++++++++++++++++++
>  2 files changed, 38 insertions(+), 21 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/extcon/extcon-usb-gpio.txt
>  create mode 100644 Documentation/devicetree/bindings/extcon/linux,extcon-usb-gpio.yaml
> 
> diff --git a/Documentation/devicetree/bindings/extcon/extcon-usb-gpio.txt b/Documentation/devicetree/bindings/extcon/extcon-usb-gpio.txt
> deleted file mode 100644
> index dfc14f71e81fb..0000000000000
> --- a/Documentation/devicetree/bindings/extcon/extcon-usb-gpio.txt
> +++ /dev/null
> @@ -1,21 +0,0 @@
> -USB GPIO Extcon device
> -
> -This is a virtual device used to generate USB cable states from the USB ID pin
> -connected to a GPIO pin.
> -
> -Required properties:
> -- compatible: Should be "linux,extcon-usb-gpio"
> -
> -Either one of id-gpio or vbus-gpio must be present. Both can be present as well.
> -- id-gpio: gpio for USB ID pin. See gpio binding.
> -- vbus-gpio: gpio for USB VBUS pin.
> -
> -Example: Examples of extcon-usb-gpio node in dra7-evm.dts as listed below:
> -	extcon_usb1 {
> -		compatible = "linux,extcon-usb-gpio";
> -		id-gpio = <&gpio6 1 GPIO_ACTIVE_HIGH>;
> -	}
> -
> -	&omap_dwc3_1 {
> -		extcon = <&extcon_usb1>;
> -	};
> diff --git a/Documentation/devicetree/bindings/extcon/linux,extcon-usb-gpio.yaml b/Documentation/devicetree/bindings/extcon/linux,extcon-usb-gpio.yaml
> new file mode 100644
> index 0000000000000..1caf58c297d34
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/extcon/linux,extcon-usb-gpio.yaml
> @@ -0,0 +1,38 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/extcon/linux,extcon-usb-gpio.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: USB GPIO Extcon device
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>
> +
> +description:
> +  This is a virtual device used to generate USB cable states from the USB ID pin
> +  connected to a GPIO pin.
> +
> +properties:
> +  compatible:
> +    const: linux,extcon-usb-gpio
> +
> +  id-gpios:
> +    description: gpio for USB ID pin. See gpio binding.
> +  vbus-gpios:
> +    description: gpio for USB VBUS pin.
> +
> +required:
> +  - compatible
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +
> +    extcon_usb1 {
> +        compatible = "linux,extcon-usb-gpio";
> +        id-gpios = <&gpio6 1 GPIO_ACTIVE_HIGH>;
> +    };
> +

Applied it. Thanks.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/extcon/extcon-usb-gpio.txt b/Documentation/devicetree/bindings/extcon/extcon-usb-gpio.txt
deleted file mode 100644
index dfc14f71e81fb..0000000000000
--- a/Documentation/devicetree/bindings/extcon/extcon-usb-gpio.txt
+++ /dev/null
@@ -1,21 +0,0 @@ 
-USB GPIO Extcon device
-
-This is a virtual device used to generate USB cable states from the USB ID pin
-connected to a GPIO pin.
-
-Required properties:
-- compatible: Should be "linux,extcon-usb-gpio"
-
-Either one of id-gpio or vbus-gpio must be present. Both can be present as well.
-- id-gpio: gpio for USB ID pin. See gpio binding.
-- vbus-gpio: gpio for USB VBUS pin.
-
-Example: Examples of extcon-usb-gpio node in dra7-evm.dts as listed below:
-	extcon_usb1 {
-		compatible = "linux,extcon-usb-gpio";
-		id-gpio = <&gpio6 1 GPIO_ACTIVE_HIGH>;
-	}
-
-	&omap_dwc3_1 {
-		extcon = <&extcon_usb1>;
-	};
diff --git a/Documentation/devicetree/bindings/extcon/linux,extcon-usb-gpio.yaml b/Documentation/devicetree/bindings/extcon/linux,extcon-usb-gpio.yaml
new file mode 100644
index 0000000000000..1caf58c297d34
--- /dev/null
+++ b/Documentation/devicetree/bindings/extcon/linux,extcon-usb-gpio.yaml
@@ -0,0 +1,38 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/extcon/linux,extcon-usb-gpio.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: USB GPIO Extcon device
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+description:
+  This is a virtual device used to generate USB cable states from the USB ID pin
+  connected to a GPIO pin.
+
+properties:
+  compatible:
+    const: linux,extcon-usb-gpio
+
+  id-gpios:
+    description: gpio for USB ID pin. See gpio binding.
+  vbus-gpios:
+    description: gpio for USB VBUS pin.
+
+required:
+  - compatible
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    extcon_usb1 {
+        compatible = "linux,extcon-usb-gpio";
+        id-gpios = <&gpio6 1 GPIO_ACTIVE_HIGH>;
+    };
+