* [PATCH v2] dt-bindings: convert extcon-usbc-cros-ec.txt extcon-usbc-cros-ec.yaml
@ 2020-02-05 11:00 Dafna Hirschfeld
2020-02-06 15:47 ` Enric Balletbo i Serra
0 siblings, 1 reply; 4+ messages in thread
From: Dafna Hirschfeld @ 2020-02-05 11:00 UTC (permalink / raw)
To: devicetree
Cc: myungjoo.ham, cw00.choi, robh+dt, mark.rutland, bleung,
enric.balletbo, groeck, linux-kernel, dafna.hirschfeld,
helen.koike, ezequiel, kernel, dafna3
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@collabora.com>
---
Changes since v1:
1 - changing the license to (GPL-2.0-only OR BSD-2-Clause)
2 - changing the maintainers
3 - changing the google,usb-port-id property to have minimum 0 and maximum 255
.../bindings/extcon/extcon-usbc-cros-ec.txt | 24 ----------
.../bindings/extcon/extcon-usbc-cros-ec.yaml | 45 +++++++++++++++++++
2 files changed, 45 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..fd95e413d46f
--- /dev/null
+++ b/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml
@@ -0,0 +1,45 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%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:
+ - Benson Leung <bleung@chromium.org>
+ - Enric Balletbo i Serra <enric.balletbo@collabora.com>
+
+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:
+ allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint32
+ description: the port id
+ minimum: 0
+ maximum: 255
+
+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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v2] dt-bindings: convert extcon-usbc-cros-ec.txt extcon-usbc-cros-ec.yaml
2020-02-05 11:00 [PATCH v2] dt-bindings: convert extcon-usbc-cros-ec.txt extcon-usbc-cros-ec.yaml Dafna Hirschfeld
@ 2020-02-06 15:47 ` Enric Balletbo i Serra
2020-02-06 21:40 ` Rob Herring
0 siblings, 1 reply; 4+ messages in thread
From: Enric Balletbo i Serra @ 2020-02-06 15:47 UTC (permalink / raw)
To: Dafna Hirschfeld, devicetree
Cc: myungjoo.ham, cw00.choi, robh+dt, mark.rutland, bleung, groeck,
linux-kernel, helen.koike, ezequiel, kernel, dafna3
Hi Dafna,
On 5/2/20 12:00, 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@collabora.com>
> ---
> Changes since v1:
> 1 - changing the license to (GPL-2.0-only OR BSD-2-Clause)
> 2 - changing the maintainers
> 3 - changing the google,usb-port-id property to have minimum 0 and maximum 255
>
> .../bindings/extcon/extcon-usbc-cros-ec.txt | 24 ----------
> .../bindings/extcon/extcon-usbc-cros-ec.yaml | 45 +++++++++++++++++++
> 2 files changed, 45 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..fd95e413d46f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml
> @@ -0,0 +1,45 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%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:
> + - Benson Leung <bleung@chromium.org>
> + - Enric Balletbo i Serra <enric.balletbo@collabora.com>
> +
> +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:
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32
> + description: the port id
> + minimum: 0
> + maximum: 255
> +
> +required:
> + - compatible
> + - google,usb-port-id
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + cros-ec@0 {
> + compatible = "google,cros-ec-i2c";
Now that you are here ... could you use compatible = "google,cros-ec-spi" here?
The reason is that the label above, cros-ec@0 is not really correct for an i2c
device because after the @ you should put the address, cros-ec@1e will have more
sense here. But cros-ec-i2c is rarely used, so I'd change the compatible to use
"google,cros-ec-spi" and the entry "cros-ec@0" is fine.
> + extcon {
> + compatible = "google,extcon-usbc-cros-ec";
> + google,usb-port-id = <0>;
> + };
And maybe would be useful have a more complete example like this?
cros-ec@0 {
compatible = "google,cros-ec-spi";
usbc_extcon0: extcon@0 {
compatible = "google,extcon-usbc-cros-ec";
google,usb-port-id = <0>;
};
usbc_extcon1: extcon@1 {
compatible = "google,extcon-usbc-cros-ec";
google,usb-port-id = <1>;
};
};
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] dt-bindings: convert extcon-usbc-cros-ec.txt extcon-usbc-cros-ec.yaml
2020-02-06 15:47 ` Enric Balletbo i Serra
@ 2020-02-06 21:40 ` Rob Herring
2020-02-07 8:05 ` Enric Balletbo i Serra
0 siblings, 1 reply; 4+ messages in thread
From: Rob Herring @ 2020-02-06 21:40 UTC (permalink / raw)
To: Enric Balletbo i Serra
Cc: Dafna Hirschfeld, devicetree, myungjoo.ham, cw00.choi,
mark.rutland, bleung, groeck, linux-kernel, helen.koike,
ezequiel, kernel, dafna3
On Thu, Feb 06, 2020 at 04:47:59PM +0100, Enric Balletbo i Serra wrote:
> Hi Dafna,
>
> On 5/2/20 12:00, 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@collabora.com>
> > ---
> > Changes since v1:
> > 1 - changing the license to (GPL-2.0-only OR BSD-2-Clause)
> > 2 - changing the maintainers
> > 3 - changing the google,usb-port-id property to have minimum 0 and maximum 255
> >
> > .../bindings/extcon/extcon-usbc-cros-ec.txt | 24 ----------
> > .../bindings/extcon/extcon-usbc-cros-ec.yaml | 45 +++++++++++++++++++
> > 2 files changed, 45 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..fd95e413d46f
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml
> > @@ -0,0 +1,45 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%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:
> > + - Benson Leung <bleung@chromium.org>
> > + - Enric Balletbo i Serra <enric.balletbo@collabora.com>
> > +
> > +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:
> > + allOf:
> > + - $ref: /schemas/types.yaml#/definitions/uint32
> > + description: the port id
> > + minimum: 0
> > + maximum: 255
> > +
> > +required:
> > + - compatible
> > + - google,usb-port-id
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > + - |
> > + cros-ec@0 {
> > + compatible = "google,cros-ec-i2c";
>
> Now that you are here ... could you use compatible = "google,cros-ec-spi" here?
>
> The reason is that the label above, cros-ec@0 is not really correct for an i2c
> device because after the @ you should put the address, cros-ec@1e will have more
> sense here. But cros-ec-i2c is rarely used, so I'd change the compatible to use
> "google,cros-ec-spi" and the entry "cros-ec@0" is fine.
>
> > + extcon {
> > + compatible = "google,extcon-usbc-cros-ec";
> > + google,usb-port-id = <0>;
> > + };
>
> And maybe would be useful have a more complete example like this?
>
> cros-ec@0 {
> compatible = "google,cros-ec-spi";
There should also be a 'spi' parent node and 'reg' here.
>
> usbc_extcon0: extcon@0 {
And no unit-address here as there's no 'reg'.
> compatible = "google,extcon-usbc-cros-ec";
> google,usb-port-id = <0>;
> };
>
>
> usbc_extcon1: extcon@1 {
> compatible = "google,extcon-usbc-cros-ec";
> google,usb-port-id = <1>;
> };
> };
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] dt-bindings: convert extcon-usbc-cros-ec.txt extcon-usbc-cros-ec.yaml
2020-02-06 21:40 ` Rob Herring
@ 2020-02-07 8:05 ` Enric Balletbo i Serra
0 siblings, 0 replies; 4+ messages in thread
From: Enric Balletbo i Serra @ 2020-02-07 8:05 UTC (permalink / raw)
To: Rob Herring
Cc: Dafna Hirschfeld, devicetree, myungjoo.ham, cw00.choi,
mark.rutland, bleung, groeck, linux-kernel, helen.koike,
ezequiel, kernel, dafna3
On 6/2/20 22:40, Rob Herring wrote:
> On Thu, Feb 06, 2020 at 04:47:59PM +0100, Enric Balletbo i Serra wrote:
>> Hi Dafna,
>>
>> On 5/2/20 12:00, 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@collabora.com>
>>> ---
>>> Changes since v1:
>>> 1 - changing the license to (GPL-2.0-only OR BSD-2-Clause)
>>> 2 - changing the maintainers
>>> 3 - changing the google,usb-port-id property to have minimum 0 and maximum 255
>>>
>>> .../bindings/extcon/extcon-usbc-cros-ec.txt | 24 ----------
>>> .../bindings/extcon/extcon-usbc-cros-ec.yaml | 45 +++++++++++++++++++
>>> 2 files changed, 45 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..fd95e413d46f
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/extcon/extcon-usbc-cros-ec.yaml
>>> @@ -0,0 +1,45 @@
>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>>> +%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:
>>> + - Benson Leung <bleung@chromium.org>
>>> + - Enric Balletbo i Serra <enric.balletbo@collabora.com>
>>> +
>>> +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:
>>> + allOf:
>>> + - $ref: /schemas/types.yaml#/definitions/uint32
>>> + description: the port id
>>> + minimum: 0
>>> + maximum: 255
>>> +
>>> +required:
>>> + - compatible
>>> + - google,usb-port-id
>>> +
>>> +additionalProperties: false
>>> +
>>> +examples:
>>> + - |
>>> + cros-ec@0 {
>>> + compatible = "google,cros-ec-i2c";
>>
>> Now that you are here ... could you use compatible = "google,cros-ec-spi" here?
>>
>> The reason is that the label above, cros-ec@0 is not really correct for an i2c
>> device because after the @ you should put the address, cros-ec@1e will have more
>> sense here. But cros-ec-i2c is rarely used, so I'd change the compatible to use
>> "google,cros-ec-spi" and the entry "cros-ec@0" is fine.
>>
>>> + extcon {
>>> + compatible = "google,extcon-usbc-cros-ec";
>>> + google,usb-port-id = <0>;
>>> + };
>>
>> And maybe would be useful have a more complete example like this?
>>
>> cros-ec@0 {
>> compatible = "google,cros-ec-spi";
>
> There should also be a 'spi' parent node and 'reg' here.
>
>>
>> usbc_extcon0: extcon@0 {
>
> And no unit-address here as there's no 'reg'.
>
Thanks for pointing all this, I'll fix current users of this binding, as they
are wrong.
Thanks,
Enric
>> compatible = "google,extcon-usbc-cros-ec";
>> google,usb-port-id = <0>;
>> };
>>
>>
>> usbc_extcon1: extcon@1 {
>> compatible = "google,extcon-usbc-cros-ec";
>> google,usb-port-id = <1>;
>> };
>> };
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-02-07 8:05 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-05 11:00 [PATCH v2] dt-bindings: convert extcon-usbc-cros-ec.txt extcon-usbc-cros-ec.yaml Dafna Hirschfeld
2020-02-06 15:47 ` Enric Balletbo i Serra
2020-02-06 21:40 ` Rob Herring
2020-02-07 8:05 ` Enric Balletbo i Serra
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).