Re: [PATCH] dt-bindings: convert extcon-usbc-cros-ec.txt extcon-usbc-cros-ec.yaml

From: Rob Herring
Date: Mon Feb 03 2020 - 07:18:56 EST


On Wed, Jan 22, 2020 at 04:13:13PM +0100, Dafna Hirschfeld wrote:
> convert the binding file extcon-usbc-cros-ec.txt to yaml format
> This was tested and verified on ARM with:
> make dt_binding_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml
> make dtbs_check DT_SCHEMA_FILES=Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml
>
> Signed-off-by: Dafna Hirschfeld <dafna.hirschfeld@xxxxxxxxxxxxx>
> ---
> .../bindings/extcon/extcon-usbc-cros-ec.txt | 24 -----------
> .../bindings/extcon/extcon-usbc-cros-ec.yaml | 42 +++++++++++++++++++
> 2 files changed, 42 insertions(+), 24 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.txt
> create mode 100644 Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml
>
> diff --git a/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.txt b/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.txt
> deleted file mode 100644
> index 8e8625c00dfa..000000000000
> --- a/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.txt
> +++ /dev/null
> @@ -1,24 +0,0 @@
> -ChromeOS EC USB Type-C cable and accessories detection
> -
> -On ChromeOS systems with USB Type C ports, the ChromeOS Embedded Controller is
> -able to detect the state of external accessories such as display adapters
> -or USB devices when said accessories are attached or detached.
> -
> -The node for this device must be under a cros-ec node like google,cros-ec-spi
> -or google,cros-ec-i2c.
> -
> -Required properties:
> -- compatible: Should be "google,extcon-usbc-cros-ec".
> -- google,usb-port-id: Specifies the USB port ID to use.
> -
> -Example:
> - cros-ec@0 {
> - compatible = "google,cros-ec-i2c";
> -
> - ...
> -
> - extcon {
> - compatible = "google,extcon-usbc-cros-ec";
> - google,usb-port-id = <0>;
> - };
> - }
> diff --git a/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml b/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml
> new file mode 100644
> index 000000000000..78779831282a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml
> @@ -0,0 +1,42 @@
> +# SPDX-License-Identifier: GPL-2.0

Surely Google is the only copyright holder on the old file and would be
okay with dual licensing here?

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/extcon/extcon-usbc-cros-ec.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ChromeOS EC USB Type-C cable and accessories detection
> +
> +maintainers:
> + - MyungJoo Ham <myungjoo.ham@xxxxxxxxxxx>
> + - Chanwoo Choi <cw00.choi@xxxxxxxxxxx>

Usually this is someone that knows the h/w, not who applies the patch.
I'd expect a Google person.

> +
> +description: |
> + On ChromeOS systems with USB Type C ports, the ChromeOS Embedded Controller is
> + able to detect the state of external accessories such as display adapters
> + or USB devices when said accessories are attached or detached.
> + The node for this device must be under a cros-ec node like google,cros-ec-spi
> + or google,cros-ec-i2c.
> +
> +properties:
> + compatible:
> + const: google,extcon-usbc-cros-ec
> +
> + google,usb-port-id:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: |
> + the port id

Any range of values allowed? ~0 is okay?

> +required:
> + - compatible
> + - google,usb-port-id
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + cros-ec@0 {
> + compatible = "google,cros-ec-i2c";
> + extcon {
> + compatible = "google,extcon-usbc-cros-ec";
> + google,usb-port-id = <0>;
> + };
> + };
> --
> 2.17.1
>