diff mbox series

[1/2] dt-bindings: usb: usb251xb: add documentation for data lane swapping

Message ID 20181219145941.5173-1-m.felsch@pengutronix.de (mailing list archive)
State New, archived
Headers show
Series [1/2] dt-bindings: usb: usb251xb: add documentation for data lane swapping | expand

Commit Message

Marco Felsch Dec. 19, 2018, 2:59 p.m. UTC
Add optional binding to allow USB differential-pair (D+/D-) data lane
swapping. The swapping can be specified for each port separately,
default is no swapping.

Signed-off-by: Marco Felsch <m.felsch@pengutronix.de>
---
 Documentation/devicetree/bindings/usb/usb251xb.txt | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Rob Herring Dec. 28, 2018, 11:45 p.m. UTC | #1
On Wed, Dec 19, 2018 at 03:59:40PM +0100, Marco Felsch wrote:
> Add optional binding to allow USB differential-pair (D+/D-) data lane
> swapping. The swapping can be specified for each port separately,
> default is no swapping.
> 
> Signed-off-by: Marco Felsch <m.felsch@pengutronix.de>
> ---
>  Documentation/devicetree/bindings/usb/usb251xb.txt | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/usb/usb251xb.txt b/Documentation/devicetree/bindings/usb/usb251xb.txt
> index 168ff819e827..aec93a92870d 100644
> --- a/Documentation/devicetree/bindings/usb/usb251xb.txt
> +++ b/Documentation/devicetree/bindings/usb/usb251xb.txt
> @@ -64,6 +64,8 @@ Optional properties :
>   - power-on-time-ms : Specifies the time it takes from the time the host
>  	initiates the power-on sequence to a port until the port has adequate
>  	power. The value is given in ms in a 0 - 510 range (default is 100ms).
> + - sw-dx-lanes-ports : Specifies the ports which will swap the differential-pair
> +	(D+/D-), default is not-swapped.

Perhaps 'swap-dx-ports' would be a more obvious name.

>  
>  Examples:
>  	usb2512b@2c {
> @@ -81,4 +83,6 @@ Examples:
>  		manufacturer = "Foo";
>  		product = "Foo-Bar";
>  		serial = "1234567890A";
> +		/* correct misplaced usb connectors on port 1,2 */
> +		sw-dx-lanes-ports = <1 2>;
>  	};
> -- 
> 2.19.1
>
Marco Felsch Dec. 31, 2018, 11:05 a.m. UTC | #2
Hi,

On 18-12-28 17:45, Rob Herring wrote:
> On Wed, Dec 19, 2018 at 03:59:40PM +0100, Marco Felsch wrote:
> > Add optional binding to allow USB differential-pair (D+/D-) data lane
> > swapping. The swapping can be specified for each port separately,
> > default is no swapping.
> > 
> > Signed-off-by: Marco Felsch <m.felsch@pengutronix.de>
> > ---
> >  Documentation/devicetree/bindings/usb/usb251xb.txt | 4 ++++
> >  1 file changed, 4 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/usb/usb251xb.txt b/Documentation/devicetree/bindings/usb/usb251xb.txt
> > index 168ff819e827..aec93a92870d 100644
> > --- a/Documentation/devicetree/bindings/usb/usb251xb.txt
> > +++ b/Documentation/devicetree/bindings/usb/usb251xb.txt
> > @@ -64,6 +64,8 @@ Optional properties :
> >   - power-on-time-ms : Specifies the time it takes from the time the host
> >  	initiates the power-on sequence to a port until the port has adequate
> >  	power. The value is given in ms in a 0 - 510 range (default is 100ms).
> > + - sw-dx-lanes-ports : Specifies the ports which will swap the differential-pair
> > +	(D+/D-), default is not-swapped.
> 
> Perhaps 'swap-dx-ports' would be a more obvious name.

What you think about 'swap-dx-lanes' since it has nothing to do with
port swapping, it's rather swapping port properties internally.

Regards,
Marco

> 
> >  
> >  Examples:
> >  	usb2512b@2c {
> > @@ -81,4 +83,6 @@ Examples:
> >  		manufacturer = "Foo";
> >  		product = "Foo-Bar";
> >  		serial = "1234567890A";
> > +		/* correct misplaced usb connectors on port 1,2 */
> > +		sw-dx-lanes-ports = <1 2>;
> >  	};
> > -- 
> > 2.19.1
> > 
>
Richard Leitner Jan. 2, 2019, 5:44 a.m. UTC | #3
Hi,

On 31/12/2018 12:05, Marco Felsch wrote:
> Hi,
> 
> On 18-12-28 17:45, Rob Herring wrote:
>> On Wed, Dec 19, 2018 at 03:59:40PM +0100, Marco Felsch wrote:
>>> Add optional binding to allow USB differential-pair (D+/D-) data lane
>>> swapping. The swapping can be specified for each port separately,
>>> default is no swapping.
>>>
>>> Signed-off-by: Marco Felsch <m.felsch@pengutronix.de>
>>> ---
>>>   Documentation/devicetree/bindings/usb/usb251xb.txt | 4 ++++
>>>   1 file changed, 4 insertions(+)
>>>
>>> diff --git a/Documentation/devicetree/bindings/usb/usb251xb.txt b/Documentation/devicetree/bindings/usb/usb251xb.txt
>>> index 168ff819e827..aec93a92870d 100644
>>> --- a/Documentation/devicetree/bindings/usb/usb251xb.txt
>>> +++ b/Documentation/devicetree/bindings/usb/usb251xb.txt
>>> @@ -64,6 +64,8 @@ Optional properties :
>>>    - power-on-time-ms : Specifies the time it takes from the time the host
>>>   	initiates the power-on sequence to a port until the port has adequate
>>>   	power. The value is given in ms in a 0 - 510 range (default is 100ms).
>>> + - sw-dx-lanes-ports : Specifies the ports which will swap the differential-pair
>>> +	(D+/D-), default is not-swapped.
>>
>> Perhaps 'swap-dx-ports' would be a more obvious name.
> 
> What you think about 'swap-dx-lanes' since it has nothing to do with
> port swapping, it's rather swapping port properties internally.

I'd also prefer 'swap-dx-lanes'. For me it's short and clear.

The only downside is that the feature is called "PORT SWAP" in the
datasheet. Therefore you should maybe mention it in a comment somewhere
in the code so people know what to look for in the datasheet?

regards;Richard.L
Marco Felsch Jan. 3, 2019, 1:58 p.m. UTC | #4
Hi,

On 19-01-02 06:44, Richard Leitner wrote:
> Hi,
> 
> On 31/12/2018 12:05, Marco Felsch wrote:
> > Hi,
> > 
> > On 18-12-28 17:45, Rob Herring wrote:
> > > On Wed, Dec 19, 2018 at 03:59:40PM +0100, Marco Felsch wrote:
> > > > Add optional binding to allow USB differential-pair (D+/D-) data lane
> > > > swapping. The swapping can be specified for each port separately,
> > > > default is no swapping.
> > > > 
> > > > Signed-off-by: Marco Felsch <m.felsch@pengutronix.de>
> > > > ---
> > > >   Documentation/devicetree/bindings/usb/usb251xb.txt | 4 ++++
> > > >   1 file changed, 4 insertions(+)
> > > > 
> > > > diff --git a/Documentation/devicetree/bindings/usb/usb251xb.txt b/Documentation/devicetree/bindings/usb/usb251xb.txt
> > > > index 168ff819e827..aec93a92870d 100644
> > > > --- a/Documentation/devicetree/bindings/usb/usb251xb.txt
> > > > +++ b/Documentation/devicetree/bindings/usb/usb251xb.txt
> > > > @@ -64,6 +64,8 @@ Optional properties :
> > > >    - power-on-time-ms : Specifies the time it takes from the time the host
> > > >   	initiates the power-on sequence to a port until the port has adequate
> > > >   	power. The value is given in ms in a 0 - 510 range (default is 100ms).
> > > > + - sw-dx-lanes-ports : Specifies the ports which will swap the differential-pair
> > > > +	(D+/D-), default is not-swapped.
> > > 
> > > Perhaps 'swap-dx-ports' would be a more obvious name.
> > 
> > What you think about 'swap-dx-lanes' since it has nothing to do with
> > port swapping, it's rather swapping port properties internally.
> 
> I'd also prefer 'swap-dx-lanes'. For me it's short and clear.
> 
> The only downside is that the feature is called "PORT SWAP" in the
> datasheet. Therefore you should maybe mention it in a comment somewhere
> in the code so people know what to look for in the datasheet?

Okay, I can do this. Should I place the comment into the driver code or
into the bindings description? Both places seems to be correct for me.

Regards,
Marco

> 
> regards;Richard.L
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/usb/usb251xb.txt b/Documentation/devicetree/bindings/usb/usb251xb.txt
index 168ff819e827..aec93a92870d 100644
--- a/Documentation/devicetree/bindings/usb/usb251xb.txt
+++ b/Documentation/devicetree/bindings/usb/usb251xb.txt
@@ -64,6 +64,8 @@  Optional properties :
  - power-on-time-ms : Specifies the time it takes from the time the host
 	initiates the power-on sequence to a port until the port has adequate
 	power. The value is given in ms in a 0 - 510 range (default is 100ms).
+ - sw-dx-lanes-ports : Specifies the ports which will swap the differential-pair
+	(D+/D-), default is not-swapped.
 
 Examples:
 	usb2512b@2c {
@@ -81,4 +83,6 @@  Examples:
 		manufacturer = "Foo";
 		product = "Foo-Bar";
 		serial = "1234567890A";
+		/* correct misplaced usb connectors on port 1,2 */
+		sw-dx-lanes-ports = <1 2>;
 	};