Re: [v2 PATCH] dt-binding: usb: add usb-role-switch property

From: Heikki Krogerus
Date: Tue May 07 2019 - 10:14:04 EST

On Tue, May 07, 2019 at 10:22:58AM +0800, Chunfeng Yun wrote:
> diff --git a/Documentation/devicetree/bindings/usb/generic.txt b/Documentation/devicetree/bindings/usb/generic.txt
> index 0a74ab8dfdc2..f5a6ad053ecc 100644
> --- a/Documentation/devicetree/bindings/usb/generic.txt
> +++ b/Documentation/devicetree/bindings/usb/generic.txt
> @@ -30,6 +30,11 @@ Optional properties:
> optional for OTG device.
> - adp-disable: tells OTG controllers we want to disable OTG ADP, ADP is
> optional for OTG device.
> + - usb-role-switch: tells Dual-Role USB controllers we want to handle the role
> + switch between host and device according to the state
> + detected by the USB connector, typically for Type-C,
> + Type-B(micro).
> + see connector/usb-connector.txt.

That does not look correct to me. Firstly, USB role switches are not
always dual-role USB controllers. Secondly, stating what determines
the role irrelevant IMO.

Since this is a boolean property, the description for it should simply
explain what does it tell about the capabilities of the device that
has it. The description should not make any assumptions about the
users of the property, and since the property is a "generic" USB
property, I'm not sure it should make any assumptions about the type
of the device that has the property either. Also, I would really like
the description to show the type of the property.

Why not just say something like this:

"Boolean property informing that the device is capable of assigning
the USB data role (USB host or USB device) for a given USB connector."